Broadworks Deployment Studio: User Guide

BroadWorks Deployment Studio
User Guide
Release 21.0
Document Version 4
9737 Washingtonian Boulevard, Suite 350

Gaithersburg, MD 20878
Tel +1 301.977.9440
WWW.BROADSOFT.COM
BroadWorks® Guide
Copyright Notice
Copyright© 2015 BroadSoft, Inc.
All rights reserved.
Any technical documentation that is made available by BroadSoft, Inc. is proprietary and
confidential and is considered the copyrighted work of BroadSoft, Inc.
This publication is for distribution under BroadSoft non-disclosure agreement only. No
part of this publication may be duplicated without the express written permission of
BroadSoft, Inc., 9737 Washingtonian Boulevard, Suite 350, Gaithersburg, MD 20878.
BroadSoft reserves the right to make changes without prior notice.
Trademarks
Any product names mentioned in this document may be trademarks or registered
trademarks of BroadSoft or their respective companies and are hereby acknowledged.
This document is printed in the United States of America.
BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

2015 BROADSOFT, INC.
©
PAGE 2 OF 42
Document Revision History
Release Version Reason for Change Date Author
14.sp1 1 Created document. March 1, 2007 Natasha Jayasinghe
14.sp1 1 Updated document with new pictures and March 31, 2007 Natasha Jayasinghe
edited. Converted to PDF.
14.sp1 1 Updated all sections, and moved March 31, 2007 Wendell Keuneman
Planning Client Deployments originally
from the Deployment Studio
Administration Guide.
14.sp1 1 Edited and published document. May 4, 2007 Andrea Fitzwilliam
14.sp1 2 Deleted section 2.12 Using the April 21, 2008 Natasha Jayasinghe
Command Line Tools and section 2.13
Compiling a Build.
14.sp1 2 Edited changes and published document. April 28, 2008 Andrea Fitzwilliam
14.sp6 1 Updated document for Release 14.sp6. May 21, 2008 Natasha Jayasinghe
Updated screen shots for Release
14.sp6.
14.sp6 1 Reviewed changes. May 22, 2008 Wendell Keuneman
14.sp6 1 Edited changes and published document. June 13, 2008 Andrea Fitzwilliam
14.sp6 2 Added note in section 2.1 About This October 16, 2008 Goska Auerbach
Guide for EV 65378.
14.sp6 2 Edited changes and published document. November 6, 2008 Andrea Fitzwilliam
16.0 1 Updated document for Release 16.0. January 29, 2009 Goska Auerbach
16.0 1 Made minor editorial changes. February 6, 2009 Patricia Renaud
16.0 1 Updated with additional Release 16.0 July 14, 2009 Goska Auerbach
functionality.
16.0 1 Edited and published document. August 25, 2009 Patricia Renaud
16.0 2 Updated section 3.12 Assign and Deploy September 10, 2009 Goska Auerbach
Profile (SaaS applications) for EV 99422.
17.0 1 Updated for Release 17.0. October 13, 2009 Goska Auerbach
17.0 1 Updated section 3.12.1 Log In to March 3, 2010 Goska Auerbach

BroadWorks for EV 104751.
17.0 1 Updated section 3.12.1 Log In to April 26, 2010 Goska Auerbach
17.0 1 Edited and published document. April 29, 2010 Patricia Renaud
17.0 2 Updated section 3.12.1 Log In to May 7, 2010 Goska Auerbach

17.0 2 Added section 4 SaaS Application June 1, 2010 Goska Auerbach

Customization Best Practices for
EV 109272.
17.0 2 Edited changes and published document. June 8, 2010 Andrea Fitzwilliam
17.sp2 1 Updated document for Release 17.sp2. November 17, 2010 Goska Auerbach
17.sp2 1 Edited and published document. November 29, 2010 Jessica Boyle

©
PAGE 3 OF 42
Release Version Reason for Change Date Author
17.sp2 2 Updated section 3.12 Assign and Deploy September 12, 2011 Goska Auerbach
Profile (SaaS applications) for
EV 148823.
18.0 1 Updated document for Release 18.0. October 11, 2011 Goska Auerbach
18.0 1 Edited changes and published document. October 24, 2011 Andrea Fitzwilliam
18.0 2 Updated sections 3.7 Create or Open December 27, 2011 Goska Auerbach
Project and 4.1 Customize Client for
EV 156779.
18.0 2 Edited changes and published document. January 19, 2012 Jessica Boyle
19.0 1 Updated document for Release 19.0. March 13, 2012 Goska Auerbach
19.0 1 Updated section 3.10 Save Project for October 19, 2012 Goska Auerbach
EV 177192.
19.0 1 Updated sections 3.11 Build Installer October 19, 2012 Goska Auerbach
(Desktop Applications) and 3.13.2 View
Menu for EV 176940.
19.0 1 Edited changes. November 1, 2012 Patricia Renaud
19.0 1 Edited changes and published document. November 5, 2012 Jessica Boyle
20.0 1 Edited changes and published document. November 21, 2012 Patricia Renaud
21.0 1 Updated the BroadSoft legal notice. October 15, 2014 Goska Auerbach
21.0 1 Edited changes and published document. October 20, 2014 Jessica Boyle
21.0 2 Updated sections 3.1 Overview, 3.4 December 17, 2014 Goska Auerbach
Workflow, and 3.5 Files and Folders to
remove references to command line
interface for EV 242059.
21.0 2 Rebranded and published document. January 13, 2015 Joan Renaud
21.0 3 Removed references to Hosted Thick January 30, 2015 Goska Auerbach
Receptionist Release 21.0, as Hosted
Thick Receptionist is no longer supported
as of Release 21.0.
21.0 3 Edited changes and published document. February 4, 2015 Joan Renaud
21.0 4 Added rebranded server icons and June 9, 2015 Joan Renaud
published document.

©
PAGE 4 OF 42
Table of Contents
1 Summary of Changes ...................................................................................................................8

1.1 Changes for Release 21.0, Document Version 4 .......................................................................8
1.9 Changes for Release 17.sp2, Document Version 2 ...................................................................9
1.10 Changes for Release 17.sp2, Document Version 1 ...................................................................9
2 Introduction ................................................................................................................................. 10
2.1 About This Guide ....................................................................................................................... 10
2.2 About Deployment Studio ......................................................................................................... 10
3 Using Deployment Studio ......................................................................................................... 11
3.1 Overview .................................................................................................................................... 11
3.2 Client Applications ..................................................................................................................... 11
3.3 Deployment Studio Capabilities ................................................................................................ 12
3.3.1 Customization ................................................................................................................... 12
3.3.2 Deployment ....................................................................................................................... 13
3.4 Workflow .................................................................................................................................... 14
3.5 Files and Folders ....................................................................................................................... 16
3.6 Use Deployment Studio ............................................................................................................ 17
3.7 Create or Open Project ............................................................................................................. 18
3.7.1 Create New Project .......................................................................................................... 18
3.7.2 Open Existing Project ....................................................................................................... 18
3.8 Set Associated Image ............................................................................................................... 19
3.9 Customize Application ............................................................................................................... 19
3.10 Save Project............................................................................................................................... 19

