CM Name

cmName

The name of the Communication Manager system as it appears in the Applications/Application Management/Entities.

Mandatory

Use Existing Extension

useExistingExtension

Select true if you want to use an already created extension.

Select false if you want to use an available extension.

Optional

Template Name

template

The template name that is used to create the endpoint. Values defined in the template will be used if you do not provide other values.

Optional

Set Type

setType

The set type of the endpoint.

Optional

Port

port

The valid port value.

Optional

01 to 64 First and second numbers are the cabinet numbers having values A to E. The third character is the carrier having values between 01 to 20. Fourth and fifth characters are the slot number between 01 to 32. Sixth and seventh characters are the circuit number having values x or X.

Indicates that there is no hardware associated with the port assignment since the switch was set up, and the administrator expects that the extension has a non-IP set, or that the extension had a non-IP set, and is dissociated. Use x for Administered WithOut Hardware (AWOH) and Computer Telephony (CTI) endpoints, as well as for SBS Extensions.

IP Indicates that there is no hardware associated with the port assignment since the switch was set up, and the administrator expects that the extension has an IP set. This is autopopulated for certain IP endpoint set types. You can enter the value for a DCP set with softphone permissions. This changes to the s00000 type when the set registers.

Delete endpoint is unassigned

deleteOnUnassign

Specifies whether the endpoint must be deleted if it is unassigned from the user.

Optional

Lock messages feature.

lockMessages

Select to enable the lock messages feature.

Optional

Select true or false to enable or disable the lock messages feature respectively.

Coverage Path 1

coveragePath1

A coverage path is a prioritized sequence of extensions to which your voice system will route an unanswered call.

Optional

Valid values: Path Number between 1-9999, time of day table between t1-t999, or blank.

Coverage Path 2

A coverage path is a prioritized sequence of extensions to which your voice system will route an unanswered call.

Optional

Valid values: Path Number between 1-9999, time of day table between t1-t999, or blank.

Hunt To Station

huntToStation

The extension the system must hunt to for this telephone when the telephone is busy. A endpoint hunting chain can be created by assigning a hunt-to endpoint to a series of telephones.

Optional

Tenant Number

tn

Provides partitioning of attendant groups and endpoints and trunk groups.

Typically this is used for multiple tenants in a building or multiple departments within a company or an organization.

Mandatory

Valid values: 1 to 250

Class of Restriction

cor

This is used for multiple tenants in a building or multiple departments within a company or an organization.

Mandatory

Valid values: 0 to 995

Class of Service

cos

Class of Service lets you define a group of users and control the groups' access to features.

Mandatory

Valid values: 0 to 15

speakerphone

Controls the behavior of speakerphones.

Optional

Valid values : none, 1-way, 2-way

Display Language

displayLanguage

The language that displays on the endpoint.

Optional

Time of day is displayed in the 24- hour format (00:00 - 23:59) for all languages except English, which is displayed in the 12-hour format (12:00 a.m. to 11:59 p.m.).

unicode: Displays English messages in a 24-hour format . If you do not install the Unicode file, the endpoint displays messages in English by default.

Personalized Ringing Pattern

personalizedRingingPattern

The personalized ringing pattern for the endpoint.

Personalized Ringing allows the users of some telephones to have one of the eight ringing patterns for incoming calls.

For virtual endpoints, this field dictates the ringing pattern on its mapped to physical telephone.

L = 530 Hz, M = 750 Hz, and H = 1060 Hz

Valid Entries Usage:

1. MMM (standard ringing)

2. HHH

3. LLL

4. LHH

5. HHL

6. HLL

7. HLH

8. LHL

Message Lamp Extension

messageLampExt

The Message Lamp Extension associated with the current extension.

Mandatory

muteButtonEnabled

Select to enable the mute button on the endpoint.

Media Complex Extension

mediaComplexExt

When used with Multi-media Call Handling, this field indicates which extension is assigned to the data module of the multimedia complex. Users can dial this extension to either place a voice or a data call. Voice conversion, coverage, and forwarding apply as if the call were made to the 1-number.

Optional

Valid Entry Usage: A valid BRI data extension. For MMCH, enter the extension of the data module that is part of this multimedia complex.

