Resource Kit Guide
Resource Kit Guide
Copyright 2009 Siperian, Inc. Copyright 2009 Siperian Inc. [Unpublished - rights reserved under the Copyright Laws of the United States] Siperian and the Siperian logo are trademarks or registered trademarks of Siperian, Inc. in the US and other countries. All other products or services mentioned are the trademarks or service marks of their respective companies or organizations. THIS DOCUMENTATION CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF SIPERIAN, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SIPERIAN, INC.
Contents
Preface
Organization.......................................................................................................................................................4 Learning About Siperian Hub .........................................................................................................................4 Contacting Siperian ...........................................................................................................................................7
Chapter 1: Introduction
Siperian Hub and Resource Kit Documentation..........................................................................................2 Siperian Sample ORS ........................................................................................................................................2 Sample Applications and Utilities ...................................................................................................................3 LookupWebServiceExample..................................................................................................................3 BDD Demo..............................................................................................................................................3 PartyWebServiceExample ......................................................................................................................4 SAMProvidersExample ..........................................................................................................................4 Business Process Management (BPM) .................................................................................................4 MetCommand Utility ..............................................................................................................................4 WsCodeGenPlugin ..................................................................................................................................4 CleanseAdapterExample ........................................................................................................................5 MetModelConverter................................................................................................................................5 Password Encryption Tool Utility ........................................................................................................5 SIF SDK .............................................................................................................................................................5 Javadocs...............................................................................................................................................................6
Installing the Siperian Resource Kit............................................................................................................. 13 Troubleshooting Your Installation..................................................................................................... 23 Uninstalling the Siperian Resource Kit........................................................................................................ 24 Modifying and Redeploying Applications ................................................................................................... 25 Running the postInstallSetup Process Manually .............................................................................. 25
Preface
This guide describes how to install, configure, and use the Siperian Hub Resource Kit. Note: This guide is written for a technical audience: service developers, database administrators, system administrators, and other implementers who are responsible for Siperian Hub installation and setup tasks. Familiarity with the database environment on which you are installing the Resource Kit and knowledge of Oracle administration is assumed. See the Siperian Hub Administrator Guide for Siperian Hub administration and configuration information.
Chapter Contents
Organization Learning About Siperian Hub Contacting Siperian
Organization
Organization
This guide contains the following sections:
Chapter 1, Introduction Describes the Siperian Hub Resource Kit, including the various sample applications, and outlines the prerequisites you need to follow prior to installing and deploying the sample applications. Describes the procedures required for installing the Siperian Resource Kit, including the sample applications. Describes how to use the Password Encryption Tool included with the Resource Kit.
Chapter 2, Installing the Siperian Resource Kit Appendix A, Using the Password Encryption Tool
Contacting Siperian
Contacting Siperian
Technical support is available to answer your questions and to help you with any problems encountered using Siperian products. Please contact your local Siperian representative or distributor as specified in your support agreement. If you have a current Siperian Support Agreement, you can contact Siperian Technical Support:
Method World Wide Web Email Voice Contact Information http://www.siperian.com [email protected] U.S.: 1-866-SIPERIAN (747-3742)
We are interested in hearing your comments about this book. Send your comments to:
by Email: by Postal Service: [email protected] Documentation Manager Siperian, Inc. 100 Foster City Blvd. 2nd Floor Foster City, California 94404 USA
Contacting Siperian
1
Introduction
The Siperian Hub Resource Kit is a set of examples and utilities that assist you in integrating the Siperian Hub into your applications and workflows.
Chapter Contents
Siperian Hub and Resource Kit Documentation Siperian Sample ORS Sample Applications and Utilities Password Encryption Tool Utility SIF SDK Javadocs
These files are located in the Resource Kit documentation folder and in the specific sample application folders (for example, BPM) within the samples folder.
LookupWebServiceExample
LookupWebServiceExample is an example of a web service for exposing the cross reference services for the entities managed by the hub and code translation services for the lookup codes defined in the hub.
BDD Demo
The Business Data Director Demo is an example of the Siperian Hub Business Data Director, a data governance application for Siperian Hub that enables business users to effectively create, manage, consume, and monitor master data. Using the sample configuration file (bddDemo.xml) and the configuration tool, you can set up a Business Data Director interface for the sample schema included in the Resource Kit.
Introduction 3
PartyWebServiceExample
PartyWebServicesExample is an example of a set of composite web services built around the Siperian Sample Schema.The web services are built using the Axis web services framework and the SIF APIs are used to access the hub.
SAMProvidersExample
The SAMProvidersExample shows the basics of building custom SAM providers. The jar file that is built by this sample application is installed through the Console in the Security Providers tool. For additional information regarding the process of installing a provider, refer to Managing Provider Files, in the Siperian Hub Administrator Guide.
MetCommand Utility
MetCommand is a simple command-line wrapper for the Siperian Hub Metadata Manager APIs. These APIs are used to manage the metadata (export, import, validate) in the Siperian Hub. It can be used in situations where it is desirable to execute these APIs as part of a script - to automate the promotion of design objects from one ORS to another.
WsCodeGenPlugin
The Eclipse Web Services Code Generator (WsCodeGen) is an Eclipse plug-in for generating the skeleton of a Web Service for use with Siperian SIF services. Components generated by WsCodeGen include Java beans, the WSDL, Castor mapping file, WSDD and other property files required to create a Web Service. The plug-in enables the user to focus on creating and adding business logic code to the framework.
SIF SDK
CleanseAdapterExample
The CleanseAdapterExample allows you to create cleanse adapters to work with your specific, non-supported cleanse engine. For more information about supported cleanse adapters, see the Siperian Cleanse Adapter Guide.
MetModelConverter
MetModelConverter is a command-line utility that converts Common Warehouse Metamodel to Siperian Hub Change List XML format. It demonstrates how Siperian Hub Metadata Manager can be used to integrate 3rd party software like ERWIN.
SIF SDK
The Siperian Resource Kit installer also installs the Siperian Hub Services Integration Framework (SIF). The SIF is the part of Siperian Hub that interfaces with client programs. Logically, it serves as a middle tier in the client/server model. It enables you to implement request/response interactions using any of the following architectural variations: Loosely coupled web services using the SOAP protocol. Tightly coupled Java remote procedure calls based on Enterprise JavaBeans (EJBs). Asynchronous Java Message Service (JMS)-based messages. XML documents going back and forth via Hypertext Transfer Protocol (HTTP).
Each of the above SIF protocols sits on top of the native Siperian Hub protocol, which accepts requests in the form of XML documents or EJBs and returns responses the same way.
Introduction 5
Javadocs
You copy the SIF SDK to any client system on which you wish to develop and run programs to interact with Siperian Hub via SIF. If you can run a Java virtual machine (JVM) on the client system, you can use the Java classes included in the SIF SDK. The SRK installs the SIF-SDK in the following location:
<Resourcekit_Home>\sifsdk
You can configure the SDK to use any SIF protocol. If you cannot run a JVM, then you must explicitly use web services (for example, on a pure .NET system) or JMS (for example, on a mainframe system), or XML over HTTP. For a complete description of the Siperian SIF-SDK, refer to the Siperian Hub Services Integration Framework Guide. This guide refers to these Java classes by the name of the first class you must instantiate, SiperianClient.
Javadocs
The Siperian Resource Kit installer installs the java documentation for the SIF API in the following locations:
<Resourcekit_Home>\docs\sifsdk\javadoc <Resourcekit_Home>\docs\sip-plugin\javadoc
You can view the associated java packages and classes via the index.html file. The index.html file is located in the following directory:
<Resourcekit_Home>\sifsdk\javadoc\index.html
Open index.html to see a right-hand frame and two left-hand frames. The left frames provide links to the pages for all packages and all classes. The lower left frame displays the links associated with the package you select in the upper left frame.You can select All Classes in the upper left frame to see a combined list of classes from all packages in the lower left frame. The right frame changes to show the pages you select. Begin by exploring the classes of the com.siperian.sif.message package. Most of the classes used in application programs are in this package and its subpackages.
2
Installing the Siperian Resource Kit
The Siperian Resource Kit installer installs the Resource Kit components. Important: Before you run the Siperian Resource Kit installer, the Siperian Hub must be installed and configured for your environment. In addition, you need to install and register the Siperian Sample ORS, and you must have purchased a license for the Siperian Hierarchy Manager. For more information, see Chapter 1, Introduction.
Chapter Contents
System Requirements Preparing to Install the Sample Applications Installing the Siperian Resource Kit Uninstalling the Siperian Resource Kit Modifying and Redeploying Applications
System Requirements
System Requirements
The system requirements for installing the Siperian Resource Kit are: JDK 1.5.0_15 (for more information, refer to: http://java.sun.com/javase/downloads/index_jdk5.jsp) Siperian Hub Server XU SP2 JBoss-4.0.3 SP1, WebLogic 9.2 MP3 or WebLogic 10 MP2, or WebSphere 6.1.0.23 Oracle 10g or Oracle 11g Windows 2003, XP SP2
For a complete description of how to install the Siperian Hub Server, refer to Siperian Hub Installation Guide. In addition, you need to install the sample schema and register the ORS prior to installing the sample applications. For more information, refer to Installing the Siperian Sample ORS on page 9.
Open a command window. Go to the Windows Start menu; choose Run and enter cmd. Go to the temporary directory you just created. To start SQL*PLUS, enter:
sqlplus
3. 4.
Press Enter.
5. 6.
Connect to the server as SYSTEM or as a user with DBA privileges. Execute the setup_ors.sql script by typing the following command:
@setup_ors.sql
7.
Answer the following prompts: Note: The text in brackets is the default information for each prompt. CMX_ ORS for the name of the User in this case. Press Enter to use the default information and go to the next prompt, unless otherwise directed. Enter name of User [CMX_ORS]: Enter sip_sample for this user name. This is the name of the Siperian Hub user that owns this ORS (sample schema). Enter password for ORS User [!!cmx!!]
Enter name of MRM data tablespace [CMX_DATA]: This is the tablespace in which this ORS will be created. Enter name of MRM index tablespace [CMX_INDX] This is the tablespace that will contain the indexes. Enter name of MRM temporary tablespace <not an Oracle temp tablespace>[CMX_TEMP]: Create a proxy user [PROXY_ROLE]: This step will create a proxy user with access to the database. Enter name of Oracle temporary tablespace [TEMP]: This is the name of the Oracle temporary tablespace. Enter ORACLE server TNS name: This is the name by which the database is known on your network. For example:
mydatabase.mycompany.com
This value is set when you install Oracle. See your Oracle documentation to learn more about this name. Enter name of DBA User [SYSTEM] This is the Oracle username with DBA privileges. Enter password of DBA User: This is the password for the Oracle username with DBA privileges. Enter file to import [cmx_ors.dmp]: Do not use the default. Enter sip_sample.dmp. This is the name of the Oracle export file containing the sample database. This is part of the Siperian Hub install. Enter import from user name [cmx_ors]: Do not use the default. Enter sip_sample.
8.
After the setup scripts are complete, there are log files in the temporary directory from which you ran the scripts:
setup_ors.log sip_sample.dmpimp.log
Review these files to ensure no errors occurred. You may see warnings, which can be ignored. Errors must be addressed. If you see database error in the logs, resolve these first with your DBA and your RDBMS vendor; then re-run the setup_ors.sql script. You can find a copy of the sip_sample.dmp file in the Resource Kit distribution media in the following directory:
database\oracle
Now you must register this sample schema database in Siperian Hub server before running the Siperian Resource Kit installer.
In the Identity section, enter the database display name and machine identifier. In the Connection Properties section, specify connection properties for your database type (Oracle database). Specify: database type and hostname Oracle SID and port number TNS name of the Oracle instance (as defined in the application servers TNSNAMES.ORA file) user name/schema name for the Hub Store
11
Note: Registering the Hub Store fails if you try to register a database that does not contain the Siperian Hub repository objects or Siperian Hub procedures.
4.
Check the Create data source after registration check box if you want to create the data source on the application server after registration. Note for WebLogic: If you are using WebLogic, a dialog box prompts you for your username and password. This process writes only to the master database. The ORS database and data source need not be available at registration time. Siperian Hub uses the data sources provided by the application server and, therefore, does not write any data to the ORS at the time of registration.
5.
Click OK. Note for JBoss: An exception may appear in the log files when registering the data sources on JBoss. This is caused by the deployment architecture on JBoss and results from the server trying to deploy twice. This is benign; the system deals with this situation gracefully. Note for WebSphere: If you are running WebSphere, any changes to an ORS datasource requires an application server restart. For more information on registering databases with the Siperian Hub, refer to the Siperian Hub Administrator Guide. You can find a copy of the sip_sample.dmp file in the Resource Kit distribution media in the following directory:
<RESOURCEKIT_HOME>/sampleschema/oracle
You can load this file into your database before you install the Resource Kit. You are now ready to install the Siperian Resource Kit.
13
2.
Click Next to continue. Note: You can select Cancel to end the installation, or Previous to return to a prior page at any time during the installation process.
3.
Cancel the installation and See Installing the Siperian Sample ORS for instructions. Samples Select this option to install the sample applications. The list of sample applications deployed is stored in the build.properties file. This file is located in the following directory: <Resourcekit_Home>\samples SIF SDK Select this option to install the javadocs, libraries, and resources associated with the SIF SDK.
15
Utilities
Click Help to view installation tips.This button is active throughout the installation wizard when installation tips are available. Click Next to continue.
4.
Enter the installation location for the Resource Kit, or accept the default folder.
Click Choose to select a location for the Resource Kit installation. Do not use spaces in your path or folder name. Click Restore Default Folder to return to the default installation location. If you select a location with an existing installation, this process will overwrite that installation. Click Install to continue. If you are returning to this page via the Previous button, the button label changes to Next as you progress through the installation wizard.
5.
Click Next.
6.
Deploy and configure the Resource Kit to run in your selected application server
17
You can choose to deploy and configure the Resource Kit during this installation or run this process manually at a later time. If you choose not to run post-install setup at this time, you will not be able to use postInstallSetup scrip to deploy the EAR file. You will have to manually edit the EAR file and deploy it to make any changes to your installation. Run the postInstallSetup.bat script from C:\Siperian\hub\resourcekit\deploy. If you run the postInstallSetup script while installing the Resource Kit and later make changes in the samples, and want to redeploy the samples, you can make use of postInstallSetup script. Note: For WebLogic, you must apply this option when running the postInstallSetup.bat script:
-Dweblogic.password=<your WebLogic password>
Click Next.
7.
Configure the Resource Kit for your application server. Each application server has unique steps that guide you through the configuration process of the Resource Kit installation.Enter the path to your selected application server for the installation of the Resource Kit, as shown in this example:
a.
b.
Enter the path to your selected application server for the installation of the Resource Kit as shown in this example:
The Siperian Hub Server and the Resource Kit can reside on different machines. Select Restore Default Folder to reset the option. Select Choose to browse to the desired location. Click Next.
19
c.
Enter the settings and login information for your selected application server. The application server installation pages will vary, depending on your application server.
Application JBoss Description Settings for your JBoss instance: RMI Port Note: The JBoss port can conflict with the default Oracle port. If this is the case for your installation, you must change one of the ports to resolve the conflict. To change the port number in that file, open jbossweb-tomcatxx.sar for editing, search for the word port, and change the value for port to match the value you have set on the JBoss Application Server Port screen. Information for your Siperian Hub Server Installation: Server Name Server HTTP Port Siperian Administrative password Important: If you change the default HTTP port number, you must also change it in the following directory:
JB_HOME\server\default\deploy\jbossweb-tomcatxx.sar\server.xml
where jbossweb-tomcatxx.sar is the SAR file for your Tomcat installation. xx represents the version number. Select a Resource Kit ORS ID. This drop down list will contain all ORS IDs you have created.You must only select an ORS ID related to the Sample Schema. If you have not registered the sample schema, you will not see the ORS ID for the Sample schema. Stop the installation at this point, register the ORS as described in Registering the Siperian Sample ORS, then restart the installation.
Application WebLogic
Description Settings for your WebLogic instance: Host Server Name Username Password Listening Port Information for your Siperian Hub Server Installation: Server Name Server HTTP Port Siperian Administrative password Select a Resource Kit ORS ID. This drop down list will contain all ORS IDs you have created.You must only select an ORS ID related to the Sample Schema.If you have not registered the sample schema, you will not see the ORS ID for the Sample schema. Stop the installation at this point, register the ORS as described in Registering the Siperian Sample ORS, then restart the installation.
WebSphere
Settings for your WebSphere instance: Server Name RMI Port SOAP Port Information for your Siperian Hob Server Installation: Server Name Server HTTP Port Siperian Administrative password Select a Resource Kit ORS ID. This drop down list will contain all ORS IDs you have created.You must only select an ORS ID related to the Sample Schema.If you have not registered the sample schema, you will not see the ORS ID for the Sample schema. Stop the installation at this point, register the ORS as described in Registering the Siperian Sample ORS, then restart the installation.
21
8.
Click Previous to return to prior pages in the installation wizard to change selections. Click Install to continue.
9.
Review messages on the Install Complete page to confirm a successful installation or view causes for an incomplete installation.
the
23
2.
Click Uninstall to begin. The Uninstall Complete screen is displayed. Click Done.
3.
Recompile the application. Rerun the postinstallsetup script that is located in the following location:
C:\siperian\hub\resourcekit\deploy
To run the post-install script manually: For the WebLogic application server, run the following command from a command prompt:
postInstallSetup.bat -Dweblogic.password=your_password -Ddatabase.password=your_database_password
where your_password is the password for your WebLogic application server. A typical way of running this script for WebLogic is as follows:
C:\siperian\hub\resourcekit\deploy>postInstallSetup.bat -Dweblogic.password=weblogic -Ddatabase.password=!!cmx!!
For the WebSphere and JBoss application servers, run the following command from a command prompt:
postInstallSetup.bat
25
A
Using the Password Encryption Tool
The Password Encryption tool is a command-line utility use to encrypt your secured database passwords. Note: See the sample folders for more information about the additional samples and utilities included in the Resource Kit.
Appendix Contents
System Requirements Running the Password Encryption Tool
27
System Requirements
System Requirements
You need to make sure Siperian-common.jar is installed under the Utilities directory. In addition, you must have Java installed and have the jar file to be able to run this utility.
For example, if admin is your the new password, the command is:
Index
A
applications, sample prerequisites before installing 8
G
GWTSampleApp sample application, about 3
B
BPM sample application, about 4 Business Process Management (BPM) sample application, about 4
H
Hub Server installing 13
I
index.html location (for Javadoc) 6 installing Resource Kit 13
C
checking after Resource Kit installation 23 cmx_ors.dmpimp.log file 11 customer support 7
D
documentation list of documents 4 organization 4
J
Javadocs index.html file location 6
L
log files 23 cmx_ors.dmpimp.log file 11 setup_ors.log file 11 LookupWebServiceExample sample application, about 3
E
encrypting a new password 29
31
M
modifying sample applications 25
S
Sample application installation prerequisites 13 sample applications modifying and redeploying 25 prerequisites before installing 8 Sample installation log files checking 23 postInstallSetup.log file 23 Sample Schema about 2 installing 9 registering 11 SAMProvidersExample sample application, about 4 Schema, Sample about 2 Services Integration Framework about 5 Services Integration Framework (SIF) about 5 setup_ors.log file 11 Siperian_Hub_Server_InstallLog.xml file 23 Siperian, contacting 7 SiperianClient class 6 Siperian-common.jar 28 support 7 System database using the Password Encryption Tool to update the passwords 29 system requirements installing Resource Kit 8
O
ORS database using the Password Encryption Tool to update the passwords 29
P
PartyWebServicesExample sample application, about 4 password using the Password Encryption Tool 28 Password Encryption Tool encrypting a new password 28 ORS database 29 running 27 System database 29 using 5, 27, 28 postInstallSetup.log file 23 proxy role 10 proxy user create 10
R
redeploying sample applications 25 Resource Kit installing 13 log files 23 system requirements 8 uninstalling 24
T
technical support 7 training 6
X
XML over HTTP 5
33