SetJobTypeFromFileName
A step that is based on this step template uses a pattern-matching string to set the
workflow from a portion of the input-file name. The step can also convert an optional
overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format, which the SetJobPropsFromTextFile step uses to set job properties. This type of step cannot be added to a workflow;
it is set as the value of the Workflow initialization step, the Child workflow initialization step, or both properties of an input device.
Associated properties
- Workflow initialization step
- Child workflow initialization step
Job property defaults
None
Usage notes
- To use this step to set the workflow, set the Parent workflow pattern or Child workflow pattern property to a pattern-matching string. The pattern-matching string is a regular expression
that can be combined with the (JOB_TYPE) token. RICOH ProcessDirector tries to match the pattern-matching string to a workflow twice, first with a dollar
sign,
$
, appended to the pattern-matching string and then without one. The$
looks for a match at the end of the file name. For example:- To use the extension of the input file, use this pattern-matching string:
*.(JOB_TYPE)
The asterisk,*
, represents zero or more characters. The period,.
, is a literal period. The (JOB_TYPE) token signifies that RICOH ProcessDirector should use the characters that follow the literal period as the workflow.When you submit an input file with the name
myfile.PDF
, RICOH ProcessDirector finds the charactersPDF
at the end of the filename. If there is a workflow called PDF, the input device assigns PDF as the workflow. - To use the first 4 alphanumeric characters of the file name, use this regular expression:
[A-Za-z0-9]{4}
The pattern in square brackets,[A-Za-z0-9]
, matches any characters in the ranges A–Z, a–z, or 0–9. The number in braces,{4}
, indicates the number of characters to use. There is no (JOB_TYPE) token in this string because the entire pattern is the workflow.When you submit an input file with the name
pdf3file.pdf
, RICOH ProcessDirector tries to find a workflow that matches the first 4 alphanumeric characters of the file name. If there is a workflow called pdf3, the input device assigns pdf3 as the workflow. If there is no such workflow, RICOH ProcessDirector logs an error.
- To use the extension of the input file, use this pattern-matching string:
- To use a pattern-matching string to set the workflow, make sure that you have created and enabled a workflow that has the same name as the file extension (or whatever part of the file name you use) of the input files that the workflow processes.
- The workflow name and the file name are case-sensitive. If the file extension is
PDF
, the RICOH ProcessDirector-supplied workflow with the name PDF does not match, and RICOH ProcessDirector issues an error message. - To use this step to convert an optional overrides file submitted with a job to a file in RICOH ProcessDirectorproperty name=value format for setting job properties, set the Parent workflow parsing rules property to the name of a control file.
- Set the Convert overrides property for a hot folder input device that uses this type of step to Yes if a control file is required to convert the overrides file submitted with a job to a job properties file in RICOH ProcessDirectorproperty name=value format.
- You cannot copy or delete this step template.