Metadata Attributes reference
An Attribute is a read-only, system-defined element which holds certain information about a certain node in the Metadata structure. This information can be static (e.g. the size of a physical page) or evaluated on-the-fly (e.g. the number of documents in a group). Attributes are non-repetitive (i.e. name is unique) and do not persist through Metadata recreation.
When the Metadata file is viewed through The Data Selector, the Attributes are listed under Production information (see Metadata tab).
The Metadata Attributes can be categorized as either Production, Finishing or Index/Count.
- Production attributes describe the production of the job and/or Metadata (e.g. path and name of the data file, date at which Metadata was created, etc.)
- Finishing attributes describe the finishing intent (e.g. page dimensions, page orientation, duplex mode, etc.).
- Index/Count attributes are not part of the original Metadata file. They are evaluated dynamically, based on the content of the Metadata.
Note: Metadata Index/Count values are one-based when viewed in the user interface: the first element in any collection has an index of 1 and the last element's index corresponds to the collection's length. However, in the API and in Metadata selections, they are zero-based: the first element in any collection has an index of 0 and the last element's index corresponds to the collection's length minus 1.
This means the zero-based value has to be used when retrieving Metadata (see also: Metadata selections and Rule Interface).
Note: The presence of some finishing attributes depends on the PlanetPress Design document and target device used when producing the job.
In the following table, the last 5 columns indicate at which level the corresponding attribute is available. This also depends on the type of job, however.
Note: In the Metadata file created for an OL Connect job:
Only three levels are filled with actual data about the job: Job, Group and Document.
Only Index and Count attributes are used.
Attribute |
Description |
Category |
Job |
Group |
Document |
Datapage |
Page |
---|---|---|---|---|---|---|---|
DataEncoding |
(optional) Name of the character encoding. |
Production |
X |
X |
X |
|
|
DataFile |
(optional) Path and name of the data file used by the PlanetPress Design Document. |
Production |
X |
X |
X |
|
|
Date |
Date the Metadata was created in ISO format. |
Production |
X |
X |
X |
|
|
Time |
Time the Metadata was created in ISO format. |
Production |
X |
X |
X |
|
|
Title |
Title of the source document. |
Production |
X |
X |
X |
|
|
Producer |
Name of the software that created the Metadata. |
Production |
X |
X |
X |
|
|
Creator |
Name of the software that created the source of the Metadata. |
Production |
X |
X |
X |
|
|
TargetDevice |
Name of the device for which the Metadata and associated data is intended. |
Production |
X |
X |
X |
|
|
Author |
Name of the user who printed the job initially, as available in the spool file, and as the first job info of the Windows capture input. |
Production |
X |
|
|
|
|
Dimension |
Two floating-point values separated by a colon indicating the media size in typographical points (ex: 612:792). |
Finishing |
X |
X |
X |
X |
X |
Orientation |
"Rotate0", "Rotate90", "Rotate180" or "Rotate270", indicating respectively portrait, landscape, rotated portrait and rotated landscape. |
Finishing |
X |
X |
X |
X |
X |
Side |
"Front" or "Back"; indicates whether the page is on the front or the back of the paper sheet. This attribute is a "best effort" and is device-dependent. |
Finishing |
|
|
|
|
X |
Duplex |
"None", "DuplexTumble" or "DuplexNoTumble"; indicates a change of the duplex status. |
Finishing |
X |
X |
X |
X |
X |
InputSlot |
Device-dependent identifier of the media source. |
Finishing |
X |
X |
X |
X |
X |
OutputBin |
Device-dependent identifier of the media destination. |
Finishing |
X |
X |
X |
X |
X |
Weight |
Device-dependent weight of the media. |
Finishing |
X |
X |
X |
X |
X |
MediaColor |
Device-dependent color of the media. |
Finishing |
X |
X |
X |
X |
X |
MediaType |
Device-dependent type of the media. |
Finishing |
X |
X |
X |
X |
X |
Index |
|
Index/Count |
|
X |
X |
X |
X |
IndexInDocument |
Returns the Absolute index of the node within all the nodes under the parent Document. |
Index/Count |
|
|
|
X |
X |
IndexInGroup |
Returns the Absolute index of the node within all the nodes under the parent Group. |
Index/Count |
|
|
X |
X |
X |
IndexInJob |
Returns the Absolute index of the node within all the nodes under the parent Job. |
Index/Count |
|
X |
X |
X |
X |
Count |
|
Index/Count |
X |
X |
X |
X |
|
DocumentCount |
|
Index/Count |
X |
|
|
|
|
DatapageCount |
|
Index/Count |
X |
X |
|
|
|
PageCount |
|
Index/Count |
X |
X |
X |
|
|
SelectedCount |
|
Index/Count |
X |
X |
X |
X |
|
SelectedDocumentCount |
|
Index/Count |
X |
|
|
|
|
SelectedDatapageCount |
|
Index/Count |
X |
X |
|
|
|
SelectedPageCount |
|
Index/Count |
X |
X |
X |
|
|
SelectedIndexInDocument |
Returns the Absolute index of the node within all the selected nodes under the parent Document. |
Index/Count |
|
|
|
X |
X |
SelectedIndexInGroup |
Returns the Absolute index of the node within all the selected nodes under the parent Group. |
Index/Count |
|
|
X |
X |
X |
SelectedIndexInJob |
Returns the Absolute index of the node within all the selected nodes under the parent Job. |
Index/Count |
|
X |
X |
X |
X |
NumCopies |
Indicates how many times the job is set to execute, as set when printing using a Windows driver. |
Index/Count |
X |
|
|
|
|