For the message format definition file of FTP adapters, use the schema provided by the service platform. Therefore, you need not create the message format definition file.

The contents of the message format used by FTP adapters are described here.

The storage location of the file is "Installation directory of the service platform\CSC\custom-adapter\FTP\schema".

(a) Request message format for FTP adapters

The operation-wise request message format for FTP adapters is described here.

PUT operation

The following table describes the request message format of PUT operation to be passed on to an FTP adapter from a business process. The file name is "ftpadp_put_request.xsd". The name of the name space is "http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/put_request".

Table 3-46 Request message format (PUT operation)

Tag name			Occurrence count#1	Description
<request>			1 time	-
	<host-ipaddr>		0 or 1 time	Specifies the IP address or the host name of the FTP server to be connected. If the tag and value both are present connect is issued in the specified string. If the tag is present and the value is not present A system exception is to be returned. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified in FTP adapter runtime-environment property file, a system exception is to be returned. When using an OS from Windows Vista and Windows Server 2008 onward, if you specify loopback IP address (127.0.0.1 or localhost), a failure might occur in FTP connection. Specify the real IP address or the host name.
	<host-con-port>		0 or 1 time	Specifies the port number for the control connection of FTP server. If the tag and value both are present Specify a port number within the range from 1 to 65535. If you specify any value other than this, a system exception is to be returned. If the tag is present and the value is not present, 21 is specified by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
	<file-name-charset>		0 or 1 time	Specifies a tag that indicates the name of the character set to be used when sending and receiving information such as file names using the control connection between FTP servers. The specified value is either of the following values: UTF-8: Use "UTF-8" in the character set. MS932: Use "MS932" in the character set. In case of character set for which the tag is present and the value can be used It will be applied as the character set to be used when sending and receiving information such as file names. In case of the character set name for which the tag is present and the value cannot be used A system exception is to be returned. If the tag is present and the value is not present By default "UTF-8" is used. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
	<ftps>		0 or 1 time	Specifies a tag indicating the settings related to FTPS. If the tag is not present, the value given in FTP adapter runtime-environment property file becomes valid for the entire setting related to FTPS.
		<ftps-enable>	0 or 1 time	Specifies a tag that indicates whether to use FTPS to connect to an FTP server. The specified value is either of the following values: true: Use FTPS to connect to an FTP server. false: Use normal FTP to connect to an FTP server.#2 When you use FTPS, the communication of control connection and data connection is encrypted. However, the destination FTP server must support the connection using FTPS. Even if you specify "true", when encryption of the communication of data connection is not set, the communication of data connection is also not encrypted. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present By default "false" is used. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
		<ftps-protocol-name>	0 or 1 time	Specifies a tag that indicates the protocol for security communication to be used, when using FTPS to connect to an FTP server. The specified value is either of the following values: TLS: Use TLS in the protocol for security communication. SSL: Use SSL in the protocol for security communication. If the tag is present and the value is "TLS" or "SSL" The specified value is applied. If the tag is present and the value is other than "TLS" or "SSL" A system exception is to be returned. If the tag is present and the value is not present "TLS" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-implicit-mode>	0 or 1 time	Specifies a tag that indicates whether to use Implicit mode of FTPS, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Use Implicit mode. false: Use Explicit mode.#2 If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present "false" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-data-con-secure>	0 or 1 time	Specifies a tag that indicates whether to encrypt the communication of data connection, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Encrypt the communication of data connection. false: Do not encrypt the communication of data connection. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present By default "true" is used. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-server-authentication>	0 or 1 time	Specifies a tag that indicates whether to perform server authentication, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Perform server authentication. false: Do not perform server authentication. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present "false" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server. Note that when you specify "true", settings related to keystore are required. For details on how to set keystore, see Appendix H.1 Secure connection using FTPS (FTP adapter).
	<ftp-user>#3		0 or 1 time	Specifies a tag that indicates the login user name of the FTP server to be connected. Use it as an argument for USER command. The login user specified in this tag must have the permission to execute file operations. If this tag is set repetitively in the FTP adapter runtime-environment property file, the value of a request message becomes valid. If the tag is present and a normal value is present "USER "Value"" is issued. If the value contains linefeed, a system exception is to be returned. If the tag is present and the value is not present or if an invalid character is included in the value a system exception is to be returned. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified in FTP adapter runtime-environment property file, a system exception is to be returned.
	<ftp-acct>#3		0 or 1 time	Specifies a tag that indicates the billing information of the FTP server to be connected. If this tag is set repetitively in FTP adapter runtime-environment property file, the value of a request message becomes valid. User for whom the billing information is required The following value is used as per the condition: If the tag is present and the value is normal The contents of the tag are used in ACCT command. If a linefeed is included in the value, a system exception is to be returned. If the tag is present and an invalid character is included in the value A system exception is to be returned. If the tag is present and the value is not present "ACCT""" is issued. If the tag is not present The value of ACCT specified in FTP adapter account definition file is used. If ACCT is not present in FTP adapter account definition file, "ACCT """ is issued. User for whom the billing information is not required Specification is ignored.
	<ftp-type>		0 or 1 time	Specifies a tag that indicates the data type to be transferred (transmission mode). Use this tag as an argument in TYPE command. If this tag is set repetitively in FTP adapter runtime-environment property file, the value given in the request message becomes valid. The specified value is either of the following values: A: Transfer the data in ASCII format. I: Transfer the data in binary format. If the tag is present and the value is either "A" or "I" The tag is used as an argument of TYPE command. If the tag is present and the value is neither "A" nor "I" A system exception is to be returned. If the tag is present and the value is not present TYPE command is not executed.#4 If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified in FTP adapter runtime-environment property file, TYPE command is not executed.#4
	<ftp-mode>		0 or 1 time	Specifies a tag that indicates transfer mode (compression mode). Use this tag as an argument in MODE command. If this tag is set repetitively in FTP adapter runtime-environment property file, the value given in the request message becomes valid. The specified value is either of the following values: S: Transfer the file without compressing it. C: Compress the file and transfer it. If the tag is present and the value is either "S" or "C" The tag is used as an argument of MODE command. If the tag is present and the value is neither "S" nor "C" A system exception is to be returned. If the tag is present and the value is not present MODE command is not executed. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified even in FTP adapter runtime-environment property file, MODE command is executed using default "S".
	<transfer-type>		1 time	Specifies a tag that indicates the transfer type. Set either of the following values: STOR: Overwriting a file APPE: Adding information to a file If the tag is present and the value is either "STOR" or "APPE" The tag is used as transfer type. If the tag is not present or the tag is present and the value is neither "STOR" nor "APPE" A system exception is to be returned.
	<request-id>		0 or 1 time	Specifies a tag that indicates the request ID created in FTP reception. If the tag and the value both are present The tag is used as request ID. If the tag is not present or if the tag is present and the value is not present When using a working folder, a system exception is to be returned. This exception is ignored, when using a common folder.
	<local-folder>		1 time	Specifies a tag that indicates a local folder. When common="true" is specified in tag attribute Use a common folder as a local folder and specify "Common folder definition name" in this tag. When you cannot acquire a common folder from the specified common folder definition name, a system exception is to be returned. When common="false" is specified in tag attribute Use a working folder as a local folder. If the common attribute is not present or the value is neither "true" nor "false" A system exception is to be returned.
	<local-file-name>		1 time	Specifies a tag that indicates the name of a local file. Specify a file, which is present just under the working folder or common folder. You can use a delimiting character such as slash (/) or back slash (\) only at the beginning of a file name. If you use a slash (/) at the beginning of a file name, slash (/) is ignored. Also, specify a file not having a symbolic link. If the tag is present and the value follows the above-mentioned limitation The tag is used as file name. If the tag is present and the value does not follow the above-mentioned limitation A system exception is to be returned. If the tag is not present or if the tag is present and the value is not present A system exception is to be returned.
	<remote-path>#5		1 time	Specifies a tag that indicates the remote path name (name of the destination path at the time of transferring to FTP server). If the tag and the value both are present The tag is used as remote path name. If the tag is not present or if the tag is present and the value is not present A system exception is to be returned.
	<ftp-commands-before>		0 or 1 time	Specifies a tag that indicates the FTP command and its argument to be executed prior to file transfer.#6 When executing multiple commands, separate the commands in the sequence in which they will be executed using a semicolon (;), and then and set. (Example: MKD transdir;CWD transdir). If the tag and the value both are present The tag is used as the command to be executed prior to file transfer. If the tag is not present or the tag is present and the value is not present There is no command to be executed prior to file transfer.
	<ftp-commands-after>		0 or 1 time	Specifies a tag that indicates the FTP command and its argument to be executed after file transfer.#6 When executing multiple commands, separate the commands in the sequence in which they will be executed using a semicolon (;) and set them (Example: RNFR oldfile.txt;RNTO newfile.txt). If the tag and the value both are present The tag is used as the command to be executed after file transfer. If the tag is not present or the tag is present and the value is not present There is no command to be executed after file transfer.

