Step templates

Step templates are separate units of processing code. They can be assembled into workflows based on what you need to do to an input file.

RICOH ProcessDirector provides many step templates that you can incorporate into workflows; optional features can add even more. You can either use those step templates as they are, or copy and modify them to work in your environment.

Note: Some step templates cannot be copied; but you can edit their properties.
You cannot write your own step templates and include them in workflows. However, if you write a script or other program that can be invoked from the command line, you can access it using the RunExternalProgram step template.

Some step templates are particularly important for interacting with other applications:

  • SetJobType step templates

    Input devices use SetJobType steps to determine which workflow to use to process a print job. The SetJobType step templates are:

    • SetJobTypeFromFileName

      Uses a pattern-matching string to set the workflow from a portion of the input-file name, such as the file extension. For example, all jobs with the file extension .AFP can be sent to the workflow AFP or all jobs with the extension .pdf can be sent to the workflow pdf. The step can also convert an optional overrides file submitted with a job to a text-based file, jobID.overrides.text, which the SetJobPropsFromTextFile step uses to set job properties.

    • SetJobTypeFromRules

      Uses a control file to select the workflow based on the value of a parameter in an overrides files that accompanies the input file. The step can also convert an optional overrides file submitted with a job to a text-based file, which the SetJobPropsFromTextFile step uses to set job properties.

    Print system administrators might want to coordinate the output of a print submission application with the values in these steps.

  • SubmitInputFiles step template

    Input devices use the SubmitInputFiles step to send print jobs to the first step in their workflows. It submits a group of input files as a parent job and child jobs according to the batching method specified. It submits a single input file as a single job of the child workflow, without a parent job.

  • SetJobPropsFromTextFile step template

    The SetJobPropsFromTextFile step is usually the first step in a workflow. It uses a text file that accompanies the input file to set job properties. The text file specifies which properties to set. Values in the text file overwrite any values that have been set previously. After processing an optional jobID.overrides.text file, the step looks for an optional Job Definition Format (JDF) job ticket file, jobID.overrides.jdf, and uses it to set additional properties of the job.

  • External steps

    External steps send print jobs to applications outside of RICOH ProcessDirector for processing such as data stream transforms, address cleansing, and impositioning. The external step templates are:

    • RunExternalProgram

      Submits the print job to an external program using a command line interface.

    • RunHotFolderApplication

      Puts the print job in a hot folder that another application monitors. That application picks up the print job, processes it according to its configuration settings, and puts it into an output folder. RICOH ProcessDirector monitors that output folder and retrieves the job when it is ready.

Parent topic: System objects