Metadata to PDI

The Metadata to PDI task takes the active metadata and generates a PDI using the information in that metadata. It is generally used in conjunction with a PDF data file and is used to generate the PDI file which is used by PlanetPress Search when building, refreshing or rebuilding its database.

For more information about Metadata see Metadata.

Input

This task can use any data file, as long as it is accompanied by metadata. This metadata may have been directly generated or could be extracted from a PDF using the Embed and Extract PlanetPress Workflow Metadata task.

Processing

The metadata is read and PDF indexes are located. These indexes are defined in the PlanetPress Design document as data selections, in which the Archive / Email / Fax properties define the data as an index with a name.

When all the indexes are collected, a PDI file is generated with those indexes.

Output

The output is the same as the input, no modification is done to either the data file or the metadata. However, a PDI file is generated and saved in the location specified in the task.

Task properties

General Tab
  • Archive Folder: Specifies where the PDI file should be saved. This should be the same location as the PDF file that the PDI refers to.
  • Filename: The file name for the PDI. This name should correspond exactly with the name of the PDF that the PDI file refers to.
  • Index Group:
    • PDI: Only generate a PDI file.
    • PDI and XML: Generate both the PDI and an XML equivalent (not used by PlanetPress Search).
On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in the Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see General appearance preferences), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.