©
PAGE 5 OF 42
3.11 Build Installer (Desktop Applications) ....................................................................................... 20
3.12 Assign and Deploy Profile (SaaS applications) ....................................................................... 20
3.12.1 Log In to BroadWorks....................................................................................................... 22
3.12.2 Select Administrative Entity.............................................................................................. 23
3.12.3 Upload Profile ................................................................................................................... 25
3.12.4 Remove Profile ................................................................................................................. 25
3.13 Menus......................................................................................................................................... 26
3.13.1 File Menu .......................................................................................................................... 26
3.13.2 View Menu ........................................................................................................................ 26
3.13.3 Tools Menu ....................................................................................................................... 27
3.13.4 Help Menu ......................................................................................................................... 27
4 SaaS Application Customization Best Practices .................................................................. 28
4.1 Customize Client........................................................................................................................ 30
4.1.1 Reuse Existing Project ..................................................................................................... 30
4.2 Deploy Custom Profile to Lab ................................................................................................... 30
4.3 Test Customized Client ............................................................................................................. 31
4.4 Report to BroadSoft via ExtraView ........................................................................................... 31
4.5 Deploy Custom Profile to Production ....................................................................................... 31
5 Client Deployment Models ........................................................................................................ 32
5.1 Network Security........................................................................................................................ 32
5.2 SaaS Applications ..................................................................................................................... 32
5.2.1 Overview ........................................................................................................................... 32
5.2.2 Initial Software Release.................................................................................................... 32
5.2.3 Subsequent Maintenance Releases ............................................................................... 32
5.3 Desktop Applications ................................................................................................................. 33
5.3.1 Software Pre-installation .................................................................................................. 33
5.3.2 Software Post-installation ................................................................................................. 33
5.3.3 Auto-detection of Software Updates ................................................................................ 33
5.3.4 Web Deployment Model (Internet/Intranet/Extranet) ...................................................... 34
5.3.5 CD-ROM Deployment Model ........................................................................................... 37
5.3.6 Managed Network ............................................................................................................ 38
5.3.7 Deployment Customizations ............................................................................................ 40
Index ..................................................................................................................................................... 42

©
PAGE 6 OF 42
Table of Figures
Figure 1 Navigational Tree for Desktop Clients ...................................................................................... 12

Figure 2 Navigational Tree for SaaS Clients ........................................................................................... 12
Figure 3 Open Existing Project Dialog..................................................................................................... 14
Figure 4 Open Image Dialog .................................................................................................................... 15
Figure 5 Files and Folders Dialog ............................................................................................................ 16
Figure 6 Deployment Studio .................................................................................................................... 17
Figure 7 Save Project Dialog ................................................................................................................... 19
Figure 8 Build Console ............................................................................................................................. 20
Figure 9 Deployment – Login Page ......................................................................................................... 22
Figure 10 Deployment – Profile Assignment ........................................................................................... 24
Figure 11 Deployment – Undeploy Button Enabled ............................................................................... 25
Figure 12 Menu Bar .................................................................................................................................. 26
Figure 13 File Drop-down List .................................................................................................................. 26
Figure 14 View Menu for SaaS Applications........................................................................................... 26
Figure 15 View Menu for Desktop Applications ...................................................................................... 26
Figure 16 Tools Menu for Desktop Applications ..................................................................................... 27
Figure 17 Tools Menu for SaaS Applications.......................................................................................... 27
Figure 18 Help Drop-down List ................................................................................................................ 27
Figure 19 Customization and Testing Process ....................................................................................... 29
Figure 20 Web Deployment ..................................................................................................................... 35
Figure 21 CD Deployment ....................................................................................................................... 37
Figure 22 Network Deployment ............................................................................................................... 39

©
PAGE 7 OF 42
1 Summary of Changes
This section describes the changes to this document for each release and document
version.
1.1 Changes for Release 21.0, Document Version 4

This version of the document includes the following change:
 Added rebranded server icons.

This version of the document includes the following changes:
 Removed references to Hosted Thick Receptionist Release 21.0, as Hosted Thick
Receptionist is no longer supported as of Release 21.0.

 Updated sections 3.1 Overview, 3.4 Workflow, and 3.5 Files and Folders to remove
references to the command line interface for EV 242059.

 Updated document for Release 21.0.


 Updated section 3.10 Save Project for EV 177192.
 Updated sections 3.11 Build Installer (Desktop Applications) and 3.13.2 View Menu
for EV 176940.

 Updated sections 3.7 Create or Open Project and 4.1 Customize Client for
EV 156779.


©
PAGE 8 OF 42
1.9 Changes for Release 17.sp2, Document Version 2
 Updated section 3.12 Assign and Deploy Profile (SaaS applications) for EV 148823.
1.10 Changes for Release 17.sp2, Document Version 1

 Updated document for Release 17.sp2.

 Updated section 3.12.1 Log In to BroadWorks for EV 111445.
 Added section 4 SaaS Application Customization Best Practices for EV 109272.

 Updated section 3.12.1 Log In to BroadWorks for EVs 104751 and 110701.

 Updated section 3.12 Assign and Deploy Profile (SaaS applications) for EV 99422.

 Updated section 2.1 About This Guide.
 Added the Summary of Changes section to this document.
 Updated document for the Web-based/Web-Services-based Receptionist and Call
Center Client Applications Feature Description.

©
PAGE 9 OF 42
2 Introduction
2.1 About This Guide

This is a general instruction guide on using Deployment Studio to customize a
BroadWorks client application. For detailed instructions on customizing a specific client
application, refer to that application’s Customization and Administration Guide.
In addition, for Software as a Service (SaaS) applications, this guide provides detailed
instructions on deploying customized application profiles.
BroadWorks Deployment Studio is referred to as Deployment Studio in this document.
2.2 About Deployment Studio

BroadWorks Deployment Studio allows a carrier to customize client applications by
creating customized client profiles or software builds for use by the end users. It
addresses the following concerns for service providers:
 Customization: Service providers can control how the client interface is presented,
which includes such elements as colors, presentation, the size and layout of
information, the ability to customize the product using skins or themes, and the ability
to adapt to the needs of closed corporate user groups.
 Deployment: Service providers can minimize the management time involved in the
deployment and upgrading of software in the field.
This includes the ability to pre-configure and deploy custom profiles, to pre-configure
custom builds, to control the software update procedure, and to configure the software
to match supported deployment models.
Allowing service providers to control the customization and deployment processes, gives
them the ability to deliver unique market solutions.
NOTE 1: BroadWorks Deployment Studio Release 21.0 should only be used with Release 16.0
or later of the client application. Otherwise, errors may occur in the customized build.
NOTE 2: BroadWorks Deployment Studio Release 21.0 or later (up to two releases forward)
must be used with BroadWorks Hosted Thin Receptionist Release 21.0 and BroadWorks Hosted
Thin Call Center Release 21.0.

