---
alias: user-guide-automation-task-ipccfx-oncfxevent
tags:
- automation tasks
description: "This task processes CFX event messages, updating outputs based on received automation data"
---

# On Cfx Event

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

This Task receives event 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.

![oncfxevent_parameters][oncfxevent_parameters]

## Inputs

| Name     | Data Type | Description                                            |
|----------|-----------|--------------------------------------------------------|
| Activate | `Boolean` | Activates the task                                     |

## Outputs

| Name         | Data Type  | Description                                            |
|--------------|------------|--------------------------------------------------------|
| 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`    | `StationStateChanged`<br />`UnitsInspected`<br />`WorkStarted`<br />`WorkCompleted` |  | Specifies the behavior of the task                                                                                    |

![oncfxevent_settings][oncfxevent_settings]

## Behavior

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

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

## Remarks

None.

[oncfxevent_parameters]: ./images/oncfxevent_parameters.png
[oncfxevent_settings]: ./images/oncfxevent_settings.png