The difference between Business Processes An organized flow of activities or tasks that achieves a business goal. An automated business process minimizes the amount of paperwork and manual tasks to complete that process by way of automatic actions, online forms, and automatically generated messages. and integrations are:
- Business Processes include tasks that can be automated or done by people.
- Integrations process only data and require minimal or no human intervention.
A Business Process can run an integration from the data integration service task so long as the input parameters are shared. The task calls the integration by way of an API. The Name of the integration is the only input parameter; you cannot specify other parameters of the integration.
Caution: By default, a Business Process retrieves data by using the credentials of the person who initiates the process. However, a process may need to retrieve data that the initiator of the process cannot access. Do this only when absolutely necessary and be careful to not expose data to people who are not privileged to access that data. To access this data, make the API request on behalf of another person; a best practice is to create a user account specifically for this purpose rather than use another real person’s credentials.
To pass integration-specific parameters, use one of the following:
- — Call any REST API.
-
- — Sequence multiple API calls to run an integration so that the user has to enter parameters as part of the Business Process.
Run an integration or integration set
| Endpoint URL | HTTP method | Publishable | Query | Description |
|---|---|---|---|---|
| http://{{host}}/wfc/restcall/v1/platform/integration_instances/execute | POST | yes | n/a | Create an integration instance and submit it for immediate execution in the system. |
| http://{{host}}/wfc/restcall/v1/platform/integration set A sequence of integrations that can be run on-demand or be scheduled._instances/execute | POST | yes | n/a | Create an integration set instance and submit it for immediate execution in the system. |
Run an integration example
{
"id": 1,
"name": "Factory job update",
"description": "Job update for the main factory",
"user": null,
"requestName": null,
"userParameters": [
{
"name": "disqualifyActive",
"type": "RADIO",
"value": true
}
],
"scheduledInfo": null,
"integrationRequestId": null,
"integrationType": "NONE"
}
Schedule an integration or integration set
The user has to enter schedule details such as frequency, start date, and so on.
| Endpoint URL | HTTP method | Publishable | Query | Description |
|---|---|---|---|---|
| http://{{host}}/wfc/restcall/v1/platform/integration_instances/schedule | POST | yes | n/a | Create an integration instance and schedule it for execution in the system. |
| http://{{host}}/wfc/restcall/v1/platform/integration_set_instances/schedule | POST | yes | n/a | Create an integration set instance and schedule it for execution in the system. |
Schedule an integration example
{
"integrationDetails": {
"id": 1,
"name": "Factory job update",
"description": "Scheduled job update for the main factory",
"user": null,
"requestName": "Factory job update-12-22-2017 11:44",
"userParameters": [
{
"name": "disqualifyActive",
"type": "RADIO",
"value": true,
"templateParamName": "disqualifyActive"
}
],
"scheduledInfo": "Recurs by day starting December 16",
"integrationRequestId": null,
"integrationType" :"NONE"
},
"eventDetails": {
"eventId": null,
"restPost": null,
"schedule": {
"frequency": null,
"frequencyType": 2,
"interval": "4",
"startTime": "12:12pm",
"endTime": null,
"forever": true,
"startDateTime": "12/16/2017",
"endDateTime": null
},
"event": null
}
}