Arc Pro. LDAP Server. User Guide. Version 6.1.0

Transcription

1 Arc Pro LDAP Server User Guide Version 6.1.0

2 Arc Solutions (International) Ltd. All rights reserved No part of this documentation may be reproduced in any form or by any means or used to make any derivative work (such as translation, transformation, or adaptation) without permission from Arc Solutions (International) Limited. Arc Solutions (International) Limited reserves the right to revise this documentation and to make changes to its content from time to time without obligation on the part of Arc Solutions (International) Limited to provide notification of such revision or change. Cisco is a registered trademark of Cisco, inc. Unless otherwise indicated, Arc Solutions (International) Limited registered trademarks are registered in the United Kingdom and may or may not be registered in other countries. All trademarks acknowledged. EMEA Americas Asia Pacific Arc Solutions (International) Ltd. Innovation House Pincents Lane Reading, Berkshire RG31 4UH T: +44(0) F: +44(0) Arc Solutions (International) Inc. Research Triangle Park 4819 Emperor Blvd Durham North Carolina T: F: Arc Solutions (International) Ltd. 2 Marks Street Naremburn NSW 2065 Australia T: F: +61 (0) e: info@arcsolutions.com e: inquiries@arcsolutions.com e: info@arcsolutions.com Support or +44(0) from outside the UK Support Support or +44(0) An Enghouse Interactive Inc. Company 31/07/14

3 Contents Introduction... v About This Document... v Getting Help... v 1 Architecture and Interface... 1 LDAP Server Architecture... 1 LDAP Database Support... 1 Arc Pro Database Support... 2 Arc Pro Console Support... 2 Client Support... 2 Contact Synchronization... 2 Keep Alive Processing... 2 LDAP Server Interface... 3 Menu Bar... 3 Activity... 3 Server Status... 4 Status Bar Controlling Arc LDAP Server Services... 5 Connecting the Server To Its Services... 5 Starting and Stopping Arc LDAP Server Services Configuring Arc LDAP Server...7 General Tab... 7 CT Server Tab... 8 Logging Tab... 9 Logging Levels... 9 Trace Level Trace Features Logging Files Synch Session Logging Arc Pro LDAP Server User Guide iii

4 iv

5 Introduction The Arc LDAP (Lightweight Directory Access Protocol) Server application is a part of the Arc Pro suite, and it performs the following functions: Transfers directories of internal or external contacts from website sources to the Arc Connect Computer Telephony Server application (CT Server), from where they are accessible to the Arc Console application. It also imports the domain and security information from the directory sources. Indexes the contacts, selects them, and returns the information to the Console, where operators can view and update the information. Displays the status of the primary CT Server, the configured database and the log database. About This Document This guide contains the following sections: 1: Architecture and Interface. This explains the architecture of the Arc LDAP Server application, and provides an introduction to the functions of the application and also instructions on how to use them. 3: Configuring Arc LDAP Server. This describes how to set the preferences for the LDAP Server application. It defines the functions to be set in the preferences, so that the application works according to the user's requirement. 2: Controlling Arc LDAP Server Services. This describes how to start and stop the LDAP Server and getting help. Getting Help For context-sensitive help on using the Arc LDAP Server, mouse over the relevant part of the interface and press F1. Arc Pro LDAP Server User Guide v

6 vi

7 1: Architecture and Interface This section describes: LDAP Server Architecture, page 1 LDAP Server Interface, page 3 LDAP Server Architecture The LDAP Server synchronizes internal and external contacts to the local database configured by the Arc CT Server. Console users can view and update the contacts information, and these changes are also updated in the LDAP source. You configure the LDAP Server using the LDAP Synchronization option within the Arc Configuration utility. Arc LDAP Server uses NT Service Architecture and performs the following key functions: LDAP Database Support Arc Pro Database Support Arc Pro Console Support Client Support Contact Synchronization Keep Alive Processing LDAP Database Support The LDAP Server connects to LDAP databases and identifies the contact records that require synchronization. Arc LDAP Server supports the following LDAP databases: Sun Microsystems IPlanet\Netscape, IPlanet versions (5.1, 5.2) Microsoft Active Directory Arc Pro LDAP Server User Guide 1

