The following table provides a list of variables you can use in your templates.
Variable Name | Description | Usage Scope |
|---|---|---|
Document information | ||
documentInfo.name | The name of the document. | Header, footer |
documentInfo.date | The last publishing date of the document. | Header, footer |
documentInfo.author.userName | The name of the user who published the latest version of the document. | Header, footer |
documentInfo.author.fullName | The full name of the user who published the latest version of the document. | Header, footer |
documentInfo.version | Version from which the document was published. | Header, footer |
Information about the project from which the document was published | ||
projectInfo.name | The name of the project name | Header, footer |
projectInfo.date | The last project modification date. | Header, footer |
projectInfo.author.userName | The name of the user who was last to modify the project | Header, footer |
projectInfo.author.fullName | The full name of the user who was last to modify the project | Header, footer |
projectInfo.version | Project version | Header, footer |
projectInfo.branchName | Name of the project branch | Header, footer |
Cover page information | ||
coverPage.image | The logo image as a byte array. The image is available if the document was published using the SysML for Cameo Collaborator template with a configured image. | Cover page |
coverPage.documentInfo | Information about the document. Check documentInfo for specific fields available for use, like coverPage.documentInfo.name | Cover page |
coverPage.projectInfo | Information about the project from which the document was published. Check projectInfo for specific fields available for use, like coverPage.projectInfo.name | Cover page |
coverPage.author.userName | The name of the user who exported the document. | Cover page |
coverPage.author.fullName | The full name of the user who exported the document. | Cover page |
coverPage.dateExported | Document export date. | Cover page |
coverPage.documentType | Document export type: DOCUMENT or COMMENTS | Cover page |
coverPage.branchIcon | Base 64 encoded branch icon image in the SVG format | Cover page |
exportFormat | Document export format: HTML or PDF | Cover page |