Settings file worksheet

Last Updated : Jan 28, 2020 |

In the following tables, populate the parameter values suitable for your deployment. You must configure these system-wide parameters in the 46xxsettings.txt file for Avaya Vantage™ to interoperate with an Open SIP controller.

For detailed parameter descriptions, see Appendix A.

System settings

Parameter

Your value

FILE_SERVER_URL

TRUSTCERTS

ADMIN_PASSWORD or PROCPSWD

ISO_SYSTEM_LANGUAGE

ADMINTIMEFORMAT

TIMEZONE

Optional.

If the Avaya installation wizard appears during the initial device setup, the device retrieves the time zone and country information from the network. You can override these local values by setting the TIMEZONE and COUNTRY parameters.

COUNTRY

Optional.

PUSH_APPLICATION

ACTIVE_CSDK_BASED_PHONE_APP

If you want to keep the Avaya Vantage™ built-in unified communication experience as the primary communication application, you do not need to set this parameter. Keep the default value.

If you want to use Avaya Vantage™ as a generic Android device with a third-party communication application instead, replace the default value with an empty string ().

Network settings

Parameter

Your value

DNSSRVR

DOMAIN

SNTPSRVR
Important:

You must configure SNTPSRVR if the default Avaya and NIST SNTP servers are not accessible over the internet. Specifying an SNTPSRVR value that is reachable from your network is essential for SIP registration and initial device setup when you start up Avaya Vantage™.

SIP interface settings

Parameter

Your value

Notes

SIPDOMAIN

SIP_CONTROLLER_LIST

The BroadSoft server does not support TLS as the transport type. If you want to use TLS, you must have a Session Border Controller (SBC). BroadSoft is certified with the ACME SBC.

For information about the supported transport types for other Open SIP servers, see Appendix B.

SIMULTANEOUS_REGISTRATIONS

With BroadSoft or RingCentral, set this parameter to 1.

ENABLE_SIP_USER_ID

0 or 1

Optional. This parameter is only for an Open SIP environment.

Set this parameter to 1 if you need to distinguish between the SIP user name and SIP user ID for SIP authentication and SIP registration respectively. If you set the parameter to 0, Avaya Vantage™ considers the user name to be identical to the user ID.

When you set ENABLE_SIP_USER_ID to 1, the Avaya Vantage™ Login screen displays the following fields:

  • Username for entering the SIP user name.

  • Password for entering the SIP user password.

  • Authentication username for entering the SIP user ID.

When you set ENABLE_SIP_USER_ID to 0, the Authentication username field is not available to the device user during login.

Server environment settings for Open SIP

The following are the core configuration parameters that you can set to identify that the deployment environment is an Open SIP environment.

Parameter

Your value

Notes

ENABLE_3PCC_ENVIRONMENT

1

Required parameter.

When set to 1, Avaya Vantage™ identifies the deployment environment as Open SIP.

ENABLE_AVAYA_ENVIRONMENT

0

Required parameter.

When set to 0, Avaya Vantage™ operates in a mode to comply with the third-party SIP proxy provisioning.

DISCOVER_AVAYA_ENVIRONMENT

0

Required parameter.

When set to 0, discovery of Avaya Aura® AST features is disabled.

3PCC_SERVER_MODE

Required parameter.

This parameter specifies with which Open SIP server the device interworks.

When set to 0, Avaya Vantage™ identifies the call control server as a generic Open SIP server.

When set to 1, Avaya Vantage™ identifies the call control server as BroadSoft. You can also use 1 for an environment with RingCentral as the call control server.

When set to 2, Avaya Vantage™ identifies the call control server as 3CX.

UPGRADE_POLICY

0

Required parameter.

The BroadWorks Device Management server uses the push mechanism for software upgrades. Therefore, retain the default value for the parameter.

XSI_URL

Optional.

You can define this parameter to support BroadSoft directory contacts on Avaya Vantage™ through the BroadSoft Xtended Service Interface (Xsi).

SUBSCRIBE_LIST_NON_AVAYA

message-summary

Optional.

You can define this parameter to support voice mail. If you do not define this parameter, the device does not subscribe for messages.

SIP subscriber-level settings

You can define the following optional device-specific parameters in the individual device-specific file settings so that the device can automatically log in to the SIP controller or server for registration and authentication. These settings must be unique across devices in order to match the settings for a SIP trunk or subscriber the Open SIP environment.

Parameter

Your value

Notes

FORCE_SIP_USERNAME

Configure this parameter with the SIP user name.

FORCE_SIP_PASSWORD

Configure this parameter with the SIP user password.

FORCE_SIP_EXTENSION

When you set ENABLE_SIP_USER_ID to 1, configure this parameter with the SIP user ID for SIP authentication.

When ENABLE_SIP_USER_ID is set to 0, do not configure this parameter. Avaya Vantage™ uses the value in FORCE_SIP_USERNAME for both SIP authentication and SIP registration.