Attachment to File Service (com.ibi.agents.XDAttachmentToFileAgent)

Syntax:

com.ibi.agents.XDAttachmentToFileAgent

iIT Service Object:

format: Attachment to File

Description: Writes the contents of an attachment to a file.

Parameters:

Parameter

Description

Attachment Number

The number of the attachment to be retrieved. If specified, it takes precedence over the Content-ID.

Content-ID

The Content-ID of the attachment to be retrieved. It is ignored if the Attachment Number is specified.

Delete Attachment

Specifies whether to delete the attachment after it becomes the body of the document.

File

Target Directory *

The target output directory.

File Pattern *

The output file name, which can contain a '*' which gets expanded to a fine timestamp.

Output Document Type

Specifies whether the output document emitted should be the original input document (original) or a status document (status).

Output Encoding

The encoding to apply to the output file being written. Does not apply when the output is base 64.

Base64 Decode

If set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified.

Respect Transactionality *

If set, the emit respects the transactionality of the channel. If not set, the emit is always done.

Append

If set, the output will be appended to the file if it already exists.

Append CRLF

If set, a line termination sequence will be written after the document.

Emit Zero Length Files?

If true, emit empty files if the process creates them.

Edges:

The following table lists the available Line Edges for the Attachment to File Service (com.ibi.agents.XDAttachmentToFileAgent).

Line Edge

Description

OnError

An exception occurred during execution.

OnSuccess

The operation was successful.

OnFailure

A fail condition occurred during execution.

OnParseError

Could not parse a document.

OnNotFound

The resource was not found and this is considered an error.

OnFailedOperation

Could not perform the operation requested.