Description

The XML File reader 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

Installation

Make sure you have the 1gateway zip file that includes the plugin files and valid licences information ready. This file has been provided to you with the installation files.

1 - Login

Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).

2 - System Maintenance

Click on the menu icon and choose the option "System maintenance"


3 - Upload file


In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.

4 - Restart

After the upload installation will be confirmed. Restart 1Gateway to ensure any locked files are updated.

Configuration


Open the main menu and click on "New plugin"

Select the plugin you want to configure. Use the Filter field if needed.


Sample FTP profile

Profiles fields to configure

Field name

Supported values

Description

Profile name

Any string

Name of the profile

File or directoy name

Any string

Name of the file content to read or directory name from which to read the files from

Polling interval

Any integer

Polling interval in seconds (default is 300)

Delete file after read

true / false

If selected, it will delete the file after it is read.

FTP serverHostname or ipSelf explanatory
FTP portPortSelf explanatory
FTP userUser nameSelf explanatory
FTP passwordPasswordSelf explanatory
Folder on ftp serverFolder nameThe directory on the ftp server without leading or trailing slash /
Use binary
Issue a BIN transfer request
Delete after processing
Delete the file from the ftp server
Archive folder
A folder to move the file to. Do NOT tick delete if you want to archive the files.



See also