H.323 endpoint extension: For the 4600 series IP Telephones, enter the corresponding H.323 endpoint. For IP Softphone, enter the corresponding H.323 endpoint. If you enter a value in this field, you can register this endpoint on either a road-warrior or Telecommuter/Avaya IP Agent application.

Blank: Leave this field blank for single-connect IP applications.

IP Softphone

ipSoftphone

Specifies whether the endpoint is an IP soft phone.

Optional

Survivable GK Node Name

survivableGkNodeName

Survivable GK Node Name identifies the existence of other H.323 gatekeepers located within gateway products that offer survivable call features. For example, the MultiTech MVPxxx-AV H.323 gateway family and the SLS function within the H.248 gateways.

When you enter a valid IP node name in this field, Communication Manager adds the IP address of this gateway to the bottom of the Alternate Gatekeeper List for this IP network region. As H.323 IP endpoints register with Communication Manager, this list is sent to the registration confirm message. The IP endpoint can use the IP address of this Survivable Gatekeeper as the call controller of last resort to register with. Survivable GK Node Name is available only if the endpoint is an H.323 endpoint (46xxor 96xx set types).

Optional

Valid Entry Usage: Valid IP node name, any valid, previously-administered IP node name.

Survivable class of restriction

survivableCOR

Sets the level of restriction for endpoints to be used with the survivable dial plan to limit certain users to certain types of calls. You can list the restriction levels from the most restrictive to least restrictive. Each level assumes the calling ability of the ones above it. This field is used by the PIM module in Integrated Management to communicate with the Communication Manager administration tables and to obtain the class of service information. PIM module builds a managed database to send to Standard Local Survivability (SLS) on the H.248 gateways. Survivable COR is valid for all analog and IP endpoint types.

Optional

Valid Entries: Usage emergency - This endpoint can only be used to place emergency calls.

Internal - This endpoint can only make intra-switch calls. This is the default value.

local - This endpoint can only make calls that are defined as locl, op, svc, or hnpa in the Survivable Gateway Call Controller's routing tables.

toll - This endpoint can place any national toll calls that are defined as fnpa or natl on the Survivable Gateway Call Controller's routing tables.

unrestricted - This endpoint can place a call to any number defined in the Survivable Gateway Call Controller's routing tables. Those strings marked as deny are also denied to these users.

Survivable Trunk Destination

survivableTrunkDest

This field does not allow certain telephones to receive incoming trunk calls when the media gateway is in survivable mode. This field is used by the PIM module in Integrated Management to successfully interrogate the Communication Manager administration tables and obtain the class of service information. PIM module builds a managed database to send for SLS on the H.248 gateways. Survivable Trunk Destination is available for all analog and IP endpoint types.

Optional

Valid Entry Usage:

true - Allows this endpoint to be an incoming trunk destination while the media gateway is running in the survivability mode. This is the default value.

false - Prevents this endpoint from receiving incoming trunk calls when the endpoint in survivable mode.

Voice Mail Number

voiceMailNumber

Enter the complete Voice Mail Dial Up number.

Optional

String

offPremisesStation

Analog telephones only.

Optional

Valid entries Usage:

• true - Enter true if this telephone is not located in the same building as the system. If you enter true, you must complete the R Balance Network.

• false - Enter false if the telephone is located in the same building as the system.

dataOption

If a second line on the telephone is administered on the I-2 channel, enter analog. Else, enter the data module if applicable, or enter none.

Optional

Valid entries: analog, none.

Message Waiting Indicator

messageWaitingIndicator

If you select led or neon, then you must enable messageLampExt, else leave this field blank.

Optional

Valid entries: led, neon, none.

remoteOfficePhone

Select true to use this endpoint as an endpoint in a remote office configuration.

Optional

Valid entries:

• audix - If LWC is attempted, the messages are stored in AUDIX.

• spe - If LWC is attempted, the messages are stored in the system processing element (spe).

• none - If LWC is attempted, the messages are not stored.

lwcActivation

Select true to allow internal telephone users to leave short LWC messages for this extension. If the system has hospitality, select true for guest-room telephones for the designated extensions to receive failed wakeup messages, and to receive LWC messages that indicate the wakeup calls failed. Select true if LWC Reception is audix.

Optional

Boolean

activeStationRinging

Active endpoint ringing

Optional

Valid entries:

• single

