# Configuration
Securely share confidential information in tickets with the Sensitive Data for Lagom WHMCS Client Theme (opens new window). This extension provides a secure way for your clients to share sensitive information, such as FTP credentials, database passwords, and other private data, directly within ticket conversations. All data is encrypted and only visible to authorized staff, ensuring full privacy and compliance.
By simplifying how sensitive information is exchanged, the extension improves communication and builds trust between you and your clients.
# Extension Views
# Sensitive Data
Displays a list of clients who have Sensitive Data assigned to them. A client appears in the list as soon as at least one Sensitive Data field has been added to any of their tickets. Once all sensitive data entries are removed, the client automatically disappears from the list.
- Search Feature - Quickly filter the client list by criteria such as client name, date, or ticket details.
- Sensitive Data - Displays the details on Sensitive Data for individual customers.
- Customer – Click the client's name to open their profile.
- Created – Date when the Sensitive Data was first added.
- Updated – Date when the Sensitive Data was last modified.
- Created By – Indicates who created the Sensitive Data (Client or Administrator).
- Updated By – Indicates who last modified the Sensitive Data (Client or Administrator).
- Manage Button - Opens the Assigned Sensitive Data list, showing all sensitive data entries across all tickets for the selected client.
# Assigned Data
On this page, you can view and manage Sensitive Data entries associated with individual tickets for a specific client.
- Ticket Details – Shows ticket ID, title, and status. Clicking the ticket ID opens the ticket in the WHMCS ticketing system.
- Search Feature – Filter entries by ticket ID, status, date, or other details.
- Copy Data – Copies the sensitive data to the clipboard for quick access.
- Edit Ticket Data – Allows you to edit the sensitive data for a selected ticket. Clicking opens the Edit Data page.
- Delete Ticket Data – Removes the sensitive data from the ticket and this list.
- Created/Edited Timestamps – Displays when the data was first added and last modified, along with the name of the user who created or updated the entry
# Edit Data
This page provides a dedicated markdown editor for adding, editing, and reviewing sensitive data in a selected ticket. It supports a wide range of formatting options, including text styling, code blocks, lists, and links, allowing you to organize and structure sensitive information effectively.
# Settings
This section allows you to configure the extension's settings, control access for different user roles, and manage field translations.
# General
This section provides the core configuration options for the extension, allowing you to control data handling, automated processes, and client data management settings.
Remove Sensitive Data on Ticket Close - Defines what happens with sensitive data when a ticket is closed.
- Automatically removes sensitive data when a ticket is closed, either by the client or the system - If selected, sensitive data will be deleted automatically when the ticket is closed — either manually by an admin in the WHMCS Admin Area or automatically by the system (for example, after a period of inactivity with the "Answered" ticket status configured in the WHMCS "Automation Settings").
- Ask the customer if they want to delete data upon ticket closure; the system will not remove it automatically - If selected, when the customer attempt to close the ticket, they will be prompted to confirm whether they want to delete the sensitive data linked to that ticket. The data will only be removed if the customer explicitly chooses to do so.
Allow Removal of Sensitive Data for Customers - When enabled, customers can manually delete their sensitive data using a "Delete" button. This gives them full control over the data they have shared.
# Access & Display
This section allows you to control which user roles can access and manage sensitive data, as well as where this data will be visible within the WHMCS Client Area and Admin Panel. The Sensitive Data extension provides three main types of permissions, each defining a different level of access and control over sensitive data.
# Access to Sensitive Data Extension
Grants full control over sensitive data, including viewing, editing, adding, and deleting entries. This permission provides comprehensive management capabilities within the RS Themes addon and extends functionality to the WHMCS Admin Area.
- RS Themes Addon: Full management of sensitive data through the "Sensitive Data Manager" extension.
- WHMCS Admin Area: Provides additional management options for sensitive data on the "Client Profile", "Ticket List", and "Ticket View" pages, including adding, editing, and deleting data.
# Access to Sensitive Data in WHMCS Admin Area
This permission provides basic (read-only) access to sensitive data, allowing users to view and copy information without modification rights.
# Display for Selected Support Departments
Controls which support departments have the Sensitive Data field available on the Open Ticket and View Ticket pages. This setting determines where clients can input sensitive data when creating or updating tickets.
# Translations
This section allows you to customize the text and labels displayed in the Client Area, ensuring a consistent user experience. You can modify the names, placeholders, alerts, and other text elements associated with sensitive data fields to match your brand tone and user communication style.
# Sensitive Data Fields in Open Ticket Page
- Tab Name - This is the name of the tab shown next to the standard message field. You can use it to label the section for sharing sensitive data. (Displayed on: Open Ticket and View Ticket pages)
- Textarea Placeholder - Placeholder text inside the secure markdown editor. Use it to show examples of what users can safely include, such as login credentials or access URLs. (Displayed on: View Ticket page)
- Description in "Sensitive Data" Tab - Text shown above the secure input field. It describes the purpose of the field and clarifies that the data will be encrypted and editable. (Displayed on: View Ticket page)
- Alert Content in "Sensitive Data" Tab - Short message placed above the secure editor, letting users know this area is safe for submitting passwords, keys, or other confidential data. (Displayed on: Open Ticket page)
- Alert Content in "Message" Tab - A warning shown above the default message field, reminding users not to include sensitive data there, and to use the dedicated Sensitive Data tab instead. (Displayed on: Open Ticket page)
# Manual Sensitive Data Removal Confirmation (Modal)
- Title - Defines the modal title shown when a user chooses to delete assigned sensitive data manually
- Description - Explains what will happen when the user deletes sensitive data. Appears above the confirmation checkbox.
- Confirmation Checkbox - Text shown next to the checkbox the user must tick to confirm permanent deletion of the data.
# Sensitive Data Removal on Ticket Closure (Modal)
- Confirmation Checkbox - Label displayed next to the checkbox shown when closing a ticket with assigned sensitive data.
# Logs
This section provides a log of all actions related to the extension, enabling you to track changes and actions over time.
- Search – Quickly locate specific log entries.
- Clear Logs – Remove all entries from the log.
- Log List – Displays details for each log entry:
- ID – Unique identifier for each log entry.
- Name – Description of the action taken, including links to related tickets and client profiles.
- Date – Date and time of the action.
- Delete – Option to remove a specific log entry.
# WHMCS Admin Area Views
This section covers the various views available to administrators and support staff within the WHMCS Admin Area. It includes client lists, ticket management, and data handling options that are accessible based on user permissions configured in the extension settings.
# Client List
The Client List view in the WHMCS admin panel provides a quick overview of all clients, including indicators for those who have Sensitive Data assigned. This view is designed to help administrators quickly identify and manage clients with sensitive data.
Permission Requirements:
To access the full range of actions in this view, the administrator must have the "Access to Sensitive Data Extension" and "Access to Sensitive Data in WHMCS Admin Area" permissions. Without this permission, the administrator will only see a tooltip with basic information about sensitive data, without the ability to perform any actions.
Available Actions:
- Manage – Redirects to the RS Themes addon, where administrators can manage all Sensitive Data entries for the selected client.
- Delete All – Triggers a confirmation modal, requiring administrators to confirm the deletion of all sensitive data entries assigned to the client.
# Client Profile
The Client Profile section allows administrators to view information about the number of Sensitive Data items assigned to the client. It provides a quick overview of sensitive data entries linked to individual tickets. The panel appears only if the client has at least one Sensitive Data entry associated with any ticket.
- Show – Expands the list of assigned sensitive data items.
- Manage – Redirects to the RS Themes addon for managing the sensitive data associated with the client. This button is visible only to administrators with the "Access to Sensitive Data Extension" permissions.
After clicking the "Show" button:
- Hide - Collapses the list of assigned sensitive data items, hiding their details.
- Manage – Redirects to the RS Themes addon for managing the sensitive data associated with the client. This button is visible only to administrators with the "Access to Sensitive Data Extension" permissions.
- Edit – Redirects to the RS Themes addon for detailed editing of the sensitive data.
- Remove – Opens a confirmation modal for removing the selected data entry.
# Ticket List
The Ticket List view allows administrators to quickly identify which tickets contain sensitive data. These tickets are marked with a shield icon next to the ticket ID, providing a clear visual indicator.
Administrators with the appropriate permissions can view, copy, edit, and delete sensitive data directly from the tooltip.
Available Actions:
- Edit – Opens the sensitive data editor within the RS Themes addon.
- Copy – Copies the sensitive data linked to the ticket.
- Delete – Removes the sensitive data from the ticket.
# Ticket View
The Ticket View page includes a section that displays information about sensitive data associated with the ticket. This section is designed to provide support staff with either read-only access to view sensitive data or full control to add, edit, and delete data, depending on their permissions.
Timestamps and User Information
- Created – Timestamp of when the sensitive data was first added to the ticket.
- Updated – Timestamp of the most recent update to the sensitive data.
- Created By – Indicates who originally added the sensitive data (Client or Administrator).
- Updated By – Indicates who last modified the sensitive data (Client or Administrator).
Show – Expands the section to display the sensitive data associated with the ticket.
When expanded, the section reveals the full sensitive data entry, along with additional management options for administrators with the appropriate permissions.
- Hide – Collapses the expanded sensitive data section.
- Edit Data – Allows direct editing of the sensitive data within the ticket view.
- Copy – Copies the sensitive data to the clipboard.
- Remove – Deletes the sensitive data from the ticket after confirmation.
# Assign Sensitive Data
If no sensitive data is linked to the ticket, support staff will see an appropriate message and the "Assign Sensitive Data" button. They will also see a link showing the number of other sensitive data entries assigned to the same client, which opens the Client Profile, where they can view all sensitive data entries associated with that client.
Clicking the "Assign Sensitive Data" button opens a markdown editor, allowing the administrator to add sensitive data. After making the necessary changes, clicking "Save Changes" will attach the sensitive data to the ticket.
# Client Area Views
The "Sensitive Data" extension allows clients to securely share sensitive information when opening and managing support tickets. It adds a dedicated "Sensitive Data" tab to the message creation area, providing a secure markdown editor for entering sensitive data. This feature helps clients keep sensitive details separate from regular ticket messages, ensuring a higher level of security. Check below how the extension looks on the various support pages in Client Area.
# Open Ticket
When creating a new ticket, users can easily add sensitive data by switching to the "Sensitive Data" tab. This tab provides a dedicated markdown editor for securely entering sensitive information, ensuring that sensitive data is kept separate from regular ticket messages.
To improve security, users are advised not to include sensitive information in the main "Message" tab. Instead, they should use the Sensitive Data tab to keep confidential details protected.
# View Ticket
The View Ticket page includes a Sensitive Data tab, allowing clients to add, view, edit, or delete sensitive data associated with a ticket. The availability of these actions depends on the settings configured in the extension.
Available Options:
- Preview – Opens a read-only view of the recorded sensitive data.
- Edit Data – Opens the markdown editor for updating existing sensitive data.
- Remove Data – Allows the client to delete sensitive data after confirming the action in a pop-up window.
# Ticket List
On the ticket list page, tickets containing sensitive data are marked with a green shield icon next to the ticket ID, indicating the presence of sensitive data.
# Translations
The Sensitive Data extension supports full localization using the language override system. This allows you to customize and manage translations by editing the appropriate file in: /templates/lagom2/core/lang/.
You can find a detailed guide in the Language Overrides documentation (opens new window).
# "Continue Editing" Button
The label "Continue Editing" appears after clicking "Preview" in the secure markdown editor (used on the "Open Ticket" and "View Ticket" pages). To change its text, add the following entry to your language override file:
'continue_editing' => 'Continue Editing',
# Tooltip on the Ticket List
To adjust the tooltip shown in the Client Area on the "Ticket List" page, use this entry:
'sensitive_data' => [
'tooltip' => 'Sensitive Data </br> assigned to this ticket',
# Disclaimer
The Sensitive Data extension is designed to enhance the security of sensitive information shared between clients and administrators. While the extension implements encryption and other security measures, it is crucial that users properly configure access controls to ensure that only authorized personnel can view or manage sensitive data.
The responsibility for maintaining the security and confidentiality of the sensitive data ultimately rests with the system administrators. Please ensure that all necessary precautions are taken to protect client data in accordance with industry standards and legal requirements.