Cisco Calling for Desktop Branding Guide
Release 22.6.9 Document Version 1
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE II
Cisco ® Guide
Notification The BroadSoft BroadCloud has been renamed to Cisco BroadCloud. Beginning in September 2018, you will begin to see the Cisco name and company logo, along with the new product name on the software, documentation, and packaging. During this transition process, you may see both BroadSoft and Cisco brands and former product names. These products meet the same high standards and quality that both BroadSoft and Cisco are known for in the industry.
Copyright Notice Copyright© 2018 Cisco Systems, Inc. All rights reserved.
Trademarks Any product names mentioned in this document may be trademarks or registered trademarks of Cisco Systems, Inc. or their respective companies and are hereby acknowledged.
This document is printed in the United States of America.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE III
Document Revision History
Release Version Reason for Change Date Author
22.6.0 1 Created document for Release 22.6.0. September 18, 2018 Veli-Pekka Heinonen
22.6.0 1 Edited and published document. September 25, 2018 Joan Renaud
22.6.0 2 Added and removed images and notes. October 16, 2018 Veli-Pekka Heinonen
22.6.0 2 Edited changes and published document.
October 17, 2018 Patricia Renaud
22.6.9 1 Made minor additions. November 1, 2018 Veli-Pekka Heinonen
22.6.9 1 Edited changes and published document.
November 5, 2018 Patricia Renaud
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE IV
Table of Contents
1 Summary of Changes ...................................................................................................................7
1.1 Changes for Release 22.6.9, Document Version 1 .................................................................... 7 1.2 Changes for Release 22.6.0, Document Version 2 .................................................................... 7 1.3 Changes for Release 22.6.0, Document Version 1 .................................................................... 7 2 Overview..........................................................................................................................................8
3 Branding Kit ....................................................................................................................................9
4 Branding Concepts Explained ................................................................................................. 11
5 Required Branding Elements ................................................................................................... 12
5.1 Application Name ...................................................................................................................... 12 5.2 Company Name ........................................................................................................................ 12 5.3 Brandable Strings such as BroadCloud Service Names......................................................... 13 5.4 Application Icon.......................................................................................................................... 14 5.5 Login Screen Background Image ............................................................................................. 15 5.6 URLs .......................................................................................................................................... 16 5.7 End-User License Agreement Text .......................................................................................... 16 5.8 Languages ................................................................................................................................. 17 5.9 Colors ......................................................................................................................................... 17
5.9.1 Basic Color Branding ........................................................................................................ 18 6 Optional ........................................................................................................................................ 20
6.1 Text ............................................................................................................................................. 20 6.2 Color Branding ........................................................................................................................... 20
6.2.1 Standard Color Branding .................................................................................................. 21 6.2.2 Advanced Color Branding ................................................................................................ 24
6.3 Images........................................................................................................................................ 30 6.3.1 General .............................................................................................................................. 30 6.3.2 Login Window ................................................................................................................... 32 6.3.3 Main Window .................................................................................................................... 33 6.3.4 Tabs ................................................................................................................................... 34 6.3.5 Contact Mouse Over ........................................................................................................ 34 6.3.6 Communications Buttons ................................................................................................. 35 6.3.7 Contacts View ................................................................................................................... 35 6.3.8 History View ...................................................................................................................... 36 6.3.9 Dial Pad ............................................................................................................................. 37 6.3.10 Advanced Call ................................................................................................................... 39 6.3.11 Call ..................................................................................................................................... 40 6.3.12 Notifications ....................................................................................................................... 42 6.3.13 Contact Card ..................................................................................................................... 43 6.3.14 Preferences ....................................................................................................................... 43 6.3.15 Call Recording .................................................................................................................. 45
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE V
6.3.16 Team Telephony ............................................................................................................... 45 6.4 Audio Tones ............................................................................................................................... 45 6.5 Brandable Add-ins – Standard HID Add-in .............................................................................. 47 6.6 Enable Third-Party Software ..................................................................................................... 47 6.7 Outlook Add-in Installer Integration .......................................................................................... 47 6.8 Disable Crash Reporter ............................................................................................................. 48 6.9 Disable Logging via Branding ................................................................................................... 48 6.10 Web Add-in for Microsoft Skype for Business ......................................................................... 48 6.11 Encryption Option for credentials_encrypted.db ...................................................................... 48 6.12 Google Analytics ........................................................................................................................ 49 6.13 Single Sign-On (SSO) ............................................................................................................... 49 6.14 SSO Enhancements .................................................................................................................. 49 6.15 Login URL List ........................................................................................................................... 50 6.16 Privacy Policy ............................................................................................................................. 51 6.17 TLS Certificate Validation .......................................................................................................... 51 6.18 Organization Name ................................................................................................................... 51 6.19 Call History Name Override ...................................................................................................... 51 7 SIP and HTTP User Agent Header Branding ......................................................................... 52
8 Client Version Number .............................................................................................................. 53
9 Automatic Upgrade .................................................................................................................... 54
Appendix A – Brandable Installer Strings ..................................................................................... 55
Acronyms and Abbreviations .......................................................................................................... 56
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE VI
Table of Figures
Figure 1 Desktop – Main Screen ............................................................................................................... 8 Figure 2 Branding Elements .................................................................................................................... 11 Figure 3 Desktop – Application Name in Window Title Bar ................................................................... 12 Figure 4 Desktop – Application Icon ........................................................................................................ 14 Figure 5 Desktop – Title Bar (Mac OS) ................................................................................................... 14 Figure 6 Desktop – Toaster Image .......................................................................................................... 14 Figure 7 Desktop – Login Screen (Windows) ......................................................................................... 15 Figure 8 Desktop – Simple Branding Sample 1 ...................................................................................... 18 Figure 9 Desktop – Simple Branding Sample 2 ...................................................................................... 19 Figure 10 Desktop – Standard Branding Sample ................................................................................... 23 Figure 11 Desktop – Advanced Branding Sample ................................................................................. 30
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 7
1 Summary of Changes
This section describes the changes to this document for each release and document version.
1.1 Changes for Release 22.6.9, Document Version 1 This version of the document includes the following change:
Added note about Cisco calling releases.
1.2 Changes for Release 22.6.0, Document Version 2 This version of the document includes the following changes:
Added images for visual voice mail.
Removed SSO images.
Added a correct reference for SSO.
Added notes to SSO section.
1.3 Changes for Release 22.6.0, Document Version 1 This version of the document includes the following change:
Created document for this release.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 8
2 Overview
Cisco developed a simple and quick process for branding. This document describes the required and optional elements that can be customized for Cisco Calling Desktop Release 22.6.9. Note that even though Cisco Calling 22.6.9 is identical in terms of functionality to Communicator 22.6.1, all Cisco Calling branding must use the 22.6.9 release.
The Desktop application runs as a native client on Windows and Mac OS. The following figure displays the Main screen.
Figure 1 Desktop – Main Screen
Perform the following steps to complete the branding process:
1) Review this document.
2) Download the branding kit.
3) Update the files in the branding kit and create as a zip file.
4) Review the Branding Portal Guide available in the Cisco Extranet using your Xchange account.
5) Go to the branding portal in the Cisco Extranet (again using your Xchange account) and complete the steps specified in the Communicator Desktop Deployment Guide to receive your branded clients.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 9
3 Branding Kit
Use the Cisco Calling Branding Resource Kit. This ZIP file contains default files that must be updated or replaced in a specific hierarchy. The location specified in the items in the following sections refers to the location of the file in the hierarchy specified by File Name. The ZIP file is available on Xchange at the following location: https://xchange.broadsoft.com/documentation/Business%20Communicator
If you have trouble with an Xchange link, copy and paste it into a web browser.
The branded build process has been updated to better identify branding projects.
In the branding zip file, each folder contains a ready branding kit for that branding option:
Basic Kit – Only the items needed for basic branding are included.
Standard Kit – Only the items needed for standard branding are included. This is the same as the basic kit but with more color codes.
Advanced Kit – All possible items are included in the kit for advanced branding.
Customers can select the branding kit they want by using the contents of the folder they need.
Also note that when doing advanced branding, there may be images in the branding kit that are not needed for the branding, these are to be left untouched. Furthermore, the branding kit is the authority over the branding guide for images, as the branding guide may list some currently unused images. The following list is the supported full directory structure for the branding kit. When using your own images, this structure must be followed in the branding kit used to make a branded build.
theme components VolumeSlider controls CheckBox CloseButton
presence smileys sounds windows CommunicationsWindow advanced_call Chat ContactCard DetailsPanel Dialpad MediaThumbnails Participants RoomApprovalDialog WebCollab
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 10
LoginWindow MainWindow ActiveCommunications ContactMouseOver Dialpad FullScreen History Presence Tabs Zoom
Notifications TeamTelephony
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 11
4 Branding Concepts Explained
The core concept of Cisco branding is to provide our customers with an easy and flexible process that allows them to convey their brand visual identity through the branding of images, colors, texts, and sounds.
There are two types of branding:
Required Branding – This branding requires the provisioning of basic branding elements such as the application name and logo.
All required elements are listed in section 5 Required Branding Elements. These are the mandatory elements needed to successfully complete the branding process.
Optional Branding – Requires Required Branding elements but includes additional brandable elements such as colors, texts, images, and sounds.
All available optional elements are listed in section 6 Optional.
Figure 2 Branding Elements
BRANDING
OPTIONAL REQUIRED
REQUIRED BRANDING ELEMENTS
COLORS - Standard Color Branding - Advanced Color Branding
TEXT
SOUNDS
IMAGES
APPLICATION NAME
COMPANY NAME
APPLICATION ICON
STRINGS
EULA
LANGUAGES
Login Screen Background Image
URLs
Basic Color Branding
Automatic Upgrade and Version Control File
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 12
5 Required Branding Elements
The required branding elements described in this section are the default minimum amount of branding for the application. Some items may be left as is depending on service provider Preferences.
5.1 Application Name The following list of text items are updated in all locations. Examples of these locations include the application folder, application executable name within the Main menu of the application, and About screen.
Figure 3 Desktop – Application Name in Window Title Bar
Application Name – The name of the product is displayed in the following areas:
Application icon ToolTips (in both Windows and Mac OS)
Application name displayed in Explorer (Windows) and Finder (Mac OS)
Window title bar
Start menu in Windows
Main menu in Mac OS
Toaster title bar
About dialog
Internal folder structure of the installation directory
Crash reporter
NOTE: The application name only supports traditional 7-bit ASCII characters in this release. For instance, Chinese characters are not supported for that reason. In addition, 7-bit ASCII character support has some limitations, the supported characters within 7-bit ASCII characters are numbers (for example, 1, 2, and 3), letters (for example, a, b, and c), space, and dash. Anything else can result in issues with the build.
5.2 Company Name Company Name is the name of the company that appears in copyright text. This can be changed. It is also used in the internal folder structure in the installation directory.
NOTE: The Company Name only supports traditional 7-bit ASCII characters in this release. For instance, Chinese characters are not supported for that reason. In addition, 7-bit ASCII character support has some limitations, the supported characters within 7-bit ASCII characters are numbers (for example, 1, 2, and 3), letters (for example, a, b, and c), space, and dash. Anything else can result into issues with the build.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 13
5.3 Brandable Strings such as BroadCloud Service Names A limited set of pre-selected strings that typically have been branded in deployments have been listed in the custom_translation_xx.csv (where xx denotes the language code) file in the translation kit for easier brandability. Service names are examples of such strings.
They are the names of BroadCloud services that appear in the Call Settings dialog. In addition, the description text for each service can be changed using the related item in the translation kit, which is part of the branding kit. Translation kits (translation/custom_translation_xx.csv file) also contain some other selected customizable strings that have been branded in many deployments. The Custom column in the file contains the desired texts.
However, the same file can also be used to customize other strings as long as the context and source text is listed in the .csv file and the number of these additional strings is limited. For details about how to obtain the context information, see the Communicator Language Guide.
Note that if a larger number of strings outside the set of pre-selected ones in the translation kit need to be customized, a different process is used instead of using the custom_translation_xx.csv file. This process is the same that is used for introducing new languages. For more information, see the Communicator Language Guide.
BroadCloud service name length restrictions no longer apply. However, caution is recommended to be used with modified service names as they are also used in accessibility menus.
Another special string that has been branded in other deployments is the “Unknown” string. This string is shown for incoming calls that are not from a contact in the contact list or for which the caller ID has been blocked. It is also included in the custom_translation_xx.csv file. In addition, the strings used in the Communications History for the same calls are different from this string.
The string used for the login dialog (typically used for blocking the 911 service in North America) can be branded and translated using the custom_translation_xx.csv file. The string is included there by default.
NOTE: The application name appears in the title bar of the application window and is limited to no more than 20 characters. Otherwise, the text may not fully display.
Text File Name Location
Application Name btbc_build.ini
Company Name btbc_build.ini
Service Names custom_translations_en.csv translation/
NOTE: Comma-separated value (CSV) files must have UTF-8 encoding without Byte Order Mark (BOM); otherwise, issues can occur when building branded builds in the branding service.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 14
5.4 Application Icon This icon/image appears on the user’s desktop, including in the task bar (Windows) and dock (Mac OS). The following lists the locations where the icon is used:
Windows title bar, task bar, and File Explorer (add/remove programs)
Toasters
Mac OS dock (top) and finder
Crash reporter
Installer
Figure 4 Desktop – Application Icon
Figure 5 Desktop – Title Bar (Mac OS)
Figure 6 Desktop – Toaster Image
File Name Dimensions (pixels) Description Location
clear.ico 16 x 16 (32-bit and 8-bit) 32 x 32 (32-bit and 8-bit) 48 x 48 (32-bit and 8-bit) 256 x 256 (32-bit and 8-bit)
Windows icon file icon/
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 15
File Name Dimensions (pixels) Description Location
BroadSoft.icns 16 x 16 (32-bit and 8-bit) 32 x 32 (32-bit and 8-bit) 64 x 64 (8-bit) 128 x 128 (8-bit) 256 x 256 (32-bit and 8-bit) 512 x 512 (32-bit and 8-bit) 1024 x 1024 (8-bit)
MACOS icon file icon/
NOTE: If you do not have an application to create .ico and .icns files, you can use the iConvert Icons Online tool (http://iconverticons.com). Provide the icons of varying sizes in one file as the iConvert tool does.
5.5 Login Screen Background Image The login screen image is displayed as a background on the screen and it should follow the specifications indicated. This image is placed at the top of the window and is displayed below all other elements (text fields, check boxes, buttons, and text).
Note that Cisco Calling is not currently using gamma correction; therefore, it is recommended to use png images in gamma neutral fashion. For instance, in Photoshop, images can be saved with “Embedded color profile” option unchecked. Additionally, all images in Cisco Calling branding must be either in 24-bit Red Green Blue (RGB) format or in 32-bit Red Green Blue Alpha (RGBA) format with alpha channel in order for the branding service validation of the branding kit to succeed. If the image has opacity, it will be in 32-bit format in general.
Figure 7 Desktop – Login Screen (Windows)
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 16
File Name Dimensions (pixels) Description Location
login_window_bg.png 570 x 200 Login screen background
theme/windows/Login Window
NOTE: The maximum height of the login screen background is 425 pixels. The screen appears as a background behind fields, check boxes, and text. If the height is more than 100 pixels, make sure that the image works with items on top of it. Provide the icons of varying sizes in one file as the iConvert tool does.
5.6 URLs The following URLs are used to navigate users to web sites:
Xsp (dm_url) – The Xtended Services Platform (Xsp) URL is used to access Xtended Services Interface (Xsi) and retrieve the configuration file. This is the login URL. In Release 22.3.2 and later, when using custom Xsp URLs, the URL needs to be fully provided as the client will not append anything to the custom Xsp URL.
Help (help_url) – This URL navigates users to the help page for the product in the Main window and the login window. The client also automatically adds a context parameter and a language parameter to the help URL: lang=xx, where xx is the language code in the same format that is used for building clients (for instance en=English or fr=French). The context parameter is the client view that was used when help was called. The web server utilized must understand these parameters if they are to be used. Otherwise, they are ignored.
Forgot password link (forgot_password_url) – Optional forgotten password link for the login window.
Text File Name
dm_url btbc_build_ini
help_url btbc_build_ini
forgot_password_url btbc_build_ini
5.7 End-User License Agreement Text The End-User License Agreement (EULA) is text that can be modified and is used in the installer. Two files are required: one for Windows and one for Mac OS. It is also possible to have many EULA files in different languages. In that case the correct language code must be used at the end of the EULA file name. Note that for each EULA language, a corresponding custom_translation file must also exist in the branding kit.
win_license_en.txt (Windows)
mac_license_en.txt (Mac OS)
The Windows file does not support any formatting.
The Mac OS file supports the following HTML tags:
<br> – Line break
<i></i> – Italic
<b></b> – Bold
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 17
File Name Location
win_license_en.txt translation/
mac_license_en.txt translation/
5.8 Languages The basic language package of Cisco Calling Desktop consists of and supports the following language:
English (U.S.) ‒ default
5.9 Colors Colors can be customized using color codes. However, in required branding, it is not mandatory to change the default color codes.
Color codes are divided into three levels of complexity. This section focuses on basic color branding which sets the main color scheme and offers a fast and easy way for branding the most commonly used branding elements.
To test colors press command+shift+alt+C+S (Mac OS) or Ctrl+Shift+alt+C+S (Windows) to display a dialog that allows for real-time updating of the interface colors (color picker tool). Note that some button color codes are not dynamically modifiable in this release with the tool but require re-login. Names in parentheses are the row names in the color scheme editor in the client. It is recommended that the Main window, dial pad, and Communications window be open to see the updates in the different windows. It is also recommended to have a toaster appear by having someone chat or call.
Use the Export button to save colors and to generate a .csv file to include in the branding kit folder structure. Note that modifying the info badge color codes does not fully work in the color picker tool.
File Name Description Location
colors.csv File containing the branded colors in CSV format.
theme/
All colors should be specified in Hex format: (#FFFFFF).
Color codes are divided into three levels of complexity. Standard and advanced color branding are described in this section while simple color branding is part of the basic branding. Color branding options:
Basic – Sets the main color scheme, part of required branding. This is the easiest way to adjust the colors by specifying a minimal set of colors.
Standard – Offers more flexibility in defining colors for major components (part of optional branding).
Advanced – Extends the standard branding color scheme, providing all colors used in the application (part of optional branding). These colors typically do not need to be modified. In general, advanced color branding is intended for design experts. Changes to standardized elements, such as alert colors and text colors, are not usually recommended.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 18
5.9.1 Basic Color Branding Using basic color branding is a simple and easy approach for setting a basic color scheme. Everything is computed for you to keep a coherent design throughout the application by simply modifying a small, core set of colors.
Main Application Colors
Sample text PrimaryBackground (has light text)
Sample text SecondaryBackground (has light text)
Sample text TertiaryBackground (has light text)
Sample text CellSelectedBackground (has dark text)
5.9.1.1 Basic Color Branding Sample 1
In this example, the customer only changes the PrimaryBackground and CellSelectedBackground color codes.
Figure 8 Desktop – Simple Branding Sample 1
PrimaryBackground
CellSelectedBackground
Defaults to PrimaryBackground
Defaults to PrimaryBackground
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 19
5.9.1.2 Basic Color Branding Sample 2
In this example, the customer changes all seven basic branding colors.
Figure 9 Desktop – Simple Branding Sample 2
PrimaryBackground
CellSelectedBackground
SecondaryBackground
TertiaryBackground
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 20
6 Optional
The following optional items allow for additional images, colors, and text to be branded.
6.1 Text The following text item can be customized:
Domain (optional) – Specify a default domain name, so users do not need to add the domain name to their user name. Note that this feature cannot be used when the BroadWorks alias feature causes different userids to be used.
Text File Name
default_domain btbc_build.ini
defaultFontFamily style.csv
The default font is Roboto, size 12. Changing the font size is not supported. Note that for some languages, the character set must be UTF-8 without BOM.
If the font is to be changed, (which is not recommended due to user interface side effects since font sizes differ), this must be specified in the style.csv file. If it is used, the style.csv file replaces colors.csv. Style.csv is almost identical to colors.csv, the only difference is that the utilized font is specified. Style.csv can also be generated using the color picker tool. command+shift+alt+f (Mac OS) or Ctrl+Shift+alt+f (Windows) enables font management in the tool. After enabling font management, exporting the color codes also exports the utilized font into the same file. An example row in the resulting csv file for font is as follows:
defaultFontFamily,Arial
6.2 Color Branding Color codes are divided into three levels of complexity. Standard and advanced color branding are described in this section while simple color branding is part of the basic branding. Color branding options:
Basic – Sets the main color scheme (part of required branding). This is the easiest way to adjust the colors, by specifying a minimal set of colors.
Standard – Offers more flexibility in defining colors for major components (part of optional branding).
Advanced – Extends the standard branding color scheme, providing all colors used in the application (part of optional branding). These colors typically do not need to be modified. In general, advanced color branding is intended for design experts. Changes to standardized elements, such as alert colors and text colors, are not usually recommended.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 21
6.2.1 Standard Color Branding Standard color branding adds more colors to the brandable palette, promoting a more distinctive visual appearance and boosting the brand identity. While simple branding allows only the branding of backgrounds, standard branding introduces the branding of several text colors.
Title Color # Value Example
PrimaryText Applies to all icons and text shown on PrimaryBackground.
#FFFFFF
SecondaryText Applies to all icons and text shown on SecondaryBackground.
#646464
NavIcon
#666666
SelectedNavIconBackground Applies to the hover state as well.
#25B6DA, Opacity 60% (defaults to CellSelectedBackground)
ChatSeparator
#F0F2F1, Opacity 20%
PrimaryButton Applies to avatar initials, profile buttons, buttons backgrounds, Advanced Call Control header, and menu items.
#25B6DA (defaults to PrimaryBackground) NOTE: The Cancel button will use a reversed color. Scheme used for the buttons with a solid color background fill.
PrimaryButtonReverse Text or icon appearing on PrimaryButton.
#FFFFFF
PrimarySeparator
#25B6DA (defaults to PrimaryBackground)
Icon #666666 (defaults to #2d2d2d)
SelectedIcon Applies to the icon hover state as well.
#2DBD9B (defaults to PrimaryBackground)
SelectedTab
#25B6BDA (defaults to PrimaryBackground)
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 22
Title Color # Value Example
SettingsHeaderBackground
#25B6DA (defaults to PrimaryBackground)
SettingsHeaderText
#FFFFFF
SelectedThumbnailOutline
#25B6DA (defaults to PrimaryBackground)
SelectedCallHistoryBackground
#e9f9fd (defaults to CellSelectedBackground)
CallHistoryIcon
#25B6DA (defaults to PrimaryBackground)
CallHistoryUnderline
#25B6DA (defaults to PrimaryBackground)
HighlightBackground
#25B6DA (defaults to PrimaryBackground)
HighlightText
#FFFFFF
AccentText Labels in Profiles and Settings
#25B6DA (defaults to PrimaryBackground)
LoginBackground
#FFFFFF (white is highly recommended)
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 23
6.2.1.1 Standard Branding Sample
The following sample has a number of standard branding elements changed.
Figure 10 Desktop – Standard Branding Sample
PrimarySeparator
SelectedIcon
PrimaryButton
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 24
6.2.2 Advanced Color Branding Advanced color branding allows all colors used for backgrounds, text, and images in the application to be branded.
Title Color Color Value Example
ContentBackground Left and right panes backgrounds, Profiles backgrounds, Selected tab, and Advanced Call options menu.
#FFFFFF (white is highly recommended)
Left Panes Background: Contacts, Call History, Dialpad, Web Links, and Settings.
Right Panes Background: Room Info and Profile Info.
Input Fields Background in: Login screen, all search fields, edit mode input fields.
Transfer, Conference, and Park Call.
Tabs Background
PrimaryContentText First line in lists, Selected Tab title, Status text in Profiles, second line in Profiles, Settings titles, and Web links second line.
#323232
PrimaryContentText is used over ContentBackground.
SecondaryContentText Second line in lists and Settings labels above dropdowns.
#646464
SecondaryContentText is used over ContentBackground.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 25
Title Color Color Value Example
TertiaryContentText Selected Tab Info.
#969696
TertiaryContentText is used over ContentBackground.
Headers
#323232
DimmedText Hints
#b4b4b4 All hint text.
Separators in all lists.
#f0f2f1
BadgeBackground
#FF6162
BadgeText
#FFFFFF
VolumeBarEmpty
#dcdcdc
ErrorText
#FF3347 (defaults to SymbolicRed)
UnselectedTabBackground
#F0F0F0
UnselectedTabSeparators
#25B6DA, Opacity 30% (defaults to SelectedTab, Opacity 30%)
UnselectedTabText
#969696
ContentSeparator
#25B6DA, Opacity 30% (defaults to SelectedTab, Opacity 30%)
SelectedThumbnailBackground
#25B5DA, Opacity 10%
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 26
Title Color Color Value Example
SelectedThumbnailText
#25B5DA
SelectedThumbnailIcon
#25B5DA , Opacity 50%
ThumbnailHoverOverlay
#000000, Opacity 50%
ThumbnailsBackground
#F0F2F1 (defaults to TertiaryBackground)
CallBackground Audio and Video calls background.
# F0F2F1 (defaults to TertiaryBackground)
CallBackgroundText
#FFFFFF
AppNotification
#FFDA00
AppNotificationBackground
#F8F8F8
AppNotificationText
#323232
AccentUnread
#FF6162
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 27
Title Color Color Value Example
LoginText Remember Password and Sign in Automatically.
#646464
LoginBottomText Version, Login, Help, and Options.
#323232
LoginBottomTextSelected Login or Options.
#2%B6DA (defaults to PrimaryBackground)
LoginCheckbox
#FFFFFF (checkbox fill is always white with 70% Opacity)
CallButton
#25B6DA (defaults to PrimaryBackground)
CallButtonReverse
#FFFFFF
HoverBackground
#FFFFFF, Opacity 10%
SwitchIndicatorOn
25B6DA (defaults to PrimaryBackground)
SwitchIndicatorOff
#b4b4b4
SwitchLineOn
2DBD9B, Opacity 30% (defaults to PrimaryBackground)
SwitchLineOff
#b4b4b4, Opacity 30%
IconSeparator
# f0f2f1
StatusTextBackground
#FFFFFF, Opacity 20%
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 28
Title Color Color Value Example
SelectedNavIcon
#666666 (defaults to NavIcon)
CallControlsBackground
# e9f9fd, Opacity 90%
TooltipBackground
#323232
TooltipText
#FFFFFF
RadioButtonOff
#b4b4b4
RadioButtonOn
#25B6DA (defaults to PrimaryBackground)
ToasterBackground
#FFFFFF
ToasterText
#646464
DropdownBackground
#f0f0f0
DropdownText
#323232
OutlineInputField
# e9f9fd(defaults to CellSelectedBackground)
DisabledBackground
#f8f8f8
ScrollBar
#969696
FocusRing
#96E3FF
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 29
Title Color Color Value Example
SelectedIconBar
#FF3347 (defaults to SymbolicRed)
CallIndicator
#28d47b (defaults to SymbolicGreen)
NotificationBackground #FFFFFF
NotificationOutline #B4B4B4
NotificationText #323232
Symbolic colors: These are colors that should remain roughly the same hue because they are being used for their color meanings. For example, “Red = dangerous”. These symbolic colors must always be used in a redundant way with other indicators (patterns for presence, labels for Call buttons), so there is no color blindness issue.
SymbolicGreen
#28D47B Merge call button – swipe (positive states or actions).
SymbolicRed Negative or destructive states or actions.
#FF3347 End call button, delete button.
SymbolicGray
#b4b4b4 Button in notifications.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 30
6.2.2.1 Advanced Branding Sample
This sample has a wide variety of branding changes.
Figure 11 Desktop – Advanced Branding Sample
6.3 Images
6.3.1 General Cisco Calling does not currently use gamma correction; therefore, it is recommended to use png images in gamma neutral fashion. For example, in Photoshop, images can be saved with the “Embedded color profile” option unchecked. Additionally, all images in Cisco Calling branding must be either in 24-bit RGB format or in 32-bit RGBA format with alpha channel.
This release has larger images that are approximately double the size in comparison to older releases. This has been done to have a better look and feel for retina displays. If images with the older, smaller size are used, machines with retina displays will not show them accurately.
Additionally, hover states are typically not done with separate buttons but using color codes instead. Therefore, those images have been removed.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 31
The following general items are used in various locations within the application. Note that native buttons such as OK and Cancel cannot be branded.
Image File Name W x H (pixels)
Location Description
checkbox_0.png 32 x 32 theme\controls\
CheckBox\ Displays an unchecked check box.
checkbox_1.png 32 x 32 theme\controls\
CheckBox\ Displays a checked check box.
close_normal.png 14 x 14 theme\controls\
CloseButton\ Displays an unchecked radio button.
close_hover.png 14 x 14 theme\controls\
CloseButton\ Displays a checked radio button.
loading_icon.gif 40 x 12 theme\ Displays when the application is loading or processing. Must be an animated gif.
dots.png 24 x 8 theme\ Displays on divider lines between adjustable sections in a window. May be displayed horizontally and vertically.
mac_menubar_icon.png
36 x 36 theme\ Shown in the Mac OS top bar as Cisco Calling icon.
Unicode_placeholder.png
16 x 16 theme\
ar6.png 22 x 22 theme\ Displays in drop-down lists on the Login window and can also display in drop-down lists on the Communications window.
avatar.png 160 x 160
theme\presence\ Displays when a user has not uploaded a picture for their avatar. Displays when a contact has not uploaded a picture for their avatar.
Avatar_small.png 60 x 60 theme\presence\ Displays when a user has not uploaded a picture for their avatar.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 32
Image File Name W x H (pixels)
Location Description
Avatar_callonly.png 160 x 160
theme\presence Displays in incoming call toaster and Call History when the caller is not a contact and only has a number.
Avatar_callonly_small.png
60 x 60 theme\presence Displays in incoming call toaster and Call History when the caller is not a contact and only has a number.
Avatar_group.png 160 x 160
theme\presence Group avatar used in, for example, History.
Avatar_group_small.png
60 x 60 theme\presence Group avatar used in, for example, History.
options_dotted_normal.png
44 x 44 theme\windows\ Dotted options button, on state.
6.3.2 Login Window The following items are used on the Login window.
Image File Name W x H (pixels)
Location Description
(No Sample Available)
bottom_logo.png 1 x 1 theme\windows\LoginWindow\
Displays at the bottom of the Login window below the version text line. Adding a bottom image moves the version text line above the bottom image. A height of 50 pixels tends to work well, but the height is variable.
back_normal.png 40 x 40 theme\windows\LoginWindow\
Login window back button.
settings_normal.png
40 x 40 theme\windows\LoginWindow\
Login window settings button to allow moving back to, for example, Device Management (DM) URL view.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 33
6.3.3 Main Window The following items are used on the left pane of the Main window and in the Main window top right (My Room icon).
Image File Name W x H (pixels)
Location Description
lp_contacts_normal.png
64 x 76 theme\windows\MainWindow\ Contacts button, on state.
lp_history_call_normal.png
64 x 76 theme\windows\MainWindow\ Call History button, on state.
lp_directory_normal.png
64 x 76 theme\windows\MainWindow\ Directory button, on state.
lp_dialpad_normal.png 64 x 76 theme\windows\MainWindow\ Dial pad button, on state.
lp_hub_normal.png 64 x 76 theme\windows\MainWindow\ Hub button, on state.
lp_extapp_normal.png 64 x 76 theme\windows\MainWindow\ External URL button, on state.
lp_callsettings_normal.png
64 x 76 theme\windows\MainWindow\ Button for the revised Call Settings toolbar in the left pane.
magnifying_glass.png 24 x 24 theme\windows\MainWindow\ In, for example, search and dial field.
email_normal.png 64 x 64 theme\windows\MainWindow\ In contact card.
new_contact_normal 68 x 64 theme\windows\MainWindow\ New contact button in new add tab UI.
new_group_normal.png 68 x 64 theme\windows\MainWindow\ New group button in new add tab UI.
new_tab_normal.png 56 x 56 theme\windows\MainWindow\ New tab button in new add tab UI, normal size. Used in the main window.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 34
Image File Name W x H (pixels)
Location Description
new_tab_small.png 22 x 22 theme\windows\MainWindow\ New tab
button in new add tab UI, small size. Used in the tab.
6.3.4 Tabs The following items are used in tabs.
Image File Name W x H (pixels)
Location Description
audio_call.png 22 x 22 theme\windows\MainWindow\Tabs
My Room button, on state.
tab_overflow_down_normal.png
43 x 44 theme\windows\MainWindow\Tabs
Contacts button, on state.
tab_overflow_right_normal.png
43 x 44 theme\windows\MainWindow\Tabs
Chat History button, on state.
video.png 22 x 22 theme\windows\MainWindow\Tabs
Call History button, on state.
6.3.5 Contact Mouse Over The following items are used for mouse over.
Image File Name W x H (pixels)
Location Description
call_normal.png 64 x 64 theme\windows\MainWindow\ContactMouseOver
Call button, on state.
info_normal.png 64 x 64 theme\windows\MainWindow\ContactMouseOver
Info button, on state.
videocall_normal.png 64 x 64 theme\windows\MainWindow\ContactMouseOver
Video call button, on state.
xsicall_normal.png 64 x 64 theme\windows\MainWindow\ContactMouseOver
Xsi call button, on state.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 35
6.3.6 Communications Buttons The following items are used in the bottom bar of the Main window and in the bottom bar of the Communications window when used.
Image File Name W x H (pixels)
Location Description
call_normal.png 64 x 64 theme\windows\MainWindow\ Call button.
xsi_call_normal.png
64 x 64 theme\windows\MainWindow\ Call from Phone button.
videocall_normal.png
64 x 64 theme\windows\MainWindow\ Video Call button, on state.
6.3.7 Contacts View The following items are used in contacts view.
6.3.7.1 General
The following items are used for search, filter, add, and favorites.
Image File Name W x H (pixels)
Location Description
search_close.png 16 x 16 theme\windows\MainWindow\ Close button in search field.
6.3.7.2 Active Communications
The following items are used for active communications.
Image File Name W x H (pixels)
Location Description
activecommunication_end_normal.png
40 x 60 theme\windows\MainWindow\ActiveCommunications\
End Call button, normal state.
activecommunication_end_deskphone_normal.png
40 x 60 theme\windows\MainWindow\ActiveCommunications\
End Call from Phone button, on state.
activecommunication_decline_deskphone_normal.png
80 x 56 theme\windows\MainWindow\ActiveCommunications\
Decline Call from Phone button, on state.
activecommunication_mergecall_normal.png
130 x 56 theme\windows\MainWindow\ActiveCommunications\
Merge Call button, on state.
activecommunication_mute_normal.png
44 x 44 theme\windows\MainWindow\ActiveCommunications\
Mute button, on state.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 36
Image File Name W x H (pixels)
Location Description
activecommunication_hold_normal.png
44 x 44 theme\windows\MainWindow\ActiveCommunications\
Hold button, on state.
activecommunication_answer_deskphone_normal.png
80 x 56 theme\windows\MainWindow\ActiveCommunications\
Answer call from desk phone.
activecommunication_conference_normal.png
44 x 44 theme\windows\MainWindow\ActiveCommunications\
Extra button for conference, normal state.
activecommunication_park_normal.png
44 x 44 theme\windows\MainWindow\ActiveCommunications\
Extra button for call park, normal state.
activecommunication_transfer_normal.png
44 x 44 theme\windows\MainWindow\ActiveCommunications\
Extra button for call transfer, normal state.
activecommunication_call_pull_normal.png
44 x 44 theme\windows\MainWindow\ActiveCommunications\
Extra button for Xsi call pull.
activecommunication_start_normal.png
80 x 56 theme\windows\MainWindow\ActiveCommunications\
Start call button.
activecommunication_startdecline_normal.png
80 x 56 theme\windows\MainWindow\ActiveCommunications\
Decline call button.
activecommunication_startvideo_normal.png
80 x 56 theme\windows\MainWindow\ActiveCommunications\
Start video call button.
Note that minimum width of the Main window increases for each extra active communications button added.
6.3.8 History View The following items are used in History view.
Image File Name W x H (pixels)
Location Description
history_incoming_normal.png
18 x 18 theme\windows\MainWindow\History\
Incoming call indicator
history_outgoing_normal.png
18 x 18 theme\windows\MainWindow\History\
Outgoing call indicator
history_missed_normal.png 18 x 18 theme\windows\MainWi
ndow\History\ Missed call indicator
timeline_call_tab_normal.png
48 x 48 theme\windows\MainWindow\History\
Icon for Calls tab
timeline_vm_tab_normal.png
48 x 48 theme\windows\MainWindow\History\
Icon for visual voice mail (VVM) tab
vm_audio.png 18 x 18 theme\windows\MainWindow\History\
VVM audio message icon
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 37
Image File Name W x H (pixels)
Location Description
vm_fax.png 18 x 18 theme\windows\MainWindow\History\
VVM fax message icon
vm_pause_normal.png 40 x 40 theme\windows\MainWi
ndow\History\ Icon for pausing voice mail
vm_play_normal.png 40 x 40 theme\windows\MainWi
ndow\History\ Icon for playing voice mail
Vm_video.png 18 x 18 theme\windows\MainWindow\History\
VVM video message icon
vm_urgent.png 2 x 15 theme\windows\MainWindow\History\
VVM urgent message icon
vm_confidential.png 13 x 15 theme\windows\MainWindow\History\
VVM confidential message icon
history_hunt_group_normal.png
18 x 18 theme\windows\MainWindow\History\
Hunt group icon
6.3.9 Dial Pad The following items are used in the dial pad.
Image File Name W x H (pixels)
Location Description
delbutton_normal.png
60 x 34 theme\windows\MainWindow\Dialpad\
Delete button, normal state
dialpad_1_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
1 button, normal state
dialpad_2_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
2 button, normal state
dialpad_3_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
3 button, normal state
dialpad_4_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
4 button normal state
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 38
Image File Name W x H (pixels)
Location Description
dialpad_5_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
5 button, normal state
dialpad_6_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
6 button, normal state
dialpad_7_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
7 button, normal state
dialpad_8_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
8 button, normal state
dialpad_9_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
9 button, normal state
dialpad_star_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
Star button, normal state
dialpad_0_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
0 button, normal state
dialpad_hash_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
Hash button, normal state
dialpad_voicemail_normal.png
140 x 100
theme\windows\MainWindow\Dialpad\
Voice mail button, normal state
call_normal.png 252 x
152 theme\windows\MainWindow\Dialpad\
Audio call button, normal state
videocall_normal.png
108 x 88 theme\windows\MainWindow\Dialpad\
Video call button, normal state
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 39
Image File Name W x H (pixels)
Location Description
xsi_call_normal.png
108 x 88 theme\windows\MainWindow\Dialpad\
Xsi call button, normal state
6.3.10 Advanced Call The following items are used in advanced call view.
Image File Name W x H (pixels)
Location Description
check_mark.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Dial pad button, on state.
conference.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Mute button, on state.
dialpad.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Speaker volume button, on state. The rest of the volume slider is done in code.
large_conference_no_contact_selected.png
110 x 110
theme\windows\CommunicationsWindow\advanced_call
Speaker volume button, hover state. The rest of the volume slider is done in code.
large_transfer_no_contact_selected.png
110 x 110
theme\windows\CommunicationsWindow\advanced_call
Active speaker animated gif in Meet-Me moderator controls.
park_call.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Meet-Me moderator controls in chat indication, normal.
pause_recording.png 24 x 24 theme\windows\Co
mmunicationsWindow\advanced_call
Meet-Me moderator controls in call indication, normal.
record_call.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Call recording, enabling.
resume_recording.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Call recording, resuming.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 40
Image File Name W x H (pixels)
Location Description
search.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Search icon.
stop_recording.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Stop recording icon.
transfer.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call
Transfer icon in call tab.
speakers.png 26 x 24 theme\windows\CommunicationsWindow\advanced_call
Unmute icon in call tab.
volume.png 26 x 19 theme\windows\CommunicationsWindow\advanced_call
Volume icon in call tab.
audio_device.png 17 x 26 theme\windows\CommunicationsWindow\advanced_call
Unmute icon in call tab.
headset.png 24 x 25 theme\windows\CommunicationsWindow\advanced_call
Unmute icon in call tab.
6.3.11 Call The following items are used in Call tabs in general.
6.3.11.1 Tab Controls
The following items are used for call control in the Call and Chat tabs.
Image File Name W x H (pixels)
Location Description
comm_mute_normal.png 64 x 64 theme\windows\CommunicationsWindow\
Mute button, on state.
full_screen_mute_indicator.png
104 x 160 Theme\windows\CommunicationsWindow\
Full screen mute indicator.
info_normal.png 64 x 64 theme\windows\CommunicationsWindow\
Hides or shows the additional info in tab.
my_video_normal.png 72 x 61 theme\windows\CommunicationsWindow\MediaThumbnails
Own video button.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 41
Image File Name W x H (pixels)
Location Description
video_normal.png 72 x 61 theme\windows\CommunicationsWindow\MediaThumbnails
Video button.
volume_normal.png 24 x 24 theme\components\VolumeSlider\
Volume control.
volume _muted.png 24 x 24 theme\components\VolumeSlider\
Speaker volume button, hover state. The rest of the volume slider is done in code.
participant_incall_normal.png
40 x 50 theme\windows\CommunicationsWindow\Participants\
Meet-Me moderator controls in call indication, normal.
activespeaker.gif 36 x 4 theme\windows\CommunicationsWindow\Participants\
Active speaker animated gif in Meet-Me moderator controls.
Secure_call_indicator_normal.png
14 x 18 theme\windows\CommunicationsWindow\
Secure Call icon.
6.3.11.2 Dial Pad
The following items are used for the dial pad in Call windows.
Image File Name W x H (pixels)
Location Description
dp1_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
1 button, on state
dp2_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
2 button, on state
dp3_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
3 button, on state
dp4_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
4 button, on state
dp5_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
5 button, on state
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 42
Image File Name W x H (pixels)
Location Description
dp6_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
6 button, on state
dp7_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
7 button, on state
dp8_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
8 button on state
dp9_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
9 button, on state
dpstar_normal.png
104 x 70 theme\windows\CommunicationsWindow\Dialpad\
Star button, on state
dp0_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\
0 button, on state
dphash_normal.png
104 x 70 theme\windows\CommunicationsWindow\Dialpad\
Hash button, on state
6.3.12 Notifications The following items are used in communication notifications.
Image File Name W x H (pixels)
Location Description
reply_audio_normal.png
52 x 52 theme\windows\ Notifications\
Answer with audio button, on state.
reply_reject_normal.png
52 x 52 theme\windows\ Notifications\
Ignore call button, active state.
reply_video_normal.png
52 x 52 theme\windows\ Notifications\
Answer with video button, active state.
reply_no_video_normal.png
52 x 52 theme\windows\ Notifications\
Answer video with audio only button, active state.
reply_ignore_normal.png
16 x 16 theme\windows\ Notifications\
Ignore call button, active state.
webpop_normal.png
44 x 42 theme\windows\ Notifications\
Web pop button, active state.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 43
Image File Name W x H (pixels)
Location Description
Hub_normal.png
200 x 200 theme\windows\ Notifications\
Hub icon used in error situations.
Weblinks_normal.png
194 x 200 theme\windows\ Notifications\
Web link icon used in error situations.
6.3.13 Contact Card The following items are used in contact card tab and window.
Image File Name W x H (pixels)
Location Description
contactcard_add_normal.png
64 x 64 theme\windows\CommunicationsWindow\ContactCard\
Add Contact button, on state.
contactcard_checkmark_normal.png
64 x 64 theme\windows\CommunicationsWindow\ContactCard\
Save changes button, on state.
contactcard_cancel_normal.png
64 x 64 theme\windows\CommunicationsWindow\ContactCard\
Cancel changes button, on state.
Contactcard_delete_normal.png
64 x 64 theme\windows\CommunicationsWindow\ContactCard\
Delete contact card button, on state.
contactcard_importl_normal.png
64 x 64 theme\windows\CommunicationsWindow\ContactCard\
Import data button, on state.
fav_star_contact_card_on.png
44 x 44 theme\windows\CommunicationsWindow\ContactCard\
Favorite checked.
fav_star_contact_card_off.png
44 x 44 theme\windows\CommunicationsWindow\ContactCard\
Favorite unchecked.
contactcard_edit_normal.png
64 x 64 theme\windows\CommunicationsWindow\ContactCard\
Edit button, on state.
6.3.14 Preferences The following items are used in the Preferences view in the Main window.
Image File Name W x H (pixels)
Location Description
settings_advanced_list_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Advanced view in the Preferences drop-down menu list in Main window used to select a view.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 44
Image File Name W x H (pixels)
Location Description
settings_advanced_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Advanced view title in the Preferences view in Main window.
settings_extensions_list_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Extensions view in the Preferences drop-down menu list in Main window used to select a view.
settings_extensions_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Extensions view title in the Preferences view in Main window.
settings_general_list_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the General view in the Preferences drop-down menu list in Main window used to select a view.
settings_general_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the General view title in the Preferences view in Main window.
settings_incomingcalls_list_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Incoming Calls view in the Preferences drop-down menu list in Main window used to select a view.
settings_incomingcalls_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Incoming Calls view title in the Preferences view in Main window.
settings_media_list_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Media view in the Preferences drop-down menu list in Main window used to select a view.
settings_media_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Media view title in the Preferences view in Main window.
settings_outgoingcalls_list_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Outgoing Calls view in the Preferences drop-down menu list in Main window used to select a view.
settings_outgoingcalls_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Outgoing Calls view title in the Preferences view in Main window.
settings_services_list_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Services view in the Preferences drop-down menu list in Main window used to select a view.
settings_services_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Services view title in the Preferences view in Main window.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 45
Image File Name W x H (pixels)
Location Description
settings_voicemail_list_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Voice Mail view in the Preferences drop-down menu list in Main window used to select a view.
settings_voicemail_normal.png
40 x 40 theme\windows\MainWindow\
Icon used for the Voice Mail view title in the Preferences view in Main window.
6.3.15 Call Recording The following item is used in the Communications window for call recording.
Image File Name W x H (pixels)
Location Description
rec_indication_normal.png
16 x 16 theme\windows\ CommunicationsWindow
Displays recording sign for calls.
6.3.16 Team Telephony The following items are used in the Team Telephony window.
Image File Name W x H (pixels)
Location Description
blf_available.png 24 x 24 theme\windows\ TeamTelephony
Available presence icon for Team Telephony contact item.
blf_incall.png 24 x 24 theme\windows\ TeamTelephony
In call presence icon for Team Telephony contact item.
blf_offline.png 24 x 24 theme\windows\ TeamTelephony
Offline presence icon for Team Telephony contact item.
blf_ringing.png 24 x 24 theme\windows\ TeamTelephony
Ringing presence icon for Team Telephony contact item.
6.4 Audio Tones The audio tones can be customized. The custom tones are added to the branded client by creating a folder named Sounds inside the Theme folder and placing a file with the exact same name specified in the following table. Only the tones that are to be customized should be included in the folder, while all other tones use the default audio for that tone.
File Name Purpose
calling.wav Ringback tone played before callee picks up the call.
call_waiting.wav Tone for call waiting.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 46
File Name Purpose
busy.wav Local busy tone in case network does not provide audible feedback for busy line.
congestion.wav Tone for calls that fail due to congestion.
incoming_message.wav Tone for received chat messages.
ringing.wav Default ringtone.
digital1.wav Alternative ringtone.
digital2.wav Alternative ringtone.
mobile1.wav Alternative ringtone.
mobile2.wav Alternative ringtone.
mobile3.wav Alternative ringtone.
moog.wav Alternative ringtone.
moogdualtone.wav Alternative ringtone.
phone.wav Alternative ringtone.
tune.wav Alternative ringtone.
dr2_LongLong.wav Priority alert tone long long.
dr3_ShortShortrLong.wav Priority alert tone short short long.
dr4_ShortLongShort Priority alert tone short long short.
dr5_RingSplash.wav Priority alert tone for ring splash. The Sounds folder may also contain an XML file to define alternate names for the tones. Name the ring_signals.xml file and use the format of the following example file. The text in the description attribute is displayed in the client UI.
<?xml version="1.0" encoding="UTF-8"?> <ringers> <ringer file=":/sounds/ringing.wav" description="Standard ring signal" default="true" /> <ringer file=":/sounds/digital1.wav" description="Digital 1"/> <ringer file=":/sounds/digital2.wav" description="Digital 2"/> <ringer file=":/sounds/mobile1.wav" description="Mobile 1"/> <ringer file=":/sounds/mobile2.wav" description="Mobile 2"/> <ringer file=":/sounds/mobile3.wav" description="Mobile 3"/> <ringer file=":/sounds/moog.wav" description="whine"/> <ringer file=":/sounds/moogdualtone.wav" description="Moog dual tone"/> <ringer file=":/sounds/phone.wav" description="Phone"/> <ringer file=":/sounds/tune.wav" description="Tune"/> </ringers> The following list shows the recommended format of the Waveform Audio File Format (WAV) files:
Resource Interchange File Format (RIFF) [little-endian] data
WAV audio
Microsoft Pulse Code Modulation (PCM)
16 bit
Mono 16000 Hertz (Hz)
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 47
In addition, other sampling frequencies work; however, the WAV must be single channel as stereo files play half speed and are corrupt. Most notably, Moving Pictures Experts Group Audio Layer 3 (MP3) or other encoded WAVs do not work. There are open-source applications that allow for modifying the WAV format if needed.
6.5 Brandable Add-ins – Standard HID Add-in Starting with Release 21.0 and onwards, individual ready-made add-ins can be enabled or disabled via branding. See the following table for the parameter for enabling the first one, the standard Human Interface Device (HID) Add-in. In addition, installing the Cisco standard HID Add-in, this parameter also automatically enables the Web API needed for the standard HID Add-in to control Web.
Note that for Skype for Business integration, the standard HID Add-in cannot be used in general, so this parameter cannot be used together with S4B integration. For more information on S4B integration and related branding limitations, see section 6.10 Web Add-in for Microsoft Skype for Business.
Text File Name
add_std_hid_connector=true btbc_build.ini
6.6 Enable Third-Party Software Cisco Calling supports compatible headsets as well as other software utilizing the Web desktop API to programmatically control Cisco Calling. To include these capabilities, the following additions must be made. This parameter also currently installs the Cisco standard HID Add-in for USB headset operation in addition to enabling the Web desktop API. For more information on the standard HID Add-in, see section 6.5 Brandable Add-ins – Standard HID Add-in.
This parameter can be used interchangeably with the Cisco standard HID parameter; however, branding validation is more restrictive for the standard HID parameter so this one can be used when, for example, you want to enable the API used for USB headsets with S4B integration so that vendor-specific add-ins can be used for USB headset control. Note that for Skype for Business integration, the standard HID Add-in cannot be used in general due to technical limitations.
Text File Name
add_headphones_connectors=true btbc_build.ini Note that the advanced logs for third-party applications, which are only required for special debugging cases, are located in the Web directory. Additionally, in order to use USB headsets, the related Web API needs to be enabled in configuration. For more information, see the Communicator for Desktop Configuration Guide.
6.7 Outlook Add-in Installer Integration Release 21.5.0 introduced support to integrate the Outlook Add-in installer with the Cisco Calling installer. To enable the integration, the changes shown in the following table must be made. Note that from Release 22.3.0 and onwards, the Outlook Add-in and Skype for Business (S4B) integration can be used together.
Text File Name
outlook_plugin=true btbc_build.ini
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 48
6.8 Disable Crash Reporter Some customers have requested the ability to disable crash reporting. This can be done as a branding option starting in Release 21.1.0. See the following table for details. Local crash dumps are still generated but are not sent.
Text File Name
disable_crashreporting=true build.ini
6.9 Disable Logging via Branding You can disable logging as a branding option starting with Release 21.6.0. See the following table for branding details. For more information on the various options, see the Communicator for Desktop Configuration Guide.
Text File Name
logging=basic Possible values: off, disabled, basic, and advanced.
build.ini
6.10 Web Add-in for Microsoft Skype for Business The Web Add-in for Microsoft Skype for Business (S4B) can be enabled via branding. In this case, the installer performs a few operations listed in the Communicator for Desktop Configuration Guide. The following table depicts the branding parameter. Note that Microsoft S4B integration must also be enabled in the configuration. For more information, see the Communicator for Desktop Configuration Guide. Also note that the Outlook Add-in can now be used at the same time with S4B integration, but the standard HID Add-in cannot be used at the same with S4B integration as they are using the same shared resource (code page of events) for USB headset calling. For this reason, Cisco Calling automatically disables the standard HID when S4B is running. They can be used in branding at the same time using the headphones parameter depicted in section 6.6 Enable Third-Party Software with this usage limitation.
Text File Name
lync_integration=true build.ini
6.11 Encryption Option for credentials_encrypted.db For Virtual Desktop Infrastructure (VDI) environments, Release 21.6.1 added a branding option to disable the use of salt in the credentials_encrypted.db file encryption process to allow copying the file across machines. By default, this option is disabled. See the following table.
Text File Name
disable_credentials_salt=true build.ini
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 49
6.12 Google Analytics Release 22.2.0 added support for Google Analytics. The following table lists the two parameters associated with this feature. The first enables/disables the Cisco tracking ID to either allow or disallow analytics data being available to Cisco. The second parameter (string) can be used by service providers to use their own tracking ID so that the analytics data is available to them in the Google Analytics administrator view. For more information about Google Analytics support, see the UC-One Google Analytics Client Reference Guide.
Text File Name
broadsoft_analytics_enabled=true build.ini
custom_analytics_tracking_id=<string> build.ini
6.13 Single Sign-On (SSO) Release 22.2.0 introduced support for SSO. The following table lists the related branding parameter where the utilized identity provider can be specified as a string used as part of the URL towards the Xsp authentication service at login. Release 22.4.0 supports Okta, Google, and Microsoft. Additionally, custom Identity Providers (IdPs) can be specified in Release 22.4.0 and later. For more information, see the subsequent section.
Release 22.5.0 added support for dynamically detecting the applicable IdPs instead of always having the same IdP list for the build. To use dynamic detection of IdPs, sso_context must be left empty. When it is populated, Cisco Calling works as before Release 22.5.0 so that the IdP list is always the same as returned by the server.
The URL where the IdPs are checked at login is constructed by using the dm_url parameter value combined with a hard-coded string authService/providers/ combined with the value of the “sso_context” parameter.
Text File Name
sso_context=<context name> build.ini
6.14 SSO Enhancements Release 22.4.0 added support for hiding BroadWorks credentials with SSO so that only SSO is used by using a new IdP option “broadworks”. If that is returned by the Xsp authentication service to Cisco Calling, the BroadWorks (username and password) will be available to the user as a sign in option. If the “broadworks” IdP is not returned, the BroadWorks username and password fields will not be visible in the login screen. Additionally, support was added for using custom IdPs.
For more information on the SSO login options enablement in relation to Xsp authentication configuration, see the SSO section of the UC-One Desktop Configuration Guide. For the related Xsp configuration, see the SAML Authentication Integration Solution Guide available on Xchange at https://xchange.broadsoft.com/node/499646.
The text for the custom IdP can be branded using existing text localization processes.
The deployment may define Custom IdP 1 phrase to be, for example, “Continue” and define the desired icon for the custom_IdP1.png as per the sizing requirements detailed earlier in this document. Additionally, the other custom IdPs can have freely selected texts.
The default phrases for the four supported custom IdPs are as follows:
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 50
“Custom IdP 1”
“Custom IdP 2”
“Custom IdP 3”
“Custom IdP 4”
The corresponding IdPs returned at login by the server need to be as follows:
“custom1”
“custom2”
“custom3”
“custom4”
If the IdPs are something else, Communicator does not recognize them and branding is not possible.
Furthermore, an optional text area is placed onto the area where the BroadWorks username and password would be when “BroadWorks” section omits from the AuthService response. By default, this text has content:
“On selecting “Continue” you will be redirected for authorization.
Once authorized, this stop will be skipped and you will be logged in automatically.”
Additionally, this text can be localized using the standard localization processes.
6.15 Login URL List Release 22.4.0 added support for brandable list of login URLs shown in the login screen. The parameter for this is depicted in the following table. It defaults to “false” when omitted.
Text File Name
show_region_login_url=true build.ini Additionally, there needs to be an XML file containing located in the root of the branding kit (zip.). The file name must be “login_regions.xml”. See the following example for the login_regions.xml file.
?xml version="1.0" encoding="utf-8"?> <locales> <locale name="en_US"> <region-names> <region-name lang="en">United States</region-name> <region-name lang="fr">États-Unis</region-name> <region-name lang="de">Vereinigte Staaten</region-name> <region-name lang="es">Estados Unidos</region-name> </region-names> <host name="https://us.company.com" xsi-path="com.broadsoft.xsi-actions" default-domain="company.com" /> </locale> <locale name="EU"> <region-names> <region-name lang="en">European Union</region-name> <region-name lang="fr">Union Európeen</region-name> </region-names> <host
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 51
name="https://eu.company.com" xsi-path="com.broadsoft.xsi-actions" default-domain="company.com" /> </locale> </locales>
6.16 Privacy Policy Release 22.4.0 added support for showing a brandable link to the privacy policy in the About view. The parameter for this is depicted in the following table. Using the %(LANG) parameter in the URL also makes it possible to point the end user to a web page with the same language used in Cisco Calling.
Text File Name
privacy_url=https://example.com build.ini
6.17 TLS Certificate Validation To enable the use of the configured server address in TLS certificate validation, the parameter depicted in the following table can be used. For more information about TLS certificate validation, see the Communicator for Desktop Configuration Guide.
Text File Name
use_safe_ssl_cert_verification=true build.ini
6.18 Organization Name To provide necessary flexibility for deployments to use alternate ID for Xsp login with arbitrary organization names, a new branding parameter was added in Release 22.5.3 (depicted in the following table). It is applicable to cases where alternate ID is being used but the organization domain must be something other than the previous default broadsoft.com. When not defined, it defaults to the value of the “default_domain” branding parameter. This also allows to have default_domain with an empty value and organization_name with something other than broadsoft.com.
Text File Name
organization_name=ExampleCompany build.ini
6.19 Call History Name Override To localize call history caller names, the names that need to be changed need to be first defined in DM configuration and then translation needs to take place for one or two strings using standard localization processes to make a new branded build. See the UC-One Communicator for Desktop Configuration Guide for more information on configuration and general process and the UC-One Communicator Language Guide for the exact language strings that need to be translated.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 52
7 SIP and HTTP User Agent Header Branding
The application name is also used for the SIP and HTTP User Agent header string, with hard-coded “bc-uc” appended in the beginning and version information at the end. User Agent headers are sometimes used for access control purposes.
As an example, if the application name is “Example Communicator” as in the default branding kit, and client version is 22.6.0.4 on Mac OS 10.10.1, the User Agent header would have the following string:
bc-uc – Example Communicator (22.6.0.4 Mac OS X [11])
Thus, via branding, it is only possible to change the application name part while the fixed “bc-uc” string is always appended at the beginning.
The various parts of the previous example string are as follows:
“bc-uc” – hard-coded string always appended at the beginning
Example Communicator – application name
22.6.0.4 – client version number
Mac OS – operating system
(11) – operating system version. For older OS versions, this can be a string identifying the OS, otherwise, it is a number.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 53
8 Client Version Number
The client version number is not brandable but generated by the branding service. For more information on how the version number is constructed, see the applicable Deployment Guide.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 54
9 Automatic Upgrade
Starting with Release 22.3.0, the automatic upgrade feature is supported, which offers a streamlined User Experience (UX) for the end user whereby no manual installation of the upgrade installer is required. This feature requires a sha256.txt file of each upgrade installer to be placed into Device Management (DM). The sha256.txt file is used by the client to verify the validity of the automatically downloaded upgrade installer. For more information on the automatic upgrade configuration, see the Communicator for Desktop Configuration Guide.
Note that the sha256.txt file is available in the branding service for each branded build.
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 55
Appendix A – Brandable Installer Strings
The following strings can be modified in the installer:
1. “Installer Language”
2. “Please select a language”
3. “An existing version of $(^Name) was found on your system. It is recommended that you uninstall the existing version before installing the new version. Do you want to uninstall the existing version of $(^Name)?”
4. “A problem was encountered while removing the existing version of $(^Name). Please uninstall it manually using Programs and Features in Control Panel.”
5. “Install Options”
6. “Choose options for installing $(^Name)”
7. “Always run $(^Name) when the system starts”
8. “Create $(^Name) Desktop Icon”
9. “Start $(^Name) now”
10. “$(^Name) is still running. Please exit the application and run uninstaller again.”
11. “In order to use all features of $(^Name) you should update Display Adapter drivers. You can use $(^Name) without updating but it will not be able to render hardware accelerated video. Do you want to continue installation?”
12. “Installation of $(^Name) aborted”
13. “Normal installation”
14. “Install and register program in the operating system.”
15. “Unpack program to specified directory without making changes to the operating system.”
16. “Normal installation. Install and register program in the operating system.”
17. “Install Mode”
18. “Choose mode for installing $(^Name)”
19. “Selected environment for all users”
20. “Selected environment for current user only”
21. “Set install registry entry: '$1' to '$0'”
22. “Delete profiles”
23. “Uninstall Options”
24. “Choose options for uninstalling $(^Name)”
25. “Do you want to keep profiles?”
26. “$(^Name) is still running. Please exit the application before continuing.”
27. “Skype for Business Installation”
CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2018 CISCO, INC. PAGE 56
Acronyms and Abbreviations
This section lists the acronyms and abbreviations found in this document. The acronyms and abbreviations are listed in alphabetical order along with their meanings.
ASCII American Standard Code for Information Interchange
BOM Byte Order Mark
CALA Central America/Latin America (Spanish)
DM Device Management
EULA End-User License Agreement
FIPS Federal Information Processing Standard
HID Human Interface Device
HTML Hypertext Markup Language
HTTP Hypertext Transfer Protocol
Hz Hertz
IdP Identity Provider
MP3 Moving Pictures Experts Group Audio Layer 3
OS Operating System
PCM Pulse Code Modulation
PIV Personal Identity Verification
PNG Portable Network Graphics
RGB Red Green Blue
RGBA Red Green Blue Alpha
RIFF Resource Interchange File Format
S4B Skype for Business
SIP Session Initiation Protocol
SSO Single Sign-On
TLS Transport Layer Security
UI User Interface
UX User Experience
VDI Virtual Desktop Infrastructure
VVM Visual Voice Mail
WAV Waveform Audio File Format (file extension)
Xsi Xtended Services Interface
Xsp Xtended Services Platform