Setting up step templates for external steps that use hot folders

Use this process to set up a step template for external steps that use hot folders to pass input and output between RICOH ProcessDirector and the external program.
To set up a step template for an external step:
  1. Click the Workflow tab.
  2. In the left pane, click Step templates.
  3. Right-click the RunHotFolderApplication step template and select Copy.
  4. Specify a name and description for the new step template.
  5. Click Hot Folder.
  6. Update the Sending folder property.
    The value of this property is the name of the input hot folder for the external program. RICOH ProcessDirector places the job in this folder to submit it to the external program.
      Note:
    • The value must be the name of a folder that exists. RICOH ProcessDirector does not create the folder.
    • The folder must be accessible to both RICOH ProcessDirector and the external program. It can be:
      • In the RICOH ProcessDirector shared file system, /aiw/aiw1/ (AIX and Linux) or C:\aiw\aiw1\ (Windows), on the computer that has the primary server installed.
      • In a file system that is shared using file sharing software, such as Samba.
    • Even if the folder is on a Windows system, specify the path using AIX or Linux format. For example, if the folder is C:\Sending, type /Sending.
    • If this value is null, no file is copied and the step waits.
  7. Update the File to send property.
    The value of this property is a symbol formula that resolves to the name of the file that RICOH ProcessDirector sends to the external program.
      Note:
    • The default value is getAbsoluteFileName(print, pdf, read), which returns the name of the PDF print file in the spool directory. If the PDF print file does not exist in the spool directory when the external program runs, an error occurs.
  8. Update the Retrieval folder property.
    The value of this property is the name of the output hot folder for the external program. RICOH ProcessDirector retrieves the job from this folder after the external program has processed it.
      Note:
    • The value must be the name of a folder that already exists. RICOH ProcessDirector does not create the folder.
    • The folder must be accessible to both RICOH ProcessDirector and the external program. It can be:
      • In the RICOH ProcessDirector shared file system, /aiw/aiw1/ (AIX and Linux) or C:\aiw\aiw1\ (Windows), on the computer that has the primary server installed.
      • In a file system that is shared using file sharing software, such as Samba.
    • Even if the folder is on a Windows system, specify the path using AIX or Linux format. For example, if the folder is C:\Retrieval, type /Retrieval.
    • When you set the Clean up retrieval folder property to No, the file that the step retrieves can be in the retrieval folder when a job arrives at the step. The step retrieves the file and puts the file specified by the File to send property in the sending folder. The step then sends the job and the retrieved file to the next step in the workflow. The step does not wait for a new file to be placed in the retrieval folder.
  9. Update the Retrieval pattern property.

    The value of this property is the pattern-matching string that RICOH ProcessDirector uses to identify the output files to retrieve from the output hot folder of an external program.

    For example, the value ${Job.ID}.* matches any file whose file name is the same as the job ID, with any file extension.

  10. Update the Retrieved file property.
    The value of this property is a symbol formula that resolves to the name that RICOH ProcessDirector uses to rename the retrieved file.
  11. Update the Clean up retrieval folder property.

    When a job enters the step, this value tells RICOH ProcessDirector whether to remove any file in the retrieval folder whose file name matches the Retrieval pattern.

  12. Update the Application log file property.
    The value of this property is the folder where the external program writes log files. This value can be blank.
  13. Update the Poll interval property.
    The value of this property is the interval in seconds at which RICOH ProcessDirector checks the output hot folder for completed jobs.
  14. Update the File size verification count property.
    The value of this property is the number of times that RICOH ProcessDirector polls the output hot folder and finds a file that has not changed in size. RICOH ProcessDirector then decides that the file is complete.
  15. Update the Timeout interval property.
    The value of this property is the time limit in minutes for retrieving a job from the output hot folder of an external program. If the job has not been received or is not complete when the time limit is reached, the job is in error.
      Note:
    • Make the timeout interval longer than the poll interval times the file verification count.
    • If the timeout interval is 0, RICOH ProcessDirector waits forever.
  16. Click OK.
  17. Update any settings on the Tuning tab to run the step on the computers where the external program is installed.
    See Tuning step templates for instructions.
  18. Select the new step template and click Enable.

Related information:

Tuning step templates
Using RICOH ProcessDirector methods
RICOH ProcessDirector symbol notation
Database property names
RunHotFolderApplication
Parent topic: Setting up step templates for external steps