Using the IoT Flow Runtime Editor
Use the OCI-integrated Node-RED editor to build and deploy flows, configure Oracle Database and OCI nodes, and collaborate with other authorized users.
Each IoT Flow Runtime provides a managed Node-RED editor.
Open the editor from the Flow Runtime details page in the OCI Console. OCI Console single sign-on authenticates you to the editor, so you don't need separate Node-RED credentials. If you need help finding the IoT Flow Runtimes, see Listing IoT Flow Runtimes.
The Node-RED editor, uses this format for the flow runtime endpoint:
https://<flow-runtime-short-id>.flows.iot.<region>.oci.customer-oci.com/Your OCI IAM permissions determine whether you can view or edit the flows.
OCI and Node-RED Navigation
The OCI navigation bar appears above the standard Node-RED editor header.
| Control | Description |
|---|---|
| <flow-runtime-short-id> | Returns to the Flow Runtime details page in the OCI Console. |
| Editor or Viewer | Shows your current access level. Editors can change and deploy flows. Viewers can inspect the editor but can't deploy changes. When multiple users are logged in, a message displays stating this flow is being updated by another user. The other user sees the option to review or merge changes. |
| Session remaining | Shows the time remaining in the authenticated editor session. |
| Extend | Select to extend the time in the authenticated editor session. |
| Help | Opens help for the editor. |
| Sign Out | Ends the editor session. |
The Node-RED header contains Deploy and the main menu. The editor contains the node palette on the left, the flow workspace in the center, and information, help, debug, configuration, and context sidebars on the right.
Working with Multiple Users
More than one authorized user can open and edit the same Flow Runtime. Each user works in a separate browser editor session; this isn't character-by-character collaborative editing.
If another user deploys changes while you have undeployed changes, you have the option to review and merge the newer deployed flow configuration before you deploy. Coordinate deployments and keep related work on separate flow tabs when possible. Separating work into tabs also makes changes easier to compare and merge. For more information, see Flow Structure.
Updating Flow Runtime Software
OCI IoT manages the software for a Flow Runtime, including the managed Node-RED runtime. Don't use the Node-RED Palette Manager to update the managed runtime. The Palette Manager manages permitted node modules.
When one or more Flow Runtimes require a software update, OCI sends an announcement that lists the affected region, Flow Runtime name, Flow Runtime OCID, and the Action required by deadline. You have 14 days (336 hours) from the notification time to update each listed Flow Runtime.
Plan for a short interruption. Flow processing pauses and the editor is unavailable while the Flow Runtime is deactivated and reactivated.
- Open the announcement and review the affected resources and deadline. To find a listed resource in the Console, see Listing IoT Flow Runtimes.
- Before updating, move any required files from the Flow Runtime's local file system to Autonomous Database, File Storage, or another persistent storage service. The local file system is ephemeral and files on it might be lost during deactivation or activation. Data stored in Autonomous Database and mounted File Storage file systems is retained. If you need another recovery point for the flow definitions, back up the current flows JSON.
- Deactivate the affected Flow Runtime and wait for the deactivation work request to complete and the lifecycle state to become Inactive.
- Activate the Flow Runtime to apply the pending software update. Wait for the activation work request to complete successfully and the lifecycle state to become Active. For work request states and details, see Work Requests for IoT Domain Groups, Domains, and Flow Runtimes.
- Open the editor and verify that the flows, Flow Runtime interface, Oracle nodes, and other permitted node modules used by the workload operate normally. If activation or flow execution fails, review the configured Flow Runtime logs.
If you don't complete the update by the Action required by deadline, OCI deactivates the affected Flow Runtime. The Flow Runtime remains in the Inactive state until you activate it. Activating it applies the pending software update and returns it to service.
Backing Up and Restoring Flows
The Flows tab stores the Flow Runtime's one current, complete Node-RED flows.json configuration file. Adding another flows.json replaces that active configuration; it doesn't create a separately retained backup.
Save a point-in-time copy outside the Flow Runtime, such as in an Object Storage bucket. A File Storage mount makes files available to running flows and isn't required for this management-side backup.
Backing Up the JSON Flows Configuration
- In the Node-RED editor, export the complete flow JSON configuration and download the JSON file. You can instead retrieve the active flows JSON from the Flow Runtime by using the Console, CLI, or API.
- Create an Object Storage bucket or select an existing backup bucket. Enable object versioning when you want Object Storage to retain earlier versions that use the same object name.
- Upload the JSON file. Use a name that identifies the Flow Runtime and backup time, for example
flow-runtimes/<flow-runtime-short-id>/2026-07-28T160000Z-flows.json. - Record the Flow Runtime OCID, Node-RED version, export time, and reason for the backup. Download the object and confirm that it contains valid JSON before depending on it for recovery.
Restoring the JSON Flows Configuration
- Retrieve and externally save the current flows JSON configuration before replacing it.
- Download the point-in-time JSON configuration that you want to restore from Object Storage.
- Add the JSON on the Flows tab, or replace the complete flows JSON by using the CLI or API. If you need help finding flows, see Listing IoT Flow Runtimes.
- Open the Node-RED editor and verify the flows, shared configuration nodes, and installed node modules. Reenter any required credentials that the exported JSON didn't preserve, and test critical flows.
The flows JSON can contain sensitive endpoint and configuration details and might not preserve every secret required by credential-backed nodes. Limit access to backup objects and test the restore process before relying on it for recovery.
Oracle Nodes
The managed palette includes Oracle Database nodes and OCI nodes in addition to the standard Node-RED nodes. The nodes available in a Flow Runtime can depend on the service version.
Oracle Database Nodes
The db-nodes group connects flows to an Oracle Database, including a customer Autonomous Database when configured.
| Node | Description |
|---|---|
| db-connection | Defines a shared Oracle Database connection that the other database nodes use. |
| begin transaction | Obtains a database connection and begins a transaction for downstream database operations. |
| end transaction | Commits or rolls back the current transaction and releases its database connection. |
| enqueue | Adds a message to a configured Oracle Database transactional event queue. |
| dequeue | Retrieves a message from a configured Oracle Database transactional event queue. |
| sql | Runs a SQL statement by using the configured database connection. |
OCI Nodes
The oci-nodes group connects a flow to supported OCI IoT operations.
| Node | Description |
|---|---|
| iot-config | Defines the shared OCI Config authentication, region, and default compartment settings used by OCI nodes. |
| send command | Sends a command to a digital twin instance. |
| subscribe | Subscribes a flow to messages from a supported OCI IoT source. |
| telemetry | Sends telemetry from a flow to OCI IoT. |
OCI Config Options
The palette labels the shared configuration node iot-config. Its edit dialog uses the OCI Config label. Select the authentication type appropriate for the flow:
| Authentication type | Description |
|---|---|
| Config File | Uses an OCI SDK configuration file and the selected profile. |
| Instance Principal | Uses the identity of the OCI compute instance when an instance principal is available to the runtime environment. |
| Resource Principal | Uses the Flow Runtime resource principal. This option avoids storing a user's long-lived credentials in the flow. Add the Flow Runtime to a dynamic group and grant only the policies required for the OCI resources that its nodes access. |
| API Key (Simple) | Uses OCI user API-signing key information supplied to the configuration node. Protect these credentials and use a resource principal instead when the target service supports it. |
Set Region to the region containing the target resources. Set Compartment OCID to the default compartment for child OCI nodes. A child node can override the default compartment.
After changing the configuration, select Update, select Deploy, and then use Test Connection.
Managing Node Modules
The Palette Manager is a built-in feature in the Node-RED editor. It lets you install, update, disable, or remove node modules without using the command line and provides an integrated package interface associated with the public Node-RED library. In an OCI IoT Flow Runtime, you can manage only the modules and versions that the service makes available or permits.
To explore additional Oracle custom nodes, see Node-RED Oracle Cloud Nodes on GitHub. The repository includes nodes for Oracle Database and Advanced Queues (AQ), Oracle Fusion Cloud SCM, OCI services, and the OCI IoT Platform, along with installation guidance, node references, and example flows. Before installing a node from the repository, confirm that the module and version are permitted for your Flow Runtime.