XML File
Inbound XML File connection
Inbound Description
The XML File inbound connection reads XML files and converts the content into a message to be processed by 1Gateway. The configuration can point at a directory where to read files from, at the file itself, or at an ftp server.
Prerequisites
- Give the directory or file read/write permissions
Inbound Configuration
| Field name | Supported values | Used for FTP or Local | Description |
|---|---|---|---|
| Profile name | Any string | FTP and Local | Name of the profile |
| File or directory name | Any string | Local | Name of the file content to read or directory name from which to read the files from |
| ID location | Any string | FTP and Local | Field in XML file that indicates the ID of this message |
| Delete file after read | true / false | Local | If selected, it will delete the file after it is read. |
| Read files from FTP server | true / false | FTP | Tick if you want to read files from FTP server instead of locally |
| FTP server | Hostname or IP | FTP | Self-explanatory |
| FTP port | Port | FTP | Self-explanatory |
| FTP user | User name | FTP | Self-explanatory |
| FTP password | Password | FTP | Self-explanatory |
| Folder on FTP server | Folder name | FTP | The directory on the FTP server without leading or trailing slash / |
| Use binary | true / false | FTP | Issue a BIN transfer request |
| Delete files from FTP server after processing | true / false | FTP | Delete the file from the FTP server |
| Folder to archive files after processing | Valid directory name | FTP | A folder to move the file to. Folder needs to exist. Do NOT tick delete if you want to archive the files. |
| Polling interval | Any integer | Both | Polling interval in seconds (default is 300) |
Outbound XML File connection
Outbound Description
The file writer writes the messages it gets from 1Gateway to a file.
Prerequisites
- The file path defined in the configuration needs to have permissions to write
Outbound Configuration
| Field name | Supported values | Description |
|---|---|---|
| File name | Any string | Filename where to write the messages |
| Truncate on startup | True / false | If true and the file already exists and it is opened for WRITE access, then its length is truncated to 0. The content is appended otherwise. |
| Write to standard output | True / false | If true, write to standard output instead of to the file. |
| Topics | Any string | Topics the queue should subscribe to |
| Queue name | Tickbox | Queue name in RabbitMQ |
| Durable | Tickbox | Persist queues when RabbitMQ shuts down |
| Filter expression | Valid expression | Groovy expression to filter out unwanted messages |
| Version | Select | Restore a previously configured version of this plugin |