uCosminexus Service Platform, Reception and Adapter Definition Guide

[Contents][Glossary][Index][Back][Next]

2.4.2 Creating message format of FTP reception

The message format definition file of FTP reception uses the schema provided by the service platform. Therefore you need not create the message format definition file.

This subsection describes the types of message format used in FTP reception and contents of each type.

Storage location of the file is "Installation directory of service platform\CSC\schema\ftprecp".

Organization of this subsection
(1) Request message format of FTP reception
(2) Response message format of FTP reception
(3) GETINFO operation

(1) Request message format of FTP reception

The operation-wise request message format of FTP reception is described here.

(a) PUT operation

The following table describes the request message format to be passed on to a business process from FTP reception of PUT operation. The file name is "urecp_ftp_put_request.xsd". The name of the namespace is "http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/put_request".

Table 2-1 Request message format of FTP reception (PUT operation)

Tag name Occurrence count # Description
<request> 1 time -
<ftpclient-ipaddr> 1 time Specifies IP address of FTP client.
It is set in text format of IP address.
<ftp-user> 1 time Specifies the user name mentioned by FTP client in USER command.
The information specified in the argument of USER command is set as-is.
<ftp-type> 1 time Specifies information of the type mentioned by FTP client in TYPE command.
The information specified in the argument of TYPE command is set as-is.
<transfer-type> 1 time Specifies the transfer type. Either of the following types is set:
  • APPE
    Adding information in the file
  • STOR
    Overwriting the file
<transfer-path> 1 time Specifies path of the file to be transferred.
From the path information specified by FTP client in APPE command or STOR command, the information of the file path excluding sorting definition part mentioned in the beginning is set.
"/" is set in the beginning without fail.
<file-name> 1 time Specifies name of the intermediate file containing data of the file sent by FTP client.
<file-size> 1 time Specifies size of the data written in the intermediate file sent by FTP client.
<request-id> 1 time Specifies the request ID. The request ID generated by FTP reception is set.
<ftp-commands-before> 0 or 1 time Specifies the FTP command to be executed prior to transfer.
It is set when the following FTP command is requested by FTP client:
SITE CSCTHR -B <FTP command>[;<FTP command> ...]

Here, "<FTP command>[;<FTP command> ...]" is set as-is.
However, the FTP command specified in the argument of SITE CSCTHR command is not set, if it is not permitted in FTP command permission list definition function.
When CSCTHR command is requested multiple times by FTP client, "<FTP command>[;<FTP command> ...]" is joined with semicolon (;) in the sequence in which SITE CSCTHR command is executed and it is added.
If CSCTHR command is not requested even once, this tag is not output.
<ftp-commands-after> 0 or 1 time Specifies the FTP command to be executed after transfer.
It is set, when the following FTP command is requested by FTP client.
SITE CSCTHR -A <FTP command>[;<FTP command> ...]

Here, "<FTP command>[;<FTP command> ...]" is set as-is.
However, the FTP command specified in the argument of SITE CSCTHR command is not set, if it is not permitted in the FTP command permission list definition function.
When CSCTHR command is requested multiple times by FTP client, "<FTP command>[;<FTP command> ...]" is joined with semicolon (;) in the sequence in which SITE CSCTHR command is executed and it is added.
If CSCTHR command is not requested even once, this tag is not output.

Legend:
-: Corresponding item does not exist.

Note#
The operation to be performed when the specified occurrence count is exceeded is not guaranteed.

(b) GET operation

The following table describes the request message format to be passed on to a business process from FTP reception of GET operation. The file name is "urecp_ftp_get_request.xsd". The name of the namespace is "http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/get_request".

Table 2-2 Request message format of FTP reception (GET operation)

Tag name Occurrence count # Description
<request> 1 time -
<ftpclient-ipaddr> 1 time Specifies IP address of FTP client.
It is set in text format of IP address.
<ftp-user> 1 time Specifies the user name mentioned by FTP client in USER command.
The information specified in the argument of USER command is set-is.
<ftp-type> 1 time Specifies information of the type mentioned by FTP client in TYPE command.
The information specified in the argument of TYPE command is set as-is.
<transfer-type> 1 time Specifies the transfer type. The following contents are set:
  • RETR
    Acquiring the file
