Print

Manually Editing the avaya-aes-sametime.properties file

This section describes how to edit the avaya-aes-sametime.properties file to set the AE Services server and LDAP configuration properties and to enable LDAP for Domino.

noteNote

This section is not required if you run configurator.bat.

The avaya-aes-sametime.properties file is a relatively large file, but it can be broken down into the following groups of properties.

View the contents of the avaya-aes-sametime.properties file.

AE Services properties

Properties used by both AE Services and LDAP

Running aes-tester

After you have entered your AE Services settings in the avaya-aes-sametime.properties file, you can verify them by running the aes-tester.bat (Windows) or aes-tester.sh (Linux) script, which is located as follows:
  • For Community Server: .\telephony_ext\AES\bin\

  • For Media Manager: .\sametime_tcspi\AES\bin\

Run aes-tester.bat in cmd.exe. Run the aes-tester tool any time you make a change to the AE Server properties in the properties file. The aes-tester tool is an effective tool in detecting connectivity issues between the Sametime server and the AE Services Server.

LDAP Properties - Connectivity

See Sametime directories configuration and setting up the LDAP properties in the Avaya configuration properties file, for more information about specifying the LDAP connectivity properties.

LDAP Properties - Queries

LDAP Properties - Queries, continued

LDAP Properties - Updating E.164 phone numbers in your directory

Customers whose phone numbers are not already stored in E.164 format in their directory may have a large number of users, making it tedious and inefficient to update the phone numbers manually. Most LDAP servers have tools for performing batch modifications, usually using the LDAP Interchange Format (LDIF). For example, you can modify the contents of an Active Directory server using the Microsoft ldifde program. As another example, if the server is IBM Lotus Domino, you can either use a tool such as the OpenLDAP ldapmodify command or write an agent in LotusScript and execute it using Domino Designer.

Running ldap-tester

After you have entered your LDAP settings in the avaya-aes-sametime.properties file, you can verify them by running the ldap-tester.bat (Windows) or ldap-tester.sh (Linux) script, which is located as follows:
  • For Community server: .\telephony_ext\AES\bin\

  • For Media Manager: .\sametime_tcspi\AES\bin\

  • For Standalone Presence Service: .\presence_service\AES\bin\

Run ldap-tester.bat in cmd.exe. Run the ldap-tester tool any time you change the LDAP properties in the properties file. The ldap-tester tool is an effective tool in detecting connectivity issues between the Sametime server and the LDAP server and desired LDAP query criteria for the Presence Service.

Adding users to your LDAP store and restarting the Conference Service and Presence Service

If a user is added to the LDAP store after the Presence Service is started, the Presence Service will become aware of that user the next time the Presence Service is restarted. (The Conference Service will automatically discover new users.) Also, if a user's phone number in the LDAP store changes, the Presence Service will become aware of the change after it is restarted; the Conference Service will automatically discover the changed telephone number.

