Onboarding an Application
Onboarding takes an application that Studio has published and turns it into something an operator can watch. It is one journey with a fixed order: each step needs the one before it, and the last step is the check that data actually arrives.
Before you begin
- The application's manifest is published from Studio. If the status tag in Studio's manifest panel does not read Published, start with Prepare an Application for Engage.
- You are signed in to Engage as an organisation member, not as a tenant user. Tenant users can see integrations but cannot select Configure.
- At least one workflow in the application contains a Send to Engage activity, so there is something to validate at the end.
The journey
| Step | Where | What you do | Guide |
|---|---|---|---|
| 1 | Studio | Configure and publish the manifest | Prepare an Application for Engage |
| 2 | Engage > Applications | Sync the published manifests, choose one, and install it | Provision an application |
| 3 | The Provision New Application drawer | Open the integration's Configure form and enable it | Configure an integration |
| 4 | The Configure form | Confirm or add the report columns | Define report columns |
| 5 | The Configure form | Map each event's schema to the columns | Map events to columns |
| 6 | The Configure form | Arrange the columns into views and save | Configure views |
| 7 | Studio, then Engage | Run the workflow and find its records in a view | Validate the data flow |
Steps 3 to 6 happen inside one form, reached from the second step of the provisioning drawer or, later, from the application's Configuration tab. They are separate pages here because each has its own rules, but you save them together.
What Engage does for you
Much of the form is pre-filled from the manifest, so a first pass is mostly checking:
- Integration Type and Integration Name are read from the manifest and cannot be edited in Engage.
- Report columns are seeded from every field in every event schema, deduplicated by name.
- Each event gets a mapping row, with fields matched to columns by name.
- A default view is created, named after the integration, with the first column as its key.
A first onboarding can therefore be as short as enabling the integration, checking the mappings, and saving. The pages that follow explain what each pre-filled part means so you can tell whether the default is right.