![]() |
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.
![]() | Note |
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.
AE Services Properties (Settings used to connect to the AE Server). For information about editing these properties, see AE Services properties.
Connectivity - For information about editing these properties, see LDAP Properties - Connectivity.
Queries - For information about editing these properties, see LDAP Properties - Queries.
Shared Properties - For information about editing these properties, see Properties used by both AE Services and LDAP.
![]() | Note |
If you are not familiar with editing property files, see Tips for editing the property files. |
View the contents of the avaya-aes-sametime.properties file.
avaya.aes.sametime.cmapi.username.n
The value of this property is the name of the user account that logs on the AE Server. The user will have been added using the User Management page on the AE Server.
Example and usage tip: Username is also referred to as account name, user ID, or login ID. For example: aesametime1. See Administering the AE Services Security Database in the AE Services Management Console.
avaya.aes.sametime.cmapi.password.n
The value of this property is the password for logging in to the AE Server.
Example and usage tip: Create a password. The default User Management password policy, which is based on a US standard keyboard, calls for a minimum of 8 characters, including a minimum of 1 upper case, 1 lower case, 1 alphanumeric, and 1 special character. The following characters are not permitted: $ (dollar sign), ’ (apostrophe), " (quotation mark), \ (backslash), the space character, and any ASCII control-character.
avaya.aes.sametime.cmapi.server_ip.n
The value of this property is the DNS name or IP address of the AE Server.
Example and usage tip: Use nslookup to make sure that the IP address resolves to the DNS name (or that the DNS name resolves to the IP address).
avaya.aes.sametime.cmapi.server_port.n
The value of this property is the port number on the AE Server that is used for IBM Lotus Sametime connections. The default value is 4722. Only change this property if you have changed the port on which the AE Server listens for SSL connections.
Example and usage tip: If you need to change this setting, use the Ports page in the AE Services Management Console (Networking > Ports).
avaya.aes.sametime.trust_store_location
The value of this property is the name of a Java keystore in the resources directory to be used to authenticate the AE Server's certificate. It has no default value and is commented out by default. Set this property only if you have installed your own certificate on the AE Server. If you have installed your own certificate on the AE Server, the file specified by this property must contain a trusted Entry for the Certificate Authority (CA) that signed the AE Server’s certificate. Use this property only if you are using your own public key infrastructure system.
Usage tip: Change this field only if you are using your own PKI or are using LDAPS. See Keystore set up and importing a trusted certificate.
avaya.aes.sametime.trust_store_password
The value of this property is the password of the Java keystore specified by the preceding property. If the preceding property is set, this property is mandatory, and you will need to create a Java keystore password. Otherwise, it is unnecessary.
Usage tip: This password can be any password you choose to create. It does not need to conform to the User Management password rules.
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.
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.
avaya.aes.sametime.ldap.url.n
The value of this property is the URL of the LDAP server, which consists of the host name of the server, the port number on which the server listens, and whether to use SSL. Example values follow.
No SSL, default port number
ldap://ldap.example.com
No SSL, non-default port number
ldap://ldap.example.org:7780
SSL, default port number
ldaps://ldap.example.net
avaya.aes.sametime.ldap.admin_dn.n
The value of this property is the distinguished name (DN) of the user that logs into the LDAP server in order to execute the queries necessary to (1) discover the telephone number of a user or (2) discover the set of users whose telephones will provide telephony presence information (e.g., on a call, not on a call) to the Sametime server. Example values follow.
A distinguished name with common name Manager and domain components example and org.
cn=Manager,dc=example,dc=org
A distinguished name with common names Administrator and emea and domain components example and com.
cn=Admin,cn=emea,dc=example,dc=com
avaya.aes.sametime.ldap.admin_password.n
The value of this property is the password with which to login to the LDAP server in order to execute queries. No examples are provided.
avaya.aes.sametime.ldap.base_search_dn.n
The value of this property is the base distinguished name with which to perform LDAP queries (such as a query for the telephone number of a particular user or for the names of users whose telephones will provide telephony presence to the Sametime server). See DN entries and scope of search for more information about the significance of this property. This property is used by both the Conference Service and the Presence Service. Example values follow.
The base distinguished name for queries is the common name emea and the domain components example and org.
cn=emea,dc=example, dc=org
The base distinguished name for queries is the common names fr and emea and the domain components example and com.
cn=fr,cn=emea,dc=example,dc=com
avaya.aes.sametime.ldap.telephone_number_attr
The value of this property is the name of the attribute for a person's office telephone number in the directory. This property is used by both the Conference Service and the Presence Service. An example value follows.
The attribute of a person's office telephone number in the directory is telephonenumber.
telephonenumber
avaya.aes.sametime.ldap.user_attr
The value of this property is the name of the attribute for a person's name in the directory. This property is used by both the Conference Service and the Presence Service. An example value follows.
The attribute of a person's name is cn.
cn
avaya.aes.sametime.ldap.users_attr_value
The values of these properties are the names of an attribute and a value to be used in a query for discovering the names of all users whose telephones will provide telephony presence to the Sametime server. They are used to build an expression of the form attribute=value. This property is used only by the Presence Service. Without this query, the Presence Service will not be able to discover the names of the users whose telephones provide telephony presence to the Sametime server. Example values follow.
The name of the attribute is objectclass and the value is person. When qualified with the base distinguished name of the base_search_dn property, the expression objectclass=person denotes all persons who fall under that distinguished name. If this category encompasses more than just the users whose telephones will provide telephony presence, then you must use a more refined pair of attribute and value for this query.
objectclass
person
The name of the attribute is sametime Presence and the value is true. Unlike the previous example, this example would likely require that you modify your directory's schema.
sametimePresence
true
The name of the attribute is sametime Server and the value is stserver1.example.org. This example would also likely require that you modify your directory's schema. In an environment with multiple Sametime servers, this use of this attribute/value pair would allow you to identify exactly which instances of the Presence Service would be responsible for publishing telephony presence for which users.
sametimeServer
stserver1.example.org
avaya.aes.sametime.ldap.page_size
The value of this property specifies the number of records to request at a time from the LDAP server 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 server by causing it to return a single, potentially large result set. For example:
Default size: 500Non-default size: 420
In this example, 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 does not support RFC 2696. The Domino LDAP server, for example, does not support it.
avaya.aes.sametime.e164_ignore_dialcharacters
avaya.aes.sametime.e164_ignore_dialcharacters=[.]
Ignore all periods, such that +1.800.555.1234 will be +18005551234.
avaya.aes.sametime.e164_ignore_dialcharacters=[\\s()]
Ignore all white space and parentheses, such that +1 (800) 555 1234 will be +18005551234.
avaya.aes.sametime.e164_ignore_dialcharacters=[/.()\\s\\-]
Ignore forward slash, period, parentheses, white space, and hyphen, such that +01.44 (80)-55/123 will be +01448055123.
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.
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.
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\\-]