Configure an Integration
Every integration an application has is listed in Engage as soon as the application is installed, but none of them records anything until it is configured and enabled. The Configure form is where that happens, and it is the same form whether you reach it during provisioning or weeks later.
Before you begin
- The application is installed. See Provision an application.
- You are an organisation member. Configure is disabled for tenant users.
Open the form
Either of these reaches the integrations table:
- During provisioning, the drawer's second step, Choose Integration and Configure Data, shows the table directly.
- Later, select the application's row under Applications, select the Configuration tab, then Integrations.
The table has one row per manifest integration, with Status, Name, Workflow, Type, Description, Updated At, and a Configure Report column. The Type filter offers API and File, and Status is Active or Inactive.
Select Configure on the integration's row. The drawer is titled Add an integration the first time and Edit an integration once a configuration has been saved.
Work through the four sections
The drawer is one long form in four sections. The first is completed here; the other three each have their own page because they carry their own rules.
Integration details
| Field | What it holds |
|---|---|
| Integration Type | API or File, read from the manifest. Cannot be changed here. |
| Integration Name | The name from the manifest. Cannot be changed here. |
| Enable Integration | Off by default for a new configuration. Switch it on to start recording executions. |
If the type or name is wrong, the fix is the manifest in Studio: select Update there, then sync the application in Engage as described in Engage and Studio.
Define report columns
Select Add columns to open the column table. The count beside it, N Columns added, is seeded from the manifest's event schemas before you touch anything. See Define report columns.
Event Mapping
One row per event, each with a Map Fields link. Rows and a first name-matched mapping are created automatically once columns exist. See Map events to columns.
Configure Views
Select Configure Views to arrange columns into one to four views. The count beside it, N Views defined, starts at one because Engage creates a default view. See Configure views.
Save
Select Save in the drawer footer, or Update when editing an existing configuration. Engage confirms with Integration updated successfully and closes the drawer.
The three sub-drawers for columns, mappings, and views each have their own Save or Add button, but those only hand the result back to this form. Nothing reaches Engage until this drawer's Save.
How you know it worked
In the integrations table, the row's Status reads Active and Updated At shows the time you saved. Opening Configure again titles the drawer Edit an integration and shows the saved counts.
When it does not work
| Symptom | Cause | What to do |
|---|---|---|
| Configure is greyed out | You are signed in as a tenant user | Ask an organisation member to configure the integration |
| Failed to update integration | Engage could not save the configuration | Try again; if it persists, reopen the form and check that every event with a mapping still has an event selected |
| Status still reads Inactive after saving | Enable Integration was left off | Open Configure, switch it on, and select Update |
| The integrations table is empty | The application was synced before the manifest had integrations | In Studio, confirm the manifest lists integrations and is published, then sync the application from this tab |