Baan OpenWorld Broker 2.1. Installation Guide for Baan OpenWorld Broker 2.1

Transcription

1 Baan OpenWorld Broker 2.1 Installation Guide for Baan OpenWorld Broker 2.1

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: U7545A US Group: User Documentation Edition: A Date: June, 2001

3 Table of contents 1 Introduction Required hardware and software To install and configure Broker 3-1 To prepare for installation 3-1 To install Broker 3-2 To configure Broker 3-3 To start the Broker service To install and configure Designer 4-1 To prepare for installation 4-1 To install Designer 4-1 To configure Designer 4-2 To configure a user object 4-3 To define ODBC data sources 4-5 To configure the database connectors To uninstall 5-1 To uninstall Broker 5-1 To uninstall Designer Upgrade notes 6-1 Appendix A Command-line parameters 1 i

4 Table of contents ii

5 About this document This guide describes how to install and configure Baan OpenWorld Broker. The guide contains the installation procedures for the server as well as the client (Designer). This installation guide also includes instructions on how to uninstall Broker. This guide is intended for whoever installs Broker and for system administrators. iii

6 About this document iv

7 1 Introduction Baan OpenWorld Broker is a run-time integration platform and a design time integration toolkit. Baan OpenWorld Broker is Baan s integration solution for integrating BaanERP with other Baan solutions, such as BaanFrontOffice. The integration between BaanERP and BaanFrontOffice is built with Broker. This installation guide does not provide information on how to install the BaanERP BaanFrontOffice integration solution (see the BaanConnector 5 Implementer Guide, part number , which is available with the software installation, or can be ordered from Invensys CRM). The initial installation procedure of Broker consists of the following main steps: 1 Install and configure Broker. 2 Install and configure Designer. 3 Define the ODBC data sources. 4 Configure Designer s standard database connectors. After you take these steps, you can work with Broker. To install the client on additional workstations, take the following steps: 1 Install and configure Designer on the additional workstations. 2 Define the ODBC data sources on these workstations. 1-1

8 Introduction 1-2

9 2 Required hardware and software To install Baan OpenWorld Broker, you need the following hardware and software: Hardware platform Intel 486/Pentium. Operating system for Broker NT 4.0, Service Pack 4 or later, Windows 2000 (all versions). Operating system for Designer NT 4.0, Service Pack 4 or later, Windows 2000 (all versions), Windows 98, Windows 95, Service Pack 1 or later. Web browser Internet Explorer 5.0 or later. To store the logging tables, code mapping table, and workflow logging tables, you must have an ODBC-compliant database system, such as Microsoft SQL Server. 2-1

10 Required hardware and software 2-2

11 3 To install and configure Broker This chapter describes how: To prepare for installation. To install Broker. To configure Broker. To start the Broker service. To prepare for installation Before you start to install Broker, you must make sure you have administrator rights. If you do not have administrator rights, the installation will fail. The installation program requires administrator rights to add the Baan OpenWorld Broker service to the list of running services. Install Internet Explorer (version 5.00 or later), and configure it with access to the Internet. Baan OpenWorld Broker uses various components that are installed with Internet Explorer 5.0. To use Baan OpenWorld Broker to its fullest extent, you must have an ODBC driver and a System Data Source Name configured with the details of your database. Baan OpenWorld Broker offers ODBC connectivity to the end user as well as the designer of integration solutions, but more importantly, ODBC databases are used to store run-time information as well as activity and error logging. The ODBC data source must be a system data source, as only system data sources are accessible by a Windows NT service (such as the Baan OpenWorld Broker service). Baan OpenWorld Broker uses these ODBC connections to perform all logging in the system, such as details of the integration process, code map service, workflow execution, periodic process execution, and so forth. Some of the underlying systems will fail if ODBC connections are not set up. This applies, for example, to the workflow engine and the integration subsystem. 3-1

