In this article, you will find components which display information on all exported objects in a list or table format.
Attributes
Adds a section with all attribute values of an object to the template. Each attribute will be displayed in a separate section, separated by attribute names.
Example:
<<{ "type": "attributes", "attributeTypeNameStyle": "Custom Attribute Style", "maxContentWidth": 110 }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | attributes | string | Yes |
attributeTypeNameStyle | Text formatting style of the attribute name. | string | Yes |
maxContentWidth | Max width (in mm) of pictures used in the attribute value. The default value is 125. | integer | No |
External Attachments
Exports all attachments of the selected objects in their own folder.
Example:
<<{ "type": "externalAttachments", "foldersByObject": false }>>
<<{ "type": "externalAttachments", "singleFolderName": "Attachments" }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | externalAttachments | string | Yes |
foldersByObject | Determines whether attachments are categorized in folders according to the object name. | boolean | Yes |
singleFolderName | Name of the folder when all attachments are in a single folder. Used for "foldersByObject": false. | string | Yes (when foldersByObject is false) |
Multi Attachments
Adds a list with attachments of all exported objects to the template. The attachments are separated by object names.
Example:
<<{ "type": "multiAttachments", "objectNameStyle": "Custom Attachment Heading" }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | multiAttachments | string | Yes |
objectNameStyle | Text formatting style of the object names, which serve as attachment separators. | string | Yes |
Relations
Adds a table to the template listing objects related to the selected object. The table also includes information on the target object’s properties.
Example:
<<{ "type": "relations", "relationType": "core_isMentioning", "columns": [ {"value": "objectName", "isBold": true, "header": "Object Name" }, {"value": "definition", "header": "Definition" } ] }>>
<<{ "type": "relations", "relationType": "core_isMentioning", "columns": [ {"value": "objectName", "isBold": true, "header": "Object Name" } ], "sortByAlphabet": true, "distinct": true, "headerStyle": "Custom Table Header 1", "objectTypes": [ "data_source" ] }>>
<<{ "type": "relations", "relationType": "core_isMentioning", "width": "12", "align": "center", "columns": [ {"value": "objectName", "header": "Object Name", "width": "60%" }, {"value": "definition", "header": "Definition" } ] }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | relations | string | Yes |
relationType | Key of the relation type used to filter related objects. The key must be in the following format: packageKey_relationTypeKey. | string | Yes |
columns | Array of columns in the table. For column configuration, see the table below. | array | Yes |
align | Horizontal placement of the table when it is narrower than the text area. Supported values are left, center, and right. When omitted, Word’s default placement applies. | string | No |
distinct | Determines whether target objects can be added more times to the table. | boolean | No |
objectTypes | Keys of the object types that can be displayed. Used as an additional object filter. The keys must be in the following format: packageKey_objectTypeKey. | string | No |
headerStyle | Text formatting style of the table’s header column. | string | No |
reverseSort | Determines whether the table is sorted in an ascending or descending order. | boolean | No |
showEmptyTableHeader | Determines if an empty table can be shown. | boolean | No |
sortByAlphabet | Determines whether the table is sorted alphabetically. | boolean | No |
width | Width of the generated table. When omitted, the table fills the text area (page width minus margins). See Width syntax. | string | No |
When the component sits directly under a table in the template, an empty paragraph separates the two tables so that Word does not merge them and the generated table keeps its own width.
Width syntax
Widths are in centimetres by default, so "width": "17.5" means 17.5 cm. A decimal comma works as well ("17,5"). Centimetres are the default because that is the unit Word shows in Table Properties > Preferred width in metric locales. To use another unit, add one of these suffixes: cm, mm, pt, in, or %. A percentage is relative to the text area for the table, and relative to the table for a column.
This syntax applies to both the table’s own width and each column’s width.
Column properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
header | Text used as column name. | string | Yes |
value | The attribute or property of the target object in the relation. See supported values. | string | Yes |
isBold | Determines if the column name is in bold. | boolean | No |
width | Width of the column. Columns without a width share the space the sized columns leave. See Width syntax. | string | No |
Supported values
Supported values are:
ObjectName: Name of the target object in the relation.- Key of the attribute of the target object in the relation. The key must be in the following format:
packageKey_attributeTypeKey.
Text
Adds text to the template, with the option to display it conditionally based on specified criteria.
Example:
<<{ "type": "text", "Text": "Nicola Tesla", "style": "Custom text 1", "conditions": [ { "type": "attribute", "value": "project_id", "operator": "not null" } ] }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | text | string | Yes |
text | String of text to be displayed. | string | Yes |
style | Formatting style of the text. | string | Yes |
conditions | Text display conditions. See mandatory properties. | string | No |
Conditions mandatory properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
| type | Type of the attribute serving as the condition for this component. | string | Yes |
| value | Value of the attribute | string | Yes |
| operator | Expression determining when the attribute is displayed.For example, the not null operator defines that the text will be displayed only when the specified attribute is not empty. | string | Yes |
User relations
Adds a section with the object’s user relations to the template.
Example:
<<{ "type": "userRelations", "userRelationTypes": [ "core_data_steward", "core_bussiness_owner" ], "property": "LastName" }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | userRelations Multiple users per user relation type will be separated by semicolons (;). | string | Yes |
userRelationTypes | Keys of the displayed user relation types. The keys must be in the following format: packageKey_userRelationTypeKey. | string | Yes |
property | Type of the displayed user property. You can display one property type per component. | string | No |
User relations property supported values
Supported types of the user relation property are:
Name: Name of the user. Default when no property is specified.FirstName: First name of the user.LastName: Last name of the user.Description: Description of the user., Login: User login.Email: Email of the user.Phone: Phone number of the user.