Adding a document property element

Customize your own set of metadata for your organization or for your template to provide descriptive properties about a document-style report. You can either create document properties or inherit them from an embedded Microsoft Word.

Restriction: New feature icon The document property element is available only in version 2 templates.

About this task

Document properties appear in the generated output and are assigned as static content, variables, JavaScript, or data values.

Microsoft Word and PDF documents include a list of predefined document properties that you can use, or you can also create your own custom document properties in the documents.

The Microsoft Word documents have the following predefined document properties:
  • Tags
  • Status
  • Comments
  • Manager
  • Hyperlink base
  • Categories
  • Author
  • Title
  • Subject
The PDF documents have the following predefined document properties:
  • File name
  • File size
  • Title
  • Author
  • Subject
  • Keywords
  • Created
  • Modified
  • Application
  • PDF producer
  • PDF version
  • Page count
  • Page size
  • Fast web view
Tip: When you first add a document property element to the template content editor, the name and the value display in the following format: Document property element when it is first added to the template content editor.
  • The name for the document property is entered in the Specific tab in the Properties view. The name property in the General tab is different from the name in the Specific tab. The name in the General tab is the metadata name for the element, which can be used when you are configuring regions.
  • The value for the document property is entered in the Content tab in the Properties view. You can also double-click the element to enter the values and view your entries from the Content tab.

Procedure

  1. In the Palette view, select the Document property icon Document property element and drag it into the template content editor.
  2. Select the Document property element.
  3. In the Properties view, select the Specific tab.
  4. Enter a name for the document property. Document property elements that do not have a name are ignored at run time.
    Note: If you are adding the custom document property, the document property name must not be one of the standard predefined document properties.
  5. In Append property, select True or False.
    • True: The document property is included in the generated output.
    • False: The document property is ignored during document-style report generation.
  6. Double-click the Document property element.
  7. Enter a value for the Document property.
    Separate multiple values with a comma.
    Example for the tags document property: Q4, budget
  8. Save the changes.

Results

When you generate the document-style report, the document properties are detected, and automatically be inserted into the document-style report output. If two document properties have the same name, the value is applied from the last document property in the template.

What to do next

You can use these document properties to find who created a document-style report, or to filter or search for document-style reports with specific metadata in your content management system.