Skip to main content

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 nameSupported valuesUsed for FTP or LocalDescription
Profile nameAny stringFTP and LocalName of the profile
File or directory nameAny stringLocalName of the file content to read or directory name from which to read the files from
ID locationAny stringFTP and LocalField in XML file that indicates the ID of this message
Delete file after readtrue / falseLocalIf selected, it will delete the file after it is read.
Read files from FTP servertrue / falseFTPTick if you want to read files from FTP server instead of locally
FTP serverHostname or IPFTPSelf-explanatory
FTP portPortFTPSelf-explanatory
FTP userUser nameFTPSelf-explanatory
FTP passwordPasswordFTPSelf-explanatory
Folder on FTP serverFolder nameFTPThe directory on the FTP server without leading or trailing slash /
Use binarytrue / falseFTPIssue a BIN transfer request
Delete files from FTP server after processingtrue / falseFTPDelete the file from the FTP server
Folder to archive files after processingValid directory nameFTPA folder to move the file to. Folder needs to exist. Do NOT tick delete if you want to archive the files.
Polling intervalAny integerBothPolling 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 nameSupported valuesDescription
File nameAny stringFilename where to write the messages
Truncate on startupTrue / falseIf 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 outputTrue / falseIf true, write to standard output instead of to the file.
TopicsAny stringTopics the queue should subscribe to
Queue nameTickboxQueue name in RabbitMQ
DurableTickboxPersist queues when RabbitMQ shuts down
Filter expressionValid expressionGroovy expression to filter out unwanted messages
VersionSelectRestore a previously configured version of this plugin