Baan OpenWorld 2.2. Installation and Configuration Guide for Adapter

Transcription

1 Baan OpenWorld 2.2 Installation and Configuration Guide for Adapter

2 A publication of: Baan Development B.V. P.O.Box AC Barneveld The Netherlands Printed in the Netherlands Baan Development B.V All rights reserved. The information in this document is subject to change without notice. No part of this document may be reproduced, stored or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Baan Development B.V. Baan Development B.V. assumes no liability for any damages incurred, directly or indirectly, from any errors, omissions or discrepancies between the software and the information contained in this document. Document Information Code: U7525B US Group: User Documentation Edition: A Date: July, 2001

3 Table of contents 1 Introduction 1-1 Baan OpenWorld Adapter installation and configuration 1-1 Directory Service installation and configuration 1-1 Installation and configuration utilities 1-2 Hardware prerequisites 1-2 Software requirements 1-2 Overview of installation and configuration steps To install and configure the Directory Service 2-1 To install and configure the SecureWay Directory server 2-1 Entries in the bus.properties file To install Baan OpenWorld Adapter 3-1 Installation steps 3-1 To uninstall Baan OpenWorld Adapter To configure Baan OpenWorld Adapter 4-1 About the Baan OpenWorld Adapter properties file 4-1 Location of properties file 4-1 About the Adapter Configuration tool 4-2 Starting the Adapter Configuration tool 4-2 Main Adapter Configuration dialog box 4-2 To edit the properties file 4-3 Properties tabs 4-3 Applying changes 4-4 Getting help 4-4 General tab 4-4 Logging tab 4-6 Directory Service tab To configure the Directory Service 5-1 About the BusComponent Editor 5-1 To start the BusComponent Editor 5-2 BusComponent Editor dialog box 5-2 To load the Directory Service information 5-3 To add a new component 5-3 To edit a component 5-3 To delete a component 5-4 i

4 Table of contents Component properties 5-4 General 5-4 Categories 5-5 Connection points 5-6 Activation 5-7 Appendix A To manually edit bus.properties 1 Sample properties file 1 Properties 2 General settings 2 Directory settings 3 Log settings 3 Advanced settings 4 Appendix B XML file Directory Service 1 To set up an XML file Directory Service 1 Example XML file Directory Service 2 Appendix C To configure Netscape Directory Server 1 Configuration procedure 1 Entries in the bus.properties file 6 Appendix D UNIX installation and configuration procedures 1 Prerequisites 1 Installation steps 1 Configuration steps 2 To test your installation 2 ii

5 About this document This guide describes how to install and configure the Baan OpenWorld Adapter software. It also describes how to install and configure a Directory Service in which the properties of Baan OpenWorld components are defined. To install the software, no specific operating system knowledge is required. You must, however, have a basic understanding of the Baan OpenWorld product suite concept and the Baan OpenWorld Adapter software in particular. This guide is divided into the following chapters: Chapter 1, Introduction, provides an overview of the installation and configuration requirements for Baan OpenWorld Adapter. It also describes the hardware and software prerequisites, and outlines the main installation and configuration steps. Read this chapter before you install the software. Chapter 2, To install and configure the Directory Service, describes how to install and configure the IBM SecureWay Directory server. Chapter 4, To install Baan OpenWorld Adapter, describes how to install Baan OpenWorld Adapter. Chapter 5, To configure Baan OpenWorld Adapter, describes how to configure Baan OpenWorld Adapter with the Adapter Configuration utility. Chapter 6, To modify the Directory Service, describes how to edit the Directory Service contents with the BusComponent Editor utility. Appendix A, To manually edit the bus.properties file, presents the syntax of the Baan OpenWorld Adapter bus.properties file and describes the properties it defines. Appendix B, XML file Directory Service, describes how to implement a Directory Service in XML flat file format. Appendix C, To configure Netscape Directory Service, describes how to install the Netscape Directory Server 4.0. Appendix D, UNIX installation and configuration procedures, describes how to install and configure the Baan OpenWorld Adapter on UNIX systems. iii

6 About this document Related documents Baan OpenWorld for BaanERP (U7305E US) Baan OpenWorld Configuration Guide for MQSeries for Baan OpenWorld Adapter (U7307C US) Baan OpenWorld Configuration Guide for MSMQ for Baan OpenWorld Adapter (U7308C US) Baan OpenWorld Deployment Guide for BCLM (U7652A US) Installation and Configuration Guide for the BaanCIT License Manager (U7631A US) iv

7 1 Introduction This chapter provides an overview of the installation and configuration requirements for Baan OpenWorld Adapter. It also describes the hardware and software prerequisites for Baan OpenWorld Adapter, and outlines the main installation and configuration steps. Baan OpenWorld Adapter installation and configuration Baan OpenWorld Adapter must be installed on every server and client that runs in the Baan OpenWorld environment and integrates using the Baan OpenWorld Adapter. In addition, the runtime settings for each server and client must be configured in the Baan OpenWorld Adapter properties file (bus.properties). This guide describes how to perform these tasks. All OpenWorld Adapter servers must be configured for the BaanCIT License Manager (BCLM), which is a central licensing engine that checks whether users or computers are licensed to start a Baan product. Directory Service installation and configuration Baan OpenWorld Adapter requires a Directory Service that stores information about all servers and clients that make use of Baan OpenWorld Adapter, indicating their name, address, message queues, ports, and so on. The Directory Service can be implemented either by an LDAP-compliant directory server, such as SecureWay Directory from IBM or the Netscape Directory Server, or by an XML flat file solution. This guide describes how to set up both types of implementation. 1-1

