Managing Tenant Connection Settings
Last updated
.svg?alt=media&token=47f65a9a-1173-415f-99c4-53091d7c9a52)
Last updated
The connections setting page can be used to configure an instance of an integration (i.e. a tenant) to run according to its end user’s needs. This is important when an integration has multiple tenants whose end users may have different needs.
The connection settings page can be accessed from the Integration Hub by going to the tenant detail page and clicking the settings button.
An integration end user can also access the connections settings page from the In-App Marketplace by going to 'My Apps', locating the card for an installed app, clicking the three-dot button to open the app’s dropdown, and clicking 'Connection Settings' from the dropdown.
When accessed from the Integration Hub, the first configuration option on the Connection Settings page is always the integration release, i.e. which version of the integration the tenant will run. To learn more about Pandium’s release management features, review .
Other configuration options on the Connections Settings page will vary based on the integration. These integration-specific options can either be static or dynamic.
A configuration is called static when its options are the same for every tenant. Each tenant’s end user may make a different selection, but the same options are presented to every tenant.
Common static configurations allow certain flows to be enabled/disabled and basic options to be selected.
For example, a Gorgias <> Klaviyo integration could include the following options:
Enable a flow to sync Gorgias customers to Klaviyo profiles
Enable a flow to sync Gorgias Events to Klaviyo events
A multi select menu for the end user to choose which standard types of Gorgias events should be synced to Klaviyo.
A configuration is called dynamic when its options vary from tenant to tenant. For example, each Klaviyo account has its own set of lists that can be used to organize profiles.
A Gorgias <> Klaviyo integration could have the following dynamic configuration:
A multi select menu that provides Klaviyo lists for that tenant. Since each tenant will be connected to a different Klaviyo account, the options in this menu will be different for each tenant.
The integration end user would be able to select the Klaviyo list to which new profiles should be added when they are synced to Klaviyo.
The options to populate a dynamic config must be fetched from the API during an init sync
When a tenant is first created through the Integration Hub, it will initially display “placeholder” instead of any account specific options. After an init sync has been run for the tenant, the account specific options should appear for all dynamic configs on the connection settings page.
Compared to the following:
There are multiple ways in which an init sync can be triggered:
In-App Marketplace - Initial Install:
When the end user installs an integration that uses dynamic configs via the In-App Marketplace, Pandium will automatically run an init sync before the end user can fill out any configuration data. This means In-App Marketplace end users should not see the “placeholder” option for a dynamic config.
In-App Marketplace - Refresh Button
An end user can trigger an init sync by clicking the 'refresh configs' button when configuring the app via the In-App Marketplace.
Integration Hub - Init Sync
An init sync can also be triggered manually int the Integration Hub when viewing a tenant, clicking Sync Now, and selecting Init sync in the top right.
An init sync can also be triggered manually int the Integration Hub when viewing a tenant, and clicking the Sync Now, and selecting Init sync in the top right.
The static and dynamic options in the connections setting page are determined by the integration’s PANDIUM.yaml. To learn more about how the PANDIUM.yaml is used for this, review this article.