©
PAGE 10 OF 42
3 Using Deployment Studio
3.1 Overview
Deployment Studio is used through an integrated windowed interface.
The windowed interface streamlines the customized process, giving you direct access to
all the options you need to configure and all the tasks you need to perform to produce a
customized client installation file or profile and to deploy the profile.
3.2 Client Applications

The client applications customized by the Deployment Studio can be of the following
types:
 Desktop applications – Client applications with desktop-based installation
executables. For these clients, the result of the customization process is a software
build that contains both the software and the customization parameters, which have to
be distributed to end users for installation. BroadWorks Assistant–Enterprise belongs
to this category.
 Hosted Thick Software as a Service (SasS) applications – Client applications
stored on a BroadWorks server and launched by users from the BroadWorks web
portal. For these clients, the result of customization is a custom profile file, separate
from the client software and deployed to the network using Deployment Studio. The
client software (including a default profile) is included in the BroadWorks software
load. Hosted Thick Receptionist belongs to this category.
 Hosted Thin SaaS applications (Rich Internet Application (RIA)-based) – Client
applications stored on BroadWorks and running in a web browser, with the majority of
processing occurring in a web application hosted on BroadWorks. For these clients,
similarly to the Hosted Thick clients, the result of customization is a custom profile file,
separate from the client software and deployed to the network using Deployment
Studio. Hosted Thin Call Center and Hosted Thin Receptionist belong to this
category.
NOTE: To determine the versions of client applications that can be customized using
Deployment Studio Release 21.0 or to determine the version of Deployment Studio to use for a
specific client application, consult the compatibility matrix available from BroadSoft Xchange at
xchange.broasoft.com and only use compatible versions. Otherwise, errors may occur in the
customized build.
In the remainder of the document, Hosted Thin and Hosted Thick client applications are
referred to as SaaS applications unless a distinction between the two is required.
NOTE: Depending on the client application type, some elements of the customization and
deployment processes are different. In the following sections, the elements that apply only to a
particular application type are flagged as such.

©
PAGE 11 OF 42
3.3 Deployment Studio Capabilities
This section describes the capabilities available from the Deployment Studio.
3.3.1 Customization
Figure 1 Navigational Tree for Desktop Clients
Figure 2 Navigational Tree for SaaS Clients
Deployment Studio provides client customization within the following:

 Branding: Modifications to the look and feel of the application, including product
names, colors, logos, and other images
 Localization: Modifications to the language used by the client, as well as
internationalization changes to suit a particular locale or alternate terminology
 Application Configuration: Modifications to the default configuration settings provided
for various product options, such as whether to log in automatically to the BroadWorks
server, and whether to save user names and passwords
 Application Widgets: Modifications to the general behavior of the client application
such as visibility of contact directories and organization and presentation of
information in the main application window. (Hosted Thin applications)
 Settings: Modifications to the default settings of the client application, such as
placement and size of windows, shortcut key, and use of plug-ins. (Hosted Thin
applications)
 Installer: Modifications to the behavior of the installer file generated by Deployment
Studio, such as default folder paths and file names, or custom scripts to run before or
after the main client installation (Desktop applications)

©
PAGE 12 OF 42
 Web Auto Updates: Modifications to the settings the client uses for auto-discovery of
available updates via the Internet, such as Web Proxy Server settings (Desktop
applications)
 Diagnostics: Modifications to the settings of log files used by Deployment Studio to
report on customization activities, such as the maximum size of a log file
 Feature Restrictions: Modifications to the product features actually available to end
users, such as disabling or removing a particular feature or element
 Deployment: Selecting the administrative entity for profile assignment (SaaS
applications)
 Desktop Shortcuts: Enabling or disabling the creation of application shortcuts on the
end-user’s desktop (Hosted Thick applications)
 Trust Certificates: Adding certificates for use during secure connections
 Reporting: Modifications to the settings the client uses when generating reports
(Hosted Thin Call Center)
3.3.2 Deployment
Deployment Studio provides the following deployment capabilities:
 For SaaS applications, the Deployment function allows you to upload a custom
profile to the network and associate it with an organizational entity.
 For Desktop Applications, the Install function allows you to create an installer file.

©
PAGE 13 OF 42
3.4 Workflow
The following is the general workflow of Deployment Studio.
1) To work on an existing project, open a project file. Project files that have the
extension .dsp contain all the customizations you make to a given client application.
Figure 3 Open Existing Project Dialog
2) To create a new project, specify an image file. Image files that have the extension .dsi
represent specific versions of specific client applications, which contain all resources
and files used by the default client application customization. Each project file is
based on a supplied image file.

©
PAGE 14 OF 42
Figure 4 Open Image Dialog
3) Customize the client application as required. You can create your customizations
using the visual controls offered in the integrated window, or by editing key-value pairs
in the project file directly using a text editor or via a script.
4) Restrict access to product features, if desired. You can restrict or disable product
features so that they are inactive or do not appear to end users.
5) Save the project. This creates or updates a project file (.dsp).
6) Generate installer or deploy profile:
− For desktop applications: Compile a build by taking the customization
information in the project file and creating an installer file for you to distribute to
end users. This file installs the BroadWorks client and it is customized according
to your specified settings.
− For SaaS applications: Log in to BroadWorks; associate the profile with an
organizational entity, such as system, service provider, enterprise, or group; and
upload the profile to the network.
NOTE: Hosted Thin client profiles can also be associated with individual users.

©
PAGE 15 OF 42
3.5 Files and Folders
Deployment Studio uses the following file types:
 Project (.dsp): This document contains abstracted key/value pairs that represent all
customizations to be applied to the client application. You create and edit project files
to create customized versions of clients, and build installer files or create profile files
from these files.
 Image (.dsi): This archive file, supplied for each version of each client application:
− For Desktop applications – Encapsulates all binary and related resources.
It contains a single corresponding template file.
− For SaaS applications – Contains the customizable/localizable resources of the
client and the corresponding template file. It does not contain the application
binaries.
 Build (.msi/exe) (Desktop applications) – This Microsoft Installer file is created from
your project file. It organizes the files that comprise a single client application into a
Microsoft Installer (MSI) compatible database with a corresponding bootstrapped
executable.
 Profile (.jar) (SaaS applications) – This file is automatically created from your project
file and it contains all the customizations for the application. It is a temporary file,
deleted after the profile is deployed in the network.
Upon installation, Deployment Studio creates a logical arrangement of folders to assist in
the customization process.
Figure 5 Files and Folders Dialog

©
PAGE 16 OF 42
The explanation for each folder is as follows:
1) Bin contains binary resources for Deployment Studio.
2) Builds contains all successfully generated MSI/EXE custom builds (Desktop
applications).
3) Conf represents the configuration templates used in the transform phase.
4) Help holds all help documentation.
5) Lib contains all java libraries that are required for Deployment Studio.
6) Logs are all logs generated by the Studio.
7) Third_party contains all third-party software used in Deployment Studio.
− Third_party/7-zip contains 7-zip archival utilities.
− Third_party/wix holds the Windows Installer XML (WIX) binary compiler
resources.
3.6 Use Deployment Studio

