Preparing to submit jobs using web services

RICOH ProcessDirector provides a REST web service utility that you can use to submit jobs. If you can configure your application to use REST web services, you can use the submitFile utility to submit a file to a workflow or hot folder.
Depending on the requirements of your web service application, you need either a Curl command or Request URL to invoke the web service. Use the RICOH ProcessDirector REST API documentation to determine the correct syntax.

To prepare to submit a job using a web service:

  1. Decide how RICOH ProcessDirector receives the file for processing.
    You can submit a file to RICOH ProcessDirector using a hot folder input device or you can submit directly to a workflow.
    • Submit files directly to a workflow when there is only one input file per job or you do not need to use the batching functions available in RICOH ProcessDirector.
    • Submit files to hot folders when you want to use the batching functions in RICOH ProcessDirector. You can only submit one file at a time with the web service. If a job has multiple input files, including job tickets, list files, or other resources, you must invoke the web service for each file.

      Note the name of the workflow or hot folder.

  2. Evaluate your web service application and see what information the application requires to submit a file to RICOH ProcessDirector.
    The RICOH ProcessDirector REST API documentation provides both a Curl command and a Request URL. Either can be used depending on what your web service application requires.
  3. Use the RICOH ProcessDirector REST API documentation for the submitFile utility to help create the web service calls to submit your file.
    Open a web browser and enter your RICOH ProcessDirector hostname or IP address into the address bar. Add /restapi/ to the end of your hostname or IP address to access the REST API documentation. For example: http://hostname:15080/restapi/.

    Open the util section and find POST /util/ submitFile/{objectType}/{name}.

  4. Update your web service application with the command or URL that you developed in previous step. Use the application to submit one or more files to RICOH ProcessDirector.
  5. Verify that your web service application is configured correctly to submit a file to RICOH ProcessDirector.
    • If you submit to a hot folder, verify that the file is in the folder location in the hot folder. Connect and disable the hot folder if you want to check that the files are received in the correct directory without actually submitting the job. If you want the input device to submit the job, make sure it is both enabled and connected when your application submits the file.
    • If you submit to a workflow, verify that a job is created with the file you submitted. Make sure the workflow is enabled when you submit the file.

Related information:

Using RICOH ProcessDirector REST API documentation
Parent topic: Preparing for job submission