Template Variables

Reference the Monolith variables available for Custom Report Templates, including Case, Evidence, Chain of Custody, Acquisition, Note, organization, and user data.

Template Variables are the data fields available when building Custom Report Templates.

Use these variables inside a Microsoft Word .docx template to populate information from Monolith when a Case Report is generated.

This page is a reference for the supported variables and data objects available to report templates. For instructions on building templates, loops, tables, and conditional logic, see Custom Report Templates.

Using This Reference

Template data generally falls into two categories:

Single-value objects, such as Case, organization, user, or report information
Lists of records, such as Evidence Items, Acquisitions, Notes, or Chain of Custody entries

Single values can usually be inserted directly into a template:

{{ case.case_number }}

Lists must generally be used inside a loop:

{% for item in evidence %}
{{ item.evidence_number }}
{% endfor %}

Use the tables below to identify the variable name, data type, and information available to your template.

Start with a small number of variables and generate a test report before building more complex loops, tables, or conditional logic.

Case Report Variables

Case Report Variables contain information entered specifically for the report being generated, such as the Report Summary, Analysis, and Report Name.

These values come from the report workflow rather than directly from the underlying Case record.

Currently, the summary and analysis variables do not include any rich text formatting like bold, bullets, or underline. Pasted images are also not included in the template when generated.

Variable Name

Description

{{ report.summary }}

This is the report summary data that was entered into the summary tab of a Monolith case report.

{{ report.analysis }}

This is the analysis data that was entered into the analysis tab of a Monolith case report.

{{ report.name }}

This is the name of your report instance.

Organization Variables

Organization Variables reference information configured for your organization in Monolith.

These values are useful for report headers, organization details, contact information, and other reusable organization-level content.

Organization information is managed under Settings > Organization Info.

Variable Name

Description

{{ org.name }}

Name of your agency, company, or organization.

{{ org.address }}

Street address of organization.

{{ org.city }}

City location of your organization.

{{ org.state }}

State or province of your organization

{{ org.zipcode }}

Postal code of your organization

{{ org.email }}

Email set for your organization.

{{ org.website }}

Website URL set for your organization.

Current User Variables

Current User Variables reference the Monolith user generating the report.

These values can be used to include examiner or report-author information such as the user's name, email address, title, or assigned Office.

Variable Name

Description

{{ user.first_name }}

First Name of user. (Jane)

{{ user.last_name }}

Last name of user. (Doe)

{{ user.full_name }}

First name and last name combined. (Jane Doe)

{{ user.email }}

User email address.

{{ user.title }}

User title set in Monolith.

{{ user.office }}

Office location that the user is assigned to.

{{ user.user_id }}

Integer based user id stored by Monolith.

Case Variables

Case Variables contain information from the Case for which the report is being generated.

These values include identifying information, dates, Status, Type, Progress, Case Lead information, Description, and supported Case Custom Fields.

See Cases for information about the Case record and the metadata available throughout Monolith.

Variable Name

Type

Description

{{ case.case_id }}

Number

Integer based, unique id set by Monolith for the case.

{{ case.uuid }}

String

String based, unique id set by Monolith for the case.

{{ case.case_number }}

String

Case number for the case.

{{ case.case_name }}

String

Case name/reference set for the case.

{{ case.case_open_date }}

Date

Case open date in the format "YYYY-MM-DD".

{{ case.case_closed_date }}

Date

Case closed date in the format "YYYY-MM-DD".

{{ case.last_activity_date }}

Date

Case last activity date in the format "YYYY-MM-DD".

{{ case.case_status }}

String

Current status of case.

{{ case.case_type }}

String

Current case type.

{{ case.case_progress }}

String

Current progress status of case.

{{ case.description }}

String

Description of the current case.

{{ case.case_lead }}

{user_id, first_name, last_name, full_name, email, title}

Properties related to the user assigned as a case lead.

{{ case.custom_field_id }}

{name, value}

Case custom field value - replace 'id' with custom field id number.

Evidence Variables

Evidence Variables contain information from the Evidence Items selected for the report.

Because a Case can contain multiple Evidence Items, the evidence object is a list and its values must be referenced within a loop.

For example:

{% for item in evidence %}
{{ item.evidence_id }}
{% endfor %}

Evidence data can include identifying information, item metadata, Progress, Linked Contacts, Photos, Custom Fields, and Chain of Custody records.

See Evidence Items for information about the Evidence record in Monolith.

Evidence photos are stored in an array/list and must be referenced within for loop syntax.

Variable Name

Type

Description

{{ item.evidence_id }}

Number

Unique ID of evidence

{{ item.uuid }}

String

Unique ID of evidence

{{ item.evidence_number }}

String

Item evidence number

{{ item.evidence_type }}

String

Type of evidence

{{ item.provider }}

String

Service provider/manufacturer

{{ item.item_name }}

String

Item name

{{ item.capacity }}

Number

Size of item

{{ item.capacity_unit }}

String

Size units: KB, MB, GB, TB

{{ item.size }}

Number

Size of item

{{ item.size_unit }}

String

Size units: KB, MB, GB, TB

{{ item.description }}

String

Description of item

{{ item.progress }}

String

Progress status of item

{{ item.created_on }}

Timestamp

Creation Timestamp

{{ item.linked_contact }}

String

Name of linked contact