Legend:

-: There is no corresponding item.

Note#1

If the specified occurrence count is exceeded, the operation is not guaranteed.

Note#2

If you specify false in the value of the <ftps-enable> tag or the <ftps-implicit-mode> tag, when the connection destination FTP server is running in Implicit mode of FTPS, waiting status might appear after connecting to the FTP server till the timeout occurs.

The smallest value from among the following values is the duration till the timeout occurs:

- Value specified in ftpadp.control-con.connect.timeout property of FTP adapter runtime-environment property file

- Time-out value set in connection destination FTP server

If the time-out occurs as per the value specified in ftpadp.control-con.connect.timeout property of FTP adapter runtime-environment property file, after you perform retry operation for the count specified in ftpadp.control-con.retry.count property of FTP adapter runtime-environment property file, error of KDEK30407-E occurs.

If the time-out occurs as per the value set in the connection destination FTP server, error of KDEK30428-E occurs.

Note#3

You can use only the following characters:

one-byte alphanumeric characters, one-byte space, 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 (]), yen mark (\), circumflex accent (^), underscore (_), accent grave (`), left curly bracket ({), right curly bracket(}), pipeline (|), wave dash (~)

Note#4

The file is transferred in ASCII format by default as per the specifications of FTP protocol (RFC959).

Note#5

If you specify a value same as the <transfer-path> tag of a request message of the FTP reception in the <remote-path> tag of FTP adapter, the path starts with a slash (/).

When you specify a relative path or when you want to specify a path in the absolute path format of Windows, if there is slash (/) at the beginning of the path, a problem occurs. In such cases, extract the string from 2nd character onward from the value of the <transfer-path> tag of the request message of the FTP reception using substring acquisition function (substr) in the data transformation activity of a business process and set that string in the <remote-path> tag of FTP adapter.

Note#6

The command specified in the <ftp-commands-before> tag and the <ftp-commands-after> tag the <ftp-commands-after> tag is sent as-is to the FTP server. The FTP adapter is not affected by the impact of the execution of the command and the validity of the command option.

Therefore, if you specify the OPTS UTF {ON|OFF} command in the <ftp-commands-before> tag and the <ftp-commands-after> tag, you must specify the character set that is applied to the communication with FTP server in either of the following:

- <file-name-charset> tag of a request message

- ftpadp.file-name.charset property of FTP adapter runtime-environment property file

GET operation

The following table describes the request message format of GET operation to be passed to FTP adapter by a business process. File name is "ftpadp_get_request.xsd". The name of the name space is "http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/get_request".

Table 3-47 Request message format (GET operation)

Tag name			Occurrence count#1	Description
<request>			1 time	-
	<host-ipaddr>		0 or 1 time	Specifies the IP address or the host name of the FTP server to be connected. If the tag and the value both are present connect is issued using the specified string. If the tag is present and the value is not present a system exception is to be returned. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified in FTP adapter runtime-environment property file, a system exception is to be returned. When using an OS from Windows Vista and Windows Server 2008 onward, if you specify a loopback IP address (127.0.0.1 or localhost), a failure might occur in FTP connection. Specify the real IP address or the host name.
	<host-con-port>		0 or 1 time	Specifies the port number for control connection of the FTP server. If the tag and the value both are present Specify a port number within the range from 1 to 65535. If you specify any other number, a system exception is to be returned. If the tag is present and the value is not present 21 is specified by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
	<file-name-charset>		0 or 1 time	Specifies a tag that indicates the name of the character set to be used when sending and receiving information such as file name using control connection with the FTP server. The specified value is either of the following values: UTF-8: Use "UTF-8" in the character set. MS932: Use "MS932" in the character set. In case of a character set for which the tag is present and the value can be used It will be applied as the character set to be used when sending and receiving information such as file names. In case of a character set name for which the tag is present and the value cannot be used A system exception is to be returned. If the tag is present and the value is not present By default "UTF-8" is used. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
	<ftps>		0 or 1 time	Specifies a tag that indicates the settings related to FTPS. If the tag is not present, the value given in FTP adapter runtime-environment property file becomes valid for all settings related to FTPS.
		<ftps-enable>	0 or 1 time	Specifies a tag that indicates whether to use FTPS to connect to an FTP server. The specified value is either of the following values: true: Use FTPS to connect to an FTP server. false: Use a normal FTP to connect to an FTP server.#2 When using FTPS, the communication of control connection and data connection is encrypted. However, the destination FTP server must support the connection done by FTPS. Even if you specify "true", when the encryption of communication of data connection is not set, even the communication of data connection is not encrypted. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present "false" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
		<ftps-protocol-name>	0 or 1 time	Specifies a tag that indicates the protocol for security communication to be used, when using FTPS to connect to an FTP server. The specified value is either of the following values: TLS: Use TLS in the protocol for security communication. SSL: Use SSL in the protocol for security communication. If the tag is present and the value is "TLS" or "SSL" The specified value is applied. If the tag is present and the value is other than "TLS" or "SSL" a system exception is to be returned. If the tag is present and the value is not present "TLS" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-implicit-mode>	0 or 1 time	Specifies a tag that indicates whether to use Implicit mode of FTPS, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Use Implicit mode. false: Use Explicit mode.#2 If the tag is present and the value is "true" or ""false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present "false" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-data-con-secure>	0 or 1 time	Specifies a tag that indicates whether to encrypt the communication of data connection, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Encrypt the communication of data connection. false: Do not encrypt the communication of data connection. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present "true" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-server-authentication>	0 or 1 time	Specifies a tag that indicates whether to perform server authentication, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Perform server authentication. false: Do not perform server authentication. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present "false" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server. Note that you must perform settings related to keystore to specify "true". For details on how to set keystore, see Appendix H.1 Secure connection using FTPS (FTP adapter).
	<ftp-user>#3		0 or 1 time	Specifies a tag that indicates the login user name of FTP server to be connected. Use it as an argument of USER command. The login user specified in this tag must have permission to execute file operations. If this tag is set repetitively in FTP adapter runtime-environment property file, the value of a request message becomes valid. If the tag is present and a normal value is present "USER "Value"" is issued. If the value contains linefeed, a system exception is to be returned. If the tag is present and the value is not present, or if an invalid character is included in the value A system exception is to be returned. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified in FTP adapter runtime-environment property file, a system exception is to be returned.
	<ftp-acct>#3		0 or 1 time	Specifies a tag that indicates the billing information of the FTP server to be connected. If this tag is set repetitively in FTP adapter runtime-environment property file, the value of a request message becomes valid. User for whom the billing information is required The following value is used as per the condition: If the tag is present and the value is normal The contents of the tag are used in ACCT command. If a linefeed is included in the value, a system exception is to be returned. If the tag is present and an invalid character is included in the value A system exception is to be returned. If the tag is present and the value is not present "ACCT""" is issued. If the tag is not present The value of ACCT specified in FTP adapter account definition file is used. If ACCT is not present in FTP adapter account definition file, "ACCT """ is issued. User for whom the billing information is not required Specification is ignored.
	<ftp-type>		0 or 1 time	Specifies a tag that indicates the data type to be transferred (transmission mode). Use this tag as an argument in TYPE command. If this tag is set repetitively in FTP adapter runtime-environment property file, the value given in the request message becomes valid. The specified value is either of the following values: A: Transfer the data in ASCII format. I: Transfer the data in binary format. If the tag is present and the value is either "A" or "I" The tag is used as an argument of TYPE command. If the tag is present and the value is neither "A" nor "I" a system exception is to be returned. If the tag is present and the value is not present TYPE command is not executed.#4 If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified in FTP adapter runtime-environment property file, TYPE command is not executed.#4
	<ftp-mode>		0 or 1 time	Specifies a tag that indicates the transfer mode (compression mode). Use this tag as an argument in the MODE command. If this tag is set repetitively in FTP adapter runtime-environment property file, the value given in the request message becomes valid. The specified value is either of the following values: S: Transfer the file without compressing it. C: Compress the file and transfer it. If the tag is present and the value is either "S" or "C" The tag is used as an argument of the MODE command. If the tag is present and the value is neither "S" nor "C" A system exception is to be returned. If the tag is present and the value is not present The MODE command is not executed. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified even in FTP adapter runtime-environment property file, the MODE command is executed using default "S".
	<request-id>		0 or 1 time	Specifies a tag that indicates the request ID created in FTP reception. If the tag and the value both are present The tag is used as request ID. If the tag is not present or if the tag is present and the value is not present When using a working folder, a system exception is to be returned. This exception is ignored, when using a common folder.
	<local-folder>		1 time	Specifies a tag that indicates a local folder. When common="true" is specified in tag attribute Use a common folder as a local folder and specify "Common folder definition name" in this tag. When you cannot acquire a common folder from the specified common folder definition name, a system exception is to be returned. When common="false" is specified in tag attribute Use a working folder as a local folder. If the common attribute is not present or the value is neither "true" nor "false A system exception is to be returned.
	<local-file-name>		1 time	Specifies a tag that indicates name of a local file. When using a working folder If the tag and the value both are present This setting is ignored and the process continues. If the tag is not present or if the tag is present and the value is not present The process continues. When using a common folder Specify a file, which is present just under a common folder. You can use a delimiting character such as slash (/) or yen mark (\) only at the beginning of a file name. If you use a slash (/) at the beginning of a file name, slash (/) is ignored. Also, specify a file not having a symbolic link. If the tag is present and the value follows the above-mentioned limitation The tag is used as file name. If the tag is present and the value does not follow the above-mentioned limitation A system exception is to be returned. If the tag is not present or if the tag is present and the value is not present A system exception is to be returned.
	<remote-path>#5		1 time	Specifies a tag that indicates the remote path name (name of the destination path at the time of transferring to the FTP server). If the tag and the value both are present The tag is used as remote path name. If the tag is not present or if the tag is present and the value is not present A system exception is to be returned.
	<ftp-commands-before>#6		0 or 1 time	Specifies a tag that indicates the FTP command and its argument to be executed prior to file transfer. When executing multiple commands, separate the commands in the sequence in which they will be executed using a semicolon (;) and set them. (Example: MKD transdir;CWD transdir) If the tag and the value both are present The tag is used as the command to be executed prior to file transfer. If the tag is not present or the tag is present and the value is not present There is no command to be executed prior to file transfer.
	<ftp-commands-after>#6		0 or 1 time	Specifies a tag that indicates the FTP command and its argument to be executed after file transfer. When executing multiple commands, separate the commands in the sequence in which they will be executed using a semicolon (;) and set them. (Example: RNFR oldfile.txt;RNTO newfile.txt) If the tag and the value both are present The tag is used as the command to be executed after file transfer. If the tag is not present or the tag is present and the value is not present There is no command to be executed after file transfer.

Legend:

-: There is no corresponding item.

Note#1

If the specified occurrence count is exceeded, the operation is not guaranteed.

Note#2

When the destination FTP server is running in Implicit mode of FTPS, if you specify false in the value of the <ftps-enable> tag or the <ftps-implicit-mode> tag, waiting status might appear after you connect to the FTP server till the timeout occurs.

The smallest value from among the following values is the duration till the timeout occurs:

- Value specified in ftpadp.control-con.connect.timeout property of FTP adapter runtime-environment property file

- Time-out value set in the connection destination FTP server

If the time-out occurs as per the value specified in ftpadp.control-con.connect.timeout property of FTP adapter runtime-environment property file, after you perform retry operation for the count specified in ftpadp.control-con.retry.count property of FTP adapter runtime-environment property file, error of KDEK30407-E occurs.

If the time-out occurs as per the value set in destination FTP server, error of KDEK30428-E occurs.

Note#3

You can use only the following characters:

one-byte alphanumeric characters, one-byte space, 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 (]), yen mark (\), circumflex accent (^), underscore (_), accent grave (`), left curly bracket ({), right curly bracket(}), pipeline (|), wave dash (~)