• continuous

• if-busy-single

• silent

idleActiveRinging

Defines how a call rings to the telephone when it is on-hook.

Optional

Valid entries

• continuous - Select continuous to cause all calls to this telephone to ring continuously.

• if-busy-single - Select if-busysingle to cause calls to this telephone to ring continuously when the telephone is off-hook and idle, and calls to this telephone to receive one ring cycle and then ring silently when the telephone is off-hook and active.

• silent-if-busy - Select silent-if-busy to cause calls to ring silently when this endpoint is busy.

• single - Select single to cause calls to this telephone to receive one ring cycle and then ring silently.

switchhookFlash

Set this field to true when the Type field is set to H.323.

Optional

Boolean

ignoreRotaryDigits

If you set this field to true, the short switch-hook flash (50 to 150) from a 2500-type set is ignored.

Optional

Boolean

h320Conversion

H.320 Conversion — Valid entries are true and false (default). This field is optional for non-multimedia complex voice endpoints and for basic multimedia complex voice endpoints. H.320 Conversion is mandatory for enhanced multimedia complex voice endpoints. Since the system can only handle a limited number of conversion calls, you must limit the number of telephones with H.320 conversion. Enhanced multimedia complexes must have this flag set to true.

Optional

Boolean

serviceLinkMode

The service link is the combined hardware and software multimedia connection between an Enhanced mode complex’s H.320 DVC system and the Avaya DEFINITY Server which ends the H.320 protocol. A service link is never used by a Basic mode complex H.320 DVC system. Connecting a service link will take several seconds. When the service link is connected, it uses MMI, VC and system timeslot resources. When the service link is disconnected it does not tie up any resource. Service Link Mode can be administered as either as-needed or permanent:

• As- Needed - Most non-call center multimedia users will be administered with this service link mode. The as-needed mode provides the enhanced multimedia complex with a connected service link whenever a multimedia call is answered by the endpoint and for a period of 10 seconds after the last multimedia call on the endpoint has been disconnected. Having the service link stay connected for 10 seconds allows a user to disconnect a multimedia call and then make another multimedia call without having to wait for the service link to disconnect and reestablish.

• Permanent – Multimedia call center agents and other users who are constantly making or receiving multimedia calls might want to be administered with this service link mode.

  The permanent mode service link will be connected during the endpoint’s first multimedia call and will remain in a connected state until the user disconnects from their PC’s multimedia application or the Avaya DEFINITY Server restarts. This provides a multimedia user with a much quicker video cut-through when answering a multimedia call from another permanent mode endpoint or a multimedia call that has been early answered.

Optional

Valid entries: as-needed permanent

multimediaMode

There are two multimedia modes, Basic and Enhanced.

Optional

Basic - A basic multimedia complex consists of a BRIconnected multimedia-equipped PC and a non-BRI-connected multifunction telephone set.

Enhanced - An enhanced multimedia complex consists of a BRI-connected multimediaequipped PC and a non-BRIconnected multifunction telephone.

mwiServedUserType

Controls the auditing or interrogation of a served user’s message waiting indicator (MWI).

Optional

Valid entries:

1. fp-mwi - Select this option if the endpoint is a served user of an fp-mwi message center.

2. qsig-mwi - Select this option if the endpoint is a served user of a qsig-mwi message center.

3. sip adjuncts - Select this option if the endpoint is a served user of a sip adjunct message center.

4. blank - Leave this field blank if you do not want to audit the served user’s MWI or if the user is not a served user of either an fp-mwi or qsigmwi message center.

audixName

The AUDIX associated with the endpoint. Must contain a user-defined adjunct name that was previously administered.

Optional

String

automaticMoves

Automatic Moves allows a DCP telephone to be unplugged from one location and moved to a new location without additional Communication Manager administration. Communication Manager automatically associates the extension to the new port.

Optional

Valid entries:

1. always - Select always to move the DCP telephone anytime without additional administration by unplugging the telephone from one location and plugging it into a new location.

2. once - Select once to unplug and plug the DCP telephone into a new location once. After a move, the field is set to done the next time that routine maintenance runs on the DCP telephone. Use once when you want to move a large number of DCP telephones so that each extension is removed from the move list. Use once to prevent automatic maintenance replacement.

