5.18.5 LOAD
LOAD command only has one mandatory keyword METHOD. The value of this keyword determines which content loader will be used to load the remote XML document. Other keywords on the LOAD command are passed to the content loader.
Syntax:
|
Command |
Keyword |
Value |
Developer notes for Command/Keyword/Value |
|
LOAD |
METHOD |
*FILE |
Mandatory. Load XML from local file system. |
|
*POP3 |
Load XML from POP3 mail server. |
||
|
*HTTP |
Load XML from remote HTTP server. |
||
|
*HTTPS |
Load XML from remote HTTP server using a secured connection. |
||
|
*FTP |
Load XML from remote FTP server. |
||
|
*STORAGE |
Load XML from internal storage. |
||
|
*BYTEARRAY |
Load XML from command byte array. |
||
|
ENCODING |
*DEFAULT |
Optional. JVM default encoding. |
|
|
*CLIENT |
Client encoding. |
||
|
value |
Default. Auto detect encoding. |
||
|
FILE |
value |
Conditional. FTP file name or local file name. |
|
|
HOST |
host:port |
Conditional. FTP, POP3 or HTTP host. |
|
|
USER |
value |
Conditional. HTTP, FTP or POP3 user profile. |
|
|
PASSWORD |
value |
Conditional. HTTP, FTP or POP3 password for user profile specified in the USER keyword. |
|
|
DATALINK |
*PORT |
Conditional. Used with METHOD(*FTP). |
|
|
*PASV |
Conditional. Default. Used with METHOD(*FTP). |
||
|
MODE |
*ASCII |
Conditional. Used with METHOD(*FTP). |
|
|
*BINARY |
Used with METHOD(*FTP). |
||
|
NAMEFMT |
0 or 1 |
Conditional. Used with METHOD(*FTP). |
|
|
PROXY |
value |
Conditional. HTTP proxy server. |
|
|
PROXYUSER |
value |
Conditional. HTTP proxy user. |
|
|
PROXYPASSWORD |
value |
Conditional. HTTP proxy password. |
|
|
SUBJECT |
value |
Conditional. Used with METHOD(*POP3). |
|
|
FROM |
value |
Conditional. Used with METHOD(*POP3). |
|
|
ATTACHMENT |
value |
Conditional. Used with METHOD(*POP3). |
|
|
NAME |
*DEFAULT |
Conditional. Default. Used with the METHOD(*STORAGE). |
|
|
value |
|
||
|
IGNORE-PREFIX |
*YES |
Ignore namespace prefix. |
|
|
*NO |
Default. |
METHODS
*BYTEARRAY source uses the byte array object from the command object.
ENCODING (*DEFAULT | *CLIENT | value) – optional default to auto detect encoding.
*FILE source reads the specified file.
ENCODING (*DEFAULT | *CLIENT | value) – optional default to auto detect encoding.
FILE (filename)
*FTP source reads the specified file from the remote host.
ENCODING (*DEFAULT | *CLIENT | value) – optional default to auto detect encoding.
FILE (filename)
HOST (host:port) – port defaults to 21
USER (name)
PASSWORD (password)
DATALINK (*PASV | *PORT) – optional defaults to *PASV
MODE (*ASCII | *BINARY) – optional defaults to *BINARY
*POP3 source reads the first attachment from the first mail entry from the specified post office.
ENCODING (*DEFAULT | *CLIENT | value) – optional default to auto detect encoding.
HOST (smtpserver) - mandatory
USER (user) - mandatory
PASSWORD (password) - mandatory
FROM (from) - optional
SUBJECT (subject) - optional
ATTACHMENT (attachment) - optional
If no mail is found in the post office, then the returned response status is NOMAIL. If no useable mail entries are found, then the returned response status is NOATTACHMENT.
If no FROM, SUBJECT or ATTACHMENT keywords are present, then the first mail entry with an attachment is used. This mail entry is then deleted from the post office and contents of the attachment become the loaded source.
To add extra selection criteria to which mail entry is selected, use the FROM, SUBJECT or ATTACHMENT keywords singularly or together to form a logic AND condition.
*HTTP and *HTTPS source reads the specified file from the remote host.
ENCODING (*DEFAULT | *CLIENT | value) – optional default to auto detect encoding .
FILE (filename) - mandatory
HOST (host:port) - optional defaults to LOCALHOST
USER (name) - optional
PASSWORD (password) - optional
PROXY (host:port) - optional
PROXYUSER (name) - optional
PROXYPASSWORD (password) - optional
*STORAGE source reads the source from the specified storage name.
NAME (*DEFAULT | name) - optional