ODA User Guide

Account Settings

Account-level administration for members, integrations, secrets, and custom apps.

The Account section is where day-to-day tenant administration takes place for the currently selected account. Unlike the organization-level controls, account-level settings manage the specific operations, integrations, and user access for a single account. This includes account details, member access control, API integration keys, external connectors, and secrets used by services and integrations.

Account administration is where teams configure the technical and governance details that enable their workflows. By centralizing these settings, users can manage authentication, integrations, and API access without affecting other accounts or organizations. The account level balances administrative control with operational flexibility—administrators can set up the account's infrastructure while day-to-day users focus on their data and workflows.

Identity and Access

General account metadata and member role management.

Integration and Security

API keys, connectors, secrets, and custom app lifecycle.

General

The General section displays fundamental information about the currently selected account, including the account name, organization it belongs to, total number of members, and creation date. This page serves as a reference point for account metadata and helps administrators understand the account's context within the larger organizational structure.

How to Review General Account Details

To review general account information, follow the steps below.

  1. Open Settings > Account > General.
  2. Review the displayed account information:
    • Account name: The name of the current account
    • Member count in account: The total number of users with access to this account
    • Organization: The parent organization this account belongs to
    • Created at: The date and time the account was created
  3. This information is read-only and reflects the account's current configuration.

Members

The Members section under Account allows administrators to manage who has access to the currently selected account and what roles they hold. User management at the account level includes inviting new members, reviewing existing members, updating their roles and permissions, and removing users who no longer need access.

Access control at the account level ensures that only authorized team members can work with the data, workflows, and settings specific to that account. Administrators can assign different roles (such as viewer, editor, or administrator) to grant appropriate levels of responsibility and control. Regular review of account membership helps maintain security and ensures that team changes are reflected promptly in the platform.

How to Manage Members and Roles

To manage account members and roles, follow the steps below.

  1. Open Settings > Account > Members.
  2. Use Search users to find people in the account by name or email.
  3. Review the members table showing current users and their assigned roles.
  4. Click Invite member to add a new user to the account:
    • Enter the user's email address
    • Select one or more roles for the user
    • Click Send invite to notify the user
  5. Click a member row to review or update that user's roles and permissions.
  6. Use the trash icon next to a member to remove a user from the account when needed (this action cannot be undone without re-inviting the user).

API Keys

API Keys enable secure, programmatic access to the Optra platform from external applications, scripts, and integrations. Each API key is tied to a specific account and can be used to authenticate requests without exposing user credentials. API keys are essential for automation, data integration, and building custom workflows that interact with the platform.

API key management involves generating new keys with appropriate expiration policies, documenting their purpose, securely storing them, and rotating or revoking keys when they are no longer needed. The platform supports multiple API versions to ensure compatibility with different integration requirements and allows you to set expiration dates to enforce key rotation policies for enhanced security.

How to Generate and Manage API Keys

To generate and manage API keys, follow the steps below.

  1. Open Settings > Account > API keys.
  2. Review existing API keys in the table, including their description, API version, expiration date (if set), and creation date.
  3. Click Generate Api Key to create a new key:
    • Enter a Description to identify the key's purpose (e.g., "Data import automation", "Third-party service integration")
    • Optionally set an Expiration date to enforce key rotation
    • Select the API Version your integration requires
    • Click Create
  4. The new API key is displayed once; use Copy to Clipboard to copy it securely to your application or secure storage.
  5. Once the key is closed, you cannot retrieve it again—store it safely before closing.
  6. To revoke an API key, use the delete/revoke option next to the key in the table.

Connectors

Connectors are pre-built integration packages that enable Optra to communicate with external systems and services. These connectors simplify the process of connecting your data sources, IoT platforms, cloud services, and business applications to Optra, allowing data to flow between systems with minimal custom development.

The Connectors page provides access to available connector packages that support your technical architecture and integration requirements. Connectors abstract away authentication and protocol complexity, allowing teams to focus on data transformation and analytics rather than integration plumbing. By downloading and deploying the appropriate connector, you establish the bridge between your external systems and Optra's data processing capabilities.

How to Browse and Deploy Connectors

To browse and deploy connectors, follow the steps below.

  1. Open Settings > Account > Connectors.
  2. Browse the available connector packages listed in the table, which display:
    • Connector name: The name and type of the connector (e.g., "Azure IoT Hub Connector", "Kafka Connector")
    • Description: A brief summary of what the connector does
    • Supported architecture: Information about which deployment architectures the connector supports (cloud, on-premises, hybrid)
  3. Review the connector's documentation or description to understand its capabilities and requirements.
  4. Click the download button or link for the connector that matches your target architecture.
  5. Follow the deployment documentation to install and configure the connector in your environment.
  6. Once deployed, configure the connector with your credentials and connection details in your Optra account settings.

Secrets

Secrets are securely encrypted credentials, API keys, and sensitive configuration data that services and integrations use to authenticate with external systems. By storing secrets in Optra rather than in code or configuration files, you reduce the risk of exposure and enable easier rotation and management.