8 Introduction Installation and configuration utilities Baan OpenWorld Adapter runs on both MS Windows and UNIX systems. This guide describes the installation and configuration procedures for both platforms. For MS Windows systems, an installation program is provided on the Baan OpenWorld Adapter CD-ROM. When you install Baan OpenWorld Adapter using this program, both the run-time environment and the configuration utilities to set up this environment are placed on your computer. The configuration utilities consist of a Adapter Configuration tool that enables you to configure the bus.properties file and a BusComponent Editor that enables you to enter and edit the contents of the Directory Service. On UNIX systems, you must install and configure Baan OpenWorld Adapter manually. All OpenWorld Adapter servers must be configured for the BaanCIT License Manager (BCLM), which is a central licensing engine that checks whether users or computers are licensed to start a Baan product. For more information on the installation and configuration of the BCLM, refer to Baan OpenWorld 2.2 Deployment Guide for BCLM (U7652 US). Hardware prerequisites Baan OpenWorld Adapter requires the following hardware: A Pentium-class PC. 12 MB disk space. For Directory Service requirements, consult the documentation for the particular directory server you are using. Software requirements Operating system: The Windows operating system requirements are as follows: Windows Windows NT 4.0 SP3 or later. Windows 95. Windows 98. Windows ME. 1-2

9 Introduction NOTE Other software: Java Virtual Machine Baan OpenWorld Adapter requires a Java Virtual Machine (JVM) to function. The JVM must be installed before you can install the Baan OpenWorld Adapter. Note that the Microsoft JVM must be version or higher. BaanCIT License Manager On all Adapter servers, the client software of the BaanCIT License Manager (BCLM) must be installed and properly configured BCLM server must be available (refer to Baan OpenWorld 2.2 Deployment Guide for BCLM). Server/client connections The connection between the Adapter client side and the Adapter server side can be established in either the following ways: CP/IP sockets (a direct line between client and server). Microsoft message queues (MSMQ). IBM message queues (MQSeries). If you use message queues, the configuration for OpenWorld Adapter 2.2 is described in the following documents: Baan OpenWorld Configuration Guide for MSMQ for Adapter (U7308D US). Baan OpenWorld Configuration Guide for MQSeries for Baan OpenWorld Adapter (U7307 US). You must have administrator rights in order to successfully run the Baan OpenWorld Adapter installer. 1-3

10 Introduction Overview of installation and configuration steps These are the principal steps required for installing and configuring Baan OpenWorld Adapter: 1 Check the hardware and software requirements for Baan OpenWorld Adapter and make a checklist of all the servers and clients that need this software. 2 Install and configure a Directory Service either an XML flat file implementation or an LDAP Directory Service. Chapter 2, "To install and configure the Directory Service," describes how to install and configure IBM s LDAP-compliant SecureWay Directory Server. Appendix B, "XML file Directory Service," describes how to implement a Directory Service in XML flat file format. Appendix C, "To configure Netscape Directory Service," describes how to install and configure the Netscape Directory Server. 3 If you use message queues to connect the client side and the server side of Adapter, configure the message-oriented middleware (MOM) as explained in Baan OpenWorld Configuration Guide for MSMQ for Adapter (U7308D US) or Baan OpenWorld Configuration Guide for MQSeries for Baan OpenWorld Adapter (U7307 US). 4 Put the BaanCIT License Manager (BCLM) into service. This step is described in Baan OpenWorld Deployment Guide for BCLM (U7652 US). 5 Install Baan OpenWorld Adapter. This step is described in Chapter 3, To install Baan OpenWorld Adapter. 6 Configure the bus.properties file(s). You can do this by using the Adapter Configuration utility, as described in Chapter 4, "To configure Baan OpenWorld Adapter," or you can do so manually, as described in Appendix A, "To manually edit the bus.properties file." 7 Add entries in the Directory Service for each BusComponent in the Baan OpenWorld environment. You do this by using the BusComponent Editor utility, as described in Chapter 5, "To configure the Directory Service." You must install BCLM software on all Adapter servers (step 4) and repeat steps 5 and 6 for every server and client on which you install Baan OpenWorld Adapter. 1-4

