You are viewing the documentation for Blueriq 14. Documentation for other versions is available in our documentation directory.

This container can be used for embedding an external flow from a different Blueriq application. 

See also Decoupling Pattern 8: External Flow Container

To have the AQ_ExternalFlow container definition available, please make sure your project references the latest AquimaLibrary version. 

Parameters 

ParameterDescription and usage
ConnectionThe expression results in the name of the connection used for configuring the flow on the target runtime.
Data MappingThe Data Mapping used for mapping the data between the source profile (current domain) and the interface profile (contract domain).
Contract The name of the Contract that the container needs to implement. Selecting the Contract triggers the pre-fill of the Contract events in the "Events" tab. 
Contract events

when opening the "Events" tab, in the "Contract events" group, there are 3 columns : 

  • Type : the event definition column, pre-filled with event definitions from the selected Contract
  • Mapping : the flow events to which the contract events are being mapped to 
  • EventType : the flow event type. Supported values are : CommitSkipValidate (Continue) and Rollback (Cancel)


Example for configuring the connection: 

application-external-flow.properties
blueriq.connection.<connection-name>.external-flow.project = projectname // the REQUIRED name of the project that contains the flow to be started
blueriq.connection.<connection-name>.external-flow.version = 0.0-Trunk // the REQUIRED  version of the project that contains the flow to be started
blueriq.connection.<connection-name>.external-flow.flow = flowname // the REQUIRED  name of the flow to be started
blueriq.connection.<connection-name>.external-flow.channel = channel // the OPTIONAL name of the channel be started
blueriq.connection.<connection-name>.external-flow.baseurl = https://<external-url>:<port>/Runtime/server // the OPTIONAL URL of the external host where the target project is on (if omitted the same server is assumed).

Alternatively, since Blueriq 12.9, it is possible to indicate a shortcut. When using the shortcut-name property, the project, version and flow properties are no longer required.

The shortcut should point to the target runtime, where the external flow is defined.

application-external-flow.properties
blueriq.connection.<connection-name>.external-flow.shortcut-name = myShortcut
blueriq.connection.<connection-name>.external-flow.channel = channel
blueriq.connection.<connection-name>.external-flow.baseurl = https://<external-url>:<port>/Runtime/server

When both a project/version/flow and a shortcut are configured, the shortcut takes precedence.


The connection name, namely <connection-name> in the example above, needs to match the result of the evaluated expression in the "Connection" parameter of the AQ_ExternalFlow container.