The Secrets section provides a secure vault for managing authentication credentials, private keys, connection strings, and other sensitive information used by connectors, workflows, and integrations. Proper secrets management is critical for security—never store secrets in code repositories or configuration files that might be shared or exposed. Instead, use Optra's secrets management to keep sensitive data encrypted and accessible only to authorized services and users.

How to Create and Maintain Secrets

To create and maintain secrets, follow the steps below.

  1. Open Settings > Account > Secrets.
  2. Review the table of existing secrets, which displays:
    • Secret name: A label identifying the secret (e.g., "Azure Service Principal Key", "Database Password")
    • Type: The type of secret (e.g., API key, password, connection string, certificate)
    • Created at: When the secret was created
    • Last updated: When the secret was last modified
  3. Click Create secret to add a new secret:
    • Enter a descriptive Name for the secret
    • Select the Type that matches your secret (dropdown menu provides standard options)
    • Enter or paste the secret value
    • Click Create to encrypt and save the secret
  4. Open a secret row to view or update it:
    • You can edit the name and value (the value will be updated but not displayed for security reasons)
    • Click Save to persist changes
  5. Use the delete button to remove a secret when no longer needed.
  6. Deleted secrets are permanently removed and cannot be recovered.

Custom Apps

Custom Apps enable teams to build, deploy, and integrate custom web applications directly within the Optra IoT Platform ecosystem. This feature transforms Optra from a single-purpose analytics platform into an extensible application framework—teams can create domain-specific tools, dashboards, and workflows tailored to their exact business needs without requiring separate hosting infrastructure or external platforms.

Each Custom App runs as an isolated web application accessed through its own unique subdomain, enabling true multi-tenancy and security isolation. Apps can be tagged to support multiple versioning strategies—for example, you can maintain separate "sandbox" and "production" versions of the same application or run A/B tests with different tagged deployments. This flexibility allows teams to develop, test, and iterate on custom applications safely while maintaining stable production versions.

The platform handles authentication, deployment, and infrastructure concerns, allowing developers to focus on building business logic and user experiences. Custom Apps integrate seamlessly with Optra's API ecosystem, enabling them to read and write data, trigger workflows, consume AI/ML models, and connect to external systems. Whether building specialized reporting interfaces, custom data entry applications, or integration gateways, Custom Apps provide the infrastructure and governance framework to operationalize custom web development within the Optra platform.

How to Create and Manage Custom Apps

To create and manage custom apps, follow the steps below.

  1. Open Settings > Account > Custom Apps (or navigate to the Custom Apps management page in your account).
  2. Click + New Custom App button to open the application creation dialog.
  3. In the Create Custom App modal, configure the following:
    • Auth Type: Select the authentication mechanism for your app:
      • Public: Anyone with the app link can access (no authentication required)
      • Authenticated: Users must log in before accessing the app
      • Other supported types depending on your platform configuration
    • Name: Enter a descriptive name for your application (e.g., "Retail Dashboard", "Field Service Platform")
    • Description: Provide a brief explanation of the app's purpose and functionality
    • Tag: Enter a deployment tag (e.g., "v1", "sandbox", "beta") to organize and version your deployments
    • Icon: Click Choose file to upload a custom icon or logo for your app (this will display in the app list and app switcher)
  4. Click Create to provision the new Custom App.
  5. The system assigns a unique subdomain to your app (automatically generated based on your account and app identifier).
  6. Your app now appears in the Custom Apps list with its subdomain and tag information.

View and Manage Applications

To view and manage your custom applications, follow the steps below.

  1. Open Settings > Account > Custom Apps.
  2. The Custom Apps page displays a table with all your applications:
    • Name: The application name you provided
    • Description: A summary of the app's purpose (if provided)
    • Icon: Visual identifier for quick recognition
    • Subdomain: The unique domain assigned to your app (used to access the application)
    • Tag: The current active deployment tag for the app
  3. Use the search or filter options to find a specific app in your list.
  4. Click any app row to view or edit its details, including:
    • Application settings and configuration
    • Deployment tags and version management
    • User access and authentication settings
    • API integrations and data connections

Deploy and Tag Versions

To deploy and tag different versions of your custom apps, follow the steps below.

  1. Once you have created a Custom App, you can deploy multiple versions using different tags.
  2. Each tag represents a distinct version of your app's code and assets.
  3. Open your Custom App's settings to:
    • Upload or update app code for a specific tag
    • Set which tag is "active" (the version users access when they visit the subdomain)
    • Review deployment history and rollback if needed
  4. Tags enable you to maintain parallel versions such as:
    • production: Your stable, live version for end users
    • staging: A pre-release version for testing and validation
    • development: An experimental or in-progress version for developer use

Export Your Application

To export your custom application, follow the steps below.

  1. Open Settings > Account > Custom Apps and select the app you want to export.
  2. Click the export option (often labeled with a download or export icon).
  3. The system downloads a ZIP file containing your app's entire configuration, code, and assets.
  4. Use this export to:
    • Create backups of your application
    • Migrate the app to another account or environment
    • Share the app template with other teams
    • Version control your app's source code in your repository

Access note: Account > Members updates require user-management permissions. Account > Secrets is restricted to administrator and higher-privilege account roles for security.