11 2 To install and configure the Directory Service Baan OpenWorld Adapter requires a Directory Service in which the properties of Baan OpenWorld components are defined. For directory access, Baan OpenWorld Adapter adheres to the Lightweight Directory Access Protocol (LDAP). This means that customers can choose any LDAP-compliant directory server to provide the Directory Service. Alternatively, they can use an XML flat file implementation. Baan assumes that most customers will use an LDAP Directory Service. This chapter describes how to install and configure IBM s SecureWay Directory LDAP-compatible Directory Service. Appendix C, "To configure Netscape Directory Service," describes the configuration of the Netscape Directory Server, which is an example of another LDAP-compliant directory server. The XML flat file solution is described in Appendix B, "XML file Directory Service." To install and configure the SecureWay Directory server Take the following steps to install and configure the IBM SecureWay Directory server for Baan OpenWorld. Steps that are not specific to Baan OpenWorld are described on a high level only. There are two tools to configure the directory server: the Web interface and the Directory Management Tool (on the machine where the LDAP server is installed). The title bar of each screen display included in this section indicates which tool is used for each step. 1 Install the SecureWay Directory server as described in the instructions that accompany the software. There are no Baan OpenWorld-specific issues you must take care of during installation. SecureWay Directory does not need to run on the same server as any of the Baan Enterprise Solutions applications. 2 After installation you must define the suffix for your Directory Service that is, the root of the directory structure. Use the Web interface to enter the URL you created when installing the directory server. When you start the browser, log in as instructed. 2-1

12 To install and configure the Directory Service 3 To add the suffix for your Directory Service, double-click Server Suffixes Add a Suffix in the Directory Server column. Enter the required suffix in the Suffix DN field (o=baan.com is the example shown in the following illustration), and click Add a new suffix. Then, if the LDAP server is not already running, start it by choosing Server Startup and then clicking Startup. 2-2

13 To install and configure the Directory Service 4 Start the Directory Management Tool on the machine where the directory server software is installed. The following screen appears: 5 Double-click Server Rebind in the left windowpane. Select the Authenticated option and enter your username and password. Then click OK. To perform a quick check of your directory server, in the left pane doubleclick Tree Browse Tree to browse through the tree structure. If your installation is completely new it will be empty. 2-3

14 To install and configure the Directory Service 6 Enter the following Baan OpenWorld-specific attributes for the directory server: Attribute name OID Syntax Allow multiple values b3admin b3admin-oid DN Distinguished name No b3category b3category-oid Directory string Case insensitive string b3location b3location-oid DN Distinguished name No b3locationdesc b3locationdesc-oid Directory string Case insensitive string b3transactional b3transactional-oid Directory string Case insensitive string b3implementationclass b3implementationclass-oid IA5 string Case sensitive string b3online b3online-oid Directory string Case insensitive string CompanyNumber companynumber-oid Integer No PreferredConnection PreferredConnection-oid Directory string Case insensitive string eibconnectionpolicy eibconnectionpolicy-oid Directory string Case insensitive string b3activationreference b3activationreference-oid IA5 string Case sensitive string b3activationtype b3activationtype-oid Directory string Case insensitive string b3activationpoolpolicy b3activationpoolpolicy-oid Directory string Case insensitive string b3activationservertimeout b3activationservertimeoutoid Integer Yes No No No No No No No No No No 2-4

15 To install and configure the Directory Service To add each attribute, double-click Schema Attributes Add attribute in the left pane and enter the attribute details in the Add server attribute dialog box, as shown in the following illustration. 7 Add the object class b3component. To do so, double-click Schema Object classes Add object class. The following dialog box appears: 2-5

16 To install and configure the Directory Service NOTE On the General tab, enter the following details: Object class name: b3component OID: b3component-oid Superior object class: Top Object class type: Structural On the Required Attributes tab, add the following attributes: cn owner SecureWay automatically displays inherited attributes. On the Optional Attributes tab, add these optional attributes: b3admin b3category b3location b3locationdesc b3online companynumber description 8 Add the object class b3connectiontype. To do this, double-click Schema Object classes Add object class. On the General tab, enter the following details: Object class name: b3connectiontype OID: b3connectiontype-oid Superior object class: Top Object class type: Structural On the Required Attributes tab, add the following attributes cn labeleduri On the Optional Attributes tab, add these optional attributes: b3implementationclass b3transactional eibconnectionpolicy preferredconnection 2-6

17 To install and configure the Directory Service 9 In the same way, add the object class b3activation. On the General tab, enter the following details: Object class name: b3activation OID: b3activation-oid Superior object class: Top Object class type: Structural On the Required Attributes tab, add the following attributes b3activationreference b3activationtype cn On the Optional Attributes tab, add the following attributes b3activationpoolpolicy b3activationservertimeout To check the entries you created, double-click Schema Object in the left pane. 10 Add a directory entry for the suffix you defined in step 3. To do this, click Entries Add entry. The following dialog box appears: 2-7

18 To install and configure the Directory Service Enter the RDN for the suffix (for example, o=test.com), and select Organization as the entry type (the entry type is Organization because the suffix starts with "o=".). Then click Next. The following dialog box appears: No need to enter any attribute values here. Simply click Create. Next, click Tree Refresh Tree in the left windowpane. The new entry now appears in the directory tree, as shown in the following dialog box: 2-8

19 To install and configure the Directory Service 11 Define the access entitlements for the Directory Service. To do this, select the new entry in the directory tree and then click the ACL button. You can now select the required access control options, as shown in the following dialog box. You have now set up the LDAP SecureWay Directory Service ready for use with Baan OpenWorld. Entries in the bus.properties file Every computer that runs the Baan OpenWorld Adapter has a bus.properties file that defines the properties of that Adapter, including the Directory Service it uses. For more information on properties, refer to Chapter 4, To configure Baan OpenWorld. For more information on how to create new entries in the Directory Service for OpenWorld, refer to Chapter 5, To configure the Directory Service. 2-9

