@@ -5,14 +5,28 @@ This APEX application serves as a dashboard for monitoring IoT devices and messa
55
66## Prerequisites
77
8- 1 . Complete setup of Iot Platform including:
9- 1 . Configure an IoT Domain's Access to REST
10- 2 . Configure an IoT Domain's Access to APEX
8+ 1 . Complete setup of Iot Platform including access to APEX:
1192 . Create an APEX user to install and access the application.
1210
1311Documentation about creating APEX users can be found in the
1412[ APEX Administration Guide] ( https://docs.oracle.com/en/database/oracle/apex/24.2/aeadm/managing-users-across-an-application-express-instance.html#GUID-CE23292D-05D1-4E79-BF40-8BC31E74E6C8 ) .
1513
14+ ### Optional
15+
16+ It is recommended that you create an OCI user and group that OCI IoT Explorer can use to
17+ access OCI REST APIs. However, any user with sufficient access will suffice.
18+
19+ 1 . Begin by creating an OCI user group.
20+ 2 . Next, create a user with an API Key assigned to that group.
21+
22+ Then, as the admin-level user, create a new policy and set the following.
23+
24+ ``` text
25+ Allow group <grp_name> to manage iot-family in compartment <cmp_name>
26+ Allow group <grp_name> to manage iot-domain-family in compartment <cmp_name>
27+ Allow group <grp_name> to manage iot-digital-twin-family in compartment <cmp_name>
28+ ```
29+
1630## Setup
1731
1832After completing your IoT Platform setup, you should be able to access your APEX
@@ -58,10 +72,10 @@ The following will walk you through the installation of the IoT Explorer
5872application.
5973
60741 . Click "Import".
61- 2 . Select the F102 .sql file.
75+ 2 . Select the iot_explorer.app .sql file.
62763 . Click the "Next" button.
63774 . Set the "Parsing Schema" to your workspace (e.g., **************** __ wksp).
64- 5 . You may either reuse application number 105 or allow APEX to auto-assign a new
78+ 5 . You may either reuse the application number or allow APEX to auto-assign a new
6579application number.
66806 . Click "Install Application".
6781
@@ -87,3 +101,16 @@ as well as telemetry sent to the platform (raw, rejected, and historized data).
87101
88102The "IoT Tree" page organizes the IoT objects and telemetry received by each object
89103in a hierarchy starting with models, next adapters, then digital twins.
104+
105+ The 'Settings' page allows you to enter a user's credentials and information
106+ about your tenancy. This information, along with OCI policies allows the
107+ application to make the REST API calls to the IoT service. Any features requiring a
108+ value that has not been set will display a message to that effect.
109+
110+ ## Removal
111+
112+ To remove the OCI IoT Explorer:
113+
114+ 1 . Select the application from the APEX Application Builder and click "Delete
115+ Application" on the left.
116+ 2 . Load iot_explorer_teardown.sql into APEX SQL Workshop -> Scripts and run.
0 commit comments