Skip to main content
You are here: Integrations

SSAM UX Functionality

Overview

Override standard Service Assignment Manager (SAM) list and detail views with custom Mirata forms using the SSAM UX functionality.

Understanding the User Flow

When you click an item in the initial custom list form, item information (e.g., Work Order ID, Operation ID) is collected into a context binding object. The system uses this object to evaluate rules in the SSAM UX <Business Object> table, following the order specified in the Order column.

The Form from the first matching rule is selected and displayed. If no rule matches, the Default form from the SSAM UX Configuration table is used.

Enabling SSAM UX Functionality

You need two data tables: the SSAM UX Configuration table and the SSAM UX <Business Object> table.

Configuration Table

The SSAM UX Configuration table requires a specific schema (see documentation). This table contains the following columns:

Record Key: The default record identifier.

Initial: The ID of the initial UX list form.

Evaluation: The integration action (embedded integration event) triggered by clicking a list item, signaling the MDK extension control.

Binding: The integration data mapping action, which constructs the context binding (JSON object) for evaluation and detail form presentation. This can be extended.

Default: The ID of the default Mirata form if no evaluation rules match.

Display: The integration action used to present the selected form.

Business Object Table

The SSAM UX <Business Object> table (e.g., SSAM UX Work Order) also has specific columns:

Record Identifier: The default record identifier.

Order: An integer determining rule processing order.

Form: The ID of the form to display if the row's criteria are met.

Remaining Columns: Predicates based on import data mappings. Values returned are compared against these columns, which must be string-convertible.

Evaluation Logic:

The context binding contains data used to evaluate the import data mappings in the predicate columns of the SSAM UX <Business Object> table. The rows in this table are checked in the order specified in the Order column. The first row where all predicates match the context binding data (or are marked with "~" for "don't care") determines the form to display. The Order column is crucial for controlling the rule evaluation sequence.

Configuring Forms

Interim forms (like initial list forms) must have the ssam-ux (lowercase) header parameter. These forms are not persisted.

Data entry forms should not have the ssam-ux header parameter. These forms are persisted.

Customizing Context Binding

The base example uses the standard SSAM context binding. You can override or extend this to include additional data. This may evolve as UX implementation progresses.