release 22.7.10 document version 1 - webex calling help · cisco calling desktop branding guide...

Cisco Calling for Desktop Branding Guide

Release 22.7.10 Document Version 1

CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2019 CISCO SYSTEMS, 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© 2019 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 ©2019 CISCO SYSTEMS, 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


November 5, 2018 Patricia Renaud

22.7.0 1 Added a feature and made edits. January 17, 2019 Veli-Pekka Heinonen


January 17, 2019 Patricia Renaud

22.7.8 1 Added a section about brandable URL schemes.

February 18, 2019 Veli-Pekka Heinonen


February 26, 2019 Patricia Renaud

22.7.10 1 Added new branding resources. May 21, 2019 Veli-Pekka Heinonen


June 6, 2019 Joan Renaud

CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2019 CISCO SYSTEMS, INC. PAGE IV

Table of Contents

1 Summary of Changes ...................................................................................................................7

1.1 Changes for Release 22.7.10, Document Version 1 ............... Error! Bookmark not defined. 1.2 Changes for Release 22.7.8, Document Version 1 .................................................................... 7 1.3 Changes for Release 22.7.0, Document Version 1 .................................................................... 7 1.4 Changes for Release 22.6.9, Document Version 1 .................................................................... 7 1.5 Changes for Release 22.6.0, Document Version 2 .................................................................... 7 1.6 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........................................................................................................................................ 31 6.3.1 General .............................................................................................................................. 31 6.3.2 Login Window ................................................................................................................... 33 6.3.3 Main Window .................................................................................................................... 34 6.3.4 Communications Window ................................................................................................ 42 6.3.5 Notifications ....................................................................................................................... 46 6.3.6 Team Telephony ............................................................................................................... 47

6.4 Audio Tones ............................................................................................................................... 47 6.5 Brandable Add-ins – Standard HID Add-in .............................................................................. 49 6.6 Enable Third-Party Software ..................................................................................................... 49 6.7 Outlook Add-in Installer Integration .......................................................................................... 49 6.8 Disable Crash Reporter ............................................................................................................. 50 6.9 Disable Logging via Branding ................................................................................................... 50

CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2019 CISCO SYSTEMS, INC. PAGE V

6.10 Web Add-in for Microsoft Skype for Business ......................................................................... 50 6.11 Encryption Option for credentials_encrypted.db ...................................................................... 50 6.12 Google Analytics ........................................................................................................................ 51 6.13 Single Sign-On (SSO) ............................................................................................................... 51 6.14 SSO Enhancements .................................................................................................................. 51 6.15 Login URL List ........................................................................................................................... 52 6.16 Privacy Policy ............................................................................................................................. 53 6.17 TLS Certificate Validation .......................................................................................................... 53 6.18 Organization Name ................................................................................................................... 53 6.19 Brandable URL Schemes ......................................................................................................... 54 6.20 Call History Name Override ...................................................................................................... 54 7 SIP and HTTP User Agent Header Branding ......................................................................... 55

8 Client Version Number .............................................................................................................. 56

9 Automatic Upgrade .................................................................................................................... 57

Appendix A – Brandable Installer Strings ..................................................................................... 58

Acronyms and Abbreviations .......................................................................................................... 59

CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2019 CISCO SYSTEMS, 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 ...................................................................................... 19 Figure 9 Desktop – Simple Branding Sample 2 ...................................................................................... 19 Figure 10 Desktop – Standard Branding Sample ................................................................................... 24 Figure 11 Desktop – Advanced Branding Sample ................................................................................. 31

CISCO CALLING DESKTOP BRANDING GUIDE 60-BT1006-00 ©2019 CISCO SYSTEMS, 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.7.10, Document Version 1 This version of the document includes the following change:

Added new branding resources based on the new UX.


Added a section about brandable URL schemes.


Added a section about brandable URL schemes.


Added note about Cisco Calling releases.

1.5 Changes for Release 22.6.0, Document Version 2 This version of the document includes the following changes:

Added images for visual voicemail.

Removed SSO images.

Added a correct reference for SSO.

Added notes to SSO section.


Created document for this release.


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.7.10. Note that even though Cisco Calling Release 22.7.10 is identical in terms of functionality to Communicator Release 22.7.3 and in terms of UX 22.8.0, all Cisco Calling branding must use the 22.7.10 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.


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 controls CheckBox

