Harvesting Claims

Using an entry or user action, you can asynchronously create Claims from link annotations on steady state documents, allowing you to quickly and easily maintain your Text Asset library. Vault harvests the full text, reference links, document metadata, and annotation IDs from text link and area link annotations.

To prevent creating duplicate Claim records, Vault checks existing records in the Text Asset library using the Match Text field on the Text Asset (annotation_keywords__sys) object.

Configuring Claims Harvesting

You can add the Harvest Claims entry action and user action to any document lifecycle state. We recommend adding the entry action to the steady state. 

To add the entry action:

  1. Navigate to Admin > Configuration > Document Lifecycles > [Lifecycle] > States > [State].
  2. Under Entry Actions, click Edit.
  3. Click Create Entry Action.
  4. Select Always and Harvest Claims.
  5. Click Save.

To add the user action:

  1. Navigate to Admin > Configuration > Document Lifecycles > [Lifecycle] > States > [State].
  2. Under User Actions, click Edit.
  3. Click Create User Action.
  4. Select Always and Harvest Claims.
  5. Click Save.

The Enable Claims Harvest Auto-Approve Qualified Annotations setting is enabled by default. When enabled, Vault automatically places qualified harvested Claims in the Approved state. 

Vault only considers a harvested Claim qualified when:

  • The source document and any linked documents are in their steady state, such as Approved for Distribution.
  • The source annotation is a text annotation.
  • The annotation text is less than 1,500 characters.

To disable this functionality, navigate to Admin > Settings > Application Settings and, under Text Asset Library Management, clear the Enable Claims Harvest Auto-Approve Qualified Annotations checkbox.

Deleting Harvested Claims

To delete a harvested Claim, you must remove the Product, Country, and Link Target relationships.

Limitations

Vault does not harvest Claims if the document is a binder. 

Vault does not harvest Claims from video or audio files.

Vault may fail to harvest Claims from area annotations if the selected area is small.