Using Short Codes in Reports
This page explains how to use Short Codes in reports.
Short Codes can help simplify report creation and encourage reuse of data to save content creation time and enforce consistency across reports. These codes can be used in report narratives and findings.
Default short codes can be used by inserting the value into the report narrative fields. For example: "The %%REPORT_NAME%% applies to all findings gathered during 2022."
In the above example, the value "%%REPORT_NAME%%" will dynamically be replaced with the value in the Report Name field.
Short codes added by the admin require an additional step, which is outlined below.
Step 1: Navigate to the Details tab of a report.
Step 2: Click Add Custom Field at the bottom.
Step 3: Add a label value in the first box on the left to correspond with the short code, and insert the text value that will replace the short code in the second box on the right.
This is the value that will replace the short code, whenever it is used in the narratives or findings text fields of the report.
Repeat as many times as desired.
Step 4: Click Save when finished.
The Custom Field label is the key linking the short code to the value (text data) that is to replace it. For example:
- Label: System Name
- Value (text data): Karbo Networks, LLC
- Short Code: %%SYSTEM_NAME%%
Step 5: Use the short code in any report narrative or text. Changes will be autosaved.
Step 6: From the Narrative tab, click Search & Replace at the top right of the page.
Step 7: The Search & Replace modal appears. Click Replace Short Codes to replace all short codes set in the report with their corresponding text data.
Step 8: Click Confirm.
A confirmation message should briefly appear.
Step 9: Validate that the change took place as desired, assuming the short code exists in the tenant settings. If not, ask the admin to add the value and do steps 6-9 again.
Click Next to learn how to add a custom finding.