presence smileys sounds windows CommunicationsWindow advanced_call Chat Contact Card DetailsPanel Dialpad LiveMeeting MediaTumbnails Participants RoomApprovalDialog WebCollab

LoginWindow MainWindow


Active Communications ContactMouseOver Dialpad History Illustrations PopOver Presence Search Tabs

Notifications TeamTelephony


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


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.


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.


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/



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)

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:

 – Line break

 – Italic

 – Bold


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.


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. Note that color codes that are shown as struck-through are not used for Cisco Calling but are still visible in the color picker.

Main Application Colors

Title Color # Value Example

CellSelectedBackground #EBF7FB

ChatBackground #FFFFFF

IncomingChatBalloon #F0F2F1

OutgoingChatBalloon #D2F4FA

PrimaryBackground #05A1BF

SecondaryBackground #05A1BF

TertiaryBackground #F0F2F1


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

5.9.1.2 Basic Color Branding Sample 2

In this example, the customer changes all four basic branding colors.

Figure 9 Desktop – Simple Branding Sample 2

PrimaryBackground

CellSelectedBackground

SecondaryBackground

TertiaryBackground

PrimaryBackground

CellSelectedBackground


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.


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. Note that color codes that are shown as struck-through are not used for Cisco Calling but are still visible in the color picker.


AvatarBackground #F0F2F1

AvatarIcon

#666666

CallBackground #F0F0F0



ChatPrimaryText #000000

ChatSecondaryText

#666666

ChatSeparator #F0F2F1, OPACITY 20%


IncomingChatText #000000

ListSearchBackground #000000



ListSearchBackgroundFocus #000000


OutgoingChatText #000000

PrimaryText Applies to all icons and text shown on PrimaryBackground.

#FFFFFF



NavIcon

#666666

SelectedNavIconBackground Applies to the hover state as well.

#05A1BF Opacity 60% (defaults to CellSelectedBackground)

SelectedNavIcon

#05A1BF

PrimaryButton Applies to avatar initials, profile buttons, buttons backgrounds, Advanced Call Control header, and menu items.

#05A1BF (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

SearchBackground

#FFFFFF

SearchBackgroundFocus #000000

Icon #666666

SelectedIcon Applies to the icon hover state as well.

#05A1BF (defaults to PrimaryBackground)

SelectedTab


TertiaryBackground

#F0F2F1

TertiaryContentText is used over ContentBackground.

HighlightBackground


AccentText Labels in Profiles and Settings


LoginBackground

#FFFFFF


6.2.1.1 Standard Branding Sample

The following sample has a number of standard branding elements changed.

Figure 10 Desktop – Standard Branding Sample

6.2.2 Advanced Color Branding Advanced color branding allows all colors used for backgrounds, text, and images in the application to be branded. Note that color codes that are shown as struck-through are not used for Cisco Calling but are still visible in the color picker.

Title Color Color Value Example

AccentMissedCalls #FF503C

AccentSearchResults #05A1BF

AccentText #05A1BF

AccentUnread #333333

ActiveSpeaker #07C1E4

AppNotification

#FFDA00

AppNotificationBackground

#FFDA00

PrimaryButton

SelectedIcon

PrimaryContentText

Icon

SelectedNavIcon



AppNotificationText

#666666

AvatarBackground #F0F2F1

AvatarIcon #666666

BadgeBackground #FF503C

BadgeText #FFFFFF

CallBackground #F0F0F0

CallButton #2ED557

CallButtonReverse #FFFFFF

CallControlButton #333333

CallControlButtonReverse #FFFFFF

CallControlButtonSelected #05A1BF

CellHoverBackground #EBF7FB



ChatButton #07C1E4

ChatButtonReverse #FFFFFF

ChatPrimaryText #000000

ChatSecondaryText #666666



ContentBackground #FFFFFF Left Panes Background: Contacts, Call History, Dialpad, Web Links, and Settings.

Right Panes Background: Header and Profile Info.

Input Fields Background in: Login screen, all search fields, edit mode input fields.

Transfer, Conference, and Park Call.

Tabs background

DialPadButton #F0F2F1

DimmedText #000000

DisabledBackground #000000

