Build your Pipeline - Enate Integration Pattern 1
Last updated
Was this helpful?
Last updated
Was this helpful?
This walkthrough will take you through how to integrate an external system into Enate using our Enate Integration Services iPaaS approach powered by Snaplogic. This will demonstrate one of the four standard patterns which you can achieve with iPaaS, specifically Pattern 1 where we want to update or get data from an external system at a known point in an Enate Workflow. The shortcuts to the main sections for building this pattern are:
Enate Configuration - Case, Action & Data Fields
SnapLogic Pipeline Construction - Building the Snaps
Getting Enate to call the Pipeline
What you'll need in order to connect Enate with 3rd party systems using Enate Integration Services:
Enate Access – An Enate instance where you have Builder-level admin access
Enate Integration Services (Snaplogic) Access –
Familiarization with Snaplogic – see the SnapLogic Overview section for this.
A 3rd Party system (in this example HubSpot), where you have configuration-level admin access.
We will build a standard Enate Case process which gets created each time there is a new business Deal in our are of the business. Part of this case calls an external system (we'll use HubSpot here) to bring data into the Enate Case process. This could just as easily be e.g. SAP, Salesforce etc.
This will be done by calling out to Enate Integration Services (powered by Snaplogic) which will grab the data from HubSpot, update the Enate Action, and then confirm that the API call is complete. The main activities in the end-to-end flow are as follows:
In Enate: External API Call – a ‘Trigger External API’ action is placed into the Case flow in Builder. This calls out to Enate Integration Services (Snaplogic) to run a specific Pipeline. Then the SnapLogic pipeline...
Calls the 3rd party System (HubSpot) – In Snaplogic a pipeline is called, this will make a call out to the 3rd party system, in this case HubSpot.
Obtains Data from HubSpot - The incoming information passed into HubSpot will allow the relevant values to be identified and sent back to Snaplogic.
Generates a Bearer Token for Accessing Enate - while this part isn't strictly necessary to complete the final snap in the pipeline (which will actually use a Callback URL for authorization instead in this example), knowing how to generate a Bearer Token for getting authorized access to your Enate system will be essential for your pipeline work going forward.
Updates Enate Data Fields & Confirms Completion of Enate Action – The updated field values are sent back to the Action in Enate, ‘Trigger External API’ action in Enate is marked as complete, allowing the Enate Case to move onto the next part of the Enate flow.
Steps for the required Enate configuration are as follows:
In your Builder environment, create a new Case process for New Deals.
In conjunction, create a series of new Custom Data fields and a Custom Card for them to show on.
Set Field values as follows:
Field Name
Field Type
Dropdown Values
Deal Name
Text
New Business; Existing Client
Deal Type
Simple Dropdown
Deal owner
Text
Priority
Simple Dropdown
Low; Medium; High
Deal Amount
Number
Created Date
Date/Time
Close Date
Date/Time
Link the Custom Card to the Case configuration.
Add a new Action at the relevant point in your Case process. You may need to create a brand new Action. Give it a sensible name, and choose type ‘Trigger External API Action’.
You’ll need to set the following information as part of the detailed Action settings:
Attribute
Value
Notes
API Integration URL
See section below on setting this value.
Response Expected
True
Set this if you wish the process to time out if you have not received a response after a certain amount of time.
Response Expected Within (Mins)
10
You can set your desired timeout minutes here, this value is a suggestion only.
The API Integration URL you enter here will call a specific Pipeline in Enate Integration Services (Snaplogic). To add that url in this Enate action’s config, you’ll first have to create that Pipeline in Snaplogic. In addition to pointing this action at the right Snaplogic location and instance, the Pipeline will also require some authentication before it will allow the action to access it. This is done by adding in a ‘Bearer Token’ as a variable at the end of the url. The format of the url is:
https://[snaplogic pipeline link] + ‘?bearer_token=’ + [the pipeline’s bearer token’], e.g.
Check out this section on How to obtain the pipeline url and the bearer token from Snaplogic.
Once you’ve completed your steps to create your pipeline and token, you will need to circle back round to here to complete your action configuration (at which point you may then be ready to test the end to end process).
Set an Allocation rule to route the Action back to the work item starter – this would be used in the situation where the action times out, to provide a ‘human in the loop’ to deal with any issues.
Now that your Enate action to trigger your Enate Integration Services pipeline is almost complete, we can move over to Snaplogic and start to create the Pipeline. As a prerequisite, check out the SnapLogic Overview section to make sure you are comfortable navigating around Snaplogic and creating Pipelines.
Here is downloadable example of this Pipeline:
This section walks through how to configure each of the snaps in the pipeline. Once this is done, you can configure Enate to call this pipeline. Snaps 2 & 3 relate to the third party system, in this example Hubspot. When building your own version of this, the details of how to configure equivalent snaps will obviously be specific to YOUR third party system.
Once this Pipeline is created, it's time to circle back to the Enate configuration to tell the Enate Action which Pipeline to call from SnapLogic. This is done by creating a Triggered Task in SnapLogic...
To tell Enate how to call this pipeline we need to:
create a Triggered Task in SnapLogic
Paste the url for this Triggered Task back into the configuration settings for the Enate Action, along with an additional variable for a SnapLogic Bearer Token.