3.12.1 File-event-reception definition file
- Organization of this subsection
(1) Format
[urecp-fileevent.thread-pool.minimum=minimum-number-of-threads-for-file-event-reception-process]
[urecp-fileevent.thread-pool.maximum=maximum-number-of-threads-for-file-event-reception-process]
[urecp-fileevent.sub-folder=path-of-subfolder-to-store-monitored-files]
[urecp-fileevent.common-folder.definition-name=common-folder-definition-name]
[urecp-fileevent.monitored-file-name.regex=regular-expression-of-monitored-file-name]
[urecp-fileevent.monitored.common-folder={true|false}]
[urecp-fileevent.file.auto-delete={true|false}]
(2) Function
Specifies the operating information for file event reception. This file is specified as a self-definition file when file event reception is created in the development environment.
To change the settings after file event reception is set up, edit the contents of the following template file, and then save the file with the same file name cscurecpfileevent.properties. Any other file names specified for a self-defined file are invalid.
(3) File storage location
service-platform-installation-directoryCSC\custom-reception\fileevent\config\templates\cscurecpfileevent.properties
- Important note
-
To edit the file-event-reception definition file, click the Edit button for Self-defined file in the User-Defined Reception Definition window (detailed) when adding a file event reception, and then modify the contents of the definition file.
The specified settings are enabled when file event reception starts. If the definition is invalid, an error occurs during deployment or startup of file event reception.
(4) Specifiable properties
(a) Number of threads that can be executed concurrently
urecp-fileevent.thread-pool.minimum=minimum-number-of-threads-for-file-event-reception-process ~ <Integer>((1-2147483647))<<1>>
For threads that invoke file event reception, this property specifies the minimum number of threads that can be executed concurrently in a thread pool.
urecp-fileevent.thread-pool.maximum=maximum-number-of-threads-for-file-event-reception-process ~<Integer>((1-2147483647))<<32>>
For threads that invoke file event reception, this property specifies the maximum number of threads that can be executed concurrently in a thread pool. You must specify a value equal to or greater than the minimum number of threads.
(b) Monitored files
urecp-fileevent.sub-folder=path-of-subfolder-to-store-monitored-files ~ <Character strings (including two-byte characters) and spaces>
When you store monitored files in a subfolder, specify the subfolder name as a relative path. Use a forward slash (/) as a folder delimiter.
If the specified folder does not exist, the request processing for file event reception fails.
Make sure that the total path length of the monitored files does not exceed the maximum path length of the OS. For details about the upper limit of the path length for the OS, see the documentation of the relevant OS.
urecp-fileevent.common-folder.definition-name=common-folder-definition-name ~ <Alphanumeric characters (0 to 9, a to f, and A to F), underscore (_)> ((1-64 characters))<<default>>
Specify the common folder definition name to be referenced when the file event reception checks for the existence of an acquisition target file.
You must specify the common folder definition name specified for common-folder-common-folder-definition-name in the HCSC server runtime definition file.
urecp-fileevent.monitored-file-name.regex=regular-expression-of-monitored-file-name ~ <Character string>
Specify the name of the file to be monitored by the file event reception, by using a regular expression. The coding format of the regular expression must comply with the java.util.regex.Pattern class specification.
If you omit this property, all files whose name does not contain .csc are monitored.
urecp-fileevent.monitored.common-folder={true|false} ~ <<false>>
Specify whether to monitor the common folder by the file event reception.
-
true
Monitors acquisition target files in the common folder.
-
false
Monitors update completion notification files in the monitored folder.
urecp-fileevent.file.auto-delete={true|false} ~ <<true>>
Specify whether to automatically delete acquisition target files when a response from a business process is normal.
This property is valid only when the monitoring target is the common folder.
-
true
Deletes acquisition target files.
-
false
Does not delete acquisition target files.
(5) Example of coding
An example of coding of the file-event-reception definition file is as follows.
urecp-fileevent.thread-pool.minimum=1 urecp-fileevent.thread-pool.maximum=32 urecp-fileevent.sub-folder=folder1 urecp-fileevent.common-folder.definition-name=common urecp-fileevent.monitored-file-name.regex=file[0-9]*\.txt urecp-fileevent.monitored.common-folder=false