This article will show you how to create an Advanced Integration.
Note that all dropdowns throughout this workflow are auto-complete dropdowns so you can narrow down your options by typing into the field.
Other Integration options can be found here: Integration Options.
- Navigate to the Integrations tab
- Click + New Integration
- Select the Advanced integration card
- Add a Short Description for your integration which will be used as the title.
- Click Create
- After creating the short description, you will be taken through steps for designing, configuring, and testing & confirming your advanced integration.
Step 1: Design
On this screen, you can select the components for your integration.
You can choose one trigger and up to 10 actions for your advanced integration. To start setting up your integration, simply select one of the components from the panel on the right and drag it onto the grid.
After dropping your selected components onto the grid, you will need to connect your trigger and action(s) and configure each of the components.
You can determine which of the components needs to be configured by the "!" indicator above the component. To configure the component, just click on the component or the ! icon, and the panel on the right will update with the fields that need to be completed for that component.
The selected component will be outlined in Red and a “-“ button will appear above it. If you click on the - button, you will have the option to delete that component. You can also delete the component by selecting the Delete button at the bottom of the panel on the right.
In most situations, your component will have a field for Credentials that needs to be selected. Only the applicable credentials for your selected Trigger or Action will be displayed (i.e. only HCMS credentials will be displayed if you choose HCMS as your Trigger, or only CivicReady credentials will be displayed if you choose CivicReady as your Action.) Additional fields will be displayed after you select a credential.
To move between linked components you can click the button on the bottom of the configuration panel. This button shows information on what your selected component is linked to. To finish configuring your component, click anywhere on the grid.
You will also need to add links for all components on the grid. To do this, you just need to click on the circle port on the right side of the component and connect it to a rectangle port on the left side of a component.
To move onto the next step, you will need one trigger connected to at least one action. You will know you have completed all required configurations for your components when the “!” icons are no longer displayed. After everything is completed, you can select Next to move onto the next step.
Step 2: Configure
After selecting Next on Step 1, you will be brought to Step 2 of setting up your advanced integration where you can configure the fields for your action. In the configuration panel, you will be presented with two sections. The fields from your trigger will be on the top in chips and the fields from your action will be in the section on the bottom. The fields for both your trigger and your action will depend on what you chose in Step 1.
On this step, you will also see a preview of your integration. The link you are currently configuring will be highlighted on the grid.
There are two types of action fields that may show up in the column on the right.
Once all required fields are filled out, users can select Next to move on to Step 3. At any point, users can select Back or click on Design in the progress bar at the top to be brought back to the previous step. Note that if any changes are made, the fields in step 2 will likely change and your previous selections may be lost.
Step 3: Test & Confirm
The third and final step for your Advanced Integration setup is the Test & Confirm step. On this screen, you will see an overview of your integration where you can preview what will trigger and be completed with this integration.
On this screen, you will also see step-by-step instructions on how to test your integration. Note that you will need to first save and enable your integration before your integration can be triggered as described in the Test Instructions.
To save your integration, all you need to do now is select the Save button. If after reviewing your integration overview you need to make changes to the integration, you can return to Step 2 by clicking the Back button.