For a specific provider, a custom step can be added to the flow step sequence of any business flow from within the Gateway user interface using Gateway scripting language. This flow step is an alternative option to:
- Adding a external custom step using Java
- Adding a internal custom step using Java
Note: Gateway scripting language is distinct from Groovy Scripting Language. For more details on how to code a custom step, see Gateway Scripting Language Guide.
A business flow is executed as an ordered sequence of flow steps. So, the positioning of a custom step depends on the role of the provider in a business flow.
Use the following table to position a custom step in the default flow step sequence:
If Provider Role in Business Flow is... | Add Custom Step... |
|---|---|
Source | with a sequence number in the range 1 - 19. |
Destination | with a sequence number in the range 61 - 79. |
You can also add a custom step in Gateway between sequence numbers 21 - 59.
The steps can then be organized as follows:
- (Optional for Source Provider) <Custom Step Name>: This step runs the custom step to the source data. It can be added in the flow sequence for a source provider with a sequence number in the range 1 - 9.
- Load from Source: This step loads the data from the source application into the Gateway framework so that it can be processed.
- (Optional for Source Provider) <Custom Step Name>: This step runs the custom step to the source data. It can be added in the flow sequence for a source provider with a sequence number in the range 11 - 19.
- (Optional in Gateway) <Custom Step Name>: This step runs the custom step within Gateway. It can be added in the Gateway flowside sequence with a sequence number in the range 21 - 59.
- Convert from Source to Gateway Format: This step converts the source data to the Gateway format.
- Convert to Destination Format: This step converts the data from Gateway format to the destination format.
- (Optional) <Custom Step Name>: This step runs the custom step to the destination data. It can be added in the flow sequence for a destination provider with a sequence number in the range 61 - 69.
- Review data: This step enables you to review the source data before updating the data in the destination application.
- (Optional) <Custom Step Name>: This step runs the custom step to the destination data. It can be added in the flow sequence for a destination provider with a sequence number in the range 71 - 79.
- Update Destination: This step saves the data into the database of the destination application.
Note: Although custom steps can be added after the last Update Destination flow step (sequence number 80), these will not be processed by the business flow.