File - write a file
Search form
Description - Writes a document to a physical file
Runtime Class - com.ibi.agents.XDFileEmitAgent
Parameter Groups
Parameter Type Description Data Source: string Value or expression to represent a data source. If not set, defaults to the input document.
* - denotes required
Parameter Type Description XML Namespace Provider: string Provider for the mapping between XML namespace prefix and namespace URI within XPath expressions.
* - denotes required
Parameter Type Description * Directory: string The target directory of the output file.
* File Name: string The output target file name; supports '*' which expands to a file timestamp.
* - denotes required
Parameter Type Description File Encoding: string Encoding to apply to the target output file being written. Does not apply when output is bas64.
Select from one of the following options:
- Leave {leave} - Make no changes (input document carries encoding)
- Platform {platform} - Use platform's encoding, not inbound message encoding
- US-ASCII - Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set
- CP-037/EBCDIC {CP037} - Eight but EBCDIC encoding
- ISO-8859-1 - ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1
- UTF-8 - Eight-bit UCS Transformation Format
- UTF16-BE {UTF-16BE} - Sixteen-bit UCS Transformation Format, big-endian byte order
- UTF16-LE {UTF-16LE} - Sixteen-bit UCS Transformation Format, little-endian byte order
- UTF16 {UTF-16} - Sixteen-bit UCS Transformation Format, byte order identified by [optional] byte order mark
Base64 Decode: boolean If set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified.
Append: boolean If set to true, the output will be appended to the file if it already exists
Append CRLF: boolean If set to true, a carriage return and a line feed will be written at end of target file.
Emit Zero Length Files: boolean If true, emit empty files if the process creates them.
* - denotes required
Parameter Type Description Output Document: string Output document of the object.
Select from one of the following options:
- iWay Status Document {status} - Replace input with standard iWay status document
- Original Input Document {input} - Output of node is original document
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDFileEmitAgent
Parameter Groups
Parameter Type Description Data Source: string Value or expression to represent a data source. If not set, defaults to the input document.
* - denotes required
Parameter Type Description XML Namespace Provider: string Provider for the mapping between XML namespace prefix and namespace URI within XPath expressions.
* - denotes required
Parameter Type Description * Directory: string The target directory of the output file.
* File Name: string The output target file name; supports '*' which expands to a file timestamp.
* - denotes required
Parameter Type Description File Encoding: string Encoding to apply to the target output file being written. Does not apply when output is bas64.
Select from one of the following options:
- Leave {leave} - Make no changes (input document carries encoding)
- Platform {platform} - Use platform's encoding, not inbound message encoding
- US-ASCII - Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set
- CP-037/EBCDIC {CP037} - Eight but EBCDIC encoding
- ISO-8859-1 - ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1
- UTF-8 - Eight-bit UCS Transformation Format
- UTF16-BE {UTF-16BE} - Sixteen-bit UCS Transformation Format, big-endian byte order
- UTF16-LE {UTF-16LE} - Sixteen-bit UCS Transformation Format, little-endian byte order
- UTF16 {UTF-16} - Sixteen-bit UCS Transformation Format, byte order identified by [optional] byte order mark
Base64 Decode: boolean If set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified.
Append: boolean If set to true, the output will be appended to the file if it already exists
Append CRLF: boolean If set to true, a carriage return and a line feed will be written at end of target file.
Emit Zero Length Files: boolean If true, emit empty files if the process creates them.
* - denotes required
Parameter Type Description Output Document: string Output document of the object.
Select from one of the following options:
- iWay Status Document {status} - Replace input with standard iWay status document
- Original Input Document {input} - Output of node is original document
* - denotes required
Output Events
Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| Data Source: | string | Value or expression to represent a data source. If not set, defaults to the input document. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| XML Namespace Provider: | string | Provider for the mapping between XML namespace prefix and namespace URI within XPath expressions. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Directory: | string | The target directory of the output file. | * | File Name: | string | The output target file name; supports '*' which expands to a file timestamp. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| File Encoding: | string | Encoding to apply to the target output file being written. Does not apply when output is bas64.
Select from one of the following options:
|
Base64 Decode: | boolean | If set, the value is assumed to be in base64 notation. Only applicable if a specific write value is specified. | Append: | boolean | If set to true, the output will be appended to the file if it already exists | Append CRLF: | boolean | If set to true, a carriage return and a line feed will be written at end of target file. | Emit Zero Length Files: | boolean | If true, emit empty files if the process creates them. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Output Document: | string | Output document of the object.
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| OnParseError | Could not parse a document. |
| OnFailedOperation | Could not perform the operation requested. |
| OnNotFound | The resource was not found. This may or may not be a failure. |