Skip to main content

Provision an Application

Provisioning creates an Engage application from a manifest Studio has published. It is the first action taken on the Engage side, and the one that most often stalls, because a manifest that has not been synced is invisible.

Before you begin

  • The manifest is published in Studio. A saved but unpublished manifest never reaches Engage.
  • You are an organisation member. The Configure action inside the drawer is disabled for tenant users.

Open the provisioning drawer

  1. In the Engage sidebar, select Applications.
  2. Select Provision Application in the toolbar.

The Provision New Application drawer opens across the whole window with three steps across the top: Choose Application, Choose Integration and Configure Data, and Assign Application to Tenant.

note

The empty-state button does nothing. When the organisation has no applications yet, the page shows You don't have any applications with a Create an Application button. That button opens nothing in the current release. Use Provision Application in the toolbar instead.

Choose the application

  1. Select Sync Manifests. Engage confirms with Manifests synced successfully! and the cards refresh. Do this every time you are looking for a manifest published since you last opened the drawer.
  2. Find the manifest. Use Search manifests to filter by name, or Sort: to switch between Alphabetical (A→Z) and Recently Installed.
  3. Optionally select Preview on a card to read the manifest's readme and its Integrations, Events, and Identifiers panels before installing. Select the back arrow to return to the cards.
  4. Select the card. Its border highlights.
  5. Select Install. The button reads Installing... while Engage creates the application, then confirms with Application installed successfully! and moves to the next step.

Each card shows the manifest name, its version in parentheses, and who created it. A greyed-out card is a manifest already installed in this organisation. You can still select it: the button then reads Next instead of Install, and the drawer moves straight to configuration of the existing application without installing again.

Configure the integration

The second step lists the application's integrations, one per integration in the manifest. Configuring them is its own task: Configure an integration. You can also select Next now and come back to it later through the application's Configuration tab.

Assign the application to a tenant

The third step shows the organisation's tenants under two tabs, Active and Invited. If the organisation has no tenants, the lists are empty and there is nothing to do here; select Finish.

To assign the application now:

  1. Select an active tenant's row. The tenant's page opens on its Provision Applications tab.
  2. Select Provision Application.
  3. In Choose Application, select the application you just installed.
  4. In Environment, select Development, Production, or both.
  5. If the manifest defines identifiers, an Identifiers group appears with one field per identifier. Enter the values this tenant's data carries. Each field accepts several values; type one and press Enter to add the next.
  6. Select Provision Application in the drawer footer.

Select Finish. Engage confirms with Application created successfully! and closes the drawer. Tenant assignment can be changed later under Settings > Tenants.

How you know it worked

The application appears as a row in the Applications table, with its Name, Workspace Name, Created By, and CreatedAt. Selecting the row opens the application. Up to five applications can be pinned to the top of the table from the pin control on the row; Engage confirms with Application pinned.

When it does not work

SymptomCauseWhat to do
The manifest is not among the cardsIt has not been synced into Engage since it was publishedSelect Sync Manifests
The manifest is still not among the cards after a syncIt is saved but not published in StudioIn Studio, open the manifest and confirm the status tag reads Published
No Manifests Available To Install.No manifest has been published to this organisation, or none has been syncedPublish from Studio, then select Sync Manifests
The card is greyed outThe manifest is already installedOpen the existing application from the Applications table instead
Please select an application first!Install was selected with no card highlightedSelect a card, then Install
Failed to install the application!Engage could not create the application from the manifestTry again; if it persists, ask an administrator to check the manifest sync
Failed to sync manifests!Engage could not reach the manifest serviceTry again later, or ask an administrator

Next steps

Configure an integration.