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. These document properties can be created by you or inherited from an embedded Microsoft Word document.
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 includes a list of predefined document properties which you can use, or you can also create your own custom document properties in the Microsoft Word document. The Microsoft Word predefined document properties are:
  • tags
  • status
  • comments
  • manager
  • hyperlink base
  • categories
  • author
  • title
  • subject
Tip: When you first add a document property element to the template content editor, the name and the value display: 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, for example.
  • 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

To create a static document property:

  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. Example: tags The Microsoft Word document property tags maps to keywords for Rational® Publishing Engine Microsoft Word and PDF outputs.
  5. For the Append property, select True or False.
    • True: The document property is included in the generated output.
    • False: The document property is ignored during document 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, the document properties are detected and automatically be inserted into the document 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 read who created a document, for example, or you can use them to filter or search for documents with specific metadata in your content management system.

Feedback