Installation and Configuration Guide

Transcription

1 IBM Initiate Provider Direct Installation and Configuration Guide Version9Release7 GI

2

3 IBM Initiate Provider Direct Installation and Configuration Guide Version9Release7 GI

4 Note Before using this information and the product that it supports, read the information in Notices and trademarks on page 13. Copyright IBM Corporation US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents Tables v Introduction vii Prerequisites vii Hardware and platform requirements..... vii Chapter 1. Running the IBM Initiate Provider Direct install Installing with Apache Tomcat Installing with IBM WebSphere Application Server. 2 Installing with Oracle WebLogic Server Required properties in the provider.properties file.. 7 Configuration conventions Legal Statement Notices and trademarks Index Contacting IBM Chapter 2. Provider Direct configuration 7 Copyright IBM Corp iii

6 iv Installation and Configuration Guide: Installation and Configuration Guide

7 Tables 1. required engine login properties required context factory properties required data source properties required engine interaction properties Enumerated data types Custom attributes IBM resources Providing feedback to IBM Copyright IBM Corp v

8 vi Installation and Configuration Guide: Installation and Configuration Guide

9 Introduction IBM Initiate Provider Direct simplifies the task of provider data management by giving the user direct access to crucial provider information such as contact information, credentials, and information changes. This guide provides an overview of the intended audience and contents of the manual and walks you through the installation of the IBM Initiate Provider Direct. This guide provides: v installation instructions when using Apache Tomcat, IBM WebSphere, and Oracle WebLogic Server v configuration instructions Prerequisites Be sure all of the required prerequisites are complete before installing IBM Initiate Provider Direct. To ensure a successful installation, use the following list to be sure that all prerequisites have been completed. v v v v v Install and configure the Master Data Engine. See the IBM Initiate Master Data Service Engine Installation Guidefor more information. Be sure to have a compatible database server (DB2, MSSQL, Oracle) installed. IBM WebSphere, Oracle WebLogic, or Apache Tomcat installed. Be sure a compatible JVM is installed. Familiarity with IBM Initiate Workbench for deploying engine hub configuration. Hardware and platform requirements See the IBM Initiate Master Data Service System Requirements sheet for certified OS, database, and hardware requirements for the IBM Initiate Master Data Service software and IBM Initiate Provider Direct application. Copyright IBM Corp vii

10 viii Installation and Configuration Guide: Installation and Configuration Guide

11 Chapter 1. Running the IBM Initiate Provider Direct install Before you begin This procedure assumes that you have a Java JRE and a Master Data Engine installed. If you do not have an engine installed, see the IBM Initiate Master Data Service Engine Installation Guide. About this task Run the installer to install the IBM Initiate Provider Direct files on your server. Procedure 1. Start the installer. The installer can be started in the following ways: v On Windows only, you can double-click the IBM_Initiate_ProviderDirect_xxxx.jar file (this assumes that Java is set as the default program to run when working with *.jar files). v Start the installer from a command line using this format: java -jar IBM_Initiate_ProviderDirect_xxxx.jar v Start the installer from a command line in console mode, using this format: java -jar IBM_Initiate_ProviderDirect_xxxx.jar -i console 2. Follow the installer prompts to extract the Initiate Provider Direct files to an installation directory. The default installation path is C:\Program Files\IBM\Initiate\ProviderDirect9.x.x 3. Create custom table and index by running madconfig -f C:\ProviderDirect\ config.xml install. Type the instance name you created when prompted. Note: Be sure to run the madconfig in the directory that the engine instance was installed to. For Windows users, run madconfig.bat. For UNIX users, run madconfig.sh. 4. Deploy the hub configuration via IBM Initiate Workbench. The Provider Direct engine configuration is located in the /hubconfiguration/provider directory of your IBM Initiate Provider Direct installation. A Workbench.project file is included that you can import as an existing project. For detailed hub configuration deployment steps, refer to the IBM Initiate Workbench User's Guide. 5. Restart the engine. Installing with Apache Tomcat Before you begin This procedure assumes that you have extracted the provider.properties file and edited it as needed. About this task For these instructions, the following variables must be replaced with values specific to your configuration: v <<TOMCAT_HOST>> - The machine name on which Tomcat is running. You can also use "localhost" if you are on the same computer. Copyright IBM Corp

