HiPath optipoint application module LDAP Functionality on optipoint application module

Transcription

1 LDAP HiPath optipoint application module LDAP Functionality on optipoint application module

2 bktoc.fm Contents Contents 0 1 Overview Scope of document What is LDAP? Required components Requirements Scope of functions on optipoint application module Configuration overview Entering LDAP Server Data on optipoint application module Entering LDAP server data Modifying LDAP Templates Editing LDAP templates Template header Search bases Search filters Search attributes Template footer Installing LDAP templates References Documentation Software Index Abbreviations and Terminology LDAP Functionality on optipoint application module, Function description

3 Overview Scope of document 1 Overview This document contains practical information on how to configure the LDAP client on an opti- Point application module (via the "LDAP" application). 1.1 Scope of document This document describes how to configure the optipoint telephone so you can use and modify the LDAP function on the optipoint application module. The following topics are not dealt with in this document: Running an LDAP search on an optipoint application module LDAP server administration Configuring further applications on an optipoint application module For further information on these topics, refer to the relevant documents listed in section 4, References. The information provided in this document contains merely general descriptions or characteristics of performance which in case of actual use do not always apply as described or which may change as a result of further development of the products. The trademarks used are the property of Siemens AG or their respective owners. 1.2 What is LDAP? LDAP is an abbreviation of Lightweight Directory Access Protocol. This network protocol allows you to access a directory server (LDAP server) via an LDAP client. You can then access various information stored there. In practice, this means, for example, that you enter the surname of a person you want to call in the optipoint application module. After a few moments, a hit list of the name(s) matching your entry is displayed. You can then call this person directly using the number that appears. 1.3 Required components The most important LDAP components are: Directory server (LDAP server): provides hierarchical storage of attributes such as names, telephone numbers, etc. LDAP client: allows you to enter search parameters and display the results. The following devices support the LDAP function: LDAP Functionality on optipoint application module, Function description 3

4 Overview Requirements optipoint application module optipoint display module optipoint 600 office Other optipoint telephones on the HiPath 3000/5000 communication platform (V5.0 and later) LDAP template: connects input and output fields on the LDAP client with attributes on the directory server. 1.4 Requirements The following requirements must be met before you start configuration: The optipoint application module must be connected to one of the following optipoint telephones and operational: optipoint 410 standard (CorNet IP) optipoint 410 advance (CorNet IP) optipoint 420 standard (CorNet IP) optipoint 420 advance (CorNet IP) You can also run the optipoint application module on optipoint 500 telephones, but these do not support the LDAP function. To optimize browser-based administration: You should know the IP address of the optipoint telephone with the optipoint application module you wish to configure. You should have a PC with a Web browser that can access the optipoint telephone with an attached optipoint application module via LAN. You can also connect a PC (a laptop, for example) directly to one of the telephones listed above using a LAN cable ( socket on the underside of the telephone). > See section 4, References to find out where you can obtain any additional information you need. 1.5 Scope of functions on optipoint application module You can use one or more search strings to find information on the directory server. You can use complete or partial strings. Enter an asterisk (*) if you are not using a complete string. You can call a person from the hit list simply by pressing a button. 4 LDAP Functionality on optipoint application module, Function description

5 Overview Configuration overview 1.6 Configuration overview The following table provides an overview of the sections in this document that describe how to administer the Java platform via a Web browser (WEB) and via the optipoint application module (APM). At a glance, you can see which configuration options are available for each task. Configuration task WEB APM Change LDAP server address Section Change LDAP server port Section Change FTP server address Section Change FTP account name Section Change FTP user name Section Change FTP password Section Change FTP LDAP template file name Section Change FTP LDAP template directory name Section Load LDAP template with FTP Section Reset LDAP template Only possible after reset to factory default. You can also use other methods to administer optipoint application module, such as the Deployment Tool or Deployment Service. For further information on these, see section 4, References. LDAP Functionality on optipoint application module, Function description 5

6 Entering LDAP Server Data on optipoint application module Entering LDAP server data 2 Entering LDAP Server Data on optipoint application module Before you can use LDAP on the optipoint application module, you must enter certain data on the telephone for communication with the LDAP server. 2.1 Entering LDAP server data 1. Open a Web browser and enter the IP address of the optipoint telephone that will receive the LDAP server data: address]:8085 The telephone homepage is displayed. 2. Click Administration. You are prompted you to enter the administration password. 3. Enter the password (default: ) and confirm your entry with Login. The administration menu is displayed. 4. In the menu select LDAP under Applications. An input form is displayed. 5. Enter the LDAP server address in the form and select Submit. 6. In the menu select Port Settings under System. An input form is displayed. 7. In the form, enter the LDAP server port in the LDAP line of the Home column and click Submit. You have now entered all data required for communication with the LDAP server on the telephone. 6 LDAP Functionality on optipoint application module, Function description