To launch Deployment Studio, open the DSWindow.exe file, which can be found in
C:\Program Files\BroadSoft\BroadWorks Deployment Studio\bin, or double-click the
application shortcut. Figure 6 shows the different work areas of Deployment Studio. The
exact content of each area depends on the client application you are working with. The
different areas are described in the following figure.
Figure 6 Deployment Studio
All mandatory fields have a light blue background. Default values are visible and can be
changed according to the user’s needs.
1 The Project View (Explorer) provides a hierarchical tree that organizes all the
elements available for customization into categories. Click any element in the tree
view to expand it and view its sub-elements, if there are any. This also opens its
associated configuration options on the Configuration panel.
2 The Configuration panel displays all the actual fields and items that you can configure.

©
PAGE 17 OF 42
3 The Output/Build Console provides logging information generated by the Deployment
Studio output generation and deployment processes. It is hidden by default. To
manually show the console, click on the View drop-down list on the menu bar and
select Output/Build Console. This contains the following tabs:
− Window tab shows general logging status updates. If an error occurs during build
or profile generation, the Window view gives details regarding which log file to
examine for details.
− Transform tab displays the log file generated by the dstransform.exe utility, which
documents any errors generated when transforming the project file into pre-
compilation WIX scripts before compiling.
− Deploy (SaaS applications) displays the log file generated by the dsdeploy.exe
utility, which documents any errors that occur during the profile deployment
process.
− Compile (Desktop applications) tab displays the log file generate by the
dscompile.exe utility, which turns the compiled build into a self-executable .exe
file.
− Bootstrap (Desktop applications) tab displays the log file generated by the
dsBootstrap.exe utility, which turns the compiled build into a self-executable .exe
file.
4 The Status Bar displays the status of the current DSI image.
3.7 Create or Open Project

Project files contain the customizations you make to a client application and are the main
working documents for Deployment Studio.
NOTE: To make the deployment process more efficient, it is recommended to reuse an old
project whenever possible. For more information, see section 4.1.1 Reuse Existing Project.
3.7.1 Create New Project

1) To create a new project, select New from the File menu. Deployment Studio opens a
dialog in which you can choose an image file to associate with the new project.
2) Select an image and click Open. This loads all available customization options into
the main window.
3.7.2 Open Existing Project

To edit an existing project, select Open from the File menu. This opens a dialog in which
you can select the project file to open. This project already has an associated image file,
and as a result, there is no need to select one.

©
PAGE 18 OF 42
3.8 Set Associated Image
The image associated with a project file determines the specific version of an application
that is built as well as the customization options that may be configured. You can change
the associated image for a project file. However, if you do this, you may lose existing
customizations you have applied in the current project.
1) In the Project View, select the root node of the project’s hierarchical tree.
2) On the Configuration panel, click Browse to the right of the DSI Version box and
select a new image for the project.
3.9 Customize Application

The Deployment Studio window makes all possible customization options for the current
application image available for configuration. As you navigate through the hierarchical
tree displayed in the Project View, the related customization options are displayed in the
Configuration panel.
3.10 Save Project

To save the project, from the File menu, click Save. If the project file has not yet been
saved, a window opens asking you to specify the path and file name.
NOTE: The file name must in English, that is, the name can only contain characters available in
English.
Figure 7 Save Project Dialog
If you want the project saved with a different file name, click Save as. Deployment Studio
opens a window for you to specify the path and file name of the project file.
©
PAGE 19 OF 42
3.11 Build Installer (Desktop Applications)
Building a project takes the customization parameters set in the project file and compiles
them into an installation file that you can deploy for your end users to install.
By default, the Build Console panel is hidden. To manually show the build console, click
View drop-down list on the Menu bar, and select Build Console.
To build the current project, click Build.
This causes Deployment Studio to compile the .msi and .exe installer files.
An .msi file is used for deployment through Microsoft Installer and a self-extracting .exe file
is used for deployments using other methods or media.
Figure 8 Build Console
To run the last build of the current project click Run.

This executes the previously created .exe self-extracting installer file. Follow the installer
instructions to install the client on your desktop and then start the client to view the results
of your customization.
3.12 Assign and Deploy Profile (SaaS applications)

This section covers the assignment and deployment of custom client profiles.
NOTE: The process is the same for all SaaS applications.
Deploying a profile takes the customized parameters set in the project file and creates a
temporary profile file (.jar). The profile is assigned to an administrative entity (system,
service provider, enterprise, group) selected by you and uploaded to the network, using
the Deploy function.
In addition, for Hosted Thin clients, it is possible to associate a profile with a user. This
allows an organization to designate a control group that can use a new version of the
application while the remaining users continue to use the existing version of the
application.
When the deployment process is complete, the local profile file is deleted.

©
PAGE 20 OF 42
The profile hierarchy is as follows:
 The system profile applies to all administrative entities in the system.
 A service provider/enterprise-level profile applies to the service provider/enterprise to
which it is assigned and all the service provider/enterprise groups. It takes
precedence over the system profile.
 The group-level profile applies only to the group to which it is assigned and it takes
precedence over the parent service provider/enterprise profile.
 A user-level profile applies only to the user to whom it is assigned and it takes
precedence over the parent group profile.
 If an entity does not have a custom profile, the closest parent profile in the hierarchy
or, if lacking that, then the default profile is applied.
NOTE 1: The default system profile cannot be changed, but a new system profile can be applied
by a system administrator.
NOTE 2: To assign and deploy a profile, you must have administrative access privileges to
BroadWorks at the appropriate level: group, service provider, or system.
NOTE 3: To deploy a profile at the group or service provider level, a Deployment Studio license
is required. However, to deploy a profile at the system level, a license is not required.
NOTE 4: To deploy a profile, a Hypertext Transfer Protocol (HTTP) interface between the
Xtended Services Platform (or the Web Server) and the Application Server is used. This
requires port 80 (HTTP) or port 443 (Hypertext Transfer Protocol Secure Sockets [(HTTPS]) to
be opened on the Application Server.
To deploy a customized profile, you need to perform the following steps:

1) Log in to BroadWorks.
2) Select the administrative entity to which you want to assign the profile.
3) Upload the profile.
You can also remove an already deployed profile.

©
PAGE 21 OF 42
3.12.1 Log In to BroadWorks
When you access the Deployment page and are not connected to BroadWorks, the Login
pane appears allowing you to log in to BroadWorks.
Figure 9 Deployment – Login Page
To log in to BroadWorks, enter the following information and then click OK.
 Host Address: This is the IP address of the BroadWorks Web Server or Xtended
Services Platform.
 Host Port: This is the port number of the Open Client Server on the server hosting the
client, and the default is “2208”.
 Username: This is your administrative role user name on BroadWorks.
 Password: This is your administrative role password on BroadWorks.
 Web Server uses SSL: This specifies that a secure connection be used to
communicate with BroadWorks.
 Webserver uses SSL for Login only: This specifies that a secure connection is only
used for logging in.