12 v <<TOMCAT_PORT>> - The port number that Tomcat is using; typically v <<TOMCAT_HOME>> -The directory where Tomcat is installed, sometimes referred to as CATALINA_HOME. (For example, C:\Program Files\Apache Software Foundation\Tomcat). Note: Be sure your catalina.properties file contains the following line: shared.loader=${catalina.base}/shared/classes,${catalina.base}/shared/lib/ *.jar Procedure 1. Copy the edited provider.properties file to <<TOMCAT_HOME\shared\ classes. Note: If the <<TOMCAT_HOME>>\shared\classes directory does not currently exist, you must create it. 2. Make sure the Master Data Engine and Tomcat are running. 3. In a web browser, go to (The default is You will see "The Apache Jakarta Project" page with an Administration menu box listing links for Tomcat Administration and Tomcat Manager. Note: If you have not previously set up Tomcat with a manager role and a user with that role, you must edit the<<tomcat_home>>\conf\tomcat-users.xml file to add the "manager" role and a user for that role. Then restart Tomcat. 4. Click the link for the "Tomcat Manager" and log in with the user name and password of a Tomcat manager account. 5. In the Deploy section, under the WAR file to deploy subsection, click the Browse button. 6. In the Choose file dialog box, browse to the providerdirect.war file in the installation directory, and then click the Open button. 7. In the Tomcat Manager, click the Deploy button. 8. When the page refreshes, a new row in the Applications section displays, with Initiate Provider Direct xxx as its Display Name and /providerdirect as its Path. 9. If the value in the Running column is false, click the Start link to start the application. 10. In a browser window on any networked computer, type <<TOMCAT_HOST>>:<<TOMCAT_PORT>>/ProviderDirect to open the login page. Installing with IBM WebSphere Application Server Follow these instructions to install IBM Initiate Provider Directon IBM WebSphere. Before you begin This procedure assumes that you have extracted the provider.properties file from the providerdirect.war file, and edited them as needed. About this task In these instructions, the following variables must be replaced with values specific to your configuration: 2 Installation and Configuration Guide: Installation and Configuration Guide

13 <<WAS_HOST>> - The machine name on which the WebSphere Application Server is running. You can also use "localhost" if you are on the same computer. <<WAS_PORT>> - The port number that the WebSphere Application Server is using; typically Note: WebSphere typically uses different port numbers for the Integrated Solutions Console and for installed applications is the typical default port for the Integrated Solutions Console, and 9080 is the typical default port for installed applications. Procedure 1. Copy the edited provider.properties file to the <<WAS_HOME>>/AppServer/ properties directory. 2. Make sure the Master Data Engine and the WebSphere Application Server are running. 3. In a browser, type 4. Enter an administration name and password to log on to the WebSphere Integrated Solutions Console. 5. Select Applications - Applications Types - WebSphere enterprise applications link from this page. 6. Click the Install button. 7. Select the Local file system radio button. Use the Browse button to specify the path to the providerdirect.war file. 8. Enter providerdirect into the Context root field. Note: Depending on the version of WebSphere you are using, you might be prompted for the Context Root field later in the process. Be sure to enter the Context Root field when prompted. 9. Make sure the Prompt me only when additional information is required radio button is selected. 10. Click the Next button, and follow these steps: a. On the Step 1: Select installation options screen, click Next. b. On the Step 2: Map modules to servers screen, select the Initiate ProviderDirect xxx module, and then click the Next button. c. On the Step 3: Map virtual hosts for Web Modules step, select the Initiate ProviderDirect xxx module, and then click the Next button. d. On the Step 4: Summary step, click the Finish button. 11. Click the Save link to save directly to the master configuration. Note: To ensure the installation is a success, the class loader properties must be edited. Follow steps to edit the properties. 12. Click the providerdirect_war link to edit the class loader properties. 13. Click Manage Modules, and then select the Provider Manager module. 14. Under General Properties, look for "Class loader order". Change it to "Classes loaded with local class loader first (parent last). 15. Click OK, and then click Save. 16. In the Administrative console, click Servers > Server Types > WebSphere application servers. 17. Select the server where the application is deployed. Chapter 1. Running the IBM Initiate Provider Direct install 3

14 18. Under Container Settings on the right-hand side, click Web Container Settings then click Web container. 19. Under Additional Properties on the right-hand side, select Custom Properties. 20. On the Custom properties page, create a new property called com.ibm.ws.webcontainer.invokefilterscompatibility. Set this value to true and give it a description. Make it something you will easily recognize. 21. Click OK, and then click Save. 22. Restart the server. 23. Select the providerdirect_war web application and click the Start button to start the application. 24. In a browser window on any networked computer, type <<WAS_HOST>>:<<WAS_PORT>>/ProviderDirect to open the login page. Note: The typical default port for installed applications on WebSphere is This is different from the default port for the Integrated Solutions Console, which is Installing with Oracle WebLogic Server Follow these instructions to install IBM Initiate Provider Direct on Oracle WebLogic Server. Before you begin This procedure assumes that you have extracted the necessary.properties files from the provider.war file, and edited them as needed. Procedure 1. Install Oracle WebLogic Server with a "Complete" installation. 2. Start the Oracle WebLogic Server. 3. Access administrative console ( and log in. The default Oracle WebLogic Server admin user name and password are "weblogic" and "weblogic". 4. In the Information and Resources section, click the Configure applications link. 5. Click Install above the list of deployed applications. 6. Select the "Upload your file(s)" link. 7. In the Deployment Archive section, browse to the location of provider.war select it, and click Next. 8. The console displays an "uploaded successfully..." message. Click Next. 9. Ensure that install this deployment as an application is selected and click Next. 10. Click Finish. There is no need to change any of the optional values. 11. Shut down the Oracle WebLogic Server. 12. Check the weblogic_home/server/lib directory for a weblogic_sp.jar file. If it does not exist, create a zip file in that location and name it weblogic_sp.jar. Place a correctly configured provider.properties, file into it. 13. Verify that the engine hub instance is up and running or the Provider Direct application will not start correctly. 14. Start the Oracle WebLogic Server and log on to the administrative console. 15. Click the Configure Applications link. 4 Installation and Configuration Guide: Installation and Configuration Guide

15 16. The Provider Direct application should be in an "Active" state. 17. In a browser window on any networked computer, type <<WLS_HOST>>:<<WLS_PORT>>/ProviderDirect to open the login page. Chapter 1. Running the IBM Initiate Provider Direct install 5

16 6 Installation and Configuration Guide: Installation and Configuration Guide

17 Chapter 2. Provider Direct configuration The user configures the provider.properties file to ensure successful use of the application. When IBM Initiate Provider Direct has been properly installed, it can be configured to the needs of the user. The items to be configured are: v provider.properties file - this file defines the host name and port where the hub instance is running. Required properties in the provider.properties file The following properties must be set. If these values are not set properly, the application cannot be deployed. Table 1. required engine login properties Property loginprovider.username loginprovider.password Description Identifies a user who has at least read-only access to all dictionary segments. (Default=system) Identifies the password for the loginprovider.username. (Default=system) Table 2. required context factory properties Property Description contextfactory.hostname Change the value to indicate the machine where the Master Data Engine is running. The default is localhost. contextfactory.hostport Default value is contextfactory.sslversion SSLv3 contextfactory.usessl Can be set to true or false. The default is false. contextfactory.seclib SSL Table 3. required data source properties Property datasource.databasename datasource.servername datasource.portnumber datasource.user Description The name of the Master Data Engine database The name or IP address of the server where the Master Data Engine database is located The port used for the Master Data Engine database. A user name configured for the Master Data Engine database. You must comment out this line (with a # character) if you are using MS SQL Server with Windows authentication. Copyright IBM Corp

18 Table 3. required data source properties (continued) Property Description datasource.password The password for the selected database user. datasource.classname You must comment out this line (with a # character) if you are using MS SQL Server with Windows authentication. The data source class name to use in order to connect to the Master Data Engine database. Note: copy one of the commented examples to ensure that the proper format is used. Table 4. required engine interaction properties Property Description HostName The host name or IP address for the engine you want to connect to; for example, localhost. HostPort The port the engine is running on; for example, UseSSL A true/false value to indicate whether SSL is used to communicate with the engine. The default is false. MaxContext Maximum number of contexts to create. The default is 10. InitContext The initial number of context that gets created in the context pool upon startup of the web server. TimeOut The number of seconds to wait for a free context to come into the pool. The default is 30. Configuration conventions IBM Initiate Provider Direct includes its own Master Data Engine configuration that defines the data model and other elements required by Initiate Provider Direct. This default engine configuration contains several elements which can be extended or customized by following predetermined naming conventions. All of these changes can be made using IBM Initiate Workbench. Enumerated data types Default values may be customized unless otherwise notes. Table 5. Enumerated data types Value Provider Specialty Provider Gender Language Provider Delivery Preferences - Information Types Provider Delivery Preferences - Delivery Mode Description Specialization field for individual providers. Values and descriptions can be customized according to customer needs. Available genders for individual providers. Languages spoken by the provider. Default includes five most common languages. Additional values can be set as needed. Information types for delivery preferences. Available delivery modes for specified delivery preferences. 8 Installation and Configuration Guide: Installation and Configuration Guide

19 Table 5. Enumerated data types (continued) Value Provider Title Provider Role License Status Provider Status Organization Type Organization Status Description Title for the individual provider. Valid roles for the individual provider (may include Administrative, Imaging, Labs, Physician). Valid status for the provider state ID credentials (may include Active, Inactive). Valid status for the provider (may include Active, Inactive). The type of organization for organizational provider records. The status of organizational provider records. Extensible attributes Use the following information when working with custom attributes and custom identifiers/credentials. Custom attributes Note: All custom attributes must be defined with MEMATTR attribute type and have single values allowed by setting the property nsactive=1. Table 6. Custom attributes Value Provider Entity Organization Entity Description Custom attributes for individual providers must use the three-letter prefix PCA in the attribute code. For example, the default configuration includes a sample custom attribute "Board Certification", with attribute code PCABRDCERT. Custom attributes for organizational providers must use the three-letter code OCA in the attribute code. Custom identifiers/credentials v Custom identifiers must be defined as attribute MEMIDENT. v The attribute code must be unique but does not follow a naming convention. Chapter 2. Provider Direct configuration 9

20 10 Installation and Configuration Guide: Installation and Configuration Guide

21 Legal Statement Licensed Materials Property of IBM Copyright IBM Corporation, 1995, US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. IBM, the IBM logo, Initiate, and Initiate Master Data Service are trademarks of IBM Corp., registered in many jurisdictions worldwide. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other product and service names might be trademarks of IBM, or other companies. This Program is licensed under the terms of the license agreement accompanying the Program. This license agreement may be either located in a Program directory folder or library identified as "License" or "Non-IBM License", if applicable, or provided as a printed license agreement. Please read this agreement carefully before using the Program. By using the Program, you agree to these terms. Copyright IBM Corp

22 12 Installation and Configuration Guide: Installation and Configuration Guide

23 Notices and trademarks This information was developed for products and services offered in the U.S.A. Notices IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY U.S.A. For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd , Shimotsuruma, Yamato-shi Kanagawa Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web Copyright IBM Corp

24 sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation J46A/G4 555 Bailey Avenue San Jose, CA U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information is for planning purposes only. The information herein is subject to change before the products described become available. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to 14 Installation and Configuration Guide: Installation and Configuration Guide

25 IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights reserved. If you are viewing this information softcopy, the photographs and color illustrations may not appear. Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at "Copyright and trademark information" at The following terms are trademarks or registered trademarks of other companies: Adobe is a registered trademark of Adobe Systems Incorporated in the United States, and/or other countries. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Notices and trademarks 15

26 16 Installation and Configuration Guide: Installation and Configuration Guide

27 Index A apache tomcat installing with 1 C configuration conventions 8 custom attributes 8 custom identifiers/credentials 8 enumerated data types 8 extensible attributes 8 provider direct 7 custom attributes configuration 8 custom identifiers/credentials configuration 8 customer support contacting 19 E enumerated data types configuration 8 extensible attributes configuration 8 H hardware and platform requirements vii provider direct configuration 7 introduction vii prerequisites vii provider direct install running 1 provider.properties file required properties 7 R required properties provider.properties file 7 requirements hardware and platform vii running the provider direct install 1 S software services contacting 19 support customer 19 T trademarks list of 13 I IBM WebSphere installing with 2 installing with oracle weblogic server 4 installing with apache tomcat 1 IBM WebSphere 2 introduction provider direct vii L legal notices 13 O oracle weblogic server installing with 4 P prerequisites provider direct vii Copyright IBM Corp

28 18 Installation and Configuration Guide: Installation and Configuration Guide

29 Contacting IBM You can contact IBM for customer support, software services, product information, and general information. You also can provide feedback to IBM about products and documentation. The following table lists resources for customer support, software services, training, and product and solutions information. Table 7. IBM resources Resource IBM Support Portal Software services My IBM Training and certification IBM representatives Description and location You can customize support information by choosing the products and the topics that interest you at entry/portal/overview/software/ Information_Management/IBM Initiate_Master_Data_Service You can find information about software, IT, and business consulting services, on the solutions site at businesssolutions/ You can manage links to IBM web sites and information that meet your specific technical support needs by creating an account on the My IBM site at You can learn about technical training and education services designed for individuals, companies, and public organizations to acquire, maintain, and optimize their IT skills at You can contact an IBM representative to learn about solutions at Providing feedback The following table describes how to provide feedback to IBM about products and product documentation. Table 8. Providing feedback to IBM Type of feedback Product feedback Action You can provide general product feedback through the Consumability Survey at consumability-survey Copyright IBM Corp

30 Table 8. Providing feedback to IBM (continued) Type of feedback Action Documentation feedback To comment on the information center, click the Feedback link on the top right side of any topic in the information center. You can also send comments about PDF file books, the information center, or any other documentation in the following ways: v Online reader comment form: v comments@us.ibm.com 20 Installation and Configuration Guide: Installation and Configuration Guide

31

32 Printed in USA GI