Note#4

The file is transferred in ASCII format by default as per the specifications of FTP protocol (RFC959).

Note#5

If you specify a value same as the <transfer-path> tag of a request message of the FTP reception in the <remote-path> tag of the FTP adapter, the path starts with a slash (/).

When you specify a relative path or when you want to specify a path in the absolute path format of Windows, if there is slash (/) at the beginning of the path, a problem occurs. In such cases, extract the string from 2nd character onward from the value of the <transfer-path> tag of the request message of the FTP reception using substring acquisition function (substr) in the data transformation activity of a business process and set that string in the <remote-path> tag of the FTP adapter.

Note#6

The command specified in the <ftp-commands-before> tag and the <ftp-commands-after> tag the <ftp-commands-after> tag is sent as is to FTP server. The FTP adapter is not affected by the impact of the execution of the command and the validity of the command option.

Therefore, if you specify OPTS UTF {ON|OFF} command in the <ftp-commands-before> tag and the <ftp-commands-after> tag, you must specify the character set that is applied to the communication with the FTP server in either of the following:

- <file-name-charset> tag of a request message

- ftpadp.file-name.charset property of FTP adapter runtime-environment property file

GETINFO operation

The following table describes the request message format of GETINFO operation, which a business process passes on to an FTP adapter. The file name is "ftpadp_getinfo_request.xsd". The name of the name space is "http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/getinfo_request".