3. no - Enter no to require administration in order to move the DCP telephone.

4. done - Done is a display-only value. Communication Manager sets the field to done after the telephone is moved and routine maintenance runs on the DCP telephone.

5. Error - Error is a display-only value. Communication Manager sets the field to error, after routine maintenance runs on the DCP telephone, when a non-serialized telephone is set as a movable telephone.

remoteSoftphoneEmergencyCalls

An Avaya IP endpoint can dial emergency calls (for example, 911 calls in the U.S.). It only reaches the local emergency service in the Public Safety Answering Point area where the telephone system has local trunks.

Optional

Valid entries:

1. As-on-local: As-on-local sends the extension entered in the Emergency Location Extension field on the Endpoint screen to the Public Safety Answering Point (PSAP)

2. Block - Block prevents the completion of emergency calls.

3. Cesid - Cesid allows Communication Manager to send the CESID information supplied by the IP Softphone to the PSAP.

4. Option - Option allows the user to select the option (extension, block, or cesid) that the user selected during registration.

emergencyLocationExt

This field allows the system to properly identify the location of a caller who dials a 911 emergency call from this endpoint. An entry in this field must be of an extension type included in the dial plan, but does not have to be an extension on the local system. The entry can be a UDP extension.

The default entry is blank. A blank entry typically is used for an IP softphone dialing in through PPP from somewhere outside your network. If you populate the IP Address Mapping screen with emergency numbers, the feature functions as follows. If the Emergency Location Extension field in the Endpoint screen is the same as the Emergency Location Extension field in the IP Address Mapping screen, the feature sends the extension to the Public Safety Answering Point (PSAP). If the Emergency Location Extension field in the Endpoint screen is different from the Emergency Location Extension field in the IP Address Mapping screen, the feature sends the extension in the IP Address Mapping screen to the Public Safety Answering Point (PSAP).

Optional

alwaysUse

A softphone can register no matter what emergency call handling settings the user has entered in the softphone. If a softphone dials 911, the administered Emergency Location Extension is used. The softphone's user-entered settings are ignored. If an IP telephone dials 911, the administered Emergency Location Extension is used. If a call center agent dials 911, the physical endpoint extension is displayed, overriding the administered LoginID for ISDN Display. This does not apply to SCCAN wireless telephones, or to extensions administered as type h.323.

Optional

Boolean

precedenceCallWaiting

Activates or deactivates Precedence Call Waiting for this endpoint.

Optional

autoSelectAnyIdleAppearance

Enables or disables automatic selection of any idle appearance of transferred or conferenced calls. Communication Manager first attempts to find an idle appearance that has the same extension number as the call being transferred or conferenced has. If that attempt fails, Optional Boolean Communication Manager selects the first idle appearance coverageMsgRetrieval.

Optional

Boolean

coverageMsgRetrieval

Allows or denies users in the telephone’s Coverage Path to retrieve Leave Word Calling (LWC) messages for this telephone. Applies only if the telephone is enabled for LWC Reception.

Optional

Boolean

autoAnswer

In EAS environments, the auto answer setting for the Agent LoginID can override a endpoint’s setting when an agent logs in.

Optional

Valid entries:

1. all: All ACD and non-ACD calls ended to an idle endpoint cut through immediately. Does not allow automatic hands-free answer for intercom calls. With non-ACD calls, the set is also rung while the call is cut through. The ring can be prevented by activating the ringer-off feature button when the Allow Ringer-off with Auto-Answer is enabled for the system.

2. acd: Only ACD split /skill calls and direct agent calls to auto answer. Non-ACD calls ended to an endpoint ring audibly. For analog endpoints, the endpoint is off-hook and idle, only the ACD split/skill calls and direct agent calls auto answer; non-ACD calls receive busy treatment. If the endpoint is active on an ACD call and a non-ACD call arrives, the Agent receives call-waiting tone.

3. none: All calls ended to this endpoint receive an audible ringing treatment.

4. icom: Allows a telephone user to answer an intercom call from the same intercom group without pressing the intercom button.

dataRestriction

Enables or disables data restriction that is used to prevent tones, such as call-waiting tones, from interrupting data calls. Data restriction provides permanent protection and cannot be changed by the telephone user. Data restriction cannot be assigned if Auto Answer is administered as all or acd. If enabled, whisper page to this endpoint is denied.

