Parameters

Parameter

Required / Optional

Description

Instance!Number Required

Numeric ID from 1 to 99 for Communications Manager instance to be started.

For Docker deployment, it is always set to 1.

Instance!DatabaseType Required when Instance!DatabaseType has a value. Optional otherwise. The type of the database to be used by the Communications Manager Repository of the instance. Specify SQLServer or Oracle.
Instance!DatabaseMode Required when the instance is not secondary and Instance!DatabaseType has a value. Not allowed otherwise.

Allowed values:

  • New - the database for the Communications Manager Repository is expected to be empty.
  • Existing - the database for the Communications Manager Repository is expected to have content, with the same Partner and Customer.

For a secondary instance, when this parameter has a value, it is implicitly set to Existing.

Instance!DatabaseConnectionString Required when Instance!DatabaseType has a value. Not allowed otherwise.

The ODBC connection string to be used by the Communications Manager Repository server to connect to the database.

Make sure that the database exists on the database server and is empty.

Do not specify user name or password in this connection string. The database user account is configured using the specific parameters described below.

For SQL Server database, consider the following:

  • Default authentication method is SQL Server authentication.
  • Windows authentication is also supported. To enable it, leave out the database user and password parameters.
Instance!DatabaseUser

Optional:

  • Required for connection to Oracle database or to SQL Server database using SQL Server authentication.
  • Can be omitted whenever you have a connection string that does not require a user and password, for example, for connection to SQL Server database using Windows authentication.

The database user account that Communications Manager Repository server will use to connect to the database.

Required to connect to Oracle database or to SQL Server database using SQL Server authentication. Make sure the account has the required roles and privileges, as described in the Communications Manager Repository database section of this guide.

Instance!DatabasePassword Optional.

Required for Oracle database user and for SQL Server connection using SQL Server authentication.

The database password that Communications Manager Repository server will use to connect to its database.

The password cannot contain double quotes.

Instance!LicenseFile Required when you run the tool for the first time. Optional otherwise. Mutually exclusive with Instance!LicenseServerUrl.

The location of the .xml file with the license information.

Instance!LicenseServerUrl Required when you run the tool for the first time. Optional otherwise. Mutually exclusive with Instance!LicenseFile.

The URL to the TotalAgility license server API, for example, https://<machine name>/TotalAgility/Services/Sdk/LicenseClient.

Instance!LicenseServerApiKey Optional. Required when Instance!LicenseServerUrl has a value.

The API key for the license server access.

Instance!LicenseServerIgnoreCertificate Optional. Defaults to false when omitted.

A boolean flag that determines whether the certificate of the license server should be verified (true) or ignored (false).

Instance!ExampleProject Required when Instance!DatabaseMode=New. Not permitted to be specified otherwise.

Boolean flag that specifies if the "InstallationTest" example project should be imported in the Communications Manager Repository database. When the project is imported, a snapshot will also be created for it automatically.

Instance!DatabaseLoadFrom Optional.

Only allowed when Instance!DatabaseMode=New

Repository dump file to load into the repository database while starting the instance. When omitted, no database dump will be loaded.

See the Dump and load the Repository database section in the Tungsten Communications Manager Repository Administrator's Guide for more information on creating database dump files.

Instance!ImportConfigurationFile Optional

Path to exported configuration file that will be loaded automatically when a Communications Manager instance is installed. See the Export functionality and initialization of new components topic for more information.

If omitted, default initial configuration will be applied.

Instance!ImportInfrastructure

Required if

Instance!ImportConfigurationFile

value was specified.

Boolean flag that specifies whether the exported configuration should be loaded with or without infrastructure. See the Export functionality and initialization of new components topic for more information.

Instance!ContinueInstallationOnFailedDatabaseCheck Optional

If set to True, it indicates that execution should continue even when the database access check returns a negative result.

This might result in a failure later, when the database connection cannot be established.

Registration!Partner Required when you run the tool for the first time. Optional otherwise.

Partner that will be specified when the new Communications Manager instance is registered on the Contract Manager.

This information is stored in the Communications Manager Repository database.

Partner information will be used for verification when the database is connected to another Communications Manager instance.

Registration!Customer Required when Registration!Partner has a value. Optional otherwise.

Customer that will be specified when the new Communications Manager instance is registered on the Contract Manager.

This information is stored in the Communications Manager Repository database.

Customer information will be used for verification when the database is connected to another Communications Manager instance.

Registration!ContractManagerRegistrationPort

Required if the Contract Manager is installed remotely.

Otherwise, must be omitted.

The registration port of the Contract Manager.

Registration!ContractManagerLocation Required when you run the tool for the first time. Optional otherwise.

Specifies the Contract Manager location when registering the new Communications Manager instance:

• If set to Local, the instance will be registered on the Contract Manager on the local server.

• If set to Remote, the instance will be registered on the Contract Manager on a remote server.

• If set to None, the instance will not be registered on the Contract Manager.
Registration!ContractManagerHost Required when the Contract Manager is remote or when a configuration with infrastructure is imported. Not permitted otherwise.

The host of the Contract Manager on which the instance will be registered.

Specify server name or IP address.

Registration!UseExampleWebApp Required when you run the tool for the first time.

Not allowed when the instance is secondary.

A boolean flag that indicates whether an example web application will be created for this Communications Manager instance.

Registration!ExampleWebAppName Required if Registration!UseExampleWebApp was set to True.

Not allowed when the instance is secondary.

The name of the example web application that will be created for the instance.

Instance!DesignerAdministratorAccountPassword Optional

The password for the Communications Manager Designer Administrator account.

For this password to be accepted by Communications Manager Repository server, it must meet the following requirements:

  1. Have at least the minimal safe password length. Default minimum is 20 characters.
  2. Only contain letters (a-z, A-Z), numbers (0-9), and the "-" (En dash) and "_" (underscore) characters.

If omitted, or if the specified password does not meet the requirements, a default password will be generated.

This default password will only be available in the output console. To change it, refer to the Change your password topic in Tungsten Communications Manager Designer Help.
Registration!NewContract

Required if the registration was changed and Registration!ContractManagerLocation is not None.

Optional otherwise, with default False.

Not allowed if the instance is secondary.

Boolean flag that specifies whether to create a new contract:

  • If set to True, the contract for the instance will be created by the registration process.
If the registration process detects that the contract already exists, registration will fail.
  • If set to False, the contract for the instance is assumed to exist and be available.
The registration will fail if the contract does not exist, or if the contract exists and is already associated with another active Communications Manager instance.
Registration!Force Optional.

Not allowed if the instance is secondary.

This parameter is only relevant when Registration!NewContract=False.

Boolean flag that specifies whether to overwrite an association between the existing contract and Communications Manager instance:

  • If set to True, registration will not fail after detecting an existing contract associated with another active Communications Manager instance – instead, this association will be overwritten.
  • If set to False, registration will fail.
Services!Password Required if either Instance!DatabaseUser or Instance!LicenseServerApiKey has a value.

The password for the Communications Manager service account.

If you plan to configure the Communications Manager instance by importing a configuration with infrastructure, this will also include Communications Manager instance registration. In this scenario, the Registration!Partner, Registration!Customer, Registration!ContractManagerLocation, and Registration!ContractManagerHost parameters override the settings from the configuration file.