8 Architecture and Interface ADAM Novell edirectory CUCM (Cisco Unified Communication Manager via AXL) FILE for importing Arc Pro Database Support The LDAP Server connects to an Arc Pro Configuration database to identify contact records that require synchronization. Arc Pro Console Support The LDAP Server connects to the Arc Pro CT Server to manage contact changes made through the Console Operator. The connection to the Arc Pro CT Server is via TCP/IP using the Multi Session Interface (MSI - an Arc proprietary protocol). Client Support The LDAP Server communicates with a TCP/IP socket, allowing the Client application to connect and request status information and change settings online. Client applications, such as Console, can only modify contacts that have not been included in the source field mappings of LDAP contacts. Contact Synchronization The LDAP Server is linked with the Arc Pro Configuration database, LDAP Server database, and the MSI to support the following requirements: Filter: LDAP Server supports multiple filters so that users can create a customized rule that select records from the LDAP source and synchronizes them to the Arc database. Field Mapping: LDAP Server maps data between the supported Arc fields and the LDAP database. Read: LDAP Server reads data from the LDAP database and compare it to the Arc database. Changes are written back to the Arc database and the information is propagated to the Arc applications in real-time. Write: LDAP Server reads data from the Arc database and pushes the changes to the LDAP database. Both: LDAP Server reads and writes the data from the Arc database and drives the changes to the LDAP Server. Keep Alive Processing The LDAP Server uses Keep Alive Processing to test the validity of the network connection with the Primary CT Server. If Keep Alive Processing fails, the LDAP Server tries to reconnect to the CT Server by sending a small packet of data over the network connection and waiting for a response. If any leg of the process fails, the connection is identified as broken. 2

9 Architecture and Interface LDAP Server Interface The interface consists of the following: Menu Bar Activity Server Status Status Bar Menu Bar The following menu options are available in the LDAP Server. Menu Option Description File Connect After the LDAP Sever application starts, it automatically connects to Arc LDAP Sever Services using the information given during the installation. If the LDAP Sever cannot find the services or if it has been stopped, the Status bar displays Not Connected. Use this to reconnect the LDAP Sever. Service Manager Exit Start and stop LDAP Server services. Exit the LDAP Server application. If the services are running when you exit the application, the events and processes configured in Preferences are logged. Configuration Preferences Set preferences for the LDAP Server. Help Contents Open the Help File for Arc LDAP Server. Keyword Search About Find a Keyword in Help File. View the Arc LDAP Server release information. Activity This section displays statistics for the sources and synchronizations. Name Active Sources Description The number of sources that are active and fed in the Configuration Database. Arc Pro LDAP Server User Guide 3

10 Architecture and Interface Name Active Synchs Online/Offline Success Online/Offline Failure Description The number of active sources that are synchronizing data with the Server. The total number of the sources successively synchronizing through MSI and/or Arc Source. The online success synchronization is through MSI. The offline synchronization is through Arc Source. The total number of the sources failed in synchronizing through MSI and/or Arc Source. The online failure synchronization is through MSI. The offline failure synchronization is through Arc Source. Server Status This section shows the status of the connection between the LDAP Server and the Primary Arc CT Server: States Active Connected Not Connected Not Configured Description Arc CT Server is connected with Arc LDAP Server and currently being used for Requests and Processes. Specified Arc CT Server is available on the Network. Specified Arc CT Server is not available on Network. Details for the specified Arc CT Server are incomplete. When the CT Server is not available on the network, the Log Database is connected to run the contact synchronisation offline. When the CT Server is available the status becomes Active, and the Log database disconnects. When the CT Server is active, the contacts are synchronized online to the Configuration database directly. Status Bar This displays the application name and the LDAP Server connection status. 4

11 2: Controlling Arc LDAP Server Services This chapter describes how to start and stop the Arc LDAP Server services Connecting the Server To Its Services To Connect the Arc LDAP Server to its Services: 1. Run the Arc LDAP Server application. 2. Choose File > Connect. 3. Type the Server Name or the IP Address of the machine hosting the Arc LDAP Sever. 4. In Service Port Number type Click Connect. The LDAP Sever status changes to Stopped. Starting and Stopping Arc LDAP Server Services To start or stop Arc LDAP Sever service use the Service Manager: 1. Choose File > Service Manager. When the service is running, the signal is green and Stop Service is active. When the service is stopped, the signal is red and Start Service is active. 2. As appropriate: Click Start Service to start the service. Click Stop Service to stop the service. 3. Click Close to exit the Service Manager. Arc Pro LDAP Server User Guide 5

12 6 Controlling Arc LDAP Server Services

13 3: Configuring Arc LDAP Server To configure Arc LDAP Server default settings, choose Configuration > Preferences. Before making any changes, consult your Network/System Administrator. The Preferences dialog box has the following tabs: General Tab CT Server Tab Logging Tab General Tab Use this tab to enter the specify the LDAP Server. Name Description LDAP Server Server Name Server Port Number The Name or IP Address of the machine where the LDAP Service is installed. The Port Number used by the LDAP Server. Synchronization Arc Pro LDAP Server User Guide 7

