LogoLogo
API DocumentationIntegrationsPlexTrac.com
  • Product Documentation
    • Using This Site
    • Security Advisories
    • Deployment and Maintenance Policy
    • Supported Applications
  • PlexTrac Modules
    • Dashboard
    • Clients
      • Clients Components
      • Creating a Client
      • Managing Clients
      • Managing Client Users
      • Adding Assets to a Client
      • Managing Assets
    • Schedule
      • Schedule Components
      • Creating an Engagement
      • Requesting an Engagement
      • Managing Engagements
      • Engagement Status
    • Assessments
      • Assessment Components
      • Managing Questionnaires
      • Starting an Assessment
      • Taking an Assessment
      • Reviewing an Assessment
      • Submitting an Assessment
    • Reports
      • Report Components
      • Creating a Report
      • Adding from NarrativesDB
      • Editing a Report
      • Using Short Codes in Reports
      • Findings
        • Creating a Finding
        • Collaborative Editing
        • Importing Findings from a File
        • CSV Findings Templates
          • Using Report Findings CSV Template
        • Importing Findings via an Integration
        • Importing Findings from WriteupsDB
        • Finding Status
        • Creating Jira Tickets
        • CVSS Scoring
        • Affected Assets
      • Importing a Report
      • Exporting a Report
    • Priorities
      • Priorities Components
      • Creating a Priority
      • Linking Findings and Assets
      • Managing Priorities
      • Priorities Metrics
    • Content Library
      • Types of Repositories
      • NarrativesDB
        • NarrativesDB Home Page
        • Managing Repositories
        • Managing Users
        • Creating a Repository
        • Managing Sections
        • Creating a Section
      • WriteupsDB
        • WriteupsDB Home Page
        • Managing Repositories
        • Managing Users
        • Creating a Repository
        • Creating a Writeup
        • Copying a Writeup
        • Adding to a Report
        • Importing via CSV Template
      • RunbooksDB
        • RunbooksDB Home Page
        • Managing Repositories
        • Managing Users
        • Creating a Repository
        • Creating a Procedure
        • Creating a Technique
        • Creating a Tactic
        • Creating a Methodology
    • Analytics
      • Findings
      • Assets
      • Runbooks
      • Trends & SLAs
    • Runbooks
      • Managing Engagements
        • Starting an Engagement
        • Submitting an Engagement
      • Managing Test Plans
        • Creating a Test Plan
        • Exporting a Test Plan
  • Tenant Management
    • Account Management
      • Profile (Personal Settings)
        • Managing User Profile
        • Managing Password
        • Setting Up Two-Factor Authentication
      • Account Admin
        • Tenant Settings
          • Account Information
          • General Settings
          • Email Settings
          • Tags Settings
          • Service-Level Agreements (SLAs)
          • Short Codes
        • Customizations
          • Layouts
          • Templates
            • Report Templates
            • Export Templates
            • Style Guides
          • Theme
        • Automations
          • Risk Scoring
            • Creating Equations
            • Managing Priority Equations
          • Parser Actions
        • Integrations & Webhooks
          • Integrations (API)
            • Cobalt
            • Edgescan
            • HackerOne
            • Jira
            • ServiceNow
            • Tenable Vulnerability Management
            • Tenable Security Center
          • Webhooks
        • Security & User Management
          • Audit Log
          • Security
            • Authentication Methods
              • OAuth/OpenID Setup
                • Microsoft Entra ID
                • Google OAuth
                • Okta
                • OpenID Connect
              • SAML Setup
            • General Authentication Settings
            • Authorization
            • Role Based Access (RBAC)
              • Custom Roles
            • Classification Tiers
          • Users
            • Adding Users
            • Managing Users
        • Licensing
          • Licensing
          • Priorities
          • Plex AI
            • Using AI
        • White Labeling
      • Help Center
      • Logout
    • Integrations and File Imports
      • Acunetix
      • BlindSPOT
      • Burp Suite
      • Checkmarx
      • Core Impact
      • HCL AppScan
      • Invicti
      • Nessus
      • Nexpose
      • Nipper
      • Nmap (Assets)
      • Nmap Vulners NSE
      • Nodeware
      • NodeZero
      • OpenVAS
      • OWASP ZAP
      • Pentera
      • Qualys (VM Parser)
      • Qualys (Web App Scanner)
      • RapidFire
      • Scythe
      • Veracode
  • API Documentation
    • Overview
    • Concept Definitions
    • Getting Started
    • Retrieving Parameter IDs
    • Object Structures
      • Client Object
      • Report Object
      • Finding Object
      • Asset Object
      • Evidence Object
    • Use Cases
    • API Change Policy
      • API Change Log
    • Webhooks
      • Webhook Payload Structure
      • Verifying Sender Requests
Powered by GitBook

Resources

  • Privacy Policy
  • Terms of Use
  • Vulnerability Policy

© 2025 PlexTrac, Inc. All rights reserved.

On this page
  • Default Short Codes
  • Creating a Short Code
  • Editing Short Codes
  • Deleting Short Codes

Was this helpful?

Export as PDF
  1. Tenant Management
  2. Account Management
  3. Account Admin
  4. Tenant Settings

Short Codes

PreviousService-Level Agreements (SLAs)NextCustomizations

Last updated 1 year ago

Was this helpful?

The Short Codes button under "Tenant Settings" in the Admin Dashboard provides the ability to replace predefined strings or variables in a report with new values, reducing the need to edit each report. Using short codes makes report creation more efficient and reduces maintenance, as it reduces the time to edit.

Short codes can pull data from a report custom field or a client custom field, depending if the short code applies to all reports for a client or one specific report.

Default Short Codes

PlexTrac provides six short codes that pull data from non-custom fields and are listed on the Default tab. These variables cannot be modified or deleted.

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 report's name is 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.

Creating a Short Code

Step 1: From the Custom tab of the Short Codes page within the Admin Dashboard, click Create Short Code.

Step 2: Enter the appropriate values in the provided fields.

  1. Short Code field: The string inserted in reusable rich text fields that will be replaced after activation. Short Codes must follow the following rules:

    • Be a single string with no spaces

    • Begin and end with two percent symbols

    • No special characters other than an underscore and the aforementioned percent symbols

    • Follow the standard of %%MY_SHORT_CODE%% when “MY_SHORT_CODE” is the desired string

  2. Source field: The value from which the short code is replaced and can originate from either a report or client custom field.

  3. Custom Field Label field: 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 short code's Custom Field Label value ("Client Domain") used in a report.

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 on the Custom tab.

Editing Short Codes

Custom Short codes can be modified by clicking Edit in the "Actions" column of the applicable short code.

Deleting Short Codes

Custom short codes can be removed by clicking Delete in the "Actions" column of the applicable short code.

A modal will appear, confirming the action. Click Confirm Delete.

Step 4: Use the for use in all reports for a client, or use the .

short code at the client level
short code within a specific report