Property mapping objects

A property mapping object defines the relationship between the headings in a preferences file and the document properties defined in the system. The property mapping is used by the ApplyPreferences step in a workflow to add or change values in the document properties file (DPF) for the job.

When you define a mapping, you also select the usage for the document property.

  • Document identifier
    Document identifiers are the properties that you use to determine which documents to update with the values in the preferences file. These values from preferences file match with document property values from the job documents.

    In the image below, the Account number heading is mapped to the Member document property. Member is then listed as a Document identifier. When the ApplyPreferences step runs, it reads the preferences file. For each row, it finds the value of the Account number, then searches the document properties file to find the entry that has the same value listed for the Member property.

  • Document property to set
    Document properties to set are the properties that are updated with values from the preferences file. These properties might not have values in the document properties file.

    In the image below, Email address and Output type are listed as Document properties to set. After the ApplyPreferences step locates the entry in the document properties file whose Member property matches an Account number value, it updates the Email address and Output type properties in the document properties file for that entry with the values in the same row of the preferences file.

You must have at least one property listed as a document identifier and at least one property listed as a property to set. Properties can only appear in one of the lists.

When you define a property mapping object, you map headings in the preferences file to properties in the document properties file. Then you specify one of these Usage values for that pair:

  • Identify document
    This pair is used to find which documents to update in the DPF.

    In the image below, the heading of Account number is mapped to the Member document property and the usage is set to Identify document. When the ApplyPreferences step runs, it reads the preferences file. For each row, it finds the value of the Account number, then searches the document properties file to find the entry that has the same value listed for the Member property.

  • Update property
    These pairs are used to update values in the document properties file. These properties might not have values in the document properties file initially.

    In the image below, the headings Email address and Output type are mapped to document properties with the same names. The Usage for both pairs is set to Update property. When the ApplyPreferences step locates the entry in the DPF whose Member property matches an Account number value, it updates the Email address and Output type properties in the DPF for that entry with the values in the corresponding row of the preferences file.

You must map at least two headings to document properties, one for each Usage type.

The values can be used by other steps in the workflow to group documents for common processing such as one set of documents to email and another set of documents to print.

Image
Image

The same property mapping object can be used by multiple workflows as long as the preferences files contain the same headings. The order of the headings can be different in each preferences file.

 
Copyright © 2015, 2018