copyFieldFromAlertToEvent

A Workflow Engine function that copies a single field from an existing alert to a deduplicating event for the same alert. For example, if an update event doesn't include a 'source' attribute, the 'copyFromAlertToEvent' copies the 'source' from the existing alert. If the copy fails, the event would have an empty 'source' field causing the Alert Builder to reject it. In this case create a subsequent action to check for the existence of 'source enables you to set a default source for the event if it is undefined.

When using this function, the following applies:

  • You can specify both the source and destination fields. Choose the forwarding action for this carefully.

  • If the process fails and the forwarding behavior is 'Stop All Workflows', the Workflow Engine drops the event.

  • If you select 'Always Forward' there is a risk that the Alert Builder will reject an incomplete event. For example, if an update event does not include a 'source' property, this function copies the value for 'source' from the existing alert.

  • If the copy fails, the event has an empty 'source' field causing the Alert Builder to reject it. In this case, create a subsequent action to check for the existence of 'source' and set a default source for the event if it is undefined.

This function is available as a feature of the Workflow Engine v1.0 and later.

This function is available for event workflows only.

Back to Workflow Engine Functions Reference.Workflow Engine Functions Reference

Arguments

Workflow Engine function copyFieldFromAlertToEvent takes the following arguments:

Name

Required

Type

Description

sourceField

Yes

String

The field in the existing alert to copy.

destinationField

Yes

String

Destination field in the event.