12 To install and configure Broker Create a new database in your database of choice. In the following configuration sections, use this database from ODBC. Baan OpenWorld Broker does extensive logging through ODBC, so you must have a separate database to simplify maintenance of Baan OpenWorld Broker specific tables in the database. If you want to install a newer version on a Windows 2000 operating system, you must first uninstall the old version (refer to Chapter 5, To uninstall ) and restart the computer. To install Broker You can install Broker on the same machine as Designer, or on a separate machine. In a production environment, you must install Broker on a dedicated (or semidedicated) machine. To install Broker, take the following steps: 1 Log on as a user with administrator rights. You must have administrator rights to install any Windows NT service (such as Baan OpenWorld Broker). 2 To install a newer version, first stop the Baan OpenWorld Broker service. Before you install a new service, you must first stop any running Baan OpenWorld Broker service on your computer. You can start and stop services in Services in the Control Panel. 3 Run setup.exe from <cd drive>setup\broker\setup.exe. Setup will not run uninstall during the installation process, even if older versions of Broker exist. To run uninstall, follow the instructions in Chapter 5, To uninstall. 4 Follow the on-screen instructions. You can safely accept all defaults. This installs Baan OpenWorld Broker with the default options, such as installing it in c:\program Files\Baan\Baan OpenWorld Broker, using the bis.cor repository file in that folder, and using port 7250 to listen to incoming connections. After you installed Broker, you must configure Broker, as described in the following section. 3-2

13 To install and configure Broker To configure Broker Configuration of the server includes: Select which object repository file to use. Set the port number the server uses to listen to incoming connection requests. Setting machine (or IP address) based access, such as granting only specific machines, or groups of machines, access. Set internet options, such as proxy server, subnet mask and SMTP server. If you must install more than one Broker service on the same machine, just follow the previous steps as often as you like, but note that you must enter a different Service Display Name, Service Name, and Port Number for each service. To configure Broker, take the following steps: 1 To run the Baan OpenWorld Broker configure utility, on the Start menu, point to Programs, click Baan OpenWorld, and click Broker. The configure utility is a Microsoft Management Console (MMC) snap-in. 2 Open the folders in the Console Root window, right-click the Broker icon, and select Properties. Alternatively, you can browse to your machine in the tree on the left-hand side, select the Broker icon, and click the button on the toolbar. 3 Enter the port number you want to use for the Baan OpenWorld Broker in the Server port number field. Baan OpenWorld Broker defaults to This is the port Baan OpenWorld Broker uses to listen to incoming client connections. If you change this value, you must also change the configuration on each client machine. 4 On the Access tab, select Grant access to all computers except those specified below. If you want to grant access to only a certain number of computers on your network, you can do that either by inclusion (select Deny access to all computers except those specified below, and add the computers you wish to grant access) or exclusion (select Grant access to all computers except those specified below, and add the computers you wish to deny access). 3-3

14 To install and configure Broker 5 On the Internet tab, specify your proxy server if your Internet setup requires one. This depends on your Internet setup. You must possibly check this with your system administrator. 6 Ensure that the setting of the Subnet mask field is correct for your network environment. If you open a Command prompt (on the Start menu, click Run, enter cmd) and type ipconfig, you will see the subnet mask for your network listed. On Windows 9x computers, the command is winipcfg. 7 In the User details panel, specify the IP address of the SMTP server and e- mail account of the system administrator. You can use any legal address. Only do this if you use the SMTP features of Baan OpenWorld Broker. 8 On the Logging tab, make sure that all logging is turned on. The Logging tab is used to turn on/off error and activity logging. If you install and configure Baan OpenWorld Broker, you must make sure that logging is always turned on, or you will miss important failure messages. Note that you must configure all of the following actions correctly to make logging successful: ODBC System Data Source Name. Make sure that you created (click ODBC in Control Panel) a system data source that points to a correctly configured database for storing log tables. The Logging tab. Logging in general can be enabled or disabled for specific parts of the system. Each object in the object repository has a logging option. By default, logging is turned off. To modify the logging options, refer to the Developers Guide for Broker (U7543A US). 3-4

