SetJobPropsFromTextFile

A step that is based on this step template uses a text file that accompanies the input file to set job properties. The text file specifies which properties to set.

Job property defaults

  • Custom 1:
  • Custom 2:
  • Custom 3:
  • Custom 4:
  • Custom 5:
  • Custom 6:
  • Custom 7:
  • Custom 8:
  • Custom 9:
  • Custom 10:
  • Customer name:
  • Input data stream: Unknown
  • Job description:
  • Job location: Not set
  • Job name:
  • Job priority:
  • Stop when entering phase: Not set
  • Test job: Not set

Usage notes

  • The text file that accompanies the input file contains one property and value pair on each line in the format: property=value
  • The property values specified in the text file override the property values that are set by the steps in the workflow.
  • The step tries to find a jobID.overrides.text file first. If it finds that file, it sets values for the properties listed. Then, the step looks for a Job Definition Format (JDF) job ticket file, jobID.overrides.jdf, and uses it to set additional properties of the job. Both files are optional.
  • If you plan to use this type of step in a workflow, the input device that assigns this workflow to input files that it receives must be configured correctly. Set the values of these input device properties as indicated:
    Override patterns
    Type the name of the text file with the default extension or create a pattern-matching string that lets RICOH ProcessDirector identify the text file that contains the properties.
    JDF patterns
    Type the name of the JDF file with the default extension or create a pattern-matching string that lets RICOH ProcessDirector identify the JDF text file that contains the properties.
    Batching method
    Set this property to:
    • Batch if you want to manually group the input file and text file from the list of files displayed by the Show Files action for the input device.
    • JDF if a Job Definition Format (JDF) job ticket is used to supply the additional properties.
    • List if the text file that accompanies the input file is specified in a list file.
    • None if each input file should be submitted as a separate job.
    • Number if you want to group a specific number of files together.
    • Number of sets if you want to group a specific number of sets together.
    • Pages if you want to group PDF files into a job that contains a specific number of PDF pages.
    • Pages in sets if you want to group sets into a job that contains a specific number of PDF pages.
    • Time if you want to group files together based on when they arrive in the hot folder input device.
    • Sets by time if you want to group sets of files together based on when they arrive in the hot folder input device.
      Note:
    • By default, using any batching method causes an input device to create jobs as groups that use the parent/child structure. A parent job contains no data; it is a container that maintains the relationship between other jobs. Those jobs are child jobs. Each input file that a batching method includes in a group becomes a child job.

      If you set the Create .zip file property of an input device to Yes, the input device does not create groups of jobs that use the parent/child structure. Instead, the input device gathers all the input files in the group and creates a ZIP file to hold them. The ZIP file is submitted as a single job.

    Submit step
    Set this property to SubmitInputFiles.
  • When you submit a job to the input device that you just configured, make sure that you include all the required files, such as the text file or job ticket, the input file, or the list file.
  • The SetJobPropsFromTextFile step should be the first step in the Receive phase in a workflow.
  • Remove ${Job.InputFile} from the Job name property in this step when you are submitting a job to a Download or LPD input device with a control file that defines the job name.
  • You cannot copy or delete this step template.

Related information:

BuildPDFFromZIP
Parent topic: Supplied step templates