20 To install and configure the Directory Service 2-10

21 3 To install Baan OpenWorld Adapter This chapter describes how to install Baan OpenWorld Adapter on MS Windows platforms. For an overview of the installation requirements, refer to Chapter 1, Introduction. For details on how to install Baan OpenWorld Adapter on UNIX platforms, refer to Appendix D, UNIX installation and configuration procedures. You must have administrator rights to run the Baan OpenWorld Adapter installer program. When you install the software, the exact version number of OpenWorld can differ from the version number shown in the screen shots. Installation steps To install Baan OpenWorld Adapter, take the following steps: 1 Insert the Baan OpenWorld Adapter CD-ROM. The installation program starts automatically. If it does not start automatically, run the Setup.exe program. The Welcome dialog box appears: 3-1

22 To install Baan OpenWorld Adapter 2 Click Next to continue. 3 The following dialog box appears. 4 To accept the license terms, click Yes. 5 If a previous version of Baan OpenWorld Adapter is already installed on the computer, the following dialog box appears. 3-2

23 To install Baan OpenWorld Adapter 6 You must uninstall the present version. Click Next to uninstall the present version and after that, continue the setup. You can have only one version of the OpenWorld Adapter installed at the same time. If you want to keep the present version, click Cancel and the setup is aborted. 7 The install program now checks whether a Java Virtual Machine is installed on the computer. If it is not, exit the install program, install a Java VM, and then restart the Baan OpenWorld Adapter installation procedure. If a Java VM is present, the following dialog box appears. 8 Accept the default installation folder, or click Browse to specify a different destination folder in which to install the software. Click Next to continue. 3-3

24 To install Baan OpenWorld Adapter 9 The following dialog box appears. 10 Accept the default program folder, or enter or select the program folder to which you want the program icons to be added. Click Next to continue. 3-4

25 To install Baan OpenWorld Adapter 11 Setup now has enough information to start copying files. When the copy process is completed, the following dialog box appears. 12 Click Finish to complete the Baan OpenWorld Adapter setup. You can now choose to automatically display the README file and/or to start the Adapter Configuration utility. To uninstall Baan OpenWorld Adapter You can uninstall Baan OpenWorld Adapter by following the standard procedure on your Windows system. 1 Click Start, select Settings, and select Control Panel. 2 Double-click the Add/Remove Programs icon. 3 Select Baan OpenWorld Adapter 2.2, and click Add/Remove or Change/Remove (Windows 2000). 4 Click Yes to delete Baan OpenWorld Adapter 2.2. The uninstall program can ask whether to delete some shared files. Click OK. 5 When the uninstall program is completed, click OK. 3-5

26 To install Baan OpenWorld Adapter 3-6

27 4 To configure Baan OpenWorld Adapter This chapter describes how to configure the Baan OpenWorld Adapter on MS Windows systems, by using the Adapter Configuration tool. On UNIX systems, you must configure the Baan OpenWorld Adapter manually (see Appendix D, UNIX installation and configuration procedures ). About the Baan OpenWorld Adapter properties file The run-time settings of Baan OpenWorld Adapter are defined in a properties file that is stored on the computer on which Baan OpenWorld Adapter runs. There can be multiple properties files for each client and server that uses Baan OpenWorld Adapter. One is a generic properties file (bus.properties). The others are user specific (<username>_bus.properties). If there is a user-specific properties file for the logged on user, Baan OpenWorld Adapter uses this to determine its runtime properties. If not, it uses the generic properties file. The Baan OpenWorld Adapter for BaanERP uses the same properties file as the Adapter. Location of properties file On MS Windows systems, the order in which Baan OpenWorld Adapter searches for the properties file to use is as follows: Windows directory (for example, C:\WINNT on Windows NT systems) user-specific bus.properties file generic bus.properties file On UNIX systems, the order in which Baan OpenWorld Adapter searches for the properties file to use is as follows: Home directory user specific bus.properties file generic bus.properties file /etc directory user specific bus.properties file generic bus.properties file 4-1

28 To configure Baan OpenWorld Adapter You must make sure that the properties files are in the correct locations. If they are not, copy them to the appropriate directory(s), as indicated above. About the Adapter Configuration tool The Adapter Configuration tool updates the user-specific and generic bus.properties files for the local Baan OpenWorld Adapter. It runs on MS Windows systems only; on UNIX systems, you must configure the Baan OpenWorld Adapter manually (see Appendix D, UNIX installation and configuration procedures ). Starting the Adapter Configuration tool To start the Adapter Configuration tool when it is installed in the default location, click: Start > Programs > Baan OpenWorld 2.2 > Adapter > Adapter Configuration Main Adapter Configuration dialog box The Adapter Configuration tool enables you to select which properties file you want to edit and to presents all the available options. 4-2

