Developer Guide > Data Integration Hub Transformations > DX_Add_Document_To_Event Transformation

DX_Add_Document_To_Event Transformation

The DX_Add_Document_To_Event transformation attaches a document to an event.

You can use the transformation to add a document that you create in previous transformations. For example, you can use the transformation to attach a log file to an event.

Input Ports

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

The following table describes the DX_Add_Document_To_Event input ports:

Port	Type	Description
DXDescription	string	Description of the document to attach to the event.
DXMIMEType	string	MIME type of the document to attach to the event.
DXEncoding	string	Character encoding of the document to attach to the event. This is the character set to use to convert strings to byte arrays.
DXTemporaryFilePath	string	Optional. Path and file name generated by the DX_Generate_Temporary_File transformation where the workflow stores the new file. The DX_Add_Document_To_Event transformation saves the file as a new document reference in the document store and attaches the file reference to the event. You can set this port or set the DXData and DXDataByReference ports. If this port and the DXData and DXDataByReference ports are not set, the transformation creates an empty document and adds it to the event.

Input/Output Ports

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

The following table describes the DX_Add_Document_To_Event input/output ports:

Port	Type	Description
DXEventId	string	Required. Identifier of the event to which to attach the document.
DXDataByReference	string	Indicates whether the DXData port contains the document data or a document reference. If the value is true, the DXData port contains a document reference. If the value is null or false, the DXData port contains the document data.
DXDocumentId	string	Identifier of the document to attach to the event.
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_Add_Document_To_Event transformation on the DX Properties tab.

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

Property	Description
Description	Description of the document to attach to the event.
Document Role	Role of the document when it is attached to an event. Select one of the following roles: - SOURCE. The document is attached to an event as a source document. When you view the event in the Operation Console, you can view the attached document in the Input section. - TARGET. The document is attached to an event as a target document. When you view the event in the Operation Console, you can view the attached document in the Output section. - LOG. The document is attached to an event as a log document. When you view the event in the Operation Console, you can view the attached document in the Logging Information section.
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.