7 Modifying LDAP Templates Editing LDAP templates 3 Modifying LDAP Templates The LDAP template is an ASCII text file that uses an allocation list to assign directory server attributes to input and output fields on an LDAP client. The LDAP template must be modified correctly for successful communication between the directory server and the LDAP client. You must complete the following steps before using an LDAP template: Use a text editor to edit the LDAP template - see section 3.1, Editing LDAP templates. Install the LDAP template on the optipoint application module - see section 3.2, Installing LDAP templates. Check that the changes are displayed as required on the optipoint application module and that no error messages have been issued. 3.1 Editing LDAP templates The following section describes the syntax of LDAP templates and provides tips on modifying a template to meet your requirements. To install the modified template, see section 3.2, Installing LDAP templates. > LDAP templates contain information that is interpreted by the directory server. It is therefore important that the syntax is accurate. Edit the template carefully and save a copy of the template file before you make any changes. The following is an example of an LDAP template, which you can copy and paste into a file (for example, template.txt) to use as a basis for further editing. optipoint 410 LDAP TEMPLATE (V1) SEARCHBASE "dc=teamone,dc=intranet" SEARCHFILTER1 = "surnamenational,nachname" SEARCHFILTER2 = "givennamenational,vorname" SEARCHFILTER3 = "department,abteilung" SEARCHFILTER4 = "localityshortcode,ort" SEARCHFILTER5 = "ou,org. Einheit" SEARCHATTRIB1 = "commonnamenational,name,0" SEARCHATTRIB2 = "telephonenumber,telefon,1" SEARCHATTRIB3 = "alternatephone,telefon 2,1" SEARCHATTRIB4 = "mobiletelephonenumber,mobile,1" SEARCHATTRIB5 = "ou,organisationseinheit,0" SEARCHATTRIB6 = "localitynational,ort,0" LDAP Functionality on optipoint application module, Function description 7

8 Modifying LDAP Templates Editing LDAP templates SEARCHATTRIB7 = "department,abteilung,0" SEARCHATTRIB8 = "mainfunction,funktion,0" EOF The template may also contain any number of blank lines. You can also add comments. Text entered after two forward slashes (//) is interpreted as a comment. A template can be divided into different segments (described below) Template header The header consists of the entry optipoint 410 LDAP TEMPLATE (V1). Do not change this entry even if the optipoint application module is connected to a telephone from the optipoint 420 family Search bases The SEARCHBASE entry marks the starting point of a search in the directory server structure. In other words, you can use the SEARCHBASE entry as a filter. Examples: SEARCHBASE "" The search starts at the directory root. All entries are searched. SEARCHBASE = "C=DE" The search is restricted to entries assigned the country (C) Germany (DE). SEARCHBASE = "O=SIEMENS,C=DE" In addition to defining the country, the search is now further restricted to the Siemens organization. This entry must correspond to the directory server configuration. Only make changes here if you have the relevant information about the directory server. 8 LDAP Functionality on optipoint application module, Function description

9 Modifying LDAP Templates Editing LDAP templates Search filters The input form for an enhanced search is made up of the entries SEARCHFILTER1 to SEARCHFILTER5. SEARCHFILTER1 and SEARCHFILTER2 are also used for the basic search input field. All search filters are connected with a logical AND. Syntax for SEARCHFILTER fields: SEARCHFILTER1 = "surnamenational,nachname" Search filter name (1 to 5) Visible identifier of LDAP client input field Attribute name as specified in the directory server You can change the visible identifier for these entries according to your wishes, for example, "Nachname" to "surname". > Please note that there is a maximum length for every identifier. Identifiers that are too long are cut off in the optipoint application module display. Always check any changes you make on your telephone. You should only change attribute names or the number of search filter entries if you modify the configuration on the directory server accordingly Search attributes The entries SEARCHATTRIB1 to SEARCHATTRIB8 are identifiers for LDAP searches on the optipoint application module. The contents of the SEARCHATTRIB1 SEARCHATTRIB1 field are also displayed in the hit list. Syntax for SEARCHATTRIB fields: SEARCHATTRIB1 = "commonnamenational,name,0" Search attribute name (1 to 5) Attribute name as specified in the directory server Dial flag 1 = number can be dialed 0 = value cannot be dialed Visible identifier of result field in LDAP client The dial flag (0 or 1) appears as a button next to the result field. You dial the telephone number in the result field simply by clicking this button. LDAP Functionality on optipoint application module, Function description 9

10 Modifying LDAP Templates Editing LDAP templates You can change the visible identifier for these entries according to your wishes, for example, you can change "telephone" to "tel. no.". > Please note that there is a maximum length for each identifier. Identifiers that are too long are cut off in the optipoint application module display. Always check any changes you make on the telephone. You should only change attribute names or the number of search filter entries if you modify the configuration on the directory server accordingly Template footer The footer is the final part of the template. Do not make any changes here. 10 LDAP Functionality on optipoint application module, Function description

11 Modifying LDAP Templates Installing LDAP templates 3.2 Installing LDAP templates The following section describes how to install an LDAP template (see section 3.1, Editing LDAP templates ) on the optipoint application module. > A default template is preinstalled and delivered with the optipoint application module. This template is overwritten by the installation procedure described here. Check the requirements listed in section 1.4, Requirements. > 1. Open a Web browser and enter the IP address of the optipoint telephone whose LDAP template you want to install on the optipoint application module: address]:8085 The telephone homepage is displayed. 2. Click Administration. You are prompted to enter the administration password. 3. Enter the password (default: ) and confirm your entry with Login. The administration menu is displayed 4. Select File transfer from the menu. An input form is displayed. 5. Enter the following parameters in the form or check that the existing entries are correct: FTP server address: : IP address of the FTP server. FTP account name: account name for FTP server access. FTP username: user name for FTP server access. Only enter a password in both FTP password fields if the password has changed. The password is not displayed when entered in these fields. LDAP template filename: : file name with the LDAP template file suffix, for example, template.txt. FTP path: file path starting at the directory entered as the FTP root on the FTP server. The default entry is a dot (.), which means that a path has not been entered. 6. Select Download LDAP template from Action on submit. 7. Click Submit. LDAP templates can be installed by administrators and users. The following describes the procedure for administrators (that is, in the administration area of your Web browser). The installation takes a few seconds. If it is successful, the browser returns to the administration menu. If it is not successful, a corresponding error message is displayed. LDAP Functionality on optipoint application module, Function description 11

