- Contents
Interaction Administrator Help
Configuration File Attributes
When the assistant creates a managed IP phone from a migration item, the phone must be associated with a registration group. The assistant uses the information contained in the SIP phone's configuration file to create a registration group. Each registration group in the file must have the same server entries for the server address, transport and port in order for the assistant to assign servers to the migration item's registration group. If there are no servers in the migration item's registration group, the assistant will not create a managed IP phone from the migration item.
The assistant requires that the address, transport, and port settings for the server are defined. The assistant uses either the server settings on the registration, or the server settings in voIpProt. The assistant uses the following rules:
If reg.X.server.Y.address exists registration settings are used:
XML Attribute |
Server Value |
reg.X.server.Y.address |
Server Address |
reg.X.server.Y.transport |
Server Transport |
reg.X.server.Y.port - Server Port |
Server Port |
If reg.X.server.Y.address does not exist, voIpProt settings are used:
XML Attribute |
Server Value |
voIpProt.server.Y.address |
Server Address |
voIpProt.server.Y.transport |
Server Transport |
voIpProt.server.Y.port |
Server Port |
The assistant converts the Server Values to the CIC equivalents to create a server in the registration group for it. The assistant uses the following conversion rules:
Server Value |
CIC Value |
Server Address |
Text only. Cannot be <null>. The assistant does not convert between server names and IP addresses. |
Server Port |
Converts the value of this value to the numeric equivalent. If <null>, then use port 5060. |
Server Transport |
"UDPonly" or "DNSnaptr", use UDP "TCPPreferred" or "TCPOnly" use TCP "TLS" use TLS |
When the migration process reads a migration item, it looks at the current set of registration groups in CIC to see if any of the registration groups match what is on the migration item. If there is a match, the migration item is set to use that registration group. If there is not a match, the migration process creates a registration group for the item using the following rules:
-
The default registration group name is set to the first server's address. If that name already exists for a registration group on the server, the assistant tries successive "_1", "_2", "_3" attempts until it finds one that does not exist in CIC.
-
For each server in the registration group, the following is set:
- The type is set to Manual.
- The address is set to the Server Address value from above.
- The port is set to the Server Port value from above.
- The transport is set to the Server Transport value from above.
Polycom XML Attributes Mappings
The following table shows the mappings of the IP phone properties to Polycom configuration file XML attributes:
Notes: If there is no value specified for these attributes in a Polycom configuration file, the assistant sets the default value (if a default value is listed shown in the Default column). Before a value is actually assigned to the attribute, the assistant goes through the conversions listed below in the Value Conversion Results table. For example, if a configuration file attribute had a value of “1” and the associated Interaction Administrator property data type was "Boolean", then the assistant would set the Interaction Administrator property for the attribute to "True".
XML Attribute |
Property Display Label |
Property Data Type |
Applies To Phone or Station |
Default |
Value Conversion |
call.autoOffHook.1.enabled Phone No |
Auto Dial On Off-hook |
Boolean |
Phone |
No |
|
call.autoOffHook.1.contact |
Auto Dial On Off-hook Number |
String |
Phone |
|
|
dialplan.digitmap |
Digitmap |
String |
Phone |
|
|
dialplan.digitmap.timeOut |
Digitmap Timeout |
String |
Phone |
3 |
|
dialplan.routing.emergency.1.value |
Emergency Numbers |
String |
Phone |
911 |
|
lcl.ml.lang |
Language |
Enum |
Phone |
English_United_States |
|
nat.ip |
NAT IP Address |
String |
Phone |
|
|
nat.keepalive.interval |
NAT Keep Alive Interval (0-3600 seconds) |
String |
Phone |
|
|
nat.mediaPortStart |
NAT Audio Port Start (1024-65535) |
String |
Phone |
|
|
nat.signalPort |
NAT Signal Port (1024-65535 ) |
String |
Phone |
|
|
up.headsetMode |
Headset Mode |
Boolean |
Phone |
No |
|
up.oneTouchVoiceMail |
One Touch Voicemail |
Boolean |
Phone |
No |
|
voice.volume.persist.handsfree |
Persist Handsfree Volume |
Boolean |
Phone |
Yes |
|
voice.volume.persist.handset |
Persist Handset Volume |
Boolean |
Phone |
No |
|
voice.volume.persist.headset |
Persist Headset Volume |
Boolean |
Phone |
No |
|
voIpProt.local.port |
SIP Receive Port |
String |
Phone |
5060 |
|
Property Data Type |
Resulting Value Conversion Applied |
Boolean
|
If the case-insensitive resulting value is "true", "1", "yes" or "-1", the value of the property is set to "True". Otherwise, the value is set to "False". |
Enumeration |
The corresponding internal enumeration in the custom property's possible enumeration values is assigned. Typically, there is a value conversion applied to the value in the configuration file and maps the configuration file's value to the appropriate enumeration, so it can then be set in the enumeration handling. |
Integer |
The resulting string is converted to an integer and that value is assigned to the property. If the value in the string cannot be converted to an integer, 0 is assigned. |
String |
The resulting string value is assigned directly to the property. |
The values assigned to the attributes are listed in Managed IP Phone Configuration - Options.