The Third Party Integration rule lets you integrate your processes with built-in external applications. Two systems are currently supported:
Title
The first part of the business rule lets you define a title for your rule and select the event on which it operates. The default title is the standard FlowForma rule name; change it by deleting the text and entering your own.
In the event field you determine when the rule is executed. For a flow this can occur when the form is loaded, started, or completed. For a step this can occur when the step is started, saved, or completed. For questions it can occur when the question is updated.
Rule condition(s)
The second part of the business rule lets you set conditions. These are not required, but if entered they control when the rule is executed in relation to other items in the form.
Rule actions
- Select source system: select the supported third-party source system you want to use from the drop-down.
- Select business area: select the business area belonging to the selected source system.
- Select feature: once a business area is selected, choose the feature you want to use.
- Select request: choose the request you want to make. Once selected, additional fields are displayed.
- Params: a list of parameters to be mapped and used in the request to the API.
- Key: the name of the key used in the API request.
- Value: the drop-down displays values depending on previous inputs, for example, the available projects depend on the selected user.
- Response: a tree view of the expected response for the API call, letting you map the response to questions in your form.
- Response body: select nodes from the tree view to use when mapping to questions.
- Map body value to: select questions to use in the mapping.
- Mappings: displays the list of current mappings.
Depending on the source system, business area, feature, and request, different input/output options are available for parameters and response.
- Stop execution: if stop execution is enabled and this rule is executed, no other rules are executed.
- Enabled: rules aren’t saved to a list like questions and steps are, so if you want to stop a rule executing without deleting it, toggle this option to enable or disable the rule.
- Enable audit: if checked, a record is added to the audit trail when this rule is executed. This option is available when the Compliance feature pack is activated.
