CreateJobsFromRepositorySearch

A step that is based on this step template searches a repository and creates one or more jobs based on the data retrieved. The step processes these searches based on the criteria specified in a file or a string. When the step completes, new jobs are created using the selected workflow with the data retrieved from the search.

The results of the search are returned in one or more ZIP files. The ZIP files include the data files for the jobs or documents. The ZIP files also contain the overrides file and a document overrides file when those files exist in the repository. For each set of search criteria, the step can return multiple jobs or documents and include them in the ZIP files. Each individual ZIP file is submitted as a separate job.

Job property defaults

  • Repository: Not set
  • Workflow for new jobs:
  • Search criteria:
  • Stop when no results are found: Yes
  • Create as child job: Yes
  • Path to override properties file:

Usage notes

  • You must have at least one repository defined to use this step.
  • Search criteria can contain entries for multiple archive searches. Make sure that each entry is on a separate line separated by a carriage return. You can also provide a full file path to a file that contains the search criteria you want to use.
    You can use symbol notation for job properties in the Search criteria field. If you put the search criteria in a file, you can use symbol notation for both job and document properties. For example: ${Doc.Custom.AccountNumber}=20035564. For more information about symbol notation and how to use it, refer to the help system.
  • To generate the Search criteria in the correct format, use the Search function on the Archive tab. Enter the search options for this step to use and click Search. In the header of the Results portlet, you can see the Search criteria.
    Image

    Copy all the text after the number in parentheses and paste it into the Search criteria field or into the search criteria file.

  • If your search results contain a large amount of data, make sure that the default spool directory has enough disk space to process the data. The step creates a temporary copy of all data returned by the search in this directory:
    • /aiw/aiw1/spool/default (AIX and Linux)
    • C:\aiw\aiw1\spool\default (Windows)
    For example, if the search returns five PDF files of 4 GB each, the step would require 20 GB of disk space in the default spool directory.

    When the step finishes, it deletes the temporary copy of the data.

  • When you create child jobs, the job processed by the CreateJobsFromRepositorySearch step becomes the parent job for the jobs created by the step. If you add a WaitForRelatedJobs step to the workflow for the parent job, the parent job stays in the system until all the child jobs complete. If you want to use the same workflow to process the child jobs, you can assign a rule to a connector that sends the child jobs through a different branch.
  • Property values, such as Media and Job copies requested, are not passed from the job in the CreateJobsFromRepositorySearch step to the jobs created by the step unless you create an override properties file. When you specify the database names of job properties in an override properties file, Ricoh ProcessDirector creates an overrides file with the values of the properties. This overrides file is passed to every job created by the step.
    For example, you receive print jobs for books. The value of the Custom 1 property for the job in the CreateJobsFromRepositorySearch step is Ghost Story, the title of the book to be printed. Specify Job.Info.Attr1 (the database name of the Custom 1 property) in the override properties file. Ricoh ProcessDirector creates an overrides file with Job.Info.Attr1=Ghost Story and passes it to every job created by the step. For information about overrides files, refer to the Information Center.
  • Steps based on the CreateJobsFromRepositorySearch step template have positional properties. You can place a step with positional properties in a workflow multiple times, and the job properties can take different values when each step is used. In the job property notebook in the legacy user interface, Ricoh ProcessDirector supplies the names of the phase and step where the value of each positional job property is used. For example: Search criteria[Prepare][CreateJobsFromRepositorySearch]. In the job property notebook in the updated user interface, the phase and step names appear as section names with the properties of the step shown inside the section.
  • You must have at least one repository defined to use this step.
  • Search criteria can contain entries for multiple archive searches. Make sure that each entry is on a separate line separated by a carriage return. You can also provide a full file path to a file that contains the search criteria you want to use.
    You can use symbol notation for job properties in the Search criteria field. If you put the search criteria in a file, you can use symbol notation for both job and document properties. For example: ${Doc.Custom.AccountNumber}=20035564. For more information about symbol notation and how to use it, refer to the help system.
  • To generate the Search criteria in the correct format, use the Search function on the Archive tab. Enter the search options for this step to use and click Search. At the bottom of the Search criteria list, you can see the Search criteria.
    Image

    Copy all the text after the number in parentheses and paste it into the Search criteria field or into the search criteria file.

  • If your search results contain a large amount of data, make sure that the default spool directory has enough disk space to process the data. The step creates a temporary copy of all data returned by the search in this directory:
    • /aiw/aiw1/spool/default (AIX and Linux)
    • C:\aiw\aiw1\spool\default (Windows)
    For example, if the search returns five PDF files of 4 GB each, the step would require 20 GB of disk space in the default spool directory.

    When the step finishes, it deletes the temporary copy of the data.

  • When you create child jobs, the job processed by the CreateJobsFromRepositorySearch step becomes the parent job for the jobs created by the step. If you add a WaitForRelatedJobs step to the workflow for the parent job, the parent job stays in the system until all the child jobs complete. If you want to use the same workflow to process the child jobs, you can assign a rule to a connector that sends the child jobs through a different branch.
  • Property values, such as Media and Job copies requested, are not passed from the job in the CreateJobsFromRepositorySearch step to the jobs created by the step unless you create an override properties file. When you specify the database names of job properties in an override properties file, Ricoh ProcessDirector creates an overrides file with the values of the properties. This overrides file is passed to every job created by the step.
    For example, you receive print jobs for books. The value of the Custom 1 property for the job in the CreateJobsFromRepositorySearch step is Ghost Story, the title of the book to be printed. Specify Job.Info.Attr1 (the database name of the Custom 1 property) in the override properties file. Ricoh ProcessDirector creates an overrides file with Job.Info.Attr1=Ghost Story and passes it to every job created by the step. For information about overrides files, refer to the Information Center.
  • Steps based on the CreateJobsFromRepositorySearch step template have positional properties. You can place a step with positional properties in a workflow multiple times, and the job properties can take different values when each step is used. In the job property notebook in the legacy user interface, Ricoh ProcessDirector supplies the names of the phase and step where the value of each positional job property is used. For example: Search criteria[Prepare][CreateJobsFromRepositorySearch]. In the job property notebook in the updated user interface, the phase and step names appear as section names with the properties of the step shown inside the section.
 
Copyright © 2014, 2018