IoT Platform User Guide

Settings Navigation

Settings sidebar structure, role-aware visibility, and setup workflows across Admin, Account, Devices, Workflows, and more.

When you click your user name/avatar and choose Settings, the platform opens a dedicated Settings workspace with grouped sections in the left sidebar. The exact items shown in this sidebar are role-aware and feature-aware. In the current implementation, Admin items require administrator access, some Account items require developer or integration-management roles, and Devices and Workflows setup sections appear only when those product features are enabled for the selected account.

The sections below describe the requested sidebar structure and provide practical, validated workflows for each area.

My account

Subsections
  • Profile
  • Appearance
  • Notifications

The My account block is the first section in Settings navigation and contains user-scoped preferences that apply to your signed-in identity across accounts. In this guide, these pages are already detailed functionally in user-facing sections, but they are also directly reachable from Settings sidebar for faster personal configuration.

To use My account from Settings, do the following:

  1. Open Settings from the user menu.
  2. In the left sidebar, use:
    • My account > Profile
    • My account > Appearance
    • My account > Notifications

Profile

The Profile page is where you manage user-level account and security details for your signed-in identity. Use this page to review personal details, update account-level security options available to your role, and manage trusted or registered devices associated with your login context.

To use Profile, do the following:

  1. Open Settings > My account > Profile.
  2. Review available account and security fields for your user identity.
  3. Update profile or security details as needed and apply changes.
  4. Review registered devices and remove any device that should no longer be trusted.

Appearance

The Appearance page controls visual preferences for your workspace. Use it to select your preferred theme and keep your interface style consistent across sessions.

To use Appearance, do the following:

  1. Open Settings > My account > Appearance.
  2. Select your preferred theme option.
  3. Verify the UI updates to the selected appearance mode.

Notifications

The Notifications page manages user-level alert delivery behavior. Use it to configure push and in-app notification preferences, adjust quiet-time behavior, and tune how operational events are surfaced during working and non-working hours.

To use Notifications, do the following:

  1. Open Settings > My account > Notifications.
  2. Enable or disable notification channels based on your workflow needs.
  3. Configure quiet-time or schedule-related preferences where available.
  4. Save changes and confirm new notifications follow your selected preferences.

Admin

Subsections
  • Organizations
  • Members

The Admin group contains organization-level governance pages intended for platform-wide administration, not just one account. These pages are used to manage organizational boundaries and to review users across organizations and accounts.

Organizations

The Organizations page is the top-level governance page for creating, finding, and managing organizations. It includes search, pagination (Load more), create and delete actions, and drill-in navigation to each organization. From an organization detail page, administrators can manage both the organization itself and the accounts inside it.

To work with Organizations, do the following:

  1. Open Settings from the user menu.
  2. In the left sidebar, go to Admin > Organizations.
  3. Use Search organizations to quickly find an organization.
  4. Click Create organization to add a new one, then provide:
    • Name
    • Parent Organization (optional)
    • Type (for example customer or partner)
  5. Click an organization row to open it.
  6. In the organization page, use the Accounts tab to review existing accounts or click Create account.
  7. Use the Settings tab to review organization metadata, update organization name, and manage super users.
  8. If needed, use the delete action and complete the typed-name confirmation.

Members

The Members page under Admin presents an Optra-wide member list (Optra Members) across organizations and accounts. It is intended for global visibility, access audits, and centralized user lookup.

To work with Admin Members, do the following:

  1. Open Settings > Admin > Members.
  2. Use Search system members to filter by name/email.
  3. Review each row for:
    • User
    • Organization
    • Member in (accounts)
    • Member since
  4. Use Load more when the list is paginated.
  5. Use this page for audit and discovery; account-specific role changes are done from account-level Members pages.

Account

Subsections
  • General
  • Members
  • API Keys
  • Connectors
  • Secrets

The Account group is for account-scoped administration in the currently selected account context. This is where most day-to-day tenant operations happen: account information, members, API access, integration binaries, and secrets.

General

The General page is informational and shows account metadata rather than edit controls. It is useful for quickly confirming account identity and context before changing members or integrations.

To review General account information, do the following:

  1. Open Settings > Account > General.
  2. Review:
    • Account name
    • Member count in account
    • Organization
    • Created at

Members

The Account > Members page is the operational workspace for account membership. It supports search, invitation, role editing (through member row actions), and member removal with confirmation safeguards.

