Using Short Codes in Reports

Short codes can significantly improve the efficiency of data representation. They can be created to represent specific data fields at the client and report levels.

With pre-defined codes, users can quickly insert data without manually entering lengthy information, saving time and effort during the report creation process. Moreover, standardized placeholders help maintain consistency in data presentation across different reports, ensuring a uniform format and structure that creates a professional and organized image.

Short codes provide flexibility and adaptability. They enable users to customize formats and update information without changing the underlying data. This ensures that reports are presented according to individual preferences and industry standards, minimizing the risk of errors and enhancing accuracy.

Short Codes are managed by admins in the Admin Dashboard.

Adding Custom Short Codes

Step 1: From the Reports module home page, click Readout under the "Actions" column of the report to edit.

Step 2: Click the Details tab.

Step 2: Click the Add new button at the bottom of the page under "Custom fields."

Step 3: In the first box on the left, add a label value to correspond with the short code, and in the second box on the right, insert the text value that will replace the short code.

This value will replace the short code used in the report's narratives or a finding's text fields.

Repeat the process to add another short code.

The short code value must exist and be set by an admin as a "Report Custom Field" for Source. If it does not, contact the admin to add it under "Tenant Settings>Short Codes."

The Custom Field label links the short code to the value (text data) that is to replace it. For example:

• Label: Contact Email

• Value (text data): [e-mail]

• Short Code: %%Contact_Email%%

Short Codes in the Admin Dashboard always begin and end with %% and have underscores rather than spaces.

Step 4: Use the short code in any report narrative. Changes will be autosaved.

Step 5: To activate the short codes, click Search & Replace at the top right of the page within the Reports module.

Step 6: The Search & Replace modal appears. Click Replace Short Codes to replace all short codes in the report with their corresponding text data.

Step 7: Click Confirm.

A confirmation message will appear.

Step 8: Validate that the change occurred as desired, assuming the short code exists in the tenant settings.

If the fields did not process as expected, kindly request the administrator to confirm their setup in the Admin Dashboard and ensure that the appropriate short code was utilized. Then, proceed to repeat steps 6-8.