Article ID: 52335 - Last Review: November 19th 2015
INFORMATION
The MiContact Center installation routine can be run silently on either a new installation, or during repair installs. The purpose of this article is to provide information and guidance on installing silently, and how to perform silent repair installations. This article will cover Enterprise Server installations, Remote Server installations, and Client installations.
INTRODUCTION
The installer can be reached in one of two ways:
- The initial installer MiContact Center extracted directory will contain a Setup.exe file
Note: The Setup.exe will install the core installation components (Chocolatey and .NET 4.5) then pass the command line arguments to the MiCC.Installer.Core.exe - For previous installations, the MiCC.Installer.Core.exe will be used, and can be found in
<Install Drive>\Program Files (x86)\Mitel\MiContact Center\PFInstaller\MiCC.Installer.Core.exe
At any point you can view thehelp information from the installation executable by running Setup.exe from the command line with the help command line switch. Help is accessible by using anyof the following switches (switches are not case sensitive):
- /h OR -h
- /? OR -?
- /help OR -help
The list of available installercommand line switches are:
- /silent OR /s
- /workflow=<WORKFLOW FILENAME> OR /w=<WORKFLOW FILENAME>
- /uninstall OR /u
- /path=<INSTALLATION PATH> OR /p=<INSTALLATION PATH>
- /features=<FEATURENAME,FEATURENAME> OR /f=<FEATURENAME,FEATURENAME>
- /username=<DOMAIN\USERNAME> OR /un=<DOMAIN\USERNAME>
- /password=<PASSWORD> OR /pw=<PASSWORD>
- /key=<SERIAL KEY> OR /k=<SERIAL KEY> *
- /authentication=<BASIC|WINDOWS> OR /a=<BASIC|WINDOWS> *
- /sqlusername=<USERNAME> OR /sqlun=<USERNAME> *
- /sqlpassword=<password> OR /sqlpw=<PASSWORD> *
- /sqlinstance=<INSTANCENAME> OR /sqli=<INSTANCENAME> *
- /SSL
- /country=<COUNTRY> *
- /timezone=<TIMEZONE-ID> OR /tzone=<TIMEZONE-ID> *
- /languagecode=<LANGUAGECODE> OR lcode=<LANGUAGECODE> *
- /updaterip=<IPADDRESS>
- /enterpriseip=<IPADDRESS>
- /role=<ROLE>
Note: Items marked with an asterisk (*) are available onthe Enterprise Server deployment only.
SWITCHDESCRIPTIONS
Detailed descriptions for each ofthe command line switches and their example usages follow. For sample installation scripts, please see EXAMPLES below.
/SILENT
The silent switch indicates tothe Setup executable that the program is being run from the command line, andwill not display the installation user interface. When using the silent command line switch you must pass a workflow to execute.
Example:
Setup.exe /workflow="Enterprise Server.deploy"
/WORKFLOW
The workflow switch is required to instruct the installer which workflow to follow. There are three available workflows based upon which installation you need to run, and one utility workflow. The installation workflows are:
- Enterprise Server.deploy
- Remote Server.deploy
- Client Component Pack.deploy
The utility workflow is available for Enterprise Servers if you need to update a license. This is useful if you installed with a demonstration license, and need to apply a serial key to the installation. This utility workflow is:
- Update License.deploy
By default only the Enterprise Server, and Update License workflow files are in the PFInstaller folder, in order to obtain the Remote Server or Client Component Pack workflow files, see the PFInstaller\Supplemental folder.
Example:
Setup.exe /silent/workflow="Enterprise Server.deploy"
/UNINSTALL
The uninstall switch is used when removing the installed software from the server or client. In order to uninstall you must specify the workflow that corresponds to the software deployment you need to uninstall. To determine the appropriate workflow, see/WORKFLOW.
Example:
Setup.exe /silent/workflow="Enterprise Server.deploy" /uninstall
/PATH
The path switch indicates to the installation where to deploy the application. The path switch allows for anexact location to be specified, or through the use of available windows environment variables.
Example:
Setup.exe /path="C:\Program Files (x86)\Mitel\MiContact Center"
/FEATURES
The features switch determines which features should be deployed, depending on which features you will use based on the deployment type and server usage. Some features may not be available based upon your purchased licenses. If you have not purchased a license for a feature specified during installation, it will not be enabled.
The list of features availablefor an Enterprise Server are:
- WorkforceScheduling
- IVRServices
- WorkforceManagement
- MultimediaFeatures
- OffboardAcdForVoice
- Wallboard
- SiteBasedSecurity
The list of features availablefor a Remote Server are:
- ContactCenterClient
- YourSiteExplorer
- IVRServices
- RemoteCollector
- MultimediaFeatures
- Wallboard
- ProxyUpdater
The list of features availablefor a Client are:
- Ignite
- ContactCenterClient
- FlexibleReporting
- ContactCenterSoftphone
- MitelBorderGatewayConnector
- WorkforceScheduling
- YourSiteExplorer
- SalesforceConnector
- EmployeePortal
Example:
Setup.exe /features="IVRServices,MultimediaFeatures,Wallboard"
/USERNAME
The username switch is used to identify the Windows identity of the account you wish to use as the MiContactCenter service account. If using a domain account, you must specify the domain and username. If using a local system account, you must specify the machine name as the domain.
Example:
Setup.exe /username="MITEL\MiCC.Service"
Setup.exe /username="MICCPROD01\MiCC.Service"
/PASSWORD
The password switch is used inconjunction with the /USERNAME command switch and specifies the password for the Windows identity used for the MiContact Center service account.
Example:
Setup.exe /username="MITEL\MiCC.Service" /password="2Vl*^uJA"
/KEY
The key switch is required forEnterprise Server deployments if you wish to apply a purchased license uponinstallation. If no /KEY switch is used on a silent installation, a demonstration license will automatically be applied.
Example:
Setup.exe /key="ABCD1-BU476-ARU9Q-S4B24-BH8Q7-7"
/AUTHENTICATION
The authentication switchspecifies which authentication methodology to use for the MiContact Centerdeployment. There are two possible options for this switch depending on the behavior you wish to use:
- Windows
- Basic
The Windows option specifies toenable Windows Authentication.
The Basic option specifies to utilize MiContact Center Authentication.
Example:
Setup.exe /authentication=Windows
/SQLINAME
The sqliname switch specifies theSQL server and if required the name of the SQL instance to use for the MiContact Center databases. The command should be in the form of SERVERNAME\INSTANCE or if no instance name is required simply SERVERNAME.
Example:
Setup.exe /sqliname="SQLPROD01\MICC"
Setup.exe /sqliname="SQLPROD04"
/SQLAUTHENTICATION
The sqlauthentication flag indicates to the installer which method to use for the connection string when connecting to the specified SQL Server. This will depend on the configuration of your SQL Server, if Windows or Mixed Mode authentication is configured. The two parameters that can be passed for this switch are:
- Windows, for Windows Authentication
- SQL, for Mixed Mode - SQL based authentication
Example:
Setup.exe /sqlauthentication=windows
Setup.exe /sqlauthentication=sql
/SQLUSERNAME
Used in conjunction with theSQLAuthentication and SQLPassword flags, the sqlusername command line switch indicates the username to use when connecting to the specified SQL instance.The username is passed in one of two formats, depending on your specified authentication method:
- DOMAIN\USER, when using Windows Authentication
- USER, when using SQL based authentication
Example:
Setup.exe /sqlusername="MITEL\MiCC.Service"
Setup.exe /sqlusername="MiCCService"
/SQLPASSWORD
Used in conjunction with the SQLAuthentication and SQLUsername flags, the sqlpassword command line switch indicates the password that corresponds with the supplied username when connecting to the configured SQL instance.
Example:
Setup.exe /sqlpassword="2Vl*^uJA"
/SSL
The SSL flag indicates to the installer that this MiContact Center Enterprise will be configured to communicate and accept communications where applicable using SSL. When settingthis flag, the EnterpriseIP flag must contain an FQDN as opposed to an IP address.
Example:
Setup.exe /SSL
/ENTERPRISEIP
The enterpriseip command lineswitch indicates to the installer the IP address or FQDN of the MiContactCenter Enterprise server. When using the SSL flag, you must specify an FQDN in this field.
Example:
Setup.exe /enterpriseip="10.1.100.15"
Setup.exe /enterpriseip="MICCPROD01.Mitel.com"
/UPDATERIP
The updaterip command line switch is available for remote servers and client installations only. Specifying this flag and specifying an IP address or FQDN indicates to the Updater Service to download application and service updates from the specified Remote Server.
Example:
Setup.exe /updaterip="10.1.100.15"
Setup.exe /updaterip="MiCCPROD01.Mitel.com"
/COUNTRY
The country flag is used to determine the regional settings for the MiContact Center Enterprise Server. Ifthis value is not passed, the installer will default to "Canada".When specifying country you must use the full name of the country, not theshort form or international country code.
Common country names that can beutilized are:
- United States
- United Kingdom
- Canada
- Virgin Islands- U.S.
- Virgin Islands- British
- Germany
- Netherlands
- France
Example:
Setup.exe /country="United States"
Setup.exe /country="United Kingdom"
/TIMEZONE
The timezone flag indicates theID of the timezone that the server will reside in. If you do not specify thetime zone, the installation will automatically use the time zone of the system the software is being installed to. You should typically never need to set this option, however it is provided in the event it is required.
The most commonly used time zoneID's are:
- Pacific Standard Time
- Central Standard Time
- Eastern Standard Time
- UTC
- GMT Standard Time
- Middle East Standard Time
- AUS Eastern Standard Time
For a full list of available timezone ID's, please see the attached Timezones.xlsx
Example:
Setup.exe /timezone="Eastern Standard Time"
/LANGUAGECODE
The language code specifies tothe installer what the default MiContact Center language should be. This mustbe selected from the supported list of languages:
- zh-CN (Chinese Simplified)
- nl-NL (Dutch Netherlands)
- en-GB (English United Kingdom)
- En-US (English United States)
- Fr-CA (French Canadian)
- Fr-FR (French France)
- De-DE (German)
- It-IT (Italian)
- Pt-BR (Portuguese Brazil)
- Ru-RU (Russian)
- Es-CL (Spanish Chile)
- Es-ES (Spanish Spain)
- Sv-SE (Swedish)
- Nb-NO (Norwegian)
By passing the language code, the installer will set the default language for the Enterprise. If no language code is passed, the system will default to en-US.
Example:
Setup.exe /languagecode="en-US"
/ROLE
The role command line flag indicates the client role to install when deploying client applications. The role flag can be used to automatically create the shortcuts for applications based upon the role you select. This can be used in place or in conjunction with the /FEATURES flag on client installation. You can select one of the following roles:
- Supervisor
- Agent
- Administrator
Example:
Setup.exe /role=Agent
SAMPLEINSTALLATIONS
The following section outlines a few commonly used installation scenarios. Each scenario will describe the use case, and provide the full installation string to utilize. In your deployment some switches such as language, and country may be modified to meet your deployment needs.
BASIC ENTERPRISESERVER WITH BASIC AUTH AND LOCAL SQL
This installation will perform aninstallation of the MiContact Center Enterprise Server allowing features to be enabled based upon the license key. We are specifying a Windows Domain account for the services, and specifying to use basic MiContact Center authentication for client access. The local SQL Express server will use Windows Authentication. Finally, we are specifying that this Enterprise Server will use SSL and the Enterprise IP address will be configured using the FQDN of MICCPROD01.MITEL.COM
Setup.exe /silent/workflow="Enterprise Server.deploy"/username="MITEL\MiCC.Service" /password="2Vl*^uJA"/key="ABCD1-BU476-ARU9Q-S4B24-BH8Q7-7"/authentication="basic" /sqlauthentication="windows"/sqliname=".\SQLEXPRESS" /sqlusername="MITEL\MiCC.Service"/SSL /enterpriseip="MICCPROD01.MITEL.COM"
BASIC ENTERPRISESERVER WITH WINDOWS AUTH AND REMOTE SQL
This installation will perform aninstallation of the MiContact Center Enterprise Server allowing features to be enabled based upon the license key. We are specifying a Windows Domain accountas the service account, specifying to utilize Windows authentication for clientaccess, and Windows authentication for communicating with the SQL Server. TheSQL Server is remote, exists on SQLPROD04 and does not require an instancename, and the MiCC Service account will be used for communication. We do not need to specify the Windows password for the Windows Domain account because we're using Windows authentication. Finally, we are indicating that we will beusing SSL on this enterprise, and to configure the enterprise IP address as an FQDN of MiCCPROD01.MITEL.COM
Setup.exe /silent/workflow="Enterprise Server.deploy"/username="MITEL\MiCC.Service" /password="2Vl*^uJA"/key="ABCD1-BU476-ARU9Q-S4B24-BH8Q7-7"/authentication="windows" /sqlauthentication="windows"/sqliname="SQLPROD04" /sqlusername="MITEL\MiCC.Service"/ssl /enterpriseip="MICCPROD01.MITEL.COM"
ENTERPRISESERVER LICENSE KEY UPDATE
This setup command will silently update the Enterprise Server license key. This is achieved by specifying the Update License deployment workflow, and passing the license key using the key command line switch. This is particularly useful when an Enterprise has been deployed using a demonstration license, and you must apply the purchased license to the server.
Setup.exe /silent/workflow="Update License.deploy"/key="ABCD1-BU476-ARU9Q-S4B24-BH8Q7-7"
REMOTE SERVERWITH IVR SERVICES AND REMOTE UPDATE PROXY
This is a basic Remote Server installation with IVR Services and configuring the Remote Server to service application and service update requests from clients. We have specified the Remote Server workflow, and configured the service account username and password. Finally, we've determined that we will be using SSL to connect to the Enterprise Server, and specified the Enterprise Server IP address as the server FQDN.
Setup.exe /silent/workflow="Remote Server.deploy"/username="MITEL\MiCC.Service" /password="2Vl*^uJA"/features="YourSiteExplorer,IVRServices,ProxyUpdater" /SSL/enterpriseip="MICCPROD01.MITEL.COM"
BASIC CONTACTCENTER AGENT CLIENT INSTALLATION WITH ALTERNATE UPDATE LOCATION
This basic client installation will deploy the client component pack with the Ignite and Contact Center Client features enabled. We are specifying the Enterprise IP address as the FQDN of the MiContact Center server, and indicating we wish to use SSL for communication where applicable. Finally, we have specified an alternate download location for applications and services from the MICCREMOTE01 server.
Setup.exe /silent/workflow="Client Component Pack.deploy"/features="Ignite,ContactCenterClient"/enterpriseip="MICCPROD01.MITEL.COM" /SSL/updaterip="MICCREMOTE01.MITEL.COM"
Applies To: 8.0 and above