How to add a screen color template in VICIdial

Adding a screen color template is how you create a reusable theme that any Campaign or in-group can later adopt. The form lives in the Screen Colors admin area, and you start a new one by clicking the add link at the top of the page. It looks like a lot of fields, but most of them are hex color values with sensible defaults already filled in, so a basic template takes only a minute or two to stand up.

Before you start, decide whether this template will be shared across the whole system or scoped to one team. That single decision drives the Admin User Group field, and getting it right now saves you from confusion later when an admin cannot find a palette you know you created.

Fill in the identity fields first

Start with the Colors ID. It must be at least 2 characters and no more than 20, with no spaces and no special characters. This is the internal identifier, so pick something stable and obvious. Next is the Colors Name, a free-text descriptive label that humans read in the pick-lists. Set the Active flag so the template can be selected, and leave the Admin User Group at --ALL-- unless you want to restrict which admins can see the record by User group.

Set the colors

1. Menu Background: the sidebar menu hex, default 015B91. Keep it dark because white text renders over it.
2. Frame Background: the main frame hex, default D9E6FE. Keep it light because black text renders over it.
3. Standard Row Backgrounds: five lighter hex values (defaults 9BB9FB, B9CBFD, 8EBCFD, B6D3FC, A3C3D6) used for sections and alternating rows.
4. Alternate Row Backgrounds: lighter hex values (defaults BDFFBD, 99FF99, CCFFCC) that differentiate sections from the standard set.
5. Web Logo: select your uploaded logo image for the template.

Getting the logo right

The Web Logo field is a select list, not a file uploader, so your image has to already be on the webserver before it can appear as an option. The standard logo size is 170 pixels wide by 45 pixels high, and PNG is the recommended format, though GIF and JPG work too. For an image to show up in the list, upload it to the images directory with a filename that begins with vicidial_admin_web_logo. For example, uploading vicidial_admin_web_logoSAMPLE.png makes it appear in the select list as SAMPLE.png. The default selection is default_new for the stock logo image.

The save-to-apply flow

flowchart TD
  A[Click add new Screen Color] --> B[Enter Colors ID and Name]
  B --> C[Set Active and Admin User Group]
  C --> D[Enter Menu and Frame hex values]
  D --> E[Enter row backgrounds and Web Logo]
  E --> F[Submit to save template]
  F --> G[Template appears in pulldowns]

Submitting the form saves the template but does not theme anything yet. The new entry simply becomes available in the Admin, Agent, and Chat Screen Colors pulldowns on the System Settings page. The full lifecycle of building and applying screen elements is covered in our agent screen configuration guide.

Common gotcha

The most common slip is entering a Colors ID with a space or a dash, which the form rejects. Enter hex values without the leading hash, exactly as the defaults are shown. If you also plan to drop in a custom image, read our notes on the logo specifics first; theming pairs nicely with a clean Agent script layout, and you can see how scripts are built in our guide to adding a VICIdial script.

Want this configured for you on a managed, ready-to-brand instance? Check VICIfast pricing and we will handle the hosting.