29 To configure Baan OpenWorld Adapter To edit the properties file There can be multiple properties files for each client and server that uses Baan OpenWorld Adapter. One is a generic properties file. The others are user specific. When you start the Adapter Configuration tool, you must first select which bus.properties file you want to edit. There are two options, as shown in the following dialog box. In the upper part of the dialog box, you can choose to edit the user-specific properties file for the current user or the generic properties file for the computer to which you are logged on. Properties tabs When you select the properties file you want to edit, the current settings in that file are displayed on four tabs in the main Adapter Configuration dialog box: General Logging Directory Service Advanced This chapter describes the options provided by the first three tabs. The options on the Advanced tab are for advanced use only and do not normally need to be changed. They are not described here. 4-3

30 To configure Baan OpenWorld Adapter Applying changes To save changes made during the current session without exiting the Adapter Configuration tool, click Apply. To exit the Adapter Configuration tool and save any changes not yet applied, click OK. To exit the Adapter Configuration tool and abandon any changes not yet applied, click Cancel. Getting help The Adapter Configuration tool provides online help for the overall application and for each tab. To view the online Help, click Help. General tab Iterator Size The default number of records that are received in one fetch. This allows you to limit the amount of data that are transferred to the client in each message. You can override this default value in your application code. The amount of data delivered depends not only on the number of records delivered but also on the number of fields in a record and the number of associated tables. For smaller records, you can increase the number of records retrieved per fetch. For larger records, you can decrease the number of records retrieved. If you do not specify a value here, the property defaults to 250. Timeout (ms) The default time (in milliseconds) that Baan OpenWorld Adapter waits for a reply when performing a request to a server. You can override this timeout period in your application code. If you do not specify a value here, the property defaults to 60,000 milliseconds. 4-4

31 To configure Baan OpenWorld Adapter Client BusComponent The name of the local (client) Baan OpenWorld component, as registered in the Directory Service. Anonymous clients that use a socket transport service, must leave this field empty. All servers and named clients, and anonymous clients that use MQSeries as their transport service, must select this option and then click Browse to specify a component. Note that the component must be defined in the Directory Service before you can select it here. To select the Client BusComponent clicking Browse will only work, if you first specify the Directory Service settings (on the Directory Service tab). Default backend The backend that your Business Object Interface Manager connects to by default. To select a backend for default usage, click the Browse button. Then, in the Component Selector dialog box, select the required server component and click Select. This only works, if you first specify the Directory Service settings (on the Directory Service tab). 4-5

32 To configure Baan OpenWorld Adapter Logging tab Use this tab to manage Baan OpenWorld Adapter logging. Logging is mainly used to trace and analyze problems, and analysis of the log files requires specialized knowledge. If you do not have this knowledge, contact a qualified consultant. There are multiple logging categories and you can choose to log all categories of activity or selected categories only. The more categories you choose, the larger the log file will be. So, disable logging when you no longer require it. Settings Use these options to specify your logging requirements: Disable Logging is disabled. This is the default and most typical option used. Some Logging is enabled for specified categories. To select the categories of activity you want to log, click Specify and then select the required categories in the Select Log Categories dialog box. Full Logging is enabled for all categories. Log File Type the full pathname of the log file here. 4-6

33 To configure Baan OpenWorld Adapter Directory Service tab Use this tab to specify the type and location of the Directory Service used in your Baan OpenWorld environment. Type Select the File button if you use an XML file Directory Service implementation. If you select the File button, note the following limitations: If two or more people use the BusComponent Editor at the same time, data loss can occur. If data is modified while OpenWorld runs, the file can be blocked for readaccess when someone saves the data. Select LDAP if you use an LDAP-compliant directory server. Server URL If you use an LDAP directory server, enter the URL for that server here. The required syntax is: ldap://<ip_address or computer_name> 4-7

34 To configure Baan OpenWorld Adapter If you use an XML file Directory Service, enter the full pathname of the XML file here. For example: \\MyMachine\MyShare\OpenWorld\ldap.xml Server Root Enter the root element of your Directory Service here. This property is required for both LDAP and XML flat file Directory Services. The required syntax is: o=<serverroot> 4-8

35 5 To configure the Directory Service Baan OpenWorld uses a Directory Service to store information about servers and clients that use Baan OpenWorld Adapter. The Directory Service must include entries for all servers and named clients, and specify their name, address, message queues, ports and so on. The BusComponent Editor utility provides the functionality to enter and edit this information; it is available on MS Windows platforms only. This chapter describes how to use the BusComponent Editor utility. You can use the BusComponent Editor to add components to both an LDAP Directory Service and to an XML file Directory Service. Chapter 2, "To install and configure the Directory Service," describes how to install and configure IBM s SecureWay Directory LDAP-compatible Directory Service. Appendix C, "To configure Netscape Directory Server," describes the configuration of the Netscape Directory Server, which is an example of another LDAP-compliant directory server. The XML flat file solution is described in Appendix B, "XML file Directory Service." About the BusComponent Editor Each server and named client that uses Baan OpenWorld Adapter must have a component entry in the Baan OpenWorld Directory Service. In addition, each component has one or more connection points that link the Baan OpenWorld Adapter for that component to the actual transport layer. The BusComponent Editor provides facilities to: Access the Directory Service. Create, edit, and delete components and their associated properties. Create, edit, and delete connection points and their associated properties. Assign an activation mode to the component. Currently, for a BaanERP server component only ASM (Application Services Manager) is supported as activation mode. 5-1

