Links

Short Codes

The Short Codes button under "Tenant Settings" in the Admin Dashboard gives the ability to replace predefined strings in a report with other values without having to edit each report. Short Codes can pull data from either a report custom field or a client custom field.
PlexTrac features several default short codes that pull data from non-custom fields and cannot be edited. These codes are listed on the page and identified with an asterisk.
Short Code
Source
%%CLIENT_NAME%%
The name of the client, as defined in the Create/Edit Client modal of the Clients module.
%%CLIENT_POC%%
The POC for the client, as defined in the Create/Edit Client modal of the Clients module.
%%CLIENT_POC_EMAIL%%
The client POC’s email address, as defined in the Create/Edit Client modal of the Clients module.
%%REPORT_NAME%%
The name of the report, as defined in the "Report Name" field of the Details tab in the Report module.
%%REPORT_START_DATE%%
The start date of the report, as defined in the "Start Date" field of the Details tab in the Report module.
%%REPORT_END_DATE%%
The end date of the report, as defined in the "End Date" field of the Details tab in the Report module.
Additional instructions exist in the Clients and Reports modules section on using short codes in reports.

Creating a Short Code

Step 1: Click Create Short Code.
Step 2: Enter values for the "Short Code," "Source," and "Custom Field Label" fields.
  • Short Code: This is the string that is inserted in re-useable rich text fields that will be replaced in a Report. Short Codes must follow the following rules:
    • Be a single string with no spaces
    • Begin and end with two percent symbols
    • Not use special characters other than an underscore and the aforementioned percent symbols
    • Follow the schema %%MY_SHORT_CODE%% where “MY_SHORT_CODE” is your desired string
  • Source: This is the value from which the short code is replaced; can originate from either report or client custom fields.
  • Custom Field Label: This is the value associated with the short code that will be entered in a client or report custom field to generate the replacement value. Below is an example of a Custom Field Label value of "Client Domain" being used in the Reports module next to the value to appear in the report (www.karbo.com):
Pro Tip: Report Custom Fields can be pre-populated from Report Templates.
Step 3: Click Save. The new short code is inserted at the bottom of the list.

Editing Short Codes

Find the short code to edit and click Edit.

Deleting Short Codes

Step 1: Find the short code to delete and click Delete.
Step 2: A modal will appear confirming action. Click Confirm Delete.
Click Next below to learn about the Customization admin options.