Configure Taxonomy Lookup Jobs

A taxonomy is a hierarchy of categories, mapped to your business structure, used to organize your assets and to help users find assets by drilling down into the area they're working on. You can create taxonomy lookup jobs to enable client users to select taxonomy categories or automate taxonomy searches using a capture field value. In the later case, users can configure the category lookup for the target category reference field that you will configure in the taxonomy lookup job in your procedure.

  1. In the procedures pane on the left, select your procedure.

    The configuration pages for the selected procedure appear on the right.

  2. Open the Processing tab.
  3. In the Taxonomy Lookup Jobs table, click Add taxonomy lookup job, or to edit an existing job, click Edit taxonomy lookup job.

    You can also copy a taxonomy lookup job by selecting it, clicking Copy taxonomy lookup job, and entering a new name when prompted. Copying a job allows you to quickly duplicate and modify it.

  4. On the Lookup page, in the Document Selection section, do the following and then click Next:
    • Enter a name and description for the job.

    • Select the Online check box to enable the use of your taxonomy lookup job in your procedure.

    • To process the taxonomy lookup job for specific document profiles, select one or more document profiles listed in the Restrict to Document Profiles field, or select All to process documents for all defined document profiles.

  5. In the Lookup Execution section, do the following and then click Next:
    1. In Target Category Reference Field, select the metadata field to which you want to assign a taxonomy reference. You configured the taxonomy on the Metadata tab by creating a new metadata field whose data type is Category Reference. If a lookup job executes successfully, the Target Category Reference Field is assigned a GUID as the searched taxonomy category value.

      Note:

      The Target Category Reference Field lists only Category Reference metadata fields in the drop-down list.
    2. In the Lookup Method drop-down list, select either Category Search or Path Traverse.
      • If you select Category Search:
        • In the Comparison Operator drop-down list, select one of the following:
          • Equals: Taxonomy search value equals the value selected in Capture Search Field.
            Sample Data
            		1. Pulsar 150
            		2. Pulsar 180
            	Capture Field value = Pulsar
            	Lookup Result = Empty
            	Capture Field value = Pulsar 150
            	Lookup Result = GUID for Pulsar 150
          • Starts With: Taxonomy search value starts with the value selected in Capture Search Field.
            Sample Data
            		1. 150 Pulsar
            		2. Pulsar 180
            	Capture Field value = Pulsar
            	Lookup Result = Pulsar 180
            	Capture Field value = Bajaj
            	Lookup Result =  Empty
          • Contains: Taxonomy search value contains the value selected in Capture Search Field.
            Sample Data
            		1. 150 Pulsar
            		2. Pulsar 180
            	Capture Field value = Pulsar
            	Lookup Result = Pulsar 150 and Pulsar 180
            	Capture Field value = Bajaj
            	Lookup Result =  Empty
            	
        • In the Capture Search Field drop-down list, select the metadata field whose value should be passed from the Content Capture Client or list job. Only alphanumeric values are available in this list. The value you select is searched in the taxonomy that you configured for the metadata field you selected in Target Category Reference Field. The target reference field is used to search the Capture Search Field. The taxonomy value is returned to the target reference field, and it is also mapped to the metadata field you selected as the value of the target reference field.

          Note:

          • The taxonomy lookup is performed on the name field of the taxonomy that is selected for the target category reference in the metadata field.
          • The result of the lookup job is the GUID Id for the searched taxonomy category and this GUID is assigned to the Target Category Reference Field.

        • In the If multiple categories match section, choose one of the following:
          • Select first: Selects the first search result.
          • Select none: Skips all categories. If this option is selected, no searched category GUID is assigned to the target category reference field. Any existing values in this field are retained.
          • Fail: Taxonomy lookup fails. A relevant error message is displayed such as "Multiple matches were found for lookup."
      • If you select Path Traverse:
        • In the Capture Path Field drop-down list, select a metadata field of the type Path. This path is used to traverse the taxonomy. It represents various categories that need to be created or found.
        • You can create missing categories by accepting the default selection of the Create Missing Categories check box. If a category is created, a new taxonomy version is created, a Draft version, which must be promoted to be used. The After Category Added drop-down list provides Promote or Publish actions to be taken if categories were created. You can select the desired option. If a taxonomy has never been published previously, Content Capture cannot publish it. A message is written in the activity log indicating as such; however, the batch does not fail processing and the taxonomy is left in promoted state. See Manage Taxonomies for more information.
        • If you choose not to create missing categories and paths are incomplete, then in the If incomplete traverse section is available. The choices are Select lowest match or Select none. The lowest match refers to the deepest part of the path that presently exists in the taxonomy. Whereas, select none leaves the category reference field unassigned.
  6. On the Post-Processing page, specify based on the following what happens after an taxonomy lookup job completes:
    • No system error situations are cases in which all the criteria on the previous page were met. A successful transformation can flow to commit.
    • System errors are any cases in which the transformation fails: too many records found and so on. For unsuccessful transformations, the batch returns to the Content Capture Client for repair.
    See Configure Post-Processing and Monitoring of a Taxonomy Lookup Job.
  7. Review settings on the Summary page and click Submit to save the job.

  8. Configure Configure Batch Flow to a Taxonomy Lookup Job.

  9. Test the taxonomy lookup job you created.

