Links
Comment on page

Custom Fields

Custom fields within a report are indispensable tools for enhancing the report's tags and personalization. These fields are commonly integrated into the cover page, allowing for the inclusion of dynamic information such as author names or specific data points relevant to the report's audience.
The user must access the Set Up code area to incorporate custom fields into a pre-built report export template. This coding section holds the blueprint for the report's layout and content, enabling users to define data sources, set display properties, and establish conditional logic for the custom fields.
Visit the Creating a Report page for more information on creating custom fields.
Report custom fields are exclusively utilized on the cover pages. Remove the Jinja calls from their cover page within the template if not needed.

Pre-Defined Custom Fields

The following custom fields are pre-defined in the Set Up code section of a pre-built report export template.
Custom Field Label
Jinja Reference
Author
{{ ss.author }}
Author Title
{{ ss.author_title }}
Author Email
{{ ss.author_email }}
Author Phone
{{ ss.author_phone }}
Company Name
{{ ss.company_name }}
Company Address
{{ ss.company_address }}

Configuring Code for Custom Fields

To retrieve the values of a report's custom fields, one must follow a specific two-step procedure and insert two lines of code within the Set Up Code section for each custom field.
Firstly, the user passes the label of the field as an argument to the function set_report_field_variable. This function is responsible for storing the value of the custom field. Secondly, the user creates a variable in the format ss.<my_label_name> and assigns it the value stored in "ss.report_field_value" using the command {{p set ss.my_label_name = ss.report_field_value }}.
Step 1: Navigate to the "REPORT CUSTOM FIELD SETUP" code section, found at the end of the Set Up code of the report export template.
Step 2: Place the cursor after the last set of highlighted text.
Step 3: Click Enter to create a new line for entering code.
Step 4: Insert the label of the custom field to the function "set_report_field_variable" with this syntax:{{p set_report_field_variable("FooBar")}}. This action stores the value of the custom field in the global variable ss.report_field_value.
Step 5: Click Enter and insert the second line: {{p set ss.my_label_name = ss.report_field_value }}, which creates the variable and assigns it the value of ss.report_field_value with a single command.

Examples

  • {{p set_report_field_variable(“Lead Penetration Tester”)}}
  • {{p set ss.lead_pentester = ss.report_field_value }}
  • {{p set_report_field_variable(“Version”)}}
  • {{p set ss.version = ss.report_field_value }}

Rendering Custom Fields

Once the custom field value has been retrieved, it can be displayed using the display command and the variable name. It is important to note that this data type is compatible with static text.
{{ ss.<my_variable_name>}}

Examples

  • Team Lead: {{ ss.team_lead }}
  • Team Lead Title: {{ ss.team_lead_title }}
© 2023 PlexTrac, Inc. All rights reserved.