< All Topics
Print

Customise The Wallboard

The wallboard is rendered using a HTML template and additional HTML files are used to render the components. A CSS file is used to format the styleing.

These files can be edited to your liking to customise the branding, layout and look of your wallboard.

You will find the editable files in the /whmcsroot/modules/addons/uptime_TicketBoard/html folder.

Three samples are included in subfolders, default, mint, and compact. You can copy the files in these folders to overwrite the template files. The existing files are the same as the default files and are provided as a backup. The mint theme is an example of a light-based display instead of the dark default. The compact theme is an example of modifying the files to show less information for a larger number of support departments.

The provided templates are reactive and will resize based on the screen and the zoom level of the browser.

An explanation of the html files follows:

Wallboard

WallBoard.html is the main html file and includes the AJAX javascript used to update the page. You can modify all aspects of this page to your liking. The page includes a number of form fields (which are all optional):

[[COMPANYNAME]] the company name set in WHMCS
[[DEPARTMENTS]] the render of the helpdesk department list
[[STATUSLIST]] the render of the helpdesk status count

The div with the id of divStaffOnline is populated with the current list of online admins.

The table with the id of tableActivity is used to populate the last 10 entries from the WHMCS log. The entries are rendered as table rows and columns.

The above components are updated via AJAX, the page itself is not refreshed only the content.

In the JavaScript at the end of the page you will see the following code:

window.setInterval(function () {
RefreshDisplay();
}, 60000);

The 60000 value is equivalent to 60 seconds and this is how often the content will be reloaded. Change this value to increase or decrease the refresh rate of the wallboard. Keep in mind that setting this value too low may impact on your the performance of WHMCS.

Departments

Department.html is the component used to display a single helpdesk department. This component is generated for each department the wallboard user has access to. The following form fields are used and are all optional:

[[DEPTNAME]] the name of the department
[[DEPTAWAITING]] the number of tickets that are awaiting a reply (e.g. new, in progress)
[[DEPTOPEN]] the number of active (not closed) tickets in the department

Status

Status.html is repeated for each ticket status you have set up in WHMCS. The following form fields are used and are all optional:

[[STATUSCOLOR]] the color of the status set in WHMCS
[[STATUSTITLE]] the name of the status
[[STATUSOPENCOUNT]] the number of tickets set to the status

Staff

Staff.html is repeated for each staff member that is online. The following form fields are used and are all optional:

[[USERNAME]] the name of the admin
[[LASTACCESS]] the last time they accessed WHMCS