Template Variables

Case Report Variables

These variables represent data contained within a report instance of a case.

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

These are template variables that reference your organization information entered into Monolith.

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

These are variables that reference the currently logged in Monolith user.

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

These are variables that contain data related to the current case you are generated a report for.

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

These are variables that contain data related to evidence items within a case.

Remember - the evidence object within a template is a list of evidence items. To use this data in a template, The values must be inside a loop:

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

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 }}

List of chain of custody records for this evidence item.

Chain of Custody Variables

The chain of custody records for an evidence item can be accessed by using the {{ item.coc }} variable listed above. The example below shows how to access COC records for each evidence item:

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

These are variables that contain data related to acquisition items within a case.

Remember - the acquisitions object within a template is a list of acquisition records. To use this data in a template, The values must be inside a loop:

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

These variables represent the data associated with notes created in Monolith. The notes contain rich text content as well as metadata that can be placed into a template report.

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.

PreviousReport Templates NextTemplate Examples

Last updated 2 months ago

Template Variables

Case Report Variables

These variables represent data contained within a report instance of a case.

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

These are template variables that reference your organization information entered into Monolith.

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

These are variables that reference the currently logged in Monolith user.

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

These are variables that contain data related to the current case you are generated a report for.

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

These are variables that contain data related to evidence items within a case.

Remember - the evidence object within a template is a list of evidence items. To use this data in a template, The values must be inside a loop:

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

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 }}

List of chain of custody records for this evidence item.

Chain of Custody Variables

The chain of custody records for an evidence item can be accessed by using the {{ item.coc }} variable listed above. The example below shows how to access COC records for each evidence item:

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

These are variables that contain data related to acquisition items within a case.

Remember - the acquisitions object within a template is a list of acquisition records. To use this data in a template, The values must be inside a loop:

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

These variables represent the data associated with notes created in Monolith. The notes contain rich text content as well as metadata that can be placed into a template report.

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.

PreviousReport Templates NextTemplate Examples

Last updated 2 months ago