36 To configure the Directory Service To start the BusComponent Editor To start the BusComponent Editor when it is installed in the default location, click: Start > Programs > Baan OpenWorld 2.2 > Adapter > BusComponent Editor BusComponent Editor dialog box If you start the BusComponent Editor, the following dialog box appears. 5-2

37 To configure the Directory Service To load the Directory Service information 1 The Directory Address and Directory Root fields are automatically filled with the values set for these properties in the local user-specific or generic bus.properties file. If these properties are not specified in the properties file, or if you want to access a different directory, you can enter the appropriate values directly in the fields, as follows: If you use an LDAP-compliant Directory Service, specify the URL of the directory server in the Directory Address field. If you use an XML file Directory Service, enter the full path name for the file in the field. The required syntaxes are: ldap://<ip_address or computer_name> or in the case of a file <file_name> Specify the root element of the Directory Service in the Directory Root field. This is required for both LDAP and XML Directory Services. The syntax is: o=<server_root> 2 Click Load to connect to the Directory Service, and to get a list of all the components that are registered in the Directory Service. A connection to the Directory Service is now established and a list of all components defined in the Directory Service appears. You cannot subsequently change the directory address or root. To add a new component To add a new component to the Directory Service, click New. A new entry is added to the component list at the left side of the dialog box. First you enter a name for the component. The syntax is as follows: cn=<component_name>, o=<directory_root> Specify a unique component name. Once you assigned a name to the component, the name cannot be changed anymore. Then you define the component properties, as explained in the following section. To edit a component To change the properties of an existing component, select it in the component list. This displays the current properties of the component. Now you are able to modify some or all of the component s properties. 5-3

38 To configure the Directory Service To delete a component To delete a component from the Directory Service, select it in the component list and click Delete. Component properties Once you selected a component, or added a new component, you can define or modify its properties. There are four kinds of properties, and each has a corresponding tab in the dialog box: General, Categories, Connection Points, and Activation. General The General tab in the dialog box looks as follows: Description, Owner, Administrator, Physical Location These are optional, information-only fields that you can use to specify a description, owner, administrator, and physical location for the component. These properties are not used by Baan OpenWorld Adapter. 5-4

39 To configure the Directory Service Company number If the component is a BaanERP component, you can specify a company number that will be used when this component interacts with BaanERP. The company number is not applicable for other components. Categories The Categories tab in the dialog box looks as follows: For components that represent BaanERP servers you must define a category named BaanERP. To add a category to the Categories list, click New and enter the name of the new category. To delete a category, select the category and click Delete. 5-5

40 To configure the Directory Service Connection points To define the connection point(s) of a component, click the Connection Points tab. The Connection Points tab in the dialog box looks as follows: To change the properties of an existing connection point, select it in the Connection Points list. Its properties are displayed, and can be modified. To delete a connection point, select it in the Connection Points list and click Delete. To add a connection point, click New. Specify the connection point s identifier and properties. The identifier must be unique for the connection point. The syntax is as follows: cn=<connection_point_name>, cn=<component_name>, o=<direcory_root> URI This field contains the Uniform Resource Identifier (URI) for the connection point. The syntax of the URI depends on the connection type. The syntax for a TCP/IP URI is: socket://<ip_address>:<port> 5-6

41 To configure the Directory Service The syntax for a MSMQ URI is: msmq://<queueserver>/<queuename> For more information on MSMQ, refer to Configuration Guide for MSMQ for Baan OpenWorld Adapter (U7308 US). The syntax for a MQSeries URI is: MQSeries://v1/#<"key1"="value1", "key2"="value2",... > Note that you can omit the double quotes. For details of MQSeries keywords and values, refer to Configuration Guide for MQSeries for Baan OpenWorld Adapter (U7307 US). Variable Policy This property is used in combination with activation mode ASM. If set, you do not need to specify a socket number in case of a socket connection. Preferred connection Select this option if this is your preferred connection. It will then be used as the default connection point. Other connection points will only be used if the preferred connection is not available. Activation 5-7

42 To configure the Directory Service A component s activation mode can be manual or automatic. To automatically start the component, select the Activation Service check box, and specify the type of the activation service and the reference for it. Type This specifies the type of the activation service. Currently (OpenWorld 2.2), only one type is supported: ASM (Application Services Manager). The BaanERP activation service is of type ASM. Reference The syntax for the activation service reference is specific for each type. For type ASM the syntax is as follows: <ASM service host>:<asm service port number>:<program path(bse)> Pooling policy This indicates what kind of pooling policy the client adapter uses when a Business Object Interface manager is initialized with a BusComponent with Activation information. In OpenWorld 2.2, the following policies are implemented. shared policy This policy creates a connection the first time a manager is initialized for a specific backend, and each other manager that is in the same UserSession and is initialized with the same backend reuses this connection. When the last manager is closed, the connection/backend is stopped. limitedshared policy This policy is similar to the shared policy with the addition that it has a limit on the managers that use one connection/backend. If this limit is exceeded, a new connection/backend is created. If a manager is closed, it frees up an spot on the connection, so the next time a manager is initialized, this spot is used. Server timeout This is a setting for the ASM Server that indicates the number of minutes after which the server stops. This counter starts after the last OpenWorld call to this server. Therefore, if the server is not used for this period of time, the server (and bshell) stops. This is to prevent servers from hanging when the OpenWorld client is not programmed, or stopped correctly. The default timeout is 720 minutes. Specifying 0 as timeout disables the timeout, and the server will not stop on its own accord. 5-8

