Developer Guide > Data Integration Hub Transformations > DX_Throw_Error

DX_Throw_Error

The DX_Throw_Error transformation generates an error if an error occurs when the workflow runs.

Use the transformation to perform the following actions:

•Set the status of the associated event to error.
•Create the error message from the value of the DXDescription port.
•Attach the error message to the associated event.
•Send the error to the session log.

Input Ports

Configure input ports for the DX_Throw_Error transformation on the Ports tab.

The following table describes the DX_Throw_Error input ports:

Port	Type	Description
DXDescription	string	Description of the error to send to the session log. This error is also the description for the log document attached to the event.
DXMessageType	string	Optional. Type of the error event. Alphanumeric value to associate with the event. Any value is valid.
DXMIMEType	string	MIME type of the document to attach to the event.

Input/Output Ports

Configure input/output ports for the DX_Throw_Error transformation on the Ports tab.

The following table describes the DX_Throw_Error input/output ports:

Port	Type	Description
DXEventId	string	Required. Identifier of the event that is associated with the error.
DXData	string binary text	Log document to attach to the event. This port can contain the data of the document or a file path to the document. If the value of the parameter is null, the transformation creates an empty document and adds the document to the event. To attach a document with text data, set the datatype of the port to string or text. To attach a document with binary data, change the datatype of the port to binary.
DXDataByReference	string	Indicates whether the DXData port contains the document data or a document reference. Possible values: - True. The DXData port contains a document reference. - False. The DXData port contains the document data. - Null. The DXData port contains the document data.
DXErrorMessage	string	Error message generated by the transformation.
DXErrorCode	string	Error code generated by the transformation. If the transformation fails, the value of the DXErrorCode port is greater than zero.

Data Integration Hub Properties

Configure properties for the DX_Throw_Error transformation on the DX Properties tab.

The following table describes the Data Integration Hub properties of the DX_Throw_Error transformation:

Property	Description
Error log document description	Description of the error log document that the transformation attaches to the event.
Message type	Alphanumeric value to associate with the event. You can enter any value.
Generate an error in case a failure occurs in this transformation	Indicates whether to set the status of the event to error when the transformation generates an error. Selected by default.