Skip to main content

Policy Adapters

External Policy Adapters allow you to provide dynamic content to application users in Journey Task UI. There are three types of policy adapters, all of which are supported in Integration Flows.

Policy AdapterFunction
Custom Search ProviderAllows a User to search and filter a dropdown listing content provided by an external source. When a value is selected the adapter can populate either a single entity field or DataGroup record.
Search Provider (Single Field)
Search Provider (Single Field)

Search Provider (DataGroup)
Search Provider (DataGroup)
Custom Validation ProviderAllows an external provider or Integration Flow to receive a single field or datagroup and return a validation status and message
Validation Provider (Single Field)
Custom Task ProviderSome Journey Tasks allow you to configure a custom task provider which adds a button to the UI allowing an external service provide custom validation & message.
warning

Policy Adapters require sychronous communication (Request/Response) and therefore do not support async operations that pause the Flow Execution such as a Wait task or HTTP Callback

Configuring a new Provider

Open the Policy API Providers screen (Policy -> API Providers) and add a new provider based on the desired type. Each policy provider includes a new "Integration Flow" toggle to switch between an external implementation (HTTPS) or Integration Flow. When choosing Integration Flow you'll see a list of published Policy flows.

External Data Providers
Custom Search Provider (DataGroup)

Runtime Details

The Execution.Request object will store the following data at runtime depending on the type of Policy Adapter being implemented:

Execution VariablesDescription and Data Type
Search Provider (Single Field)
FieldNameString. Datakey of field as specified in Policy
FieldValueString. Value entered by User in UI dropdown
Search Provider (DataGroup - Search)Search for DataGroup include two separate calls.
- Search: To query matching results (including record identifier)
- Get: To retrieve the selected record's details
Fields[ {} ]
   FieldNameString. Field Name from Provider Configuration
   FieldValueString. Value entered by User in UI dropdown
Search Provider (DataGroup - Get)
   suggestionIdRecord Identifier to retrieve the complete details
Validation Provider (Single Field)
FieldNameString. Field Name from Provider Configuration
FieldValueString. Value entered by User in UI dropdown
EntityId
EntityDraftId