©
PAGE 22 OF 42
NOTE: If you are using a self-signed SSL certificate or a SSL certificate that is not from a
trusted certificate authority (CA), you must import the certificate in the Java Key Store (JKS) on
the machine where Deployment Studio is installed, using the java keytool utility as follows:
1) Click Start and then select Run…
2) Type “cmd” and click OK.
3) Type “<Java Runtime Path>\bin\keytool -import -alias <aliasname> -file <path><certificate file
name> -keystore %JAVA_HOME%\jre\lib\security\cacerts”.
To verify the certificate:

1) Click Start and select Run….
2) Type “cmd” and click OK.
3) Type “<Java Runtime Path>\bin\keytool -printcert -file <path><certificate file name>”.
3.12.2 Select Administrative Entity

When you successfully log in to BroadWorks, you are presented with profile assignment
settings. The administrative entities to which you can assign a profile depend on your
administrative credentials.
The following applies to the different administrative levels:
 The group administrator can only deploy a custom profile to their group, or for Hosted
Thin clients, to a user in their group.
 The group administrator can only remove a profile that was assigned by their group
administrator.
 The service provider/enterprise administrator can deploy a profile to their service
provider/enterprise or a group that is part of that service provider/enterprise.
 The service provider/enterprise administrator can only remove a profile that was
assigned by their service provider/enterprise administrator.
 The system administrator can deploy or remove any profile except for the default
profile.
Figure 10 shows an example of the profile assignment screen for a user with system
administration privileges.

©
PAGE 23 OF 42
Figure 10 Deployment – Profile Assignment
Enter or select required information. The following explains the profile assignment fields:
 Profile Name: This is a read-only field displaying the name of the profile you are
assigning.
 Entity Level: This is the administrative level at which you want to assign the profile.
Select the one (from the available options) that depends on your credentials. The
options include the following: system, service provider, or group.
 Search: This is used to find administrative entities at the selected level. When you
select an Entity Level other than system, the Search button becomes active, allowing
you to find the entities at that level. You can narrow the search by entering the
beginning of the entity name in the Search box. If you leave the box empty, all the
entities at the selected level are displayed.
 Entity Assignment: This is where the list of available entities is displayed, when you
click Search. Select the entity (service provider, enterprise, or group) to which you
want to assign the profile.
NOTE: When you select “System” as the Entity Level, you are assigning the profile to the entire
system and there is no Entity Assignment to select.

©
PAGE 24 OF 42
3.12.3 Upload Profile
When you selected the administrative entity to which you want to assign the profile, click
Deploy. This starts the deployment of your profile.
The deployment process creates a temporary profile file, uploads it to the network, and
assigns it to the selected administrative entity. Once the deployment process is
completed, the local copy of the profile file is deleted from Deployment Studio.
NOTE: If you assign a profile to an administrative entity that already has a profile assigned, then
the new profile replaces the old profile, and the old profile is removed.
The Output Console allows you to see the application logs. By default, the Output
Console panel is hidden. To manually show the Output Console, click the View
drop-down list on the Menu bar, and select Output Console.
3.12.4 Remove Profile

You can remove an already deployed profile. To do this, select the administrative entity
whose profile you want to remove. For more information, see section 3.12.2 Select
Administrative Entity. The name of the profile is displayed, concatenated with the name of
the administrative entity.
When you select an entity, which has a profile assigned, the Undeploy button becomes
active.
To remove the selected profile, click Undeploy.
Figure 11 Deployment – Undeploy Button Enabled
NOTE: You cannot remove the default (System) profile.

©
PAGE 25 OF 42
3.13 Menus
This section describes the menus available from the Deployment Studio Menu bar.
Figure 12 Menu Bar
3.13.1 File Menu

The File menu offers standard commands for working with Deployment Studio projects.
Figure 13 File Drop-down List
1 New Project creates a new Deployment Studio project file. You are prompted to
specify a Deployment Studio image file (*.dsi) for use in the new project. If a project
file is already open when you select File and then New Project, Deployment Studio
closes that project.
2 Open Existing Project opens a project file for customization in Deployment Studio.
You are prompted to specify the project file you want to open. If another project file is
already open, that project closes.
3 Close leaves the Deployment Studio window open but exits the current project file.
4 Save preserves the current project file. If the current project has not already been
saved to a file, you are prompted to specify a path and file name for the new file.
5 Save as saves the current project to a new file. You are prompted to specify the path
and file name.
6 Exit closes the Deployment Studio window, thereby closing any current projects.
3.13.2 View Menu
Figure 14 View Menu for SaaS Applications
Figure 15 View Menu for Desktop Applications

©
PAGE 26 OF 42
The View menu allows you to make the Output Console or Build Console window visible
or invisible. By default, the Output/Build Console is hidden; however, once the Output
Console (for a SaaS application) or Build Console (for a Desktop application) menu item is
checked, the console is visible.
3.13.3 Tools Menu

The tools menu allows you to:
 For Desktop applications: build and run the installer for the current project.
 For SaaS applications: deploy or remove profiles.
Figure 16 Tools Menu for Desktop Applications
1 Build creates a build from the current project file. This menu item has the same effect
as clicking the Build button at the bottom-right of the Deployment Studio window.
2 Run is the last installer built from the current project file. It has the same effect as
clicking the Run button the bottom-right of the Deployment Studio window.
Figure 17 Tools Menu for SaaS Applications
3 Deploy creates a profile file from the current project file, assigns it to the organizational
entity you selected, and uploads it to BroadWorks. This menu item has the same
effect as clicking the Deploy button at the bottom of the Deployment Studio window.
4 Undeploy removes an existing profile from the network. This menu item has the same
effect as clicking the Undeploy button at the bottom of the Deployment Studio
window.
3.13.4 Help Menu
Figure 18 Help Drop-down List
The Help menu provides access to information that can aid you in using Deployment
Studio.
1 User Guide opens the Deployment Studio User Guide.
2 About opens the About window, which provides general information about the version
of Deployment Studio you are currently using.

©
PAGE 27 OF 42
4 SaaS Application Customization Best Practices
This section outlines the recommended process for customizing a hosted (SaaS) client
application, including the testing that should be performed before deploying the
customized client to a wider audience.
This includes creating the project (.dsp), testing it in a lab environment, and when satisfied,
deploying to a production system in a controlled way without affecting live users at a
broader scope.
Testing should be done in a lab environment, since hosted applications are deployed
system-wide, and testing on a production system would affect all users.
Alternatively, if you have the Deployment Studio license allowing you to deploy at the
group level or user level, you can deploy only to a specific group or user(s) for testing.
This can be done on the production network, if necessary.
NOTE: Only the Hosted Thin Receptionist and Call Center clients can be deployed at the user
level.
The following flowchart shows a typical customization and testing process. It is kept
general since different customers may want to customize different parts of the application;
however, the overall process is the same.
You can follow this process for each separate part that you customize, for a collection of
customizations at a time, or you can customize the entire client and apply the process
once.
If necessary, repeat the process until you are satisfied with the result.

