File Writer
This destination connector writes files out to the local filesystem, or to a remote directory. Several protocols are supported, including regular local file mode, FTP, SFTP, SMB, WebDAV, and Amazon S3. Files may be converted from Base64 and written out in raw binary format, or converted to bytes using a specific character set encoding. Additional options (like FTPS) are available with the SSL Manager extension.
Supported property groups:
| Item | Name | Default Value | Description |
|---|---|---|---|
| A | Method | file | The basic method used to access the directory to write files to. Options include File (local filesystem or NFS / mapped share), FTP, SFTP, SMB, WebDAV, or Amazon S3. Once all necessary connection/directory information has been filled in before, use the Test Write button to attempt to actually connect and test the ability to write to the directory. |
| B | Advanced Options | If the file method supports advanced options, this button will be enabled. Any advanced options set will be summarized in the Advanced Options label below this. For additional information, see File Reader. | |
| C | Directory | Only applicable to the File method. The directory (folder) to write the files to. | |
| D | URL | Applicable to all methods except File. The domain name or IP address of the host (computer) to connect to. If this setting is enabled, the second text field specifies the directory (folder) to write to. When using the Amazon S3 method, the first text field will be the bucket name, and the second text field can be used for a directory prefix. | |
| E | File Name | The name to write the file out as. | |
| F | Anonymous | Yes | Only applicable to the FTP / WebDAV / Amazon S3 methods. If enabled, connects to the remote server anonymously instead of using a username and password. |
| G | Username | anonymous | Applicable to all methods except File. The username used to connect to the remote server with. When using the Amazon S3 mode, this will be your AWS Access Key ID. |
| H | Password | Applicable to all methods except File. The password used to connect to the remote server with. When using the Amazon S3 mode, this will be your AWS Secret Access Key. | |
| I | Timeout (ms) | 10000 | Applicable to the FTP / SFTP / SMB / Amazon S3 methods. The socket timeout (in ms) to use when connecting to the remote server. |
| J | Keep Connection Open | Yes | Select Yes to keep the connection to the file system open after writing to it. |
| K | Max Idle Time (ms) | 0 | The maximum amount of time that a connection can be idle/unused before it gets closed. A timeout value of zero is interpreted as an infinite timeout, meaning that connections will only be closed when the connector is stopped. |
| L | Secure Mode | Yes | Only applicable to the WebDAV method. If enabled, HTTPS will be used instead of HTTP. |
| M | Passive Mode | Yes | Only applicable to the FTP method. If enabled, the server decides what port the client should connect to for the data channel. Passive mode sometimes allows a connection through a firewall that normal mode does not, because the client is initiating the data connection rather than the server. |
| N | Validate Connection | Yes | Only applicable to the FTP method. If enabled, the connection will be tested for validity before each operation. |
| O | File Exists | Append | Determines what to do when the file to be written already exists on the filesystem / remote server.
|
| P | Create Temp File | No | If enabled, the file contents will first be written to a temp file and then renamed to the specified file name. If disabled, the file contents will be written directly to the destination file. This option is not available if the file is being appended to (option M). |
| Q | File Type | Text | Select Binary if the Template contains Base64 data; the contents will be decoded into raw bytes. Select Text if the Template contains textual data; the contents will be decoded to bytes using the specified character set encoding. |
| R | Encoding | Default | If Text is chosen for the File Type, select the character set encoding (ASCII, UTF-8, etc.) to be used in writing out the contents of each file. |
| S | Template | ${message.encodedData} | The actual payload to send to the target channel. By default the encoded data of this destination will be used. Velocity Variable Replacement is supported here. |