Create a document variant

  1. On the Home page, click Data > Document Variant.

    The Document Variant page appears.

  2. Enter a Name for the document variant.
  3. Consume the document in the Document box.
    The document fields available within the document is displayed in the table.
  4. Click Yes for Include in Children to include the variant within the child document types.
    Note If a document variant with the same name exist, the variant is not overwritten but a message appears which lists all the document types wherein this variant has not been applied to.
  5. Do either of the following for Active From:
    • Click Date to specify the date from which the document variant should be active.
    • Click Not Specified for the document variant to be always active.
    Note the following:
    • If a document contains a variant, which is active, the document is validated based on the variant configuration, ignoring the appropriate fields.
    • If a document contains a variant, which is not active, the document will not be stamped with the variant and will be validated without the variant configuration.
  6. Enter an optional Description for the document variant.
  7. From the table, select the checkbox against the field to ignore.
  8. Click Save.
    • When you export a document type as part of a process or package, the variant functionality is retained.
    • When you upgrade TotalAgility, the variant functionality is available for the existing document types.
    • When you remove any fields from a document type, these fields are removed automatically from the variant configuration.
    • When you modify a document type by adding fields, these fields are added to the variants of the document type and process but are unmarked as ignored or hidden.

    See Create an activity variant.

    To consume a variant in a capture form, see Properties of a composite control.

Maintain a document variant

To update a document variant:

  1. On the Data Explorer, click Document Variants.

  2. Click the Extraction Group and select the document type under which the document variant is created.

  3. Click the Document Variant icon and click Open.

  4. Make changes to the variant as needed.

  5. Click Save.

To delete a document variant:

  1. On the Data Explorer, click Document Variants.

  2. Click the Extraction Group and select the document type under which the document variant is created.

  3. Click the Document Variant icon and click Delete generic delete.

  4. Click OK to confirm deletion.