Master Data Package Reference#

This page provides a technical reference for the Master Data Package generated by the UNS Export Integration business scenario. Understanding this structure enables administrators to inspect, modify, and extend the integration beyond the defaults provided by Cortex.

Package Overview#

The Master Data Package contains three object types that together define the complete UNS Export Integration pipeline:

Master Data Package
├── AutomationController        — Controller entity with scope and task packages
├── AutomationControllerWorkflow — Setup workflow with event processing logic
└── AutomationControllerIoTEventDef — Bindings to Light CDM event definitions

AutomationController#

The AutomationController object defines the controller entity that manages the UNS Export Integration workflow.

Required Task Packages#

The automation controller requires three task packages to function:

Table: UNS Export Integration Task Packages

AutomationControllerWorkflow#

The Setup workflow defines the event processing pipeline. It is a ControlFlow workflow containing a single job trigger with a handler branch that executes two sequential tasks.

Workflow Structure#

jobStart (Trigger)
└── handler (Branch)
    ├── codeExecution (Transform CDM event → MQTT topic)
    └── distributedMessageSend (Publish to MQTT broker)

Task: jobStart#

The jobStart task triggers the workflow when a CDM event matching one of the subscribed IoT event definitions is generated.

Task: codeExecution#

The codeExecution task transforms the raw CDM event into an MQTT-compatible message with a constructed topic.

Inputs:

Output:

Code Logic:

The TypeScript code performs the following operations:

1. Extracts Enterprise, Site, Area, and Resource names from the raw CDM event.
2. Applies defaults (DefaultEnterprise, DefaultSite, DefaultArea, DefaultResource) for missing values.
3. Constructs the hierarchical topic string using / as separator.
4. Conditionally includes the Resource level only if present in the event.
5. Extracts the event definition name from the IoT event metadata.
6. Appends the event name as the last topic level.
7. Replaces spaces with hyphens for MQTT compatibility.

For the full code listing and customization options, see UNS Topic Mapping and Customization.

Task: distributedMessageSend#

The distributedMessageSend task publishes the transformed event to the MQTT broker through the UNS Connector service.

Table: distributedMessageSend Task Settings

Inputs:

Outputs:

AutomationControllerIoTEventDef#

This object binds the automation controller to specific CDM event definitions. Each entry subscribes the controller to one event type.

Example Configuration#

The following example subscribes the controller to two light CDM events:

Table: Example IoT Event Definition Bindings

Available Light CDM Events#

• Material Operations
• Resource State Change
• Post Data Collection

To add subscriptions for additional event types, either:

• Use Cortex to create a new automation controller with the desired events, or
• Manually add AutomationControllerIoTEventDef entries to the Master Data Package JSON and reload it.

Loading and Reloading the Package#

Initial Load#

1. Open the Master Data Package generated by Cortex.
2. Select Run > Load on the top ribbon.
3. Select the AutomationController object and confirm.

Reloading After Modifications#

If you modify the Master Data Package JSON (for example, adding event subscriptions or changing workflow code):

1. Navigate to the Master Data Package.
2. Select Run > Load.
3. Select all modified objects.
4. Confirm the reload. Existing objects are updated in place.

Package JSON Structure#

The complete Master Data Package JSON follows this structure:

{
    "<DM>AutomationController": {
        "1": { /* Controller definition */ }
    },
    "AutomationControllerWorkflow": {
        "1": { /* Setup workflow with tasks */ }
    },
    "AutomationControllerIoTEventDef": {
        "1": { /* First event subscription */ },
        "2": { /* Second event subscription */ }
    }
}

Related Topics#

• [Tutorial: Customizing UNS Hierarchyand Payloads]] — developer guide for customizing topics and payloads
• Configuring UNS Export Integration — end-to-end setup guide
• UNS Topic Mapping and Customization — topic structure and customization
• Master Data Packages — general Master Data Package information