©
PAGE 28 OF 42
Figure 19 Customization and Testing Process

©
PAGE 29 OF 42
4.1 Customize Client
To customize a SaaS client application, you need the client’s .dsi file.
NOTE: You need the Deployment Studio (Application Server) license only if you are planning to
deploy the customized client to a level below “System”.
1) Before you begin, read this guide, and part one (customization) of the client’s
administration and configuration guide to become familiar with the customization
process.
2) Prepare a list of elements that you want to customize. This list, updated during
customization, can then be used to test the customized client.
3) Customize the elements of the client as needed. Make sure to take notes of the
elements you customize.
4) Do not deploy right away.
5) Save the customized file with a name that reflects the scope of customization and that
is meaningful for you.
4.1.1 Reuse Existing Project

To reduce the amount of customization, it is recommended to reuse an existing project
when customizing a new version of the client. This will make the deployment process
more efficient.
To reuse an existing project:
1) Open an existing project (DSP file) for an earlier version of the same application.
2) Replace the DSI file with the DSI file for the new version of the application.
3) Make any additional changes that are necessary.
4) Save the project with a new name (as a new DSP file).
NOTE: The exceptions to the above process are as follows:
- When changing from a hosted thick to a hosted thin client
- When changing from version 17.2.xx to version 17.2.1xx of a hosted thin client
In those cases, you should NOT reuse the existing project but start a new project.
4.2 Deploy Custom Profile to Lab

It is strongly recommended that you deploy and test the customized client in a lab
environment before deploying it to a production system.
1) On the system where you are testing, create a new user group and a test user.
2) Assign appropriate services.
3) Using Deployment Studio, deploy the customized profile to the newly created group.

©
PAGE 30 OF 42
4.3 Test Customized Client
1) Log in to BroadWorks as the newly created test user and launch the client.
2) Using the notes that you took when customizing the client, verify each customized
element.
3) If you see any errors or discrepancies from the desired behavior, try to determine
whether they are caused by a software error or whether further customization is
required.
4.4 Report to BroadSoft via ExtraView

If you noticed any behavior that might be caused by a software error, contact BroadSoft by
creating a report in ExtraView.
4.5 Deploy Custom Profile to Production

Once you are satisfied with the customized version of the client, create a new user group
on a production system and deploy the customized client to this group. Create accounts
for users (agents and supervisors) who will use this version of the client and let them use
the system for a set period, and when comfortable deploy the desired hierarchy level
(system, service provider, group). Customized Hosted Thin clients can also be deployed
to specific users.

©
PAGE 31 OF 42
5 Client Deployment Models
With BroadWorks Deployment Studio, client software can be delivered to the end user
using a number of mechanisms.
5.1 Network Security

The following deployment models are independent of network security layers, providing
service providers and systems integrators with the flexibility to define new processes and
architectures, or to integrate into existing ones. For example, the client software or profile
can be deployed over a secure sockets layer (SSL)-based portal that enforces user
authentication.
5.2 SaaS Applications

This section describes the deployment process for the SaaS applications.
5.2.1 Overview
For the SaaS clients, both application executables and profiles are stored on BroadWorks.
To run a client application, the user clicks the application link on the web portal. The client
application executable and profile are then downloaded and launched. Therefore, there is
no need to distribute SaaS client software for installation on end users’ desktops.
5.2.2 Initial Software Release

The software and default profile are deployed in the network as part of the Application
Server build, and the customized profiles are uploaded to the network using Deployment
Studio, as specified in section 3.12 Assign and Deploy Profile (SaaS applications).
5.2.3 Subsequent Maintenance Releases

Client upgrades are deployed in the same way as the initial release. The application
software and the default profile are installed on the server and automatically accessed by
the end users the next time they use the application.
The existing customized profiles and user settings are not affected, as they are stored
separately from the application executables. Therefore, following a software upgrade,
administrators may need to upload new versions of the custom profiles. This depends on
the extent of application changes. For instance, an upgrade may just contain problem
corrections with no configuration changes, in which case, new profiles are not required.
On the other hand, a new release may contain a new application setting. In this case, it is
recommended to update customized profiles so that the default application setting is
correctly customized.

©
PAGE 32 OF 42
5.3 Desktop Applications
Desktop client software can be delivered using a number of mechanisms that span
multiple deployment mediums. There are three broad categories for mass client delivery:
 Web: Typically user-driven acquisition of software using a web portal and subsequent
desktop installation
 CD-ROM: Installation of software from compact disc media to specific endpoints
 Managed Network: For corporate and stricter network-based policy environments, in
which all software is pushed to user desktops through a centrally-managed layer
The references to deployment and update models provided here relate to the features
provided through the BroadWorks Deployment Studio software. Each deployment model
guides the reader through the typical processes for both an initial release and subsequent
maintenance updates. Even though the models have some elements in common, they
are all addressed separately to distinguish their specific considerations.
5.3.1 Software Pre-installation

BroadWorks client deployment wizards and scripts include compliancy checking prior to
installation to ensure that the user’s computer fulfills the client’s system requirements. If
the user’s system successfully passes these tests, the user is allowed to download and
install the software.
5.3.2 Software Post-installation

Once deployed, BroadWorks clients guide the user through the configuration process
using step-by-step wizards. For information on installing each client application, see its
corresponding Administration Guide.
5.3.3 Auto-detection of Software Updates

BroadWorks clients contain a mechanism that periodically checks an INI file hosted at a
specified network location to determine whether a software update is available. When an
update is available, the client notifies the user. The user can then choose to download
and install the new version of the client from the network location specified in the INI file.
Although the auto-detection mechanism is best adapted to the web deployment model, it
can be used with any initial deployment model. For more information, see section 5.3.4
Web Deployment Model (Internet/Intranet/Extranet).
When a new version of a client application is available, providers who choose to use this
method of deploying updates must:
 Use Deployment Studio to create a customized build of the client application.
 Place the customized build on a network location accessible to users.
 Update the INI file accessed by the corresponding client to indicate the availability of
the new version.
This auto-detection mechanism requires the client’s update settings (and Internet proxy
settings, if required) to be configured correctly. Providers may choose to pre-configure
these settings using Deployment Studio before initially deploying the client to end users.
For more information, see section 5.3.7 Deployment Customizations or the Deployment
Studio User Guide specific to your client application.

©
PAGE 33 OF 42
5.3.4 Web Deployment Model (Internet/Intranet/Extranet)
5.3.4.1 Overview
In this deployment model, providers host client software on either a content server that is
available on a public Internet site or on a private virtual private network (VPN) site
available to subscribers only. The general procedure to set up this deployment model is
as follows:
1) Create a custom software build in which the installer and update settings reflect the
web deployment model and the service provider environment. See the Deployment
Studio User Guide corresponding to the specific client application you plan to deploy.
2) Create a subsection of the service provider web site/portal as an entry point to
downloading the software. Use the sample Web Deployment Wizard pages supplied
with the BroadWorks client software, hosted on a standard HTTP Web Server such as
Apache or Microsoft IIS. Alternatively, create custom-designed specialized web
pages that contain similar pre-install scripts to confirm that the user matches or
exceeds the system requirements of the client.
3) Make sure all uniform resource locators (URLs) in the pages link correctly to the
software installer, which should also be hosted on the site or accessible through the
site (for example, via file transfer protocol [FTP]).
4) If the release is an update, additional editing of an INI file hosted with the software is
required so that the automated update process in the software can find software
updates, as they are made available.

