Recipe List Request#
This trigger task listens for recipe list requests coming from the MES and lets a workflow reply with the list of recipes available at the equipment.
It belongs to the System / MES category, under Triggers.
Details#
| Fields | Details |
|---|---|
| Scope | Connect IoT Data Platform Enterprise Integration Factory Automation |
| Workflow | Data flow Control flow |
IsProtocol flag |
Behavior#
When the MES requests the list of recipes at the equipment (the get recipes operation of a Resource with Recipe List Support enabled), it sends a request on the RecipeManagement.GetAllRecipes subject and waits for a reply. This task receives that request and activates the workflow branch that gathers the recipe list from the equipment.
The MES stays blocked until a reply is sent. If none is sent within the Reply Timeout, the task emits Error and the operation fails on the MES side.
The reply is sent by a downstream Send Recipe List Reply task, carrying an array with the names of the recipes.
Inputs#
| Name | Data Type | Description |
|---|---|---|
| Reply Timeout | Integer | Amount of time allowed to wait for a reply before issuing a timeout, in milliseconds. |
| Enable/Disable | Boolean | Enables (true) or disables (false) the message listener at runtime. Works together with the Auto Enable setting. |
Table: Recipe List Request task inputs
Outputs#
| Name | Data Type | Description |
|---|---|---|
| Success | Boolean | Triggered when a request is received and processed. |
| Error | Error | Triggered when the task fails or the reply times out. |
Table: Recipe List Request task outputs
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. |
| Recipe List Requested | String | RecipeManagement.GetAllRecipes | Subject used to communicate with the MES. This setting is read-only. |
Table: Recipe List Request task settings
Remarks#
Before version 12.0.0 this task was named Recipe List Requested and carried the reply on its own inputs; the reply is now sent by the dedicated Send Recipe List Reply task.
This task uses a specific structure of context-based data called zone. More information on this topic can be read in the Zones page.