15 To install and configure Broker 9 The Log Viewer uses the Borland Database Engine (BDE) to query the logging database. Please provide the following configuration parameters: Driver: Informs the BDE which vendor-specific driver is to be used to connect to the data source. Accepted values are: MSSQL, ORACLE, DB2, INFORMIX. If the driver you specified does not match one of the BDE accepted values, the BDE will display the following message: The driver you specified could not be loaded. Please check your settings. Verify that the Driver field contains an accepted drive name. The vendor's client software must also be installed and correctly configured on the machine in order for the specified driver to be used. If the client software cannot be loaded by the BDE, the BDE will display the following message: Vendor initialization failed. Server: The name of the server or listener service (Oracle) to which the Log Viewer must connect. If the Log Viewer attempts to connect to the given server until the BDE timeout is reached, the vendor-specific error message will appear. Database: The name of the database on the specified server. The BDE will attempt to use the default database if this field is omited, but it is recommended to explicitly specify the name. If the BDE cannot resolve the database name, a vendor-specific error will appear. This field must not be used for ORACLE databases, since the Oracle listener must be configured to use a specific database SID. User ID / password: The user name and password of a user with authorization to view tables on the database. To use a trusted connection (NT authentication), the user name and password fields must be left empty. The default user name value which the BDE uses for the appropriate native driver must also be removed. To do this, open the BDE Administrator applet in the Control Panel on the client computer. Click the Configuration tab, and expand the Drivers and Native nodes. Select the appropriate driver name, for example MSSQL, and remove any text from the User Name field (do not leave any spaces). On the Object menu, click Apply to apply the changes. The trusted connection will now be used if a user name is not provided. 10 Click OK. 11 In the Control Panel, click on the Services icon, and start the Baan OpenWorld Broker service. If the service is already running, restart it. You must restart the service for any new settings to take effect. 3-5

16 To install and configure Broker NOTE To start the Broker service To start the Broker service: 1 On the Windows task bar, click Start, point to Settings, and click Control Panel. 2 In Control Panel, double-click Services. 3 Click the Baan OpenWorld Broker. 4 Click Start. If the Broker service is already running, you must stop the service first, and then restart Broker. 3-6

17 4 To install and configure Designer This chapter describes how: To prepare for installation. To install Designer. To configure Designer. To prepare for installation Install Internet Explorer (version 5.00 or later), and configure it with access to the Internet. Baan OpenWorld Designer uses various components that are installed with Internet Explorer 5.0. To use Baan OpenWorld Designer to its fullest extent, you must have an ODBC driver and a System Data Source Name configured with the details of your database. To install Designer To install Designer, take the following steps: 1 Run setup.exe from <cd drive>setup\designer\setup.exe. Setup will not run uninstall during the installation process, even if older versions of Designer exist. To run uninstall, follow the instructions in Chapter 5, To uninstall. 2 Follow the on-screen instructions. You can safely accept all defaults. This installs Baan OpenWorld Designer with the default options, such as installing it in C:\Program Files\Baan\Baan OpenWorld Designer. When you installed Designer, you must configure it (refer to the configuration information). The minimum configuration involves selecting the machine that runs the Baan OpenWorld Broker service. 4-1

