By placing a [Message Start Event (HTTP)] (which is the mechanism for starting a Case triggered by an HTTP request) a new Case that uses the request data will be automatically started every time it receives an HTTP request. For example, you can establish inter-system links, such as launching a "payment reminder App", from a core system.
1. Usage Examples of the [Message Start Event (HTTP)]
- a. Starting from Other Systems
"Error Address Corresponding flow" will be Started automatically by the customer management system
- b. Launching from Other Apps
Automatically pass the Order data in the "Contract flow" to the "Production flow"
2. Setting [Message Start Event (HTTP)]
- 1. Receiving Data Item
Set the Data editing permissions in the [Message Start Event (HTTP)] Settings to Editable for all Data items
- By clicking [URL, Reception parameter], you can refer to the launch URL (request URL) and the names of the receiving parameters ([Field name] of the Data Items)
- After releasing the App, an auto-step icon to connect to the released Start Event will be added to the app editor on the same workflow platform
- If the sent data does not satisfy the required setting, minimum/maximum length, or input check of the Data Item that stores the data, the Case startup will fail
3. Preparing the Data Transmission Mechanism (External Settings)
- 1. Request URI
Specify App ID and Event Node number using the Parameter Details
- 2. POST body parameter
Specify "API key" and "business data to be substituted"
- Request parameters can be either GET or POST (POST is recommended, GET is partially prohibited)
- File data are transmitted by POST multipart
- The use of the system variable ${var[applicationRoot]} is valid for communication on the same workflow infrastructure
- The value of API key arbitrarily can be set with halfwidth alphanumeric characters, at most 100 in length
- Communication from external networks is not permitted by default (M312)
- It is possible to filter the source IP address for each triggering URL (M312)
- If the communication is on the same workflow platform, it is effective to use [Service Task (Start Child Case) ]
BPMN Icons: Service Task (Start Child Case)
BPMN Icons: Message Start Event (HTTP)
R2210: Data Receiving Parameter and Samples
When using [Service Task (Start Child Case) ], refer to;
M411: Auto-starting a "Billing App" Triggered by a "Shipping App".
When using [Throwing Message Intermediate Event (HTTP)], refer to;Fis
M225: Auto Sending of HTTP Requests with Business Data Inserted.
A. Corresponding with JSON-Webhook, etc.
- Place a [Message Start Event (Webhook)] at the beginning of the flow
Change the auto-start node from [Message Start Event (HTTP)] to [Message Start Event (Webhook)] - Set the receiving method
Specify the method and content-type (e.g. "POST application/json"、"PUT text/xml", etc.） - Set the storage location of the Body section
Specify String type multiple-line Data Item in which received data will be stored - Define the Response
Insert Case data as necessary （"application/json;charset=UTF-8","text/xml;charset=UTF-8"）
- Even though it is possible to set patterns that are cannot be set with normal REST communication, it is not recommended (e.g. GET communication specifying Content-Type, etc.）
- In many situations, some automatic processing Steps are placed downstream to extract the necessary information from the received data
- Even if the Query parameter has been given [Message Start Event (Webhook)] ignores the query part
BPMN Icons: Message Start Event (Webhook)