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.
- In the procedures pane on the left, select your procedure.
The configuration pages for the selected procedure appear on the right.
- Open the Processing tab.
-
In the Taxonomy Lookup Jobs table, click
, or to edit an existing job, click
.
You can also copy a taxonomy lookup job by selecting it, clicking
, and entering a new name when prompted. Copying a job allows you to quickly duplicate and modify it.
-
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.
-
- In the Lookup Execution section, do the following and then
click Next:
- 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. - 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
- Equals: Taxonomy search
value equals the value selected in Capture Search
Field.
- 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."
- In the Comparison Operator drop-down
list, select one of the following:
- 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.
- If you select Category Search:
- 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.
-
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.
-
Review settings on the Summary page and click Submit to save the job.
-
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.
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.