The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This section describes the parameters used to configure deployments for your corporate environment.
If you do not configure CSF devices for users, you cannot apply group configurations to those users.
This topic provides a high-level overview of the steps to create a global configuration file and explains how to host the file on your TFTP server.
Step 1 |
Create a file named jabber-config.xml with any text editor.
|
Step 2 |
Define the required configuration parameters in jabber-config.xml.
|
Step 3 |
Host jabber-config.xml on your TFTP server.
|
You must restart your TFTP server before Cisco UC Integration for Microsoft Lync can access the configuration files.
Step 1 | Open the Cisco Unified Serviceability interface on Cisco Unified Communications Manager. |
Step 2 | Select . |
Step 3 | Select Cisco Tftp from the CM Services section. |
Step 4 |
Select Restart. A window displays to prompt you to confirm the restart. |
Step 5 |
Select OK. The Cisco Tftp Service Restart Operation was Successful status displays. |
Step 6 | Select Refresh to ensure the Cisco Tftp service starts successfully. |
To verify that the configuration file is available on your TFTP server, open the configuration file in any browser. Typically, you can access the global configuration file at the following URL: http://tftp_server_address:6970/jabber-config.xml
<?xml version="1.0" encoding="utf-8"?> <config version="1.0"> <Client> <parameter_name>value</parameter_name> </Client> <Options> <parameter_name>value</parameter_name> </Options> <Policies> <parameter_name>value</parameter_name> </Policies> <Phone> <parameter_name>value</parameter_name> </Phone> </config>
Element | Description |
---|---|
<?xml version="1.0" encoding="utf-8"?> | XML declaration. Your configuration file must conform to the standard XML format. |
config | Root element of the configuration XML that contains the available configuration groups. The root element must also contain the version attribute. |
Client | Parent element that contains client configuration parameters. |
Directory | Parent element that contains directory configuration parameters. |
Options | Parent element that contains user option configuration parameters for user options. |
Policies | Parent element that contains policy configuration parameters. |
Parameter | Value | Description |
---|---|---|
PrtLogServerUrl | URL |
Specifies the custom script for submitting problem reports. For more information about problem reports, see Configure Problem Reporting. |
<Client> <PrtLogServerUrl>http://server_name.cisco.com/cucilync/prt/my_script.php</PrtLogServerUrl> </Client>
You can change the default attribute mappings for Cisco UC Integration for Microsoft Lync. For example, by default, Cisco UC Integration for Microsoft Lync maps the BusinessPhone parameter to the telephoneNumber attribute in your directory. The result of this mapping is that Cisco UC Integration for Microsoft Lync retrieves the value of the telephoneNumber attribute from your directory for a particular user. Cisco UC Integration for Microsoft Lync then displays this value as the user's work phone in that user's profile. If your organization uses an attribute other than telephoneNumber for business phone numbers, you should change the mapping in the configuration file.
Parameter | Default Value |
---|---|
CommonName | cn |
DisplayName | displayName |
Firstname | givenName |
Lastname | sn |
EmailAddress | |
SipUri | msRTCSIP-PrimaryUserAddress |
PhotoSource | thumbnailPhoto |
BusinessPhone | telephoneNumber |
MobilePhone | mobile |
HomePhone | homePhone |
OtherPhone | otherTelephone |
Title | title |
CompanyName | company |
UserAccountName | sAMAccountName |
DomainName | userPrincipalName |
Location | co |
Nickname | nickname |
PostalCode | postalCode |
State | st |
StreetAddress | streetAddress |
Parameter | Value | Description |
---|---|---|
ConnectionType | 0 1 |
Specifies if Cisco UC Integration for Microsoft Lyncconnects to a Global Catalog server or Domain Controller.
|
PrimaryServerName | Fully qualified domain name IP address |
Specifies the fully qualified domain name or IP address of the primary server connection for directory access. You must specify this parameter if Cisco UC Integration for Microsoft Lync cannot automatically discover the primary server. |
SecondaryServerName | Fully qualified domain name IP address |
Specifies the fully qualified domain name or IP address of the backup server connection for directory access. You must specify this parameter if Cisco UC Integration for Microsoft Lync cannot automatically discover the backup server. |
ServerPort1 | Port number |
Specifies the primary server port. You must specify this parameter if Cisco UC Integration for Microsoft Lync cannot automatically discover the primary server. |
ServerPort2 | Port number |
Specifies the backup server port. You must specify this parameter if Cisco UC Integration for Microsoft Lync cannot automatically discover the backup server. |
UseWindowsCredentials | 0 1 |
Specifies if Cisco UC Integration for Microsoft Lync uses Microsoft Windows user names and passwords.
|
ConnectionUsername | Username |
Specifies a username to connect to the directory server. The client transmits and stores this username as plain text. Using this parameter is not a secure method of authenticating with the directory server. In most deployment scenarios, you do not need to specify a username to connect to the directory server. This parameter enables you to authenticate with a directory server that requires a well-known or public set of credentials. You should include this parameter in the client configuration only if it is not possible to authenticate with the directory server with the user's credentials. |
ConnectionPassword | Password |
Specifies a password to connect to the directory server. The client transmits and stores this password as plain text. Using this parameter is not a secure method of authenticating with the directory server. In most deployment scenarios, you do not need to specify a password to connect to the directory server. This parameter enables you to authenticate with a directory server that requires a well-known or public set of credentials. You should include this parameter in the client configuration only if it is not possible to authenticate with the directory server with the user's credentials. |
UseSSL | 0 1 |
Specifies if Cisco UC Integration for Microsoft Lync uses SSL for secure connections to the directory.
|
UseSecureConnection | 0 1 |
|
Parameter | Value | Description | ||
---|---|---|---|---|
BaseFilter | Base filter |
Specifies a base filter for Active Directory queries. Specify a directory subkey name only to retrieve objects other than user objects when you query Active Directory. The default value is (&(objectCategory=person). Configuration files can contain only valid XML character entity references. Use & instead of & if you specify a custom base filter. In some cases, base filters do not return query results if you specify a closing bracket in your Cisco UC Integration for Microsoft Lync configuration file. For example, this issue might occur if you specify the following base filter: (&(memberOf=CN=UCFilterGroup,OU=DN)) To resolve this issue, remove the closing bracket; for example, (&(memberOf=CN=UCFilterGroup,OU=DN) |
||
PredictiveSearchFilter | Search filter |
Defines a filter to apply to predictive search queries. The default value is anr= If you want Cisco UC Integration for Microsoft Lync to search for attributes that are not set for ANR, you must configure your directory server to set those attributes for ANR. |
||
DisableSecondaryNumberLookups | 0 1 |
Specifies whether users can search for alternative contact numbers if the work number is not available, such as the mobile, home, or other number.
|
||
PhoneNumberMasks | Mask string |
Specifies masks to use when users search for phone numbers. For example, a user receives a call from +14085550100. However, this number in Active Directory is +(1) 408 555 0100. The following mask ensures that the contact is found: +14081+(#) ### ### #### The length of mask strings cannot exceed the size restriction for registry subkey names. |
||
SearchTimeout | Number of seconds |
Specifies the timeout period for queries in seconds. The default value is 5. |
||
UseWildcards | 0 1 |
Specifies whether to enable wildcard searches.
You can use phone number masks instead of wildcard searches. |
||
Searchable organizational unit (OU) in the directory tree |
Specifies a location in the directory server from which searches begin. In other words, a search base is the root from which Cisco UC Integration for Microsoft Lync executes a search. By default, Cisco UC Integration for Microsoft Lync searches from the root of the directory tree. You can specify the value of up to five search bases in your OU to override the default behavior.
|
You can set masks to use when Cisco UC Integration for Microsoft Lync searches your directory for a phone number with the PhoneNumberMasks parameter.
Phone masks apply to phone numbers before Cisco UC Integration for Microsoft Lync searches your directory. If you configure phone masks correctly, directory searches succeed as exact query matches and prevent any impact to performance of your directory server.
Element | Description |
---|---|
Phone number pattern | Provides a number pattern to retrieve phone numbers from your directory. To add a phone mask, you specify a number pattern that applies to the mask. For example, to specify a mask for searches that begin with +1408, you can use the following mask: +1408|+(#) ### ### #### To enable a mask to process phone numbers that have the same number of digits, but different patterns, use multiple masks with the same number of digits.
|
Pipe symbol (|) | Separates number patterns and masks. For example, +1408|+(#) ### ### ####|+34|+(##) ### ####. |
Wildcard character | Substitutes one or more characters for a subset of possible matching characters. Any wildcard character can exist in a phone mask.
|
Reverse mask | Applies a number pattern from right to left. For example, a mask of +3498|R+34 (98) 559 #### applied to +34985590199 results in +34 (98) 559 0199. You can use both forward and reverse masks. |
Parameter | Value | Description |
---|---|---|
UseSIPURIToResolveContacts | true false |
Specifies whether Cisco UC Integration for Microsoft Lync retrieves contact information using the value of the attribute you specify in the SipUri parameter.
|
UriPrefix | Text string |
Defines the prefix that applies to the value of the attribute you specify in the SipUri parameter. The prefix is any text that exists before the username of the contact ID. For example, you specify msRTCSIP-PrimaryUserAddress as the value of SipUri. In your directory the value of the msRTCSIP-PrimaryUserAddress attribute has the following format: sip:username@domain. The default value is blank. |
PresenceDomain | Text string | Specifies the domain name used for creating instant messaging addresses for directory contacts. username@domain |
Note |
The Active Directory attribute msRTCSIP-PrimaryUserAddress must contain the SIP URI in the format sip:username@domain and the configuration file must have the following entry in the Directory section for contact resolution to perform properly. <Directory> <UseSIPURIToResolveContacts>true</UseSIPURIToResolveContacts> <SipUri>msRTCSIP-PrimaryUserAddress</SipUri> <UriPrefix>sip:</UriPrefix> <PresenceDomain>example.com</PresenceDomain> </Directory> |
Parameter | Value | Description |
---|---|---|
TFTPServer1 | IP address Hostname FQDN |
|
CtiServer1 | IP address Hostname FQDN |
Specifies the address of your CTI server. This parameter is required only if the address of your CTI server is not the same as the address of your TFTP server. If both server addresses are the same, you do not need to specify this parameter in your configuration file. |
CcmcipServer1 | IP address Hostname FQDN |
Specifies the address of your CCMCIP server. This parameter is required only if the address of your CCMCIP server is not the same as the address of your TFTP server. If both server addresses are the same, you do not need to specify this parameter in your configuration file. |
<Phone> <TftpServer1>tftpserver.domain.com</TftpServer1> <CtiServer1>ctiserver.domain.com</CtiServer1> </Phone>
The application supports obtaining the location of TFTP and CCMCIP servers from the Microsoft Windows registry. The following registry values can be used to specify these servers:
The application will first search for these values in HKEY_CURRENT_USER\Software\Cisco Systems, Inc.\Client Services Framework\AdminData and then HKEY_CURRENT_USER\Software\Policies\Cisco Systems, Inc.\Client Services Framework\AdminData. Values located in these registry keys will override information specified in the configuration file. Values will be read from the configuration file if they cannot be found in either of these registry locations.
Note |
Configuration through the registry is only supported with these four values. |
CTI Load Balancing allows Cisco UC Integration for Microsoft Lync to use Cisco Unified Communications Group information to determine which CTI server to use.
A CTI device typically has a one to one mapping to a Device Pool and each pool has a one to one mapping with a Cisco Unified Communications Manager group. That group has one of more Cisco Unified Communications Manager servers associated with it. Cisco UC Integration for Microsoft Lync will use the first two highest priority servers in the group when CTI Load Balancing is enabled. These two servers become the primary and secondary CTI servers. These servers override any other CTI server settings.
Note |
Select in Cisco Unified Communications Manager to view group information. |
This feature is enabled by creating the registry key UseCUCMGroupForCti and setting the value to true. The application will first search for this value in HKEY_CURRENT_USER\Software\Cisco Systems, Inc.\Client Services Framework\AdminData and then HKEY_CURRENT_USER\Software\Policies\Cisco Systems, Inc.\Client Services Framework\AdminData.
Note |
If the desktop phone device configuration file is encrypted but the software phone device configuration file is not encrypted, the CUCM Group information contained in the software phone device configuration file will be used. If no software phone device configuration file is present, the CTI server information cannot be obtained by this method. |
A new Internet Explorer window or tab can be opened to display information about an incoming caller. This information is displayed after the incoming call is accepted. The behavior of the new window or tab and the information it displays are controlled using the configuration file. The following table lists the parameters used to display the new window or tab.
Parameter | Value | Description |
---|---|---|
BrowserContactURI | The base URI used to open Internet Explorer. Must have an %ID% key marker. | |
BrowserFallbackURI | A fall back URI used when the BrowserIDType information does not arrive within a period of time. | |
BrowserBehavior | The behavior of the browser when opening new URIs. | |
NewTab | Open the URI in a new tab if available. Open a new browser window if tabs are not supported. | |
Navigate | Navigate to the new URI in the browser window already open. | |
NewWindow | Always open a URI in a new browser window. | |
BrowserIDType | The type of ID supplied to the URI defined in the registry. | |
CallNumber | The media address of the participant | |
CallDisplayName | The display name of the participant | |
ContactBusinessNumber | The business number of the contact | |
ContactMobileNumber | The mobile number of the contact | |
ContactHomeNumber | The home number of the contact | |
ContactOtherNumber | The other number of the contact | |
ContactDisplayName | The display name of the contact | |
ContactURI | The URI of the contact (user@domain.com for example) | |
ContactEmail | The email of the contact (email@work.com for example) | |
ContactUsername | The user logon name of the contact. | |
BrowserIDFilter | Regular expression | A filter applied to the chosen BrowserIDType that will prevent a new browser window or tab if a match is made. The following are examples of regular expressions:
Any valid regular expression supported by the Microsoft std::tr1::regex library can be used. |
Note the following items when implementing this feature:
This feature can only be implemented with Microsoft Internet Explorer 7.0, 8.0, or 9.0. No other browser is supported.
The following examples demonstrate configuration file entries for this feature.
<BrowserPop> <BrowserContactURI>www.example.com/%ID%.html</BrowserContactURI> <BrowserIDType>ContactUsername</BrowserIDType> <BrowserFallbackURI>www.example.com</BrowserFallbackURI> <BrowserBehavior>NewTab</BrowserBehavior> </BrowserPop>
<BrowserPop> <BrowserContactURI>www.example.com/%ID%.html</BrowserContactURI> <BrowserIDType>ContactEmail</BrowserIDType> <BrowserFallbackURI>www.example.com</BrowserFallbackURI> <BrowserBehavior>NewWindow</BrowserBehavior> </BrowserPop>
<BrowserPop> <BrowserContactURI>www.example.com/%ID%.html</BrowserContactURI> <BrowserIDType>CallNumber</BrowserIDType> <BrowserIDFilter>[^7]\d{3}</BrowserIDFilter> <BrowserFallbackURI>www.example.com</BrowserFallbackURI> <BrowserBehavior>Navigate</BrowserBehavior> </BrowserPop>
To enable automatic updates, you create an XML file that contains the information for the most recent version, including the URL of the installation package on the HTTP server. Cisco UC Integration for Microsoft Lync retrieves the XML file when users sign in, resume their computer from sleep mode, or perform a manual update request from the Help menu.
<JabberUpdate> <LatestBuildNum>value</LatestBuildNum> <LatestVersion>value</LatestVersion> <Message><![CDATA[your_html]]></Message> <DownloadURL>value</DownloadURL> </JabberUpdate>
Step 1 | Host the appropriate installation package on your HTTP server. |
Step 2 | Create an update XML file with any text editor. |
Step 3 | Specify the build number of the update as the value of the LatestBuildNum element. |
Step 4 | Specify the version number of the update as the value of the LatestVersion element. |
Step 5 | Specify HTML as the value of the Message element in the format: <![CDATA[your_html]]> |
Step 6 | Specify the URL of the installation package on your HTTP server as the value of the DownloadURL element. |
Step 7 | Save and close your update XML file. |
Step 8 | Host your update XML file on your HTTP server. |
Step 9 | Specify the URL of your update XML file as the value of the UpdateUrl parameter in your configuration file. |
<JabberUpdate> <LatestBuildNum>12345</LatestBuildNum> <LatestVersion>9.2.1</LatestVersion> <Message><![CDATA[<b>This new version of Cisco UC Integration for Microsoft Lync lets you do the following:</b><ul><li>Feature 1</li><li>Feature 2</li></ul>For more information click <a target="_blank" href="http://cisco.com/go/cucilync">here</a>.]]></Message> <DownloadURL>http://server_name/CUCILyncSetup.msi</DownloadURL> </JabberUpdate>
Cisco UC Integration for Microsoft Lync uses an HTTP POST method to submit problem reports. Create a custom script to accept the POST request and specify the URL of the script on your HTTP server as a configuration parameter. Because users can save problem reports locally, you should also create an HTML page with a form to enable users to upload problem reports.
<form name="uploadPrt" action="http://server_name.com/scripts/UploadPrt.php" method="post" enctype="multipart/form-data"> <input type="file" name="zipFileName" id="zipFileName" /><br /> <input type="submit" name="submitBtn" id="submitBtn" value="Upload File" /> </form>
Step 1 | Host your custom script on your HTTP server. |
Step 2 | Specify the URL of your script as the value of the PrtLogServerUrl parameter in your configuration file. |
<?xml version="1.0" encoding="utf-8"?> <config version="1.0"> <Client> <PrtLogServerUrl>http://server_name.domain.com/prt_script.php</PrtLogServerUrl> <UpdateUrl>http://server_name.domain.com/update.xml</UpdateUrl> <Forgot_Password_URL>http://server_name.domain.com/password.html</Forgot_Password_URL> </Client> <Directory> <DirectoryServerType>EDI</DirectoryServerType> <BusinessPhone>aNonDefaultTelephoneNumberAttribute</BusinessPhone> <PhotoUriSubstitutionEnabled>true</PhotoUriSubstitutionEnabled> <PhotoUriSubstitutionToken>cn</PhotoUriSubstitutionToken> <PhotoUriWithToken>http://staffphoto.example.com/cn.jpg</PhotoUriWithToken> </Directory> </config>