DropdownBackground #FFFFFF

DropdownText #333333

EmoticonsBackground #FFFFFF

ErrorText #FF503C

FocusRing #25B6DA

Headers #666666

HighlightBackground #05A1BF



HoverBackground #000000

Icon #666666


IncomingChatText #000000

InfoButton #89C6C7

InfoButtonReverse #FFFFFF

ListSearchBackground #000000

ListSearchBackgroundFocus #000000

LoginBackground #FFFFFF

LoginCheckbox

#E0E0E0

LoginText #666666

LoginTextSelected #05A1BF

MainHeaderButton #FFFFFF

MainHeaderButtonIcon #333333

MeetingBackground #0C2C3E



MeetingText #FFFFFF

NavIcon #666666

NotificationBackground #000000

NotificationOutline #FFFFFF

NotificationText #FFFFFF


OutgoingChatText #000000

OutlineInputField #000000

PopOverBorder #E7E7E7


PrimaryButton #05A1BF

PrimaryButtonReverse #FFFFFF



PrimaryContentText #333333

PrimaryContentText is used over ContentBackground.

PrimaryText #FFFFFF

ScrollBar #000000

SearchBackground #FFFFFF

SearchBackgroundFocus #000000


SecondaryContentText Second line in lists and Settings labels above dropdowns.

#666666

SecondaryContentText is used over ContentBackground.

SelectedIcon #05A1BF

SelectedNavIcon #05A1BF



SelectedNaviconBackground #FFFFFF

SelectedTab #F0F0F0

Separators #F0F0F0

SharingBarBackground #05A1BF

SharingBarText #FFFFFF

SharingButtonBackground #FFFFFF

TertiaryBackground #F0F2F1

ToasterBackground #FFFFFF

TooltipBackground

#333333

TooltipText

#FFFFFF

UnselectedTabBackground #FAFAFA

UnselectedTabText #333333

WidgetOff #E0E0E0

WidgetOn #05A1BF

WidgetReverse #FFFFFF



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

#2ED557 Merge call button – swipe (positive states or actions).

SymboilicOrange

#FFB400

SymbolicRed Negative or destructive states or actions.

#FF503C End call button, delete button.

SymbolicGray

#B4B4B4 Button in notifications.

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.

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.

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 26 x 16 theme\ Displays in drop-down lists on the Login window and can also display in drop-down lists on the Communications window.

Avatar_regular.png 32 x 32 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 28 x 28 theme\presence\ Displays when a user has not uploaded a picture for their avatar.




Avatar_callonly_regular.png

32 x 32 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

28 x 28 theme\presence Displays in incoming call toaster and Call History when the caller is not a contact and only has a number.

Avatar_group_regular.png

32 x 32 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.