12 References Documentation 4 References The following list contains references and links to documentation and other sources of information. It is not exhaustive. 4.1 Documentation Configuration notes for IP terminals Non application-specific information for configuring IP-based optipoint terminals. URL: > Products, Solutions & Services > Clients & Devices WAP function on the optipoint application module Description of the "Browser" application administrative function on the optipoint application module. URL: > Products, Solutions & Services > Clients & Devices Java function on the optipoint application module Description of the "Prog." application administrative function on the optipoint application module. URL: > Products, Solutions & Services > Clients & Devices user manual optipoint application module Description of local and system-based procedures, explanation of user interface, etc.. URL: > Downloads > User Guides Ref. No.: A31003-A2056-M423-*-7619 (Search for A31003-A2056-M423 ) optipoint 410/420 family administration manual Explanation of administrative tasks for startup and configuration. URL: > Downloads > Administration Guides Ref. No.: A31003-A2056-B415-*-76A9 (Search for A31003-A2056-B415 ) 12 LDAP Functionality on optipoint application module, Function description

13 References Software 4.2 Software phpldapadmin Web-based LDAP client for testing LDAP servers. URL: OpenLDAP Open source software for LDAP servers. URL: LDAP Functionality on optipoint application module, Function description 13

14 bkix.fm Index Index Z B Basics 3 C Components (required) 3 Configuration overview 5 D Documentation 12 L LDAP server data 6 LDAP template editing 7 header 8 installing 11 search attributes 9 search bases 8 search filters 9 R Requirements 4 S Scope of functions 4 Software LDAP Functionality on optipoint application module, Function description

15 bkglos.fm Abbreviations and Terminology Abbreviations and Terminology X LDAP Lightweight Directory Access Protocol LDAP is a simplified protocol for accessing standard directory systems, for example, a corporate telephone directory. LAN Local Area Network LDAP Functionality on optipoint application module, Function description 15

16 The information provided in this document contains merely general descriptions or characteristics of performance which in case of actual use do not always apply as described or which may change as a result of further development of the products. An obligation to provide the respective characteristics shall only exist if expressly agreed in the terms of contract. The trademarks used are owned by Siemens AG or their respective owners. Siemens AG 2005 Siemens Communications Hofmannstr. 51 D München Subject to availability. Right of modification reserved