Home › Settings Reference
Settings Reference
All settings are managed in the module’s Settings page, grouped into four tabs. Changes are saved with Save Changes and applied immediately.
General
| Setting | Description | Notes |
|---|
| Support PIN Page Title | The title shown on the client-area Support PIN page. | Defaults to “Support PIN”. |
| PIN Length | Number of digits in the PIN code. | Default 6. Longer = more secure, harder to read aloud. |
| PIN Color | Hex color used to display the PIN. | Default #34c278 (green). Any valid hex color works. |
| PIN Font Size | Font size (px) used to display the PIN. | Default 35. |
| Copy to Clipboard | Show a copy-to-clipboard button next to the PIN. | Recommended ON for chat-based support. |
| Allow PIN Generation | Let clients generate and manage their own PINs. | When OFF, clients see a “generation disabled” message. |
| Allow Multiple PINs | Let a client hold more than one active PIN at once. | When OFF, generating a new PIN auto-expires the old one. |
Security & Expiry
| Setting | Description | Notes |
|---|
| Enable PIN Expiry | Expire PINs automatically after the configured time. | Recommended ON for temporary PINs. |
| Expiry Time (hours) | Number of hours before an active PIN expires. | Default 12. |
| Show Expiry Time | Display when the current PIN expires. | Shown on the client page and summary card. |
| Live Expiry Countdown | Show a live countdown to expiry on the client page. | Uses JavaScript; also shown on admin tables. |
| Mark PIN as Used | Adds a “Mark Used” button that sets a PIN to Used in lists, audit log and history. | Prevents PIN reuse after verification. |
| Hide PIN | Mask the PIN, showing only the last two digits (client area). | Admins always see the full PIN. |
| Remove Expired PINs | Automatically delete expired PINs older than 24 hours via the daily cron. | Keeps the tables clean; logged in the audit trail. |
| Setting | Description | Notes |
|---|
| Show Sidebar Widget | Display the Support PIN widget in the client-area sidebar. | |
| Sidebar Location | Primary or Secondary sidebar. | Secondary renders below primary panels. |
| Show Sidebar On Pages | Limit the widget to specific client-area pages (multi-select). | Leave unselected to show on every page. |
| Sidebar Display Order | Position of the widget from the top of the sidebar (0 = top). | Larger values move it further down. |
| Support Menu Link | Add a Support PIN link under the client-area Support menu. | |
Users & Notifications
| Setting | Description | Notes |
|---|
| Allow Sub-Users | Let clients grant PIN permission to their sub-users. | Adds a “Support PIN” permission to WHMCS users. |
| Sub-Users Generate Their Own PIN | Give each sub-user their own PIN. | Off = share the owner’s PIN. |
| Owner Notification | Email the account owner when a sub-user generates a PIN. | |
| Email PIN to Client | Email the newly generated PIN to the client. | Uses the module’s email template. |