43 Appendix A To manually edit bus.properties The run-time settings of Baan OpenWorld Adapter are defined in a properties file that is stored on the computer on which Baan OpenWorld Adapter runs. Typically, users on Windows platforms edit the bus.properties file by using the Adapter Configuration tool, as described in Chapter 4, To configure Baan OpenWorld Adapter. However, since the file is an ASCII file, you can use an ASCII editor to manually edit the file. This appendix describes the available properties, their default values, valid values, and the full syntax for the properties file. For an overview of the bus.properties file and details of its location on MS Windows and UNIX systems, see Chapter 4, To configure Baan OpenWorld Adapter. Sample properties file The following is an example of a bus.properties file: [General settings] bus.bdf.iterator.size=10 bus.bdf.manager.timeout=10000 bus.default.backend= user.name= bus.component= [Directory settings] bus.services.directory.directory=com.eibus.services.directory.ldap.ldapdirectory bus.services.directory.serverurl=ldap://server.baan.com bus.services.directory.root=o=baan.com [Log settings] bus.log.file=c:\\buslog.xml bus.log.mask=0x1801e [Advanced settings] bus.default.protocol=socket bus.connection.max.readers= org.xml.sax.parser=com.jclark.xml.sax.driver bus.num.xml.parse.threads=1 bus.services.guid.guidfactory=com.eibus.services.guid.win32.comguidfactory To manually edit bus.properties - Page 1

44 To manually edit bus.properties NOTE NOTE A line that starts with a semi-colon character (;) is treated as a comment line. If you enter backslashes ( \ ) in a property value, make sure that you enter them twice, since Java uses the back-slash as an escape character. If, for example, you want c:\temp\buslog.txt to be your log file, enter c:\\temp\\buslog.txt. Properties This section describes the most commonly used properties in the bus.properties file. General settings bus.bdf.iterator.size The default number of records that are received in one fetch. This allows you to limit the amount of data that is transferred to the client in each message. You can override this default value in your application code. The amount of data delivered does not only depend on the number of records delivered, but also on the number of fields in a record, and the number of associated tables. For smaller records, you can increase the number of records retrieved for each fetch. For larger records, you can decrease the number of records retrieved. Use value 0 to set no limit. All records are returned in one message. Default value: 250 bus.bdf.manager.timeout The default time (in milliseconds) that Baan OpenWorld Adapter waits for a reply when performing a request to a server. You can override this timeout period in your application code. Use value 0 to disable the timeout. The application waits infinitely for a reply. Default value: 60,000 bus.default.backend The backend that your programmed manager connects to by default. You can override this default setting in your application code with the manager.initialize method. Default value: not applicable. user.name This property is currently not used. Page 2 - To manually edit bus.properties

45 To manually edit bus.properties bus.component The name of the local Baan OpenWorld component, as registered in the Directory Service. You do not need to specify this parameter for anonymous clients that use a socket transport service. For all servers and named clients, and for anonymous clients that use MQSeries as their transport service, set this as the relevant component name. Default value: Fully qualified machine name. Directory settings bus.services.directory.directory Contains the name of the directory server class. This can be either: com.eibus.services.directory.file.filedirectory or com.eibus.services.directory.ldap.ldapdirectory Default value: not applicable. bus.services.directory.serverurl The name of the directory server to use. If you use an LDAP-compliant Directory Service, specify the URL of the directory server. If you use an XML file Directory Service, specify the full path name for the file. The required syntax is: ldap://<ip_address or computer_name> <file_name> Default value: not applicable. bus.services.directory.root The name of the domain in the directory server to use; that is, the root element of the Directory Service. This property is required for both LDAP and XML flat file Directory Services. The syntax is: o=<server_root> Default value: not applicable. Log settings bus.log.file Can contain the path name to a specific log file. If null, then messages are logged to System.out. Default value: not applicable. To manually edit bus.properties - Page 3

46 To manually edit bus.properties bus.log.mask Bit pattern to activate logging for specific categories of activity. Default value: 0 (no logging) Advanced settings bus.default.protocol This can be MQSeries, msmq, or socket. bus.services.guid.guidfactory This property can be set to one of two fixed values, depending on the operating system. For MS Windows: com.eibus.services.guid.win32.comguidfactory For UNIX: com.eibus.services.guid.standard.nearenoughguidfactory Page 4 - To manually edit bus.properties

