Define Metadata

The Define Metadata Card

The Define Metadata card is used to contain information pertaining to the metadata for the package. If any metadata items exist, their properties display within the card. If no metadata exists, use the +Add Metadata button to begin defining metadata items. You may define multiple metadata items for a package.

What is Metadata?

Metadata items are essentially name/value pairs:

  • The metadata name is created in the Define Metadata card for each package. There is no limit to the number of metadata titles defined.
  • The the metadata value is defined for each document in the package individually within the Properties popup window. Each Metadata Title (name) defined in the Define Metadata card displays within the Properties window with a corresponding text box in which to enter the metadata value. The value may be blank if it does not apply to a given document.
  • Documents having metadata defined display in the Package Details window with a yellow ball indicator. The indicator displays when any of the available metadata values are populated for the document.

Metadata items can be used for two purposes:

  • Barcode Definition. Metadata titles can be used as a variable in the barcode pattern. This variable is then resolved by Expere Document Services during processing to use the corresponding value, which is included in the barcode on the generated document.
  • Additional Document Information. System integrations may require data defined per document in a package to automatically invoke workflows or automate processes. The Metadata titles and values per each document in the package are passed when processing a Expere Document Service request and included in the request’s response file. Metadata titles/values are always included in the response file regardless if the metadata item was used as a variable for the barcode pattern.

Adding Metadata

The following steps describe how to create metadata items for use within your documents in your packages. Once the metadata item is created, use the Document Properties popup to enter a specific metadata value for each document.

  1. Click Add Metadata on the Define Metadata card to open the Add Metadata window.
  2. Enter a Metadata Title for the metadata item you are adding.
  3. Click Add.
  4. Continue for each metadata item you wish to add.
The Metadata Title is limited to 255 characters or less. Additionally, the following special characters are not allowed within the Metadata Title:
  • Quotes (standard and smart; double and single)
  • forward slash /
  • back slash \
  • Ampersand &
Note: When entering metadata titles, avoid using any of the Expere reserved barcode variable names (page, totalpages, docsequence, docsequencetotal, docname, date) for the metadata titles.
Note: Use the Document Properties popup to define specific metadata values for each metadata item for each document, as desired.

Editing Metadata

  1. Click Edit for the metadata item you wish to edit on the Define Metadata card.
  2. Edit the Metadata Title as desired and click Add.

Removing Metadata

  1. Click Edit for the metadata item you wish to delete on the Define Metadata card.
  2. Click Remove Metadata.
  3. When prompted to confirm the deletion, click Delete.

The Relationship of Barcodes, Metadata, and Document Properties