To manage account members, do the following:

  1. Open Settings > Account > Members.
  2. Use Search users to locate a user.
  3. Click Invite member to open the invite flow.
  4. Click a member row to open role/detail editing.
  5. Use the trash action to remove a member when needed.
  6. Confirm removal in the confirmation dialog.
  7. Use Load More to view additional members.

API Keys

The API Keys page manages account API keys for programmatic access. It includes key generation, API version selection, optional expiration, copy-to-clipboard support, and delete/update actions based on permissions.

To manage API Keys, do the following:

  1. Open Settings > Account > API keys.
  2. Click Generate Api Key.
  3. In Create New API Key, provide:
    • Description
    • Expires at (optional)
    • API Version
  4. Click Create.
  5. Copy the key using Copy to Clipboard and store it securely.
  6. Use edit (pencil) to update API version/description when needed.
  7. Use delete (trash) to revoke a key and confirm the deletion.

Connectors

The Connectors page provides downloadable connector artifacts for integration deployment, specifically AWS connector packages by architecture. This page is operationally useful when preparing external runtime environments.

To use Connectors, do the following:

  1. Open Settings > Account > Connectors.
  2. Review available connector rows (for example x86_64 and arm64 variants).
  3. Verify package hash values if your deployment process requires integrity validation.
  4. Click the download icon for the required architecture package.

Secrets

The Secrets area is the account vault for credentials and integration-sensitive values. It supports creating secrets, editing details, enabling/disabling, expiration configuration, value updates, and deletion.

To manage Secrets, do the following:

  1. Open Settings > Account > Secrets.
  2. Click Create secret.
  3. In Create New Secret, enter Name and select a Type, then click Create.
  4. Click a secret row to open its details page.
  5. In the details page, update:
    • General info (Name, Enabled/Disabled)
    • Expiration
    • Secret Values
  6. Click Save to apply changes.
  7. If a secret is no longer needed, use delete from the list and confirm.

Devices

Subsections
  • Device Groups
  • Device Templates

The Devices group in Settings is focused on setup objects used by fleet operations: device grouping rules and device template models. These are foundational configuration entities that affect enrollment, telemetry rendering, and automation targeting.

Device Groups

Device Groups are managed in a list-and-editor flow. You can create groups, then define dynamic rule-based membership or static membership by searching and selecting devices. Group settings also include template linkage and a device-group webhook endpoint for automated provisioning flows.

To manage Device Groups, do the following:

  1. Open Settings > Devices > Device groups.
  2. Click New Device Group to create a group.
  3. Enter group name and click Create.
  4. Click a group row to open its editor.
  5. In Set device queries, choose:
    • Dynamic: add and configure filter rules.
    • Static: search/filter devices, select them, then click Add Devices.
  6. Review Results to confirm membership.
  7. Use the group Edit flow to update name or assign/change Device template.
  8. Copy/use the Device Group Webhook URL for auto-provisioning scenarios.
  9. Use Delete Device Group when decommissioning a group.

Device Templates

Device Templates define model structure and behavior for device capabilities and telemetry handling. From the template editor, you can add capabilities and components, manage publish state (Publish DTDL), and tune telemetry inactivity settings.

To manage Device Templates, do the following:

  1. Open Settings > Devices > Device templates.
  2. Click New Device Template, enter a name, and click Create.
  3. Click a template row to open the template editor.
  4. In the editor, use:
    • Add Capability
    • Add Component
    • Publish DTDL
  5. Use the outline and linked device/group references to validate usage impact.
  6. Configure Device Telemetry Inactivity timeout and unit, then save.
  7. Use delete only when the template is no longer required.

Workflows

Subsections
  • Integrations
  • Message Routes

The Workflows settings group is for integration setup primitives used by automation: reusable integrations and message routes. These pages complement the workflow builder by providing destination and routing configuration at account settings level.

Integrations

The Integrations page lists account integrations and supports creation, update, external-link launch, and deletion. New integrations require a platform secret, aligning this flow with secret management.

To manage Integrations, do the following:

  1. Open Settings > Workflows > Integrations.
  2. Click Create ingestion.
  3. In Create New Integration, provide:
    • Name
    • Workflow Name
    • Platform Secret
  4. Click Create.
  5. Click an integration row to open detailed Settings and Logs.
  6. Update name/description and click Save when needed.
  7. Use delete (trash) to remove unused integrations and confirm.