©
PAGE 34 OF 42
Figure 20 Web Deployment

©
PAGE 35 OF 42
5.3.4.2 Initial Software Release
Service providers can easily adopt a pull-style deployment strategy with user-driven
installation. As BroadWorks clients are designed to be simple and intuitive to set up, this
model is viable in both residential and enterprise markets. One advantage to this strategy
is that it is quick to set up and manage. A corresponding disadvantage is that it relies on
the user to drive the deployment and installation process.
The following is a brief outline of a typical user interaction:
1) User accesses service provider portal.
2) User launches Web Deployment Wizard to verify software compatibility with the user’s
local system.
3) After all compliancy checks are made, the software can be downloaded and installed.
4) Any supporting third-party software such as runtime environments are manually or
automatically installed. For example, BroadWorks Receptionist requires the Java
Runtime Environment (JRE), and the sample Web Deployment Wizard supports an
automated JRE setup if the user has the required browser (IE5+).
5) If all required third-party libraries are installed successfully, the user proceeds to
download and set up the client application on the user’s local system.
5.3.4.3 Subsequent Maintenance Releases

BroadWorks clients have built-in support for updates. While this method still uses a pull-
style strategy and user-driven installation, users are automatically notified of the availability
of subsequent updates (assuming the Update settings on their client are configured
correctly).
Following is a brief outline of a typical user interaction.
1) The provider creates a customized build of the updated client application, places it in
an accessible location on the network, and includes that location in the INI file used by
the client auto-detection mechanism described in section 5.3.3 Auto-detection of
Software Updates.
2) The user is notified when an update of the software is available.
3) The user follows the prompts in the update wizard to download and install the new
version.
4) The wizard closes and automatically starts the new version’s installer.
5) The installer detects the previous version, then un-installs it, and begins the wizard to
install the new version of the client application.
6) The user follows the prompts to install the new version.
7) The new version is installed and the user continues as usual, until the next update
notification.

©
PAGE 36 OF 42
5.3.5 CD-ROM Deployment Model
5.3.5.1 Overview
In this deployment model, providers create a CD-ROM containing a custom build that is
installed on a single user’s machine or a set of machines. This deployment model is best
suited to smaller scale software deployments, especially for targeted installations and
situations where end-user training is delivered simultaneously.
The general procedure to set up this deployment model is as follows:
CD-ROM deployment model and the service provider environment (this is required if a
different deployment model is employed to distribute software updates, such as via
Internet).
2) Create a standard CD-ROM that contains the following:
− Custom build
− Pre-install scripts (either separate or integrated into custom build)
− Third-party runtimes (for example, the Java Runtime Environment required for
Receptionist)
− Training material (if these services are required)
− Other documentation or materials
CD-ROM Manual Installation
Client PC
Figure 21 CD Deployment

This deployment model combines a manual push-style deployment strategy with user-
driven installation. CD-ROM is a suitable model for deploying applications to individual
endpoints, which may require more complicated installation routines, larger file sizes, or
additional training services. Advantages to this strategy are that it ensures the software is
installed and configured correctly, and it allows user interaction. Disadvantages are that it
is only viable for small deployments, and it can be resource-intensive and time-consuming.
The following is a brief outline of a typical user interaction.
1) Install any prerequisite supporting software, such as third-party runtimes.
2) Launch pre-install scripts to ensure machine meets software prerequisites (if not
integrated into custom build).
3) Launch the client installer from the CD-ROM.

©
PAGE 37 OF 42
4) Configure the client software on the target machine.

Providers can supply subsequent maintenance updates in a similar way to the initial
installer. Following is a brief explanation of a typical user interaction:
1) Launch any independent pre-install scripts to ensure machine continues to meet latest
software prerequisites (if not integrated into custom update build).
2) Launch the client installer from the CD-ROM. The installer removes the previous
version and begins installing the new version.
3) Configure the client software on the target machine.
5.3.6 Managed Network
5.3.6.1 Overview
A managed network in most medium to large enterprises typically consists of a tightly
locked down desktop environment, in which all software is centrally managed. Mass
deployments are carried out using login scripts or third-party software to “push” pre-
configured applications to the endpoint. This allows moderate flexibility to network
administrators who wish to deliver software to a majority (or all) their managed user base
with minimal impact on day-to-day activities.
This model involves the network administrator or systems integrator performing the
following steps to package and deploy the software to a controlled desktop environment:
deployment model and the service provider environment. Important properties of this
type of build include:
− Silent Microsoft Installer (MSI) installation output
− Non-windowed mode (with other dialog preferences preset)
− Invalid/null web update settings (assuming updates are also controlled using the
managed network model)
2) Use MSI in conjunction with Windows software publishing or third-party network
management products to deploy to end users.

©
PAGE 38 OF 42
Figure 22 Network Deployment

This deployment model offers an automated push-style deployment strategy with an
installation process that is transparent to the end user. It is suitable for mass deployment
in a controlled desktop environment, in which specific installation rights need to be granted
to modify file systems and Windows registry.
Following is a brief outline of a typical user interaction:
1) Create a customized silent software build in which the installer and update settings
reflect the managed network deployment model.
2) An administrator can:
− Include the silent installation package as part of a login script typically run when a
user signs into any Network Operating System (Windows-based domain).

©
PAGE 39 OF 42
− Use additional server software such as Microsoft Systems Management Server
(SMS) to deliver software to endpoints and manage its installation. For more
information on SMS, see http://www.microsoft.com/smserver.
3) Depending on the technique used in step 2, the client can install on the user’s
machine in one of the following ways:
− The user logs in, initiating a silent installation of the pre-configured software in the
background.
− The user’s machine is remote-booted, and the client installs using a system or
administrator account. The next time the user logs in, the MSI automatically
repairs itself for that user.
4) On most occasions, a reboot is not required.
5) The installation contains predefined settings allowing the user to run the client.

Subsequent maintenance updates in the managed network deployment model are
performed almost identically to the initial update. Following is a brief outline of a typical
user interaction:
1) Create a customized silent software build of the updated client application, reflecting
the managed network deployment model.
2) A administrator can:
− Include the silent installation package as part of a login script typically run when a
user signs into any Network Operating System (Windows-based domain).
3) Depending on the technique used in step 2, the client installs on the user’s machine in
the following possible ways:
− The user logs in, initiating a silent installation of the pre-configured software in the
background.
− The user’s machine is remote-booted, and the client installs using a system or
administrator account. The next time the user logs in, the MSI automatically
repairs itself for that user.
4) The previous version is silently removed, and the new version is installed. A reboot
should not be required.
5) The user may proceed to run the client.
5.3.7 Deployment Customizations

