How do I edit ldap.properties, and do I need to restart my TDV server after editing it?

How do I edit ldap.properties, and do I need to restart my TDV server after editing it?

book

Article ID: KB0081211

calendar_today

Updated On:

Products Versions
TIBCO Data Virtualization v 7.0.0 and higher

Description

Introduction
TDV_INSTALL_DIR\conf\server\ldap.properties is an ASCII text file. It contains the LDAP filters that TDV uses to search your LDAP server for groups and users. 

For instance, the following filter tells TDV to search for groups and users under the domains DC=my and DC=com
      activedirectory.all.users.search.context=DC=my,DC=com
  
Resolution 

You can open ldap.properties with any text editor (e.g.Notepad++) and edit the filters to match your search requirements.

It is not necessary to restart TDV after editing ldap.properties. Whenever you save an edit to the file, the edit instantaneously takes effect. This is very useful as it means that you can experiment by making a change, and immediately finding out whether the change produced the desired effect or not. If the change resulted in an error, the error will be written to cs_server_client.log or cs_server.log. Therefore, these logs are a good source of feedback. We recommend the following procedure:

(1) Back up ldap.properties before editing it.

(2) Keep the cs_server_client.log and cs_server.log open in a text editor.

(3) Make a change to ldap.properties, and then test out the change. 

EXAMPLE: if you changed a group filter because you want to restrict the number of groups returned, click on the Edit External Groups button in the Web Manager to see if the desired groups are displayed.

(4) If you suspect that the change is erroneous (which is fairly common when initially editing a filter, as it usually takes a few attempts to correctly tune the filter):
  •    Refresh the cs_server_client.log and cs_server.log.
  •    Scroll to the bottom to the logs.
If an error was generated, it will be displayed at the bottom of the log.

You can cycle through steps (3) and (4) repeatedly until the filter that you are working with is tuned to your satisfaction.

Issue/Introduction

How do I edit ldap.properties, and do I need to restart my TDV server after editing it?