6.8.4 FTP reception configuration file

Organization of this subsection

(1) Format
(2) Function
(3) Specifiable properties
(4) Example of coding
(5) Notes

(1) Format

[urecp-ftp.permission-def.filepath=Path-of-FTP-execution-authorization-list-definition-file]
[urecp-ftp.ftp-command-allow.filepath=Path-of-FTP-command-authorization-list-definition-file]
[urecp-ftp.request-timeout=processing-time-of-business-process-after-FTP-reception]
[urecp-ftp.resident-thread.count=number-of-resident-threads-used-for-monitoring-the-processing-time-after-FTP-reception]
[urecp-ftp.timer-thread.maximum=maximum-number-of-threads-used-for-monitoring-the-processing-time-after-FTP-reception]
[urecp-ftp.list-command-option.filepath=Path-of-list-command-options-definition-file]
[urecp-ftp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails]
[urecp-ftp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails]
[urecp-ftp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails]
[urecp-ftp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails]

To Page Top

(2) Function

Specifies the information for the settings that are changed frequently after an FTP reception is set up. The contents specified in the FTP reception configuration file become valid when an FTP reception starts.

This file specifies the parameters that depend on the execution environment of FTP receptions.

There are two types of FTP reception configuration files: the individual definition file specified for each FTP reception, and the common definition file that is applied to all FTP receptions. A common definition file that is applied to all FTP receptions is referred to as an FTP reception common configuration file.

If both an FTP reception configuration file and an FTP reception common configuration file are specified, the definitions of the two files are merged. If the same properties are specified in these files, the contents of the FTP reception configuration file become valid.

You can create an FTP reception configuration file and an FTP reception common configuration file based on the template file.

How to create an FTP reception configuration file

To create an FTP reception configuration file:

Define the FTP reception configuration file based on the following template file:

service-platform-installation-directory\CSC\config\ftprecp\templates\ftprecp_config.properties

Rename the edited FTP reception configuration file as reception-ID.properties, and then store the file in the following directory:
```
service-platform-installation-directory\CSC\config\ftprecp
```

How to create an FTP reception common configuration file

To create an FTP reception common configuration file:

Define the FTP reception common configuration file based on the following template file:

service-platform-installation-directory\CSC\config\ftprecp\templates\ftprecp_config.properties

Store the edited FTP reception common configuration file in the following directory:
```
service-platform-installation-directory\CSC\config\ftprecp\common
```
Do not change the file name.

To Page Top

(3) Specifiable properties

urecp-ftp.permission-def.filepath=Path-of-FTP-execution-authorization-list-definition-file ~ <Character strings (including two-byte characters) and spaces>

Specifies an absolute path for the FTP execution authorization list definition file.

If you omit this property in both the individual definition file and the common definition file, all users are permitted to execute business processes related to FTP receptions.

urecp-ftp.ftp-command-allow.filepath=Path-of-FTP-command-authorization-list-definition-file ~ <Character strings (including two-byte characters) and spaces>

Specifies an absolute path for the FTP command authorization list definition file (for FTP receptions).

If you omit this property in both the individual definition file and the common definition file, the execution of user-specified FTP commands is not permitted before and after transmission and before and after execution of list commands.

urecp-ftp.request-timeout=processing-time-of-business-process-after-FTP-reception ~ <Numeric character> ((0 to 2147483647)) <<0>>

Specifies the processing time from the passing of a request message to a business process after an FTP reception and until the return of a response message, in seconds.

If you specify 0 or if you omit the key or the value, the processing time is not monitored.
If you specify a value of 1 or more, resident threads will be created to monitor the processing time. Specify the number of resident threads in the urecp-ftp.resident-thread.count property.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

urecp-ftp.resident-thread.count=number-of-resident-threads-used-for-monitoring-the-processing-time-after-FTP-reception ~ <Numeric character> ((0 to 2147483647)) <<0>>