Table 3-48 Request message format (GETINFO operation)

Tag name			Occurrence count #1	Description
<request>			1 time	-
	<host-ipaddr>		0 or 1 time	Specifies the IP address or the host name of the FTP server to be connected. If the tag and the value both are present connect is issued using the specified string. If the tag is present and the value is not present a system exception is to be returned. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified in FTP adapter runtime-environment property file, a system exception is to be returned. When using an OS from Windows Vista and Windows Server 2008 onward, if you specify loopback IP address (127.0.0.1 or localhost), a failure might occur in FTP connection. Specify the real IP address or the host name.
	<host-con-port>		0 or 1 time	Specifies the port number for the control connection of FTP server. If the tag and the value both are present Specify a port number within the range from 1 to 65535. If you specify any value other than this, a system exception is to be returned. If the tag is present and the value is not present 21 is specified by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
	<file-name-charset>		0 or 1 time	Specifies a tag that indicates the name of the character set to be used when sending and receiving the following information using the control connection between FTP servers. Information to be sent and received using control connection (such as file name) Information received from an FTP server through a data connection at the time of executing LIST command or NLST command (information of file list) The specified value is either of the following values: UTF-8: Use "UTF-8" in the character set. MS932: Use "MS932" in the character set. In case of character set for which the tag is present and the value can be used It will be applied as the character set to be used when sending and receiving information such as file names. In case of character set name for which the tag is present and the value cannot be used A system exception is to be returned. If the tag is present and the value is not present "UTF-8" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
	<ftps>		0 or 1 time	Specifies a tag that indicates the settings related to FTPS. If the tag is not present, the value given in FTP adapter runtime-environment property file becomes valid for all the settings related to FTPS.
		<ftps-enable>	0 or 1 time	Specifies a tag that indicates whether to use FTPS to connect to an FTP server. The specified value is either of the following values: true: Use FTPS to connect to an FTP server. false: Use normal FTP to connect to an FTP server.#2 When you use FTPS, the communication of control connection and data connection is encrypted. However, the connection destination FTP server must support the connection using FTPS. Even if you specify "true", when encryption of communication of data connection is not set, communication of data connection is also not encrypted. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" a system exception is to be returned. If the tag is present and the value is not present "false" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid.
		<ftps-protocol-name>	0 or 1 time	Specifies a tag that indicates the protocol for security communication to be used, when using FTPS to connect to an FTP server. The specified value is either of the following values: TLS: Use TLS in the protocol for security communication. SSL: Use SSL in the protocol for security communication. If the tag is present and the value is "TLS" or "SSL" The specified value is applied. If the tag is present and the value is other than "TLS" or "SSL" A system exception is to be returned. If the tag is present and the value is not present "TLS" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-implicit-mode>	0 or 1 time	Specifies a tag that indicates whether to use Implicit mode of FTPS, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Use Implicit mode. false: Use Explicit mode.#2 If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" a system exception is to be returned. If the tag is present and the value is not present "false" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-data-con-secure>	0 or 1 time	Specifies a tag that indicates whether to encrypt the communication of data connection, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Encrypt the communication of data connection. false: Do not encrypt the communication of data connection. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present "true" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server.
		<ftps-server-authentication>	0 or 1 time	Specifies a tag that indicates whether to perform server authentication, when using FTPS to connect to an FTP server. The specified value is either of the following values: true: Perform server authentication. false: Do not perform server authentication. If the tag is present and the value is "true" or "false" The specified value is applied. If the tag is present and the value is other than "true" or "false" A system exception is to be returned. If the tag is present and the value is not present "false" is used by default. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. This setting becomes valid only when using FTPS to connect to an FTP server. Note that when you specify "true", settings related to keystore are required. For details on how to set a keystore, see, Appendix H.1 Secure connection using FTPS (FTP adapter).
	<ftp-user>#3		0 or 1 time	Specifies a tag that indicates the login user name of the FTP server to be connected. Use it as an argument for USER command. The login user specified in this tag must have permission to execute file operations. If this tag is set repetitively in FTP adapter runtime-environment property file, the value of a request message becomes valid. If the tag is present and a normal value is present "USER "Value"" is issued. If the value contains linefeed, a system exception is to be returned. If the tag is present and the value is not present or if an invalid character is included in the value A system exception is to be returned. If the tag is not present The value given in FTP adapter runtime-environment property file becomes valid. If a value is not specified in FTP adapter runtime-environment property file, a system exception is to be returned.
	<ftp-acct>#3		0 or 1 time	Specifies a tag that indicates the billing information of the FTP server to be connected. If this tag is set repetitively in FTP adapter runtime-environment property file, the value of a request message becomes valid. User for whom the billing information is required The following value is used as per the condition: If the tag is present and the value is normal The contents of the tag are used in ACCT command. If a linefeed is included in the value, a system exception is to be returned. If the tag is present and an invalid character is included in the value A system exception is to be returned. If the tag is present and the value is not present "ACCT""" is issued. If the tag is not present The value of ACCT specified in FTP adapter account definition file is used. If ACCT is not present in FTP adapter account definition file, "ACCT """ is issued. User for whom the billing information is not required Specification is ignored.
	<getinfo-type>		1 time	Specifies a tag that indicates the acquisition type of the information acquired from the FTP server to be connected. Either of the following values is the setup value: LIST: Execute LIST command and acquire the list of file information. NLST: Execute NLST command and acquire the list of file names. If the tag is present and the value is either "LIST" or "NLST" Use the specified value as the acquisition type. If the tag is present and the value is other than "LIST" or "NLST" A system exception is to be returned. If the tag is not present or if the tag is present and the value is not present A system exception is to be returned.
	<getinfo-option>		0 or 1 time	Specifies a tag that indicates the acquisition option for the information acquired from the FTP server to be connected. This option is to be specified when executing the command specified in <getinfo-type>. If the tag and the value both are present Mention the specified value as an option and execute the command specified in <getinfo-type>. The tag is not present or if the tag is present and the value is not present Execute the command specified in < getinfo-type > without specifying an option.
	<getinfo-path>		0 or 1 time	Specifies a tag that indicates the acquisition path of the information acquired from the FTP server to be connected. This path is to be specified when executing the command specified in <getinfo-type>. If the tag and the value both are present Mention the specified value as the path and execute the command specified in <getinfo-type>. The tag is not present or if the tag is present and the value is not present Execute the command specified in <getinfo-type> without specifying the path.
	<request-id>		0 or 1 time	Specifies a tag that indicates the request ID created in FTP reception.#5 If the tag and the value both are present The working folder is used as the local folder. The specified value is used as the request ID. This is valid only when a value other than common="true" is specified in the attribute of <local-folder>. If the tag is present and the value is not present a system exception is to be returned. If the tag is not present If <local-folder> tag is omitted, it is not output to a response message.
	<local-folder>		0 or 1 time	Specifies a tag that indicates a local folder.#5 If common="true" is specified in the tag attribute Use a common folder as the local folder and specify "Name of common folder definition" in this tag. When you cannot acquire the common folder from the specified name of the common folder definition, a system exception is to be returned. If common="false" is specified in the tag attribute Use a working folder as the local folder. If common attribute is not present or the value is neither "true" nor "false" A system exception is to be returned. If the tag is not present Use a working folder as the local folder. However, if <request-id> is omitted, it is output to a response message.
	<local-file-name>		0 or 1 time	Specifies a tag that indicates the name of a local file.#5 When using a working folder Specification of the tag is ignored and the process continues. When using a common folder Specify name of the file present just under the common folder. If you specify name of a file which does not exist, a file is created with the specified name. You can use a delimiting character such as slash (/) or yen mark (\) only at the beginning of a file name. If you use a slash (/) at the beginning of a file name, slash (/) is ignored. Also, specify a file not having a symbolic link. If the tag is present and the value follows the above-mentioned limitation The tag is used as file name. If the tag is present and the value does not follow the above-mentioned limitation A system exception is to be returned. If the tag is not present or if the tag is present and the value is not present A system exception is to be returned. When the tag is to be output to a response message Specification of the tag is ignored and the process continues.
	<ftp-commands-before>#4		0 or 1 time	Specifies a tag that indicates the FTP command and its arguments to be executed before executing the list command. When executing multiple commands, separate the commands in the sequence in which they will be executed using a semicolon (;) and set them (Example: MKD transdir;CWD transdir). If the tag and the value both are present The command is used as the command to be executed before executing the list command. If the tag is not present or the tag is present and the value is not present There is no command to be executed before executing the list command.
	<ftp-commands-after>#4		0 or 1 time	Specifies a tag that indicates the FTP command and its arguments to be executed after executing the list command. When executing multiple commands, separate the commands in the sequence in which they will be executed using a semicolon (;) ,and set them (Example: RNFR oldfile.txt;RNTO newfile.txt). If the tag and the value both are present The command is used as the command to be executed after executing the list command. If the tag is not present or if the tag is present and the value is not present There is no command to be executed after executing the list command.

