Skip to content

Commit 5a7984e

Browse files
feat: ✨ Added command data monitoring, IoT domain information, and OCI settings information
Command Data Monitoring: This feature is now integrated throughout the application, providing real-time visibility and insights into command-related activities. Domain Information Visibility: Easily access domain group and domain details for the environment where the app is installed. Settings Page: A dedicated page is now available for entering OCI credentials and other essential OCI configuration details. This setup is required to unlock new and upcoming features in the OCI IoT Explorer. Signed-off-by: Micheal Simmons <[email protected]>
1 parent 0a51100 commit 5a7984e

File tree

7 files changed

+774
-20
lines changed

7 files changed

+774
-20
lines changed

apex/dashboard/.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
f102.sql filter=lfs diff=lfs merge=lfs -text
1+
iot_explorer.app.sql filter=lfs diff=lfs merge=lfs -text

apex/dashboard/CHANGELOG.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# IoT Explorer - Release Notes
2+
3+
## September 16th 2025
4+
5+
### New Features
6+
7+
- Inclusion of command data throughout the application
8+
- Copy button added to OCIDs
9+
- Settings page added for user tenancy information
10+
- IoT Platform domain group and domain information added
11+
12+
### Changes
13+
14+
- Direct link from OCI IoT Platform object listings to recent activity
15+
16+
### Bug Fixes
17+
18+
- Report column names and order consistancy
19+
20+
## August 25th 2025
21+
22+
### Inital Release
23+
24+
Features
25+
26+
- Traffic monitoring dashboard
27+
- Listing of OcI IoT Platform objects (models, adapters, and instances)
28+
- Reports of Raw Data, Errors, and Historized data
29+
- Dynamic tree structure of OCI IoT Platform objects, their relationships, and most
30+
recent data collected

apex/dashboard/README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -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:
119
2. Create an APEX user to install and access the application.
1210

1311
Documentation 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

1832
After 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
5872
application.
5973

6074
1. Click "Import".
61-
2. Select the F102.sql file.
75+
2. Select the iot_explorer.app.sql file.
6276
3. Click the "Next" button.
6377
4. 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
6579
application number.
6680
6. Click "Install Application".
6781

@@ -87,3 +101,16 @@ as well as telemetry sent to the platform (raw, rejected, and historized data).
87101

88102
The "IoT Tree" page organizes the IoT objects and telemetry received by each object
89103
in 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.

apex/dashboard/f102.sql

Lines changed: 0 additions & 3 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
version https://git-lfs.github.com/spec/v1
2+
oid sha256:007df5138ee8fb979636739cdf20bbf3823fa1d9015ab70350d7d264eb8e7771
3+
size 845208

0 commit comments

Comments
 (0)