###############################################################################
# The name of the Sametime user account on AE Services.
#
# Examples:
#     None
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.cmapi.username=
###############################################################################
# The password of the Sametime user account on AE Services.
#
# Examples:
#     None
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.cmapi.password=
###############################################################################
# The fully-qualified host name or IP address of the AE Services server.
#
# Examples:
#     FQHN:               hostname.example.com
#     IP address:         192.168.0.42
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.cmapi.server_ip=
###############################################################################
# The TLS port on AE Services.
#
# Examples:
#     Default port:        4722
#     Non-default port:   12013
#
# The default value of this property is 4722.  It is configurable on the
# AE Services server on the Ports page of the OA&M interface.
###############################################################################
#avaya.aes.sametime.cmapi.server_port=4722
###############################################################################
# The path to the Java key store used to establish trust with AE Services and
# LDAP-S.  The key store must be in AES/resources.
#
# Examples:
#     Default JKS:        avaya.jks
#     Non-default JKS:    [your organization].jks
#
# The default value of this property is avaya.jks.  The default value is
# appropriate except when the AE Services server has been configured to use
# non-default certificate.  If your organization has its own Public Key
# Infrastructure, it is likely you will need to use a non-default key store.
###############################################################################
#avaya.aes.sametime.trust_store_location=avaya.jks
###############################################################################
# The password of the Java key store used to establish trust with AE Services
# and for LDAP-S
#
# Examples:
#     None
#
# The default value of this property is the password of the default Java
# key store, avaya.jks.
###############################################################################
#avaya.aes.sametime.trust_store_password=
###############################################################################
# The URL of the LDAP server.
#
# Examples:
#     Non-SSL connection: ldap://hostname.example.com
#     SSL connection:     ldaps://hostname.example.com
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.ldap.url=
###############################################################################
# The name of the user to login as on the LDAP server.
#
# Examples:
#     Domino LDAP server: cn=sametime admin,o=domino_domain
#     Active Directory:   cn=ldap admin,dc=example,dc=com
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.ldap.admin_dn=
###############################################################################
# The password with which to login on the LDAP server.
#
# Examples:
#     None
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.ldap.admin_password=
###############################################################################
# The base Distinguished Name (dn) to use for directory searches.
#
# Examples:
#     Domino LDAP server: o=domino_domain
#     Active Directory:   dc=example,dc=com
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.ldap.base_search_dn=
###############################################################################
# The page size -- the number of records -- to request from the LDAP server
# at a time during LDAP searches.  This value should be large enough to allow
# potentially large searches, such as those performed by the Presence Service,
# to complete in a reasonable amount of time without overwhelming the LDAP
# by causing it to return a single, potentially large result set.
#
# Examples:
#     Default size:       500
#     Non-default size:   420
#
# The default value of this property is 500.  The default value is appropriate
# in almost all cases.  This property is ignored if the LDAP server doesn’t
# support RFC 2696.  The Domino LDAP server does not support that RFC.
###############################################################################
#avaya.aes.sametime.ldap.page_size=
###############################################################################
# The attribute of a user’s office phone in directory.
#
# Examples:
#     Domino:             telephonenumber
#     Active Directory:   telephonenumber
#
# The default value of this property is telephonenumber.
###############################################################################
#avaya.aes.sametime.ldap.telephone_number_attr=telephonenumber
###############################################################################
# The attribute of a user’s name in directory.  Used by the Conference Service.
#
# Examples:
#     Domino: dn
#     Active Directory:  dn
#
# The default value of this property is dn.
###############################################################################
#avaya.aes.sametime.ldap.conference.user_attr=dn
###############################################################################
# The attribute of a user’s name in directory.  Used by the Presence Service.
#
# Examples:
#     Domino 7:           uid
#     Domino 8:           displayname
#     Active Directory:   dn
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.ldap.presence.user_attr=
###############################################################################
# The attribute used for retrieving all Sametime users from directory.  Used
# by the Presence Service.  Please consult the section "About the
# avaya-aes-sametime.properties file" in the AE Services Integration Guide
# for IBM Lotus Sametime to understand this property.
#
# Examples:
#     Simple deployment:  objectclass
#     Anything else:      See documentation
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.ldap.users_attr=
###############################################################################
# The attribute value used for retrieving all Sametime users from directory.
# Used by the Presence Service.  Please consult the section "About the
# avaya-aes-sametime.properties file" in the AE Services Integration Guide
# for IBM Lotus Sametime to understand this property.
#
# Examples:
#     Simple deployment:  person
#     Anything else:      See documentation
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.ldap.users_attr_value=
###############################################################################
# A regular expression character class containing a set of values to be
# ignored from a dialstring retrieved from LDAP. If any of these characters are
# found in the dialstring, the Presence Service will ignore the character(s)
# before passing the dialstring to AES to return an E.164 number.
# Follows standard regular expression syntax: \s = whitespace (space, tab, line
# break). A backslash must be escaped by another backslash: \\- for a hyphen.
# If no value is present, the Presence Service will continue the current E.164
# restrictions for LDAP dialstrings as described in the Integration Guide.
#
#
# Examples:
#     Pattern: [()\\s\\-]
#        LDAP dialstring: +1 (234) 567-7890  will pass +12345677890
#     Pattern: [/.]
#        LDAP dialstring: +1/234/567.7890  will pass +12345677890
#
# This property does not have a default value.
###############################################################################
avaya.aes.sametime.e164_ignore_dialcharacters=[/.()\\s\\-]