5.16.3 READ

When the READ command of this service is executed the following steps occur:

If the HOST keyword is not present then the contents of the local file is read, else the FTP get protocol is used to read the remote file.

The service determines the encoding to apply to the received byte content to convert it to Unicode content. The default action is to auto-detect the encoding of the XML source.

The service converts the Unicode content to a UTF-8 byte content.

The service determines if the Unicode data needs to be archived.

To read a file from the local file system, only requires the FILE keyword.

Syntax:

Command

Keyword

Value

Developer notes for Command/Keyword/Value

READ

FILE

value

Mandatory. File Path.

ENCODING

 

Optional. See ENCODING.
Default is to auto-detect encoding.

ARCHIVE

 

Optional. See ARCHIVE.

 

To read a file from a remote file system using the FTP protocol requires the HOST keyword.

Syntax:

Command

Keyword

Value

Developer notes for Command/Keyword/Value

READ

HOST

value

Conditional. FTP server.

FILE

value

Mandatory. File Path.

ENCODING

 

Optional. See ENCODING.
Default is to auto-detect encoding.

ARCHIVE

 

Optional. See ARCHIVE.

USER

value

Mandatory. User.

PASSWORD

value

Mandatory. Password.

NAMEFMT

0

Optional. Path name format. library/file.member.

1

Path name format. /directory/directory/file.

DATALINK

*PASV

Optional. Default. Data channel connection mode.

*PORT

Data channel connection mode.

MODE

*BINARY

Optional. Default. Data transfer mode.

*ASCII

Data transfer mode.