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.
{{ 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.
These are template variables that reference your organization information entered into Monolith.
{{ 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.
These are variables that reference the currently logged in Monolith user.
{{ 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.
These are variables that contain data related to the current case you are generated a report for.
{{ 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.
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:
Evidence photos are stored in an array/list and must be referenced within for loop syntax.
{{ 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.
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:
{{ 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.
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:
{{ 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
Monolith allows you to make use of report templates, so you can create any reports you wish based on data within a Monolith case.
The template document must be a Microsoft Word document (DOCX).
In order to use a template, you must insert placeholders that Monolith recognizes as case variables that can be replaced with case data:
Be mindful of the placement of spaces within the template syntax - spaces matter.
Here is standard syntax for inserting basic values into a template -
Please ensure that there is a space at the start and end of the variable name.
At the time of report generation, Monolith will replace this template variable with the chosen data from the case:
Some data in a Monolith case consists of a list of items. For example, you may want to reference data from evidence items associated with a case. You may have ten evidence items in a case and you want that evidence data to be included in your templated report.
To do this, we need to use some special syntax to loop through the list of evidence items and output each item's data into the template report.
Here is the basic syntax to loop through a list of items in a template document:
The above syntax will loop through a list of evidence items (stored in the "evidence" variable} and output a vertical list of evidence numbers.
Loops are a very powerful way to create complex report templates and display just about any data that you want.
There is special syntax used to iterate through table rows - similar to the looping syntax above, you may want to iterate through a list and create table rows with data.
Lets create a table that contains rows for each evidence item and columns for the evidence number and evidence provider (manufacturer, make, etc...)
Given the following evidence data passed to the template from a case:
Template Syntax for table -
Generated Document Result -
The "tr" prefix denotes that we are creating a loop through table rows.
You'll notice that the table rows that have the start loop syntax and end loop syntax are not included in the final rendered table.
Using this syntax you can create tables with templated lists pulled in from Monolith.
There is more syntax available for templates, but the item listed about are the most common. If you need help with this or have more questions, reach out to us at support@monolithforensics.com.