Message Routes

Message Routes define how device message streams are routed to destination systems. The UI supports create, edit, and delete, with route-specific fields based on selected route type (for example Amazon S3 or Postgres).

To manage Message Routes, do the following:

  1. Open Settings > Workflows > Message routes.
  2. Click Create New Message Route.
  3. Select Route Type.
  4. Select a compatible Secret.
  5. Provide route-specific fields:
    • For Amazon S3: bucket and region.
    • For Postgres: schema and SSL option.
  6. Click Create.
  7. Click a route row to edit and click Update when required.
  8. Use delete (trash) to remove a route and confirm.

Model Optimization

Subsections
  • Product Families
  • Lookup
  • Databricks
  • Job History

The Model Optimization settings group appears after Workflows in the left settings sidebar when the model-hub feature is enabled for the selected account. These pages are setup and operational-support pages for model governance, lookup normalization, Databricks notebook linkage, and execution history review.

In this part of Settings, navigation itself is the primary context indicator: the left sidebar keeps the active item highlighted (Product families, Lookup, Databricks, or Job history). Some pages also provide direct in-page navigation controls (for example Databricks logs includes a back button to return to Databricks setup).

Product Families

Product Families define model-governance categories used across model creation and rules. This page is a management table with create/edit flows and optional feature-driven controls (for waiting-time, utilization-based suppression, and repetition-window behavior). It also shows usage indicators such as number of error types and notebooks mapped to each family.

To manage Product Families, do the following:

  1. Open Settings > Model Optimization > Product families.
  2. Review existing rows, including:
    • Name (with optional description indicator)
    • Waiting-time inclusion (when enabled)
    • Utilization-based suppression (when enabled)
    • Repetition window baseline (when enabled)
    • Error and notebook counts
    • Inserted date
  3. Click New Product Family to create a new family.
  4. In the modal, enter Name and Description.
  5. Configure feature-dependent switches/options when available:
    • Waiting time: Included/Excluded
    • Utilization-Based Suppression: Included/Excluded
    • Repetition Window Baseline: Time Window or Utilization Window
  6. Click Save.
  7. To edit, click an existing row and update values in the same modal.

Lookup

The Lookup page is the error-type master table used by Model Optimization flows. It supports searchable list operations, product-family filtering, create/edit dialogs, and delete confirmation. This page is the canonical place to maintain display names and error-type mappings per product family.

To manage Lookup entries, do the following:

  1. Open Settings > Model Optimization > Lookup.
  2. Use Search to find entries by text.
  3. Click Filter to open facets and apply Product Family filtering.
  4. Use Clear all to reset filters.
  5. Click New Error Type to add a new lookup row.
  6. In Add Error Type, provide:
    • Product Family
    • Error Type
    • Display name
  7. Click Save.
  8. To update an entry, click its row and use Edit Error Type.
  9. To remove an entry, use the trash action and confirm deletion.

Databricks

The Databricks page is the notebook setup registry used by model workflows. It links product family, rule type, mode (experiment/production), notebook metadata, optional secret/visualization bindings, and optional model linkage. For experiment rows, logs are available through a dedicated logs page.

To manage Databricks setup, do the following:

  1. Open Settings > Model Optimization > Databricks.
  2. Review notebook rows and key indicators:
    • Product family/mode/rule badges
    • Linked model (if any)
    • Notebook path and cluster ID
    • Secret and chart linkage indicators
    • Run indicator for experiment-mode rows
  3. Click Add new databrick notebook.
  4. In New Notebook, set:
    • Mode (Experiment or Production)
    • Rule (model type)
    • Product Family
    • Notebook path
    • Cluster ID
    • Optional Secret
    • Optional Visualization
  5. Click Save.
  6. Use the link action to open Link to Model and associate the notebook to a compatible model.
  7. Use the pencil action to update notebook configuration.
  8. For experiment-mode rows, click Logs to open Databricks run logs.

To work with Databricks logs, do the following:

  1. From Databricks setup, click Logs on an experiment row.
  2. On the logs page, use the back button to return to Databricks setup.
  3. Review execution rows (Model, Experiment, run id, timestamps, status, reason).
  4. If a run is stuck in active state, use Reset run status and confirm when appropriate.

Job History

Job history is the consolidated Databricks execution history view for the selected account. It provides a run-centric table for operational review and troubleshooting, including lifecycle timestamps and final status/reason.

