Skip to main content

Key Concepts

The Engage section uses a small vocabulary consistently. Most of it is shared with Studio; where a word means something slightly different on each side, this page says so.

Application​

An application in Engage is a provisioned copy of an application published from Studio. It carries the manifest's name and version, and it is the unit that is installed, assigned to tenants, and opened to see executions. A manifest can be installed once per organisation; its card in the provisioning drawer is disabled after that.

Manifest​

The manifest is the description Studio publishes and Engage reads: integrations, events and their schemas, identifiers, retry workflows, and a readme. Engage shows it in the provisioning drawer under Preview, with three panels: Integrations, Events, and Identifiers. See Engage and Studio for how it crosses between the products.

Integration​

An integration is one entry point into an application, backed by one or more trigger workflows in Studio. In Engage each integration has a Status of Active or Inactive, a Type of API or File, and its own configuration of columns, mappings, and views. Executions are listed per integration.

Event​

An event is a business milestone the workflow reports, defined in the manifest with a schema. In Engage, events are what get mapped: each event's schema fields are connected to report columns so the data lands in the right place. A workflow reports an event through the Send to Engage activity, and can report the same event more than once in one execution to update the record in place.

Report column​

A report column is a field Engage stores for every execution record of an integration. Columns have a FieldName, a DisplayName, a Type (String, Integer, Float, or Date), and an optional Description. Engage seeds them from the union of every event schema in the manifest, and an integration can hold at most 70.

Mapping​

A mapping connects one event's schema to the report columns: when this event arrives, the value in schema field X goes into column Y. Engage builds a first mapping automatically by matching names, and the Map Fields drawer is where it is checked or changed. Every event needs a mapping before its data appears anywhere.

View​

A view is a curated selection of columns shown as a table, with a View Name, a View Level, and at least one column marked as Key. Views are hierarchical: level 1 is the summary an operator lands on, and a record there drills down into the next level. The key columns are what Engage compares to decide which lower-level records belong to a higher-level one, so every view needs a different key combination. An integration can have up to four.

Execution and record​

An execution is one run of an integration. What an operator sees in a view is the records that execution produced, each with a Status of Success, Failed, or Pending, a TimeStamp, and the mapped columns. A record's Trace opens the execution trace when one is available; development traces are kept for 7 days and production traces for 90.

Fallout​

A fallout is a failed execution or record that needs an operator's attention. Engage records fallouts per application, and organisation-wide under Global Fallout. Fallout definitions, error definitions, retry configuration, and alerting decide what happens to a fallout after it is recorded. See Managing fallouts and Alerting.

Tenant​

Engage is multi-tenant. An organisation can have tenants, each of which is assigned applications and sees only its own data. The Multi-tenant Data View switch, available to the default tenant only, shows data from every tenant at once. Tenant assignment is the last step of provisioning and can be changed later under Settings > Tenants.

Environment​

Every execution belongs to an environment, Development or Production, selected in the Engage header. Views, the dashboard, and traces all show the selected environment only, and the two have different retention periods.