Configure Post-Processing and Monitoring of a Taxonomy Lookup Job

Use post-processing options of a taxonomy lookup job to specify what happens after processing completes.

To configure post-processing and monitoring of a taxonomy lookup job:
  1. In the procedures pane on the left, select your procedure.
    The configuration pages for the selected procedure appear on the right.
  2. Open the Processor tab.
  3. In the Taxonomy Lookup Jobs table, add or edit an taxonomy lookup job.
  4. Click the Post-Processing page to display the processing options for successful processing (no system errors) and unsuccessful processing (one or more system errors). The next steps apply to both sections: When there is no system error and When there are system errors.
  5. In the Batch Processor and Batch Processor Job fields, specify which processing step, if any, occurs after the taxonomy lookup job completes. Only those batch processor jobs that you have defined for your procedure are available for selection. For example, if you didn't define a recognition processor job, then the recognition processor option will not be available in the Batch Processor field. If you choose recognition processor or conversions to TIFF/PDF in the Batch Processor field, then specify the corresponding processor job.
  6. In the email address field, optionally enter an address to which to send an email after processing completes successfully or fails. While configuring and testing a taxonomy lookup job, you might set yourself to receive email notifications upon system errors, then later automatically alert an administrator of processing errors.
  7. In the remaining fields, specify how to change processed batches.
    • Rename batches by adding a prefix. For example, rename batches that were unsuccessful with the prefix ERR for follow-up.

    • Change batch status or priority. For example, you might change the status of batches with system errors, then create a client profile with batch filtering set to this status to allow qualified users to manually edit and complete batches that encountered errors.

  8. Click Submit to save the job.

Configure Batch Flow to a Taxonomy Lookup Job

To run a taxonomy lookup job, you must configure batches to flow to the job for processing. You do this by setting the taxonomy lookup job as a post-processing step in a client profile, an import processor job, or a processing job discussed under processing settings. See the post-processing information for the job or client profile from which you want to configure a batch flow, under Configure Processing Settings or Configure Capture Settings.

Deactivate or Delete a Taxonomy Lookup Job

When you delete a taxonomy lookup job, it no longer remains available for batches for which it is set as a post-processing step. If a job specified for post-processing is not available, an error results for the batch. You may want to change a job to offline for a time before deleting it, allowing you to resolve unexpected issues with its deletion. Online taxonomy lookup jobs run when they are selected in a client profile or on the Post-Processing page of a processor job. You can temporarily stop a job (take it offline) or change a deactivated job to run again. You cannot delete batch processing jobs if they are configured as a post processing job in another batch processor.

To deactivate or delete a taxonomy lookup job:
  1. In the procedures pane on the left, select your procedure.
    The configuration pages for the selected procedure are displayed on the right.
  2. Open the Processing tab.
  3. To deactivate a job, select it in the Taxonomy Lookup Jobs table and click Deactivate or activate a taxonomy lookup job.

    You can also deactivate or activate a taxonomy lookup job by selecting or deselecting the Online field on the Document Selection page.

  4. Select the deactivated job in the Taxonomy Lookup Jobs table and click Delete taxonomy lookup job.
  5. When prompted, click Yes to confirm that you want to delete this job.