To use Job History, do the following:

  1. Open Settings > Model Optimization > Job history.
  2. Review run rows in Databricks Job runs, including:
    • Model
    • Experiment
    • run id
    • Pushed at
    • Started at
    • Stopped at
    • Status
    • Reason
  3. Use this page for historical triage and audit of model-notebook executions.

Insights

Subsections
  • Power BI Setup
  • Superset Setup

The Insights settings group appears after Model Optimization when reports are enabled and the user has dashboard-management permissions. It currently provides setup pages for Power BI and Superset instances used by reporting features.

Power BI Setup

Power BI setup manages account-scoped Power BI instances by linking a friendly name to a secret reference. The page supports create and update workflows through modal forms and a table-based list.

To manage Power BI Setup, do the following:

  1. Open Settings > Insights > Power BI setup.
  2. Review existing instance rows (Name, Secret Name).
  3. Click Create new instance.
  4. In Create Power BI Instance, enter:
    • Name
    • Secret
  5. Click Save.
  6. To edit an instance, click a row and update fields in Update Power BI Instance.
  7. Click Save to apply updates.

Superset Setup

Superset setup mirrors the Power BI setup pattern for Superset-backed reporting. It maintains account-scoped Superset instances and secret bindings.

To manage Superset Setup, do the following:

  1. Open Settings > Insights > Superset setup.
  2. Review existing rows (Name, Secret Name).
  3. Click Create new instance.
  4. In Create Superset Instance, provide:
    • Name
    • Secret
  5. Click Save.
  6. To edit, click a row and update details in Update Superset Instance.
  7. Click Save.

Apps (Custom Apps)

Subsections
  • Custom Apps List
  • Custom Apps

The final settings group in this sidebar order is Apps, which currently exposes Custom apps. This area is used to create and administer custom applications, download OCA client binaries, manage app metadata, and configure domains. It includes both a list view and an app detail view with breadcrumb navigation.

Custom Apps List

The Custom Apps list page is the primary catalog and entry point. It provides creation, deletion, row drill-in, and OCA client package downloads by platform architecture.

To use the Custom Apps list, do the following:

  1. Open Settings > Apps > Custom apps.
  2. Review table columns:
    • Name
    • Description
    • Icon
    • Subdomain
    • Tag
  3. Click New Custom App to create an app.
  4. In Create Custom App, provide:
    • Auth Type (Public, Basic Auth, or Entra ID)
    • Name
    • Description
    • Tag
    • Optional Icon upload (SVG)
  5. Click Create.
  6. Use the OCA Client download menu to choose platform binaries (for example linux-amd64, windows-amd64, darwin-arm64).
  7. Click an app row to open detailed app settings.
  8. Use trash to delete an app and confirm deletion when required.

Custom Apps

The app detail page includes a breadcrumb trail at the top (Custom Apps > [App Name]), making return navigation explicit while staying in Settings context. This page is organized into General, optional Media (when enabled), and Custom Domains panels.

To manage Custom App details, do the following:

  1. Open an app from Settings > Apps > Custom apps.
  2. Use the breadcrumb to confirm navigation context or return to the app list.
  3. In General, update:
    • Name
    • Auth Type
    • Description
    • Icon
  4. Click Save.
  5. If Media is enabled, use drag-and-drop or file picker upload and filter/search media assets by type.
  6. In Custom Domains, click New Custom Domain to add a domain.
  7. For each domain, use actions as needed:
    • Make Primary
    • Override Verification (for pending verification cases)
    • Delete (trash)
  8. Confirm domain deletion in the modal when prompted.

Role and Visibility Notes

If a settings item is missing, the most common reasons are role, feature, or environment gating. In the current implementation:

  1. Admin > Organizations and Admin > Members require administrator-level access.
  2. Account > API keys and Account > Connectors require developer/integration-capable roles.
  3. Account > Secrets and Workflows > Message routes are restricted to administrator-level access.
  4. Workflows > Integrations requires integration-management permissions.
  5. Devices and Workflows settings groups appear only when corresponding account features are enabled.
  6. Model Optimization setup pages are shown when model-hub feature enablement is active for the account.
  7. Insights > Power BI setup and Insights > Superset setup depend on reports feature enablement plus dashboard-management permissions.
  8. Apps > Custom apps depends on custom-apps environment configuration and administrator role.

Previous Page

Ask Optra

Next Page

Troubleshooting