(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.

login_spinner.png

64 x 64 theme\windows\LoginWindow\

Login window back button.

settings_normal.png

32 x 32 theme\windows\LoginWindow\

Login window settings button to allow moving back to, for example, Device Management (DM) URL view.


6.3.3 Main Window The following items are used on the left pane of the Main window and in the Main window.



email_normal.png 64 x 64 theme\windows\MainWindow\ In contact card.

fav_star_group_header.png

28 x 28 theme\windows\MainWindow\ In contact card.

group_header_arrow.png

26 x 16 theme\windows\MainWindow\ In contact card.

loading_spinner_20.png

64 x 64 theme\windows\MainWindow\ 20% spinner

loading_spinner_32.png

64 x 64 theme\windows\MainWindow\ 32% spinner

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_extapp2_normal.png 64 x 76 theme\windows\MainWindow\ Optional second external URL button, on state.

lp_extapp3_normal.png 64 x 76 theme\windows\MainWindow\ Optional third external URL button, on state.




lp_extapp4_normal.png 64 x 76 theme\windows\MainWindow\ Optional fourth 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.

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.

record_call_normal 20 x 20 theme\windows\MainWindow\ Record call button

search_close.png 16 x 16 theme\windows\MainWindow\ Close button in search field.

Secure_call.png 20 x 20 theme\windows\MainWindow\ Secure call indicator

textfield_clear.png 20 x 20 theme\windows\MainWindow\ Secure call indicator

6.3.3.1 Communications Buttons

The following items are used in the Main window and in the Communications tabs when used.



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.3.1 Active Communications

The following items are used for active communications.



activecommunication_answer_deskphone_normal.png

44 x 44 theme\windows\MainWindow\ActiveCommunications\

Answer call from desk phone.

activecommunication_conference_normal.png


Extra button for conference, normal state.

activecommunication_decline_deskphone_normal.png


Decline Call from Phone button, on state.

activecommunication_end_deskphone_normal.png


End Call from Phone button, on state.

activecommunication_end_normal.png


End Call button, normal state.

activecommunication_hold_normal.png


Hold button, on state.

activecommunication_mergecall_normal.png


Merge Call button, on state.

activecommunication_mute_normal.png


Mute button, on state.

activecommunication_park_normal.png


Extra button for call park, normal state.

activecommunicatio_pull_call_normal.png


Extra button for Xsi call pull.

activecommunication_start_normal.png


Start call button.

activecommunication_startdecline_normal.png


Decline call button.

activecommunication_startvideo_normal.png


Start video call button.

activecommunication_transfer_normal.png


Extra button for call transfer, normal state.


6.3.3.2 Contact Mouse Over

The following items are used for mouse over in e.g. contact list and hovering over a contact to get a popover with communications options.



call_normal.png 48 x 48 theme\windows\MainWindow\ContactMouseOver

Call button, on state.

info_normal.png 48 x 48 theme\windows\MainWindow\ContactMouseOver

Info button, on state.

videocall_normal.png 48 x 48 theme\windows\MainWindow\ContactMouseOver

Video call button, on state.

xsicall_normal.png 48 x 48 theme\windows\MainWindow\ContactMouseOver

Xsi call button, on state.

6.3.3.3 Dialpad

The following items are used in the main window dial pad.



delbutton_normal.png

60 x 34 theme\windows\MainWindow\Dialpad\

Delete button, normal state

dialpad_voicemail_normal.png

104 x 104

theme\windows\MainWindow\Dialpad\

Voice mail button, normal state

call_normal.png 40 x 40 theme\windows\MainWi

ndow\Dialpad\ Audio call button, normal state

videocall_normal.png


Video call button, normal state

xsi_call_normal.png


Xsi call button, normal state

6.3.3.4 History

The following items are used in the history view.



history_hunt_group_normal.png

16 x 16 theme\windows\MainWindow\History\

Incoming hunt group call indicator




history_incoming_normal.png


Incoming call indicator

history_missed_diverted_arrow.png


Missed diverted call indicator

history_missed_normal.png 16 x 16 theme\windows\MainWi

ndow\History\ Missed call indicator

history_outgoing_normal.png


Outgoing call indicator

history_primary_diverted_arrow.png


Primary diverted arrow

history_secondary_diverted_arrow.png


Secondary diverted arrow

history_tertiary_diverted_arrow.png


Tertiary diverted arrow

timeline_call_tab_normal.png


Icon for Calls tab

timeline_vm_tab_normal.png


Icon for visual voice mail (VVM) tab

vm_audio.png 16 x 16 theme\windows\MainWindow\History\

VVM audio message icon

vm_call_normal 32 x 32 theme\windows\MainWindow\History\

vm_confidential.png 24 x 24 theme\windows\MainWindow\History\

VVM confidential message icon

vm_delete_normal 32 x 32 theme\windows\MainWindow\History\

VM delete button

vm_download_normal 32 x 32 theme\windows\MainWindow\History\

VM download button

vm_fax.png 24 x 24 theme\windows\MainWindow\History\

VVM fax message icon

vm_pause_normal.png 32 x 32 theme\windows\MainWi

ndow\History\ Icon for pausing voice mail

vm_play_normal.png 32 x 32 theme\windows\MainWi

ndow\History\ Icon for playing voice mail

vm_played_normal.png 32 x 32 theme\windows\MainWi

ndow\History\ Icon for playing voice mail




vm_urgent.png 24 x 24 theme\windows\MainWi

ndow\History\ VVM urgent message icon

Vm_video.png 24 x 24 theme\windows\MainWindow\History\

VVM video message icon

6.3.3.5 Illustrations

The following items are used for illustrations in various places of the main window.



call_history_empty_illustration.png

64 x 64 theme\windows\MainWindow\Illustrations

Empty call history list.

contacts_empty_illustration.png


Empty contact list

voice_mail_empty_illustration.png


Empty voice mail list

6.3.3.6 Popover

The following items are used for search result popover in the main window. The color of these images cannot be changed.



clear_normal.png 28 x 28 theme\windows\MainWindow\popover

Clear button.

close_normal.png 16 x 16 theme\windows\MainWindow\p

opover Close button.

down_arrow.png 30 x15 theme\windows\MainWindow\p

opover Arrow down, part of the popover image.

left_arrow.png 30 x15 theme\windows\MainWindow\p

opover Arrow left, part of the popover image.

pop_over.png 126

x126 theme\windows\MainWindow\popover

Popover image

right_arrow.png 15 x30 theme\windows\MainWindow\p

opover Popover arrow right, part of the image.




search_normal.png 24 x 24 theme\windows\MainWindow\p

opover Search icon

up_arrow.png 30 x15 theme\windows\MainWindow\p

opover Popover arrow up, part of the image.

6.3.3.1 Preferences

The following items are used in the Preferences view in the Main window.



settings_advanced_normal.png

24 x 24 theme\windows\MainWindow\

Icon used for the Advanced view title in the Preferences view in Main window.

settings_checkmark.png


Icon used for the check mark in the Preferences view in Main window.

settings_extensions_normal.png


Icon used for the Extensions view title in the Preferences view in Main window.

settings_general_normal.png


Icon used for the General view title in the Preferences view in Main window.

settings_incomingcalls_normal.png


Icon used for the Incoming Calls view title in the Preferences view in Main window.

settings_media_normal.png


Icon used for the Media view title in the Preferences view in Main window.

settings_outgoingcalls_normal.png


Icon used for the Outgoing Calls view title in the Preferences view in Main window.

settings_services_normal.png


Icon used for the Services view title in the Preferences view in Main window.

settings_voicemail_normal.png


Icon used for the Voice Mail view title in the Preferences view in Main window.


6.3.3.2 Search

The following items are used for universal search in the main window.



recent_search.png 100x56 theme\windows\MainWindow\search

Recent search button.

search_tab_calls.png

100x56 theme\windows\MainWindow\search

Search calls button.

search_tab_contacts.png

100x56 theme\windows\MainWindow\search

Search contacts button.

6.3.3.1 Tabs

The following items are used in tabs.



audio_call.png 22 x 22 theme\windows\MainWindow\Tabs

Audio call button.

tab_close_normal.png 16 x 16 theme\windows\MainWindow\Tabs

Tab close button.

tab_overflow_down_normal.png

44 x 44 theme\windows\MainWindow\Tabs

Tab overflow down button.

tab_overflow_right_normal.png


Tab overflow to the right button.

tab_pop_in_normal.png 16 x 16 theme\windows\MainWindow\Tabs

Pop tab back in as a tab button.

tab_pop_out_normal.png


Pop tab out as its own window button.

video.png 20 x 20 theme\windows\MainWindow\Tabs

Video call button.

Note that minimum width of the Main window increases for each extra active communications button added.


6.3.4 Communications Window

6.3.4.1 Advanced Call

The following items are used in advanced call view.



advanced_call_submenu_arrow.png

24 x 24 theme\windows\CommunicationsWindow\advanced_call

Submenu arrow.

audio_device.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Audio device control button

check_mark.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call

Check mark

conference.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Conference button.

dialpad.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Dialpad button

headset.png 24 x 25 theme\windows\CommunicationsWindow\advanced_call

Headset icon.

large_conference_no_contact_selected.png

110 x 110

theme\windows\CommunicationsWindow\advanced_call

Large conference no contact selected button

large_transfer_no_contact_selected.png

110 x 110

theme\windows\CommunicationsWindow\advanced_call

Large transfer no contact selected button

park_call.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Call park button

pause_recording.png 40 x 40 theme\windows\Co

mmunicationsWindow\advanced_call

Call recording, pause

record_call.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Call recording, enabling.

resume_recording.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Call recording, resuming.

search.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call

Search icon.




speakers.png 24 x 24 theme\windows\CommunicationsWindow\advanced_call

Speakers icon in call tab.

stop_recording.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Stop recording icon.

transfer.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Transfer icon in call tab.

Video.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Video call icon.

volume.png 40 x 40 theme\windows\CommunicationsWindow\advanced_call

Volume icon in call tab.

6.3.4.2 Tab Controls

The following items are used in Call tabs in general. The following table specifies items that are used for call control in the Call tab.



Advanced_call_menu_normal.png

44 x 44 theme\windows\CommunicationsWindow\


back_arrow.png 26 x 16 theme\windows\Co

mmunicationsWindow\


comm_mute_normal.png 64 x 64 theme\windows\CommunicationsWindow\


full_screen_mute_indicator.png

44 x 44 Theme\windows\CommunicationsWindow\

Full screen mute indicator.

info_normal.png 44 x 44 theme\windows\CommunicationsWindow\

Hides or shows the additional info in tab.

Infopane_header_arrow.png

26 x 16 theme\windows\CommunicationsWindow\

Infopane header arrow.

my_video_normal.png 76 x 50 theme\windows\Co

mmunicationsWindow\MediaThumbnails

Own video button.




video_normal.png 76 x 50 theme\windows\CommunicationsWindow\MediaThumbnails

Video button.

call_normal.png 76 x 50 theme\windows\Co

mmunicationsWindow\MediaThumbnails

Audio call 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.

6.3.4.3 Contact Card

The following items are used in the contact card tab and window.



call_normal.png 40 x 40 theme\windows\CommunicationsWindow\ContactCard\

Call button, on state.

contactcard_add_normal.png

64 x 64 theme\windows\CommunicationsWindow\ContactCard\

Add Contact button, on state.

Contactcard_delete_normal.png


Delete contact card button, on state.

Contactcard_edit_normal.png


Edit contact card button, on state.

Contactcard_hide_normal.png


Hide contact card button, on state.




contactcard_importl_normal.png


Import data button, on state.

email_normal.png


Email button, on state.

Videocall_normal.png


Video call button, on state.

Xsi_call_normal.png


Xsi call button, on state.

6.3.4.4 Details Panel

The following items are used for the details panel (on the left) in the communications window.



email_23x22.png 32 x 22 theme\windows\CommunicationsWindow\DetailsPanel\

Email button, on state.

reset_20x24.png 21 x 24 theme\windows\CommunicationsWindow\DetailsPanel\

Reset button, on state.

6.3.4.5 Dial Pad

The following items are used for the dial pad in Call windows.



dp1_normal.png 104 x 70 theme\windows\CommunicationsWindow\Dialpad\

1 button, on state.


2 button, on state.


3 button, on state.


4 button, on state.





5 button, on state.


6 button, on state.


7 button, on state.


8 button on state.


9 button, on state.

dpstar_normal.png

104 x 70 theme\windows\CommunicationsWindow\Dialpad\

Star button, on state.


0 button, on state.

dphash_normal.png

104 x 70 theme\windows\CommunicationsWindow\Dialpad\

Hash button, on state.

6.3.5 Notifications The following items are used in communication notifications.



Hub_normal.png

200 x 200 theme\windows\ Notifications\

Hub icon used in error situations.

reply_audio_normal.png


Answer with audio button, on state.

reply_ignore_normal.png


Ignore call button, active state.

reply_no_video_normal.png


Answer video with audio only button, active state.

reply_reject_normal.png


Ignore call button, active state.




reply_video_normal.png


Answer with video button, active state.

Weblinks_normal.png


Web link icon used in error situations.

webpop_normal.png


Web pop button, active state.

6.3.6 Team Telephony The following items are used in the Team Telephony window.



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.

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.

File Name Purpose



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)

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


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

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:

“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 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 Brandable URL Schemes Release 22.7.0 added support to include additional URL schemes that can be used by third-party applications to make calls using Communicator, that is, new URL schemes added via branding. The additional branded URL schemes are supported on top of already existing tel:// and call-to:// URL schemes. The default URL scheme that is added when no branding parameters are used is ucone://. A branding example with webexcalltel:// URL scheme is shown in the following table. This is the recommended value for Cisco Calling that allows launching Cisco Calling from Webex Teams.

Text File Name

custom_uri_scheme=webexcalltel build.ini

6.20 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.


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.


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.


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.


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”


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

release 22.7.10 document version 1 - webex calling help · cisco calling desktop branding guide...

Documents