The Deployment Studio aids providers in implementing their choice of deployment model
by allowing them to pre-determine the behavior of the client installer and the settings used
by the client for automatic upgrades.
5.3.7.1 Installer
In addition to branding settings that control the icons, logos, and product names displayed
in the client installation wizard, client installers may be configured in the following ways:
 Windowed versus silent install: Providers can have the BroadWorks installation
program run in either interactive windowed mode or a silent non-interactive mode that
runs in the background.

©
PAGE 40 OF 42
 Include custom pre-install scripts: Providers can include custom scripts that the client
installer runs before performing the client application. These scripts can be used to
check system requirements or to force the installation of prerequisite software
components.
 Default installation folder: Providers can specify the default installation paths for the
client.
 Retain user preferences: Providers can determine whether user preferences from
previous installations are retained.
 Prompt to close host application (Outlook/Internet Explorer) dialog: This message can
be customized with information specific to the provider in applicable clients.
The following table indicates the type of deployment model recommended for each of
these installer customization options.
Customization Feature Web CD-ROM Managed Network
Windowed Install Y Y
Silent Install Y
Include Custom Pre-install Scripts Y Y
Default Installation Folder Y Y Y
Retain User Preferences (Silent) Y Y Y
Prompt to Close Host Application Y Y

(OL/IE) Dialog
5.3.7.2 Updates
Update customizations allow the service provider to pre-set or customize the settings used
by the client to auto-detect new software updates. Customizable settings include:
 Silent update checking host/URL: Presets the host and URL the client connects to
when checking for updates.
 Auto update proxy: Presets a web or SOCKS proxy the client uses to access the
Internet when checking for updates.
 Auto update INI file location: Specifies the location of the INI file that instructs clients
when a new product update is available for download.
The following table indicates the type of deployment model recommended for each of
these installer customization options.
Customization Feature List Web CD-ROM Managed Network
Silent Update Checking Host/URL Y Y -
Auto Update Proxy (Silent Updates) Y Y -
Auto Update INI File Location Y Y -

©
PAGE 41 OF 42
Index
Administrative entity, selecting, 23 Logging in to BroadWorks, 22

Assigning Profile, 20 Managed network, 38
Associated image, set, 19 Initial software release, 39
Auto-detection of software updates, 33 Subsequent maintenance release, 40
Build installer, 20 Menu, 26
File, 26
CD-ROM
Help, 27
Deployment, 37
Tools, 27
Initial software release, 37
View, 26
Subsequent maintenance releases, 38
Network security, 32
Client applications, 11
Network, managed, 38
Client customization, SaaS applications, 30
Planning client deployment, 32
Client deployment, planning, 32
Post-installation, 33
Create project, 18
Auto-detection of software updates, 33
Custom profile to lab, 30
Pre-installation, 33
Customization options, 12
Profile
Customizations, deployment, 40 Assigning, 20
Customize project file, 19 Deploying, 20
Customized client, testing, 31 Removing, 25
Customized SaaS application, testing, 28 Uploading, 25
Deploy Profile, 20 Project
Deploying Create, 18
Desktop applications, 33 Create new, 18
Profile, 25 Customize file, 19
SaaS applications, 32 Edit existing, 18
Save, 19
Deployment customizations
Installer, 40 Removing profile, 25
Updates, 41 SaaS applications, 11
Deployment functions, 13 Client customization, 30
Deployment models, 32 Custom profile to production, 31
CD-ROM, 37 Customization best practices, 28
Deploy custom profile to lab, 30
Customizations, 40
Deployment, 32
Managed network, 38
Network security, 32 Report to BroadSoft via ExtraView, 31
Post-installation, 33 Test customized client, 31
Pre-installation, 33 Save project, 19
Web, 34 Set associated image, 19
Deployment Studio window, 17 Subsequent maintenance releases, 40
Deployment Studio, capabilities, 12 CD-ROM, 38
SaaS applications, 32
Desktop applications, 11
Deployment, 33 Web, 36
File menu, 26 Testing customized SaaS application, 28
Files and folders, 16 Tools menu, 27
Help menu, 27 Updates, 41
Initial software release, 39 Uploading profile, 25
CD-ROM, 37 View menu, 26
SaaS applications, 32 Web deployment
Web, 36 Initial software release, 36
Installer, 40 Subsequent maintenance release, 36
Build, 20 Workflow, 14

©
PAGE 42 OF 42

Broadworks Deployment Studio: User Guide

Uploaded by

Copyright:

Available Formats

Broadworks Deployment Studio: User Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Broadworks Deployment Studio: User Guide

Uploaded by

Copyright:

Available Formats

BroadWorks Deployment Studio

9737 Washingtonian Boulevard, Suite 350

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

Release Version Reason for Change Date Author

14.sp1 1 Created document. March 1, 2007 Natasha Jayasinghe

14.sp1 1 Edited and published document. May 4, 2007 Andrea Fitzwilliam

14.sp6 1 Reviewed changes. May 22, 2008 Wendell Keuneman

16.0 1 Made minor editorial changes. February 6, 2009 Patricia Renaud

17.0 1 Updated section 3.12.1 Log In to March 3, 2010 Goska Auerbach

17.0 2 Updated section 3.12.1 Log In to May 7, 2010 Goska Auerbach

17.0 2 Added section 4 SaaS Application June 1, 2010 Goska Auerbach

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

19.0 1 Edited changes. November 1, 2012 Patricia Renaud

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

1 Summary of Changes ...................................................................................................................8

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

Figure 1 Navigational Tree for Desktop Clients ...................................................................................... 12

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

1.1 Changes for Release 21.0, Document Version 4

1.2 Changes for Release 21.0, Document Version 3

1.3 Changes for Release 21.0, Document Version 2

1.4 Changes for Release 21.0, Document Version 1

1.5 Changes for Release 20.0, Document Version 1

1.6 Changes for Release 19.0, Document Version 1

1.7 Changes for Release 18.0, Document Version 2

1.8 Changes for Release 18.0, Document Version 1

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

1.10 Changes for Release 17.sp2, Document Version 1

1.11 Changes for Release 17.0, Document Version 2

1.12 Changes for Release 17.0, Document Version 1

1.13 Changes for Release 16.0, Document Version 2

1.14 Changes for Release 16.0, Document Version 1

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

2.1 About This Guide

2.2 About Deployment Studio

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

3.2 Client Applications

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

Figure 1 Navigational Tree for Desktop Clients

Figure 2 Navigational Tree for SaaS Clients

Deployment Studio provides client customization within the following:

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

Figure 3 Open Existing Project Dialog

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

Figure 5 Files and Folders Dialog

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

3.6 Use Deployment Studio

Figure 6 Deployment Studio

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

3.7 Create or Open Project

3.7.1 Create New Project

3.7.2 Open Existing Project

BROADWORKS DEPLOYMENT STUDIO USER GUIDE 40-CA5706-00

3.9 Customize Application

3.10 Save Project

Figure 7 Save Project Dialog