In this article, you will find the list of components that are used for per-object templates.
Warning
All values must be in the database format: packageKey_assetKey.
Attachments
Adds a list of attachments of an object to the template.
Example:
<<{ "type": "attachments", "header": "Object attachments", "headerStyle": "Custom Heading 2" }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | attachments | string | Yes |
header | Title above the list of attachments. If the object doesn’t have any attachments, the title or an empty list won’t be displayed. | string | Yes |
headerStyle | Text formatting style of the title. | string | Yes |
Attribute
Adds an object’s attribute value to the template.
Example:
<<{ "type": "attribute", "attributeType": "core_definition", "maxContentWidth": 110 }>>
<<{ "type": "attribute", "attributeType": "registration_date", "format": "dd. MM. yyyy HH:mm:ss" }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | attribute | string | Yes |
attributeType | Key of the displayed attribute type. You can display one attribute type per component. The key must be in the following format: packageKey_attributeTypeKey. | string | Yes |
format | Format of the date. C# format strings are supported. Used with datetime attributes. | string | No |
maxContentWidth | Max width (in mm) of pictures used in the attribute value. The default value is 125. For the object details table section, we recommend using 116. | string | No |
Object name
Adds the object name to the template.
Example:
<<{ "type": "objectName", "styles": ["Custom Header Level 1", "Custom Header Level 2", "Custom Header Level 3"], "useNumbering": true }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | objectName | string | Yes |
style | List of text formatting styles used depending on the object hierarchy level. | string | Yes |
useNumbering | Determines if object numbering from the hierarchy is added to the object name. | boolean | Yes |
Object property
Adds object information (metadata) to the template.
Example:
<<{ "type": "objectProperty", "property": "WorkflowStateName" "styles": [ "Custom Level 1", "Custom Level 2", "Custom Level 3" ] }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | objectProperty | string | Yes |
property | Type of the displayed object property. See supported values. | string | Yes |
styles | List of text formatting styles used depending on the object hierarchy level, in the ascending order. Levels higher than the number of defined styles will use the last listed style. | string | Yes |
Object property supported values
Supported values of the object property are:
ApplicationName: Application to which the object belongs.Created: The object creation date and time.Creator: Who created the object.Numbering: Order number of the hierarchy.ObjectId: ID of the object.ObjectName: Name of the object.ObjectTypeName: Object type of the object.ParentObjectName: Parent of the object.ParentPath: Parent path of the object.SpaceName: Space to which the object belongs.Updated: The date and time of the last object update.Updater: Who last updated the object.WorkflowStateName: Workflow state of the object.
Relation
Adds a section with objects related to the exported object to the template.
Example:
<<{ "type": "relation", "relationType": "has_synonym", "attribute": "objectName" , "objectTypes": [ "business_rule", "data_source" ] }>>
<<{ "type": "relation", "relationType": "has_synonym", "attribute": "project_id" }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | relation Multiple objects per relation type will be separated using semicolons (;). | string | Yes |
relationTypes | Key of the relation type used to filter related objects. The key must be in the following format: packageKey_relationTypeKey. | string | Yes |
attribute | Attribute or property of the object to be displayed. See supported values. | string | Yes |
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 |
Relation attribute supported values
Supported values of the relation attribute property are:
ObjectName: Name of the target object in the relation.- Key of the attribute of the target object in the relation. 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 condition properties. | string | No |
Condition 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. Example: For The not null operator defines that the text will be displayed only when the specified attribute is not empty. | string | Yes |
User relation
Adds a section with the object’s user relations to the template.
Example:
<<{ "type": "userRelation", "userRelationType": "data_steward" , "property": "LastName" }>>| Property | Description | Values | Mandatory |
|---|---|---|---|
type | userRelation Multiple users per user relation type will be separated by semicolons (;). | string | Yes |
userRelationType | Key of the displayed user relation type. You can display one user relation type per component. The key 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. See supported values. | string | No |
User relation 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.