Specifies the number of resident threads created for monitoring the processing time in business processes after an FTP reception. A resident thread is generated when an FTP reception starts.

Also, no threads are generated if the monitoring process is not executed. Therefore, the value specified in this property is ignored.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed. Also, if you specify a value that is greater than the value specified in the urecp-ftp.timer-thread.maximum property, an error occurs when the command is executed.

urecp-ftp.timer-thread.maximum=maximum-number-of-threads-used-for-monitoring-the-processing-time-after-FTP-reception ~ <Numeric character> ((0 to 2147483647)) <<value specified for urecp-ftp.pooled-instance.maximum in the FTP reception definition file>>

Specifies the maximum number of threads used for monitoring the processing time after an FTP reception. No threads are generated if the processing time is not monitored. Therefore, the value specified in this property is ignored.

If you omit the key or the value, the value specified in the urecp-ftp.pooled-instance.maximum property (maximum number of instances pooled for the reception processing and the custom reception framework) of the FTP reception definition file is applied as the default value. The changes made with the csccompoconfig command are not applied.

The maximum number of threads is one amongst the following cases:

When you specify 0
When the default value is applied and the value specified for urecp-ftp.pooled-instance.maximum in the FTP reception definition file is 0

urecp-ftp.list-command-option.filepath=Path-of-list-command-options-definition-file ~ <Character strings (including two-byte characters) and spaces>

Specifies an absolute path for the list command options definition file.

If you omit this property in both the individual definition file and the common definition file, all information specified in the list command arguments is interpreted as the path information.

urecp-ftp.read-lock.retry.count=retry-count-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a shared lock of the files in the common folder fails. If you do not use the common folder, the value specified for this property is ignored because the files are not locked with a shared lock.

If you omit the key or the value, the default value is used for operation.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

urecp-ftp.read-lock.retry.interval=retry-interval-when-shared-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies, in seconds, the retry interval when a shared lock of the files in the common folder fails. If you do not use the common folder, the value specified for this property is ignored because the files are not locked with a shared lock.

If you omit the key or the value, the default value is used for operation.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

urecp-ftp.write-lock.retry.count=retry-count-when-dedicated-lock-of-common-folder-files-fails ~ <Numeric character> ((0 to 1024)) <<0>>

Specifies the retry count when a dedicated lock of the files in the common folder fails. If you do not delete the files in the common folder, the value specified for this property is ignored because the files are not locked with a dedicated lock.

If you omit the key or the value, the default value is used for operation.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

urecp-ftp.write-lock.retry.interval=retry-interval-when-dedicated-lock-of-common-folder-files-fails ~ <Numeric character> ((1 to 1024)) <<1>>

Specifies, in seconds, the retry interval when a dedicated lock of the files in the common folder fails. If you do not delete the files in the common folder, the value specified for this property is ignored because the files are not locked with a dedicated lock.

If you omit the key or the value, the default value is used for operation.

If you specify a non-numeric value or a value outside the range, an error occurs when the command is executed.

To Page Top

(4) Example of coding

The examples of coding are as follows:

In Windows

urecp-ftp.permission-def.filepath=C:\\my_config\\permission_A.properties
urecp-ftp.ftp-command-allow.filepath=C:\\my_config\\command_allow_X.properties
urecp-ftp.list-command-option.filepath=C:\\my_config\\list_command_option.txt

In UNIX

urecp-ftp.permission-def.filepath=/my_config/permission_A.properties
urecp-ftp.ftp-command-allow.filepath=/my_config/command_allow_X.properties
urecp-ftp.list-command-option.filepath=/my_config/list_command_option.txt

To Page Top

(5) Notes

Note the following when you specify the path:

Do not specify a path that contains characters expressing a relative path or a parent directory (..\ or ../) or characters expressing a current directory (.\ or ./).
Do not specify a path containing a symbolic link.
In Windows, do not specify a path containing a UNC format, an NTFS stream name, or a reserved device name. The path characters are not case sensitive.

To Page Top