On Resource Begin Setup Request#
This trigger task listens for Begin Setup requests coming from the MES and lets a workflow perform the equipment-side setup for the Resource that is being set up.
It belongs to the System / MES category, under Triggers, and is available in both Data Flow and Control Flow workflows. In a Control Flow workflow it appears as a Start trigger named When a Resource performs Begin Setup.
Details#
| Fields | Details |
|---|---|
| Scope | Connect IoT Data Platform Enterprise Integration Factory Automation |
| Workflow | Data flow Control flow |
IsProtocol flag |
Behavior#
When an operator performs Begin Setup on a Resource, the MES sends a request on the ConnectIoT.BeginSetup.RequestReply subject and waits for a reply. This task receives that request, emits the resource that is being set up, and emits Success.
The MES stays blocked until a reply is sent. If none is sent within the Reply Timeout, the task emits Error and the Begin Setup fails on the MES side.
The reply is produced differently depending on the workflow type:
- Control Flow - the reply is the result of the trigger's handler branch.
- Data Flow - a downstream Send Resource Begin Setup Reply task sends the reply.
Inputs#
| Name | Data Type | Description |
|---|---|---|
| Enable/Disable | Boolean | Enables (true) or disables (false) the message listener at runtime. Works together with the Auto Enable setting. |
Outputs#
| Name | Data Type | Description |
|---|---|---|
| resource | Resource | The Resource that is performing Begin Setup. |
| Success | Boolean | Triggered when a request is received and processed. |
| Error | Error | Triggered when the task fails or the reply times out. |
Settings#
On the General tab, you have the usual settings and the following settings:
| Name | Data Type | Values | Default | Description |
|---|---|---|---|---|
| Auto Enable | Boolean | true | Automatically enables the message listener when the task starts. | |
| Reply Timeout | Integer | ms | 60000 | Amount of time allowed to wait for a reply before issuing a timeout. This setting is mandatory. |
| Resource Begin Setup Request Subject | String | ConnectIoT.BeginSetup.RequestReply | Subject used to communicate with the MES. This setting is read-only. |
Remarks#
This task pairs with the Send Resource Begin Setup Reply task, which sends the reply back to the originating request.
This task uses a specific structure of context-based data called zone. More information on this topic can be read in the Zones page.