Skip to content

On Cfx Request#

This Task is specific to be used with the IPC-CFX Driver.

This Task receives request CFX messages of a specific type, which can be configured in the Task's settings.

The Task's static and dynamic outputs are updated after each event received.

oncfxrequest_parameters

Inputs#

Name Data Type Description
Activate Boolean Activates the task

Outputs#

Name Data Type Description
requestId string The RequestId of the message received
timestamp DateTime The timestamp for when the event is triggered
eventRawData any The raw automation event object
Success Boolean If there was no problem emits a true
Error Error Error that occurred during the processing of this task

Settings#

On the General Tab, you have the usual settings and the following settings:

Name Data Type Values Default Description
Auto Activate Boolean true If the event is activated by the register of an event of that type or if it is only activated by the activate input
Message Full Name string Name of the complete CFX message with the namespace included, e.g. 'CFX.Production.ActivitiesExecuted'.
Message enum ActivateRecipeRequest
ValidateUnitsRequest
BlockMaterialsRequest
Specifies the behavior of the task

oncfxrequest_settings

Behavior#

When activated, this Task subscribes to a specific request CFX message, configured in the settings.

Every time a message is received (via request) it emits the respective results to its outputs.

Remarks#

None.