<transfer-path> 1 time Specifies path of the file to be transferred.
From the path information specified by FTP client in RETR command, the information of the file path excluding sorting definition part mentioned in the beginning is set.
"/" should be set in the beginning.
<request-id> 1 time Specifies the request ID. The request ID generated by FTP reception is set.
<ftp-commands-before> 0 or 1 time Specifies the FTP command to be executed before transfer.
It is set, when the following FTP command is requested by FTP client:
SITE CSCTHR -B <FTP command>[;<FTP command> ...]

Here, "<FTP command>[;<FTP command> ...]" is set as-is.
However, the FTP command specified in the argument of SITE CSCTHR command is not set, if it is not permitted in the FTP command permission list definition function.
When CSCTHR command is requested multiple times by FTP client, "<FTP command>[;<FTP command> ...]" is joined with semicolon (;) in the sequence in which SITE CSCTHR command is executed and it is added.
If CSCTHR command is not requested even once, this tag is not output.
<ftp-commands-after> 0 or 1 time Specifies the FTP command to be executed after transfer.
It is set, when the following command is requested by FTP client:
SITE CSCTHR -A <FTP command>[;<FTP command> ...]

Here, "<FTP command>[;<FTP command> ...]" is set as-is.
However, the FTP command specified in the argument of SITE CSCTHR command is not set, if it is not permitted in the FTP command permission list definition function.
When CSCTHR command is requested multiple times by FTP client, "<FTP command>[;<FTP command> ...]" is joined with semicolon (;) in the sequence in which SITE CSCTHR command is executed and it is added.
If CSCTHR command is not requested even once, this tag is not output.

Legend:
-: Corresponding item does not exist.

Note#
The operation to be performed when the specified occurrence count is exceeded is not guaranteed.

(c) GETINFO operation

The following table describes the request message format to be passed on to a business process from FTP reception of GETINFO operation. The file name is "urecp_ftp_getinfo_request.xsd". The name of the namespace is "http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/getinfo_request".

Table 2-3 Request message format of FTP reception (GETINFO operation)

Tag name Occurrence count # Description
<request> 1 time -
<ftpclient-ipaddr> 1 time Specifies IP address of FTP client.
It is set in text format of IP address.
<ftp-user> 1 time Specifies the user name mentioned by FTP client in USER command.
The information specified in the argument of USER command
is set as-is.
<getinfo-type> 1 time Either of the following options is set as information acquisition type:
  • LIST
    Acquires the list of file information.
  • NLST
    Acquires the list of file names.
<getinfo-option> 0 or 1 time Specifies the information about the information acquisition option.
When all of the following conditions are fulfilled, a string same as the one set in the option definition file is set:
  • The starting part of the argument specified by FTP client in LIST command or NLST command matches with the string set in the option definition file
  • A string is not continued after the starting part of the argument or there is space
Note that, this tag is not output, if either of the following conditions is applicable:
  • If FTP client does not specify an argument in LIST command or NLST command
  • If the starting part of the argument specified by FTP client in LIST command or NLST command does not match with the string set in the option definition file.
<getinfo-path> 0 or 1 time Specifies the information about information acquisition path.
When the <getinfo-option> tag is not output, the argument specified by FTP client in LIST command or NLST command is set as-is.
When the <getinfo-option> tag is output, from the start of the argument specified by FTP client in LIST command or NLST command, the option information output to the <getinfo-option> tag and path information excluding the space after the option information are set.
Note that, this tag is not output, if either of the following conditions is applicable:
  • If FTP client does not specify an argument in LIST command or NLST command
  • If only option information is specified in the argument specified by FTP client in LIST command or NLST command
<request-id> 1 time Specifies the request ID. The request ID generated by FTP reception is set.
<ftp-commands-before> 0 or 1 time Specified the FTP command to be executed before executing list command.
It is set, when the following FTP command is requested by FTP client:
SITE CSCTHR -B <FTP command>[;<FTP command> ...]