Optional

idleAppearancePreference

Indicates which call appearance is selected when the user lifts the handset and there is an incoming call.

Optional

true - The user connects to an idle call appearance instead of the ringing call.

false - The Alerting Appearance Preference is set and the user connects to the ringing call appearance.

callWaitingIndication

Enable or disable call waiting for this endpoint.

Optional

attCallWaitingIndication

Attendant call waiting allows attendantoriginated or attendant-extended calls to a busy single-line telephone to wait and sends distinctive call-waiting tone to the single-line user. Select to enable or disable attendant call waiting

Optional

Boolean

distinctiveAudibleAlert

Select true so that the telephone can receive the three different types of ringing patterns which identify the type of incoming calls. Distinctive ringing might not work properly for off-premises telephones.

Optional

restrictLastAppearance

Optional

Valid entries:

1. true: Restricts the last idle call appearance used for incoming priority calls and outgoing call originations only.

2. false: Last idle call appearance is used for incoming priority calls and outgoing call originations.

adjunctSupervision

Enable or disable Adjunct Supervision.

Optional

Valid entries:

1. true: Analog disconnect signal is sent automatically to the port after a call ends. Analog devices such as answering machines and speakerphones use this signal to turn the devices off after a call ends.

2. false: Hunt group agents are alerted to incoming calls. In a hunt group environment, the disconnect signal blocks the reception of zip tone and incoming call notification by an auto-answer endpoint when a call is queued for the endpoint.

perStationCpnSendCallingNumber

Send Calling Number

Optional

Valid entries:

1. y: All outgoing calls from the endpoint will deliver the Calling Party Number (CPN) information as Presentation Allowed.

2. n: No CPN information is sent for the call.

3. r: Outgoing non-DCS network calls from the endpoint will deliver the Calling Party Number information as Presentation Restricted.

busyAutoCallbackWithoutFlash

Appears on the Endpoint screen for analog telephones, only if the Without Flash field in the ANALOG BUSY AUTO CALLBACK section of the Feature-Related System Parameters screen is set to true. The Busy Auto Callback without Flash field then defaults to true for all analog telephones that allow Analog Automatic Callback. Set this field to true to provide automatic callback for a calling analog endpoint without flashing the hook.

Optional

audibleMessageWaiting

Provides audible message waiting

Optional

Boolean

displayClientRedirection

Only administrable if Hospitality is enabled on the System Parameters Customer- Options (Optional Features) screen. This field affects the telephone display on calls that originate from an endpoint with Client Room Class of Service.

For endpoints with an audix endpoint type, AUDIX Voice Power ports, or ports for any other type of messaging that needs display information, Display Client Redirection must be enabled. Set this field to true to redirect information for a call originating from a Client Room and ending to this endpoint displays.

Optional

Boolean

selectLastUsedAppearance

Optional

Valid entries:

1. True: Indicates that an endpoint’s line selection is not to be moved from the currently selected line button to a different, non-alerting line button. If you select true, the line selection on an on-hook endpoint only moves from the last used line button to a line button with an audibly alerting call. If there are no alerting calls, the line selection remains on the button last used for a call.

2. false: The line selection on an on-hook endpoint with no alerting calls can be moved to a different line button, which might be serving a different extension.

coverageAfterForwarding

Specifies whether an unanswered forwarded call is provided coverage treatment.

Optional

directIpIpAudioConnections

Select to allow or deny direct audio connections between IP endpoints.

Optional

ipAudioHairpinning

Allows IP endpoints to be connected through the server’s IP circuit pack.

Optional

primeAppearancePreference

Set prime appearance preference.

Optional

endpointSiteData

This is applicable for Site Data fields

room

This is a Site Data field.

Optional

Max length 10

jack

This is a Site Data field.

Optional

Max length 5

cable

This is a Site Data field.

Optional

Max length 5

floor

This is a Site Data field.

Optional

building

This is a Site Data field.

Optional

headset

This is a Site Data field.

Optional

speaker

This is a Site Data field.

Optional

mounting

This is a Site Data field.

Optional

Valid values d, w.

cordLength

This is a Site Data field.

Optional

Valid range from 0 to 99.

setColor

This is a Site Data field.

Optional

abbrList

