On this page
$template is the tool used for getting a template’s information.
$template.getName()
Return the name of a template.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.lang.String | Return a template name. |
$template.getResourcesLocation()
Return the folder location of the resource file.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.lang.String | The location of a resource file folder. |
$template.getTemplateFile()
Return a template filename.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.lang.String | Return a template file name. |
$template.getTemplateLocation()
In case, there is an included template, the latest included template location would be returned, otherwise, the main location of a template file will be returned.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.lang.String | The location of the latest included template file folder. |
$template.getMainTemplateLocation()
Return the folder location of the main template file.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.lang.String | The location of a main template file folder. |
$template.getOutputFile()
Return the output filename.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.lang.String | Return an output file name. |
$template.getOutputFileNoExt()
Return the output name.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.lang.String | An output name without a file name extension. |
$template.getOutputLocation()
Return the folder location of the output file.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.lang.String | Return the location of an output file folder. |
$template.getReportDataVariables()
Return Report Data variables from the selected Report Data.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | - | - | - |
| Return | - | java.util.Collection | A collection of Report Data variables. |
For example:
#foreach($variable in $template.getReportDataVariables()) $variable.name = $variable.value #end