To create Word export templates which are replicated for every object. There are two types of the object details section:

  • Object details: Anything within the tags will be replicated for every single selected object.
  • Object details table: Anything after the tag will be understood as a template.

Per-object templates can use the following components:

  • Attachments
  • Attribute
  • Object name
  • Object property
  • Relation
  • Text
  • User relation

For more information, see Per-Object Components.

Tip

These components can also be used in the header or footer of a Word document. Add the full component, or a reference from the template fields section.

Object Detail Section

The object detail section must include both an opening and a closing tag. All content placed between the tags will be replicated for each selected object during export.

<<Object details>>
<</Object details>>

Examples:

  1. “Document Title” will be exported once for the whole document.

    Document Title
<<Object details>>
<<{ "type": "objectName", "useNumbering": true, "styles": ["1 Number Heading", "2 Number Heading", "3 Number Heading"]}>>
<<{ "type" :"attribute", "attributeType": "definition", "style": "Normal" }>>
<</Object details>>

  2. Each new export section begins with “Document Title”, including the space that follows it.

    <<Object details>>
Document Title

<<{ "type": "objectName", "useNumbering": true, "styles": ["1 Number Heading", "2 Number Heading", "3 Number Heading"]}>>
<<{ "type" :"attribute", "attributeType": "definition", "style": "Normal" }>>
<</Object details>>
Tip

Any formatting applied to static text in the template will be preserved, but formatting applied directly to component fields will be ignored. To format the components, use the style property when available.

Multiple Object Details Sections

A single template can include multiple object detail sections, each targeting a specific object type. The object type is specified in the following ways

  •   <<Object details: { "objectType": "packageKey_objectTypeKey" }>>
  •   <<Object details: { "OT": "packageKey_objectTypeKey" }>>

Example:  The export requires both parent and child objects to appear on each exported page. The template should include:

  • Object Detail Section 1: Parent objects with their names and descriptions.
  • Object Detail Section 2: Child objects with their names and creation date.
<<Object details: { "OT": "packageKey_parentObjectKey" }>>
<<{ "type": "objectName", "useNumbering": true, "styles": ["1 Number Heading", "2 Number Heading", "3 Number Heading"]}>>
<<{ "type" :"attribute", "attributeType": "core_description", "style": "Normal" }>>
<</Object details>>

<<Object details: { "OT": "packageKey_childObjectKey" }>>
<<{ "type": "objectName", "useNumbering": true, "styles": ["1 Number Heading", "2 Number Heading", "3 Number Heading"]}>>
<<{ "type": "attribute", "attributeType": "packageKey_creation_date", "format": "dd. MM. yyyy HH:mm:ss"}>>
<</Object details>>

Objects Details Table

The object details table allows the creation of a table with a consistent header column, which is replicated for every single selected object.

  1. Add the object details table tag. We recommend specifying the maximum width for pictures to make sure they don’t break the formatting. Anything after this tag will be understood as the template. 
    •   <<Object details table: {"MaxContentWidth": 116}>>
    • The object details table doesn’t have a closing tag.
  2. Create your table.
  3. Mark the header row, which will be replicated on each exported object page.
  4. Add the components to the cells. Here, you can use the template fields section to avoid overcrowding the template. For more information, see Word Export Template.

Example: diagram-1

Multiple object types

To export multiple object types in one table, use the following tags:

  •   <<objectType: "packageKey_objectTypeKey">>
  •   <<OT: "packageKey_objectTypeKey">>

This tag assigns all following components to the specified object type until another object type tag appears.

Example: diagram-2

In this table, there are two sections:

  • The two columns will have the name and description of Object Type 1.
  • The merged column will have the name and creation date of Object Type 2.

Multiple tables: Object type ID

The Object Type ID is used in the Object Details table to specify that the following fields should export only information related to the selected object type IDs.

The tag has the following format:

  •   <<Object details table: {„ObjectTypeIds“: [1,2,3]}>>

This tag indicates that the following fields are from objects with the following IDs: 1, 2, 3

Typical use cases include:

  • Exporting data from a single object type into multiple tables
  • Exporting data from specific object types into different tables
  • Exporting data from each object type into its own table

Example: Exporting data from a single object type into multiple tables diagram-3

Example: Exporting data from specific object types into different tables

  • The first table will export information from objects with object type ID 1, 2, and 3.
  • The second table will export information from objects with object type ID 4, and 5.

The export looks up defined fields only among the specified object type IDs. diagram-4