External Data Adapter
External Data Adapters allow clients to search for and import data from external sources. Previously clients would need to host an API outside of Fenergo to receive Adapter Requests and orchestrate calls to their existing systems.
Using Flows that orchestration can now be run within Fenergo.
Flows only supports TEST, SEARCH and GET methods of External Data Adapter. Ongoing Monitoring and Document Import are not currently supported.
Configuring a new Provider
Open the External Data Providers screen (IntegrationHub -> External Data) where you can add manage your External Data Providers.
The Flow Provider Configuration screen lets you map each External Data Request (Test, Search, Get) to a Flow. You can build a separate Flow per request, or build one Flow that handles all three requests See 'Gleif Search & Import' in Templates for an example.
After you've linked your Flow to each Adapter Request you can map the request/response schemas to your policy definition. See External Data Adapter Configuration for more details.
Runtime Details
ExternalDataAdapter sends three different events - TEST, SEARCH, GET. The Execution.Request object will store the following data for each event:
| Execution Variables | Description and Data Type |
|---|---|
| Id | String. Unique Identifier of the External Data Adapter Request. |
| Tenant | String. Tenant Id the External Data Provider and Flow are running in. |
| ProviderId | String. External Data Provider Id sending the request |
| Type | String. Unique Identifier of the Task in Journey for the running Flow |
| Request | Type = Test |
| Id | String. Unique Identifier of the External Data Adapter Request. |
| Request | Type = Search |
| EntityType | String. Fenergo Entity Type [ Individual | Company | Other | Group ] |
| SearchCriteria | Object. Fields that have been mapped on Search Request. These will be populated with the values from the Entity being searched. |
| Request | Type = Get |
| EntityType | String. Fenergo Entity Type [ Individual | Company | Other | Group ] |
| Id | String. Unique Identifier of the Entity provided by the previous Search call |
| Data | Object. Fields that have been mapped on Get Request. These will be populated with the values from the Entity being fetched. |