Attribute details defined in the Session Manager communication profile XSD

Last Updated : Nov 21, 2024 |

Attribute

Attribute Description

Mandatory/Optional

Validation Constraints

Policy

policyType

When you enable the Enable Policy Based Assignment of Session Managers field on the Elements > Session Manager > Global Settings page, the system displays the Policy field to select the required policy for the Session Manager communication profile.

Based on the policy selection, the system displays the relevant fields. The options are:

  • fixed

  • fixed-region

  • location-region

Note:

If the Enable Policy Based Assignment of Session Managers field on the Elements > Session Manager > Global Settings page is not enabled, the system displays the Primary Session Manager and Secondary Session Manager fields similar to Release 8.1.x and earlier system.

-

Primary Session Manager

primarySM

When the policy type is fixed, the system displays this field.

The name of the Session Manager instance used as the home server for a communication profile. As a home server, the primary Session Manager instance is used as the default access point for connecting devices associated with the communication profile to the Avaya Aura® network.

Mandatory

-

Secondary Session Manager

secondarySM

When the policy type is fixed, the system displays this field.

If a secondary Session Manager instance is specified, this Session Manager provides continued service to SIP devices associated with this communication profile when the primary Session Manager is unavailable.

Optional

-

Third Session Manager

thirdSM

When the policy type is fixed, the system displays this field.

The Session Manager instance you select as the third Session Manager. It provides continued service to SIP devices associated with this communication profile when the primary or the secondary Session Manager server becomes unavailable.

Optional

-

Fourth Session Manager

fourthSM

When the policy type is fixed, the system displays this field.

The Session Manager instance you select as the fourth Session Manager. It provides continued service to SIP devices associated with this communication profile when the primary, secondary, or third Session Manager server becomes unavailable.

Optional

-

Primary Region

primaryFixedRegion

When you select the fixed-region policy type, the system displays this field.

The Session Manager region you select as the primary region. You must select the primary region of the Session Manager server.

Mandatory

-

Secondary Region

secondaryFixedRegion

When you select the fixed-region policy type, the system displays this field.

The Session Manager region you select as the secondary region.

Optional

-

Third Region

thirdFixedRegion

When you select the fixed-region policy type, the system displays this field.

The Session Manager region you select as the third region.

Optional

-

Fourth Region

fourthFixedRegion

When you select the fixed-region policy type, the system displays this field.

The Session Manager region you select as the fourth region.

Optional

-

Survivability Server

survivabilityServer

For local survivability, you can specify the name of a survivability server, a SIP entity, to provide survivability communication services for devices associated with a communication profile if the local connectivity to Session Manager instances in the Aura Core is lost.

If you specify a Branch Session Manager, and the termination and origination application sequences contain a Communication Manager application, sequencing to this application continues, locally, to the Communication Manager remote survivability server resident with the Branch Session Manager.

Note:

If a termination or origination application sequence contains a Communication Manager application, the Communication Manager associated with the application must be the main Communication Manager for the Communication Manager remote survivability server resident with Branch Session Manager.

Optional

-

Max. Simultaneous Devices

maxSimultaneousDevices

The maximum number of endpoints that you can register at a time by using this communication profile. If you register more than one endpoint, all the endpoints receive calls simultaneously.

The default value is 1.

Block New Registration When Maximum Registrations Active

blockNewRegistrationWhenMaxActive

Set the value to true or false. If you do not set the attribute, by default, the system sets the attribute to false.

If you set to true and if an endpoint tries to register using this communication profile when the maximum number of allowed simultaneous registrations reaches, the endpoint cannot register with Session Manager The endpoint does not have the SIP service.

If the value is set to false, the default, the endpoint can register only after the system cancels the registration of the oldest endpoint. The stopped endpoint does not have the SIP service.

-

Origination Application Sequence

originationAppSequence

An Application Sequence invoked when calls are routed from this user.

Note:

If you specify origination and termination application sequences, and if each sequence contains a Communication Manager application, Communication Manager must be the same in both the sequences.

Optional

-

Termination Application Sequence

terminationAppSequence

An Application Sequence invoked when calls are routed to this user.

Note:

If you specify origination and termination application sequences, and if each sequence contains a Communication Manager application, Communication Manager must be the same in both the sequences.

Optional

-

Enable Centralized Call History

enabledisablecalllog

The option to enable the call history feature for SIP users.

Optional

-

Emergency Calling Origination Sequence

emergencyOriginationAppSequence

The list of application sequences invoked when the system routes emergency calls from this user.

Optional

-

Emergency Calling Termination Sequence

emergencyTerminationAppSequence

The list of application sequences invoked when the system routes emergency calls to this user.

Optional

-

Home Location

homeLocation

The home location that you set from Routing > Locations page to support user mobility. When this user calls numbers that are not associated with an administered user, dial-plan rules that are set inRouting > Dial Patterns will be applied to complete the call based on this home location regardless of the physical location of the SIP device used to make the call.

Mandatory

-

Conference Factory Set

confFactorySet

The conference factory set to enable media capability-based call routing to the Conferencing SIP entities.

Use the Session Manager > Application Configuration > Conference Factories page to administer the Conference Factory Sets.

Optional

-

Enable Client

thirdPartyClient

Name of third party client

Optional

Must be a string