Documentation Index

Fetch the complete documentation index at: https://help.csgi.com/llms.txt

Use this file to discover all available pages before exploring further.

📢 Announcement:  Xponent Journey Hub, Bill Explainer, and Xponent Communication Control April 2026 (26.1) Release Notes are now available – Check out the latest updates published on April 2026.

Variables Management

Prev Next

The Communications Management module provides Client Admins with powerful tools to manage reusable variables within Xponent Communication Control, ensuring that editors and admins can work more efficiently when creating templates. It contains two primary features: Mapping and Customization and Categorization. Together, these features streamline how variables are defined, organized, and presented across the platform.

To access this module, click on the Communication Management icon located in the left-hand side menu bar, and then select Communication Management.

Within the Communication Management page, the navigation tabs in the top right-hand side of the interface allow users to switch between Mapping & Customization and Categorization. These tabs make it easy to move between different sections of content within the same interface without the need to load a new page.

Mapping and Customization

The Mapping and Customization feature enables Client Admins to define, organize, and simplify variables that will be reused in templates. Variables often originate from API sources and can have long or complex names that are difficult for editors to interpret. By mapping API variable names to friendly names, admins ensure clarity and consistency across the platform.

For Example: A complex API variable such as ACME_1234566 may represent a customer’s first name. Through variable mapping, this can be renamed to FIRST_NAME, making it clear to editors which value will populate that field during message composition. Along with the friendly name, admins can provide testing variables that allow editors to preview templates with real examples, ensuring accuracy and reducing confusion.

Searching Variables

Use the Search All bar to quickly locate variables by name, friendly name, or testing variable.

Deleting a Variable

Click on the delete icon next to a variable. Deletion removes the variable from the database and updates all templates. In Studio, the friendly name disappears from menus, and testing variables no longer display in previews, but the original API variable persists to maintain data links. Click Delete to confirm the variable deletion.

Note

Deleting a Variable Line affects the visualization of existing Templates in Studio. The Friendly Name will be removed from the menu list and replaced with its Original Variable Name. Additionally, the Testing Variable will no longer appear on the Preview. However, the variable itself will persist to maintain any existing data links.

Adding a Variable Line:

Click the + Add Variable option, enter the variable name, assign a friendly name, and (optionally) a testing variable.

Adding a Variable Line

Variable Name

The Variable Name is the original, system-recognized identifier for a field. It often comes directly from an API or database and follows strict naming rules (uppercase letters, numbers, underscores, no spaces, up to 50 characters). For Example: CUSTOMER_FIRST_NAME. This name is used behind the scenes during message delivery to resolve actual data.

Friendly Name

The Friendly Name is a simplified, human-readable label mapped to the variable name. It helps editors and strategists easily understand and select variables while creating templates. For Example: the variable name CUSTOMER_FIRST_NAME might be displayed as First Name in the editor. This improves clarity without affecting the backend data mapping.

Testing Variable

The Testing Variable provides a sample value for preview purposes. It allows editors to see realistic examples when designing templates. For instance, the friendly name First Name may have a testing variable such as John. During preview, the system inserts John so editors can confirm formatting and placement before the template is sent.

Variable names follow strict formatting rules to ensure consistency and system stability. A warning icon appears with a tooltip

  • Must be written in uppercase.

  • Can include letters (A-Z), numbers (0-9), and underscores (_).

  • Cannot contain spaces or special characters.

  • Variable name must begin with a letter or number.

  • Duplicate names are not allowed.

  • Must contain more than one character and be fewer than 50 characters in length.

  • Once a valid variable name is entered, the Save button becomes active. Click Save to add the newly created variable.

To maintain clarity and prevent conflicts, duplicate names are not allowed across Variable Names, Friendly Names, and Testing Variables.

Once a variable is created and saved, it becomes available for use across all template types, including MMS, SMS, and Email, allowing editors to easily insert it during template composition.

Categorization

The Categorization feature allows Client Admins to organize variables into categories. Instead of navigating a long, flat list of variables, editors can quickly locate the correct group, such as Transactional, Promotional, or Customer Profile, and insert variables more efficiently.

Categories can be tailored to organizational needs and may include both general-purpose groups. Admins can also create entirely custom categories. For Example: Promotional, Financial Services, or Pharmaceutical

To create a new variable category, follow these steps:

  1. Click on the + Add Category button.

  2. Enter the Category Name in the input field. The name must be between 3–30 characters, using only letters, numbers, or spaces.

    By default, the visibility toggle for the new category is enabled (ON), which means the category and its variables will be immediately visible in the editor.

  3. Click on + Add to begin adding variables to the category. In the variable selection panel, you can search for a variable by name or scroll through the list to locate it.

  4. Select the checkbox next to each variable you want to include. As you select variables, they appear as tags under the category. Once at least one variable has been selected, the Save button becomes visible.

  5. Click Save to confirm and create the category with the chosen variables. The new category is now added and displayed in the editor (unless the admin later disables the toggle to hide it).

Category Management

Category Management allows Client Admins to create, rename, delete, organize, and control the visibility of variable categories, ensuring editors can quickly find and use the right variables in templates.

Renaming a Category

Click on the ellipsis menu, select Rename, and enter the new name. Once saved, the updated name appears across the system.

Deleting a Category

Click on the ellipsis menu and select Clear All. The system displays a Variable Category Confirm Delete window. When confirmed, the category is removed from Studio. Variables remain available under the All category, preserving data integrity.

Display Toggle

New categories are visible by default in the editor.

  • When the toggle is switched ON, the category and its variables are accessible to editors.

  • When the toggle is switched OFF, the category is hidden from editors but still accessible to admins.

Sorting Categories

Category lists can be sorted alphabetically:

  • Hover: A sorting arrow appears to indicate that the column is sortable.

  • First Click: Sorts categories in ascending (A–Z) order.

  • Second Click: Sorts categories in descending (Z–A) order.

  • Default Behavior: Sorting is not applied until the admin interacts with the column header. The selected sort order remains until manually changed or the page is refreshed.

Drag and Drop

Variables can also be managed through drag-and-drop functionality. Dragging a variable tag from one category to another duplicates the variable into the new group while keeping it in the original group. Both versions behave consistently, with their assigned friendly names and testing values.

Tag Display and Variable Differentiation

Variables appear as tags with an “X” icon that allows for quick deselection. Tags help editors clearly see which variables are in use within a category.

Admins and editors must also be aware of the difference between API Variables and Client-Specific Static Content Variables. API variables pull live data at runtime (For Example: customer names or account balances), whereas static content variables represent reusable values defined by the client (For Example: company or brand names). Both can be grouped, mapped, and reused across templates, but static variables are maintained entirely within XCC rather than sourced from an API.