18 To install and configure Designer NOTE NOTE NOTE To configure Designer To configure Designer: 1 In Baan OpenWorld/Studio/Designer, select and open Designer Configure. 2 In Microsoft Management Console (MMC), open the folders in the Console Root window. 3 Right-click Designer. In the drop-down menu that appears, click Properties. 4 On the Basics tab, enter the local IP address or DNS name and server port number of the machine on which the server for the Broker runs. 5 On the Basics tab, select the Enable Trusted Logon check box. 6 The Log Viewer uses the Borland Database Engine (BDE) to query the logging database. Provide the following configuration parameters: Driver: Informs the BDE which vendor-specific driver is to be used to connect to the data source. Accepted values are: MSSQL, ORACLE, DB2, INFORMIX. If the driver you specified does not match one of the BDE-accepted values, the BDE reports The driver you specified could not be loaded. Please check your settings. Verify that the Driver field contains an accepted drive name. The vendor s client software must also be installed and correctly configured on the machine to use the specified driver. If the client software cannot be loaded by the BDE, the BDE reports Vendor initialization failed. Server: The name of the server or listener service (Oracle) to which the Log Viewer must connect. If the Log Viewer attempts to connect to the given server until the BDE timeout is reached, the vendor-specific error message appears. Database: The name of the database on the specified server. The BDE attempts to use the default database if this field is omitted, but you are recommended to explicitly specify the name. If the BDE cannot resolve the database name, a vendor-specific error appears. This field must not be used for ORACLE databases, as the Oracle listener must be configured to use a specific database SID. User ID / password: The user name and password of a user with rights to view tables on the database. 4-2

19 To install and configure Designer NOTE To use a trusted connection (NT authentication), the user name and password fields must be left empty. The default user name value which the BDE uses for the appropriate native driver must also be removed. To do this, open the BDE Administrator applet in the Control Panel on the client computer. On the Configuration tab, expand the Drivers and Native nodes. Select the appropriate driver name, for example MSSQL, and remove any text from the User Name field. Make sure you do not leave any spaces. To apply the changes, on the Object menu, click Apply. The trusted connection is now used if a user name is not provided. 7 On the Internet tab, specify your proxy server if your Internet setup requires one. 8 On the Internet tab, in the User Details section, specify the IP address of the SMTP server and account of the system administrator. You can use any legal address. Click OK. Now, you can start Designer for the first time. To configure a user object If you log on to Designer for the first time, your Windows user name most likely does not exist as a user in the Designer s repository (\users\ folder). In that case, Designer automatically creates a user for you. Automatically-created users do not have the Superuser status. To change your status to Superuser, you must log on as another user that already has the Superuser status. Designer contains a standard user object SUPERUSER, which you can use for this purpose. To start the Designer for the first time: 1 Start the Baan OpenWorld Designer. Designer automatically creates a user object with your user name. A dialog box appears in which you can edit the properties of your user object. 2 Enter your name and password. The password must be the same as your Windows NT password. 3 Click OK. 4 On the File menu, click Exit to quit Designer. 4-3

20 To install and configure Designer To change your status to Superuser: 1 Start the Baan OpenWorld Designer Configure program. 2 In Microsoft Management Console (MMC), open the folders in the Console Root window. 3 Right-click the Designer icon. 4 In the drop-down menu, click Properties. 5 On the Basics tab, clear the Enable Trusted Logon check box. 6 Click OK. Now you can log on with any user name you specify: 1 Start the Baan OpenWorld Designer. 2 Enter user name Superuser and password Superuser. 3 On the File menu, click Repository Browser. 4 Use the All folders list to open the \users folder. 5 Double-click the user object with your user name. 6 Select the Superuser check box. 7 Click OK. Take the following steps to switch back to the trusted log on procedure: 1 Return to the Microsoft Management Console window. 2 Right-click the Designer icon. 3 In the drop-down menu, click Properties. 4 On the Basics tab, select the Enable Trusted Logon check box. 5 Click OK. 4-4