Legend:

-: There is no corresponding item.

Note#1

If the specified occurrence count is exceeded, the operation is not guaranteed.

Note#2

If you specify false in the value of the <ftps-enable> tag or the <ftps-implicit-mode> tag, when the connection destination FTP server operates in Implicit mode of FTPS, waiting status might appear after connecting to the FTP server till the timeout occurs.

The smallest value from among the following values is the duration till the timeout occurs:

- Value specified in ftpadp.control-con.connect.timeout property of FTP adapter runtime-environment property file

- Time-out value set in connection destination FTP server

If the time-out occurs as per the value specified in ftpadp.control-con.connect.timeout property of FTP adapter runtime-environment property file, after you perform retry operation for the count specified in ftpadp.control-con.retry.count property of FTP adapter runtime-environment property file, error of KDEK30407-E occurs.

If the time-out occurs as per the value set in the connection destination FTP server, error of KDEK30428-E occurs.

Note#3

You can use only the following characters:

one-byte alphanumeric characters, one-byte space, 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 (]), yen mark (\), circumflex accent (^), underscore (_), accent grave (`), left curly bracket ({), right curly bracket(}), pipeline (|), wave dash (~)

Note#4

The command specified in the <ftp-commands-before> tag and the <ftp-commands-after> tag the <ftp-commands-after> tag is sent as is to FTP server. The FTP adapter is not affected by the impact of the execution of the command and the validity of the command option.

Therefore, if you specify OPTS UTF {ON|OFF} command in the <ftp-commands-before> tag and the <ftp-commands-after> tag, you must specify the character set that is applied to the communication with FTP server in either of the following:

- <file-name-charset> tag of a request message

- ftpadp.file-name.charset property of FTP adapter runtime-environment property file

Note#5

For details on how to define GETINFO operation, see (c) Request message and response message to be used at the time of using GETINFO operation.

(b) Response message format for FTP adapters

PUT operation

The following table describes the response message format for PUT operation, which is returned to the calling business process by the FTP adapter. The file name is "ftpadp_put_response.xsd". The name of the name space is "http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/put_response".

Table 3-49 Response message format (PUT operation)

Tag name			Occurrence count	Description
<response>			1 time	-
	<local-folder>		1 time	Specifies a tag that indicates a local folder. If you use a working folder, "common="false"" is set in the attribute. Null is set in the value. If you use a common folder, "common="true"" is set in the attribute. The name of the common folder definition specified in the <local-folder> tag of a request message is set in the value.
	<local-file-name>		1 time	Specifies a tag that indicates name of the local file. The value specified in <local-file-name> of a request message is set.
	<command-info>		More than 1 time	-
		<command>	1 time	Specifies a tag that indicates the command executed by an FTP adapter. #1 All the FTP commands, which are executed are output.
		<command-message>	More than 1 time	Specifies a tag that indicates display message of the command executed by an FTP adapter.#2 The message of the FTP command consists of FTP response code and a message. In case of a message having multiple lines, if the response code of these lines is same, 1 tag is generated. In case of FTP response code of multiple types, multiple tags are generated.

Legend:

-: There is no corresponding item.

Note#1

For details on the types of the commands executed by an FTP adapter, see 8.6.2 Executing the FTP commands in the manual Service Platform Overview.

For details on the output format of the commands executed by an FTP adapter and examples of output, see Table 3-52.

Note#2

For details on the message format of FTP commands and examples of output, see Table 3-53.

GET operation

The following table describes the response message format of GET operation, which is returned to the calling business process by an FTP adapter. The file name is "ftpadp_get_response.xsd". The name of the name space is "http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/get_response".

Table 3-50 Response message format (GET operation)

Tag name			Occurrence count	Description
<response>			1 time	-
	<local-folder>		1 time	Specifies a tag that indicates a local folder. If you use a working folder, "common="false"" is set in the attribute. Null is set in the value. If you use a common folder, "common="true"" is set in the attribute. The name of the common folder definition specified in the <local-folder> tag of a request message is set in the value.
	<local-file-name>		1 time	Specifies a tag that indicates name of a local file. When using a working folder Specify name of the file, which is stored just under the working folder. File name will be in the format of "csc_<characters generated internally>". When using a common folder The value specified in <local-file-name> of a request message is set.
	<file-size>		1 time	Specifies a tag that indicates the size of the remote file, which is sent and received. Size of the local file acquired from an FTP server is set.
	<command-info>		More than 1 time	-
		<command>	1 time	Specifies a tag that indicates the FTP command executed by an FTP adapter.#1 All the FTP commands, which are executed are output.
		<command-message>	More than 1 time	Specifies a tag that indicates the display message of the command executed by an FTP adapter .#2 The message of the FTP command consists of the FTP response code and a message. In case of a message having multiple lines, if the response code of these lines is same, 1 tag is generated. In case of the FTP response code of multiple types, multiple tags are generated.

Legend:

-: There is no corresponding item.

Note#1

For details on the types of the commands executed by an FTP adapter, see 8.6.2 Executing the FTP commands in the manual Service Platform Overview.

For details on the output format of the commands executed by an FTP adapter and examples of output, see Table 3-52.

Note#2

For details on the message format of FTP commands and examples of output , see Table 3-53.

GETINFO operation

The following table describes the response message format of GETINFO operation, which is returned by the calling business process by an FTP adapter. The file name is "ftpadp_getinfo_response.xsd". The name of the name space is "http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/getinfo_response".

Table 3-51 Response message format (GETINFO operation)

Tag name			Occurrence count	Description
<response>			1 time	-
	<local-folder>		0 or 1 time	Specifies a tag that indicates a local folder. This tag appears when the output is to be generated in a common folder. This tag does not appear when the output is to be generated in a working folder or a response message. When using a common folder "common="true"" is set in the attribute. The name of the common folder definition specified in the <local-folder> tag of a request message is set in the value.
	<local-file-name>		0 or 1 time	Specifies a tag that indicates the name of a local file. This tag appears, when the output is to be generated in a working folder or common folder. This tag does not appear, when the output is to be generated in a response message. When using a working folder Specify name of the file, which is stored just under the working folder. File name will be in the format of "csc_<characters generated internally>". The acquired information is output using the character set of "UTF-16". Also, the linefeed code is output using CRLF. When using a common folder The value specified in <local-file-name> of a request message is set. The acquired information is written in this file using character set of UTF-16. Also, the linefeed code will be CRLF.
	<reply-code>		1 time	Specifies a tag that indicates reply code of the LIST command or the NLST command. When you execute LIST command or NLST command, either of the following values is set as the reply code which is sent at the end by FTP server: 200~299 Specifies a code indicating that the process has completed successfully. 450 or 550 Specifies a tag indicating that the file operation could not be performed. Note that if the path specified in the LIST command or the NLST command does not exist, the reply code which is returned differs according to the connection destination FTP server.
	<reply-message>		1 time	Specifies a tag that indicates the reply message of the LIST command or the NLST command. When you execute the LIST command or the NLST command, the reply message which is sent at the end is set by the FTP server.
	<command-info>		More than 1 time	-
		<command>	1 time	Specifies a tag that indicates an FTP command executed by an FTP adapter. #1 All the FTP commands, which are executed are output.
		<command-message>	More than 1 time	Specifies a tag that indicates a display message of the command executed by an FTP adapter.#2 The message of the FTP command consists of FTP response code and a message. In case of a message having multiple lines, if the response code of these lines is same, 1 tag is generated. In case of the FTP response code of multiple types, multiple tags are generated.
	<list-info>		0 or 1 time	Appears when the output is to be generated in a response message.#3
		<list>	More than 0	Appears when the output is to be generated in a response message.#3

Legend:

-: There is no corresponding item.

Note#1

For details on the types of the commands executed by an FTP adapter, see 8.6.2 Executing the FTP commands in the manual Service Platform Overview.

For details on the output format of the commands executed by an FTP adapter and examples of output, see Table 3-52.

Note#2

For details on the message format of FTP commands and examples of output , Table 3-53.

Note#3

For details on how to define GETINFO operation, see (c) Request message and response message to be used at the time of using GETINFO operation.

Output format of the commands executed by an FTP adapter and examples of output

The following table describes the output format of the FTP commands which is output to the <command> tag of a response message and examples of output:

Table 3-52 Output format of the commands executed by an FTP adapter and examples of output

Item	FTP command	Output format	Example of output	Remarks
1	(Connection process)	Connected to <xxxxx>.	Connected to 10.208.180.254.	<xxxxx> is the IP address of the FTP server or the host name.
2	USER	USER <user name>	USER user1	-
3	PASS	PASS ********	PASS ********	The password is displayed with 8 * symbols.
4	ACCT	ACCT <Billing information>	ACCT acct1	-
5	TYPE	TYPE <format option>	TYPE A	Either "A" or "I" is displayed in <format option>.
6	MODE	MODE <transfer mode option>	MODE S	Either "S" or "C" is displayed in <transfer mode option>.
7	PASV	PASV	PASV	-
8	PORT	PORT <aaa>,<bbb>,<ccc>,<ddd>,<mmm>,<nnn>	PORT 10,208,182,27,14,160	<aaa>,<bbb>,<ccc>,<ddd> is the local IP address. <mmm>,<nnn> is the port number. The local data connection port number appears in the format of 256*mmm+nnn.
9	SITE	SITE FSIZE [<file size>]	SITE FSIZE 4096	For GET operation, <file size> is not output. Also, for PUT operation, size of the file present in the transfer path of the source file is output to <file size>.
10	Command prior to transfer or command prior to list	<command name> [<command argument>]	CWD ./workdir	-
11	STOR	STOR <path name>	STOR work/fileA.txt	-
12	APPE	APPE <path name>	APPE work/fileA.txt	-
13	RETR	RETR <path name>	RETR fileA.txt	-
14	LIST	LIST [<option>] [<path name>]	LIST -l work	-
15	NLST	NLST [<option>] [<path name>]	NLST -l work	-
16	Command after transfer or command after list	<command name> [<command argument>]	RNFR fileA.txt RNTO fileB.txt	-
17	QUIT	QUIT	QUIT	-

Legend:

-: There is no corresponding item.

Message format of FTP commands and examples of output

The following table describes the message format of FTP commands, which is output to <command-message> tag of a response message and examples of output:

Table 3-53 Message format of FTP commands and examples of output

Condition	Message format	Example of output
Single response code	<FTP response code> <message>	226 File receive OK.
	<FTP response code>-<message 1> [<message 2>] : <FTP response code> <message n#>	214-The following commands are recognized. ACCT ALLO APPE CDUP ... MDTM MKD NLST NOOP OPTS PASS ... RMD RNFR 214 Help OK.
Multiple response code	<FTP response code 1> <message 1> <FTP response code 2> <message 2>	150 File status okay; about to open data connection. 226 Transfer complete.

Note

For details on the string contents of a response code and a message, see a document on the FTP server in use.

Note#

n is a natural number.

(c) Request message and response message to be used at the time of using GETINFO operation

The following table describes the tags which must be specified in a request message, and the tags which appear in a response message, when you want to output the result of the LIST command or the NLIST command to a response message, a working folder, and a common folder.

For details on the setup contents of each tag and the tags which are not described in the table, see (a) Request message format for FTP adapters and (b) Response message format for FTP adapters.

Table 3-54 Relation between an output destination and a request message

Output destination	Tag to be specified in a request message
	<request-id>	<local-folder>	<local-file-name>
Response message	-	-	-
Working folder	Y	Y	-
Common folder	-	Y	Y

Legend:

Y: Specify.

-: Do not specify

Table 3-55 Relation between an output destination and a response message

Output destination	Tag to be specified in a response message
	<local-folder>	<local-file-name>	<list-info>	<list>
Response message	-	-	Y	Y
Working folder	-	Y	-	-
Common folder	Y	Y	-	-

Legend:

Y: Appears.

--: Does not appear.

Types of the definition file to be created are as follows:

• FTP adapter command definition file
  This file is used to define output destinations and output levels of messages of the user management commands used in FTP adapters.
  
• FTP adapter account definition file
  This file is used to define the user account information such as FTP authorized user, billing information. This file is referenced from FTP-adapter runtime-environment property file.
  
• FTP command permission list definition file (for FTP adapters)
  This file is used to define the execution permissions of the FTP commands to be executed before and after transfer. This file is referenced from the FTP reception config file and FTP-adapter runtime-environment property file.
  
• FTP-adapter runtime-environment property file
  This file is used to define the configuration information for each FTP adapter.
  

The following is the procedure for creating each definition file. You can create a definition file using the template file provided by the FTP adapter.

(a) Procedure for creating the FTP adapter command definition file

1. Copy the template file (Installation directory of the service platform\CSC\custom-adapter\FTP\config\templates\adpftpcommand.properties) and save this file in the following directory:
   Installation directory of the service platform\CSC\custom-adapter\FTP\config
   
2. Edit and save the definition contents.
   For details on the definition contents that you can edit in the FTP adapter command definition file, see FTP adapter command definition file in the manual Service Platform Reference Guide.
   

(b) Procedure for creating the FTP adapter account definition file

1. Execute the csaftpuseradd command to create the FTP adapter account definition file.
   You must specify the path of the FTP adapter account definition file in the ftpadp.account-inf-filepath key of the FTP-adapter runtime-environment property file. For details on the csaftpuseradd command, see csaftpuseradd (Registering and updating users of FTP adapters) in the manual Service Platform Reference Guide.
   

(c) Procedure for creating the FTP command permission list definition file (for FTP adapters)

1. Copy the template file (Installation directory of the service platform\CSC\custom-adapter\FTP\config\templates\cscthrough.properties) and save this file in any directory.
2. Change the name of the template file, which is copied with any name.
3. Edit and save the definition contents.
   For details on the definition contents that can be edited in the FTP command permission list definition file (for FTP adapters), see FTP command permission list definition file in the manual Service Platform Reference Guide.
   

(d) Procedure for creating FTP-adapter runtime-environment property file

1. Copy the template file (Installation directory of the service adapter\CSC\custom-adapter\FTP\config\templates\adpftp.properties) and save this file in the following directory:
   Installation directory of the service platform\CSC\custom-adapter\FTP\config
   
2. Change the name of the template file, which is copied with "<Service ID#>.properties".
3. Edit and save the definition contents.
   For details on the definition contents that can be edited in the FTP-adapter runtime-environment property file, see FTP-adapter runtime-environment property file in the manual Service Platform Reference Guide.
   

   Note

   A service ID is any string, which is to be specified on the service adapter settings screen, when adding a new FTP adapter.

Define data transformation of the message format definition file of transformation source and the message format definition file of the transformation destination using the data transformation definition screen.

For details on how to define data transformation, see 6. Defining Data Transformation in the manual Service Platform Basic Development Guide.

The procedure for defining FTP adapters is as follows:

1. Display the service adapter settings screen.
   For details on how to display the service adapter settings screen, see 3.3.1(4) Displaying the service adapter settings screen.
   
2. Set up the definition information.
   For details on the items for which setting is required in the service adapter settings screen (basic), see 3.3.15(8) For FTP adapters and 1.2.2 Service adapter settings screen in the manual Service Platform Reference Guide.
   
3. Click the [Service adapter settings (details)] tab.
   The service adapter settings screen (details) is displayed.
   
4. Set up the definition information.
   For details on the items for which setting is required in the service adapter settings screen (details), see 3.3.15(8) For FTP adapters and 1.2.2 Service adapter settings screen in the manual Service Platform Reference Guide.