Here, "<FTP command>[;<FTP command> ...]" is set as-is.
However, the FTP command specified in the argument of SITE CSCTHR command is not set, if it is not permitted in the FTP command permission list definition function.
When CSCTHR command is requested multiple times by FTP client, "<FTP command>[;<FTP command> ...]" is joined with semicolon (;) in the sequence in which SITE CSCTHR command is executed and it is added.
If CSCTHR command is not requested even once, this tag is not output.
<ftp-commands-after> 0 or 1 time Specifies the FTP command to be executed after execution of list command.
It is set, when the following command is requested by FTP client:
SITE CSCTHR -A <FTP command>[;<FTP command> ...]

Here, "<FTP command>[;<FTP command> ...]" is set as-is.
However, the FTP command specified in the argument of SITE CSCTHR command is not set, if it is not permitted in the FTP command permission list definition function.
When CSCTHR command is requested multiple times by FTP client, "<FTP command>[;<FTP command> ...]" is joined with semicolon (;) in the sequence in which SITE CSCTHR command is executed and it is added.
If CSCTHR command is not requested even once, this tag is not output.

Legend:
-: Corresponding item does not exist.

Note#
The operation to be performed when the specified occurrence count is exceeded is not guaranteed.

(2) Response message format of FTP reception

The operation-wise response message format of FTP reception is described here.

(a) PUT operation

The following table describes the response message format to be passed on to FTP reception of PUT operation from a business process. The file name is "urecp_ftp_put_response.xsd". The name of the namespace is "http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/put_response".

Table 2-4 Response message format of FTP reception (PUT operation)

Tag name Occurrence count # Description
<response> 1 time -
<message> 0 or 1 time Specifies a message indicating end of a business process. Maximum character length that can be specified in a message is 1,024.
If length of the message specified by you exceeds the maximum value, the last part of the message is truncated so that the message fits in 1,024 characters.
If a message contains a character that cannot be used#2, such character is replaced with a question mark (?).
If you omit the message, the following message is set:
  • Value of the <success> tag is true
    Transfer complete.
  • Value of the <success> tag is false
    Requested action aborted.
<success> 0 or 1 time Specifies a flag indicating end of a business process. Specify either of the following flags:
  • true
    Processing of the business process ended successfully.
  • false
    An error occurred in the processing of the business process.
If you omit the flag, true is set.

Legend:
-: Corresponding item does not exist.

Note#1
The operation to be performed when the specified occurrence count is exceeded is not guaranteed.