21 To install and configure Designer NOTE To define ODBC data sources If you have not yet defined ODBC data sources on the server, you must do this now. The Broker uses ODBC-compliant databases for the following subsystems: The logging system (to log errors and other events). The component integration subsystem s code mapping service. The workflow system. You must at least define an ODBC data source for the logging system. If you use the component integration subsystem or the workflow system, or both, you must define the corresponding ODBC data sources as well. If the database connectors for logging were deleted, the logging system uses text files instead. The logging system creates the text files on the server s working directory. You must define these ODBC data sources on the server. If you want to use the log event viewer on a particular client, you must use the following procedure: 1 Ensure that the database management system that the server uses for logging is also available on your client workstation. 2 Ensure that the logging file is located on a file server that is accessible by the client. 3 Define an ODBC data source on the client, and take care of the following: The ODBC data source on the client must have the same name as the ODBC data source on the server. The ODBC data source on the client must point to the same database file as the ODBC data source on the server. You can define ODBC data sources in the ODBC Data Source Administrator. You must create the data source and a database file, but you do not have to set up the database tables. The Broker s database connector creates the database tables when it connects to the database for the first time. To start the ODBC Data Source Administrator: 1 On the Windows task bar, click Start, point to Settings, and click Control Panel. 2 In the Control Panel, double-click ODBC. 3 For instructions on how to use the ODBC Data Source Administrator, click Help. 4-5

22 To install and configure Designer To configure the database connectors By default, the Broker s object repository includes three database-connector objects. The names and full paths of the objects are: \sys\databases\workflow (workflow history logging). \sys\databases\cis (Component Integration Subsystem (cis) that is, the CodeMap as well as the component instance information). \sys\databases\relations (store object relations). You must configure these database connectors to assure proper functioning of the ODBC access. You do not need to repeat the configuration for each client. The server and the clients all use the same database connectors to access the data. A default database connector, called default, can be created to take over the responsibility of the previously-mentioned database connectors. These database connectors (for example, workflow, cis, relations) have precedence over the default database connector. Before you can configure the database connectors, you must take the following steps: 1 Get access to the Broker server. 2 Install Designer. 3 Define ODBC data sources on the server, and optionally on the client computers, as described in the To define ODBC data sources section. 4 For information on the required connection options for your database system, consult the documentation of your database system and BaanOpenWorld Broker Developer's Guide (U7543A US). 4-6

23 5 To uninstall To uninstall Broker If you want to uninstall Broker, you must first stop the Broker service. To stop the Broker service: 1 On the Start menu, point to Settings, and click Control Panel. 2 In Control Panel, double-click Services. 3 Click Baan OpenWorld Broker. 4 Click Stop. To uninstall the server: 1 On the Start menu, point to Settings, and click Control Panel. 2 In Control Panel, double-click Add/Remove Programs. 3 Select Baan OpenWorld Broker. 4 Click Add/Remove. To uninstall Designer To uninstall the client: 1 On the Start menu, point to Settings, and click Control Panel. 2 In Control Panel, double-click Add/Remove Programs. 3 Select Baan OpenWorld Designer. 4 Click Add/Remove. 5-1

24 To uninstall 5-2

25 6 Upgrade notes You must take the following steps to upgrade from older versions of Broker (for example, BaanEAI Integration Server). This only applies if you do not replace the Broker s Repository. In the Repository Browser, take the following steps: 1 Move the WfData object from the \apps\odbc folder to the \sys\databases folder, and rename it workflow, that is, \apps\odbc\wfdata becomes \sys\databases\workflow. 2 Move the CodeMapData object from the \sys\codes folder to the \sys\databases folder and rename it cis, that is, \sys\codes\codemapdata becomes \sys\databases\cis. 3 Use the Tool Dock to run Archive.reparse to recompile all scripts. 6-1

26 Upgrade notes 6-2

27 Appendix A Command-line parameters You can run Broker from the Run option of the Start menu on the Windows desktop. You can add parameters to the command line to change the behavior of Broker. The available command-line parameters are listed in the following table. Command-line parameters Parameter Effect /i <ServiceName>;<DisplayName> Installs a new service with the given <ServiceName> and <DisplayName>. /u <ServiceName> Uninstalls an installed service. /n <RepositoryName> Creates a new repository file. /? Displays a list of valid parameters. Command-line parameters - Page 1

28 Command-line parameters Page 2 - Command-line parameters