This is applicable for Station Abbreviated Dialing Data fields.

Optional

listType

This is a Station Abbreviated Dialing Data field.

Mandatory

Valid values enhanced, group, personal, system.

number

This is a Station Abbreviated Dialing Data field.

Mandatory

A number.

buttons

This is applicable for button data.

Optional

Number

This is a button data field.

Mandatory

Type

This is a button data field.

Optional

data1

This is a button data field.

Optional

data2

This is a button data field.

Optional

data3

This is a button data field.

Optional

data4

This is a button data field.

Optional

data5

This is a button data field.

Optional

data6

This is a button data field.

Optional

endpointDataModule

This is a Station Data module field.

Optional

dataExtension

This is a Station Data module field.

Mandatory

name

This is a Station Data module field.

Optional

Max length 29

Class of restriction

cor

This is a Station Data module field.

Mandatory

Valid range from 0 to 995.

Class of Service

Cos

This is a Station Data module field.

Mandatory

Valid range from 0 to 15.

itc

This is a Station Data module field.

Mandatory

Valid values:

1. restricted

2. unrestricted

Tenant Number

This is a Station Data module field.

Mandatory

Valid range from 1 to 100.

listType

This is a Station Data module field.

Optional

Valid values:

1. enhanced

2. group

3. personal

4. system

listId

This is a Station Data module field.

Optional

specialDialingOption

This is a Station Data module field.

Optional

Valid values:

1. default

2. hot-line

specialDialingAbbrDialCode

This is a Station Data module field.

Optional

hotLineDestAbbrevList

This is a Station Hot Line Data field.

Optional

Valid range 1 to 3

hotLineAbbrevDialCode

This is a Station Hot Line Data field.

Optional

Numeric string

nativeName

This is a Native Name Data field.

Optional

locale

This is a Native Name Data field.

The locale for the multiscript languages are:

• Japanese: ja

• Chinese: zh-cn

• Traditional Chinese: zh-tw

• Korean: ko-kr

• Vietnamese: vi-vn

The locale tag is case sensitive.

You can use the preferredLanguage tag to specify the locale if displayName, nativeName, and Name are in multibytes. If the locale tag is present in the xml, locale tag is preferred over the preferredLanguage tag.

Optional

Name

This is a Native Name Data field.

Mandatory

Max length 27

enableReachStaDomainControl

Enable Reachability for Domain Control SIP Stations

The system enables Reachability on SIP endpoint.

Optional

sipTrunk

Sip Trunk

The system makes this field available only for the SIP set type.

If you select Calculate Route Pattern check box, the system:

• Populates the Sip Trunk field

• Makes Sip Trunk field read-only.

calculateRoutePattern

Calculate Route Pattern

The option to automatically select the route pattern based on the primary or secondary Session Managerconfigured in the Session Manager Communication Profile.

Allow H.323 and SIP Endpoint Dual Registration

The option to register both an H.323 endpoint and a SIP endpoint together at the same time to the same extension.

Optional

phoneScreenCalling

Phone Screen on Calling

The option to specify whether the phone must automatically display the phone screen when the user goes off-hook or starts dialing.

profileRedial

Redial

The field to select the redial options.

dialingOption

Dialing Option

The field to specify the dialing options.

headsetSignaling

Headset Signaling

The field that defines a headset signaling profile.

audioPath

Audio Path

The field to set the phone to go off-hook when you make an on-hook call.

buttonClicks

Button Clicks

The field to activate or deactivate the standard button click sound.

phoneScreen

Phone Screen

The field to configure the phone screen width.

backgroundLogo

Background Logo

The option to set a customized background logo. The Default value sets the built-in Avaya logo.

personalizedRinging

Personalized Ringing

The option to set a personalized ring tone for an incoming call.

callPickUpIndication

Call Pickup Indication

The option to set ring tones to alert you about an incoming call.

touchPanel

Show Quick Touch Panel

The options to display Quick Touch Panel on the phone.

userPreferredLanguage

User Preferred Language

The option to configure the user preferred language.

timeFormat

Time Format

The option to configure the time format to be displayed on the phone screen.

awayTimer

Away Timer

The option to enable the automatic away timer for presence indication.

awayTimerValue

Away Timer Value

The option to specify a value for the automatic Away Timer.