{{ item.evidence_photos }}

[{name, image}]

Array/list of evidence photos

{{ item.custom_field_id }}

{name, value}

Custom field value - ID is a number that uniquely identifies a custom field.

{{ item.coc }}

Chain of Custody List

List of chain of custody records for this evidence item.

Chain of Custody Variables

Chain of Custody records are available through the {{ item.coc }} list associated with each Evidence Item.

Because Chain of Custody is nested beneath Evidence, templates first loop through the selected Evidence Items and then loop through the Chain of Custody records associated with each item.

The example below demonstrates this nested relationship.

Chain of Custody Example:

// Loop through evidence items
{% for item in evidence %}

    // Loop through evidence item COC records
    {% for record in item.coc %}
    
        // Output COC record details
        {{ record.type }}
        {{ record.custody_to }}
        {{ record.custody_from }}
        {{ record.timestamp }}
        {{ record.reason }}
        
    // End loop for COC records
    {% endfor %}
    
// End loop for evidence items
{% endfor %}

Variable Name

Type

Description

{{ record.type }}

string

Type of COC record: Intake, Release, Move, etc...

{{ record.custody_to }}

string

Person or location that received the item.

{{ record.custody_from }}

string

Person or location that provided the item.

{{ record.timestamp }}

string

UTC timestamp of COC event.

{{ record.reason }}

string

Notes or reason provided for COC event.

Acquisition Variables

Acquisition Variables contain information from the Acquisitions selected for the report.

Because a Case can contain multiple Acquisitions, the acquisitions object is a list and must be referenced within a loop.

Acquisition data can include the acquisition name, type, format, size, date, examiner, linked Evidence, forensic software, Storage Item, duration, Contacts, and supported Custom Fields.

Example:
{% for item in acquisitions %}
{{ item.acquisition_id }}
{% endfor %}

Variable Name

Type

Description

{{ item.acquisition_id }}

Number

Unique ID of item.

{{ item.uuid }}

String

Unique ID of item.

{{ item.name }}

String

Name of item.

{{ item.description }}

String

Description of item.

{{ item.size }}

Number

Size of item in numbers.

{{ item.size_unit }}

String

Units of item size: KB,MB,GB,TB.

{{ item.format }}

String

Format of acquisition Ex. E01, DD, ZIP.

{{ item.type }}

String

Type of acquisition: Ex. File System, Physical, Chip-off.

{{ item.status }}

String

Active or Deleted.

{{ item.acquired_on }}

Date

Date of acquistion.

{{ item.created_on }}

Date

Date of record creation.

{{ item.acquired_by }}

{full_name, user_id, email, title}

The user that acquired this data.

{{ item.linked_contact }}

{name, contact_id}

The person that this acquisition is associated with.

{{ item.evidence }}

{evidence_id, uuid, evidence_number}

Evidence linked to acquisition.

{{ item.tool }}

{name, version}

Software uses to create acquisition.

{{ item.storage }}

{storage_id, uuid, storage_number}

Storage item where acquisition is stored.

{{ item.duration }}

{hours, mins}

Time spent creating acquisition.

{{ item.custom_field_id }}

{name, value}

Custom Field Value

Notes Variables

Notes Variables provide access to Notes selected for the report, including both Note metadata and rich-text content.

Because notes is a list, Note values must be referenced within a loop.

Note content can be rendered as either plain text or rich text. Use the r option when the generated Word report should preserve supported rich-text content, including pasted images.

Notes data can be accessed using the "notes" variable

In order to render the note content as rich text data within the Word document, be sure to use the following syntax:

// Notes template example
// use 'r' inside the template declaration to output the note content as rich text
// remove the 'r' to output as plain text data

{% for note in notes %}
{{r note.content }}
{% endfor %}

Similar to the evidence data, the 'notes' template data is a list of notes, so you must place the note template data inside of a loop to access it and display note content within the template report.

Variable Name

Type

Decription

{{r note.content }}

Rich Text or Plain Text

This is the note content - use 'r' to output as rich text. Includes pasted images as well.

{{ note.title }}

String

This is the note title

{{ note.uuid }}

String

This is the unique identifier assigned by Monolith to the note.

{{ note.created_on }}

ISO String

Creation timestamp of note

{{ note.updated_on }}

ISO String

Last Update time of note

{{ note.created_by }}

User Object

User that created the note

{{ note.linked_object }}

Object Link {

type: string,

name: string,

id: string

}

This is an object that is linked to the note such as a case, evidence item, or task.

Working With Template Variables

When building a Custom Report Template:

Copy variable names exactly as shown in this reference.
Use loops when working with Evidence, Acquisitions, Notes, and other lists of records.
Make sure every loop has a matching {% endfor %} statement.
Use the appropriate rich-text syntax when rendering Note content.
Test the template frequently as variables and logic are added.
Confirm that the underlying Monolith records contain the information you expect to appear in the report.

For complete template-building guidance, see Custom Report Templates.

For working examples and downloadable templates, see Template Examples.

PreviousCustom Report Templates

NextTemplate Examples

Last updated 13 days ago

Was this helpful?

Using This Reference

Case Report Variables

Organization Variables

Current User Variables

Case Variables

Evidence Variables

Chain of Custody Variables

Acquisition Variables

Notes Variables

Working With Template Variables

Related Documentation