Skip to main content

Reference/Glossary

Key terms used throughout the IrisX App SDK documentation.

IrisX App​

An installable unit that customers can find and install from the Trackunit Marketplace. An app is a container — it bundles one or more Extensions, defines marketplace metadata (name, description, screenshots), and controls the installation policy.

Extension​

The unit of functionality inside an app. An extension targets a specific Extension Point in Trackunit Manager and contains the React code and business logic the end user interacts with. One app can contain multiple extensions.

Extension Point​

A named slot in Trackunit Manager where an extension can render UI or execute logic. Examples: Asset Home, Fleet, Widget, Report, App Settings, Administration, Customer Home, Asset Events Actions, App Lifecycle.

Workspace​

An NX monorepo that holds all your IrisX Apps and Extensions. The recommended approach is one workspace per developer or organisation, containing all apps and shared libraries.

Manifest (iris-app-manifest.ts)​

The primary configuration file for an IrisX App. Written in TypeScript (for type safety and IDE completion), it defines marketplace settings, extension registrations, security policy (cspHeader, permissionsPolicy), installation rules, and runtime dependencies.

moduleFederationName​

The unique identifier for your app used by Module Federation. Automatically derived from your workspace and app name. Must be unique across all published apps — it cannot be changed after first publish.

specVersion​

The version of the iris-app-manifest.ts schema. Set automatically by the SDK tooling. Do not change it manually; it tells the platform which manifest features your app declares.

Scope​

A permission your app requests in iris-app-manifest.ts to access specific Trackunit APIs and capabilities. Scopes determine what the app can do on behalf of the installing account, and the same granted scopes are applied to any app tokens issued to the app.

Custom Field​

An app-defined data attribute that can be attached to Trackunit entities (Asset, Account, Group, Site). Custom fields are defined in the app manifest and owned by the app that defines them.

App Token​

A short-lived credential issued to an App Lifecycle Extension when a customer installs your app. Scoped to that customer's account, it allows your server-side code to call Iris APIs on their behalf.

cspHeader​

A Content Security Policy declaration in your app manifest. Controls which external origins your extension is permitted to contact. Every external API domain your app calls must be listed here — otherwise the browser blocks the request at runtime.

permissionsPolicy​

A Permissions Policy declaration in your app manifest. Controls access to browser features and shared resources (clipboard, geolocation, etc.) inside the extension iframe.

TU_TOKEN​

An API token used to authenticate the submitApp CLI command in CI/CD pipelines instead of interactive browser login. Generated in the Trackunit Manager Developer Console.