These notes are intended as an aid in the installation of RIB. They are not intended to replace the detailed description of each of the process steps and prerequisites, but to act as a companion to those steps. For a successful installation, a methodical reading and understanding of each step of this installation guide is strongly recommended.
This checklist covers all of the sequential steps required to perform a full installation of the RIB, using either the GUI RIB Installer (strongly recommended) or a command line installation.
Task | Notes | |
---|---|---|
Prepare the Oracle Application Servers for installation of the RIB Components |
Prerequisite |
|
Prepare the Oracle Database Schemas that the RIB will use. |
Prerequisite |
|
Prepare the Oracle AQ JMS |
Prerequisite |
|
Verify the Applications the RIB will be integrating to are configured appropriately. |
See documentation regarding integration with the RIB in the documentation for each Oracle Retail application. |
|
"Information to Gather for the Install" |
During the prerequisites steps there is information that should be note that will be used to configure the RIB during the installation process. |
|
Install the RIB using one of these methods:
|
It is strongly recommended that the Installation Using the RIB Installer GUI method be used. |
|
Verify Application URL settings match RIB install. |
RIB Functional Artifact URLJNDI URL |
|
Complete the setup of RDMT using the same "Information to Gather for the Install" |
During either of the installation methods, one of the manual steps will have extracted the rdmt tools to the appropriate directory. |
|
Verify the RIB installation using the RDMT tools. |
||
Install RIHA. |
The RIB Hospital maintenance tool |
Task | Notes | |
---|---|---|
Install Oracle Application Server 10.1.3.x. |
See Release Notes for the certifications and the Oracle Retail Integration Bus Implementation Guide for deployment Architectures. |
|
Ensure that Java 1.5 JDK is installed on the OracleAS host and accessible. |
||
Create the RIB OC4J instances. Warning: Each rib-<app> application requires a separate OC4J instance that is not shared with any other application. $ORACLE_HOME/bin/createinstance -instanceName rib-<app>-oc4j-instance Note: For details on opmn usage and configuration details, see the Oracle Process Manager and Notification Server Administrator's Guide 10g Release 3 (10.1.3.3). |
Replace <app> with the actual value of the RIB application for the associated retail application. There are two RIB specific oc4j instances that must be created regardless of the other application deployment choices.
These are the optional application instances depending on the deployment choices. It is recommended, but not required that this naming convention be followed:
|
|
Edit the $ORACLE_HOME/ j2ee/rib-<app>-oc4j-instance/config/server.xmlAdd attribute global-jndi-lookup-enabled="true" to <application-server> element. |
Example : <application-server xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://xmlns.oracle.com/oracleas/schema/application-server-10_1.xsd" application-directory="../applications" check-for-updates="adminClientOnly" deployment-directory="../application-deployments" connector-directory="../connectors" global-jndi-lookup-enabled="true" schema-major-version="10" schema-minor-version="0" > |
|
Edit the $ORACLE_HOME/opmn/conf/opmn.xml file and add the following properties to the rib-<app>-oc4j-instance definition. |
Make a backup copy of opmn.xml before you edit. |
|
Locate the section of the xml file that relates to each of the rib-<app> instances. Note: The properties below must be applied ONLY to rib-<app>-oc4j-instance definition. |
<process-type id="rib-rms-oc4j-instance" module-id="OC4J" status="enabled"> <module-data> <category id="start-parameters"> Default stuff…. </category> <category id="stop-parameters"> Default stuff…. </category> </module-data> Port stuff…. </process-type> |
|
Update the java-options section to add the following JVM properties:
Note: These are minimum values. Consult with the local sysadmin's for site values.
|
<data id="java-options" value="-server -Doc4j.jmx.security.proxy.off=true -Xms500M -Xmx900M -Djava.security.policy=$ORACLE_HOME/j2ee/rib-rms-oc4j-instance/config/java2.policy -Djava.awt.headless=true -Dhttp.webdir.enable=false"/> |
|
Specify -userThreads to oc4j-options element. |
<data id="oc4j-options" value="-userThreads"/> |
|
Make sure that numprocs attribute for the process-set element for rib-<app>-oc4j-instance is set to 1. |
<process-set id="default_group" numprocs="1"/> |
|
Edit the "orion-ejb-jar.xml" present under <oc4j-instance-home>/application-deployments/admin_ejb directory of the oc4j instance. Make sure to create a backup of the file before editing. |
Add the "rib-oc4j-administrator" role as follows: <security-role-mapping name="jmxAdministrator"> <group name="oc4j-administrators" /> <group name="ascontrol_admin" /> <group name="rib-oc4j-administrators" /> </security-role-mapping> <security-role-mapping name="jmxusers"> <group name="oc4j-app-administrators" /> <group name="ascontrol_appadmin" /> <group name="rib-oc4j-administrators" /> </security-role-mapping> |
|
This completes the creation and mapping of the user and role. Restart the oc4j instance. |
Task | Notes | |
---|---|---|
Each Oracle Retail Application has an associated set of RIB Artifacts that must be installed as part of the RIB integration, e.g. the RIB Hospital Tables, CLOB API libraries, and Oracle Objects.
|
Each Application packages the RIB artifact creation scripts and they are installed at the time of the application's installation. It is critical to Insure that they have been installed and are the correct version. The TAFR Hospital is independent of any of the applications and should have a separate user/schema created for it. It is recommended that all applications have a separate Hospital and that they be logically and operationally associated with that application. |
|
Ensure that each PL/SQL application schema has run the RIB supplied scripts to create the RIB Artifacts:
|
Verify the XML Developer's Kit for PL/SQL is installed. |
|
RMS Application- verify that the row in the RIB_OPTIONS table has correct values to match the RIB deployment environment. |
XML_SCHEMA_BASE_URL_DEFAULT = http://<hostname>:<port>/rib-func-artifact; |
|
Ensure that each Java EE application schema has run the RIB supplied scripts to create the RIB Artifacts:
|
||
RIB TAFR RIB Hospital Ensure that the schema exists and has run the RIB supplied script to create the RIB Hospital.
|
In RIB 13, there is a separate Hospital for all RIB TAFRs. Ensure that there is a user created for the RIB components and the scripts that create the hospital objects have been run. The TAFR Hospital user requires no special permissions. CREATE USER "TAFRHOSP" IDENTIFIED BY "TAFRHOSP" DEFAULT TABLESPACE "USERS" TEMPORARY TABLESPACE "TEMP"; GRANT "CONNECT" TO " TAFRHOSP "; GRANT "RESOURCE" TO " TAFRHOSP "; |
|
Ensure that the XA grants are made appropriately. Note: For details, see the Oracle Database Administrator Guide 10g Release 2 (10.2.0.3), |
grant select on v$xatrans$ to public; grant select on pending_trans$ to public; Verify that the XA scripts have been run on the database.grant select on dba_2pc_pending to public; grant select on dba_pending_transactions to public; grant execute on dbms_system to public; |
Task | Notes | |
---|---|---|
Create the Oracle RDBMS instance that will be the JMS Provider. |
Oracle Streams AQ is provided by the Oracle RDBMS Enterprise Edition install. Warning: It is strongly recommended that the Oracle Database Instance that is configured to be the JMS provider is not shared with any other applications and not be on the same host (physical or logical) with any other applications. See "Deployment Architectures" in the Oracle Retail Integration Bus Implementation Guide. |
|
Create the AQ JMS user with the appropriate access and permissions to the Oracle Streams AQ packages. This user must have at least the following database permissions.
|
Example script: CREATE USER "RIBAQ" IDENTIFIED BY "RIBAQ" DEFAULT TABLESPACE "AQJMS" TEMPORARY TABLESPACE "TEMP"; GRANT "CONNECT" TO "RIBAQ"; GRANT "RESOURCE" TO "RIBAQ"; GRANT CREATE SESSION TO "RIBAQ"; GRANT EXECUTE ON "SYS"."DBMS_AQ" TO "RIBAQ"; GRANT EXECUTE ON "SYS"."DBMS_AQADM" TO "RIBAQ"; GRANT EXECUTE ON "SYS"."DBMS_AQIN" TO "RIBAQ"; GRANT EXECUTE ON "SYS"."DBMS_AQJMS" TO "RIBAQ"; GRANT "AQ_ADMINISTRATOR_ROLE" TO "RIBAQ"; |
Information | Notes | |
---|---|---|
jms-server-home jms-url jms-port jms-user jms-password |
JMS Provider for RIB Release 13.0.3 is AQ.
|
|
oas-instance-name oas-instance-home oas-opmn-request-port oas-ohs-port java-home |
For each of the Oracle Application Servers that the RIB components will be deployed to.
|
|
oc4j-instance-name oc4j-instance-home oc4j-user oc4j-password |
The oc4j instances for each of your rib-<app> applications that are in-scope.
|
|
To configure each rib-<app> this information is needed for each. |
|
|
For RIB Hospital Database: database/url database/user database/password |
|
|
For PL/SQL application database: database/url database/user database/password |
See samples in row above for RIB Hospital Database. |
|
For email notifications: email-server-host email-server-port from-address to-address-list |
|
|
joined information for jayvee applications: jndi/url jndi/factory jndi/user jndi/password |
|
Task | Notes | |
---|---|---|
Make sure that the JAVA_HOME environment variable is set for the user that will be performing these tasks. > echo $JAVA_HOME /usr/bin/java/jdk1.5.0_09 |
Example: export JAVA_HOME=/usr/bin/java/jdk1.5.0_09 |
|
Make sure that all RIB OC4J instance that are to deployed to are running. |
||
Determine the host and file system to create the rib-app-builder home directory on. > mkdir rib-app-builder |
See the Oracle Retail Integration Bus Implementation Guide for guidelines and deployment approaches. This is an important strategic decision since all RIB configurations and management for a given deployment will be from this single, central location. |
|
Download and extract the RibKernel<RIB_MAJOR_VERSION>ForAll<RETAIL_APP_VERSION>Apps_eng_ga.tar. > tar xvf RibKernelRelease 13.0.3ForAllRelease 13.0.3Apps_eng_ga.tar |
Copy the latest version to the rib-app-builder and then extract it to build your "rib-home". This "rib-home" will be the directory from where you will perform "all" the rib-<app> related tasks from now on. |
|
Download the RibFuncArtifact<RIB_{MAJOR|MINOR}_VERSION>ForAll<RETAIL_APP_VERSION>Apps_eng_ga.tar and put it in rib-home/download-home/rib-func-artifacts directory. |
Do "not" extract the tar file. This will be done by the check-version-and-unpack tool. |
|
Download all the RibPak<RIB_{MAJOR|MINOR}_VERSION>For<RETAIL_APP_NAME><RETAIL_APP_VERSION>_eng_ga.tar and put it in rib-home/download-home/all-rib-apps directory. |
Do not extract the tar file. This will be done by the check-version-and-unpack tool. |
|
Return to the root rib-home directory. |
||
Execute rib-installer.sh >./rib-installer.sh This will start the x-term GUI. |
For installs using a remote client (x-term) set the DISPLAY variable appropriately first. > export DISPLAY=141.144.112.189:0.0 Make sure that your local machine has an X-server (such as Exceed) running. |
|
Verify Application URL settings match RIB install. |
RIB Functional Artifact URL JNDI URL |
|
Bounce all of the rib-<app>-oc4j-instances. |
During the installation a shared library is created that contains the JDBC Driver update. It is necessary to bounce the oc4j instance. |
|
Verify the installation using RDMT. |
Task | Notes | |
---|---|---|
Make sure that the JAVA_HOME environment variable is set for the user that will be performing these tasks. > echo $JAVA_HOME /usr/bin/java/jdk1.5.0_09 |
Example: export JAVA_HOME=/usr/bin/java/jdk1.5.0_09 |
|
Make sure that all RIB OC4J instance that are to deployed to are running. |
||
Determine the host and file system to create the rib-app-builder home directory on. > mkdir rib-app-builder |
See the Oracle Retail Integration Bus Implementatoin Guide for guidelines and deployment approaches. This is an important strategic decision since all RIB configurations and management for a given deployment will be from this single, central location. |
|
Download and extract the RibKernel<RIB_MAJOR_VERSION>ForAll<RETAIL_APP_VERSION>Apps_eng_ga.tar. > tar xvf RibKernelRelease 13.0.3ForAllRelease 13.0.3Apps_eng_ga.tar |
Copy the latest version to the rib-app-builder and then extract it to build your "rib-home." This "rib-home" will be the directory from where you will perform "all" the rib-<app> related tasks from now on. |
|
Download the RibFuncArtifact<RIB_MAJOR_VERSION>ForAll<RETAIL_APP_VERSION>Apps_eng_ga.tar and put it in rib-home/download-home/rib-func-artifacts directory. |
Do not extract the tar file. This will be done by the check-version-and-unpack tool. |
|
Download all the RibPak<RIB_MAJOR_VERSION>For<RETAIL_APP_NAME><RETAIL_APP_VERSION>_eng_ga.tar and put it in rib-home/download-home/all-rib-apps directory. |
Do not extract the tar file. This will be done by the check-version-and-unpack tool. |
|
Run the rib-home/download-home/bin/check-version-and-unpack.sh script from rib-home/download-home/bin directory. |
This script will verify the version compatibility between the paks and extract the files if they are compatible. |
|
Edit rib-home/deployment-home/conf/rib-deployment-env-info.xml file to specify the deployment environment information. See the section, "Information to Gather for Installation in Remote Server", before starting the edit. |
This file (rib-deployment-env-info.xml) is the ONLY file that the user has to edit. See "RIB-app-builder" in the Oracle Retail Integration Bus Operations Guide for details and examples. The xml file is divided in 4 major sections.
|
|
Edit the app-in-scope-for-integration section to match the desired deployment. |
Define what application are in scope for this environment. <app-in-scope-for-integration> <app id="rms" type="plsql-app"/> <app id="tafr" type="tafr-app"/> <app id="sim" type="javaee-app"/> <app id="rwms" type="plsql-app"/> <app id="rpm" type="javaee-app"/> <app id="aip" type="javaee-app"/> </app-in-scope-for-integration> |
|
Edit the rib-jms-server section. See "Pre-Installation Steps for Multiple JMS Server Setup" in Chapter 4. |
For AQ: <jms-server-home>linux1@linux1:/home/oracle/oracle/product/10.2.0/db_1</jms-server-home> <jms-url>jdbc:oracle:thin:@linux1:1521:ora10g</jms-url> <jms-port>1521</jms-port> <jms-user>ribaq</jms-user> <jms-password>ribaq</jms-password> |
|
Edit the Application Server section |
<oas-instance-name> AS4.linux1.localdomain </oas-instance-name> <oas-instance-home>soa1@linux1:/home/soa1/product/10.1.3.1/OracleAS_6</oas-instance-home> <oas-opmn-request-port>6003</oas-opmn-request-port> <oas-ohs-port protocol="http" >7777</oas-ohs-port> <java-home>/usr/java/jdk1.5.0_01</java-home> |
|
Configure the oc4j instances for each of your rib-<app> applications that are in-scope. |
<oc4j id="rib-rms-app-server-instance"> <oc4j-instance-name>rib-rms-oc4j-instance</oc4j-instance-name> <oc4j-instance-home>soa1@linux1:/home/soa1/product/10.1.3.1/OracleAS_4/j2ee/rib-rms-oc4j-instance</oc4j-instance-home> <oc4j-user>riboc4jadmin</oc4j-user> <oc4j-password>riboc4jadmin</oc4j-password> </oc4j> |
|
Configure the rib-applications section: In this section you define the rib-<app> specific information for each rib-<app> that in scope. |
For plsql applications you will need to define RIB Hospital connection, application database connections, and email notification information. <rib-app id="rib-rms" type="plsql-app"> For javaee applications, you will need to define RIB Hospital connection, email notification information and the connecting retail application's (i.e. <app>) JNDI information. |
|
Run the rib-home/application-assembly-home/bin/rib-app-compiler.sh script from rib-home/application-assembly-home/bin directory. |
This will generate/assemble a rib-<app> and make it ready for deployment. |
|
The RIB apps are now ready to deploy. Execute the rib-home/deployment-home/bin/rib-app-deployer.sh script with the appropriate command line parameter. |
This script is located in the rib-home/deployment-home/bin directory. |
|
> rib-app-deployer.sh -prepare-jms |
This creates a new JMS server with all RIB configured topics. |
|
>rib-app-deployer.sh -verify-error-hospital rib-<app> |
This verfies:
Note: Database must be already running. |
|
> rib-app-deployer.sh -deploy-rib-func-artifact-war |
This deploys the rib-func-artifact.war to the Java EE container. |
|
> rib-app-deployer.sh -deploy-rib-app-ear rib-<app> |
This deploys the rib-<app> to the javaee container. Repeat this step for all rib-<app> that is in scope for this integration environment. Note: <app> must be one of rms, rwms, tafr, sim, aip or rpm |
|
Bounce all of the rib-<app>-oc4j-instances. |
During the installation a shared library is created that contains the JDBC Driver update. It is necessary to bounce the oc4j instance. |
|
Verify Application URL settings match RIB install. |
RIB Functional Artifact URL JNDI URL |
|
Verify the installation using RDMT |
The following are necessary directory parameters.
RDMT Home Directory |
Rib1301ForAll13xxApps/rib-home/tools-home/rdmt/ |
|
RDMTLOGS Directory |
Rib1301ForAll13xxApps/rib-home/tools-home/rdmt /RDMTLOGS |
|
Temp Files Directory |
Rib1301ForAll13xxApps/rib-home/tools-home/rdmt /RDMTLOGS/tmp |
|
RIB App Builder rib-home Directory |
/u00/Rib1301ForAll13xxApps/rib-home |
The following are parameters for JMS Provider.
AQ JMS User ID |
ribaq |
|
AQ JMS Password |
retek |
|
AQ JMS Database Name |
soa1 |
|
JMS HOST |
mspdev38 |
|
JMS PORT |
1521 |
The following are OC4J parameters for JMX functions.
OC4J/JMX Host |
mspdev72 |
|
JMX Req Port |
6003 |
|
OC4J Instance name |
rib-rms-oc4j-instance |
|
OC4J App Name |
rib-rms |
|
OC4J User Name |
oc4jadmin |
|
OC4J Password |
welcome1 |
The following are parameters for each hospital (RMS, RWMS, SIM, and others).
User Name |
rms |
|
Password |
retek |
|
Database (SID) |
orcl |
|
Database Host |
mspdev68 |
|
Listener Port |
1521 |
The following are the steps required to complete RDMT installation.
Task | Notes | |
---|---|---|
Make sure that the Java path is set Java 5.0. > java -version |
The RDMT Java support classes require Java 5.0, and installation will perform a check and fail if the path is not correct. Prior to the install, verify that your Java version is correct. |
|
Download the RdmtRelease 13.0.3ForAll13.x.xApps_eng_ga.tar. |
The recommended location is to put it in rib-home/tools-home directory. There is an empty rdmt subdirectory already there. This is only a placeholder. RDMT can be installed under any user in any directory. |
|
Extract the tar file. > tar xvf RdmtRelease 13.0.3ForAll13.x.xApps_eng_ga.tar |
Extract the tar file. It will create or over-write a directory call rdmt. |
|
Execute the configbuilder.sh script. > ./setup.sh |
cd to the rdmt directory and execute the configbuilder.sh script supplied with the toolkit. |
|
If rdmt is extracted under rib-home, it updates the necessary rdmt configuration files if installed under rib-home/tools-home/rdmt directory. |
The configbuilder.sh script checks if rdmt is installed under rib-home. If so, it fetches and updates all the necessary configuration information from rib-deployment-env-info.xml present under rib-home/deployment-home/conf directory. Also, it configures for all the rib-<app>s depending upon the applications in scope as defined in rib-deployment-env-info.xml. |
|
If rdmt is extracted in some other directory outside rib-home, it updates the necessary rdmt configuration files if installed in some other directory with rib-home present on same server. |
Once prompted for rib-home path, provide the same and it fetches and updates all the necessary configuration information from rib-deployment-env-info.xml present under specified rib-home/deployment-home/conf directory.Also, it configures for all the rib-<app>s depending upon the applications in scope as defined in rib-deployment-env-info.xml. |
|
If rdmt is extracted in a remote server with no rib-home present, answer prompts for RIB configuration values during Setup if installed in a remote server with no rib-home present on that server. |
The installation script will prompt for the configuration settings need to run the tools in the toolkit (See "Information to Gather for Installation in Remote Server" in this manual.) Note: After the installation, these configurations can be changed at any time via any text editor in the appropriate configuration file. |
|
Answer prompts the for additional JMX configurations. Answer yes to configure additional rib-apps in case of remote installation. |
After prompting for the necessary configuration parameters, the setup script updates the various configuration files and then prompts the user for additional JMX configurations that the user will be interested in. It is recommended that you configure all the rib-apps that have been installed in the RIB Installation process and then run the RibConfigReport. This report will run a battery of tests that will validate the RIB components installed. |
|
The configbuilder.sh script will set the permissions to 700 (-rwx------) on all tools and files within the rdmt directory structure. |
There are configurations that contain passwords. |
|
Run Configuration Report |
This report will execute using all of the configuration parameter that have been supplied and will verify them against the RIB installation |
|
Installation is complete. |
The following is a checklist for Oracle Retail RIHA installation.
Task | Notes | |
---|---|---|
Pre-Installation |
||
Verify the JRE Installed on server/PC where RIHA will be installed. |
The minimum and preferred Java Runtime Engine (JRE) version to use with RIHA is 1.5. |
|
The RIB XSDs must be made network-accessible in order for RIHA to properly display RIB messages. |
The RIB Functional Artifact URL (e.g. http://mspdev85:7777/rib-func-artifact/payload/xsd/) should be accessible to all RIHA users. |
|
Verify RIHA Version is compatible with RIB version. |
Due to changes in the underlying RIB architecture RIHARelease 13.0.3 is only compatible with RIB13.0.X and will not work with RIB12.0.X and lower. |
|
Copy the RihaRelease 13.0.3ForAll13.x.xApps_eng_ga.tar archive file to the location where RIHA will be installed. |
|
|
Decompress the tar file with an archive utility. |
|
|
Download hibernate-2.1.8.zip archive file, extract the hibernate2.jar and put it in external-lib directory. |
URL: |
|
Execute the RIHA configuration executable file. Follow instructions, this script will drive the rest of the installation and configuration process. |
|
|
If riha is extracted under rib-home, it updates the necessary riha configuration files if installed under rib-home/tools-home/riha directory. |
It fetches and updates all the necessary configuration information from rib-deployment-env-info.xml present under rib-home/deployment-home/conf directory.It configures for RIB hospital for the <app>s depending upon the applications in scope as defined in rib-deployment-env-info.xml. |
|
If riha is extracted in some other directory outside rib-home, it updates the necessary rdmt configuration files if installed in some other directory with rib-home present on same server. |
It fetches and updates all the necessary configuration information from rib-deployment-env-info.xml present under specified rib-home/deployment-home/conf directory.It configures for RIB hospital for the <app>s depending upon the applications in scope as defined in rib-deployment-env-info.xml. |
|
If reha is extracted in a remote server with no rib-home present. |
Follow instructions, this script will drive the rest of the installation and configuration process. |
|
Verify RIHA is configured and ready. Execute the appropriate file to start RIHA. |
|