There are a number of placeholders that can be used within report templates. These include global variables and functions, and various data types.
Global Variables
Name
Type
Description
static_data
dict
Contains the static data specified in the Static Data tab of the report template editor.
folder
Folder
Contains data related to the folder this report is being rendered for.
case
Folder
Alias of folder
snapshots
dict{string: Snapshot[]}
Snapshots selected by the report generator, grouped by snapshot container. Keys in the dict are the template names specified in the snapshot containers section of the report template editor.
report_signed_by
Signer
The signer of the report (if it is signed).
report_signed_at
datetime
When the report was signed (if it was signed).
Global Functions
Name
Description
template_file_by_name(name)
Get a URL to the file contents of a Report Template File by specifying its name.
template_file_by_id(id)
Get a URL to the file contents of a Report Template File by specifying its id.
Params
Name
Type
Description
name
string
The name of the report template file (must be exact).
id
string
The id (10 character alphanumeric) of the report template file.
Data Types
Some commonly used properties for folders, images, attachments and snapshots are listed.
Note: Some properties are omitted for brevity. The pprint filter in Jinja is useful for exploring the available properties in each variable.
Folder properties
Name
Type
Description
id
int
The ID of this folder.
name
string
The name of the folder.
description
string
The description of the folder.
attachments
Attachment[]
A list of attachments in this folder (i.e. non-image files).
images
Image[]
A list of images in this folder.
fields
dict
A dictionary mapping custom field names to custom field values.
Attachment properties
Name
Type
Description
id
string
The ID of this file.
name
string
The name of this file.
file_url
string
A URL to access the contents of this file.
filesize
int
The size of this file in bytes.
Image properties
Name
Type
Description
id
string
The ID of this image.
name
string
The name of this image.
filesize
int
The size of this image in bytes.
get_thumbnail(bounds)
function
Get a URL to access the thumbnail of this image.
get_region(area, bounds)
function
Get a URL to access a region from this image.
Params
Name
Type
Description
area
int[]
A region to extract from the image specified as [x, y, width, height] in pixel coordinates of the original image. If omitted or invalid, the requested image is omitted from the report.
bounds
int[]
A [width, height] pair in pixels that this image will be resized to fit within (if larger). If omitted, the requested image is returned unscaled and if invalid, the requested image is omitted from the report.
Snapshot properties
Name
Type
Description
id
int
The ID of this snapshot.
title
string
The title of this snapshot.
description
string
The description of this snapshot.
bounds
function
Get a URL to access this snapshot’s region image.
Params
Name
Type
Description
name
string
The name of the user that signed the report.
signature
string
A URL to the signature image of the report signer.
