200 |
|
|
application/json
model |
example
{
"title": "job",
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sos.joc.model.wizard.Job",
"type": "object",
"required": [
"docPath",
"assignReference"
],
"properties": {
"deliveryDate": {
"description": "Value is UTC timestamp in ISO 8601 YYYY-MM-DDThh:mm:ss.sZ or empty",
"type": "string",
"format": "date-time"
},
"docPath": {
"description": "absolute path of an object.",
"type": "string",
"pattern": "^(/|(/[^/\\\\<>?:\"|*]+)+)$",
"maxLength": 255,
"minLength": 1
},
"docName": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"assignReference": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"title": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"javaClass": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"params": {
"type": "array",
"items": {
"type": "object",
"javaType": "com.sos.joc.model.wizard.Param",
"properties": {
"name": {
"type": "string",
"pattern": "^[^<>]*$",
"maxLength": 255
},
"required": {
"type": "boolean"
},
"defaultValue": {
"type": "string"
},
"description": {
"description": "string in html format",
"type": "string"
}
}
}
}
}
}
{ "assignReference": "RenameFileJob", "deliveryDate": "2021-08-13T01:10:07.203Z", "docName": "RenameFileJob.xml", "docPath": "/sos/jitl-jobs/RenameFileJob.xml", "javaClass": "com.sos.jitl.jobs.file.RenameFileJob", "params": [{ "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">File or Folder to be monitored</p>\r\n \r\n<p>Monitored file or directory.</p>\r\n \r\n</div>\r\n\r\n <div class=\"note\">\r\n \r\n<p>\r\n Supports masks for substitution in the file name\r\n and directory\r\n name with format strings that are\r\n enclosed by brackets\r\n ([\r\n and\r\n ]).\r\n The following format strings are supported:\r\n </p>\r\n\r\n \r\n<p>\r\n \r\n<code>\r\n [date:date format]\r\n </code>\r\n \r\n</p>\r\n \r\n<p>\r\n \r\n date format\r\n must be a valid Java data format string,\r\n e.g.\r\n yyyyMMddHHmmss\r\n ,\r\n yyyy-MM-dd.HHmmss\r\n etc.\r\n </p>\r\n \r\n<p>\r\n For further information on valid values for a dateformat string see\r\n <a href=\"http://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html\">SimpleDateFormat</a>\r\n \r\n</p>\r\n \r\n \r\n<p>\r\n An example:\r\n </p>\r\n \r\n<p>\r\n \r\n<code>\r\n <param name=\"file\"\r\n value=\"sample/hello[date:yyyyMMdd].txt\"\r\n /> </code>\r\n \r\n</p>\r\n \r\n<p>\r\n On 2050-12-31 the parameter\r\n <code>file</code>\r\n contains the value\r\n <code>\"sample/hello20501231.txt\"</code>\r\n .\r\n </p>\r\n \r\n</div></div>", "name": "source_file", "required": true }, { "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Target-file or -folder</p>\r\n\t\t \r\n<p>Target file or directory</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf the\r\n\t\t\t<i><code>target_file</code></i>\r\n\t\t\tis not specified, then the directory path of\r\n\t\t\t<i><code>source_file</code></i>\r\n\t\t\tis used as target.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n <div class=\"note\">\r\n \r\n<p>\r\n Supports masks for substitution in the file name\r\n and directory\r\n name with format strings that are\r\n enclosed by brackets\r\n ([\r\n and\r\n ]).\r\n The following format strings are supported:\r\n </p>\r\n\r\n \r\n<p>\r\n \r\n<code>\r\n [date:date format]\r\n </code>\r\n \r\n</p>\r\n \r\n<p>\r\n \r\n date format\r\n must be a valid Java data format string,\r\n e.g.\r\n yyyyMMddHHmmss\r\n ,\r\n yyyy-MM-dd.HHmmss\r\n etc.\r\n </p>\r\n \r\n<p>\r\n For further information on valid values for a dateformat string see\r\n <a href=\"http://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html\">SimpleDateFormat</a>\r\n \r\n</p>\r\n \r\n \r\n<p>\r\n An example:\r\n </p>\r\n \r\n<p>\r\n \r\n<code>\r\n <param name=\"file\"\r\n value=\"sample/hello[date:yyyyMMdd].txt\"\r\n /> </code>\r\n \r\n</p>\r\n \r\n<p>\r\n On 2050-12-31 the parameter\r\n <code>file</code>\r\n contains the value\r\n <code>\"sample/hello20501231.txt\"</code>\r\n .\r\n </p>\r\n \r\n</div></div>", "name": "target_file", "required": true }, { "defaultValue": ".*", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Regular Expression for filename filtering</p>\r\n\t\t \r\n<p>\r\n\t\t\tRegular Expression for file filtering.\r\n\t\t\tThe behaviour is CASE_INSENSITIVE.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tOnly effective if the parameter\r\n\t\t\t<i><code>source_file</code></i>\r\n\t\t\tis a directory.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n\t <div class=\"note\">\r\n\t\t \r\n<p>\r\n\t\tSome remarks on regular expression, used in JobScheduler and YADE.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tA regular expression is not a\r\n\t\t\t<a href=\"http://en.wikipedia.org/wiki/Wildcard_character#Files_and_directories\">wildcard</a>.\r\n\t\t\tTo get an impression of the differences one have a look on the meaning of the wildcard *.txt, which will\r\n\t\t\tselect all filenames with the filename-extension \".txt\".\r\n\t\t\tA regular expression to match, e.g. works the same way, this \"wildcard\" must look like \"^.*\\.txt$\".\r\n\t\t\tThat looks a little bit strange but it is much more flexible and powerfull on filtering filenames\r\n\t\t\tthan the concept of wildcards, if one want to filter more complex names or pattern.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t The general syntax of an\r\n\t <a href=\"http://en.wikipedia.org/wiki/Regular_expression\">regular expression</a>, also referred to as regex or regexp,\r\n\t is described\r\n\t <a href=\"http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap09.html\">\r\n\t here</a>.\r\n\t It is different to other RegExp definitions, e.g. as for Perl.\r\n\t\t</p>\r\n\t \r\n<p>\r\n\t \tFor further information on regular expressions see\r\n\t <a href=\"http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html\">java.util.regex.Pattern</a>\r\n\t \r\n</p>\r\n\t \r\n<p>\r\n\t \tAs an extension of regular expression the [date:] variable is supported. Using this feature it is possible to create a regexp, which is\r\n\t \tdepending on the date with is defined in the date-format.\r\n\t </p>\r\n\t \r\n<p>\r\n\t \tIf you want (only part of the regex) to be case sensitive , then you have the option to use\r\n\t \tthe (?-i) and [optionally] (?i) mode modifiers: (?-i)G[a-b](?i).*\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf you're dealing with Unicode characters besides ASCII, check whether or not your regex engine properly supports them.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n <div class=\"note\">\r\n \r\n<p>\r\n Examples for regular expressions used for replacing:\r\n </p>\r\n \r\n<p>\r\n \r\n<table class=\"explanation\"> \r\n \r\n<tr>\r\n \r\n<th>\r\n <code>source_file</code>\r\n </th>\r\n <th>\r\n <code>file_spec</code>\r\n </th>\r\n <th>\r\n <code>replacing</code>\r\n </th>\r\n <th>\r\n <code>replacement</code>\r\n </th>\r\n <th>Example Input</th>\r\n <th>Output</th>\r\n <th>Comment</th>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>~</td>\r\n <td>\"\"</td>\r\n <td>hallo.dat~</td>\r\n <td>hallo.dat</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>a.txt</td>\r\n <td>-</td>\r\n <td>[.]txt</td>\r\n <td>_2011-11-24.txt</td>\r\n <td>-</td>\r\n <td>a_2011-11-24.txt</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>.*</td>\r\n <td>[filename:] [date:yyyy-MM-dd].dat</td>\r\n <td>a.txt</td>\r\n <td>a.txt2011-11-24.dat</td>\r\n <td>[filename:] and [date:] will be substituted after file has\r\n been replaced\r\n </td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*[.]txt</td>\r\n <td>a.*?b</td>\r\n <td>world</td>\r\n <td>a.1.b.txt.b</td>\r\n <td>world.txt.b</td>\r\n <td>.*? : ungreedy usage of .*</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>abcdefg.txt</td>\r\n <td>-</td>\r\n <td>^(ab)cde(fg)[.]txt</td>\r\n <td>123;[date:yyyy-MM-dd]</td>\r\n <td>-</td>\r\n <td>123cde2011-11-24.txt</td>\r\n <td>; : separator between multiple replacements</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*dat$</td>\r\n <td>(ab)_c[0-9]d_(fg)</td>\r\n <td>group1;group2</td>\r\n <td>ab_c1d_fg. ab_c2d_fg.dat</td>\r\n <td>group1_c1d_group2. ab_c2d_fg.dat</td>\r\n <td>Only the first pattern match is replaced</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>^(?:aa|bb)_. {2}_([0-9]+_[0-9]+)$</td>\r\n <td>tail</td>\r\n <td>aa_QU_061205_222334</td>\r\n <td>aa_QU_tail</td>\r\n <td>(?:...) : \"?:\" specifies a non capturing group. The file will\r\n not be replaced.\r\n </td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>FILE.txt</td>\r\n <td>.*</td>\r\n <td>[filename:lowercase]_[filename:uppercase]_[filename:]</td>\r\n <td>FILE.txt</td>\r\n <td>file.txt_FILE.TXT_FILE.txt</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n</table>\r\n \r\n<table class=\"explanation\" style=\"margin-top:10px\">\r\n \r\n<tr>\r\n \r\n<th>\r\n <code>source_file</code>\r\n </th>\r\n <th>\r\n <code>target_file</code>\r\n </th>\r\n <th>\r\n <code>file_spec</code>\r\n </th>\r\n <th>\r\n <code>create_dir</code>\r\n </th>\r\n <th>\r\n <code>replacing</code>\r\n </th>\r\n <th>\r\n <code>replacement</code>\r\n </th>\r\n <th>Example input</th>\r\n <th>Output</th>\r\n <th>Comment</th>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>aaa/bbb/</td>\r\n <td>[directory:]/[date:yyyyMMdd]/</td>\r\n <td>hello.txt</td>\r\n <td>true</td>\r\n <td>[.]txt</td>\r\n <td>[date:yyyy].txt</td>\r\n <td>aaa/bbb/hello.txt</td>\r\n <td>aaa/bbb/20070316/hello2007.txt</td>\r\n <td>If the directory aaa/bbb/20070316 does not yet exist it will\r\n be created\r\n </td>\r\n \r\n</tr>\r\n \r\n</table>\r\n \r\n</p>\r\n \r\n<p>\r\n For further information see\r\n <a href=\"http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html\">java.util.regex.Pattern</a>\r\n \r\n</p>\r\n \r\n<p>\r\n For further information on date-patterns see:\r\n <a href=\"http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html\">java.util.regex.Pattern</a>\r\n \r\n</p>\r\n \r\n</div></div>", "name": "file_spec", "required": false }, { "defaultValue": "false", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Specify error message tolerance</p>\r\n\t\t \r\n<p>\r\n\t\t\tEnables or disables error messages that are caused by an empty result-set, which is the result of an operation, executed by the job.\r\n \t</p>\r\n\t \r\n</div></div>", "name": "gracious", "required": false }, { "defaultValue": "0", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Maximum age of a file</p>\r\n \r\n<p>\r\n Specifies the maximum age of a file.\r\n If a file is older, then it is deemed not to exist, it will be not included in the result-list.\r\n </p>\r\n \r\n</div>\r\n\r\n <div class=\"note\">\r\n\t \r\n<p>Valid values:</p>\r\n \t \r\n<table class=\"explanation\"> \r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<th>Value</th>\r\n\t\t\t <th>Description</th>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>0</td>\r\n\t\t\t <td>The value of the parameter has no effect and the parameter is not part of the filter.</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>seconds</td>\r\n\t\t\t <td>no of seconds.</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>hours:minutes</td>\r\n\t\t\t <td>01:15 is to read as \"1 hour and 15 minutes\".</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>hours:minutes:seconds</td>\r\n\t\t\t <td>01:15:10 is to read as \"1 hour, 15 minutes and 10 seconds\".</td>\r\n\t\t \r\n</tr>\r\n\t \r\n</table>\r\n \r\n</div></div>", "name": "max_file_age", "required": false }, { "defaultValue": "0", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">minimum age of a file</p>\r\n \r\n<p>\r\n \tSpecifies the minimum age of a files.\r\n \tIf the file(s) is newer then it is classified as non-existing, it will be not included in the result-list.\r\n </p>\r\n \t \r\n</div>\r\n\r\n \t <div class=\"note\">\r\n\t \r\n<p>Valid values:</p>\r\n \t \r\n<table class=\"explanation\"> \r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<th>Value</th>\r\n\t\t\t <th>Description</th>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>0</td>\r\n\t\t\t <td>The value of the parameter has no effect and the parameter is not part of the filter.</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>seconds</td>\r\n\t\t\t <td>no of seconds.</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>hours:minutes</td>\r\n\t\t\t <td>01:15 is to read as \"1 hour and 15 minutes\".</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>hours:minutes:seconds</td>\r\n\t\t\t <td>01:15:10 is to read as \"1 hour, 15 minutes and 10 seconds\".</td>\r\n\t\t \r\n</tr>\r\n\t \r\n</table>\r\n \r\n</div></div>", "name": "min_file_age", "required": false }, { "defaultValue": "-1", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">minimum size of one or multiple files </p>\r\n\t\t \r\n<p>\r\n\t\t\tSpecifies the minimum size of one or multiple files in bytes:\r\n\t\t\tshould the size of one of the files fall below this value, then it is not included in the result list of the operation.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n\t <div class=\"note\">\r\n\t \r\n<p>valid values for file size are</p>\r\n\t\t \r\n<table class=\"explanation\">\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<th>Value</th>\r\n\t\t\t\t <th>Description</th>\r\n\t\t\t \r\n</tr>\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<td>-1</td>\r\n\t\t\t\t <td>The value of the parameter has no effect and the parameter is not part of the filter.</td>\r\n\t\t\t \r\n</tr>\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<td>number</td>\r\n\t\t\t\t <td>a number stand for the size in byte, e.g. 40 means 40 bytes.</td>\r\n\t\t\t \r\n</tr>\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<td>numberKB</td>\r\n\t\t\t\t <td>a number with the chars \"KB\" stand for the size in kilobyte.</td>\r\n\t\t\t \r\n</tr>\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<td>numberMB</td>\r\n\t\t\t\t <td>a number with the chars \"MB\" stand for the size in megabyte.</td>\r\n\t\t\t \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>numberGB</td>\r\n <td>a number with the chars \"GB\" stand for the size in gigabyte.</td>\r\n \r\n</tr>\r\n\t\t \r\n</table>\r\n \r\n</div></div>", "name": "min_file_size", "required": false }, { "defaultValue": "0", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">number of files to remove from the top of the result-set</p>\r\n \r\n<p>\r\n The number of files are removed from the beginning of the set\r\n resulting by<i><code>sort_criteria</code></i>,<i><code>sort_order</code></i>\r\n These files are excluded from further operations.\r\n </p>\r\n \r\n<p>\r\n The result set is sorted according to the parameters:\r\n </p>\r\n \r\n<p>\r\n \r\n<ul>\r\n \r\n<li>\r\n \r\n<i><code>sort_criteria</code></i>\r\n \r\n</li>\r\n \r\n<li>\r\n \r\n<i><code>sort_order</code></i>\r\n \r\n</li>\r\n \r\n</ul>\r\n \r\n</p>\r\n \r\n</div></div>", "name": "skip_first_files", "required": false }, { "defaultValue": "0", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">number of files to remove from the top of the result-set</p>\r\n \r\n<p>\r\n The number of files are removed from the beginning of the set\r\n resulting by<i><code>sort_criteria</code></i>,<i><code>sort_order</code></i>\r\n These files are excluded from further operations.\r\n </p>\r\n \r\n<p>\r\n The result set is sorted according to the parameters:\r\n </p>\r\n \r\n<p>\r\n \r\n<ul>\r\n \r\n<li>\r\n \r\n<i><code>sort_criteria</code></i>\r\n \r\n</li>\r\n \r\n<li>\r\n \r\n<i><code>sort_order</code></i>\r\n \r\n</li>\r\n \r\n</ul>\r\n \r\n</p>\r\n \r\n</div></div>", "name": "skip_last_files", "required": false }, { "defaultValue": "false", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Return the size of resultset</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf this parameter is set true \"<code>true</code>\" the number of matches\r\n\t\t\tis returned in the order parameter \"<i><code>fileoperations_result_set_size</code></i>\".\r\n\t\t</p>\r\n\t \r\n</div></div>", "name": "count_files", "required": false }, { "defaultValue": "false", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Create folder</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf enabled the folder, which is specified as value of the parameter\r\n\t\t\t<i><code>target_file</code></i>, is checked for existence.\r\n\t\t\tIf <i><code>target_file</code></i> does not exist\r\n\t\t\t<i><code>target_file</code></i> will be created as a directory.\r\n\t\t</p>\r\n\t \r\n</div></div>", "name": "create_dir", "required": false }, { "defaultValue": "false", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Include subfolders in operation</p>\r\n \r\n<p>\r\n This parameter specifies wether files from subdirectories should be included recursively.\r\n </p>\r\n \r\n<p>\r\n Only effective if <i><code>file</code></i> is a directory.\r\n </p>\r\n \r\n<p>\r\n Regular expression matches apply to files from subdirectories\r\n as specified by the parameter <i><code>file_spec</code></i>.\r\n </p>\r\n \r\n</div></div>", "name": "recursive", "required": false }, { "defaultValue": "true", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Overwrite existing files</p>\r\n\t\t \r\n<p>\r\n\t\t\tThis parameter specifies wether existing files can be overwritten.\r\n\t\t</p>\r\n\t \r\n</div></div>", "name": "overwrite", "required": false }, { "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Regular expression for renaming Files</p>\r\n\t\t \r\n<p>\r\n\t\t\tRegular expression for filename replacement with\r\n\t\t\tthe value of the parameter <i><code>replacement</code></i>.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf the expression matches the filename then the groups found are replaced.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\ta) For replacement \"capturing groups\" are used. Only the content of the\r\n\t\t\tcapturing groups is replaced.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tReplacements are separated by a semicolon \";\". Example:\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\t \r\n<i><code>replacing</code></i> = (1)abc(12)def(.*)\r\n\t\t\t<br>\r\n\t\t\t \r\n<i><code>replacement</code></i> = A;BB;CCC\r\n\t\t\t<br>\r\n\t\t\tName of original file: 1abc12def123.txt\r\n\t\t\t<br>\r\n\t\t\tName after renaming: AabcBBdefCCC\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tb) If no \"capturing groups\" are specified then the entire match is\r\n\t\t\treplaced. Example:\r\n\t\t\t<br>\r\n\t\t\t \r\n<i><code>replacing</code></i> = Hello\r\n\t\t\t<br>\r\n\t\t\t \r\n<i><code>replacement</code></i> = 1234\r\n\t\t\t<br>\r\n\t\t\tInput file: Hello_World.txt\r\n\t\t\t<br>\r\n\t\t\tOutput file: 1234_World.txt\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tRequires the parameter <i><code>replacement</code></i> to be specified.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n\t <div class=\"note\">\r\n \r\n<p>\r\n Examples for regular expressions used for replacing:\r\n </p>\r\n \r\n<p>\r\n \r\n<table class=\"explanation\"> \r\n \r\n<tr>\r\n \r\n<th>\r\n <code>source_file</code>\r\n </th>\r\n <th>\r\n <code>file_spec</code>\r\n </th>\r\n <th>\r\n <code>replacing</code>\r\n </th>\r\n <th>\r\n <code>replacement</code>\r\n </th>\r\n <th>Example Input</th>\r\n <th>Output</th>\r\n <th>Comment</th>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>~</td>\r\n <td>\"\"</td>\r\n <td>hallo.dat~</td>\r\n <td>hallo.dat</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>a.txt</td>\r\n <td>-</td>\r\n <td>[.]txt</td>\r\n <td>_2011-11-24.txt</td>\r\n <td>-</td>\r\n <td>a_2011-11-24.txt</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>.*</td>\r\n <td>[filename:] [date:yyyy-MM-dd].dat</td>\r\n <td>a.txt</td>\r\n <td>a.txt2011-11-24.dat</td>\r\n <td>[filename:] and [date:] will be substituted after file has\r\n been replaced\r\n </td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*[.]txt</td>\r\n <td>a.*?b</td>\r\n <td>world</td>\r\n <td>a.1.b.txt.b</td>\r\n <td>world.txt.b</td>\r\n <td>.*? : ungreedy usage of .*</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>abcdefg.txt</td>\r\n <td>-</td>\r\n <td>^(ab)cde(fg)[.]txt</td>\r\n <td>123;[date:yyyy-MM-dd]</td>\r\n <td>-</td>\r\n <td>123cde2011-11-24.txt</td>\r\n <td>; : separator between multiple replacements</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*dat$</td>\r\n <td>(ab)_c[0-9]d_(fg)</td>\r\n <td>group1;group2</td>\r\n <td>ab_c1d_fg. ab_c2d_fg.dat</td>\r\n <td>group1_c1d_group2. ab_c2d_fg.dat</td>\r\n <td>Only the first pattern match is replaced</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>^(?:aa|bb)_. {2}_([0-9]+_[0-9]+)$</td>\r\n <td>tail</td>\r\n <td>aa_QU_061205_222334</td>\r\n <td>aa_QU_tail</td>\r\n <td>(?:...) : \"?:\" specifies a non capturing group. The file will\r\n not be replaced.\r\n </td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>FILE.txt</td>\r\n <td>.*</td>\r\n <td>[filename:lowercase]_[filename:uppercase]_[filename:]</td>\r\n <td>FILE.txt</td>\r\n <td>file.txt_FILE.TXT_FILE.txt</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n</table>\r\n \r\n<table class=\"explanation\" style=\"margin-top:10px\">\r\n \r\n<tr>\r\n \r\n<th>\r\n <code>source_file</code>\r\n </th>\r\n <th>\r\n <code>target_file</code>\r\n </th>\r\n <th>\r\n <code>file_spec</code>\r\n </th>\r\n <th>\r\n <code>create_dir</code>\r\n </th>\r\n <th>\r\n <code>replacing</code>\r\n </th>\r\n <th>\r\n <code>replacement</code>\r\n </th>\r\n <th>Example input</th>\r\n <th>Output</th>\r\n <th>Comment</th>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>aaa/bbb/</td>\r\n <td>[directory:]/[date:yyyyMMdd]/</td>\r\n <td>hello.txt</td>\r\n <td>true</td>\r\n <td>[.]txt</td>\r\n <td>[date:yyyy].txt</td>\r\n <td>aaa/bbb/hello.txt</td>\r\n <td>aaa/bbb/20070316/hello2007.txt</td>\r\n <td>If the directory aaa/bbb/20070316 does not yet exist it will\r\n be created\r\n </td>\r\n \r\n</tr>\r\n \r\n</table>\r\n \r\n</p>\r\n \r\n<p>\r\n For further information see\r\n <a href=\"http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html\">java.util.regex.Pattern</a>\r\n \r\n</p>\r\n \r\n<p>\r\n For further information on date-patterns see:\r\n <a href=\"http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html\">java.util.regex.Pattern</a>\r\n \r\n</p>\r\n \r\n</div></div>", "name": "replacing", "required": false }, { "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">String for renaming Filenames </p>\r\n \r\n<p>\r\n String for replacement of matching character sequences within file names that are specified with the\r\n value of the parameter <i><code>replacing</code></i>.\r\n </p>\r\n \r\n<p>\r\n If multiple \"capturing groups\" are to be replaced then one replacement string per group has to be specified. \r\n These strings are separated by a semicolon \";\":\r\n </p>\r\n \r\n<p>\r\n replacement: aa;[filename:];bb\r\n </p>\r\n \r\n<p>\r\n Supports masks for substitution in the file name with format strings that are enclosed with\r\n <em>[</em>\r\n and\r\n <em>]</em>\r\n .\r\n The following format strings are supported:\r\n </p>\r\n\t\t\t \r\n<list type=\"unordered\">\r\n \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\t \r\n<code>\r\n\t\t\t\t\t\t\t[date:\r\n\t\t\t\t\t\t\t<em>date format</em>\r\n\t\t\t\t\t\t\t]\r\n\t\t\t\t\t\t</code>\r\n\t\t\t\t\t \r\n</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\t \r\n<em>date format</em>\r\n\t\t\t\t\t\tmust be a valid Java data format string, e.g.\r\n\t\t\t\t\t\t<br>\r\n\t\t\t\t\t\t \r\n<em>yyyyMMddHHmmss</em>\r\n\t\t\t\t\t\t,\r\n\t\t\t\t\t\t<em>yyyy-MM-dd.HHmmss</em>\r\n\t\t\t\t\t\tetc.\r\n\t </p>\r\n \r\n</item>\r\n\t\t\t \r\n</list>\r\n\t\t\t \r\n<list type=\"unordered\">\r\n \r\n<item>\r\n \t \r\n<p>\r\n \r\n<code>[filename:]</code>\r\n \t\t\t\t\t \r\n</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tWill be substituted by the original file name including the file extension.\r\n\t </p>\r\n \r\n</item>\r\n\t\t\t \r\n</list>\r\n\t\t\t \r\n<list type=\"def\">\r\n \r\n<item>\r\n\t \r\n<p>\r\n \r\n<code>[filename:lowercase]</code>\r\n\t\t\t\t\t \r\n</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tWill be substituted by the original file name including the file extension \r\n\t\t\t\t\t\twith all characters converted to lower case.\r\n\t </p>\r\n \r\n</item>\r\n\t\t\t \r\n</list>\r\n\t\t\t \r\n<list type=\"def\">\r\n \r\n<item>\r\n\t \r\n<p>\r\n \r\n<code>[filename:uppercase]</code>\r\n\t\t\t\t\t \r\n</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tWill be substituted by the original file name including the file extension \r\n\t\t\t\t\t\twith all characters converted to upper case.\r\n\t </p>\r\n \r\n</item>\r\n\t\t\t \r\n</list>\r\n \r\n<p>\r\n Requires the parameter\r\n <i><code>replacing</code></i>\r\n to be specified.\r\n </p>\r\n \r\n<p>\r\n\t\t\t \r\n<list type=\"unordered\">\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\t \r\n<i><code>replacing</code></i>\r\n\t\t\t\t\t\t= Hello\r\n\t\t\t\t\t</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\t \r\n<i><code>replacement</code></i>\r\n\t\t\t\t\t\t= 1234\r\n\t\t\t\t\t</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tInput file: Hello_World.txt\r\n\t\t\t\t\t</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tOutput file: 1234_World.txt\r\n\t\t\t\t\t</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t \r\n</list>\r\n\t\t \r\n</p>\r\n\t \r\n</div></div>", "name": "replacement", "required": false }, { "defaultValue": "asc", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Sort order with which the result set will be sorted.</p>\r\n \r\n<p>\r\n Default: asc\r\n Possible values: asc | desc \r\n See: <i><code>sort_criteria</code></i>\r\n \r\n</p>\r\n \r\n</div></div>", "name": "sort_order", "required": false }, { "defaultValue": "name", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Sort criteria with which the result set will be sorted.</p>\r\n \r\n<p>\r\n Default: name\r\n Possible values: name | age | size\r\n See: <i><code>sort_order</code></i>\r\n \r\n</p>\r\n \r\n</div></div>", "name": "sort_criteria", "required": false }, { "defaultValue": "0", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">number of expected hits in result-list</p>\r\n\t \r\n</div></div>", "name": "expected_size_of_result_set", "required": false }, { "defaultValue": "", "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">raise error on expected size of result-set</p>\r\n\t\t \r\n<p>\r\n\t\t\tWith this parameter it is possible to raise an error if the quantity of hits of the\r\n\t\t\tresult-list is according to the value of this parameter.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tAn example:\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tAssuming, that the parameter \"raise_error_if_result_set_is=ne\" is defined and the parameter\r\n\t\t\t\"expected_size_of_result_set=1\" is specified as well. If the number of hits is not equal to \"1\"\r\n\t\t\tan error will raised.\r\n\t\t</p>\r\n\t \r\n</div></div>", "name": "raise_error_if_result_set_is", "required": false }, { "description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Name of the result-list file</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf the value of this parameter specifies a valid filename the result-list will be\r\n\t\t\twritten to this file.\r\n\t\t</p>\r\n\t \r\n</div></div>", "name": "result_set_file", "required": false }], "title": "Rename one or more files" }
{
"assignReference": "RenameFileJob",
"deliveryDate": "2021-08-13T01:10:07.203Z",
"docName": "RenameFileJob.xml",
"docPath": "/sos/jitl-jobs/RenameFileJob.xml",
"javaClass": "com.sos.jitl.jobs.file.RenameFileJob",
"params": [{
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">File or Folder to be monitored</p>\r\n \r\n<p>Monitored file or directory.</p>\r\n \r\n</div>\r\n\r\n <div class=\"note\">\r\n \r\n<p>\r\n Supports masks for substitution in the file name\r\n and directory\r\n name with format strings that are\r\n enclosed by brackets\r\n ([\r\n and\r\n ]).\r\n The following format strings are supported:\r\n </p>\r\n\r\n \r\n<p>\r\n \r\n<code>\r\n [date:date format]\r\n </code>\r\n \r\n</p>\r\n \r\n<p>\r\n \r\n date format\r\n must be a valid Java data format string,\r\n e.g.\r\n yyyyMMddHHmmss\r\n ,\r\n yyyy-MM-dd.HHmmss\r\n etc.\r\n </p>\r\n \r\n<p>\r\n For further information on valid values for a dateformat string see\r\n <a href=\"http://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html\">SimpleDateFormat</a>\r\n \r\n</p>\r\n \r\n \r\n<p>\r\n An example:\r\n </p>\r\n \r\n<p>\r\n \r\n<code>\r\n <param name=\"file\"\r\n value=\"sample/hello[date:yyyyMMdd].txt\"\r\n /> </code>\r\n \r\n</p>\r\n \r\n<p>\r\n On 2050-12-31 the parameter\r\n <code>file</code>\r\n contains the value\r\n <code>\"sample/hello20501231.txt\"</code>\r\n .\r\n </p>\r\n \r\n</div></div>",
"name": "source_file",
"required": true
}, {
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Target-file or -folder</p>\r\n\t\t \r\n<p>Target file or directory</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf the\r\n\t\t\t<i><code>target_file</code></i>\r\n\t\t\tis not specified, then the directory path of\r\n\t\t\t<i><code>source_file</code></i>\r\n\t\t\tis used as target.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n <div class=\"note\">\r\n \r\n<p>\r\n Supports masks for substitution in the file name\r\n and directory\r\n name with format strings that are\r\n enclosed by brackets\r\n ([\r\n and\r\n ]).\r\n The following format strings are supported:\r\n </p>\r\n\r\n \r\n<p>\r\n \r\n<code>\r\n [date:date format]\r\n </code>\r\n \r\n</p>\r\n \r\n<p>\r\n \r\n date format\r\n must be a valid Java data format string,\r\n e.g.\r\n yyyyMMddHHmmss\r\n ,\r\n yyyy-MM-dd.HHmmss\r\n etc.\r\n </p>\r\n \r\n<p>\r\n For further information on valid values for a dateformat string see\r\n <a href=\"http://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html\">SimpleDateFormat</a>\r\n \r\n</p>\r\n \r\n \r\n<p>\r\n An example:\r\n </p>\r\n \r\n<p>\r\n \r\n<code>\r\n <param name=\"file\"\r\n value=\"sample/hello[date:yyyyMMdd].txt\"\r\n /> </code>\r\n \r\n</p>\r\n \r\n<p>\r\n On 2050-12-31 the parameter\r\n <code>file</code>\r\n contains the value\r\n <code>\"sample/hello20501231.txt\"</code>\r\n .\r\n </p>\r\n \r\n</div></div>",
"name": "target_file",
"required": true
}, {
"defaultValue": ".*",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Regular Expression for filename filtering</p>\r\n\t\t \r\n<p>\r\n\t\t\tRegular Expression for file filtering.\r\n\t\t\tThe behaviour is CASE_INSENSITIVE.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tOnly effective if the parameter\r\n\t\t\t<i><code>source_file</code></i>\r\n\t\t\tis a directory.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n\t <div class=\"note\">\r\n\t\t \r\n<p>\r\n\t\tSome remarks on regular expression, used in JobScheduler and YADE.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tA regular expression is not a\r\n\t\t\t<a href=\"http://en.wikipedia.org/wiki/Wildcard_character#Files_and_directories\">wildcard</a>.\r\n\t\t\tTo get an impression of the differences one have a look on the meaning of the wildcard *.txt, which will\r\n\t\t\tselect all filenames with the filename-extension \".txt\".\r\n\t\t\tA regular expression to match, e.g. works the same way, this \"wildcard\" must look like \"^.*\\.txt$\".\r\n\t\t\tThat looks a little bit strange but it is much more flexible and powerfull on filtering filenames\r\n\t\t\tthan the concept of wildcards, if one want to filter more complex names or pattern.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t The general syntax of an\r\n\t <a href=\"http://en.wikipedia.org/wiki/Regular_expression\">regular expression</a>, also referred to as regex or regexp,\r\n\t is described\r\n\t <a href=\"http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap09.html\">\r\n\t here</a>.\r\n\t It is different to other RegExp definitions, e.g. as for Perl.\r\n\t\t</p>\r\n\t \r\n<p>\r\n\t \tFor further information on regular expressions see\r\n\t <a href=\"http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html\">java.util.regex.Pattern</a>\r\n\t \r\n</p>\r\n\t \r\n<p>\r\n\t \tAs an extension of regular expression the [date:] variable is supported. Using this feature it is possible to create a regexp, which is\r\n\t \tdepending on the date with is defined in the date-format.\r\n\t </p>\r\n\t \r\n<p>\r\n\t \tIf you want (only part of the regex) to be case sensitive , then you have the option to use\r\n\t \tthe (?-i) and [optionally] (?i) mode modifiers: (?-i)G[a-b](?i).*\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf you're dealing with Unicode characters besides ASCII, check whether or not your regex engine properly supports them.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n <div class=\"note\">\r\n \r\n<p>\r\n Examples for regular expressions used for replacing:\r\n </p>\r\n \r\n<p>\r\n \r\n<table class=\"explanation\"> \r\n \r\n<tr>\r\n \r\n<th>\r\n <code>source_file</code>\r\n </th>\r\n <th>\r\n <code>file_spec</code>\r\n </th>\r\n <th>\r\n <code>replacing</code>\r\n </th>\r\n <th>\r\n <code>replacement</code>\r\n </th>\r\n <th>Example Input</th>\r\n <th>Output</th>\r\n <th>Comment</th>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>~</td>\r\n <td>\"\"</td>\r\n <td>hallo.dat~</td>\r\n <td>hallo.dat</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>a.txt</td>\r\n <td>-</td>\r\n <td>[.]txt</td>\r\n <td>_2011-11-24.txt</td>\r\n <td>-</td>\r\n <td>a_2011-11-24.txt</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>.*</td>\r\n <td>[filename:] [date:yyyy-MM-dd].dat</td>\r\n <td>a.txt</td>\r\n <td>a.txt2011-11-24.dat</td>\r\n <td>[filename:] and [date:] will be substituted after file has\r\n been replaced\r\n </td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*[.]txt</td>\r\n <td>a.*?b</td>\r\n <td>world</td>\r\n <td>a.1.b.txt.b</td>\r\n <td>world.txt.b</td>\r\n <td>.*? : ungreedy usage of .*</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>abcdefg.txt</td>\r\n <td>-</td>\r\n <td>^(ab)cde(fg)[.]txt</td>\r\n <td>123;[date:yyyy-MM-dd]</td>\r\n <td>-</td>\r\n <td>123cde2011-11-24.txt</td>\r\n <td>; : separator between multiple replacements</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*dat$</td>\r\n <td>(ab)_c[0-9]d_(fg)</td>\r\n <td>group1;group2</td>\r\n <td>ab_c1d_fg. ab_c2d_fg.dat</td>\r\n <td>group1_c1d_group2. ab_c2d_fg.dat</td>\r\n <td>Only the first pattern match is replaced</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>^(?:aa|bb)_. {2}_([0-9]+_[0-9]+)$</td>\r\n <td>tail</td>\r\n <td>aa_QU_061205_222334</td>\r\n <td>aa_QU_tail</td>\r\n <td>(?:...) : \"?:\" specifies a non capturing group. The file will\r\n not be replaced.\r\n </td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>FILE.txt</td>\r\n <td>.*</td>\r\n <td>[filename:lowercase]_[filename:uppercase]_[filename:]</td>\r\n <td>FILE.txt</td>\r\n <td>file.txt_FILE.TXT_FILE.txt</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n</table>\r\n \r\n<table class=\"explanation\" style=\"margin-top:10px\">\r\n \r\n<tr>\r\n \r\n<th>\r\n <code>source_file</code>\r\n </th>\r\n <th>\r\n <code>target_file</code>\r\n </th>\r\n <th>\r\n <code>file_spec</code>\r\n </th>\r\n <th>\r\n <code>create_dir</code>\r\n </th>\r\n <th>\r\n <code>replacing</code>\r\n </th>\r\n <th>\r\n <code>replacement</code>\r\n </th>\r\n <th>Example input</th>\r\n <th>Output</th>\r\n <th>Comment</th>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>aaa/bbb/</td>\r\n <td>[directory:]/[date:yyyyMMdd]/</td>\r\n <td>hello.txt</td>\r\n <td>true</td>\r\n <td>[.]txt</td>\r\n <td>[date:yyyy].txt</td>\r\n <td>aaa/bbb/hello.txt</td>\r\n <td>aaa/bbb/20070316/hello2007.txt</td>\r\n <td>If the directory aaa/bbb/20070316 does not yet exist it will\r\n be created\r\n </td>\r\n \r\n</tr>\r\n \r\n</table>\r\n \r\n</p>\r\n \r\n<p>\r\n For further information see\r\n <a href=\"http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html\">java.util.regex.Pattern</a>\r\n \r\n</p>\r\n \r\n<p>\r\n For further information on date-patterns see:\r\n <a href=\"http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html\">java.util.regex.Pattern</a>\r\n \r\n</p>\r\n \r\n</div></div>",
"name": "file_spec",
"required": false
}, {
"defaultValue": "false",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Specify error message tolerance</p>\r\n\t\t \r\n<p>\r\n\t\t\tEnables or disables error messages that are caused by an empty result-set, which is the result of an operation, executed by the job.\r\n \t</p>\r\n\t \r\n</div></div>",
"name": "gracious",
"required": false
}, {
"defaultValue": "0",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Maximum age of a file</p>\r\n \r\n<p>\r\n Specifies the maximum age of a file.\r\n If a file is older, then it is deemed not to exist, it will be not included in the result-list.\r\n </p>\r\n \r\n</div>\r\n\r\n <div class=\"note\">\r\n\t \r\n<p>Valid values:</p>\r\n \t \r\n<table class=\"explanation\"> \r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<th>Value</th>\r\n\t\t\t <th>Description</th>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>0</td>\r\n\t\t\t <td>The value of the parameter has no effect and the parameter is not part of the filter.</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>seconds</td>\r\n\t\t\t <td>no of seconds.</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>hours:minutes</td>\r\n\t\t\t <td>01:15 is to read as \"1 hour and 15 minutes\".</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>hours:minutes:seconds</td>\r\n\t\t\t <td>01:15:10 is to read as \"1 hour, 15 minutes and 10 seconds\".</td>\r\n\t\t \r\n</tr>\r\n\t \r\n</table>\r\n \r\n</div></div>",
"name": "max_file_age",
"required": false
}, {
"defaultValue": "0",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">minimum age of a file</p>\r\n \r\n<p>\r\n \tSpecifies the minimum age of a files.\r\n \tIf the file(s) is newer then it is classified as non-existing, it will be not included in the result-list.\r\n </p>\r\n \t \r\n</div>\r\n\r\n \t <div class=\"note\">\r\n\t \r\n<p>Valid values:</p>\r\n \t \r\n<table class=\"explanation\"> \r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<th>Value</th>\r\n\t\t\t <th>Description</th>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>0</td>\r\n\t\t\t <td>The value of the parameter has no effect and the parameter is not part of the filter.</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>seconds</td>\r\n\t\t\t <td>no of seconds.</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>hours:minutes</td>\r\n\t\t\t <td>01:15 is to read as \"1 hour and 15 minutes\".</td>\r\n\t\t \r\n</tr>\r\n\t\t \r\n<tr>\r\n\t\t\t \r\n<td>hours:minutes:seconds</td>\r\n\t\t\t <td>01:15:10 is to read as \"1 hour, 15 minutes and 10 seconds\".</td>\r\n\t\t \r\n</tr>\r\n\t \r\n</table>\r\n \r\n</div></div>",
"name": "min_file_age",
"required": false
}, {
"defaultValue": "-1",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">minimum size of one or multiple files </p>\r\n\t\t \r\n<p>\r\n\t\t\tSpecifies the minimum size of one or multiple files in bytes:\r\n\t\t\tshould the size of one of the files fall below this value, then it is not included in the result list of the operation.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n\t <div class=\"note\">\r\n\t \r\n<p>valid values for file size are</p>\r\n\t\t \r\n<table class=\"explanation\">\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<th>Value</th>\r\n\t\t\t\t <th>Description</th>\r\n\t\t\t \r\n</tr>\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<td>-1</td>\r\n\t\t\t\t <td>The value of the parameter has no effect and the parameter is not part of the filter.</td>\r\n\t\t\t \r\n</tr>\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<td>number</td>\r\n\t\t\t\t <td>a number stand for the size in byte, e.g. 40 means 40 bytes.</td>\r\n\t\t\t \r\n</tr>\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<td>numberKB</td>\r\n\t\t\t\t <td>a number with the chars \"KB\" stand for the size in kilobyte.</td>\r\n\t\t\t \r\n</tr>\r\n\t\t\t \r\n<tr>\r\n\t\t\t\t \r\n<td>numberMB</td>\r\n\t\t\t\t <td>a number with the chars \"MB\" stand for the size in megabyte.</td>\r\n\t\t\t \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>numberGB</td>\r\n <td>a number with the chars \"GB\" stand for the size in gigabyte.</td>\r\n \r\n</tr>\r\n\t\t \r\n</table>\r\n \r\n</div></div>",
"name": "min_file_size",
"required": false
}, {
"defaultValue": "0",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">number of files to remove from the top of the result-set</p>\r\n \r\n<p>\r\n The number of files are removed from the beginning of the set\r\n resulting by<i><code>sort_criteria</code></i>,<i><code>sort_order</code></i>\r\n These files are excluded from further operations.\r\n </p>\r\n \r\n<p>\r\n The result set is sorted according to the parameters:\r\n </p>\r\n \r\n<p>\r\n \r\n<ul>\r\n \r\n<li>\r\n \r\n<i><code>sort_criteria</code></i>\r\n \r\n</li>\r\n \r\n<li>\r\n \r\n<i><code>sort_order</code></i>\r\n \r\n</li>\r\n \r\n</ul>\r\n \r\n</p>\r\n \r\n</div></div>",
"name": "skip_first_files",
"required": false
}, {
"defaultValue": "0",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">number of files to remove from the top of the result-set</p>\r\n \r\n<p>\r\n The number of files are removed from the beginning of the set\r\n resulting by<i><code>sort_criteria</code></i>,<i><code>sort_order</code></i>\r\n These files are excluded from further operations.\r\n </p>\r\n \r\n<p>\r\n The result set is sorted according to the parameters:\r\n </p>\r\n \r\n<p>\r\n \r\n<ul>\r\n \r\n<li>\r\n \r\n<i><code>sort_criteria</code></i>\r\n \r\n</li>\r\n \r\n<li>\r\n \r\n<i><code>sort_order</code></i>\r\n \r\n</li>\r\n \r\n</ul>\r\n \r\n</p>\r\n \r\n</div></div>",
"name": "skip_last_files",
"required": false
}, {
"defaultValue": "false",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Return the size of resultset</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf this parameter is set true \"<code>true</code>\" the number of matches\r\n\t\t\tis returned in the order parameter \"<i><code>fileoperations_result_set_size</code></i>\".\r\n\t\t</p>\r\n\t \r\n</div></div>",
"name": "count_files",
"required": false
}, {
"defaultValue": "false",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Create folder</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf enabled the folder, which is specified as value of the parameter\r\n\t\t\t<i><code>target_file</code></i>, is checked for existence.\r\n\t\t\tIf <i><code>target_file</code></i> does not exist\r\n\t\t\t<i><code>target_file</code></i> will be created as a directory.\r\n\t\t</p>\r\n\t \r\n</div></div>",
"name": "create_dir",
"required": false
}, {
"defaultValue": "false",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Include subfolders in operation</p>\r\n \r\n<p>\r\n This parameter specifies wether files from subdirectories should be included recursively.\r\n </p>\r\n \r\n<p>\r\n Only effective if <i><code>file</code></i> is a directory.\r\n </p>\r\n \r\n<p>\r\n Regular expression matches apply to files from subdirectories\r\n as specified by the parameter <i><code>file_spec</code></i>.\r\n </p>\r\n \r\n</div></div>",
"name": "recursive",
"required": false
}, {
"defaultValue": "true",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Overwrite existing files</p>\r\n\t\t \r\n<p>\r\n\t\t\tThis parameter specifies wether existing files can be overwritten.\r\n\t\t</p>\r\n\t \r\n</div></div>",
"name": "overwrite",
"required": false
}, {
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Regular expression for renaming Files</p>\r\n\t\t \r\n<p>\r\n\t\t\tRegular expression for filename replacement with\r\n\t\t\tthe value of the parameter <i><code>replacement</code></i>.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf the expression matches the filename then the groups found are replaced.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\ta) For replacement \"capturing groups\" are used. Only the content of the\r\n\t\t\tcapturing groups is replaced.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tReplacements are separated by a semicolon \";\". Example:\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\t \r\n<i><code>replacing</code></i> = (1)abc(12)def(.*)\r\n\t\t\t<br>\r\n\t\t\t \r\n<i><code>replacement</code></i> = A;BB;CCC\r\n\t\t\t<br>\r\n\t\t\tName of original file: 1abc12def123.txt\r\n\t\t\t<br>\r\n\t\t\tName after renaming: AabcBBdefCCC\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tb) If no \"capturing groups\" are specified then the entire match is\r\n\t\t\treplaced. Example:\r\n\t\t\t<br>\r\n\t\t\t \r\n<i><code>replacing</code></i> = Hello\r\n\t\t\t<br>\r\n\t\t\t \r\n<i><code>replacement</code></i> = 1234\r\n\t\t\t<br>\r\n\t\t\tInput file: Hello_World.txt\r\n\t\t\t<br>\r\n\t\t\tOutput file: 1234_World.txt\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tRequires the parameter <i><code>replacement</code></i> to be specified.\r\n\t\t</p>\r\n\t \r\n</div>\r\n\r\n\t <div class=\"note\">\r\n \r\n<p>\r\n Examples for regular expressions used for replacing:\r\n </p>\r\n \r\n<p>\r\n \r\n<table class=\"explanation\"> \r\n \r\n<tr>\r\n \r\n<th>\r\n <code>source_file</code>\r\n </th>\r\n <th>\r\n <code>file_spec</code>\r\n </th>\r\n <th>\r\n <code>replacing</code>\r\n </th>\r\n <th>\r\n <code>replacement</code>\r\n </th>\r\n <th>Example Input</th>\r\n <th>Output</th>\r\n <th>Comment</th>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>~</td>\r\n <td>\"\"</td>\r\n <td>hallo.dat~</td>\r\n <td>hallo.dat</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>a.txt</td>\r\n <td>-</td>\r\n <td>[.]txt</td>\r\n <td>_2011-11-24.txt</td>\r\n <td>-</td>\r\n <td>a_2011-11-24.txt</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>.*</td>\r\n <td>[filename:] [date:yyyy-MM-dd].dat</td>\r\n <td>a.txt</td>\r\n <td>a.txt2011-11-24.dat</td>\r\n <td>[filename:] and [date:] will be substituted after file has\r\n been replaced\r\n </td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*[.]txt</td>\r\n <td>a.*?b</td>\r\n <td>world</td>\r\n <td>a.1.b.txt.b</td>\r\n <td>world.txt.b</td>\r\n <td>.*? : ungreedy usage of .*</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>abcdefg.txt</td>\r\n <td>-</td>\r\n <td>^(ab)cde(fg)[.]txt</td>\r\n <td>123;[date:yyyy-MM-dd]</td>\r\n <td>-</td>\r\n <td>123cde2011-11-24.txt</td>\r\n <td>; : separator between multiple replacements</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*dat$</td>\r\n <td>(ab)_c[0-9]d_(fg)</td>\r\n <td>group1;group2</td>\r\n <td>ab_c1d_fg. ab_c2d_fg.dat</td>\r\n <td>group1_c1d_group2. ab_c2d_fg.dat</td>\r\n <td>Only the first pattern match is replaced</td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>.*</td>\r\n <td>^(?:aa|bb)_. {2}_([0-9]+_[0-9]+)$</td>\r\n <td>tail</td>\r\n <td>aa_QU_061205_222334</td>\r\n <td>aa_QU_tail</td>\r\n <td>(?:...) : \"?:\" specifies a non capturing group. The file will\r\n not be replaced.\r\n </td>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>./temp</td>\r\n <td>FILE.txt</td>\r\n <td>.*</td>\r\n <td>[filename:lowercase]_[filename:uppercase]_[filename:]</td>\r\n <td>FILE.txt</td>\r\n <td>file.txt_FILE.TXT_FILE.txt</td>\r\n <td>-</td>\r\n \r\n</tr>\r\n \r\n</table>\r\n \r\n<table class=\"explanation\" style=\"margin-top:10px\">\r\n \r\n<tr>\r\n \r\n<th>\r\n <code>source_file</code>\r\n </th>\r\n <th>\r\n <code>target_file</code>\r\n </th>\r\n <th>\r\n <code>file_spec</code>\r\n </th>\r\n <th>\r\n <code>create_dir</code>\r\n </th>\r\n <th>\r\n <code>replacing</code>\r\n </th>\r\n <th>\r\n <code>replacement</code>\r\n </th>\r\n <th>Example input</th>\r\n <th>Output</th>\r\n <th>Comment</th>\r\n \r\n</tr>\r\n \r\n<tr>\r\n \r\n<td>aaa/bbb/</td>\r\n <td>[directory:]/[date:yyyyMMdd]/</td>\r\n <td>hello.txt</td>\r\n <td>true</td>\r\n <td>[.]txt</td>\r\n <td>[date:yyyy].txt</td>\r\n <td>aaa/bbb/hello.txt</td>\r\n <td>aaa/bbb/20070316/hello2007.txt</td>\r\n <td>If the directory aaa/bbb/20070316 does not yet exist it will\r\n be created\r\n </td>\r\n \r\n</tr>\r\n \r\n</table>\r\n \r\n</p>\r\n \r\n<p>\r\n For further information see\r\n <a href=\"http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html\">java.util.regex.Pattern</a>\r\n \r\n</p>\r\n \r\n<p>\r\n For further information on date-patterns see:\r\n <a href=\"http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html\">java.util.regex.Pattern</a>\r\n \r\n</p>\r\n \r\n</div></div>",
"name": "replacing",
"required": false
}, {
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">String for renaming Filenames </p>\r\n \r\n<p>\r\n String for replacement of matching character sequences within file names that are specified with the\r\n value of the parameter <i><code>replacing</code></i>.\r\n </p>\r\n \r\n<p>\r\n If multiple \"capturing groups\" are to be replaced then one replacement string per group has to be specified. \r\n These strings are separated by a semicolon \";\":\r\n </p>\r\n \r\n<p>\r\n replacement: aa;[filename:];bb\r\n </p>\r\n \r\n<p>\r\n Supports masks for substitution in the file name with format strings that are enclosed with\r\n <em>[</em>\r\n and\r\n <em>]</em>\r\n .\r\n The following format strings are supported:\r\n </p>\r\n\t\t\t \r\n<list type=\"unordered\">\r\n \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\t \r\n<code>\r\n\t\t\t\t\t\t\t[date:\r\n\t\t\t\t\t\t\t<em>date format</em>\r\n\t\t\t\t\t\t\t]\r\n\t\t\t\t\t\t</code>\r\n\t\t\t\t\t \r\n</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\t \r\n<em>date format</em>\r\n\t\t\t\t\t\tmust be a valid Java data format string, e.g.\r\n\t\t\t\t\t\t<br>\r\n\t\t\t\t\t\t \r\n<em>yyyyMMddHHmmss</em>\r\n\t\t\t\t\t\t,\r\n\t\t\t\t\t\t<em>yyyy-MM-dd.HHmmss</em>\r\n\t\t\t\t\t\tetc.\r\n\t </p>\r\n \r\n</item>\r\n\t\t\t \r\n</list>\r\n\t\t\t \r\n<list type=\"unordered\">\r\n \r\n<item>\r\n \t \r\n<p>\r\n \r\n<code>[filename:]</code>\r\n \t\t\t\t\t \r\n</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tWill be substituted by the original file name including the file extension.\r\n\t </p>\r\n \r\n</item>\r\n\t\t\t \r\n</list>\r\n\t\t\t \r\n<list type=\"def\">\r\n \r\n<item>\r\n\t \r\n<p>\r\n \r\n<code>[filename:lowercase]</code>\r\n\t\t\t\t\t \r\n</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tWill be substituted by the original file name including the file extension \r\n\t\t\t\t\t\twith all characters converted to lower case.\r\n\t </p>\r\n \r\n</item>\r\n\t\t\t \r\n</list>\r\n\t\t\t \r\n<list type=\"def\">\r\n \r\n<item>\r\n\t \r\n<p>\r\n \r\n<code>[filename:uppercase]</code>\r\n\t\t\t\t\t \r\n</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tWill be substituted by the original file name including the file extension \r\n\t\t\t\t\t\twith all characters converted to upper case.\r\n\t </p>\r\n \r\n</item>\r\n\t\t\t \r\n</list>\r\n \r\n<p>\r\n Requires the parameter\r\n <i><code>replacing</code></i>\r\n to be specified.\r\n </p>\r\n \r\n<p>\r\n\t\t\t \r\n<list type=\"unordered\">\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\t \r\n<i><code>replacing</code></i>\r\n\t\t\t\t\t\t= Hello\r\n\t\t\t\t\t</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\t \r\n<i><code>replacement</code></i>\r\n\t\t\t\t\t\t= 1234\r\n\t\t\t\t\t</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tInput file: Hello_World.txt\r\n\t\t\t\t\t</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t\t \r\n<item>\r\n\t\t\t\t\t \r\n<p>\r\n\t\t\t\t\t\tOutput file: 1234_World.txt\r\n\t\t\t\t\t</p>\r\n\t\t\t\t \r\n</item>\r\n\t\t\t \r\n</list>\r\n\t\t \r\n</p>\r\n\t \r\n</div></div>",
"name": "replacement",
"required": false
}, {
"defaultValue": "asc",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Sort order with which the result set will be sorted.</p>\r\n \r\n<p>\r\n Default: asc\r\n Possible values: asc | desc \r\n See: <i><code>sort_criteria</code></i>\r\n \r\n</p>\r\n \r\n</div></div>",
"name": "sort_order",
"required": false
}, {
"defaultValue": "name",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n \r\n<p class=\"title\">Sort criteria with which the result set will be sorted.</p>\r\n \r\n<p>\r\n Default: name\r\n Possible values: name | age | size\r\n See: <i><code>sort_order</code></i>\r\n \r\n</p>\r\n \r\n</div></div>",
"name": "sort_criteria",
"required": false
}, {
"defaultValue": "0",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">number of expected hits in result-list</p>\r\n\t \r\n</div></div>",
"name": "expected_size_of_result_set",
"required": false
}, {
"defaultValue": "",
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">raise error on expected size of result-set</p>\r\n\t\t \r\n<p>\r\n\t\t\tWith this parameter it is possible to raise an error if the quantity of hits of the\r\n\t\t\tresult-list is according to the value of this parameter.\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tAn example:\r\n\t\t</p>\r\n\t\t \r\n<p>\r\n\t\t\tAssuming, that the parameter \"raise_error_if_result_set_is=ne\" is defined and the parameter\r\n\t\t\t\"expected_size_of_result_set=1\" is specified as well. If the number of hits is not equal to \"1\"\r\n\t\t\tan error will raised.\r\n\t\t</p>\r\n\t \r\n</div></div>",
"name": "raise_error_if_result_set_is",
"required": false
}, {
"description": "<div class=\"jitl-job-param\"><div class=\"note\">\r\n\t\t \r\n<p class=\"title\">Name of the result-list file</p>\r\n\t\t \r\n<p>\r\n\t\t\tIf the value of this parameter specifies a valid filename the result-list will be\r\n\t\t\twritten to this file.\r\n\t\t</p>\r\n\t \r\n</div></div>",
"name": "result_set_file",
"required": false
}],
"title": "Rename one or more files"
}
|