| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Description of the JobSchedulerExistsFile Job - check whether a file exists
Checks for the existence of a file, a directory or for specific files inside of a directory.
...
Name | Title | Mandatory | Default | ||
|---|---|---|---|---|---|
File or Folder to watch for | true | . | |||
Regular Expression for filename filtering | false |
| |||
Specify error message tolerance | false | false | |||
Maximum age of a file | false | 0 | |||
Minimum age of a file | false | 0 | |||
Maximum size of a file | false | -1 | |||
Minimum size of one or multiple files | false | -1 | |||
Number of files to remove from the top of the result-set | false | 0 | |||
Number of files to remove from the bottom of the result-set | false | 0 | |||
Return the size of resultset | false | false | |||
Activate file-order creation | false | false | |||
Create a file-order for every file in the result-list | false | false | |||
| create_orders_for_new_files | Create a file-order for every new file in the result-list | false | false | ||
| param_name_file_path | false | --- | |||
The name of the jobchain which belongs to the order | false |
| |||
The first node to execute in a jobchain | false |
| |||
| merge_order_parameter | Merge actual order parameter into new created order | false | false | ||
Set next node on empty result set | false | empty | |||
Number of expected hits in result-list | false | 0 | |||
Raise error on expected size of result-set | false | 0 | |||
Name of the result-list file | false | empty | |||
| check_steady_state_of_files | Check the completeness of a file (steady state) | false | false | ||
| steady_state_count | Maximum Number of Checkpoints | false | 30 | ||
| check_steady_state_interval | Temporal distance between checkpoints | false | 1 |
Parameter file: File or Folder to watch for
...
For example, the setting "gracious=all" will suppress all errors regarding an empty result-set and will terminate a Job (standalone and inside a jobchain) as it would be without errors.
Data-Type : SOSOptionGracious
The default value for this parameter is false.
Parameter max_file_age:
...
Maximum age of a file
...
maximum age of a file
Specifies the maximum age of a file. If a file is older, then it is deemed not to exist, it will be not included in the result list.
Data-Type : SOSOptionTime
The default value for this parameter is 0.
Parameter min_file_age:
...
Minimum age of a file
...
minimum age of a file
Specifies the minimum age of a files. If the file(s) is newer then it is classified as non-existing, it will be not included in the result list.
Data-Type : SOSOptionTime
The default value for this parameter is 0.
Parameter max_file_size:
...
Maximum size of a file
...
maximum size of a file
Specifies the maximum size of a file in bytes: should the size of one of the files exceed this value, then it is classified as non-existing.
valid values for file size are
...
Data-Type : SOSOptionFileSize
The default value for this parameter is -1.
Parameter min_file_size:
...
Minimum size of one or multiple files
...
minimum size of one or multiple files
Specifies the minimum size of one or multiple files in bytes: should the size of one of the files fall below this value, then it is not included in the result list of the operation.
valid values for file size are
...
Data-Type : SOSOptionFileSize
The default value for this parameter is -1.
Parameter skip_first_files:
...
Number of files to remove from the top of the result-set
...
number of files to remove from the top of the result-set
The number of files are removed from the beginning of the set resulting by min_file_size , min_file_age etc. These files are excluded from further operations.
The result set is sorted according to the used filter parameters:
...
Only either skip_first_files or skip_last_files is allowed to be set at the same time.
Data-Type : SOSOptionInteger
The default value for this parameter is 0.
Parameter skip_last_files:
...
Number of files to remove from the bottom of the result-set
...
number Number of files to remove from the bottom of the result-set
...
merge actual order parameter into new created order
This parameter specifies , that the order, which has to be created, will be extended by the parameters of the actual order.
...
Set next node on empty result set
The next Node (Step, Job) to execute in a JobChain can be set with this parameter. The value of the parameter is a (valid) node-name of the current JobChain. In case of an empty result-set, e.g. due to non existent files, the current job will end without an errors and the JobChain will continue with the name of the node which is given as the value of this parameter.
Data-Type : SOSOptionJobChainNode
The default value for this parameter is empty.
Parameter expected_size_of_result_set:
...
Number of expected hits in result list
...
number Number of expected hits in result-list
Data-Type : SOSOptionInteger
The default value for this parameter is 0.
Use together with parameter:
raise_error_if_result_set_is - raise error on expected size of result-set
Parameter raise_error_if_result_set_is:
...
Raise error on expected size of result set
...
raise Raise error on expected size of result-set
With this parameter it is possible to raise an error if the quantity of hits of the result list is according to the value of this parameter.
An example:
Assuming, that the parameter "raise_error_if_result_set_is=ne" is defined and the parameter "expected_size_of_result_set=1" is specified as well. If the number of hits is not equal to "1" an error will raised.
...
Name | Title | Mandatory | Default |
|---|---|---|---|
File to process for a file-order | false | empty | |
Pathname of the file to process for a file-order | false | empty | |
Name of the file to process for a file-order | false | empty | |
The result of the operation as a list of items | false | empty | |
The amount of hits in the result set of the operation | false | empty | |
Return the size of the result set after a file operation | false | 0 |
Parameter scheduler_file_path:
...
File to process for a file-order
...
file to process for a file-order
Using Directory Monitoring with File Orders the job parameter scheduler_file_path contains automatically the path of the file that triggered the order.
Data-Type : SOSOptionFileName
The default value for this parameter is empty.
Parameter scheduler_file_parent:
...
Pathanme of the file to process for a file-order
...
pathanme Pathanme of the file to process for a file-order
...