14 Configuring Arc LDAP Server Name Synchronization Mode Synch Record Retries Synch Record Interval Delete Obsolete Contact Properties Description Select one of the following: Offline: changes are made directly to the database if LDAP Server is not connected. Online: synchronization makes changes to the database through the CT Server. Both: you can make changes using both offline and online synchronization modes. How many times it tries to synch a record if the initial Synch is unsuccessful. In milliseconds. Select this to remove those contact properties that are not included in LDAP contact source filed mappings. CT Server Tab Use this tab to configure the Primary Server and Request Time-out Delay. The CT Server on the Primary Server is used as default. If the Primary Server goes down or stops for any reason, the Console Operator application connects to the Log Database until it becomes active again. Name Description General Request Timeout Delay The delay (in milliseconds) before a synchronous request to the Arc CT Server, after which it is timed out by the LDAP Server. 8

15 Configuring Arc LDAP Server Name Description Primary CT Server Server name Server Port Number Auto Start Delay Connection Interval Connection Retries Keep Alive Interval Keep Alive Retries Name or IP Address of the machine where the Primary Server is installed. Service Port Number used by the Primary Server. The length of time the LDAP Server waits before trying to connect to the CT Server. Enter the time in Minutes and Seconds. The delay before the LDAP Server retries a connection request to the CT Server. Enter the time in Minutes and Seconds. How many times the Arc LDAP Service tries to connect with the primary Arc CT Server. The time interval between the Keep Alive requests sent by the LDAP Server to the CT Server. Enter the time in Minutes and Seconds. How many times the Arc LDAP Service tries to reconnect to the Arc CT Server. Logging Tab The LDAP Server can log all its events and processes so that support engineers can check its activity and performance, and so assess functionality loss and configuration issues. Use the Logging tab to set up Runtime Logging and Synch Session Logging. Logging Levels The LDAP Server application can log activities in these levels: Management Level Network Level Arc Pro LDAP Server User Guide 9

16 Configuring Arc LDAP Server MSI Server Level Arc Source Level External Source Level For each Logging Level you can set the: Trace Level Trace Features Trace Level Arc LDAP Server uses the trace levels, shown here with their hexadecimal equivalents (hex numbers are converted into binary by the application): Off = 0 Low = 1 Medium = 2 High = 4 Full = FFFF The higher the Trace Level, the more detailed the logs become. Trace Features Different features are logged for each of the Logging Levels, but the amount of information logged for a feature depends on the Trace Level. If Trace Level is 0, then there is no logging for that Level. Management Level Features The LDAP Server can log these features in management level, with their corresponding hex values: No Feature = 0 Requests = 1 Processes = 2 MSI Response = 4 DB Response = 8 All = F Network Level Features The LDAP Server can log these features in Network level: Use the following hexadecimal values to set the desired features for this level. No feature = 0 Comms Debug Feed = 1 Comms Error Feed = 2 TCP/IP Request = 4 TCP/IP Events = 8 All = F Comms Debug Feed - The TCP/IP events and processes during communication between the Arc LDAP Server and LDAP client applications. Comms Error Feed - The TCP/IP errors during communication between the Arc LDAP Server and LDAP client applications. 10

17 Configuring Arc LDAP Server MSI Server Level Features The LDAP Server can log these features in MSI Server Level: MSI Debug Feed - The TCP/IP events and processes during communication between the Arc LDAP Server and Arc CT Server. MSI Error Feed - The TCP/IP errors during communication between the Arc LDAP Server and Arc CT Server. Triggers - Arc LDAP Server signals that launch processes Keep Alive retries Connection Retries MSI Activity Use the following hexadecimal values to set the Trace Features for this Logging Level. No feature = 0 MSI Debug Feed = 1 MSI Error Feed = 2 Triggers = 4 Keep Alive retries = 8 Connection Retries = 10 MSI Activity = 20 All = 7F Arc Source Level Features The LDAP Server can log these features in Arc Source level, with their corresponding hex values: No feature = 0 DB Error Feed = 1 DB Debug Feed = 2 Triggers = 4 Connection Retries = 8 DB Activity = 10 DB Drive = 20 All = 7F External Source Level Features The LDAP Server can log these features in External Source level, with their corresponding hex values: No feature = 0 External Source Error Feed = 1 External Source Debug Feed = 2 Triggers = 4 External Source Activity = 8 Connection Retries = 10 External Server Activity = 20 All = 7F Logging Files The LDAP Server application records of the activities to a sequence of log files. Each log file contains a predefined number of lines, and there is a maximum number of log-files. Once the maximum number of log-files have been exceeded, the Server overwrites the first log-file and so on. This enables support engineers to ensure disk space is not exceeded. 1. Select the No. Of Logging File - the maximum number of the log files that should be created by Arc Pro LDAP Server User Guide 11

18 Configuring Arc LDAP Server LDAP Server. 2. Select the Lines Per File - the maximum number of lines each log file contains. After the log file reaches this number of lines, a new file are created to log the events. The Logging Path and File Name field shows the location of the log files, and is read-only. Synch Session Logging During synchronization, log files are created. Use this tab to specify the number and size of those files.j The fields are the same as in the Logging Files section of the Runtime Logging tab. 12