Skip to main content

Tenants

A tenant is a separate organisation inside your Engage organisation, with its own members and its own view of the data. Tenants see only the applications you provision to them, filtered to the identifier values you set, so one Engage organisation can serve several customers without any of them seeing another's records.

Before you begin

  • You are an organisation member, not a tenant user. Tenant users see this page but cannot invite, edit, or delete tenants, or change what is provisioned to them.
  • The email address of the person who will own the tenant. Engage invites them by email, and the tenant becomes active when they complete setup.
  • For provisioning, the application is already installed. See Provision an application.

Open the tenants page

Select Settings > Tenants. Tenants are split across two tabs: Active for tenants whose owner has completed setup, and Invited for the rest. Both show Name, Contact Email, and Identity Id, with a copy control beside the identity that confirms Identity ID copied. Search tenants filters by name or email, and Refresh reloads the list.

Invite a tenant

  1. Select Invite Tenant. The Create Tenant drawer opens.
  2. Enter a Tenant Name.
  3. Enter the owner's email address in Invite Owner.
  4. Optionally enter a Description.
  5. Select Invite.

The tenant appears on the Invited tab. Managed Identity Id is filled in by Engage and cannot be edited. Until the owner completes setup, the row's Resend Invite action sends the invitation again and confirms with Invite Sent Successfully.

Edit or delete a tenant

On the Active tab, each row has an action menu:

  • Edit opens the Edit Tenant drawer. The name and description can change; the owner's email cannot. Select Update.
  • Delete asks for confirmation and explains that the tenant is removed and can be re-invited later. Select Delete.

Provision an application to a tenant

  1. Select the tenant's name on the Active tab. The tenant's page opens on its Provision Applications tab, listing what it already has with Name, Environment, and Created at.
  2. Select Provision Application. The Provision Application drawer opens.
  3. In Choose Application, select an installed application.
  4. In Environment, select Development, Production, or both. The tenant sees this application's data only in the environments chosen here.
  5. If the application's manifest defines identifiers, an Identifiers group lists one field per identifier. Enter the values that mark this tenant's records. A field accepts several values; type one and press Enter to add the next. Identifiers the manifest marks as required must have a value.
  6. Select Provision Application in the drawer footer.

The application appears in the tenant's table. The same drawer is the third step of the provisioning flow, described in Provision an application.

To change environments or identifier values later, open the row's action menu and select Edit; the application itself cannot be changed, so select Delete and provision again if the wrong one was chosen. The delete dialog says the application is removed and can be provisioned again.

How you know it worked

A newly invited tenant appears on the Invited tab and moves to Active once its owner completes setup. A provisioned application appears in the tenant's Provision Applications table with the environments chosen, and a member of that tenant who opens Applications sees it listed.

When it does not work

SymptomCauseWhat to do
Invite Tenant is missingYou are signed in as a tenant userAsk an organisation member
This tenant name already exists!Another tenant has that nameChoose a different name
Please enter a valid email addressThe owner address is malformedCorrect it
Error Sending InviteThe invitation could not be sentTry Resend Invite again later
The tenant stays on InvitedThe owner has not completed setupUse Resend Invite and ask the owner to follow the email
The tenant sees no data for a provisioned applicationThe environment the workflow runs in is not selected, or the identifier values do not match the recordsEdit the provisioned application and check Environment and the identifier values

Next steps

Register where alerts for tenant applications should go: Channels.