REPORTER
Reporter Template tags
The Reporter uses a tag system to make report templates reusable. These tags are handled by the Reporter processor and converted to the text and values of the objects that the tags refer to.
Tags start with "$" and have the following syntax:
- For non-image objects - ${type.id.property}
- For image objects - ${type.id.property},[image tag modifier]
The text between ${ and } is case sensitive. Words must be written exactly as they are presented in the Template listing.
Tags should not contain white spaces, especially between $ and {.
E.g. $ { this.object.id } could be misinterpreted. The correct syntax is ${this.object.id}.
Type
Type refers to what model the object is in. Some short forms are available for Type:
|
Available types |
Model |
|
o, org, organisation, organization |
Organization |
|
n, node, |
Node |
|
nodetype, nt |
Node type |
|
scorecard, perspective, strategicobjective, kpi, function, template, t |
Template objects, i.e. objects in the model tree that are not organizations |
|
resource, res, r |
Resources |
ID
This part of the tag refers to the ID of the object being referred to. You can see the ID in the Advanced tab for the object in the Configuration Studio. Also you can find this ID in the tooltip for all objects in the tree panels, e.g. 100 Main Organization.
Property
This is a property of the selected object. This is highly variable based on the object selected in the first two parts of the tag. For example, if name is selected here then the tag will change into the name of the object specified via Type and ID. If it is description, then it will change to the description.
Examples:
|
Tag |
Description |
|
${o.100.name} |
The name of the organization with ID 100 |
|
${o.100.description} |
The description of the organization with ID 100 |
|
${t.148.periodStorage} |
The period type of the scorecard with ID 148 |
|
${t.139.statusAlgorithm} |
The Status algorithm for the KPI with ID 139 |
These examples will only work if you have objects with the same IDs as the ones that are used in the examples.
Custom properties can now use the ID property instead of the name in tags. The ID is now default in template listing. E.g.
a new Numeric property with ID 605 on an object with ID 103 will have this tag in the Template listing: ${t.103.605}
Image tag modifier
This is a tag element that indicates Corporater BMP how to resize a template image that no longer fits the image template in the report.
The modifier can be one of the following:
- imageSize– Indicates Corporater BMP to change the size of the image based on the size of the result image, instead of the size of the template image.
- shapeSize – Indicates Corporater BMP to fit the image into the applicable shape while also maintaining its aspect ratio.
Corporater BMP automatically attributes a modifier to each image in a new reporter template.
The modifier depends on the image type, as follows:
- imageSize – For Gantt charts and spreadsheet views.
- shapeSize – For risk charts, image views, maps, and visual status indicators such as trend arrows, status gauges, and bullets.
You can view the modifier in the Alternative text property field of the image in the reporter template document.
If the image is included in an existing reporter template, for Corporater BMP to resize the image in the report output, manually add the modifier to the image's Alternative text property field.