47 Appendix B XML file Directory Service As an alternative to an LDAP-compliant directory server, you can use an XML flat file to implement your Directory Service. This appendix describes how to set up an XML file and provides an example of an XML file Directory Service. When you use the XML file directory, you can put it in a share and map this share to a local drive on your machine. In this way you can use one file for different client or server machines. To set up an XML file Directory Service To set up an XML file Directory Service you must create a new XML file, add the required skeleton, and then use the BusComponent Editor to add components. Follow the steps outlined here: 1 Create an XML file with the following tags: <?xml version="1.0"?> <DirectoryService /> 2 Start the BusComponent Editor. 3 Specify the full pathname of the XML file in the Directory Address field. 4 Add the required components and connection points as described in Chapter 5, "To configure the Directory Service." The XML file is populated with the specified information. XML file Directory Service - Page 1

48 XML file Directory Service Example XML file Directory Service <DirectoryService> <BusComponent> <id>john</id> <owner>john</owner> <description/> <location>computerfullyqualifieddomainaddress</location> <locationid>john</locationid> <connectiontype> <id>1</id> <transactional>false</transactional> <implementation> com.eibus.connection.sockets.connection</implementation> <uri>socket://fullyqualifieddomainname:port/</uri> <preferredconnection>true</preferredconnection> </connectiontype> <connectiontype> <id>2</id> <transactional>false</transactional> <implementation> com.eibus.connection.msmq.connection</implementation> <uri>msmq://msmqservername/john</uri> <preferredconnection>false</preferredconnection> </connectiontype> </BusComponent> </DirectoryService> Page 2 - XML file Directory Service

49 Appendix C To configure Netscape Directory Server Baan OpenWorld Adapter requires a Directory Service in which the properties of Baan OpenWorld components are defined. For directory access, Baan OpenWorld Adapter adheres to the Lightweight Directory Access Protocol (LDAP). So customers can choose any LDAP-compliant directory server to provide the Directory Service. Alternatively, they can use an XML flat file implementation. Chapter 2, "To install and configure the Directory Service," describes how to install and configure IBM's SecureWay Directory server. This chapter describes the configuration of the Netscape Directory Server 4.0, as an example of another LDAP-compliant directory server. Configuration procedure After you install the Netscape Directory Server 4.0, take the following steps. 1 Open the Network Console 4.0 and enter you password. The following dialog box appears. 2 To open the Directory Server, select Directory Server in the left panel and click Open in the right panel. To configure Netscape Directory Server - Page 1

50 To configure Netscape Directory Server 3 Select the Configuration tab and from the Database menu, double-click Schema. The following dialog box appears. Page 2 - To configure Netscape Directory Server

51 To configure Netscape Directory Server 4 Select the Attributes tab and create the following attributes. Name OID Type Single / Multi-valued b3admin b3admin-oid Distinguished name Single b3category b3category-oid Case ignore string Multi b3location b3location-oid Distinguished name Single b3locationdesc b3locationdesc-oid Case ignore string Single b3transactional b3transactional-oid Case ignore string Single b3implementationclass b3implementationclass-oid Case exact string Single b3online b3online-oid Case ignore string Single CompanyNumber companynumber-oid Integer Single PreferredConnection PreferredConnection-oid Case ignore string Single Eibconnectionpolicy eibconnectionpolicy-oid Case ignore string Single b3activationreference b3activationreference-oid Case exact string Single b3activationtype b3activationtype-oid Case ignore string Single b3activationpoolpolicy b3activationpoolpolicy-oid Case ignore string Single b3activationservertimeout b3activationservertimeout-oid Integer Single 5 Select the Object Classes tab in the right panel. Define the object class b3component as shown in the following screenshot. To configure Netscape Directory Server - Page 3

52 To configure Netscape Directory Server 6 Define the object class bconnectiontype as shown in the following screenshot. 7 Define the object class b3activation as follows: Parent is: top. OID is: b3activation-oid. Required attributes: b3activationtype and b3activationreference. Allowed attributes: b3activationpoolpolicy and b3activationservertimeout. 8 Baan.com must be created as an organizational unit in the directory server. To do so, select the Directory tab in the left panel. From the menu bar double-click Object New Organizational Unit. Enter the required information as shown in the following dialog box. Page 4 - To configure Netscape Directory Server

53 To configure Netscape Directory Server 9 To set the correct permissions for baan.com click the baan.com entry. From the Object menu, double-click Set Access Permissions. The following dialog box appears: 10 Click New and define the access permissions as shown in the following screenshot. Now the Netscape Directory Service has been set up for Baan OpenWorld. You must continue with the next section to set up Baan OpenWorld Adapter for use with the Directory service. To configure Netscape Directory Server - Page 5

54 To configure Netscape Directory Server Entries in the bus.properties file Every computer that runs the Baan OpenWorld Adapter has a bus.properties file that holds information about the Baan OpenWorld environment it runs in. The following entries relate to the LDAP Directory Service that is used: bus.services.directory.root=<o=root directory> bus.services.directory.serverurl= <ldap:name of directory server> For example: bus.services.directory.root=o=baan.com bus.services.directory.serverurl=ldap://computera.baan.com You can edit this file directly, but preferably use the Adapter Configuration tool (see Chapter 5, "To configure Baan OpenWorld Adapter"). If you do edit the file directly, please note that every \ character in the path should be replaced with \\. For example, if the LDAP server name is \\Jupiter, you must type \\\\Jupiter. Page 6 - To configure Netscape Directory Server