Parametric elements
The system allows you to use parametric text sections, in order to display the values of the filters configured when defining the item, and some specific pieces of information of the generated reports. In order to display such information, the user must use a specific syntax.
The following table shows the accepted parametric elements and their syntax:
| Parameter | Syntax | Replaced value |
|---|---|---|
| Entity | ${Entity} | Code of the deployed entity filter . For hierarchy node: hierarchy code - node code EXAMPLE For a deployed Entity node (e.g. 010, 020, 030) by writing ${Entity}, the system will translate this instruction into '010', '020', '030' |
| Entity description | ${Entity.desc} | Description of the deployed entity node. For a hierarchy node: description of the hierarchy node |
| Entity attributes | ${Entity.attrib1} .. ${Entity.attrib5} | Value of attribute 1,..,5 of the deployed entity filter. For a hierarchy node, the resulting value is null |
| Category | ${Category} | Code of the deployed category filter. For a grouping node: grouping code - node code |
| Category description | ${Category.desc} | Description of the deployed category filter. For a hierarchy node: description of a hierarchy node |
| Custom dimensions | ${Dest1} ... ${Dest5} | Code of the custom dimension 1,..,5 deployed filter. For a hierarchy node: hierarchy code - node code |
| Custom dimensions description | ${Dest1.desc} ... ${Dest5.desc} | Description of the custom dimension 1,..,5 deployed filter For a hierarchy node: hierarchy node description |
| Custom dimension attributes | ${Dest1.attrib1} ... ${Dest5.attrib5} | Value of attribute 1,..,5 of the custom dimension 1,..,5 deployed filter For a hierarchy node the resulting value is null |
| Currency | ${Currency} | Code of the Currency filter |
| Currency description | ${Currency.desc} | Description of the currency filter |
| Scenario Year | ${Year} | Year of the Scenario filter |
| Scenario Code | ${Scenario} | Code of the Scenario filter |
| Period Code | ${Period} | Code of the Period filter |
| Period end date | ${Period.YYYY} ${Period.YY} ${Period.MM} ${Period.dd} | Period end date. The resulting value depends on the syntax used; more in detail: - ${Period.YYYY} the resulting value is yyyy (four digits year) - ${Period.YY} the resulting value is (two digits year) - ${Period.MM} the resulting value is MM (two digits month) - ${Period.dd} the resulting value is dd (two digits day) |
| Attributes of generated Filesi | ||
| Attribute | Syntax | Replaced value |
| Language | ${Language} | Language of the selected report |
| Date | ${Date} ${Date.YYYY} ${Date.YY} ${Date.MM} ${Date.DD} ${Date.hh} ${Date.mm} | File generation and / or distribution date. The resulting value depends on the syntax used; more in detail: - ${Date} the resulting value is YYYY_MM_hh_mm (YYYYyear, MM month, hh hours, mm minutes) - ${Date.YYYY} the resulting value is YYYY (four digits year) - ${Date.YY} the resulting value is YY (two digits year) - ${Date.MM} the resulting value is MM (two digits month) - ${Date.DD} the resulting value is DD (two digits day) - ${Date.hh} the resulting value is hh (two digits hour) - ${Date.mm} the resulting value is mm (two digits minutes) Only in "File name", if the syntax used is ${Date}, the resulting value will be: DD_MM (DD day, MM month) |
| File name | ${Filename} | Name chosen for the generated files The file name must contain less than 255 characters |
| Recipients | ${Recipient} | Code of the email recipient |
| Table | {Table(${},..,${})} | Within the body of the email, it is possible to insert a table whose rows and columns depend on the parameters "${}" between brackets. It is possible to insert all parameters described above but the attributes and their descriptions. EXAMPLE For a deployed entity filter (e.g. 010, 020, 030) and for a Custom dimension 2 node (e.g. 01,01) with its description, the table will have three columns(one for Entity, one for Custom dimension 2 and one for its description) as shown in the image below: |
Where to insert the parametric elements¶
The parametric elements described above can be inserted in: Email body and subject, Table, File name and Directory. Exceptions to this are the following parameters:
- Year of the scenario; it cannot be used in "Tabla" and "Directory"
- Recipient of the email; it cannot be used in "File name"
and some attributes of the generated file. For the file's attributes, see the following table:
| File attributes | Email object | Email body | Table | File name | Directory | |
|---|---|---|---|---|---|---|
| Language | ||||||
| Date | ||||||
| File name | ||||||
| Recipients |