Comment on page
Creating and Managing Integrations
In order to deploy an integration through Pandium, you must first create the integration. The steps below will walk you through how to do so.
Internal integrations are fully powered by the platform, and require more advanced configuration. Pandium creates releases based on changes to your repository.
External Integrations are for creating integration tiles for pre-existing and third-party integrations. This is most relevant when embedding the marketplace, and wanting to show integrations that Pandium doesn't know are installed. See Embedding the Marketplace for more information.
Below, you'll find the steps to setup both types of integrations.
If you've clicked 'Internal Integration', you'll be brought to the initial configuration page. The first step is to tell Pandium the connectors that your integration will be using.
If you select the Global option, then you will only need to connect to it once, and then all of your tenants will share the same global secrets.
Applying to both types of integrations, here is where you fill in the information you want displayed for end-user discovery as well as a unique identifier for your integration.
Next is the repository settings, which is where you tell us where your integration code lives.
- Repository URL: A link to the repository Bitbucket, Azure, or Github.
- Repository Tracking Branch: You can tell us the branch to track for releases. Every time we see this branched pushed we will create a new Release.
- Repository Path: Path to PANDIUM.yaml relative to the root of the repository. If left blank, we will look for the file in the root.
Once your integration is created, if you want to set default release behavior for instances of the integration that your clients install via the marketplace, you can select 'Configure' once the integration is created. Learn more about here.
Here, you set the default schedule that the end-customer user will be able to select when setting up their integration. You can also set up a drop-down schedule so that your end-customer users are able to pick for themselves. In either case, you can use simple intervals, or use cron string format to define the frequency.
Lastly, you can determine if the tenant schedule is active or not on initial install by toggling the sync schedule.
Once your integration settings are input, click 'Create' and this will save your settings, and take you to the following 'Provisioning' tab.
If the connectors you selected during your integration configuration require any credentials, such as a Client ID or Client Secret that is necessary to facilitate a 3rd-party connection, you'll input that here. If there is no need for any, Pandium will display that information.
On connectors, you will also see an 'Show Secret Keys' button - clicking this will show you relevant variables used for this connector, which can aid in the development of the integration.
Once you're done, you will land on the integration detail page for your newly-created integration. If you navigate away from here, you'll be able to find it under the 'Unpublished' tab under the 'Integration' Resource on the sidebar.
Applying to both types of integrations, once you've created the base configuration for your integration, you'll be taken to the integration detail page. Here, you'll see 'Marketplace Setup' as an option near the top right. You'll be able to add/edit the theme, copy, and content of the actual marketplace tile that will show your integration.
When you are ready to officially publish your integration, toggle the "Publish in Marketplace" button.
You'll also see the toggle in this area that determines whether or not an app displays in the Carousel feature (if enabled).
If you are setting up an external integration, then you'll setup the integration name and ID the same as an internal integration setup, as well as provide a link to the landing page, and an ID for how we should refer to this integration programmatically. This is most relevant when embedding the marketplace, and wanting to show integrations that Pandium doesn't know about as installed. See Embedding the Marketplace for more information.
Once an external integration is created, you will land on the integration detail page.
Last modified 13d ago