Note#2
You can use only the following characters:
one-byte alphanumeric characters, one-byte space, one-byte tab, one-byte linefeed, exclamation mark (!), double-quotation mark ("), number sign (#), dollar sign ($), percentage sign (%), ampersand (&), apostrophe ('), left parenthesis ((), right parenthesis ()), asterisk (*), positive sign (+), comma (,), hyphen (-), period (.), slash (/), colon (:), semi-colon (;), left-angle bracket (<), right-angle bracket (>), equal sign (=), question mark (?), at sign (@), left-square bracket ([), right-square bracket (]), back slash (\), circumflex accent (^), underscore (_), accent grave (`), left curly bracket ({), right curly bracket(}), pipeline (|), wave dash (~)

(b) GET operation

The following table describes the response message format to be passed on to FTP reception of GET operation from a business process. The file name is "urecp_ftp_get_response.xsd". The name of the namespace is "http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/get_response".

Table 2-5 Response message format of FTP reception (GET operation)

Tag name Occurrence count#1 Description
<response> 1 time -
<message> 0 or 1 time Specifies a message indicating end of a business process. Maximum character length that can be specified in a message is 1,024.
If length of the message specified by you exceeds the maximum value, the last part of the message is truncated so that the message fits in 1,024 characters.
If a message contains a character that cannot be used#2, such character is replaced with a question mark (?).
If you omit the message, the following message is set:
  • Value of the <success> tag is true
    Transfer complete.
  • Value of the <success> tag is false
    Requested action not taken.
<success> 0 or 1 time Specifies a flag indicating end of a business process. Specify either of the following flags:
  • true
    Processing of the business process ended successfully.
  • false
    An error occurred in the processing of the business process.
If you omit the flag, true is set.
<file-name> 0 or 1 time Specifies name of the intermediate file in which data of the file to be resent to FTP client is mentioned.
However, if value of the <success> tag is false, this setting is not required. Even if this setting is performed, it is ignored.
<file-size> 0 or 1 time Specifies size of data of the file to be resent to FTP client.
However, if value of the <success> tag is false, this setting is not required. Even if this setting is performed, it is ignored.

Legend:
-: Corresponding item does not exist.

Note#1
The operation to be performed when the specified occurrence count is exceeded is not guaranteed.

Note#2
You can use only the following characters:
one-byte alphanumeric characters, one-byte space, one-byte tab, one-byte linefeed, exclamation mark (!), double-quotation mark ("), number sign (#), dollar sign ($), percentage sign (%), ampersand (&), apostrophe ('), left parenthesis ((), right parenthesis ()), asterisk (*), positive sign (+), comma (,), hyphen (-), period (.), slash (/), colon (:), semi-colon (;), left-angle bracket (<), right-angle bracket (>), equal sign (=), question mark (?), at sign (@), left-square bracket ([), right-square bracket (]), back slash (\), circumflex accent (^), underscore (_), accent grave (`), left curly bracket ({), right curly bracket(}), pipeline (|), wave dash (~)

(3) GETINFO operation

The following table describes the response message format to be passed on to FTP reception of GETINFO operation from a business process. The file name is "urecp_ftp_getinfo_response.xsd". The name of the namespace is "http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/ftp/getinfo_response".

Table 2-6 Response message format of FTP reception (GETINFO operation)

Tag name Occurrence count #1 Description
<response> 1 time -
<reply-code> 0 or 1 time Specifies the reply code received from FTP server when information acquisition process is executed (or code based on this).
When executing the information acquisition process using GETINFO operation of FTP adapter, it is recommended that you set the value of <reply-code> of response message of FTP adapter.
Value that can be specified in this tag is a number between 200 to 299 or 400 to 599.
If you set a number between 200 to 299, the reply code that is returned to FTP client is 266.
If you set a number between 400 to 599, the set value is the reply code that is returned to FTP client.
If value of the <success> tag is true and if you omit this tag, FTP reception assumes 226 in the reply code.
If value of the <success> tag is false, this setting is not required. Even if this setting is performed, it is ignored.
<message> 0 or 1 time Specifies the reply message received from FTP server when the information acquisition process is executed or the message indicating end of a business process.
Maximum character length that can be specified in a message is 1,024. If length of the message specified by you exceeds the maximum value, the last part of the message is truncated so that the message fits in 1,024 characters.
If a message contains a character that cannot be used#2, such character is replaced with a question mark (?).
If you omit the message, the following message is set:
  • Value of the <success> tag is true
    Transfer complete.
  • Value of the <success> tag is false
    Requested action not taken.
When executing the information acquisition process using GETINFO operation of FTP adapter, it is recommended that you set the value of <reply- message> of response message of FTP adapter.
<success> 0 or 1 time Specifies the flag indicating end of a business process. Specify either of the following flags:
  • true
    Processing of the business process ended successfully.
  • false
    An error occurred in the processing of a business process.
If you omit this, true is set.
<file-name> 0 or 1 time Specifies name of the intermediate file in which data of the file to be resent to FTP client is mentioned.
The information acquired in the following format must be mentioned in the file specified in this tag:
  • Character code: UTF-16
  • Linefeed code: CRLF
However, when either of the following condition is applicable, this setting is not required. Even if this setting is performed, it is ignored.
  • If value of the <success> tag is false
  • If value of the <success> tag is true and value of <reply-code> is between 400 to 599

Legend:
-: Corresponding item does not exist.

Note#1
The operation to be performed when the specified occurrence count is exceeded is not guaranteed.

Note#2
You can use only the following characters:
one-byte alphanumeric characters, one-byte space, one-byte tab, one-byte linefeed, exclamation mark (!), double-quotation mark ("), number sign (#), dollar sign ($), percentage sign (%), ampersand (&), apostrophe ('), left parenthesis ((), right parenthesis ()), asterisk (*), positive sign (+), comma (,), hyphen (-), period (.), slash (/), colon (:), semi-colon (;), left-angle bracket (<), right-angle bracket (>), equal sign (=), question mark (?), at sign (@), left-square bracket ([), right-square bracket (]), back slash (\), circumflex accent (^), underscore (_), accent grave (`), left curly bracket ({), right curly bracket(}), pipeline (|), wave dash (~)

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2015, Hitachi, Ltd.