Table 1-2 Required and Optional CSV Fields for Users With Voice Mail
Column Heading
|
Creating
|
Updating
|
Deleting
|
Description
|
Alias
|
Req
|
Req
|
Req
|
The unique text name for the user account.
Any combination of ASCII or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 64 characters.
|
Extension
|
Req
|
Opt
|
N/A
|
The number that callers dial to reach the user.
The value must be unique among users on the Virtual Messaging System.
Any combination of ASCII only alphanumeric characters, from 3 through 40 characters long.
|
TemplateAlias
|
Req
|
N/A
|
N/A
|
The unique text name for the user template to apply to the account during creation.
|
Active_HomePhone
|
Opt
|
Opt
|
N/A
|
Whether the user home phone device is enabled:
|
Active_MobilePhone
|
Opt
|
Opt
|
N/A
|
Whether the user cell phone device is enabled:
|
Active_Pager
|
Opt
|
Opt
|
N/A
|
Whether the user pager device is enabled:
|
Active_TextPager1
|
Opt
|
Opt
|
N/A
|
Whether the user text pager device is enabled:
|
Active_WorkPhone
|
Opt
|
Opt
|
N/A
|
Whether the user work phone device is enabled:
|
Address
|
Opt
|
Opt
|
N/A
|
The physical address such as a house number and street name where the user is located, or with which the user is associated.
Any combination of ASCII or Unicode characters, up to a maximum of 128 characters.
|
AfterDialDigits_Pager
|
Opt
|
Opt
|
N/A
|
Digits to send to the pager. This is referred to on the system administration interface as "Extra Digits." For numeric pagers, the field holds numeric text to send the pager; For text pagers, the field is blank.
The maximum length is 32 digits.
|
AltFirstName
|
Opt
|
Opt
|
N/A
|
An alternate spelling of the user first name in an internationally recognizable format (i.e., ASCII only characters). The value is used by the telephone interface to search for users and to address messages.
Any combination of ASCII alphanumeric characters, up to maximum of 64 characters.
|
AltLastName
|
Opt
|
Opt
|
N/A
|
An alternate spelling of the user last name in an internationally recognizable format (i.e., ASCII only characters). The value is used by the telephone interface to search for users and to address messages.
Any combination of ASCII alphanumeric characters, up to maximum of 64 characters.
|
BillingId
|
Opt
|
Opt
|
N/A
|
Organization-specific information about the user, such as accounting information, department names, or project codes. The information can be included in user reports.
Any combination of digits from 0 through 9, up to maximum of 32 digits.
|
Building
|
Opt
|
Opt
|
N/A
|
The name of the building where the user is based.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
CcmId
|
Opt
|
Opt
|
N/A
|
The Cisco CallManager user ID associated with the user.
Any combination of characters except for non-printing ASCII characters, up to a maximum of 128 characters.
|
City
|
Opt
|
Opt
|
N/A
|
The name of a locality, such as a city, county or other geographic region where the user is located, or with which the user is associated.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
ClientMatterCode
|
Opt
|
Opt
|
N/A
|
The required Client Matter Code (CMC) to transmit to Cisco CallManager, if applicable, when the user makes an outbound call.
CMCs are typically used to enable the system to track calls for account or billing purposes.
The value is used only if the system is using Cisco CallManager and if the version of Cisco CallManager is 4.1 or later.
Whether the CMC is transmitted depends on the setting for outbound calls. The user CMC is used only if the outbound call does not have its own CMC.
The code length can be from 1 through 40 characters.
|
COSDisplayName
|
Opt
|
Opt
|
N/A
|
The unique text name displayed on the user interfaces for the Class of Service (COS) to which the user account is associated.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
Country
|
Opt
|
Opt
|
N/A
|
The 2-letter ISO 3166-1 country code where the user is located, or with which the user is associated.
Two ASCII lower or upper case alpha characters.
|
Department
|
Opt
|
Opt
|
N/A
|
The name or number for the department or subdivision of an organization to which the user belongs.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
DirectoryId
|
Opt
|
Opt
|
N/A
|
The unique identifier for the user in the corporate or organization's directory (for example, in Active Directory, if Active Directory is used).
Any combination of ASCII alphanumeric characters, up to a maximum of 256 characters.
|
DisplayName
|
Opt
|
Opt
|
N/A
|
The user name that appears on the administration and user interfaces.
If no value is provided, the value is set to the Alias.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
DisplayName_HomePhone
|
Opt
|
Opt
|
N/A
|
The text name for the user home phone displayed on the Cisco Unity Connection interface(s).
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
DisplayName_MobilePhone
|
Opt
|
Opt
|
N/A
|
The text name for the user cell phone displayed on the Cisco Unity Connection interface(s).
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
DisplayName_Pager
|
Opt
|
Opt
|
N/A
|
The text name for the user pager displayed on the Cisco Unity Connection interface(s).
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
DisplayName_TextPager1
|
Opt
|
Opt
|
N/A
|
The text name for the user text pager displayed on the Cisco Unity Connection interface(s).
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
DisplayName_WorkPhone
|
Opt
|
Opt
|
N/A
|
The text name for the user work phone displayed on the Cisco Unity Connection interface(s).
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
EmailAddress
|
Opt
|
Opt
|
N/A
|
The primary e-mail address of the user.
Note that the field is only for directory information purposes. Cisco Unity Connection does not use the address to deliver incoming messages.
Any combination of ASCII alphanumeric characters, and the special characters hyphen, underscore, period and at sign ("@"), up to a maximum of 320 characters.
|
EmployeeId
|
Opt
|
Opt
|
N/A
|
The numeric or alphanumeric identifier assigned to a user, typically based on order of hire or association with an organization.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
EnhancedSecurityAlias
|
Opt
|
Opt
|
N/A
|
The unique text name used to identify and authenticate the user with an RSA SecurID security system.
Any combination of ASCII or Unicode characters, up to a maximum of 50 characters.
|
Extension_Alt1
|
Opt
|
Opt
|
N/A
|
The user's first alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
Extension_Alt2
|
Opt
|
Opt
|
N/A
|
The user's second alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
Extension_Alt3
|
Opt
|
Opt
|
N/A
|
The user's third alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
Extension_Alt4
|
Opt
|
Opt
|
N/A
|
The user's fourth alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
Extension_Alt5
|
Opt
|
Opt
|
N/A
|
The user's fifth alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
Extension_Alt6
|
Opt
|
Opt
|
N/A
|
The user's sixth alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
Extension_Alt7
|
Opt
|
Opt
|
N/A
|
The user's seventh alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
Extension_Alt8
|
Opt
|
Opt
|
N/A
|
The user's eighth alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
Extension_Alt9
|
Opt
|
Opt
|
N/A
|
The user's ninth alternate extension.
Any combination of ASCII alphanumeric characters, from 1 through 40 characters long.
|
FirstName
|
Opt
|
Opt
|
N/A
|
The user first name.
Any combination of ANSI or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 64 characters.
|
ForcedAuthoizationCode
|
Opt
|
Opt
|
N/A
|
The required forced-authorization code (FACs) to transmit to Cisco CallManager, if applicable, when the user makes an outbound call.
Your organization may use FACs to prevent toll fraud. For example, users may have to provide FACs to place long-distance calls.
The value is used only if the system is using Cisco CallManager and if the version of Cisco CallManager is 4.1 or later.
The code length can be from 1 through 40 characters.
|
ImapService_AccountLogin
|
Opt
|
Opt
|
N/A
|
The Active Directory user logon name that is associated with the Exchange mailbox that you want this Cisco Unity Connection user to be able to access. (The Active Directory logon name of the user should be in the format LogonName.)
Any combination of ANSI or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 256 characters.
To add the IMAP service for a user, include values for both the ImapService_RemoteServerDisplayName and ImapService_AccountLogin fields in the CSV input file.
To remove the IMAP service for a user, set at least one of either the ImapService_RemoteServerDisplayName or ImapService_AccountLogin fields to %null% in the CSV input file.
|
ImapService_RemoteServerDisplayName
|
Opt
|
Opt
|
N/A
|
The Cisco Unity Connection IMAP service that corresponds with the Exchange server that contains the Exchange mailbox for this Cisco Unity Connection user.
Any combination of ANSI or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 64 characters.
To add the IMAP service for a user, include values for both the ImapService_RemoteServerDisplayName and ImapService_AccountLogin fields in the CSV input file.
To remove the IMAP service for a user, set at least one of either the ImapService_RemoteServerDisplayName or ImapService_AccountLogin fields to %null% in the CSV input file.
|
Initials
|
Opt
|
Opt
|
N/A
|
The initials of part or all of the user name.
Any combination of ANSI or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 6 characters.
|
Language
|
Opt
|
Opt
|
N/A
|
The preferred language of the user.
Use the Windows language code, such as 1033 for US English.
|
LastName
|
Opt
|
Opt
|
N/A
|
The user last name.
Any combination of ANSI or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 64 characters.
|
ListInDirectory
|
Opt
|
Opt
|
N/A
|
Determines whether the user is included in the phone directory for outside callers:
- 0- Not included in the directory
- 1- Included in the directory
|
Manager
|
Opt
|
Opt
|
N/A
|
The name of the manager or supervisor of the user.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
MaxMsgLen
|
Opt
|
Opt
|
N/A
|
The maximum duration (in seconds) for recording a message from an unidentified caller.
The length specified can be from 1 through 1200 seconds.
|
MediaSwitchDisplayName
|
Opt
|
Opt
|
N/A
|
The text name displayed on the system administration interface of the phone system used for Telephone Record and Playback (TRAP) sessions and to turn message waiting indicators on and off.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
MWIExtension
|
Opt
|
Opt
|
N/A
|
The phone number (extension) of the default message waiting indicator (MWI) to light when callers leave messages for the user.
If no value is provided, Cisco Unity Connection uses the number of the primary extension.
|
PhoneNumber_HomePhone
|
Opt
|
Opt
|
N/A
|
The user home phone number.
Any combination of the digits 0-9, T, t, commas, hashes (#), and asterisks (*), up to a maximum of 38 characters.
|
PhoneNumber_MobilePhone
|
Opt
|
Opt
|
N/A
|
The user cell phone number.
Any combination of the digits 0-9, T, t, commas, hashes (#), and asterisks (*), up to a maximum of 38 characters.
|
PhoneNumber_Pager
|
Opt
|
Opt
|
N/A
|
The user pager number.
Any combination of the digits 0-9, T, t, commas, hashes (#), and asterisks (*), up to a maximum of 38 characters.
|
PhoneNumber_TextPager1
|
Opt
|
Opt
|
N/A
|
The user text pager number.
Any combination of ASCII only alphanumeric characters, hyphens, underscores, periods, at signs (@), commas and hashes (#), up to a maximum of 40 characters.
|
PhoneNumber_WorkPhone
|
Opt
|
Opt
|
N/A
|
The user work phone number.
Any combination of the digits 0-9, T, t, commas, hashes (#), and asterisks (*), up to a maximum of 38 characters.
|
PostalCode
|
Opt
|
Opt
|
N/A
|
For users located in the United States, the zip code where the user is located, or with which a user is associated. For users located in Canada, Mexico, and other countries, the postal code where the user is located, or with which a user is associated.
Any combination of ASCII or Unicode characters, up to a maximum of 40 characters.
|
RnaAction
|
Opt
|
Opt
|
N/A
|
Determines whether Cisco Unity Connection transfers the call to the appropriate greeting or releases the call to the phone system when a call is unanswered:
- 0-Release the call to the phone system.
- 1-After the number of rings specified in the TransferRings field, transfer the call to the appropriate greeting.
|
State
|
Opt
|
Opt
|
N/A
|
The full name of the state or province where the user is located, or with which a user is associated.
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
TimeZone
|
Opt
|
Opt
|
N/A
|
The time zone to which the user account is associated.
|
Title
|
Opt
|
Opt
|
N/A
|
The position or function of the user within the organization, for example "Vice President."
Any combination of ASCII or Unicode characters, up to a maximum of 64 characters.
|
TransferAction
|
Opt
|
Opt
|
N/A
|
Determines whether Cisco Unity Connection transfers the user's incoming calls to the call handler greeting or to the extension specified in TransferExtension:
- 0-Transfer to the call handler greeting.
- 1-Transfer to TransferExtension.
|
TransferExtension
|
Opt
|
Opt
|
N/A
|
The phone number that Cisco Unity Connection transfers calls to if TransferAction is set to 1.
|
TransferRings
|
Opt
|
Opt
|
N/A
|
Determines the number of times the user extension rings before Cisco Unity Connection considers the call unanswered and plays the appropriate greeting.
An integer value from 2 through 100.
|
TransferType
|
Opt
|
Opt
|
N/A
|
Determines the way in which Cisco Unity Connection will transfer calls from the automated attendant or a directory handler to the user's phone for the standard (default) transfer rule:
|
VoiceMailPasswordHash
|
Opt
|
Opt
|
N/A
|
The user phone password stored in an encrypted format.
The maximum length is 128 characters.
|
VoiceName
|
Opt
|
Opt
|
N/A
|
The relative or full path to the .WAV audio file containing the recorded voice name of the user. The relative path is from the CSV input file directory.
Because Bulk Administration Manager only copies the .WAV file to the database, the file can be deleted from the system after the operation has completed successfully.
Any combination of ASCII only alphabetic and numeric characters, periods, hyphens, and underscores, from 1 to 255 characters long, except for the following restrictions:
- The first character must not be a period or a hyphen.
- The last character must not be a period.
|
WebDavService_AccountLogin
|
Opt
|
Opt
|
N/A
|
To enable access to Exchange messages by using Text to Speech, the Exchange alias (often the same as the Active Directory user logon name) for the Exchange mailbox that you want this Cisco Unity Connection user to be able to access.
Any combination of ANSI or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 256 characters.
To add the WebDav service for a user, include the values for the WebDavService_AccountLogin, WebDavService_RemoteServerDisplayName, and WebDavService_ServerUrlSuffix fields in the CSV input file.
To remove the WebDav service for a user, set at least one of the fields WebDavService_AccountLogin, WebDavService_RemoteServerDisplayName, or WebDavService_ServerUrlSuffix to %null% in the CSV input file.
|
WebDavService_RemoteServerDisplayName
|
Opt
|
Opt
|
N/A
|
The Cisco Unity Connection WebDav service that corresponds with the Exchange server that contains the Exchange mailbox for this Cisco Unity Connection user.
Any combination of ANSI or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 64 characters.
To add the WebDav service for a user, include the values for the WebDavService_AccountLogin, WebDavService_RemoteServerDisplayName, and WebDavService_ServerUrlSuffix fields in the CSV input file.
To remove the WebDav service for a user, set at least one of the fields WebDavService_AccountLogin, WebDavService_RemoteServerDisplayName, or WebDavService_ServerUrlSuffix to %null% in the CSV input file.
|
WebDavService_ServerUrlSuffix
|
Opt
|
Opt
|
N/A
|
The Exchange e-mail alias for this user. Do not include https://<Servername>/exchange in the field. Only enter the alias for this user.
When you added a new Cisco Unity Connection external service, you specified the base URL to the Exchange server, https://<Exchange server>/Exchange/ where <Exchange server> is the fully qualified domain name or the IP address of the Exchange server. When Connection accesses the Exchange mailbox for a Connection user, it combines the base URL with the URL suffix. The combination must produce the correct URL for accessing the Exchange mailbox for this user.
Any combination of ANSI or Unicode alphanumeric characters, periods, commas, spaces, and the special characters `, ~, !, @, #, $, %, ^, &, -, _, ', up to a maximum of 256 characters.
To add the WebDav service for a user, include the values for the WebDavService_AccountLogin, WebDavService_RemoteServerDisplayName, and WebDavService_ServerUrlSuffix fields in the CSV input file.
To remove the WebDav service for a user, set at least one of the fields WebDavService_AccountLogin, WebDavService_RemoteServerDisplayName, or WebDavService_ServerUrlSuffix to %null% in the CSV input file.
|