Contents

Send Us Your Comments......................................................................................... xi

Preface................................................................................................................... xiii

Audience.............................................................................................................................................. xiii

Related Documents........................................................................................................................... xiii

Customer Support............................................................................................................................. xiii

Review Patch Documentation....................................................................................................... xiv

Improved Process for Oracle Retail Documentation Corrections........................................ xiv

Oracle Retail Documentation on the Oracle Technology Network.................................... xiv

Conventions........................................................................................................................................ xiv

1 Preinstallation Tasks............................................................................................ 1

Installation Terminology.................................................................................................................... 1

Implementation Capacity Planning................................................................................................ 1

Requesting Infrastructure Software................................................................................................. 2

Check Supported Database Server Requirements....................................................................... 2

Check Supported Application Server Requirements.................................................................. 3

Verify Single Sign-On........................................................................................................................... 4

Check Supported Web Browser and Client Requirements....................................................... 4

Supported Oracle Retail Products.................................................................................................... 4

Supported Oracle Retail Integration Technologies..................................................................... 5

Supported Oracle Applications........................................................................................................ 5

UNIX User Account Privileges to Install the Software............................................................... 5

Verify RMS and SIM Inventory Adjustment Reason Codes..................................................... 5

Verify Supplier Site Indicator............................................................................................................ 5

Data Access Schema (DAS)................................................................................................................ 6

2 RAC and Clustering.............................................................................................. 7

Part I: Full Installation............................................................................................... 9

3 Database Installation Tasks—Full....................................................................... 11

Data Access Schema.......................................................................................................................... 11

RMS Database Schema Distribution – Oracle Retail Applications Included................... 11

Create Staging Directory for RMS Installer................................................................................. 11

Establish a Database Partitioning Strategy................................................................................. 12

Step 1: Modify partition_attributes.cfg................................................................................ 14

Step 2: Modify Data Definition Files.................................................................................... 14

Step 3: Generate DDL for DAS Tables – Run partition.ksh (Optional)....................... 15

Step 4: Generate DDL for Tables – Run partition.ksh...................................................... 16

Create the RMS Database................................................................................................................. 16

Create the Database Instance Using Oracle Generic Template..................................... 17

Create Required RMS Tablespaces........................................................................................ 18

Create the Schema Owner for RMS........................................................................................ 19

Create the Database User for BDI RMS INT SCHEMA.................................................... 20

Create the Database User for BDI_RMS_INFR_SCHEMA............................................. 20

Create the Database User for Allocation (Optional)......................................................... 20

Create the Database User for Demo Data (Optional)........................................................ 20

Create the Database User for DAS (Optional).................................................................... 21

Run the RMS Database Schema Installation.............................................................................. 21

Values to Remember for the Batch and Application Installation................................. 23

Resolving Errors Encountered During Database Schema Installation....................... 23

Set Up Additional RMS Users......................................................................................................... 23

PRODUCT_VERS_CONFIG_OPTIONS...................................................................................... 24

Batch Security Setup.......................................................................................................................... 24

Adding a User to the RPM Application....................................................................................... 25

4 Batch Installation Tasks—Full............................................................................ 27

Create Staging Directory for RMS Installer................................................................................. 27

Run the RMS Installer....................................................................................................................... 28

Resolving Errors Encountered During Batch Installation...................................................... 29

Manual Steps for Running script ld_iindfiles.ksh................................................................... 29

RETL....................................................................................................................................................... 30

5 Application Server Installation Tasks – Full........................................................ 31

Middleware Infrastructure and WebLogic Server12c (12.2.1.0.0) Installation................. 31

Install RCU Database Schemas...................................................................................................... 42

Create a New ADF Domain (with managed server and EM)................................................. 50

Start the Node Manager.................................................................................................................... 65

Start the AdminServer (admin console)....................................................................................... 65

Start the Managed Server.................................................................................................................. 66

Configuration of OID LDAP Provider in WebLogic Domain:............................................... 66

Verify OID Authenticator......................................................................................................... 72

Configure Oracle Single Sign-On................................................................................................... 73

Create mds-CustomPortalDS Datasource using console........................................................ 74

Load LDIF Files in LDAP................................................................................................................. 77

Oracle Retail Application Administration Console................................................................. 78

Clustered Installations – Preinstallation Steps......................................................................... 79

Create Staging Directory for RMS Application Server Files................................................... 79

Run the RMS Application Installation......................................................................................... 79

RMS Application – Post installation Steps................................................................................. 80

Resolving Errors Encountered During Application Installation......................................... 81

Test the RMS Application................................................................................................................ 81

Single Sign-On..................................................................................................................................... 81

Clustered Installations – Post-Installation Steps...................................................................... 82

RMS Reports Copied by the Application Installation............................................................. 82

BDI Job Admin install........................................................................................................................ 82

6 Oracle BI EE Configuration for RMS Reports...................................................... 85

BI Server Component Installation Tasks...................................................................................... 85

Installation Process Overview................................................................................................ 85

Post Install Steps for OBIEE 12C............................................................................................ 86

Installing the RMS BI Publisher Templates........................................................................ 91

Configuring the RMS JDBC connection............................................................................... 91

Part II: Upgrade Installation..................................................................................... 95

7 Database Installation Tasks – Upgrade................................................................ 97

Upgrade RMS Database using the Installer................................................................................ 97

Create Staging Directory for RMS Database Schema Files............................................. 98

Optional: Analyze Changes in the Patch.................................................................................... 98

Run the Allocation Data Cleanup Scripts........................................................................... 99

Create the Database User for BDI RMS INT SCHEMA.................................................... 99

Create the Database User for BDI_RMS_INFR_SCHEMA............................................. 99

Run the below RAF seed data script prior to running 16.0 upgrade in RMS main schema 99

Drop the Database User RMS_ASYNC_USER for clients upgrading from 15.0.1 to 16.0 100

Run the RMS Database Schema Upgrade......................................................................... 100

Resolving Errors Encountered During Database Schema Installation.................... 102

8 Batch Installation Tasks—Upgrade................................................................... 103

Create Staging Directory for RMS Installer....................................................................... 103

(Optional) Analyze Changes in the Patch................................................................................ 104

Run the RMS Installer..................................................................................................................... 104

Resolving Errors Encountered During Batch Installation................................................... 105

Manual Steps for Running script ld_iindfiles.ksh................................................................. 106

9 Application Server Installation Tasks – Upgrade............................................... 107

10 Reports Installation Tasks – Upgrade................................................................ 109

Installing the RMS BI Publisher Templates...................................................................... 109

11 Data Migration................................................................................................... 111

Create Staging Directory for RMS Data Migration Files....................................................... 111

Configure RMS Data Migration Tool.................................................................................. 111

Run the RMS Data Migration Tool...................................................................................... 112

12 Web Services Installation.................................................................................. 115

Set up Environment................................................................................................................. 115

Grant permissions to RMS Database Schema.................................................................. 116

13 Patching Procedures......................................................................................... 117

Oracle Retail Patching Process..................................................................................................... 117

Supported Products and Technologies...................................................................................... 117

Patch Concepts.................................................................................................................................. 118

Patching Utility Overview..................................................................................................... 119

Changes with 16.0.................................................................................................................... 119

Patching Considerations................................................................................................................ 119

Patch Types................................................................................................................................ 119

Incremental Patch Structure.................................................................................................. 120

Version Tracking...................................................................................................................... 120

Apply all Patches with Installer or ORPatch................................................................... 120

Environment Configuration.................................................................................................. 120

Retained Installation Files..................................................................................................... 121

Reloading Content................................................................................................................... 121

Java Hotfixes and Cumulative Patches.............................................................................. 121

Backups....................................................................................................................................... 121

Disk Space.................................................................................................................................. 122

Patching Operations........................................................................................................................ 123

Running ORPatch.................................................................................................................... 123

Merging Patches....................................................................................................................... 132

Compiling Application Components................................................................................. 134

Deploying Application Components................................................................................. 135

Maintenance Considerations........................................................................................................ 137

Database Password Changes............................................................................................... 137

WebLogic Password Changes.............................................................................................. 137

Infrastructure Directory Changes........................................................................................ 138

DBManifest Table..................................................................................................................... 138

RETAIL_HOME relationship to Database and Application Server.......................... 139

Jar Signing Configuration Maintenance............................................................................ 139

Customization................................................................................................................................... 140

Patching Considerations with Customized Files and Objects.................................... 140

Registering Customized Files............................................................................................... 141

Custom Compiled Java Code................................................................................................ 143

Extending Oracle Retail Patch Assistant with Custom Hooks................................... 145

Troubleshooting Patching............................................................................................................. 150

ORPatch Log Files.................................................................................................................... 150

Restarting ORPatch................................................................................................................. 150

Manual DBManifest Updates............................................................................................... 150

Manual Restart State File Updates...................................................................................... 152

DISPLAY Settings When Compiling Forms..................................................................... 152

JAVA_HOME Setting.............................................................................................................. 152

Patching Prior to First Install................................................................................................ 152

Providing Metadata to Oracle Support.............................................................................. 153

A Appendix: Oracle 12cR1 Database Parameter File.............................................. 155

B Appendix: Configure Listener for External Procedures...................................... 157

C Appendix: Tablespace Creation......................................................................... 159

Non-Encrypted Tablespace Creation......................................................................................... 159

Encrypted Tablespace Creation................................................................................................... 159

Configure a Wallet................................................................................................................... 159

Encryption at Tablespace Level........................................................................................... 160

D Appendix: RMS RETL Instructions.................................................................... 163

Configuration: RETL....................................................................................................................... 163

E Appendix: Oracle Trade Management System Expectations.............................. 167

Installation Scripts (elc_comp_post_htsupld.sql).................................................................. 167

HTS Upload / Mass Update......................................................................................................... 169

Calculation of Merchandise Processing Fee..................................................................... 170

Unit of Measure Conversions............................................................................................... 170

Customs Entry Ref. Status...................................................................................................... 170

Customs Entry Totals.............................................................................................................. 171

F Appendix: RMS Database Schema and Batch Installation Screens.................... 173

G Appendix: RMS Application Installer Screens................................................... 215

H Appendix: RMS Analyze Tool............................................................................ 237

Run the RMS Analyze Tool........................................................................................................... 237

I Appendix: Installer Silent Mode........................................................................ 239

J Appendix: URL Reference.................................................................................. 240

JDBC URL for a Database............................................................................................................... 240

K Appendix: Common Installation Errors............................................................. 241

Database Installer Hangs on Startup......................................................................................... 241

Warning: Could Not Find X Input Context.............................................................................. 241

Unresponsive Country and Currency Drop-Downs.............................................................. 242

Could Not Execl Robot Child Process: Permission Denied................................................. 243

ConcurrentModificationException in Installer GUI.............................................................. 243

ORA-04031 (Unable to Allocate Memory) Error During Database Schema Installation 243

RIB Errors............................................................................................................................................ 244

Error Connecting to Database URL............................................................................................. 244

Multi-Threaded OCI Client Dumps Core after Reconnecting To Database.................... 244

Error Compiling Batch.................................................................................................................... 245

L Appendix: Single Sign-On for WebLogic........................................................... 247

What Do I Need for Single Sign-On?.......................................................................................... 247

Can Oracle Access Manager Work with Other SSO Implementations?........................... 247

Oracle Single Sign-on Terms and Definitions.......................................................................... 248

What Single Sign-On is not........................................................................................................... 249

How Oracle Single Sign-On Works............................................................................................. 249

Installation Overview...................................................................................................................... 251

User Management............................................................................................................................ 251

M Appendix: AIX Shared Library Bug Fix.............................................................. 253

N Appendix: Setting Up Password Stores with wallets/credential stores............... 255

About Database Password Stores and Oracle Wallet............................................................ 255

Setting Up Password Stores for Database User Accounts.................................................... 256

Setting up Wallets for Database User Accounts...................................................................... 257

For RMS, RWMS, RPM Batch using sqlplus or sqlldr, RETL, RMS, and RWMS.. 257

Setting up RETL Wallets................................................................................................................ 259

For Java Applications (SIM, ReIM, RPM, RIB, AIP, Alloc, ReSA, RETL).................. 260

How does the Wallet Relate to the Application?.................................................................... 263

How does the Wallet Relate to Java Batch Program use?..................................................... 263

Database Credential Store Administration............................................................................... 263

Managing Credentials with WSLT/OPSS Scripts.................................................................. 265

listCred........................................................................................................................................ 266

updateCred................................................................................................................................. 267

createCred................................................................................................................................... 268

deleteCred................................................................................................................................... 268

modifyBootStrapCredential................................................................................................... 268

addBootStrapCredential......................................................................................................... 270

Quick Guide for Retail Password Stores (db wallet, java wallet, DB credential stores) 271

O Appendix: Creating User Synonyms.................................................................. 281

P Appendix: Manual Batch Compilation............................................................... 283

Q Appendix: Installation Order............................................................................. 285

Enterprise Installation Order........................................................................................................ 285

Supported on	Versions Supported
Application Server OS	OS certified with Oracle Fusion Middleware 12.2.1.0.0 Options are: § Oracle Linux 6 and 7 for x86-64 (Actual hardware or Oracle virtual machine). § Red Hat Enterprise Linux 6 and 7 for x86-64 (Actual hardware or Oracle virtual machine). § AIX 7.1 (Actual hardware or LPARs) § Solaris 11.x SPARC (Actual hardware or logical domains) § HP-UX 11.31 Integrity (Actual hardware, HPVM, or vPars)
Application Server	Oracle Fusion Middleware 12.2.1.0.0 Components: § FMW 12.2.1.0.0 Infrastructure (WLS and ADF included) § Oracle Identity Management 11g Release 1 (11.1.1.9) § Oracle Enterprise Manager Fusion Middleware Control 12.2.1.0 Note: Oracle Internet Directory (OID) is the supported LDAP directory for Oracle Retail products. For alternate LDAP directories, refer to Oracle WebLogic documentation set. Java: § JDK 1.8+ 64 bit § BI Publisher 12.2.1.0.0 for legacy reports Optional (required for SSO) § Oracle WebTier (12.2.1.0.0) Oracle Access Manager 11g Release 2 (11.1.2.3) Note: A separate WebLogic 10.3.6 installation is required for Oracle Access Manager 11.1.2.3 Optional (for running RMS batch from Application Server) § Oracle Client 12.1.0.2_PSUx (including its dependencies) Note: Oracle supports running RMS batch from the Application Server. Customers may choose this option, but should be aware that we recommend App and DB servers are co-located to reduce latency between the servers.

Database Installation Tasks—Full

This chapter describes the tasks required for a full database installation.

Note: If the RMS 15.0.1 software is already installed, please see Database Installation Tasks—Upgrade for information on Upgrading to RMS 16.0.

Data Access Schema

Data Access Schema (DAS) exposes a subset of core RMS data to external applications via database replication. DAS allows these applications read only access RMS data as they need it. The use of a separate schema insulates core RMS processes from outside requests for information. If you choose to implement the DAS schema, execute the DDL scripts included in the upcoming sections.

RMS Database Schema Distribution – Oracle Retail Applications Included

The RMS 16.0 release contains an installer package that can be used to install the database objects for the following products: RMS, ReSA, RTM, RPM, ReIM, and Allocation.

Note: The Java application installers for RPM, ReIM, ReSA and Allocation are separately downloadable under their respective products. It is only the database schema component of these applications that is included with the RMS release.

Create Staging Directory for RMS Installer

To create the staging directory for RMS installer, complete the following steps.

Note: The same installer can be used to install multiple RMS components. If you are installing any of the RMS components (Database, Batch, or Application) on the same server, they can use the same installer and this step does not need to be repeated.

1. Log into the database server as a user that can connect to the RMS database.

2. Create a staging directory for the RMS installation software.

3. Copy the rms16installer.zip file from the RMS 16.0 release to the staging directory. This is referred to as STAGING_DIR when installing database software.

4. Change directories to STAGING_DIR and extract the rms16installer.zip file. This creates an rms/installer/ subdirectory under STAGING_DIR.

Note: The DB Schema and Batch install can be run at the same time, with the same installer, since they are configured to run from the database server. To run both, please follow instructions from the DB Schema Full install and Batch Full install sections of the install guide. This will ensure that both DB Schema and batch have the same RETAIL_HOME. When running the installer, select the Install Schema and Install batch check boxes.

Establish a Database Partitioning Strategy

Partitioning is mandatory for specific tables. Review this entire section before proceeding with the installation.

Note: Ensure the installer is used to automatically run the partition.ksh script when using the Sample Partitioning strategy. Do not run partion.ksh manually unless steps 1 and 2 below have been completed fully for the tables you wanted partitioned.

Sample Partitioning

The RMS 16.0 database schema installation runs the partitioning script (partition.ksh) automatically using a sample partitioning strategy if you do not run the partition script yourself. This is acceptable for development or demo installations and allows for a simpler installation. However, the resulting partitioning strategy is not suitable for production environments. It is highly recommended that the Production Partitioning section below be followed rather than allowing the installer to implement the sample strategy. The installer can be used to install the RMS database schema regardless of the choice made here.

Production Partitioning

Requirements for mandatory and optional partitioning are defined in the Microsoft Excel spreadsheet located in STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/source/RMS_partition_definition.xlsx. Since partitioning strategies are complex, this step should be implemented by an experienced individual who has a thorough understanding of partitioning principles and the data to be partitioned.

Use the Microsoft Excel spreadsheet to determine an appropriate partitioning strategy (STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/source/RMS_partition_definition.xlsx). The Partition Method column indicates the recommended partitioning options for each table. Refer to the information in this file to modify the DDL for partitioned tables. This can be done by manually changing the file STAGING_DIR/rms/installer/mom/Cross_Pillar/ddl/1_rms_tab_ddl.sql or by implementing the process defined below.. This file will be used later in the installation process.

Note: Refer to Oracle Database Concepts 12 c Release 1 (12.1) Chapter 4 “Partitions, Views, and Other Schema Objects” for further details regarding partitioning concepts.

Beginning with hash partitions, complete the following process.

Hash partitions: To calculate the number of hash partitions and sub-partitions, enter values for the three parameters highlighted in yellow at the top of the RMS worksheet. Altering these values will update the Number of Partitions column for HASH partitioned/sub-partitioned tables. The values in these columns indicate the number of hash partitions/sub-partitions to create. Keep in mind that the number of hash partitions should be a power of 2.

Partition Factor: This value is used to adjust the number of hash partitions. It is based on the number of active items per location and transactions per location/day. If the number of items/location and/or transactions/store/day is low, the value of partition factor should be high. This will calculate fewer hash partitions. The typical factor value ranges from 2 to 4; in come cases, it can be 10 or more.

Note: Changing the items/location and transactions/store/day fields on the worksheet does not automatically impact the factor value. They are used as a point of reference only.

Sub-Partition Factor: This value is used to adjust the number of hash sub-partitions. The partition strategy for historical information determines the value of this number. If the number of range partitions is high, the value of sub-partition factor should be high to control the number of sub-partitions. Typically, this value is 2.

Locations: The total number of active stores and warehouses.

Range partitions: Determine the purging strategy for all of the tables that are RANGE partitioned. Each partition should have a range of multiple key values. For example, if the strategy were to have data available for one year and to purge it every three months, five partitions would be created. In this case, four 3-month partitions and a max value partition to contain all data greater than the defined ranges would result. Refer to the Comments column and update the value in the Number of Partitions column. The value in this column indicates the number of range partitions to create.

Interval partitions: Interval partitioning is an extension of range partitioning wherein the database automatically creates interval partitions as data for that partition is inserted. Determine the purging strategy for all of the tables that are INTERVAL partitioned. Each partition should have a range of multiple key values. For example, if the strategy were to have data available for 90 days and to purge it every week, you can create one 7 day partition, with an interval of 7 days. In this case, one 7 day partition would be created and any data that is inserted past the initial 7 day range will have a new partition automatically create to store the new data. Refer to the Comments column and update the value in the Number of Partitions column. The value in this column indicates the number of initial range partitions to create.

List partitions: The DAILY_ITEM_FORECAST, ITEM_FORECAST, DEAL_ITEMLOC_DCS, DEAL_ITEMLOC_DIV_GRP, DEAL_ITEMLOC_ITEM, AND DEAL_ITEMLOC_PARENT_DIFF must be LIST partitioned. If number of partition keys is relatively static, change the value in the Partition Method column to LIST where allowed. This method will ensure that each partition key has a separate partition and that none are empty. The Number of Partitions column will be automatically updated with the proper number of locations in the event the partition method is changed. The value in this column indicates the number of list partitions to create.

Step 1: Modify partition_attributes.cfg

Modify STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/source/partition_attributes.cfg based on the partitioning strategy defined in RMS_partition_definition.xlsx. Changes to this file should be made only as indicated.

partition_attributes.cfg file: (file is comma-delimited)

Sample Entry:

ITEM_LOC_HIST,EOW_DATE,RANGE,item_loc_hist.eow_date.date,64,LOC,HASH,item_loc_hist.loc.number,64,RETAIL_DATA

Field 1: Table Name - Do not modify

Field 2: Partition Key - Do not modify

Field 3: Partition Method - Modify based on value in Partition Method column in RMS_partition_definition.xlsx - Valid values are RANGE, LIST, HASH, or INTERVAL (case sensitive)

Field 4: Partition Data Definition Filename - Do not modify - This field is ignored if Partition Method is not RANGE or LIST or INTERVAL

Field 5: Partition Hash Count – Modify based on value in Hash Partitions Calculated column in RMS_partition_definition.xlsx. In case of INTERVAL partition, this field will contain a partition interval value (e.g. 7 days in one partition). This field is ignored if Partition Method is not HASH or INTERVAL.

Field 6: Interval Unit – Used and required for INTERVAL partition only. Expected values are 'DAY' or 'MONTH'.

Field 7: Sub-Partition Key - Do not modify

Field 8: Sub-Partition Method - Modify based on value in Sub-partition Method column in RMS_partition_definition.xlsx - Valid values are LIST or HASH (case sensitive)

Field 9: Sub-Partition Data Definition Filename - Do not modify - This field is ignored if Sub-Partition Method is not RANGE, LIST, or INTERVAL

Field 10: Sub-Partition Hash Count - Modify based on value in Hash Sub-partitions Calculated column in RMS_partition_definition.xls. This field is ignored if Sub-Partition Method is HASH

Field 11: Tablespace Name - Optional. Default is RETAIL_DATA

Step 2: Modify Data Definition Files

Tables partitioned or sub-partitioned by RANGE, INTERVAL or LIST have a corresponding data definition file in the STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/source/data_def” directory and should not be removed or renamed. These files are used to define the data boundaries for each partition. Values must be entered in each file based on the data type of the Partition Key column in RMS_partition_definition.xls. Refer to the Comments column in this file for additional information. The value in the Number of Partitions column indicates the number of entries to place in the data definition file. For INTERVAL partitioning, a single entry in the data definition file will be sufficient.

The format of a data definition file name is <table name>.<partition key column>.<partition key data type> (for example, item_loc_hist.eow_date.date). When placing data into these files, enter one data partition value per line.

When entering varchar2 values in a data definition file, do not use quotation marks. When defining date values, use the DDMMYYYY format.

sampletable.action_date.date:

01012004

01012005

sampletable.state.varchar2:

Minnesota

Iowa

sampletable.location.number:

1000

2000

When using RANGE partitioning, the data definition files will use the value less than concept. For example, in sampletable.action_date.date above, the first partition will contain all data less than 01012004. The second partition will contain all data greater than or equal to 01012004 and less than 01012005. A third MAXVALUE partition will automatically be created for all data greater than or equal to 01012005.

When using INTERVAL partitioning, the data definition file can be populated with one date entry to create the first range. Future partitions will be added automatically when data is inserted into the table for dates greater than the defined range and corresponding interval.

When using LIST partitioning, the data definition files will use the value equal to concept. For example, in sampletable.state.varchar2 above, the first partition will contain all data equal to Minnesota. The second partition will contain all data equal to Iowa.

Step 3: Generate DDL for DAS Tables – Run partition.ksh (Optional)

1. Copy STAGING_DIR/rms/installer/mom/Cross_Pillar/das_ddl/source/rms_das_ddl.sql to STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/rms_das.tab.

2. Execute STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/source/partition_das.ksh at the UNIX command prompt. This script reads configuration information from the partition_attributes.cfg file and generates the partitioned DDL file STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/ rms_das_part.tab. This file is used later during the installation process.

Sample output from partition.ksh:

STAGING_DIR/installer/mom/Cross_Pillar/partitioning/source > ./partition.ksh

########################################################################

# partition_das.ksh:

# This script will read the partition_attributes.cfg file and any referenced

# data definition files and generate partitioned DDL.

########################################################################

# The non-partitioned DDL file is ../rms_das.tab.

# The partitioned DDL file that will be generated is ../rms_das_part.tab.

########################################################################

Checking partition_attributes.cfg for errors

Generating Partitioned DDL for ITEM_LOC

Generating Partitioned DDL for ITEM_LOC_SOH

Partition_das.ksh has generated the DDL for partitioned tables in the ../rms_das_part.tab file.

Completed successfully

3. Copy STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/rms_das_part.tab to STAGING_DIR/rms/installer/mom/Cross_Pillar/das_ddl/source/rms_das_ddl.sql.

Step 4: Generate DDL for Tables – Run partition.ksh

1. Copy STAGING_DIR/rms/installer/mom/Cross_Pillar/ddl/1_rms_tab_ddl.sql to STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/rms.tab.

2. Execute STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/source/partition.ksh at the UNIX command prompt. This script reads configuration information from the partition_attributes.cfg file and generates the partitioned DDL file STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/rms_part.tab. This file is used later during the installation process.

Sample output from partition.ksh:

STAGING_DIR/installer/mom/Cross_Pillar/partitioning/source > ./partition.ksh

########################################################################

# partition.ksh:

# This script will read the partition_attributes.cfg file and any referenced

# data definition files and generate partitioned DDL.

########################################################################

# The non-partitioned DDL file is ../rms.tab.

# The partitioned DDL file that will be generated is ../rms_part.tab.

########################################################################

Checking partition_attributes.cfg for errors

Generating Partitioned DDL for DAILY_DATA

Generating Partitioned DDL for DAILY_ITEM_FORECAST

Generating Partitioned DDL for DAILY_SALES_DISCOUNT

…

partition.ksh has generated the DDL for partitioned tables in the ../rms_part.tab file.

Completed successfully

Create the RMS Database

It is assumed that Oracle Enterprise Edition 12c Release 1, with appropriate patches, has already been installed. If not, refer to Check Supported Database Server Requirements in Chapter 1 before proceeding. Additionally, STAGING_DIR in this section refers to the directory created in Create Staging Directory for RMS Database Schema Files in Part I, Chapter 1.

Review the Establish Database Partitioning Strategy section before continuing.

If a database has already been created, it is necessary to review the contents of this section to determine if all database components have been installed and configured properly. Also refer to appendices A, B, C in this document.

If a database instance has not been created, create one using database creation templates via DBCA in silent mode.

Create the Database Instance Using Oracle Generic Template

Prerequisites:

§ 12.1.0.2 binary must have already been installed along with the appropriate oneoff patches. Refer to the Database Server Preinstallation section for all the required oneoff patchesBackground

§ Oracle Retail no longer deliver custom database template files. Instead, databases can be created using the generic Oracle delivered template in the directory$ORACLE_HOME/assistant/dbca/template.

$ORACLE_HOME/assistantsdbca/templates>

--> ls -l General_Purpose.dbc

-rw-r--r-- 1 oracle rgbudba 4908 May 24 2013 General_Purpose.dbc

Instance Creation Using the Generic Template via DBCA

1. Ensure ORACLE_HOME and ORACLE_BASE is in the path:

export ORACLE_HOME=<Location for Oracle Home >

export ORACLE_BASE=<Location for Oracle Base>

export PATH=$ORACLE_HOME/bin:$PATH

.cd into $ORACLE_HOME/assistants/dbca/templates

2. Execute the following command to create an instance:

$ORACLE_HOME/bin/dbca -silent -createDatabase -templateName General_Purpose.dbc -gdbName DB_NAME -sid DB_SID -createAsContainerDatabase true -SysPassword oracle1 -SystemPassword oracle1 -emConfiguration NONE -datafileDestination <Datafile Location> -characterSet AL32UTF8 -nationalCharacterSet AL16UTF16 -redoLogFileSize 100 -initParams nls_date_format=DD-MON-RR,nls_language=AMERICAN,nls_calendar=GREGORIAN,fast_start_mttr_target=900

The above will create a container database using all the default parameters set by dbca. Please replace the pfile by taking a copy from Appendix: Oracle 12cR1 Database Parameter File but customize the values according to the need of your environment.

If you wish to create a non-container database, replace [-createAsContainerDatabase true] with [-createAsContainerDatabase false].

3. Execute the following command to create a pluggable database if this is a container environment:

CREATE PLUGGABLE DATABASE PDB_NAME ADMIN USER PDBADMIN

IDENTIFIED BY pdbadmin_pwd ROLES=(CONNECT) file_name_convert=('<Old Locationof PDB Datafiles>','<New Location for PDB Datafiles>');

alter pluggable database pdb_name open;

alter system register;

4. Post Database Creation Setup

The above commands create a database with all files in one directory,. Please multiplex the redo logs and the control files following the OFA architecture.

5. Configure the listener and the tnsnames entry.

6. Log into the pluggable database to create the required tablespaces accordingly. For non-container databases, log into the database as normal to create the tablespaces.

Create Required RMS Tablespaces

Release 16.0 uses the tablespaces RETAIL_DATA, RETAIL_INDEX. ENCRYPTED_RETAIL_DATA and ENCRYPTED_RETAIL_INDEX.

The ENCRYPTED_RETAIL_DATA and ENCRYPTED_RETAIL_INDEX tablespaces hold data which may include Personally Identifiable Information data (PII Data). If you hold the Advanced Security Option license, you can choose to create these two tablespaces with TDE tablespace encryption to protect the PII data at rest. If you do not hold an Advanced Security Option license, you can create the tablespaces as normal tablespaces. The tablespace names must always be ENCRYPTED_RETAIL_DATA and ENCRYPTED_RETAIL_INDEX regardless of whether TDE encryption is used, because the table and index creation scripts look for these specific names.

1. Modify STAGING_DIR/rms/installer/create_db/create_rms_tablespaces.sql. The table below shows the default initial sizes.

2. Once this script has been modified, execute it in SQL*Plus as sys.

§ For Example: SQL> @create_rms_tablespaces.sql

3. Review create_rms_tablespaces.log for errors and correct as needed.

4. If you do not wish to use TDE tablespace encryption follow below steps else for TDE encryption skip to step 5.

a. Modify STAGING_DIR/rms/installer/create_db/create_encrypted_
tablespaces_no_TDE.sql.

b. Run the script using SQL*Plus as sys.

c. Review Create_encrypted_retail_tablespaces_no_TDE.log for errors and correct as needed.

5. If you hold an Advanced Security Option license and wish to use TDE tablespace encryption

a. Modify STAGING_DIR/rms/installer/create_db/create_encrypted_
tablespaces_TDE.sql.

b. Run the script using SQL*Plus as sys.

c. Review Create_encrypted_retail_tablespaces_TDE.log for errors and correct as needed.

d. Refer to Appendix: Tablespace Creation for details about how to create tablespaces in an encrypted format.

Note: The partitioning strategy determines the size of RMS tablespaces. Be aware that increasing the number of partitions may necessitate an increase in the size of the required tablespaces. It is important to be accurate when sizing tablespaces prior to the installation of RMS. Failure to do so results in “insufficient space” errors which require a complete re-install of RMS.

The standard tablespace scripts contain the DDL for creating the required tablespaces which can extend up to the following sizes:

TABLESPACE_NAME	Size
ENCRYPTED_RETAIL_INDEX	12G
ENCRYPTED_RETAIL_DATA	10G
RETAIL_INDEX	10G
RETAIL_DATA	8G
LOB_DATA	2G
USERS	2G

These sizes are sufficient if the initial values in the STAGING_DIR/rms/installer/mom/Cross_Pillar/partitioning/source/RMS_partition_definition.xls spreadsheet are used without modifications. Although using the initial values is not recommended for a production environment, it is possible to use them for the purpose of creating a small test environment. For additional assistance with production database sizing, please work with your implementation partner or contact Oracle Retail Consulting.

Create the Schema Owner for RMS

Create an Oracle schema that will own the RMS application.

Note: The RMS schema owner must be created prior to running the RMS database schema installation. The installer will validate this user before proceeding with installation.

1. Change directories to STAGING_DIR/rms/installer/create_db.

2. The create_user script relies on empty roles, being created. Log into sqlplus sys as sysdba and run the following commands to create the roles.

SQL> @create_roles.sql

3. Enter the following command to create the schema owner:

SQL> @create_user.sql

The following prompts will occur:

§ Schema Owner – the Oracle user that will own all RMS objects. Referred to in this install guide as RMS16DEV

§ Password – the password for RMS16DEV

§ Temp Tablespace – the temporary tablespace for RMS16DEV

4. Check the log file create_<Schema Owner>.lst for any errors.

Create the Database User for BDI RMS INT SCHEMA

1. Enter the following command to create the BDI RMS Integration Schema:

SQL>@create_bdi_int_user.sql

The following prompts will occur:

§ Please enter the BDI INT schema: The BDI RMS Integration Schema is referred to in this install guide as BDI_RMS_INT_SCHEMA

§ Please enter the password for the user: the password for BDI_RMS_INT_SCHEMA user

§ Please enter the the temporary tablespace for the user: the temporary tablespace for BDI_RMS_INT_SCHEMA

2. Check the log file create_BDI_RMS_INT_SCHEMA.lst for any errors.

Create the Database User for BDI_RMS_INFR_SCHEMA

1. Enter the following command to create the BDI RMS Infrastructure Schema

SQL>@create_bdi_infr_user.sql

The following prompts will occur:

§ Please enter the BDI INFR schema: The BDI RMS Infrastructure Schema is referred to in this install guide as BDI_RMS_INFR_SCHEMA

§ Please enter the password for the user: the password for BDI_RMS_INFR_SCHEMA user

§ Please enter the the temporary tablespace for the user: the temporary tablespace for BDI_RMS_INFR_SCHEMA

2. Check the log file create_BDI_RMS_INFR_SCHEMA.lst for any errors.

Create the Database User for Allocation (Optional)

1. To create the database user for where Allocation temporary tables will be stored, complete the following steps.

2. Change directories to STAGING_DIR/rms/installer/create_db

3. Log into sqlplus as sysdba and run the following command:

SQL> @create_user_generic.sql

The following prompts will occur:

§ Schema Name – The name of the Allocation database user. Referred to in this install guide as ALLOC16DEV

§ Password – the password for ALLOC16DEV

§ Temp Tablespace – the temporary tablespace for ALLOC16DEV

Create the Database User for Demo Data (Optional)

The RMS demo data user is only required if you will be seeding RMS during installation with optional demo data. To create the demo data user, complete the following steps.

1. Change directories to STAGING_DIR/rms/installer/create_db

2. Log into sqlplus as sysdba and run the following command:

SQL>@create_user_generic.sql

The following prompts will occur:

§ Schema Name – The name of the Demo database user. Referred to in this install guide as RMS16DEMO

§ Password – the password for RMS16DEMO

§ Temp Tablespace – the temporary tablespace for RMS16DEMO

Create the Database User for DAS (Optional)

The RMS DAS user is only required if you will be setting up a DAS schema. Additional configuration of data replication will be required after installation. Note that the DAS user must be created in a different database from RMS. To create the DAS user, complete the following steps:

1. Change directories to STAGING_DIR/rms/installer/create_db

2. Log into sqlplus as sysdba and run the following command:

SQL> @create_user.sql

The following prompts will occur:

§ Schema Name – The name of the DAS database user. Referred to in this install guide as RMS16DAS

§ Password – the password for RMS16DAS

§ Temp Tablespace – the temporary tablespace for RMS16DAS

Run the RMS Database Schema Installation

Note: See Appendix: RMS Database Schema Installer Screens for details on the RMS Database Schema installation screens and fields in the installer.

Note: It is recommended, but not required, that the Schema and Batch installation be done at the same time and use the same path for RETAIL_HOME. See next section for batch installation steps

Note: If dynamic hierarchy is being used, as a pre-installation task, update the script <STAGING_DIR>/rms/installer/mom/Cross_Pillar/control_scripts/source/dynamic_hier_token_map.sql and its language files <STAGING_DIR>/rms/installer/mom/Cross_Pillar/languages/xx/dynamic_hier_token_map_xx.sql to provide the client name value. Refer to Merch Implementation guide for details on dynamic hierarchy.

1. Change directories to STAGING_DIR/rms/installer.

2. Source the oraenv script to set up the Oracle environment variables (ORACLE_HOME, ORACLE_SID, PATH, etc).

Example: prompt$ . oraenv

ORACLE_SID = [] ? mydb

prompt$

3. Verify the ORACLE_HOME and ORACLE_SID variables after running this script.

Example: prompt$ echo $ORACLE_HOME

/u00/oracle/product/mydbversion

prompt$ echo $ORACLE_SID

mydb

4. Set and export the following environment variables. These variables are needed in addition to the environment variables set by the oraenv script above.

Variable	Description	Example
JAVA_HOME	Java home needed to run the GUI. Java 1.8 is required	JAVA_HOME=/usr/java/jdk1.8.64bit export JAVA_HOME
NLS_LANG	Locale setting for Oracle database client	NLS_LANG=AMERICAN_AMERICA.AL32UTF8 export NLS_LANG
DISPLAY	Address and port of X server on desktop system of user running install. Optional for dbschema installation	DISPLAY=<IP address>:0.0 export DISPLAY

Note: Unset NLS_DATE_FORMAT before running the installer. If NLS_DATE_FORMAT is set as YYYY-MM-DD:HH24:MI:SS, the installer will fail.

5. If you are going to run the installer in GUI mode using an X server, you need to have the XTEST extension enabled. This setting is not always enabled by default in your X server. See Appendix: Common Installation Errors for more details.

6. Run the install.sh script to start the installer.

Note: Below are the usage details for install.sh. The typical usage for GUI mode is no arguments.

./install.sh [text | silent]

7. Verify that the installer reports “SUCCESS” for the Database Preinstall Check. If it reports “FAILED,” check for errors in the output under the “Checking environment for Database installation” section, and verify that your environment variables are set properly.

8. For the initial RMS database installation select the Full option on the Full Install or Patch screen. If you are upgrading a previous install the Patch option will be used. See Part II: Upgrade Installation, Chapter 1: Database Installation Tasks - Upgrade.

9. Check the Install DB Objects checkbox and continue with installer. If the Batch and Database objects reside on the same RETAIL_HOME then click on the Batch also.

10. The RMS Installer provides the option of installing the Invoice Matching (ReIM) and Allocation database objects in addition to the RMS objects.

11. After the installer is complete, you can check its log file: rms-install.<timestamp>.log.

12. The installer leaves behind the ant.install.properties file for future reference and repeat installations. This file contains inputs you provided. As a security precaution, make sure that the file has restrictive permissions.

Example: chmod 600 ant.install.properties

Values to Remember for the Batch and Application Installation

If the RMS batch and application components will be installed separately, you will want to remember the database username and password details in order to correctly complete the RMS batch and application installations.

Resolving Errors Encountered During Database Schema Installation

If the installer encounters any errors, it halts execution immediately and prints to the screen which SQL script it was running when the error occurred. Please view the log files in $RETAIL_HOME/orpatch/logs. Additional error information for invalid objects can be found in $RETAIL_HOME/orpatch/logs/detail_logs/dbsql_{schema}/invalids. The {schema} refers to rms, rmsbdiint, raf, reim, rpm, alloc, rmsdasSee Appendix: Common Installation Errors in this document for a list of common installation errors.

Subsequent executions of the installer skip the SQL scripts which have already been executed in previous installer runs. This is possible because the installer maintains entries in a table called DBMANIFEST of the scripts that have been run. It also p.54 - maintains an orpatch_restart.state file when the install restarts.

In case if you decided to drop the schemas and start the install from scratch, then make sure the RETAIL_HOME is also removed.

Set Up Additional RMS Users

1. Few sample scripts to create application roles and database user are available in the following location: <STAGING_DIR>/rms/installer/mom/Cross_Pillar/utility_files. Review the scripts as per your company’s security regulation to restrict the access based on user responsibility.

§ create_ORMS_business_user_role.sql can be referred to create a new DB role having access to objects owned by the schema owner.

§ create_ORMS_business_user.sql can be referred to create a new DB user and granted the role created by create_ORMS_business_user_role.sql script.

§ create_roles.sql creates sample roles.

§ create_user_generic.sql is a generic script to create DB user having extensive access and are assigned the roles created using create_roles.sql

Note: Evaluate the use of multiple roles and assign appropriately to users, based on user responsibilities.

2. After users are set up, create synonyms to the owner schema for all tables, views, sequences, functions, procedures, packages and types to which the user has access.

3. For information, see “Appendix: Creating User Synonyms.”

Note: create_ORMS_business_user_role.sql and create_ORMS_business_user.sql can be referred to create RMS user with restricted privileges. Please refer to the Oracle Retail Merchandising Operations Management Security Guide for details.

Note: Users created with these scripts will be granted with selective privileges on each database object. A new object addition/patch that contains new objects will need attention from customer database administrator. Either grant selective privileges to the individual database objects or re-create the role with create_ORMS_business_user_role.sql which will grant privileges to new objects for the users.

PRODUCT_VERS_CONFIG_OPTIONS

1. Run the ad-hoc script as RMS Schema Owner STAGING_DIR/rms/installer /mom/Cross_Pillar/install_scripts/source/sys_update_prod_vers.sql to update the PRODUCT_VERS_CONFIG_OPTIONS table. It updates the patch version of the other MOM products installed if any. It accepts seven values as user input:

§ first input as Allocation version

§ second input as RWMS version

§ third input as REIM version

§ fourth input as SIM version

§ fifth input as AIP version

§ sixth input as RPM version

§ seventh input as ReSA version

Batch Security Setup

If RMS was installed without DEMO Data, additional data setup is required to be able to run batch programs. USER_ATTRIB, SEC_USER, SEC_GROUP, and SEC_USER_GROUP need to be populated using the below scripts.

1. Log on to sqlplus as the RMS schema owner.

2. Insert row into USER_ATTRIB table.

3. Insert into SEC_GROUP and entry for Super Group:

@<STAGING_DIR>/rms/installer/create_db/superGroup.sql

4. Insert the following row into SEC_USER and SEC_USER_GROUP for the schema owner:

@<STAGING_DIR>/rms/installer/create_db/superUser.sql

Adding a User to the RPM Application

For LDAP authentication of RPM, complete the following steps to insert the user into the RMS schema.

1. Change directories to STAGING_DIR /rms/installer/mom/rpm-db/install_scripts

2. Log on to sqlplus as the RMS schema owner.

3. Run the following script to insert row to database table:

@RSM_RPM_SE_user_role.sql <username>;

Example: @RSM_RPM_SE_user_role.sql RETAIL.USER;

Application Server Installation Tasks – Full

Before proceeding, you must install Oracle WebLogic Server 12.2.1.0.0 with ADF and any patches listed in the Chapter 1 of this document. The Oracle Retail Merchandising System is deployed to a WebLogic Managed server within the WebLogic installation. It is assumed Oracle Database has already been configured and loaded with the appropriate schemas for your installation.

Installing a separate domain is mandated. It can be called “RMSDomain” (or something similar) and will be used to install the managed servers. The ADF libraries should be extended to this domain and the Enterprise Manager application should be deployed.

Note: If this domain is to be setup in a secure mode. Please set up weblogic as SSL and refer to ORACLE Retail Merchandising Security Guide for details on all items to change to be in secure mode. This would best be done before domain and application install. The domain example below is for unsecured setup.

Middleware Infrastructure and WebLogic Server12c (12.2.1.0.0) Installation

Create a directory to install the WebLogic (this will be the ORACLE_HOME):

Example: mkdir -p /u00/webadmin/products/wls_retail

1. Set the ORACLE_HOME, JAVA_HOME, and DOMAIN_HOME environment variables:

§ ORACLE_HOME should point to your WebLogic installation.

§ JAVA_HOME should point to the Java JDK 1.8+. This is typically the same JDK which is being used by the WebLogic domain where application is getting installed.

Example:

$ export ORACLE_HOME=/u00/webadmin/products/wls_retail

$ export JAVA_HOME=/u00/webadmin/products/jdk_java

(This should point to the Java which is installed on your server)

$ export PATH=$JAVA_HOME/bin:$PATH

Going forward we will use the above references for further installations.

2. Go to location where the weblogic jar is downloaded and run the installer using the following command:

java -jar ./fmw_12.2.1.0.0_infrastructure.jar

3. Welcome screen appears. Click Next.

4. Click Next.

5. Enter the following and click Next.

Oracle home =<Path to the ORACLE_HOME>

Example:

/u00/webadmin/products/wls_retail

6. Select install type ‘Fusion Middleware Infrastructure’. Click Next.

This screen will verify that the system meets the minimum necessary requirements.

7. Click Next.

8. If you already have an Oracle Support account, use this screen to indicate how you would like to receive security updates.

9. If you do not have one or if you want to skip this step, clear the check box and verify your selection in the follow-up dialog box.

10. Click Next.

11. Click Next.

12. Click Next.

13. Click Yes, if you wish to remain uninformed of security issues in your configuration.

14. Click Install.

15. Click ‘Next’.

16. Click Finish.

Install RCU Database Schemas

The RCU database schemas are required for the installation of configuration of domain and retail application.

Note: Need user which have sys admin privileges to install the RCU database schemas.

The following steps are provided for the creation of the database schemas:

1. Navigate to the directory into which RCU is installed. For example:

<ORACLE_HOME>/oracle_common/bin/

Run “./rcu”

2. Click Next.

3. Select Create Repository and System Load and Product Load. Click Next.

4. Enter database connection details:

§ Database Type: Oracle Database

§ Host Name: dbhostname.us.oracle.com

§ Port: 1521

§ Service Name: dbservicename

§ Username: sys

§ Password: <syspassword>

§ Role: SYSDBA

5. Click Next. The Installer checks prerequisites.

6. When the prerequisite checks are complete, click OK. Click Next.

7. Click the Create a new prefix option, the prefix name for your schemas should be unique to your application environment.

Example: RMS, ALLOC, ReSA, etc

8. Select the components to create:

§ Meta Data Services

§ Oracle Platform Security Services

Note: Once OPSS schema is selected, the following dependent schemas will get selected automatically.

Audit Services

Audit Services Append

Audit Services Viewer

Note: STB schema will be already selected as part of the Common Infrastructure component.

9. Click Next.

10. Enter password of your choice.

Note: This password is needed at the time of ADF domain creation.

11. Provide the password and Click ‘Next’.

12. Click Next. A Repository Creation notification will appear. Click OK.

13. Tablespaces are created, and the progress will be displayed in a pop-up notification. When the operation is completed, click OK.

14. Click Create. The schema is created.

Upon successful creation of database schemas, a screen will appear with all the schemas created.

15. Click Close.

Create a New ADF Domain (with managed server and EM)

To create a new domain and managed server with ADF libraries and EM, follow the below steps:

1. Set the environemnt variables:

export JAVA_HOME=<JDK_HOME>

(Example:/u00/webadmin/products/jdk_java) [JDK_HOME is the location where jdk has been installed)

export PATH=$JAVA_HOME/bin:$PATH

export ORACLE_HOME=<ORACLE_HOME>/

(Example:/u00/webadmin/products/wls_retail/)

cd $ORACLE_HOME/oracle_common/common/bin

(ORACLE_HOMEis the location where Weblogic has been installed.)

2. Run the following command:

./config.sh

3. Select Create a new domain.

Domain location: Specify the path to the <DOMAIN_HOME>

Example: /u00/webadmin/config/domains/wls_retail/APPNAMEDomain

4. Click Next.

5. Select Create Domain Using Product Templates.

6. Check the following components:

Oracle Enterprise Manager

Oracle WSM Policy Manager

Note: When Oracle Enterprise Manager component is selected, the following dependent components are selected automatically:

Oracle JRF

Weblogic Coherence Cluster Extension

7. Click Next.

Application location: Application directory location. Example: /u00/webadmin/config/applications/wls_retail/APPNAMEDomain

8. Click Next.

9. Provide the WebLogic administrator credentials and click Next:

§ Username: weblogic

§ Password: <Password>

10. Select Domain Mode as Production and the JDK to use (as applicable) and click Next.

11. Select RCU Data.

§ Vendor: Oracle

§ DBMS/Service: dbservicename

§ Host Name: dbhostname.us.oracle.com

§ Port: 1521

§ Schema Owner: APPNAME_STB (Example: ALLOC_STB, ReSA_STB, etc)

§ Password: <Password>. This password which was used for RCU schema creation.

12. Click the Get RCU Configuration button.

13. Click Next.

14. Click Next and it will test to make sure it can connect to your datasources.

15. Click Next to continue

16. Select advanced configuration for:

§ Administration Server

§ Node manager

§ Managed Servers, Clusters and Coherence

§ Deployments and Services

17. Configure the Administration Server:

§ Server Name: <APP name>_AdminServer

§ Listen address: Appserver Hostname or IPAddress of the Appserver Host.

§ Listen port: <Port for Admin Server> Note: The port that is not already used.

§ Server Groups: Unspecified

18. Configure Node Manager:

§ Node manager type: Per domain default location

§ Username: weblogic

§ Password: <Password for weblogic>

19. Click the Add button.

§ Server Name: <appname-server>

§ Listen address: Appserver Hostname or IPAddress of the Appserver Host

§ Listen port: <Port for Managed Server> Note: The port used here must be a free port.

20. Server Groups: JRF-MAN-SVR

21. Skip Configure Clusters and click Next.

22. No change needed. Click Next.

23. Configure Machines

24. Select unix Machine :

25. Click the Add button.

§ Name: apphostname_MACHINE

§ Listen address: apphostname or IPAddress

§ Listen port: <Port for node manager> Note: The port used here must be a free port.

26. Assign the configured Admin server and managed servers to the new machine.

27. Target the “wsm-pm” deployment to APPNAME_AdminServer:

28. Click Next.

29. Click Create.

30. Click Next.

31. When the process completes, click Finish.

Start the Node Manager

1. Start the nodemanager from <DOMAIN_HOME>/bin using the following script:

nohup ./startNodeManager.sh &

Start the AdminServer (admin console)

1. Configure boot.properties for starting the Weblogic domain without prompting to username and password using the following command:

2. Create security folder at <DOMAIN_HOME>/servers/<AdminServer>/ and create boot.properties file under <DOMAIN_HOME>/servers/<AdminServer>/security

The file ‘boot.properties’ should have the following:

----------------------------------

username=weblogic

password=<password>

------------------------------------

In the above, the password value is the password of WebLogic domain which is given at the time of domain creation.

Save the boot.properties file and start WebLogic server.

3. Start the WebLogic Domain (Admin Server) from <DOMAIN_HOME> using the following:

nohup ./startWebLogic.sh &

Example:

nohup /u00/webadmin/config/domains/wls_retail/RPMdomain/ startWebLogic.sh &Access the Weblogic Admin console

Example: http://<HOST_NAME>:<ADMIN_PORT>/console

In the below screen, provide username=weblogic and password=<weblogic password>

Start the Managed Server

After NodeManager is started, the managed servers can be started via the admin console.

1. Navigate to Environments -> Servers and click the Control tab. Select rpm-server and click Start.

2. Managed Server should be up and running before configuring further steps

Configuration of OID LDAP Provider in WebLogic Domain:

Perform the following procedure to create LDAP providers in the domains created in the previous steps

1. Log in to the Administration Console.

http://<HOSTNAME>:<ADMIN_PORT>/console

2. In the Domain Structure frame, click Security Realms.

3. In the Realms table, click myrealm. The Settings for myrealm page is displayed.

4. Click the Providers tab.

5. Click Lock & Edit and then click New. The ‘Create a New Authentication Provider’ page is displayed.

6. Enter OIDAuthenticator in the Name field and select OracleInternetDirectoryAuthenticator as the type. Click OK.

7. All the providers are displayed. Click OID Authenticator. Settings of OID Authenticator are displayed.

8. Set the Control Flag field to SUFFICIENT and click Save.

9. From the Providers tab, click on DefaultAuthenticator -> Configuration tab -> Common tab. Update the Control Flag to SUFFICIENT.

10. Click Save.

11. From the Providers tab, click the “OIDAuthenticator” (you just created), in the configuration -> Provider Specific tab enter your LDAP connection details:

The values shown below are examples only. You should match the entries to your OID.

§ Host: <oidhost>

§ Port: <oidport>

§ Principal: cn=orcladmin

§ Credential: <password>

§ Confirm Credential: <password>

§ User Base DN: cn=users,dc=us,dc=oracle,dc=com

§ Enable ‘Use Retrieved User Name as principal.’

12. Modify the following:

§ Group Base DN: cn=Groups,dc=us,dc=oracle,dc=com

13. Check Propagate Cause For Login Exception

14. Click Save.

15. Click the Providers tab.

16. Click Reorder.

17. Move OIDAuthenticator to the top of the providers list.

18. Click OK.

19. Once your changes are saved, click Activate Changes.

20. Shutdown all servers and restart the admin server using startWebLogic.sh script.

Verify OID Authenticator

1. Log in to the Administration Console.

http://<HOST_NAME>:<ADMIN_PORT>/console/

2. In the Domain Structure frame, click Security Realms.

3. In the Realms table, click Default Realm Name. The Settings page is displayed.

4. Click the Providers tab. You must see the OID Provider in that list.

5. Click the Users and Groups tab to see a list of users and groups contained in the configured authentication providers.

Configure Oracle Single Sign-On

Note: This procédure is only needed if RMS application setting up using Single Sign On (SSO) authentication. This can be skipped if SSO is not going to be used. The Oracle Access Manager must be configured and the Oracle http server (Webtier and webgate) must be registered into the Oracle Access Manager.

(Webtier and webgate) must be registered into the Oracle Access Manager

1. Log into the WebLogic console.

2. Navigate to: security realms -> myrealm (default realm) -> providers.

3. Start a Lock and Edit session.

4. Click New provider.

5. Set the provider name (Default: OAMIdentityAsserter).

6. Click OK.

7. Open the new provider configuration.

8. Under Common, set the Control Flag to REQUIRED.

9. On the provider list, click Reorder.

10. Move the OAMIdentityAsserter to the top of the list, or above the DefaultAuthenticator.

a. Click OK.

b. Click Activate Changes.

c. Shutdown the domain.

d. Start the admin and managed servers for the domain.

Create mds-CustomPortalDS Datasource using console

Follow below steps to create mds-CustomPortal datasource using console:

1. Login to WebLogic Admin console with Administrator user credentials.

http://<HOST_NAME>:<ADMIN_PORT>/console

2. Take Lock & Edit and Navigate to ServicesàData Sources and click on NewàGeneric Data Source.

3. Provide mds-CustomPortalDS name, JNDI Name and Database Type.

4. Select Oracle’s (Thin) Driver Service connections and Click next. Input the details of Database Hostname, Port number and Service name. Provide Database username and password created during RCU installation. Click Next.

5. Click Test Configuration to test the DB connection and click Next.

6. Select Targets as Managed server and Admin Server. Click Next.

7. Click on Activate Changes and verify mds-CustomPortalDS exists in the Data Sources.

Load LDIF Files in LDAP

Note: In this section, the base DN “dn=us,dn=oracle,dn=com” is used as an example. Modify this value as per the organisation’s ldap settings.

The OID (Oracle Internet Directory 11.1.1.9) must be set up in order to perform the configuration of OID Authenticator in WebLogic Domain.

There are four LDIF files provided in the application zip under STAGING_DIR/ rms/installer/mom/ldifs

§ RGBU-oid-create-groups.ldif

§ RGBU-oid-create-users.ldif

§ RGBU-oid-delete-groups.ldif

§ RGBU-oid-delete-users.ldif

Note: You may use the existing users and existing groups if the enterprise users and groups are already available in the LDAP. The users provided in the LDIF files above may not be required to use the application. For more information, refer to the Retail Role Hierarchy section in the Implementing Functional Security of the Oracle Retail Merchandising system 16.0 Operation Guide.

The steps given below can be used to import the Groups and Users into the LDAP using the LDIF files ‘RGBU-oid-create-groups.ldif’ and ‘RGBU-oid-create-users.ldif’.

Note:If you are using the above LDIF files to set up the users and groups, you must update the ‘RGBU-oid-create-user.ldif’ LDIF file with your password for the ‘userpassword’ attribute for all the users mentioned in the RGBU-oid-create-user.ldif LDIF file. The changes must be done before importing the users LDIF file ‘RGBU-oid-create-users.ldif’ into the LDAP. Once the users are imported into the LDAP, remove the ‘userpassword’ attribute value from the LDIF file. Refer to the Oracle Internet Directory Administration Guide for OID password policies for setting up passwords.

User DN and Group DN values (example: dc=us,dc=oracle,dc=com) may need to be updated based on the DN values in your OID.

Once the LDIF files are updated for your configuration, the LDIF files can be loaded into LDAP using the ldapadd tool that is included in the OID installation. LDIF files can also be imported in other ways like ODSM.

For example to load RGBU-oid-create-users.ldif using ldapadd (this is done on the OID host)

export ORACLE_HOME=/u00/webadmin/products/wls_idm/ORACLE_IDM (this is the ORACLE_HOME of your OID install)

export PATH=$ORACLE_HOME/bin:$PATH

$ORACLE_HOME/bin/ldapadd –v –c –h <OID_HOST> -p 3060 –w <ORCLADMIN PASSWORD> -D “cn=orcladmin” –f RGBU-oid-create-users.ldif

The delete LDIF ‘RGBU-oid-delete-groups.ldif’ can be used as needed if you need to delete the groups created from the groups creation LDIF ‘RGBU-oid-create-groups.ldif’.

The delete LDIF ‘RGBU-oid-delete-users.ldif’ can be used if you need to delete the users created from the users LDIF file ‘RGBU-oid-create-users.ldif’.

Oracle Retail Application Administration Console

Oracle Retail Application Administration Console (RAAC) is a tool used by an administrator to manage application roles, manage the application navigator and manage notifications. It facilitates the customization of default RGBU role mappings to suit the retailer’s business role model. RAAC is deployed along with the RMS application and accessed from the user menu of the RMS application’s user interface.

Only the user with RMS Application Administrator privilege can access RAAC from the RMS application portal.

As part of the Retail Merchandising system install, RAAC gets installed with one default role RMS_APPLICATION_ADMINISTRATOR_JOB role. The same job role will also exist in RMS jazn-data.xml file. The below options can be used for the set up.

Option 1:

Create the RMS_APPLICATION_ADMINISTRATOR_JOB role in your LDAP and assign that role to a user who intends to execute the role mapping process.

Option 2:

Create a Job role in your LDAP and map the intended job role in the LDAP to the RMS_APPLICATION_ADMINISTRATOR_JOB role using enterprise manager.

Since the user is part of the RMS_APPLICATION_ADMINISTRATOR_JOB role, the user first access the RMS application app and then launch ORAAC for role mapping from the user menu of the RMS application.

Note: The RMS_APPLICATION_ADMINISTRATOR_JOB role must have been already created if using the sample LDIF files which are provided as part of the Retail Merchandising system Application zip file.

Clustered Installations – Preinstallation Steps

Skip this section if you are not clustering the application server.

8. Make sure that you are able to start and stop the managed servers that are part of the RMS Cluster from the WebLogic Admin Console.

There are no additional steps before running the installer for RMS.

Create Staging Directory for RMS Application Server Files

To create the staging directory for the RMS Installer, complete the following steps.

1. Log into the application server as the user who owns WebLogic Installation files.

2. Create a staging directory for the RMS application distribution (rms16installer.zip).

Example: /u00/webadmin/media/RMS

3. This location is referred as STAGING_DIR when installing application software.

4. Copy rms16installer.zip to staging directory and extract its contents.

Example: unzip rms16installer.zip

5. This will create rms/installer subdirectory under STAGING_DIR.

Run the RMS Application Installation

Note: See Appendix: RMS Application Installer Screens for details about the RMS application screens and fields in the installer.

Note: On the installer screen “RMS Application Deployment Details” The exact string “Rms” must be used for RMS to function properly with ORAAC. The default value of “rms” should not be used.

1. Log on to your application server as a user with read and write access to the WebLogic files.

2. Change directories to STAGING_DIR/rms/installer.

3. Set and export the following environment variables.

Variable	Description	Example
JAVA_HOME	Location of a Java 1.8 JDK.	JAVA_HOME= /u00/webadmin/java/jdk1.8 export JAVA_HOME
NLS_LANG	Locale setting for Oracle database client.	NLS_LANG=AMERICAN_AMERICA.AL32UTF8 export NLS_LANG
J2EE_DOMAIN_HOME	The location of the WebLogic domain (RMSDomain).	J2EE_DOMAIN_HOME=/u00/webadmin/config/domains/wls_retailRMSDomain export J2EE_DOMAIN_HOME
J2EE_ORACLE_HOME	The location of the WebLogic installation.	J2EE_ORACLE_HOME=/u00/webadmin/products/wls_retail. export J2EE_ORACLE_HOME
DISPLAY	Address and port of X server on desktop system of user running install. Optional when running the application installer	DISPLAY=<IP address>:0 export DISPLAY

4. Run the install.sh script to start the installer.

Note: Below are the usage details for install.sh. The typical usage for GUI mode is no arguments.

./install.sh [text | silent]

5. Verify that the installer reports “SUCCESS” for the WLS J2EE Preinstall Check preinstall check. If it reports “FAILED,” check for errors in the output under the “Checking environment for Application installation” section, and verify that your environment variables are set properly.

6. Check the Install Application checkbox and proceed with the installation.

7. After the installer is complete, you can check its log file in the “logs” directory: STAGING_DIR/rms/installer/logs/rms-install.<timestamp>.log. RETAIL_HOME/orpatch/logs/detail_log/{javaapp_*}

8. The installer leaves behind the ant.install.properties file for future reference and repeat installations. This file contains inputs you provided. As a security precaution, make sure that the file has restrictive permissions.

Example: chmod 600 ant.install.properties

RMS Application – Post installation Steps

1. Copy runtime12.jar from Database install library directory (<DB_HOME>/sqlj/lib) to <WEBLOGIC_DOMAIN_HOME>/lib directory. For example location, copy jar file from /u00/oracle/product/12.1.0.2/sqlj/lib to /u00/webadmin/config/domains/wls_retail/RMSDomain/lib

2. Configure JDBC connection pool maximum capacity value at least 150 in Weblogic Console for RmsDBDS and RetailPlatformDBDS Data Sources.

3. RMS Application server where the application is deployed should have at least 6GB of maximum JVM Heap size. Following are the configuration steps.

4. Login to RMS Weblogic Console and Click on EnvironmentàServersàrms-serveràConfigurationàServer Start tab

5. Add below lines in the Arguments box:

-Xms4096m –Xmx6144m

Note: The JVM Heap and MetaspaceSize values can be configured based on your Infrastructure to improve application performance. Above values are minimum required configurations.

6. Restart RMS WebLogic Domain servers including AdminServer.

Resolving Errors Encountered During Application Installation

If the application installer encounters any errors, it halts execution immediately. You can run the installer in silent mode so that you do not have to re-enter the settings for your environment. See Appendix: Installer Silent Mode in this document for instructions on silent mode.

See Appendix: Common Installation Errors in this document for a list of common installation errors.

Because the application installation is a full reinstall every time, any previous partial installations are overwritten by the successful installation.

Test the RMS Application

After the application installer completes you should have a working RMS application installation. To launch the application, open a web browser and go to http://<HOST_NAME>: <httpport>/Rms/faces/RmsHome

Examples:

§ http://apphost:app-server-port/ Rms/faces/RmsHome. You should use a user/password that you built in the previous section of this install guide “Load LDIF files in LDAP”.

The default, preloaded user supplied in the LDIF scripts for testing this installed application is RMS_ADMIN; the password is <the password which you have given in the LDIF file RGBU-oid-create-users.ldif as part of loading LDIF files into the LDAP>.

Single Sign-On

Skip this section if RMS is not used within an Oracle Single Sign-On environment.

Note: This section assumes the Oracle WebLogic Server has already been registered with the Oracle Access Manager (OAM) via the oamreg tool. See the Oracle Single Sign-On (OAM using webgate) documentation for details.

If RMS is being used in an Oracle Single Sign-On environment, then the RMS root context must be protected. Modify the following files.

mod_wl_ohs.conf located in

DOMAIN_HOME/config/fmwconfig/components/OHS/instances/instanceName

LoadModule weblogic_module "${ORACLE_HOME}/ohs/modules/mod_wl_ohs.so"

</IfModule>

WebLogicHost <weblogichostname>

WebLogicPort <rmsserverport>

WLCookieName RMSSESSIONID

SetHandler weblogic-handler

</Location>

WebLogicHost <weblogichostname>

WebLogicPort <rmsserverport>

WLCookieName RMSSESSIONID

SetHandler weblogic-handler

</Location>

WebLogicHost <weblogichostname>

WebLogicPort <rmsserverport>

WLCookieName RMSSESSIONID

SetHandler weblogic-handler

</Location>

Clustered Installations – Post-Installation Steps

If you are installing the RMS application to a clustered environment, there are some extra steps you need to take to complete the installation. In these instructions, the application server node with the ORACLE_HOME you used for the RMS application installation is referred to as master node. All other nodes are referred to as remote nodes.

Note: Do not copy the entire file from one node to another. Only copy the RMS entries modified in these files by the installer. There is node-specific information in this file that is different between ORACLE_HOME installations.

Copy runtime12.jar to all the remote nodes under domain lib location. <WEBLOGIC_DOMAIN_HOME>/lib

RMS Reports Copied by the Application Installation

The application installation copies RMS report files to $RETAIL_HOME /reports. These files should be installed into BI Publisher as documented in the RMS Reports chapter of this document.

BDI Job Admin install

1. Create a managed server for the RMS batch admin otherwise consider that this will be installed on the managed server created for Rms application deployment.

§ The managed server should have JRF templates and oracle WSm libraries targeted to it.

§ A simple way to do this is to clone the RMS server and give it different port number.

2. Extract the contents of the BdiEdgeAppJobAdminPak16.0.0ForRms16.0.0_eng_ga.zip from the RMS release in a staging directory.

Example:

cd /u00/webadmin/BDIRMS_EXTRACTOR_INSTALL

unzip *.zip

3. Update the /u00/webadmin/BDIRMS_EXTRACTOR_INSTALL /conf/deploymentenvinfo.json file. Update the data source and weblogic server information. See sample below: (NOTE: Managed server entry is same as Admin server in the example.)

Blue: data source

Yellow: Weblogic Admin server

Green: Managed server

{

"BdiJobAdminDeploymentEnvInfo": {

"DataSourceDef":{

"JobAdminDataSource":{

"dataSourceName":"RmsJobAdminDataSource",

"dataSourceClass":"oracle.jdbc.pool.OracleDataSource",

"dataSourceJndiName":"jdbc/RmsJobAdminDataSource",

"jdbcUrl":"jdbc:oracle:thin:@//<dbhost.example.com>:1522/pdborcl",

"jdbcUserAlias":"rmsJobAdminDataSourceUserAlias",

"jdbcUser":"GET_FROM_WALLET",

"jdbcPassword":"GET_FROM_WALLET"

"BatchInfraDataSource":{

"dataSourceName":"BatchInfraDataSource",

"dataSourceClass":"oracle.jdbc.xa.client.OracleXADataSource",

"dataSourceJndiName":"jdbc/BatchInfraDataSource",

"jdbcUrl":"jdbc:oracle:thin:@// <dbhost.example.com>:1522/pdborcl",

"jdbcUserAlias":"batchInfraDataSourceUserAlias",

"jdbcUser":"GET_FROM_WALLET",

"jdbcPassword":"GET_FROM_WALLET"

"JobXmlDataSource":{

"dataSourceName":"JobXmlDataSource",

"dataSourceClass":"oracle.jdbc.xa.client.OracleXADataSource",

"dataSourceJndiName":"jdbc/JobXmlDataSource",

"jdbcUrl":"jdbc:oracle:thin:@// <dbhost.example.com>:1522/pdborcl",

"jdbcUserAlias":"jobXmlDataSourceUserAlias",

"jdbcUser":"GET_FROM_WALLET",

"jdbcPassword":"GET_FROM_WALLET" },

"MiddlewareServerDef":{

"JobAdminAppServer": {

"weblogicDomainName": " RMS_BATCH_DOMAIN ",

"weblogicDomainHome": "/u00/webadmin/config/domains/wls_retail/ RMS_BATCH_DOMAIN ",

"weblogicDomainAdminServerUrl": "t3://msp00abx:7001",

"weblogicDomainAdminServerProtocol": "t3",

"weblogicDomainAdminServerHost": "msp00abx",

"weblogicDomainAdminServerPort": "7001",

"weblogicDomainAdminServerUserAlias": "bdiAppServerAdminServerUserAlias",

"weblogicDomainTargetManagedServerName": "BDI_EX_JOB_SERVER",

"jobAdminUiUrl":"http://msp00abx:7001/rms-batch-job-admin",

"jobAdminUiUserGroup":"RmsJobAdminGroup",

"jobAdminUiUserAlias":"rmsJobAdminUiUserAlias",

"jobAdminUiUser":"GET_FROM_WALLET",

"jobAdminUiPassword":"GET_FROM_WALLET",

"jobOperatorUiUserGroup":"RmsJobOperatorGroup",

"jobOperatorUiUserAlias":"rmsJobOperatorUiUserAlias",

"jobOperatorUiUser":"GET_FROM_WALLET",

"jobOperatorUiPassword":"GET_FROM_WALLET",

"jobMonitorUiUserGroup":"RmsJobMonitorGroup",

"jobMonitorUiUserAlias":"rmsJobMonitorUiUserAlias",

"jobMonitorUiUser":"GET_FROM_WALLET",

"jobMonitorUiPassword":"GET_FROM_WALLET"

}

"JobAdminApplication":{

"appName":"rms",

"JobAdminAppUses":[

"JobAdminDataSource",

"JobAdminAppServer"

]

}

4. Compile and Deploy the RMS bdi application using admin deployer script.

Example:

cd <root-directory>/rms-home/bin

./bdi-job-admin-deployer.sh -setup-credentials -deploy-job-admin-app

Output:

/rms-home/bin> ./bdi-job-admin-deployer.sh -setup-credentials -deploy-job-admin-app

Extracting jars from jps-wallet-all.

log4j:WARN No appenders could be found for logger (com.oracle.retail.integration.common.security.credential.CredentialStoreManager).

log4j:WARN Please initialize the log4j system properly.

Credential required for weblogicDomainAdminServerHost(msp00abx) weblogicDomainAdminServerPort(7001):

Enter username for alias (bdiAppServerAdminServerUserAlias):weblogic

Enter Password: <weblogic-password>

Credential required for jobAdminUiUrl(http://msp00abx:7001/rms-batch-job-admin):

Enter username for alias (rmsJobAdminUiUserAlias):rmsbatchadmin

Enter Password: <rms-batch-admin-password>

Credential required for jobOperatorUiUrl(http://mspdv217:9010/rms-batch-job-admin):

Enter username for alias (rmsJobOperatorUiUserAlias): rmsbatchoperator

Enter Password: <rms-batch-opr-password>

Credential required for jobMonitorUiUrl(http://mspdv217:9010/rms-batch-job-admin):

Enter username for alias (rmsJobMonitorUiUserAlias): rmsbatchmonitor

Enter Password: <rms-batch-mon-password>

Credential required for dataSource(jdbc/RmsJobAdminDataSource) jdbcUrl(jdbc:oracle:thin:@//<dbhost.example.com>:1521/qolsp38app):

Enter username for alias (rmsAppDataSourceUserAlias):bdi-rms-extractor-infra

Enter Password: <password>

Credential required for BatchInfraDataSource dataSource(jdbc/BatchInfraDataSource) jdbcUrl(jdbc:oracle:thin:@// <dbhost.example.com>:1521/qolsp38app):

Enter username for alias (batchInfraDataSourceUserAlias):batchinfra_wls

Enter Password: <password>

Credential required for JobXmlDataSource dataSource(jdbc/JobXmlDataSource) jdbcUrl(jdbc:oracle:thin:@// <dbhost.example.com>:1521/qolsp38app):

Enter username for alias (jobXmlDataSourceUserAlias): rms01app

Enter Password: <password>

5. When finished, bounce the WebLogic domain. And launch the application using the path (http://<host>:<port>/rms-batch-job-admin).

Patching Procedures

Oracle Retail Patching Process

The patching process for many Oracle Retail products has been substantially revised from prior releases. Automated tools are available to reduce the amount of manual steps when applying patches. To support and complement this automation, more information about the environment is now tracked and retained between patches. This information is used to allow subsequent patches to identify and skip changes which have already been made to the environment. For example, the patching process uses a database manifest table to skip database change scripts which have already been executed.

The enhanced product patching process incorporates the following:

§ Utilities to automate the application of Oracle Retail patches to environments.

§ Unified patches so that a single patch can be applied against Database, Forms, Java applications, Batch, etc. installations.

§ Database and Environment manifests track versions of files at a module level.

§ Centralized configuration distinguishes installation types (Database, Forms, Java, Batch, etc.).

§ Patch inventory tracks the patches applied to an environment.

These enhancements make installing and updating Oracle Retail product installations easier and reduce opportunities for mistakes. Some of these changes add additional considerations to patching and maintaining Oracle Retail product environments. Additional details on these considerations are found in later sections.

Supported Products and Technologies

Several products and technologies are supported by the enhanced patching process. The utilities, processes and procedures described here are supported with the following products and listed technologies:

Product	Supported Technology
Oracle Retail Merchandising System (RMS)	§ Database scripts § Batch scripts § RETL scripts § Data Conversion Scripts § BI Publisher Reports § Java Application
Oracle Retail Warehouse Management System (RWMS)	§ Database scripts § Batch scripts § Forms § BI Publisher Reports
Oracle Retail Price Management (RPM)	§ Database scripts (included with RMS) § Java Application § Batch scripts
Oracle Retail Invoice Matching (ReIM)	§ Database scripts (included with RMS) § Java Application § Batch scripts
Oracle Retail Allocation	§ Database scripts (included with RMS) § Java Application § Batch scripts
Oracle Retail Sales Audit (ReSA)	§ Database scripts (included with RMS) § Java Application
Oracle Retail Insights (RI) Previously called Oracle Retail Analytics (RA)	§ Database scripts
Oracle Retail Advanced Science Engine (ORASE)	§ Database scripts § Batch scripts
Oracle Retail Data Extractor (RDE)	§ Database scripts
Oracle Retail Application Admin Console (ORAAC). Previously called Oracle Retail Application Security Role Manager (RASRM)	§ Java Application

Patch Concepts

During the lifecycle of an Oracle Retail environment, patches are applied to maintain your system. This maintenance may be necessary to resolve a specific issue, add new functionality, update to the latest patch level, add support for new technologies, or other reasons.

A patch refers to a collection of files to apply to an environment. Patches could be cumulative, such as the 16.0 release, or incremental, such as a hot fix for just a few modules. Patches may contain updates for some or all components of a product installation including database, application code, forms, and batch. In a distributed architecture the same patch may need to be applied to multiple systems in order to patch all of the components. For example, if a patch contains both database and application changes, the patch would need to be applied to both the database server and the application server.

The top-level directory for the installation of an Oracle Retail product is referred to as the RETAIL_HOME. Underneath RETAIL_HOME are all of the files related to that product installation, as well as configuration and metadata necessary for the Oracle Retail Patch Assistant to maintain those files. In some cases the runtime application files also exist under RETAIL_HOME. For example, compiled RMS batch files, the compiled RWMS forms, or Java Application batch scripts.

Patching Utility Overview

Patches are applied and tracked using utilities that are specifically designed for this purpose. The primary utility is described briefly below and additional information is available in later sections.

Oracle Retail Patch Assistant (ORPatch)

ORPatch is the utility used to apply patches to an Oracle Retail product installation. It is used in the background by the installer when creating a new installation or applying a cumulative patch. It is used directly to apply an incremental patch to an environment.

Oracle Retail Merge Patch (ORMerge)

ORMerge is a utility to allow multiple patches to be combined into a single patch. Applying patches individually may require some steps to be repeated. Merging multiple patches together allows these steps to be run only once. For example, applying several incremental patches to database packages will recompile invalid objects with each patch. Merging the patches into a single patch before applying them will allow invalid objects to be recompiled only once.

Oracle Retail Compile Patch (ORCompile)

ORCompile is a utility to compile components of Oracle Retail products outside of a patch. It allows RMS Batch, and RWMS Forms to be fully recompiled even if no patch has been applied. It also contains functionality to recompile invalid database objects in product schemas.

Oracle Retail Deploy Patch (ORDeploy)

ORDeploy is a utility to deploy components of Oracle Retail Java products outside of a patch. It allows RPM, ReIM, Allocation and ReSA java applications to be redeployed to WebLogic even if a patch has not been applied. It contains functionality to optionally include or not include Java customizations when redeploying.

Changes with 16.0

Some products and technologies are supported by the enhanced patching process for the first time in 16.0. In those cases all of the content in this chapter is new with 16.0.

New technologies

For the 16.0 release Oracle Retail Merchandising System (RMS) has a new ADF application component that is integrated with Orpatch.

Patching Considerations

Patch Types

Oracle Retail produces two types of patches for their products: cumulative and incremental.

Cumulative Patches

A cumulative patch includes all of the files necessary to patch an environment to a specific level or build a new environment at that level. Examples of cumulative patches would be 16.0, 15.0.2, and so on. Cumulative patches come with a standard Oracle Retail installer and so can be applied to an environment with the installer rather than with ORPatch or other utilities.

Incremental Patches

An incremental patch includes only selected files necessary to address a specific issue or add a feature. Examples of incremental patches would be a hot fix for a specific defect. Incremental patches do not include an installer and must be applied with ORPatch.

Incremental Patch Structure

An Oracle Retail incremental patch generally contains several files and one or more subdirectories. The subdirectories contain the contents of the patch, while the individual files contain information about the patch and metadata necessary for patching utilities to correctly apply the patch. The most important files in the top-level directory are the README.txt, the manifest files.

README File

The README.txt file contains information about the incremental patch and how to apply it. This may include manual steps that are necessary before, after or while applying the patch. It will also contain instructions on applying the patch with ORPatch.

Manifest Files

Each patch contains manifest files which contain metadata about the contents of a patch and are used by ORPatch to determine the actions necessary to apply a patch. Patches should generally be run against all installations a product in an environment, and ORPatch will only apply the changes from the patch that are relevant to that installation.

Note: Cumulative patches use a different patch structure because they include a full installer which will run ORPatch automatically.

Version Tracking

The patching infrastructure tracks version information for all files involved with a product installation. The RETAIL_HOME contains files which track the revision of all files within the RETAIL_HOME including batch, forms, database, Java archives and other files. In addition, records of database scripts that have been applied to the product database objects are kept within each database schema.

Apply all Patches with Installer or ORPatch

In order to ensure that environment metadata is accurate all patches must be applied to the Oracle Retail product installation using patching utilities. For cumulative patches this is done automatically by the installer. For incremental patches ORPatch must be used directly. This is especially important if database changes are being applied, in order to ensure that the database-related metadata is kept up-to-date.

Environment Configuration

A configuration file in $RETAIL_HOME/orpatch/config/env_info.cfg is used to define the details of a specific Oracle Retail environment. This file defines:

§ The location of critical infrastructure components such as the ORACLE_HOME on a database or middleware server.

§ The location of Oracle Wallets to support connecting to the database users.

§ The type of file processing which is relevant to a particular host. For example, if this is a host where database work should be done, or a host where batch compilation should be done, a host where Java applications should be deployed, etc. This allows a single database, forms and batch patch to be run against all types of hosts, applying only the relevant pieces on each server.

§ Other configuration necessary to determine proper behavior in an environment.

Retained Installation Files

The RETAIL_HOME location of an Oracle Retail product installation contains all of the files associated with that installation. This can include database scripts, Java files, Forms, Batch, RETL and Data Conversion files as with previous versions and also includes all database scripts. This allows objects to be reloaded during patching, including any necessary dependencies.

Reloading Content

In order to ensure that database contents and generated files exactly match patched versions, when applying cumulative patches some content is regenerated even if it does not appear to have changed.

On a cumulative patch this includes:

§ All re-runnable database content will be reloaded

– Packages and Procedures

– Database Types (excluding RIB objects)

– Control scripts

– Triggers

– WebService jars and packages

– Form Elements

§ All RWMS forms files will be recompiled

§ All RMS batch files will be recompiled

When applying incremental patches, only changed files will be reloaded. However this does not apply to RMS batch, which is fully recompiled with any change.

Java Hotfixes and Cumulative Patches

When applying cumulative patches to Java applications components with ORPatch, all hotfixes related to base product ear files included with the patch will be rolled back. This increases the likelihood of a successful deployment because hotfixes may not be compatible with updated product ear files, or may already be included with the ear. Before applying a cumulative patch to Java applications, check the patch documentation to determine which hotfixes are not included in the ear. Then work with Oracle Support to obtain compatible versions of the fixes for the updated ear version. In some cases this may be the same hotfix, in which case it can be re-applied to the environment. In other cases a new hotfix may be required.

Backups

Before applying a patch to an environment, it is extremely important to take a full backup of both the RETAIL_HOME file system and the Oracle Retail database. Although ORPatch makes backups of files modified during patching, any database changes cannot be reversed. If a patch fails which contains database changes, and cannot be completed, the environment must be restored from backup.

Disk Space

When patches are applied to an environment, the old version of files which are updated or deleted are backed up to $RETAIL_HOME/backups/backup-<timestamp>. When applying large patches, ensure there is sufficient disk space on the system where you unzip the patch or the patching process may fail. Up to twice as much disk space as the unzipped patch may be required during patching.

In addition to backups of source files, the existing compiled RWMS Forms and RMS Batch files are saved before recompilation. These backups may be created during patches:

§ Batch ‘lib’ directory in $RETAIL_HOME/oracle/lib/bin-<timestamp>

§ Batch ‘proc’ directory in $RETAIL_HOME/oracle/proc/bin-<timestamp>

§ Forms ‘toolset’ directory in $RETAIL_HOME/base/toolset/bin-<timestamp>

§ Forms ‘forms’ directory in $RETAIL_HOME/base/forms/bin-<timestamp>

Periodically both types of backup files can be removed to preserve disk space.

Patching Operations

Running ORPatch

ORPatch is used to apply patches to an Oracle Retail product installation. When applying a patch which includes an installer, ORPatch does not need to be executed manually as the installer will run it automatically as part of the installation process. When applying a patch that does not include an installer, ORPatch is run directly.

ORPatch performs the tasks necessary to apply the patch:

§ Inspects the patch metadata to determine the patch contents and patch type.

§ Reads the environment configuration file to determine which product components exist in this installation.

§ Assembles a list of patch actions which will be run on this host to process the patch.

§ Executes pre-checks to validate that all patch actions have the necessary configuration to proceed.

§ Compares version numbers of files from the patch against the files in the environment.

§ Backs up files which will be updated.

§ Copies updated files into the installation.

§ Loads updated files into database schemas, if applicable.

§ Recompiles RMS batch, if applicable.

§ Recompiles RWMS forms, if applicable.

§ Constructs updated Java archives and deploys them to WebLogic, if applicable

§ Updates Java batch files and libraries, if applicable

§ Records the patch in the patch inventory.

If a patch does not contain updated files for the database or system, no action may be taken. If a previously failed ORPatch session is discovered, it will be restarted.

Preparing for Patching

Before applying a patch to your system, it is important to properly prepare the environment.

Single Patching Session

It is extremely important that only a single ORPatch session is active against a product installation at a time. If multiple patches need to be applied, you can optionally merge them into a single patch and apply one patch to the environment. Never apply multiple patches at the same time.

Shutdown Applications

If a patch updates database objects, it is important that all applications are shutdown to ensure no database objects are locked or in use. This is especially important when applying changes to Oracle Retail Integration Bus (RIB) objects as types in use will not be correctly replaced, leading to “ORA-21700: object does not exist or marked for delete” errors when restarting the RIB.

Backup Environment

Before applying a patch to an environment, it is important to take a full backup of both the RETAIL_HOME file system and the retail database. Although ORPatch makes backups of files modified during patching, any database changes cannot be reversed. If a patch which contains database changes fails and cannot be completed, the environment must be restored from backup.

Log Files

When applying a patch, ORPatch will create a number of log files which contain important information about the actions taken during a patch and may contain more information in the event of problems. Log files are created in the $RETAIL_HOME/orpatch/logs directory. Logs should always be reviewed after a patch is applied.

After a patch session the log directory will contain at a minimum an ORPatch log file and may also contain other logs depending on the actions taken. The following table describes logs that may exist.

Log File	Used For
orpatch-<date>-<time>.log	Primary ORPatch log file
detail_logs/dbsql_<component>/invalids/*	Details on the errors causing a database object to be invalid
detail_logs/analyze/details	Detail logs of files that will be created/updated/removed when a patch is applied
detail_logs/compare/details	Detail logs of the differences between two sets of environment metadata
orpatch_forms_<pid>_child_<num>.log	Temporary logs from a child process spawned to compile forms in parallel. After the child process completes, the contents are append to the primary orpatch log file
detail_logs/rmsbatch/lib/*	Detail logs of the compilation of RMS Batch libraries
detail_logs/rmsbatch/proc/*	Detail logs of the compilation of RMS Batch programs
detail_logs/dbsql_rms/rms_db_ws_consumer_jars/*	Detail logs of the loadjava command to install RMS WebService Consumer objects
detail_logs/dbsql_rms/rms_db_ws_consumer_libs/*	Detail logs of the loadjava command to install RMS WebService Consumer libraries
detail_logs/forms/rwms_frm_forms/*	Detail logs of the compilation of each RWMS Forms file
detail_logs/dbsql_rwms/rwms_db_sp _jars/*	Detail logs of the loadjava command to install RWMS SP jars
detail_logs/javaapp_<product>/deploy/*	Detail logs of the deploy of a Java product

Unzip Patch Files

Before executing ORPatch, the patch files must be unzipped into a directory. This directory will be passed to ORPatch as the “-s <source directory>” argument on the command-line when applying or analyzing a patch.

Location of ORPatch

The ORPatch script will be located in $RETAIL_HOME/orpatch/bin.

Command Line Arguments

ORPatch behavior is controlled by several command-line arguments. These arguments may be actions or options. Command and option names can be specified in upper or lower case, and will be converted to upper-case automatically. Arguments to options, for example the source directory patch, will not be modified.

ORPatch command-line actions:

Action	Description
apply	Tells ORPatch to apply a patch, requires the –s option Example: orpatch apply –s $RETAIL_HOME/stage/patch123456
analyze	Tells ORPatch to analyze a patch, requires the –s option Example: orpatch analyze –s $RETAIL_HOME/stage/patch123456
lsinventory	Tells ORPatch to list the inventory of patches that have been applied to this installation
exportmetadata	Tells ORPatch to extract all metadata information from the environment and create a $RETAIL_HOME/support directory to contain it. Requires the –expname option.
Diffmetadata	Tells ORPatch to compare all metadata from the current environment with metadata exported from some other environment. Requires the –expname and –srcname options.
Revert	Tells ORPatch to revert the files related to a patch, requires the –s option Example: orpatch revert –s $RETAIL_HOME/backups/backup-09302013-153010

Note: An action is required and only one action can be specified at a time.

ORPatch command-line arguments:

Argument	Valid For Actions	Description
-s <source dir>	apply analyze	Specifies where to find the top-level directory of the patch to apply or analyze. The source directory should contain the manifest.csv and patch_info.cfg files.
-new	apply	Forces ORPatch to not attempt to restart a failed ORPatch session
-expname	exportmetadata diffmetadata lsinventory	Defines the top-level name to be used for the export or comparison of environment metadata. When used with lsinventory, it allows an exported inventory to be printed.
-srcname	diffmetadata	Defines the ‘name’ to use when referring to the current environment during metadata comparisons.
-dbmodules	diffmetadata	When comparing metadata at a module-level, compare the dbmanifest information rather than the environment manifest. This method of comparing metadata is less accurate as it does not include non-database files.
-jarmodules	analyze diffmetadata	When used with analyze, requests a full comparison of the metadata of Java archives included in the patch versus the metadata of the Java archives in the environment. This behavior is automatically enabled when Java customizations are detected in the environment. Analyzing the contents of Java archives allows for detailed investigation of the potential impacts of installing a new Java ear to an environment with customizations. When used with diffmetadata, causes metadata to be compared using jarmanifest information rather than the environment manifest. This provides more detailed information on the exact differences of the content of Java archives, but does not include non-Java files.
-selfonly	apply analyze	Only apply or analyze changes in a patch that relate to orpatch itself. This is useful for applying updates to orpatch without applying the entire patch to an environment.
-s <backup dir>	revert	Specifies the backup from a patch that should be reverted to the environment. This restores only the files modified during the patch, the database must be restored separately or the environment will be out-of-sync and likely unusable.

Analyzing the Impact of a Patch

In some cases, it may be desirable to see a list of the files that will be updated by a patch, particularly if files in the environment have been customized. ORPatch has an ‘analyze’ mode that will evaluate all files in the patch against the environment and report on the files that will be updated based on the patch.

To run ORPatch in analyze mode, include ‘analyze’ on the command line. It performs the following actions:

§ Identifies files in the environment which the patch would remove.

§ Compares version numbers of files in the patch to version numbers of files in the environment.

§ Prints a summary of the number of files which would be created, updated or removed.

§ Prints an additional list of any files that would be updated which are registered as being customized.

§ Prints an additional list of any files which are in the environment and newer than the files included in the patch. These files are considered possible conflicts as the modules in the patch may not be compatible with the newer versions already installed. If you choose to apply the patch the newer versions of modules in the environment will NOT be overwritten.

§ If a Java custom file tree is detected, prints a detailed analysis of the modules within Java ear files that differ from the current ear file on the system.

§ Saves details of the files that will be impacted in $RETAIL_HOME/orpatch/logs/detail_logs/analyze/details.

This list of files can then be used to assess the impact of a patch on your environment.

To analyze a patch, perform the following steps:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

Export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Set the JAVA_HOME environment variable if the patch contains Java application files.

Export JAVA_HOME=/u00/oretail/java_jdk

Note: If the JAVA_HOME environment variable is not specified, the value from RETAIL_HOME/orpatch/config/env_info.cfg will be used.

5. Create a staging directory to contain the patch, if it does not already exist.

Mkdir –p $RETAIL_HOME/stage

6. Download the patch to the staging directory and unzip it.

7. Execute orpatch to analyze the patch.

Orpatch analyze –s $RETAIL_HOME/stage/patch123456

8. Repeat the patch analysis on all servers with installations for this product environment.

9. Evaluate the list(s) of impacted files.

For more information on registering and analyzing customizations, please see the Customization section later in this document.

Applying a Patch

Once the system is prepared for patching, ORPatch can be executed to apply the patch to the environment. The patch may need to be applied to multiple systems if it updates components that are installed on distributed servers.

To apply a patch, perform the following steps:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

Export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Set the DISPLAY environment variable if the patch contains Forms.

Export DISPLAY=localhost:10.0

Note: If the DISPLAY environment variable is not specified, the value from RETAIL_HOME/orpatch/config/env_info.cfg will be used.

5. Set the JAVA_HOME environment variable if the patch contains Java application files.

Export JAVA_HOME=/u00/oretail/java_jdk

Note: If the JAVA_HOME environment variable is not specified, the value from RETAIL_HOME/orpatch/config/env_info.cfg will be used.

6. Create a staging directory to contain the patch, if it does not already exist.

Mkdir –p $RETAIL_HOME/stage

7. Download the patch to the staging directory and unzip it.

8. Review the README.txt included with the patch. If manual steps are specified in the patch, execute those steps at the appropriate time.

9. Shutdown applications.

10. Execute ORPatch to apply the patch.

Orpatch apply –s $RETAIL_HOME/stage/patch123456

11. After ORPatch completes, review the log files in $RETAIL_HOME/orpatch/logs.

12. Repeat the patch application on all servers with installations for this product environment.

13. Restart applications.

Restarting ORPatch

If ORPatch is interrupted while applying a patch, or exits with an error, it saves a record of completed work in a restart state file in $RETAIL_HOME/orpatch/logs. Investigate and resolve the problem that caused the failure, then restart ORPatch.

By default when ORPatch is started again, it will restart the patch process close to where it left off. If the patch process should not be restarted, add ‘-new’ to the command-line of ORPatch.

Please note that starting a new patch session without completing the prior patch may have serious impacts that result in a patch not being applied correctly. For example, if a patch contains database updates and batch file changes and ORPatch is aborted during the load of database objects, abandoning the patch session will leave batch without the latest changes compiled in the installation.

Listing the Patch Inventory

After a patch is successfully applied by ORPatch the patch inventory in $RETAIL_HOME/orpatch/inventory is updated with a record that the patch was applied. This inventory contains a record of the patches applied, the dates they were applied, the patch type and products impacted.

To list the patch inventory, perform the following steps:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

Export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory

export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Execute orpatch to list the inventory.

Orpatch lsinventory

Exporting Environment Metadata

ORPatch functionality is driven based on additional metadata that is stored in the environment to define what version of files are applied to the environment, and which database scripts have been applied to database schemas. This environment metadata is used to analyze the impact of patches to environments and controls what actions are taken during a patch. The metadata is stored in several locations depending on the type of information it tracks and in some cases it may be desirable to extract the metadata for analysis outside of ORPatch. For example, Oracle Support could ask for the metadata to be uploaded to assist them in triaging an application problem.

ORPatch provides a capability to export all of the metadata in an environment into a single directory and to automatically create a zip file of that content for upload or transfer to another system. The exact metadata collected from the environment depends on the products installed in the RETAIL_HOME.

ORPatch metadata exported:

Installed Product Component	Exported Metadata	Description
Any	orpatch/config/env_info.cfg orpatch/config/custom_hooks.cfg ORPatch inventory files	ORPatch configuration and settings
Any	All env_manifest.csv and deleted_env_manifest.csv files	Environment manifest files detailing product files installed, versions, customized flags and which patch provided the file
Database Schemas	DBMANIFEST table contents	Database manifest information detailing which database scripts were run, what version and when they were executed
Java Applications	All files from javaapp_<product>/config except jar files	Environment-specific product configuration files generated during installation
Java Applications	Combined export of all META-INF/env_manifest.csv files from all product ear files	Jar manifest information detailing files, versions, customized flags and which patch provided the file
Java Applications	orpatch/config/javaapp_<product>/ant.deploy.properties	Environment properties file created during product installation and used during application deployment
Java Applications	<weblogic_home>/server/lib/weblogic.policy	WebLogic server java security manager policy file
RMS Batch	orpatch/config/rmsbatch_profile	Batch compilation shell profile
RWMS Forms	orpatch/cofngi/rwsmforms_profile	Forms compilation shell profile

Exports of environment metadata are always done to the $RETAIL_HOME/support directory. When exporting metadata, you must specify the –expname argument and define the name that should be given to the export. The name is used for the directory within $RETAIL_HOME/support and for the name of the zip file.

To extract an environment’s metadata, perform the following steps:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

Export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Execute orpatch to export the metadata.

Orpatch exportmetadata –expname test_env

This example would export all metadata from the environment to the $RETAIL_HOME/support/test_env directory. A zip file of the metadata would be created in $RETAIL_HOME/support/test_env.zip.

Note: The $RETAIL_HOME/support/<name> directory should be empty or not exist prior to running exportmetadata in order to ensure accurate results.

Comparing Environment Metadata

Once metadata has been exported from an environment, it can be used to compare the environment manifest metadata of two environments. ORPatch provides a capability to compare metadata of the current environment with the exported metadata of another environment. Note that even though there are many types of metadata exported by ORPatch, only environment manifest metadata is evaluated during comparisons. Metadata comparison happens in four phases: product comparison, patch comparison, ORPatch action comparison, and module-level comparison.

Product comparison compares the products installed in one environment with the products installed in another environment. Patch comparison compares the patches applied in one environment with the patches applied in another environment, for common products. This provides the most summarized view of how environments differ. Patches which only apply to products on one environment are not included in the comparison.

Since each patch may impact many files, the comparison then moves on to more detailed analysis. The third phase of comparison is to compare the enabled ORPatch actions between environments. These actions roughly correspond to the installed ‘components’ of a product. For example, one environment may have database and forms components installed while another has only forms. Action comparison identifies components that are different between environments. The final phase of comparison is at the module level for actions that are common between environments. Modules which exist only on one environment, or exist on both environments with different revisions, or which are flagged as customized are reported during the comparison.

Differences between environment metadata are reported in a summarized fashion during the ORPatch execution. Details of the comparison results are saved in $RETAIL_HOME/orpatch/logs/detail_logs/compare/details. One CSV file is created for each phase of comparison: product_details.csv, patch_details.csv, action_details.csv and module_details.csv.

In order to be compared by ORPatch, exported metadata must be placed in the $RETAIL_HOME/support directory. The metadata should exist in the same structure that it was originally exported in. For example, if the metadata was exported to $RETAIL_HOME/support/test_env on another system, it should be placed in $RETAIL_HOME/support/test_env on this system.

When reporting differences between two environments, ORPatch uses names to refer to the environments. These names are defined as part of the diffmetadata command. The
–expname parameter, which defines the directory containing the metadata, is also used as the name when referring to the exported metadata. The –srcname parameter defines the name to use when referring to the current environment. As an example, if you had exported the ‘test’ environment’s metadata and copied it to the ‘dev’ environment’s $RETAIL_HOME/support/test_env directory, you could run “orpatch diffmetadata –expname test_env –srcname dev_env”. The detail and summary output would then refer to things that exist on dev but not test, revisions in the test environment versus revisions in the dev environment, etc.

ORPatch will automatically export the environment’s current metadata to $RETAIL_HOME/support/compare prior to starting the metadata comparison.

To compare two environment’s metadata, perform the following steps:

1. Export the metadata from another environment using orpatch exportmetadata.

2. Transfer the metadata zip from the other system to $RETAIL_HOME/support.

3. Log in as the UNIX user that owns the product installation.

4. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

Export RETAIL_HOME=/u00/oretail/dev

5. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

6. Unzip the metadata zip file.

Unzip test_env.zip

7. Execute orpatch to compare the metadata

orpatch diffmetadata –expname test_env –srcname dev_env

This example would compare the current environment against the metadata extracted in $RETAIL_HOME/support/test_env directory.

Note: The $RETAIL_HOME/support/compare directory will be automatically removed before environment metadata is exported at the start of the comparison.

Reverting a Patch

In general it is best to either completely apply a patch, or restore the entire environment from the backup taken before starting the patch. It is important to test patches in test or staging environments before applying to production. In the event of problems, Oracle Retail recommends restoring the environment from backup if a patch is not successful.

Note: Reverting patches in an integrated environment can be extremely complex and there is no fully automated way to revert all changes made by a patch. Restoring the environment from a backup is the recommended method to remove patches.

It is, however, possible to revert small patches using the backups taken by ORPatch during a patch. This will restore only the files modified, and it is still necessary to restore the database if any changes were made to it.

Note: Reverting a patch reverts only the files modified by the patch, and does not modify the database, or recompile forms or batch files after the change.

When multiple patches have been applied to an environment, reverting any patches other than the most recently applied patch is strongly discouraged as this will lead to incompatible or inconsistent versions of modules applied to the environment. If multiple patches are going to be applied sequentially it is recommended to first merge the patches into a single patch that can be applied or reverted in a single operation.

To revert a patch, perform the following steps:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

Export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Identify the backup directory in $RETAIL_HOME/backups that contains the backup from the patch you want to restore.

§ The backup directory will contain a patch_info.cfg file which contains the name of the patch the backup is from.

§ It is possible to have two directories for the same patch, if ORPatch was updated during the patch. It is not possible to revert the updates to ORPatch. Select the backup directory that does not contain orpatch files.

§ If it is not clear which backup directory to use, restore the environment from backup

5. Execute orpatch to revert the environment using the contents of the backup directory

orpatch revert –s $RETAIL_HOME/backups/backup-11232013-152059

6. Restore the database from backup if the patch made database changes

7. Use the orcompile script to recompile forms if the patch included RWMS forms files

orcompile –a RWMS –t FORMS

8. Use the orcompile script to recompile batch if the patch included RMS batch files

orcompile –a RMS –t BATCH

9. Use the ordeploy script to redeploy the appropriate Java applications if the patch included Java files

ordeploy –a RPM –t JAVA

ordeploy –a REIM –t JAVA

ordeploy –a ALLOC –t JAVA

ordeploy –a RESA –t JAVA

ordeploy –a RMS –t JAVA

Merging Patches

When patches are applied individually some ORPatch tasks such as compiling forms and batch files or deploying Java archives are performed separately for each patch. This can be time-consuming. An alternative is to use the ORMerge utility to combine several patches into a single patch, reducing application downtime by eliminating tasks that would otherwise be performed multiple times. Patches merged with ORMerge are applied with ORPatch after the merge patch is created.

Source and Destination Directories

ORMerge uses source and destination areas in order to merge patch files. The source area is a single directory that contains the extracted patches to merge. The destination area is the location where the merged patch will be created. If a file exists in one or more source patches, only the highest revision will be copied to the merged patch.

The source and destination directories should exist under the same parent directory. That is, both the source and destination directories should be subdirectories of a single top-level directory.

The source directory must have all patches to be merged as immediate child directories. For example if three patches need to be merged the directory structure would look like this:

Source and Destination Directory Example

ormerge_diagram

In the example above, the manifest.csv and patch_info.cfg files for each patch to be merged must exist in source/patch1, source/patch2, and source/patch3.

ORMerge Command-line Arguments

Argument	Required	Description
-s	Yes	Path to source directory containing patches to merge
-d	Yes	Path to destination directory that will contain merged patch
-name	No	The name to give the merged patch. If not specified, a name will be generated. When the merged patch is applied to a system, this name will appear in the Oracle Retail patch inventory.
-inplace	No	Used only when applying a patch to installation files prior to the first installation. See “Patching prior to the first install” in the Troubleshooting section later, for more information.

Running the ORMerge Utility

To merge patches, perform the following steps:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

Export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Create a staging directory to contain the patches.

Mkdir –p $RETAIL_HOME/stage/merge/src

5. Download the patches to the staging directory and unzip them so that each patch is in a separate subdirectory.

6. Review the README.txt included with each patch to identify additional manual steps that may be required. If manual steps are specified in any patch, execute them at the appropriate time when applying the merged patch.

7. Create a destination directory to contain the merged patches.

Mkdir –p $RETAIL_HOME/stage/merge/dest

8. Execute ORMerge to merge the patches.

Ormerge –s $RETAIL_HOME/stage/merge/src –d $RETAIL_HOME/stage/merge/dest –name merged_patch

The merged patch can now be applied as a single patch to the product installation using ORPatch.

Compiling Application Components

In some cases it may be desirable to recompile RWMS Forms or RMS Batch outside of a product patch. The ORCompile utility is designed to make this easy and remove the need to manually execute ‘make’ or ‘frmcmp’ commands which can be error-prone. ORCompile leverages ORPatch functions to ensure that it compiles forms and batch exactly the same way as ORPatch. In addition ORCompile offers an option to compile invalid database objects using ORPatch logic.

ORCompile takes two required command line arguments each of which take an option. Arguments and options can be specified in upper or lower case.

ORCompile Command Line Arguments

Argument	Description
-a <app>	The application to compile.
-t <type>	The type of application objects to compile

ORCompile Argument Options

Application	Type	Description
RMS	BATCH	Compile RMS Batch programs
RWMS	FORMS	Compile RWMS Forms
RMS	DB	Compile invalid database objects in the primary RMS schema
ALLOC	DB-ALC	Compile invalid database objects in the Allocations user schema
ALLOC	DB-RMS	Compile invalid database objects in the RMS schema
REIM	DB	Compile invalid database objects in the RMS schema
RME	DB	Compile invalid database objects in the RME schema
ASO	DB	Compile invalid database objects in the ASO schema
RI	DB-DM	Compile invalid database objects in the RI DM schema
RI	DB-RIBATCH	Compile invalid database objects in the RI batch schema
RI	DB-RMSBATCH	Compile invalid database objects in the RI RMS batch schema
RI	DB-FEDM	Compile invalid database objects in the RI front-end schema
RDE	DB-DM	Compile invalid database objects in the RDE DM schema
RDE	DB-RDEBATCH	Compile invalid database objects in the RDE batch schema
RDE	DB-RMSBATCH	Compile invalid database objects in the RDE RMS batch schema

Note: Compiling RMS type DB, ReIM type DB, and Allocation type DB-RMS, are all identical as they attempt to compile all invalid objects residing in the RMS schema.

Running the ORCompile utility

To compile files, perform the following steps:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

Export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Execute orcompile to compile the desired type of files.

Orcompile –a <app> -t <type>

ORCompile Examples

Compile RMS Batch.

Orcompile –a RMS –t BATCH

Compile RWMS Forms.

Orcompile –a RWMS –t FORMS

Compile invalid objects in the RA DM schema.

Orcompile –a RI –t DB-DM

Compile invalid objects in the RMS owning schema.

Orcompile –a RMS –t DB

Deploying Application Components

In some cases it may be desirable to redeploy Java applications outside of a product patch. For example, when troubleshooting a problem, or verifying the operation of the application with different WebLogic settings. Another situation might include wanting to deploy the application using the same settings, but without customizations to isolate behavior that could be related to customized functionality.

The ordeploy utility is designed to make this easy and remove the need to re-execute the entire product installer when no configuration needs to change. ORDeploy leverages Oracle Retail Patch Assistant functions to ensure that it deploys applications exactly the same way as ORPatch. In addition ORDeploy offers an option to include or not include custom Java files, to ease troubleshooting.

ORDeploy takes two required command line arguments each of which take an option. Arguments and options can be specified in upper or lower case.

ORDeploy Command Line Arguments

Argument	Description
-a <app>	The application to deploy.
-t <type>	The type of application objects to deploy

ORDeploy Argument Options

Application	Type	Description
ALLOC	JAVA	Deploy the Allocations Java application and Java batch files, including any custom Java files.
ALLOC	JAVANOCUSTOM	Deploy the Allocations Java application and Java batch files, NOT including any custom Java files.
REIM	JAVA	Deploy the REIM Java application and Java batch files, including any custom Java files.
REIM	JAVANOCUSTOM	Deploy the REIM Java application and Java batch files, NOT including any custom Java files.
RESA	JAVA	Deploy the RESA Java application, including any custom Java files.
RESA	JAVANOCUSTOM	Deploy the RESA Java application, NOT including any custom Java files.
RPM	JAVA	Deploy the RPM Java application and Java batch files, including any custom Java files.
RPM	JAVANOCUSTOM	Deploy the RPM Java application and Java batch files, NOT including any custom Java files.

Running the ORDeploy utility

To deploy Java applications, perform the following steps:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Execute ORDeploy to deploy the desired Java application.

ordeploy –a <app> -t <type>

ORDeploy Examples

Deploy RPM.

ordeploy -a RPM -t JAVA

Deploy ReIM without including Java customizations.

ordeploy -a REIM -t JAVANOCUSTOM

Maintenance Considerations

The additional information stored within the RETAIL_HOME and within database schemas adds some considerations when performing maintenance on your environment.

Database Password Changes

Oracle wallets are used to protect the password credentials for connecting to database schemas. This includes all database schemas used during an install. If the password for any of these users is changed the wallet’s entry must be updated.

The wallet location is configurable but by default is in the following locations:

Location	Installation Type
$RETAIL_HOME/orpatch/rms_wallet	RMS Database RMS Batch
$RETAIL_HOME/orpatch/rwms_wallet	RWMS Database
$RETAIL_HOME/orpatch/rwms_wallet_app	RWMS Forms
$RETAIL_HOME/orpatch/oraso_wallet	ASO Database
$RETAIL_HOME/orpatch/orme_wallet	RME Database
$RETAIL_HOME/orpatch/ra_wallet	RI (Previously RA) Database
$RETAIL_HOME/orpatch/rde_wallet	RDE Database

The wallet alias for each schema will be <username>_<dbname>. Standard mkstore commands can be used to update the password.

For example:

mkstore -wrl $RETAIL_HOME/orpatch/rms_wallet –modifyCredential rms_rmsdb rms01 rmspassword

This command will update the password for the RMS01 user to ‘rmspassword’ in the alias ‘rms_rmsdb’.

The Oracle wallets are required to be present when executing ORPatch. Removing them will prevent you from being able to run ORPatch successfully. In addition the Oracle wallet location is referenced in the RMS batch.profile, and in the default RWMS Forms URL configuration, so removing them will require reconfiguration of batch and forms. If batch and forms were reconfigured after installation to use other wallet files, it is possible to backup and remove the wallets, then restore them when running ORPatch.

WebLogic Password Changes

Java wallets are used to protect the password credentials used when deploying Java products. This includes the WebLogic administrator credentials, LDAP connection credentials, batch user credentials and any other credentials used during an install. If the password for any of these users is changed the wallet’s entry must be updated, or the Java product installation can be run again.

The wallet location is in the following locations:

Location	Installation Type
$RETAIL_HOME/orpatch/config/javapp_rpm	RPM Java
$RETAIL_HOME/orpatch/config/javapp_reim	ReIM Java
$RETAIL_HOME/orpatch/config/javapp_alloc	Allocation Java
$RETAIL_HOME/orpatch/config/javapp_resa	RESA Java
$RETAIL_HOME/orpatch/config/javaapp_rasrm	ORAAC (Previously RASRM) Java
$RETAIL_HOME/orpatch/config/javaapp_rms	RMS Java

The wallet aliases will be stored in the retail_installer partition. The names of the aliases will vary depending on what was entered during initial product installation.

The dump_credentials.sh script can be used to list the aliases in the wallet.

For example:

cd $RETAIL_HOME/orpatch/deploy/retail-public-security-api/bin

./dump_credentials.sh $RETAIL_HOME/orpatch/config/javapp_alloc

Apapplication level key partition name:retail_installer

User Name Alias:dsallocAlias User Name:rms01app

User Name Alias:BATCH-ALIAS User Name:SYSTEM_ADMINISTRATOR

User Name Alias:wlsAlias User Name:weblogic

The easiest way to update the credential information is to re-run the Java product installer. If you need to manually update the password for a credential, the save_credential.sh script can be used.

For example:

cd $RETAIL_HOME/orpatch/deploy/retail-public-security-api/bin

./save_credential.sh –l $RETAIL_HOME/orpatch/config/javapp_alloc –p retail_installer –a wlsAlias –u weblogic

This command will prompt for the new password twice and update the aslias wlsAlias, username weblogic with the new password.

Infrastructure Directory Changes

The RETAIL_HOME/orpatch/config/env_info.cfg file contains the path to the database ORACLE_HOME on database or RMS Batch installations, to the WebLogic Forms and Reports ORACLE_HOME and ORACLE_INSTANCE on RWMS Forms installations, and to the WEBLOGIC_DOMAIN_HOME, WL_HOME and MW_HOME on Java product installations. If these paths change, the related configuration variables in the env_info.cfg file must be updated.

DBManifest Table

The table dbmanifest within Oracle Retail database schemas is used to track the database scripts which have been applied to the schema. It is critical not to drop or truncate this table. Without it, ORPatch will attempt to re-run scripts against the database which have already been applied which can destroy a working environment. Similarly, if copying a schema from one database to another database, ensure that the dbmanifest table is preserved during the copy.

RETAIL_HOME relationship to Database and Application Server

The RETAIL_HOME associated with an Oracle Retail product installation is critical due to the additional metadata and historical information contained within it. If a database or application installation is moved or copied, the RETAIL_HOME related to it should be copied or moved at the same time.

Jar Signing Configuration Maintenance

The RPM product installation includes an option to configure a code signing certificate so that jar files modified during installation or patching are automatically re-signed. This configuration is optional, but recommended. If it is configured, the code signing keystore is copied during installation to $RETAIL_HOME/orpatch/config/jarsign/orpkeystore.jks. The keystore password and private key password are stored in a Java wallet in the $RETAIL_HOME/orpatch/config/jarsign directory. The credentials are stored in a wallet partition called orpatch:

Alias	Username	Description
storepass	discard	Password for the keystore
keypass	discard	Password for the private key

The keystore file and passwords can be updated using the product installer. This is the recommended way to update the signing configuration.

If only the credentials need to be updated, the sign_jar.sh script can be used.

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your installation.

export RETAIL_HOME=/u00/oretail/tst

3. Change directories to the location of sign_jar.sh
cd $RETAIL_HOME/orpatch/deploy/bin

4. Execute sign_jar.sh

sign_jar.sh changepwd

5. When prompted, enter the new keystore password

6. When prompted, enter the new private key password

Customization

Patching Considerations with Customized Files and Objects

In general, the additional capabilities provided by the ORPatch should make it easier to evaluate the potential impacts of patches to your customizations of Oracle Retail products. However, the additional metadata maintained by the Oracle Retail patching utilities does add some considerations when making customizations.

General Guidelines

It is always preferred to customize applications by extension rather than by direct modification. For example, adding new database objects and forms rather than modifying existing Oracle Retail objects and forms. You can also leverage built-in extension points such as User Defined Attributes, the Custom Flexible Attribute Solution, or seeded customization points in ADF Applications.

It is strongly discouraged to directly modify Oracle Retail database objects, especially tables, as your changes may be lost during patching or may conflict with future updates. When adding or modifying database objects, Oracle Retail recommends that all objects be added with scripts to ensure that they can be rebuilt if necessary after a patch.

Custom Database Objects

When you create new database objects, Oracle Retail recommends placing them in an Oracle database schema specifically for your customizations. You must use synonyms and grants to allow the Oracle Retail product schema owner and other users to access your objects, and use synonyms and grants to allow your customizations to access Oracle Retail objects. A separate schema will ensure that your customizations are segregated from base Oracle Retail code.

ORPatch expects that there will be no invalid objects in the database schemas it manages after a patch is applied. For this reason adding extra objects to the product schema could result in failures to apply patches as changes to base objects may cause custom objects to go invalid until they are updated. In this situation, manually update the custom objects so that they compile, and restart the patch.

Custom Forms

When creating new custom forms, Oracle Retail recommends placing them in a separate directory specifically for your customizations. This directory should be added to the FORMS_PATH of your RWMS Forms URL configuration to allow the forms to be found by the Forms Server. This will ensure that your customizations are segregated from base Oracle Retail code. If you choose to place customizations in the Forms bin directory, then your custom forms will need to be recopied each time Forms are fully recompiled.

ADF Application Customization

Oracle Retail ADF-based applications such as Allocation and ReSA can be customized using a process called ‘seeded customization’. The customization process involves using JDeveloper in Customizer mode to create changes to product configurations, and then building a MAR archive containing the changes. The generated MAR is deployed to the MDS repository used by the application and applied to the application at runtime. These types of customizations are handled outside of ORPatch and are not reported during patch analysis or tracked by the custom file registration utility. More information can be found in the respective product customization guides.

Custom Compiled Java Code

When customizing Oracle Retail Java-based products such as RPM and ReIM via product source code, ORPatch supports automatically adding compiled customizations into the application ear file prior to deployment. This allows customizations to be applied to the application without directly modifying the base product ear, enabling customizations and defect hotfixes to co-exist when they do not change the same file or a dependent file. See the later “Custom Compiled Java Code” section for additional information and considerations.

Analyze Patches when Customizations are Present

Whenever you have customized a product by directly modifying Oracle Retail files or database objects, it is important to ensure you analyze each the files that will be updated by a patch before applying the patch. This will allow you to identify any customized files which may be overwritten by the patch and either merge your customization with the new version of the file, or re-apply the customization after applying the patch.

Manifest Updates

If you choose to customize Oracle Retail files directly, it is extremely important not to update the revision number contained in the env_manifest.csv. This could cause future updates to the file to be skipped, invalidating later patch applications as only a partial patch would be applied. The customized revision number for modified files will need to be tracked separately.

Registering Customized Files

The ORPatch contains utilities and functionality to allow tracking of files that have been customized through direct modification. This process is referred to as ‘registering’ a customized file. Registration only works for files which are shipped by Oracle Retail. It is not possible to register new files created in the environment as part of extensions or customizations.

When patches are analyzed with ORPatch, special reporting is provided if any registered files would be updated or deleted by the patch. Customized files impacted by the patch are listed at the end of the analysis report from ORPatch. The detail files generated during the analyze will contain a column called ‘customized’ which will have a Y for any files which were registered as customized. This allows easier identification of customizations which will be overwritten by a patch.

All files delivered by Oracle Retail are considered ‘base’ and so when they are applied to an environment any registrations of those files as customized will revert back to un-customized. Each time a patch overwrites customized files, you must re-register the files as customized once you have applied customizations.

To register customized files, use the $RETAIL_HOME/orpatch/bin/orcustomreg script.

The orcustomerg script operates in one of two modes: registration and list.

§ Registration mode registers or unregisters one or more files as customized.

§ List mode lists all files in the environment that are registered as customized.

Command Line Arguments for Registration Mode

Argument	Description
-f <file>	Adds <file> to the list of files that will be registered. Can be specified more than once.
-bulk <file>	Specifies a file to read, containing one filename per line. All filenames listed inside <file> will be registered.
-register	Files specified with -f or -bulk will be registered as ‘customized’
-unregister	Files specified with -f or -bulk will be registered as ‘base’

Notes:

§ At least one of -f or -bulk is required.

§ If neither -register nor -unregister is specified, the default is ‘-register’.

§ File names specified with -f must either be fully-qualified or be relative to RETAIL_HOME. The same is true for filenames specified within a -bulk file.

Command Line arguments for list mode

Argument	Description
-list	List all files in the environment registered as customized

Running the orcustomreg Script

Perform the following procedure to run the orcustomreg script:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Execute orcustomreg script to register the desired file(s).

orcustomreg –register –f <file>

Examples of using the orcustomreg Script

orcustomreg -f dbsql_rms/Cross_Pillar/control_scripts/source/oga.sql

Unregister customizations for $RETAIL_HOME/dbsql_rwms/Triggers/Source/TR_WAVE.trg

orcustomreg –unregister –f $RETAIL_HOME/dbsql_rwms/Triggers/Source/TR_WAVE.trg

Bulk register several files as customized.

echo “$RETAIL_HOME/oracle/proc/src/mrt.pc” > custom.txt

echo “$RETAIL_HOME/oracle/proc/src/saldly.pc” >> custom.txt

echo “$RETAIL_HOME/oracle/proc/src/ccprg.pc” >> custom.txt

orcustomreg –bulk custom.txt

List all files registered as customized.

orcustomreg –list

Custom Compiled Java Code

This functionality is enabled by creating a directory called $RETAIL_HOME/javaapp_<app>/custom, where <app> is the application the customizations apply to. Files stored within this directory will be combined with the base product ear files before the application is deployed to WebLogic. ORPatch will attempt to consider customizations stored within the ‘custom’ directory during patch analysis by triggering more detailed ear file change analysis to assist with identifying which customizations might be impacted by changes in the patches.

Note: It is not possible, nor necessary, to register compiled Java customizations with the orcustomreg tool.

As with other customization techniques for other technologies, Oracle Retail recommends making Java customizations in new files as much as possible, versus overwriting base product or configuration files. In the past it was necessary to build complete replacement product ear files, but this method of customization is no longer required nor recommended. Replacement ear and jar files will not contain the META-INF/env_manifest.csv files which are required in order to be able to apply incremental patches. Instead, compile the specific Java classes being customized and place them along with any custom configuration files in $RETAIL_HOME/javaapp_<app>/custom.

Building Deployable ear files

When constructing the product ear file to deploy to WebLogic, ORPatch applies changes to the ear file in a specific order, with files from later steps overwriting files in earlier steps. The resulting ear is stored in $RETAIL_HOME/javaapp_<app>/deploy, and then deployed to WebLogic.

Sequence for ORPatch Java Product ear file updates

Order	File Type	Location
1	Base product ear	$RETAIL_HOME/javaapp_<app>/base
2	Updated configuration files	$RETAIL_HOME/javaapp_<app>/config
3	Oracle Retail-supplied hotfixes	$RETAIL_HOME/javaapp_<app>/internal
4	Compiled customizations	$RETAIL_HOME/javaapp_<app>/custom

Merging Custom Files

When merging files from the custom directory with the product ear, ORPatch uses the directory path of the files within custom to calculate where the file should be stored within the ear. This allows arbitrary nesting of files, even when placing files within jars stored in jars, stored within the ear. The following examples below use RPM, but apply to adding compiled customizations to any Java-based product.

Custom directory location and product ear location Examples

File path within javaapp_<app>/custom/	Final Ear File Location
rpm.ear/company/ui/MyCustom.class	In rpm.ear: /company/ui/MyCustom.class
rpm.ear/rpm.jar/company/bc/MyCustom2.class	In rpm.ear: In rpm.jar: /company/bc/MyCustom2.class
rpm.ear/lib/ourcustomlibs.jar	In rpm.ear /lib/ourcustomlibs.jar
rpm.ear/WebLaunchServlet.war/lib/ rpm.jar/company/bc/MyCustom2.class	In rpm.ear: In WebLaunchServlet.war: In lib/rpm.jar: /company/bc/MyCustom2.class

Analyzing patches when customizations are present

When analyzing a patch which contains a base product ear and the custom directory contains files, ORPatch will automatically trigger a more detailed analysis of the changes coming in a patch. This includes calculating what files inside the product ear have been added, removed or updated and which files appear to be customized based on the contents of the ‘custom’ directory. The detailed results of the ear file comparison during patch analysis will be saved in javaapp_<app>_archive_compare_details.csv. Any custom files which appeared to be impacted by the patch are saved in javapp_<app>_archive_custom_impacts.csv. Both files will be in the $RETAIL_HOME/orpatch/logs/detail_logs/analyze/details directory.

Note: This detailed analysis is not available when analyzing individual hotfixes, so special care must be taken when applying hotfixes to a customized product installation, to ensure there are no conflicts between customizations and hotfix changes.

Customizations and cumulative patches

By default, when applying a cumulative patch, ORPatch will not include customizations in the deployed product ear, even if they are present in the appropriate directory. This allows verification that the application is functioning properly using base code, before applying customizations. After verifying the initial deployment, use ORDeploy with the “-t JAVA” option to construct and deploy the product ear including customizations.

If customizations need to be removed outside of a patch, use ORDeploy with the “-t JAVANOCUSTOM” option to create and deploy an ear containing only Oracle Retail code. To force ORPatch to include customizations in the deployed ear even when applying a cumulative patch, set JAVAAPP_<app>_INCLUDE_CUSTOM=Y in the $RETAIL_HOME/orpatch/config/env_info.cfg file.

Changing configuration files

It is possible to directly change product configuration files in $RETAIL_HOME/javaapp_<app>/config. These updates can be deployed to the environment using the ORDeploy utility. However, the ‘config’ directory is completely recreated each time the product installer is used. This means that modifications will be lost and must be manually reapplied after each installer run. It is recommended to make configuration changes via the installer where possible, and retain the ant.install.properties file for use in later installer sessions.

Extending Oracle Retail Patch Assistant with Custom Hooks

The default ORPatch actions and processing logic is sufficient to install and patch the base Oracle Retail product code. However there may be situations where custom processing is desired during patching activities such as executing a shell script prior to the start of patching, or running a SQL script at the end of the patch.

ORPatch supports extensions in the form of custom hooks. These hooks allow external scripts to be run at specific points during ORPatch processing.

ORPatch Processing

Action

ORPatch supports a variety of ‘actions’ which define the steps necessary to apply updates to a particular area of the Oracle Retail application. Each action is generally specific to updates to a single technology or logical component of the environment. For example, one action might handle making updates to the RMS database schema, while a separate action is responsible for compiling RWMS forms, and a different action deploys the RPM Java application. These actions are enabled and disabled within the environment configuration file, allowing ORPatch to determine what types of changes to apply to each product installation.

ORPatch Actions

Order	Action Name	Description
1	DBSQL_RMSBDIINT	Loads database objects into the RMS BDI Integration schema
2	DBSQL_RMSBDIINFR	Loads database objects into the RMS BDI Infrastructure schema
3	DBSQL_RAF	Loads Retail Application Framework database objects into the RMS schema
44	DBSQL_RMS	Loads RMS and RPM database objects into the primary RMS schema
5	DBSQL_REIM	Loads ReIM database objects into the RMS schema
6	DBSQL_ALCRMS	Loads Allocation database objects into the RMS schema
7	DBSQL_ALLOC	Loads Allocation database objects into the Allocation user schema
8	DBSQL_RMSDEMO	Used to create demo data in the RMS schema if demo data was selected during initial installation
9	DBSQL_RMSDAS	Loads database objects into the RMS Data Access Schema
10	RMSBATCH	Compiles RMS Batch

11	RMSRETLSCRIPTS	Copies Oracle Retail Extract and Load scripts for RMS
12	RMSDCSCRIPTS	Copies Oracle Retail Merchandising System data conversion scripts
13	JAVAAPP_RMS	Deploys the RMS Java application
14	DBSQL_RWMS	Loads database objects into the primary RWMS schema
15	DBSQL_RWMSADF	Loads database objects into the RWMS ADF user schema
16	DBSQL_RWMSUSER	Loads database objects into the RWMS user schema
17	ORAFORMS_RWMS	Compiles RWMS Forms, copies RWMS batch scripts and reports to $RETAIL_HOME
18	JAVAAPP_RPM	Deploys the RPM Java application and batch scripts
19	JAVAAPP_REIM	Deploys the REIM Java application and batch scripts
20	JAVAAPP_ALLOC	Deploys the Allocation Java application and batch scripts
21	JAVAAPP_RESA	Deploys the ReSA Java application
22	JAVAAPP_RASRM	Deploys the ORAAC (previously called RASRM) Java application
23	DBSQL_RARMSBATCH	Loads database objects into the RMS Batch schema for RI (previously called RA)
24	DBSQL_RADM	Loads database objects into the RI (previously called RA) Data Mart schema
25	DBSQL_RAFEDM	Loads database objects into the RI (previously called RA) Front-end schema
26	DBSQL_RABATCH	Loads database objects into the RI (previously called RA) Batch schema
27	RACOREBATCH	Copies RA Core batch scripts and libraries
28	DBSQL_RDERMSBATCH	Loads database objects into the RMS Batch schema for RDE
29	DBSQL_RDEDM	Loads database objects into the RDE Data Mart schema
30	DBSQL_RDEBATCH	Loads database objects into the RDE Batch schema
31	RDECOREBATCH	Copies RDE Core batch scripts and libraries
32	DBSQL_RASECORE	Loads core database objects into the ORASE schema
33	DBSQL_RASEASO	Loads ASO database objects into the ORASE schema
34	DBSQL_RASERL	Loads RL database objects into the ORASE schema
35	DBSQL_RASECDT	Loads CDT database objects into the ORASE schema
36	DBSQL_RASECIS	Loads CIS database objects into the ORASE schema
37	DBSQL_RASEDT	Loads DT database objects into the ORASE schema
38	DBSQL_RASEAE	Loads AE database objects into the ORASE schema
39	DBSQL_RASEMBA	Loads MBA database objects into the ORASE schema
40	RASECOREBATCH	Copies ORASE core batch scripts and libraries
41	RASEASOBATCH	Copies ORASE ASO batch scripts and libraries
42	RASERLBATCH	Copies ORASE RL batch scripts and libraries
43	RASECDTBATCH	Copies ORASE CDT batch scripts and libraries
44	RASECISBATCH	Copies ORASE CIS batch scripts and libraries
45	RASEDTBATCH	Copies ORASE DT batch scripts and libraries
46	RASEAEBATCH	Copies ORASE AE batch scripts and libraries
47	RASEMBABATCH	Copies ORASE MBA batch scripts and libraries
48	DBSQL_RFM	Loads RFM database objects into the RMS schema

Phase

ORPatch processes patches in phases. Each action relevant to a patch and host is provided an opportunity to process the patch for each phase. The standard phases which allow hooks are:

Restart Phase Number	Phase Name	Description
N/A	PRECHECK	Actions verify that their configuration appears complete and correct. This phase and the associated hooks will be run every time orpatch is executed, even if processing will be restarted in a later phase.
10	PREACTION	Actions do processing prior to when files are copied to the environment. Files are deleted during this phase.
20	COPYPATCH	Actions copy files included in a patch into the destination environment and the environment manifest is updated.
30	PATCHACTION	Actions take the more detailed steps necessary to apply the new files to the environment. For database actions in particular, this is the phase when new and updated sql files are loaded into the database.
40	POSTACTION	Actions do processing after files have been copied and PatchActions are completed. The Forms actions, for example, use this phase to compile the forms files as this must happen after database packages are loaded.
50	CLEANUP	Actions do any additional processing. Currently no actions implement activities in this phase.

Configuring Custom Hooks

Custom hooks are configured in a configuration file RETAIL_HOME/orpatch/config/custom_hooks.cfg. The configuration file is a simple text file where blank lines and lines starting with # are ignored and all other lines should define a custom hook.

To define a custom hook, a line is added to the file in the form:

The hook name must be in upper case and is in the form:

The action name is any action name understood by ORPatch. The phase name is one of the five phase names from the table above. The sequence is either ‘START’ or ‘END’. Hooks defined with a sequence of ‘START’ are run before the action’s phase is invoked. Hooks defined with a sequence of ‘END’ are run after the action’s phase is invoked.

Multiple scripts can be associated with a single hook by separating the script names with a comma. If a hook name appears in the configuration file multiple times only the last entry will be used.

The script defined as a custom hook must be an executable shell script that does not take any arguments or inputs. The only environment variable that is guaranteed to be passed to the custom hook is RETAIL_HOME. The script must return 0 on success and non-zero on failure.

If an action is a DBSQL action (i.e. has a name like DBSQL_), the custom hook can optionally be a .sql file. In this case the SQL script will be run against the database schema that the DBSQL action normally executes against. The SQL script must not generate any ORA- or SP2- errors on success. In order to be treated as a database script, the extension of the file defined as the custom hook must be .sql in lower-case. Any other extension will be treated as if it is a shell script. If you have database scripts with different extensions, they must be renamed or wrapped in a .sql script.

When using the PRECHECK phase and START sequence, please note that the custom hook will be executed prior to any verification of the configuration. Invalid configuration, such as invalid database username/password or a non-existent ORACLE_HOME, may cause the custom hook to fail depending on the actions it tries to take. However in these cases, the normal orpatch PRECHECK activities would likely have failed as well. All that is lost is the additional context that orpatch would have provided about what was incorrect about the configuration.

Restarting with Custom Hooks

If a custom hook fails, for example a shell script hook returns non-zero or a sql script generates an ORA- error in its output, the custom hook will be treated as failing. A failing custom hook causes ORPatch to immediately stop the patching session.

When ORPatch is restarted it always restarts with the same phase and action, including any START sequence custom hooks. If the START sequence custom hook fails, the action’s phase is never executed. With an END sequence custom hook, the action’s phase is re-executed when ORPatch is restarted and then the custom hook is re-executed. When an action’s phase is costly, for example the DBSQL_RMS action which does a lot of work, this can mean a lot of duplicate processing.

For this reason it is preferred to use START sequence custom hooks whenever possible. If necessary, use a START sequence hook on a later phase or a later action, rather than an END sequence custom hook.

Patch-level Custom Hooks

In addition to action-specific hooks, there are two patch-level hook points available. These hooks allow scripts to be run before any patching activities start and after all patching activities are completed. The hooks are defined in the same configuration file, with a special hook name.

To run a script before patching, define:

ORPATCH_PATCH_START=<fully qualified script>

To run a script after patching, define:

ORPATCH_PATCH_END=<fully qualified script>

These hooks only support executing shell scripts, database scripts must be wrapped in a shell script. It is also important to note that these hooks are run on every execution of ORPatch to apply a patch, even when restarting a patch application. If the START sequence patch-level hook returns a failure, patching is aborted. If the END sequence patch-level hook returns a failure, it is logged but ignored as all patching activities have already completed.

Please note that the ORPATCH_PATCH_START hook is executed prior to any verification of the configuration. Invalid configuration may cause the custom hook to fail depending on the actions it tries to take. However in these cases, the normal ORPatchactivities would likely fail as well.

Example Custom Hook Definitions

A shell script that is executed prior to the Pre-Action phase of RMS Batch:

RMSBATCH_PREACTION_START=/u00/oretail/prepare_custom_header.sh

A shell script that is executed after RETL script files are copied into the RETAIL_HOME:

RETLSCRIPTS_COPYPATCH_END=/u00/oretail/copy_custom_files.sh

A SQL script that is executed against the RWMS owning schema at the start of the Clean-up Phase:

DBSQL_RWMS_CLEANUP_START=/dba/sql/recompile_synonyms.sql

Troubleshooting Patching

There is not a general method for determining the cause of a patching failure. It is important to ensure that patches are thoroughly tested in a test or staging system several times prior to attempting to apply the patch to a production system, particularly if the patch is a large cumulative patch. After the test application is successful, apply the patch to the production system.

ORPatch Log Files

ORPatch records extensive information about the activities during a patch to the log files in RETAIL_HOME/orpatch/logs. This includes a summary of the actions that are planned for a patch, information about all files that were updated by the patch, and detailed information about subsequent processing of those files. The ORPatch log files also contain timestamps to assist in correlating log entries with other logs.

Even more detailed logs are available in RETAIL_HOME/orpatch/logs/detail_logs for some activities such as forms compilation, invalid database object errors, and output from custom hooks. If the standard ORPatch log information is not sufficient, it might be helpful to check the detailed log if it exists.

Restarting ORPatch

The restart mechanism in ORPatch is designed to be safe in nearly any situation. In some cases to ensure this, a portion of work may be redone. If the failure was caused by an intermittent issue that has been resolved, restarting ORPatch may be sufficient to allow the patch to proceed.

Manual DBManifest Updates

A possible cause for database change script failures is that a database change was already made manually to the database. In this event, you may need to update the dbmanifest table to record that a specific script does not need to be run. Before doing this, it is extremely important to ensure that all statements contained in the script have been completed.

Use the $RETAIL_HOME/orpatch/bin/ordbmreg script to register database scripts in the dbmanifest table.

Command Line Arguments for ordbmreg

Argument	Description
-f <file>	Adds <file> to the list of files that will be registered. Can be specified more than once.
-bulk <file>	Specifies a file to read, containing one filename per line. All filenames listed inside <file> will be registered.
-register	Files specified with -f or -bulk will be registered in the dbmanifest table
-unregister	Files specified with -f or -bulk will be removed from the dbmanifest table

Notes:

§ At least one of -f or -bulk is required.

§ If neither -register nor -unregister is specified, the default is ‘-register’.

§ File names specified with -f must either be fully-qualified or be relative to RETAIL_HOME. The same is true for filenames specified within a -bulk file.

§ Registering a file in the dbmanifest table will cause it to be completely skipped. Before doing so, ensure that all commands contained in it have been completed.

§ Removing a file from the dbmanifest table will cause it to be run again. This will fail if the commands in the script cannot be re-run. For example if they create a table that already exists.

Running the ordbmreg Script

Perform the following procedure to run the ordbmreg script:

1. Log in as the UNIX user that owns the product installation.

2. Set the RETAIL_HOME environment variable to the top-level directory of your product installation.

export RETAIL_HOME=/u00/oretail/tst

3. Set the PATH environment variable to include the orpatch/bin directory
export PATH=$RETAIL_HOME/orpatch/bin:$PATH

4. Execute ordbmreg script to register the desired file(s).

ordbmreg –register –f <file>

Examples of using the ordbmreg Script

Register $RETAIL_HOME/dbsql_rms/Cross_Pillar/db_change_scripts/source/000593_system_options.sql with the dbmanifest table.

ordbmreg -f dbsql_rms/Cross_Pillar/db_change_scripts/source/000593_system_options.sql

Remove the dbmanifest row for $RETAIL_HOME/dbsql_radm/ra_db/radm/database_change_scripts/000035_s12733240_w_party_per_d.sql.

ordbmreg –unregister –f $RETAIL_HOME/dbsql_radm/ra_db/radm/database_change_scripts/000035_s12733240_w_party_per_d.sql

Bulk register several files in the dbmanifest table.

echo “$RETAIL_HOME/dbsql_rwms/DBCs/Source/000294_container.sql” > dbcs.txt

echo “$RETAIL_HOME/dbsql_rwms/DBCs/Source/000457_drop_object.sql” >> dbcs.txt

ordbmreg –bulk dbcs.txt

Restarting after registration

Once the row has been added to the dbmanifest table, restart ORPatch and the script will be skipped. If the file is not skipped there are several possibilities:

§ The script registered is not the failing script.

§ The file type is not a type that is filtered by the dbmanifest. The only file types that skip files listed in the dbmanifest are:

– Initial install DDL Files

– Installation scripts that cannot be rerun

– Database Change Scripts

Manual Restart State File Updates

Oracle Retail strongly discourages manually updating the ORPatch restart state files. Updating the file improperly could cause necessary steps in the patching process to be skipped or patches to be incorrectly recorded as applied.

DISPLAY Settings When Compiling Forms

When compiling RWMS forms, it is necessary to have a valid X-Windows Display. ORPatch allows this setting to come from one of two places:

§ DISPLAY environment variable set before executing ORPatch

§ DISPLAY setting in RETAIL_HOME/orpatch/config/env_info.cfg

The DISPLAY variable in the environment overrides the env_info.cfg, if both are set. The destination X-Windows display must be accessible to the user running ORPatch, and for best compilation performance it should be on the network ‘close’ to the server where Forms are installed and compiled. Using a local display or VNC display is preferred. Compiling forms across a Wide-Area Network will greatly increase the time required to apply patches to environments.

JAVA_HOME Setting

When working with Java application jar, ear or war files, it is necessary to have a valid JAVA_HOME setting. ORPatch allows this setting to come from one of two places:

§ JAVA_HOME environment variable set before executing ORPatch

§ JAVA_HOME setting in RETAIL_HOME/orpatch/config/env_info.cfg

The JAVA_HOME variable in the environment overrides the env_info.cfg, if both are set. The specified Java home location must be accessible to the user running ORPatch and be a full Java Development Kit (JDK) installation. The JAVA_HOME must contain the jar utility and if automatic Jar file signing is configured, must also contain the keytool and jarsigner utilities.

Patching Prior to First Install

In some situations, it may be necessary to apply a patch to product installation files before the initial install. For example, if there is a defect with a script that would be run during the install and prevent proper installation. In this rare situation, it may be necessary to apply a patch to the installation files prior to starting installation.

Note: These steps should only be undertaken at the direction of Oracle Support.

Perform the following steps to patch installation files prior to starting an installation. The steps assume an RMS installation, but apply to any product supported by ORPatch:

1. Unzip the installation files to a staging area.

Note: The following steps assume the files are in /media/oretail

2. Locate the patch_info.cfg within the product media. The directory it resides in will be used for later steps.

3. find /media/oretail/rms/installer –name patch_info.cfg

4. Output Example:

5. /media/oretail/rms/installer/mom/patch_info.cfg

6. Get the PATCH_NAME for the standard product installation. The patch name to use in subsequent steps will be the portion following the “=” sign.

grep “PATCH_NAME=” /media/oretail/rms/installer/mom/patch_info.cfg

Output Example:

PATCH_NAME=MOM_16_0_0_0

7. Create a directory that will contain the patch that must be applied, next to the directory with the product installation files.

Note: The following steps assume this directory is in /media/patch.

8. Unzip the patch into the directory created in step 2.

Note: This should place the patch contents in /media/patch/<patch num>.

9. Export RETAIL_HOME to point within the installation staging area.

export RETAIL_HOME=/media/oretail/rms/installer/mom/Build

10. Create a logs directory within the installation staging area

mkdir $RETAIL_HOME/orpatch/logs

11. Ensure the ORMerge shell script is executable.

chmod u+x $RETAIL_HOME/orpatch/bin/ormerge

12. Run ORMerge to apply the patch to the installation media, using a –name argument that is the same as what was found in step 3.

$RETAIL_HOME/orpatch/bin/ormerge -s /media/patch -d /media/oretail/rms/installer/mom –name MOM_16_0_0_0 –inplace

Note: The –inplace argument is critical to ensure that the patching replaces files in the mom15 directory.

13. Unset the RETAIL_HOME environment variable.

unset RETAIL_HOME

At this point, the installation files will have been updated with the newer versions of files contained within the patch. Log files for the merge will be in /media/oretail/rms/installer/mom/Build/orpatch/logs.

Providing Metadata to Oracle Support

In some situations, it may be necessary to provide details of the metadata from an environment to Oracle support in order to assist with investigating a patching or application problem. ORPatch provides built-in functionality through the ‘exportmetadata’ action to extract and consolidate metadata information for uploading to Oracle Support or for external analysis. For more information, see the ORPatch ‘Exporting Environment Metadata’ section.

Appendix: RMS Database Schema and Batch Installation Screens

You need the following details about your environment for the installer to successfully create the RMS database schema and install the RMS batch programs. Depending on the options you select, you may not see some screens or fields.

The RMS database schema installation also includes the option to install the database schema objects for the ReIM and Allocation products. The RPM database schema objects will be included with RMS.

Screen: Component Selection

Field Title	Component Selection
Field Description	Select the RMS component(s) you would like to install. Multiple components may be selected. You will not be able to install a component if the preinstall check for that component has failed. Subsequent screens may or may not be displayed based on this choice.

Screen: Database Component Selection

Field Title	Database Component Selection
Field Description	By default, the RMS database schema installer creates database objects for RMS/ReSA/RTM and RPM. Optionally, the database objects for ReIM, Allocation and/or RMS DAS Schema may be installed at the same time or later. Subsequent screens may or may not be displayed based on this choice.
Note	RMS DAS Schema is applicable if setting up DAS.

Screen: Full Install or Patch

Field Title	Full Install or Patch
Field Description	The installer can create either the full baseline schema or upgrade an existing installation. To install a new instance of RMS 16.0 release, select Full. If upgrading from 15.0.1, please select Patch. Subsequent screens may or may not be displayed based on this choice.
Example	Full

Screen: Host Details

Field Title	Hostname
Field Description	Provide the hostname of the Oracle Database Server.
Example	dbhostname

Screen: JDBC Security Details

Field Title	Enable Secure JDBC connection
Field Description	Select Yes to use a secure jdbc connection during installation, otherwise choose No. A secure data base connection must already be set up if you want to use this option.

Screen: JDBC URL Details

Field Title

RMS JDBC URL

Field Description

URL used by the RMS application to access the RMS database schema. See Appendix: URL Reference for expected syntax.

Examples

For Non Secure JDBC Connection:

jdbc:oracle:oci:@mydb

jdbc:oracle:thin:@dbhostname:1521/mydb

For Secure JDBC Connection: jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=tcps)(HOST=dbhostname)(PORT=2484)))(CONNECT_DATA=(SERVICE_NAME=mydb)))

Screen: RMS Database Schema Details

Field Title	RMS schema
Field Description	Provide the RMS database user here. The installer logs into the database as this user to create the RMS schema and uses it to compile RMS batch. This user must already exist in the database when the RMS database schema installer is run.
Example	rms01

Field Title	RMS schema password
Field Description	Database password for the RMS Schema Owner.

Field Title	RMS Oracle SID
Field Description	Oracle system identifier for the database where RMS will be installed
Example	mydb

Field Title	RMS Schema Security Alias
Field Description	The alias to store the schema credentials.
Example	dsRMSAlias
Note	This alias must be unique. Do not use the same value for any other alias fields in the installer. If the same alias is used, entries in the wallet can override each other and cause problems with the application.

Screen: Secure Data Source Details

Note: This screen appears only if you have enabled ’Secure JDBC’ for RMS. Ignore this step in case you have not enabled ‘Secure JDBC’ for RMS.

Field Title

Identity Keystore

Field Description

Keystores ensure the secure storage and management of private keys and trusted certificate authorities (CAs). This screen lets you provide the keystore to be used for datasource connection These settings help you to manage the security of message transmissions. For further information, please refer MOM security Guide.

Location or path where identity keystore file is stored.

Field Title

Identity Keystore Type

Field Description

Type of the identity keystore used.

Exampe: jks

Field Title	Identity Keystore Passphrase
Field Description	The password to access the keystore mentioned above.

Field Title	Identity truststore
Field Description	Location or path where identity truststore file is stored.

Field Title

Identity truststore Type

Field Description

Type of the identity truststore used.

Exampe: jks

Field Title	Identity truststore Passphrase
Field Description	The password to access the truststore mentioned above.

The database settings provided are validated by the installer when you advance to the next screen.

Screen: BDI Integration Schema Details

Field Title	BDI Integration Schema
Field Description	Provide the RMS BDI Integration database user here. The installer logs into the database as this user to create the RMS BDI Integration schema. This user must already exist in the database when the RMS database schema installer is run.
Example	BDI_RMS_INT_SCHEMA

Field Title	BDI Integration Schema Password
Field Description	Database password for the RMS BDI Integration database user.

Field Title	BDI Integration Schema Security Alias
Field Description	The alias to store the schema credentials.
Example	dsRMSBDIIntAlias
Note	This alias must be unique. Do not use the same value for any other alias fields in the installer. If the same alias is used, entries in the wallet can override each other and cause problems with the application.

The database settings provided are validated by the installer when you advance to the next screen.

Screen: BDI Infrastructure Schema Details

Field Title	BDI InfrastructureSchema
Field Description	Provide the RMS BDI Infrastructure database user here. The installer logs into the database as this user to create the RMS BDI Infrastructure schema. This user must already exist in the database when the RMS database schema installer is run.
Example	BDI_RMS_INFR_SCHEMA

Field Title	BDI Infrastructure Schema Password
Field Description	Database password for the RMS BDI Infrastructure database user.

Field Title	BDI Infrastructure Schema Security Alias
Field Description	The alias to store the schema credentials.
Example	dsRMSBDIInfrAlias
Note	This alias must be unique. Do not use the same value for any other alias fields in the installer. If the same alias is used, entries in the wallet can override each other and cause problems with the application.

The database settings provided are validated by the installer when you advance to the next screen.

Screen: Allocation Database Schema Details

Field Title	Alloc schema
Field Description	Provide the Allocation database user here. The installer logs into the database as this user to create the Allocation schema objects. This user must already exist in the database when the database schema installer is run.
Example	alloc01

Field Title

Alloc schema password

Field Description

Database password for the Allocation database user.

Field Title	Alloc Schema Security Alias
Field Description	The alias to store the schema credentials.
Example	dsAllocAlias
Note	This alias must be unique. Do not use the same value for any other alias fields in the installer. If the same alias is used, entries in the wallet can override each other and cause problems with the application.

The database settings provided are validated by the installer when you advance to the next screen.

Screen: RMS DAS JDBC URL Details

Field Title	RMS DAS JDBC URL
Field Description	URL used by the RMS application to access the RMS DAS database schema. See Appendix: URL Reference for expected syntax.
Examples	For Non Secure JDBC Connection: jdbc:oracle:oci:@mydasdb or jdbc:oracle:thin:@dbhostname:1521/mydasdb For Secure JDBC Connection: jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=tcps)(HOST=dbhostname)(PORT=2484)))(CONNECT_DATA=(SERVICE_NAME=mydasdb)))
Note	The DAS Schema must be created in a different database instance than that of RMS schema.

Screen: RMS DAS Database Schema Details

Field Title	RMS DAS schema
Field Description	Provide the RMS DAS database user here. The installer logs into the database as this user to create the DAS schema objects. This user must already exist in the database when the database schema installer is run.
Example	rms01das

Field Title	RMS DAS schema password
Field Description	Database password for the RMS DAS schema.

Field Title	RMS DAS Schema Oracle SID
Field Description	Oracle system identifier for the database where RMS DAS schema will be installed.
Example	mydasdb
Note	The DAS Schema must be created in a different database instance than that of RMS schema.

Field Title	RMS DAS Schema Security Alias
Field Description	The alias to store the schema credentials.
Example	dsRMSDASAlias
Note	This alias must be unique. Do not use the same value for any other alias fields in the installer. If the same alias is used, entries in the wallet can override each other and cause problems with the application.

The database settings provided are validated by the installer when you advance to the next screen.

Note: The next 18 screens are only shown for a FULL installation, and not for UPGRADE installation.

Screen: RMS Primary Country

Field Title	Primary Country
Field Description	Choose your primary country from the dropdown list provided.
Example	UNITED STATES OF AMERICA (US)

Screen: RMS Primary Currency

Field Title	Primary Currency
Field Description	Choose your primary currency from the dropdown list provided.
Example	United States Dollar (USD)

Screen: RMS Primary Language

Field Title	Primary Language
Field Description	Choose your primary language from the dropdown list provided.
Example	English (en)

Screen: RMS Default Tax Type

Field Title

Default Tax type

Field Description

Select the tax type that will be used with the system.

SVAT: Simple Value-Added Tax (VAT information is configured in RMS)

SALES: Sales and Use Tax

If VAT is enabled, then select SVAT. For a configuration with only Sales Tax, Select SALES.

Note: The RMS Class level VAT screen is only shown if SVAT is selected on the Default Tax Type.

Screen: RMS Class-Level Value-Added Tax

Field Title	Enable Class-Level VAT
Field Description	Check the box to allow tax rates to be maintained at the class level. Leave the box unchecked to restrict tax rates.

Screen: RMS Calendar Type

Field Title	Select Calendar Type
Field Description	Choose the type of calendar to use.

Screen: RMS Calendar Week Option

Field Title	Select Week Start-End
Field Description	Select the range that defines the first and last days of the week.

Screen: RMS Calendar VDate

Field Title	VDate
Field Description	Enter the first date the RMS System will be in operation. The format dd-MMM-yyyy must be used.
Example	16-NOV-2016

Screen: HTS Tracking Level

Field Title	HTS Tracking Level
Field Description	Select the basis for HTS tariffs and fees. The options are either the item’s country of manufacturer or the item’s country of sourcing.

Screen: Data Level Security

Field Title	Enable Data Level Security?
Field Description	Indicates if data level security is being utilized in the system.

Screen: RIB CLOB Settings

Field Title

XML Schema Base URL

Field Description

URL for the RIB object schema definition.

Example

http://hostname:7777/rib-func-artifact/

Note: Here, the host and ports must be from RIB that is probably installed later.

Field Title	XML Namespace URL
Field Description	URL for the RIB object namespace.
Example	http://www.oracle.com/retail/integration/base/bo

Field Title	XML XSI URL
Field Description	URL for the XML schema instance.
Example	http://www.w3.org/2001/XMLSchema-instance

Screen: Load RMS Demo Data

Field Title	Insert Demo Data
Field Description	The Installer by default loads seed data for RMS. Check the box to insert RMS demo data in addition to seed data.
Note	Demo data should not be installed in production environments. See the warning screen below for more details.

Screen: Load ReIM Demo Data

Note: The Load ReIM Demo Data screen is only shown if Insert Demo Data is checked in the previous screen and ReIM is selected in the beginning of the installation.

Field Title	Insert ReIM Demo Data
Field Description	Check the box to insert ReIM demo data.
Note	Demo data should not be installed in production environments. See the warning screen below for more details.

Screen: Demo Data Warning

Note: This screen is shown only if a Demo Data option is selected in the previous screens. Please read the Warning carefully.

Screen: RMS Demo Data Schema Details

Field Title	Demo Data schema
Field Description	Schema that will be used to insert demo data into the RMS database.
Example	rms01demo

Field Title	Demo Data schema password
Field Description	Password for the demo data schema.

Field Title	Demo Data Schema Security Alias
Field Description	The alias to store the schema credentials.
Example	dsDemoDataAlias
Note	This alias must be unique. Do not use the same value for any other alias fields in the installer. If the same alias is used, entries in the wallet can override each other and cause problems with the application.

The database settings provided are validated by the installer when you advance to the next screen.

Screen: RMS Demo Data – Number of Items

Field Title	Number of demo items
Field Description	The number of demo data items to create.
Example	15

Screen: RMS Demo Data – Transaction Level

Field Title	Transaction Level
Field Description	Value to use for the transaction level of the demo items being created.
Example	1 (Line)

Screen: RMS Database RETAIL_HOME

Field Title	RMS DB RETAIL_HOME
Field Description	The location where the RMS Database Files are stored by the installer. This location will be used during the subsequent patching of RMS, and will contain the ORPatch utility.
Example	/path/to/retail_home
Note	If you have selected an existing RETAIL_HOME, and it has been configured to run other components than the ones you have selected for this installation, those components will also be installed regardless of what you selected on the Component Selection screen.

Screen: RMS Batch RETAIL_HOME

Field Title	RMS Batch RETAIL_HOME
Field Description	This is the Batch Installation Directory, the location where RMS Batch Files will be installed along with the ORPATCH utility. This can be the same RETAIL_HOME that was used for another component.
Example	/path/to/retail_home
Note	If you have selected an existing RETAIL_HOME, and it has been configured to run other components than the ones you have selected for this installation, those components will also be installed regardless of what you selected on the Component Selection screen.

Screen: Oracle Wallet

Field Title	Oracle Wallet
Oracle Wallet Password	This is the password for the wallet that will store the credentials used during the RMS installation. If you have selected an existing RETAIL_HOME in the previous screens, you will need to enter the password that was used for the wallet in that RETAIL_HOME.
Note	Make sure this password is kept as it will be needed for future upgrades.

Appendix: RMS Application Installer Screens

Screen: Component Selection

Field Title	Component Selection
Field Description	Select the RMS component(s) you would like to install. Multiple components may be selected. You will not be able to install a component if the preinstall check for that component has failed. Subsequent screens may or may not be displayed based on this choice.

Screen: Full Install or Upgrade

Field Title	Full Install or Patch
Field Description	The option selected on this page has no impact on the RMS installation. All Application installations will be full installations.
Example	Full

Screen: Host Details

Field Title	Hostname
Field Description	Provide the hostname where the RMS Application is being installed.
Example	apphostname

Screen: JDBC Security Details

Field Title	Enable Secure JDBC connection
Field Description	Select Yes to create secured data sources in WebLogic, otherwise choose No. A secure data base connection must already be set up if you want to create a secure data source.

Screen: JDBC URL Details

Field Title

RMS JDBC URL

Field Description

URL used by the RMS application to access the RMS database schema. See Appendix: URL Reference for expected syntax.

Examples

For Non Secure JDBC Connection:

jdbc:oracle:oci:@mydb

jdbc:oracle:thin:@dbhostname:1521/mydb

For Secure JDBC Connection: jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=tcps)(HOST=dbhostname)(PORT=2484)))(CONNECT_DATA=(SERVICE_NAME=mydb)))

Screen: RMS Database Schema Details

Field Title	RMS schema
Field Description	Provide the RMS database user here. The installer logs into the database as this user to create the RMS schema and uses it to compile RMS batch. This user must already exist in the database when the RMS database schema installer is run.
Example	rms01

Field Title	RMS schema password
Field Description	Database password for the RMS Schema Owner.

Field Title	RMS Oracle SID
Field Description	Oracle system identifier for the database where RMS will be installed
Example	mydb

Field Title	RMS Schema Security Alias
Field Description	The alias to store the schema credentials.
Example	dsRMSAlias
Note	This alias must be unique. Do not use the same value for any other alias fields in the installer. If the same alias is used, entries in the wallet can override each other and cause problems with the application.

Screen: Secure Data Source Details

Note: This screen appears only if you have enabled ’Secure JDBC’ for RMS. Ignore this step in case you have not enabled ‘Secure JDBC’ for RMS.

Field Title

Identity Keystore

Field Description

Location or path where identity keystore file is stored.

Field Title

Identity Keystore Type

Field Description

Type of the identity keystore used.

Exampe: jks

Field Title	Identity Keystore Passphrase
Field Description	The password to access the keystore mentioned above.

Field Title	Identity truststore
Field Description	Location or path where identity truststore file is stored.

Field Title

Identity truststore Type

Field Description

Type of the identity truststore used.

Exampe: jks

Field Title	Identity truststore Passphrase
Field Description	The password to access the truststore mentioned above.

The database settings provided are validated by the installer when you advance to the next screen.

Screen: WebLogic Administrative Details

Field Title	Weblogic Admin port
Field Description	Listen port for the WebLogic Admin server.
Example	7001

Field Title	Weblogic Admin User
Field Description	Username of the admin user for the WebLogic instance to which the RMS application will be deployed
Example	weblogic

Field Title	Weblogic Admin Password
Field Description	Password for the WebLogic admin user. You chose this password when you created the WebLogic instance.

Field Title	Weblogic Admin User Security Alias
Field Description	An alias for the WebLogic admin user.
Example	wlsAlias
Note	This alias must be unique. Do not use the same value for any other alias fields in the installer. If the same alias is used, entries in the wallet can override each other and cause problems with the application.

Field Title	SSL Enabled(Admin Server)?
Field Description	Choose Yes to install RMS using a WebLogic admin server configured to use SSL. In this case, SSL must be configured and the ports must be enabled for the admin server. Choose No to install using a WebLogic admin server configured without SSL. In this case the non-SSL ports must be enabled for the admin server.

Screen: RMS Application Deployment Details

Field Title	RMS App Deployment Name
Field Description	Name by which this RMS application is identified in the application server.
Example	Rms
Note	The exact string “Rms” must be used for RMS to function properly with ORAAC. The default value of “rms” should not be used.

Field Title	RMS server/cluster
Field Description	Name of the RMS WebLogic managed server or cluster.
Example	rms_server1

Field Title	SSL Enabled(RMS Server/Cluster)?
Field Description	Choose Yes to install RMS into a managed server/cluster configured to use SSL. In this case, SSL must be configured and the ports must be enabled for the managed server/cluster. Choose No to install into a managed server/cluster configured without SSL. In this case the non-SSL ports must be enabled for the managed server/cluster.

Screen: Deploy Mobile ReST Services

Field Title	Deploy Mobile ReST Services Apps?
Field Description	Choosing Yes deploy’s the Mobile ReST Services Apps. Choosing no will not deploy the Mobile ReST Services Apps

Screen: Enable Secure Cookies using JSESSIONID Flag

Field Title	Enable Secure Cookies using JSESSIONID Flag?
Field Description	Selecting “Yes” will enable secure cookies using JSESSIONID Flag. Selecting “No” will not enable secure cookies using JSESSIONID Flag.

Screen: Harden HTTP Transport

Field Title	Enable Harden HTTP Transport?
Field Description	Selecting “Yes” will enable Harden HTTP Transport. Selecting “No” will not enable Harden HTTP Transport.

Screen: OHS Web Tier

Field Title	Are you running an OHS web tier for use in Oracle Single Sign-On and/or a Clustered Environment?
Field Description	Selecting the option ‘Yes’ will configure all the application URLs delivered by this installer with the OHS webtier hostname and port that will be entered in the next screen. Selecting option ‘No’ will result in application URLs having default hosts and ports.

Screen: OHS Web Tier Details

This screen appears only if you have selected Yes in the previous screen.

Field Title	OHS web tier connection protocol
Field Description	Connection protocol for OHS web tier – http or https

Field Title	OHS web tier host
Field Description	Host name for OHS web tier
Example	webtierhostname

Field Title	OHS web tier port
Field Description	Port number for OHS web tier
Example	7777

Screen: Enable BIPublisher Integration?

Field Title	Enable BIPublisher Integration?
Field Description	Selecting the option ‘Yes’ will configure RMS to use the BIPublisher url that will be entered in the next screen. Selecting option ‘No’ will result RMS not being configured to use BIPublisher.

Screen: BIPublisher Details

This screen appears only if you have selected Yes in the previous screen.

Field Title	BIPublisher URL
Field Description	The url through which the RMS application will access RMS BIPublisher reports
Example	https://mybiphost:7323/xmlpserver/Guest/RMS

Screen: RMS Application RETAIL_HOME

Field Title	RMS Application RETAIL_HOME
Field Description	Retail Home is used to keep Orpatch related files, batches etc. by default. Please keep track of this directory, it should remain in place after installation and will be used to apply future patches.
Example	/path/to/retail_home
Note	If upgrading an existing RMS installation, please choose a RETAIL_HOME location different than one used previously to install an RMS 15.0.x or earlier application. If you have selected an existing RETAIL_HOME, and it has been configured to run other components than the ones you have selected for this installation, those components will also be installed regardless of what you selected on the Component Selection screen.

Appendix: Setting Up Password Stores with wallets/credential stores

As part of an application installation, administrators must set up password stores for user accounts using wallets/credential stores. Some password stores must be installed on the application database side. While the installer handles much of this process, the administrators must perform some additional steps.

Password stores for the application and application server user accounts must also be installed; however, the installer takes care of this entire process.

ORACLE Retail Merchandising applications now have 3 different types of password stores. They are database wallets, java wallets, and database credential stores. Background and how to administer them below are explained in this appendix

About Database Password Stores and Oracle Wallet

Oracle databases have allowed other users on the server to see passwords in case database connect strings (username/password@db) were passed to programs. In the past, users could navigate to ps –ef|grep <username> to see the password if the password was supplied in the command line when calling a program.

To make passwords more secure, Oracle Retail has implemented the Oracle Software Security Assurance (OSSA) program. Sensitive information such as user credentials now must be encrypted and stored in a secure location. This location is called password stores or wallets. These password stores are secure software containers that store the encrypted user credentials.

Users can retrieve the credentials using aliases that were set up when encrypting and storing the user credentials in the password store. For example, if username/password@db is entered in the command line argument and the alias is called db_username, the argument to a program is as follows:

sqlplus /@db_username

This would connect to the database as it did previously, but it would hide the password from any system user.

After this is configured, as in the example above, the application installation and the other relevant scripts are no longer needed to use embedded usernames and passwords. This reduces any security risks that may exist because usernames and passwords are no longer exposed.

When the installation starts, all the necessary user credentials are retrieved from the Oracle Wallet based on the alias name associated with the user credentials.

There are three different types of password stores. One type explain in the next section is for database connect strings used in program arguments (such as sqlplus /@db_username). The others are for Java application installation and application use.

Setting Up Password Stores for Database User Accounts

After the database is installed and the default database user accounts are set up, administrators must set up a password store using the Oracle wallet. This involves assigning an alias for the username and associated password for each database user account. The alias is used later during the application installation. This password store must be created on the system where the application server and database client are installed.

This section describes the steps you must take to set up a wallet and the aliases for the database user accounts. For more information on configuring authentication and password stores, see the Oracle Database Security Guide.

Note: In this section, <wallet_location> is a placeholder text for illustration purposes. Before running the command, ensure that you specify the path to the location where you want to create and store the wallet.

To set up a password store for the database user accounts, perform the following steps:

1. Create a wallet using the following command:

mkstore -wrl <wallet_location> -create

After you run the command, a prompt appears. Enter a password for the Oracle Wallet in the prompt.

Note: The mkstore utility is included in the Oracle Database Client installation.

The wallet is created with the auto-login feature enabled. This feature enables the database client to access the wallet contents without using the password. For more information, refer to the Oracle Database Advanced Security Administrator's Guide.

2. Create the database connection credentials in the wallet using the following command:

mkstore -wrl <wallet_location> -createCredential <alias-name> <database-user-name>

After you run the command, a prompt appears. Enter the password associated with the database user account in the prompt.

3. Repeat Step 2 for all the database user accounts.

4. Update the sqlnet.ora file to include the following statements:

WALLET_LOCATION = (SOURCE = (METHOD = FILE) (METHOD_DATA = (DIRECTORY = <wallet_location>)))

SQLNET.WALLET_OVERRIDE = TRUE

SSL_CLIENT_AUTHENTICATION = FALSE

5. Update the tnsnames.ora file to include the following entry for each alias name to be set up.

<alias-name> =

(DESCRIPTION =

(ADDRESS_LIST =

(ADDRESS = (PROTOCOL = TCP) (HOST = <host>) (PORT = <port>))

)

(CONNECT_DATA =

(SERVICE_NAME = <service>)

)

In the previous example, <alias-name>, <host>, <port>, and <service> are placeholder text for illustration purposes. Ensure that you replace these with the relevant values.

Setting up Wallets for Database User Accounts

The following examples show how to set up wallets for database user accounts for the following applications:

§ For RMS, RWMS, RPM Batch using sqlplus or sqlldr, RETL, RMS and RWMS

For RMS, RWMS, RPM Batch using sqlplus or sqlldr, RETL, RMS, and RWMS

To set up wallets for database user accounts, do the following.

1. Create a new directory called wallet under your folder structure.

cd /projects/rms16/dev/

mkdir .wallet

Note: The default permissions of the wallet allow only the owner to use it, ensuring the connection information is protected. If you want other users to be able to use the connection, you must adjust permissions appropriately to ensure only authorized users have access to the wallet.

2. Create a sqlnet.ora in the wallet directory with the following content.

WALLET_LOCATION = (SOURCE = (METHOD = FILE) (METHOD_DATA = (DIRECTORY = /projects/rms16/dev/.wallet)) )

SQLNET.WALLET_OVERRIDE=TRUE
SSL_CLIENT_AUTHENTICATION=FALSE

Note: WALLET_LOCATION must be on line 1 in the file.

3. Setup a tnsnames.ora in the wallet directory. This tnsnames.ora includes the standard tnsnames.ora file. Then, add two custom tns_alias entries that are only for use with the wallet. For example, sqlplus /@dvols29_rms01user.

ifile = /u00/oracle/product/12.1.0.2/network/admin/tnsnames.ora

Examples for a NON pluggable db:

dvols29_rms01user =

(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = tcp)

(host = xxxxxx.us.oracle.com) (Port = 1521)))

(CONNECT_DATA = (SID = <sid_name> (GLOBAL_NAME = <sid_name>)))

dvols29_rms01user.world =

(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = tcp)

(host = xxxxxx.us.oracle.com) (Port = 1521)))

(CONNECT_DATA = (SID = <sid_name>) (GLOBAL_NAME = <sid_name>)))

Examples for a pluggable db:

dvols29_rms01user =

(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = tcp)

(host = xxxxxx.us.oracle.com) (Port = 1521)))

(CONNECT_DATA = (SERVICE_NAME = <pluggable db name>)))

dvols29_rms01user.world =

(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = tcp)

(host = xxxxxx.us.oracle.com) (Port = 1521)))

(CONNECT_DATA = (SERVICE_NAME = <pluggable db name>)))

Note: It is important to not just copy the tnsnames.ora file because it can quickly become out of date. The ifile clause (shown above) is key.

4. Create the wallet files. These are empty initially.

a. Ensure you are in the intended location.

$ pwd
/projects/rms16/dev/.wallet

b. Create the wallet files.

$ mkstore -wrl . –create

c. Enter the wallet password you want to use. It is recommended that you use the same password as the UNIX user you are creating the wallet on.

d. Enter the password again.

Two wallet files are created from the above command:

– ewallet.p12

– cwallet.sso

5. Create the wallet entry that associates the user name and password to the custom tns alias that was setup in the wallet’s tnsnames.ora file.

mkstore –wrl . –createCredential <tns_alias> <username> <password>

Example: mkstore –wrl . –createCredential dvols29_rms01user rms01user passwd

6. Test the connectivity. The ORACLE_HOME used with the wallet must be the same version or higher than what the wallet was created with.

$ export TNS_ADMIN=/projects/rms16/dev/.wallet /* This is very import to use wallet to point at the alternate tnsnames.ora created in this example */

$ sqlplus /@dvols29_rms01user

SQL*Plus: Release 12

Connected to:

Oracle Database 12g

SQL> show user

USER is “rms01user”

Running batch programs or shell scripts would be similar:

Ex: dtesys /@dvols29_rms01user

script.sh /@dvols29_rms01user

Set the UP unix variable to help with some compiles :

export UP=/@dvols29_rms01user

for use in RMS batch compiles, and RMS, RWMS forms compiles.

As shown in the example above, users can ensure that passwords remain invisible.

Additional Database Wallet Commands

The following is a list of additional database wallet commands.

§ Delete a credential on wallet

mkstore –wrl . –deleteCredential dvols29_rms01user

§ Change the password for a credential on wallet

mkstore –wrl . –modifyCredential dvols29_rms01user rms01user passwd

§ List the wallet credential entries

mkstore –wrl . –list

This command returns values such as the following.

oracle.security.client.connect_string1

oracle.security.client.user1

oracle.security.client.password1

§ View the details of a wallet entry

mkstore –wrl . –viewEntry oracle.security.client.connect_string1

Returns the value of the entry:

dvols29_rms01user

mkstore –wrl . –viewEntry oracle.security.client.user1

Returns the value of the entry:

rms01user

mkstore –wrl . –viewEntry oracle.security.client.password1

Returns the value of the entry:

Passwd

Setting up RETL Wallets

RETL creates a wallet under $RFX_HOME/etc/security, with the following files:

§ cwallet.sso

§ jazn-data.xml

§ jps-config.xml

§ README.txt

To set up RETL wallets, perform the following steps:

1. Set the following environment variables:

§ ORACLE_SID=<retaildb>

§ RFX_HOME=/u00/rfx/rfx-13

§ RFX_TMP=/u00/rfx/rfx-13/tmp

§ JAVA_HOME=/usr/jdk1.6.0_12.64bit

§ LD_LIBRARY_PATH=$ORACLE_HOME

§ PATH=$RFX_HOME/bin:$JAVA_HOME/bin:$PATH

2. Change directory to $RFX_HOME/bin.

3. Run setup-security-credential.sh.

§ Enter 1 to add a new database credential.

§ Enter the dbuseralias. For example, retl_java_rms01user.

§ Enter the database user name. For example, rms01user.

§ Enter the database password.

§ Re-enter the database password.

§ Enter D to exit the setup script.

4. Update your RETL environment variable script to reflect the names of both the Oracle Networking wallet and the Java wallet.

For example, to configure RETLforRPAS, modify the following entries in
$RETAIL_HOME/RETLforRPAS/rfx/etc/rmse_rpas_config.env.

§ The RETL_WALLET_ALIAS should point to the Java wallet entry:

– export RETL_WALLET_ALIAS="retl_java_rms01user"

§ The ORACLE_WALLET_ALIAS should point to the Oracle network wallet entry:

– export ORACLE_WALLET_ALIAS="dvols29_rms01user"

§ The SQLPLUS_LOGON should use the ORACLE_WALLET_ALIAS:

– export SQLPLUS_LOGON="/@${ORACLE_WALLET_ALIAS}"

5. To change a password later, run setup-security-credential.sh.

§ Enter 2 to update a database credential.

§ Select the credential to update.

§ Enter the database user to update or change.

§ Enter the password of the database user.

§ Re-enter the password.

For Java Applications (SIM, ReIM, RPM, RIB, AIP, Alloc, ReSA, RETL)

For Java applications, consider the following:

§ For database user accounts, ensure that you set up the same alias names between the password stores (database wallet and Java wallet). You can provide the alias name during the installer process.

§ Document all aliases that you have set up. During the application installation, you must enter the alias names for the application installer to connect to the database and application server.

§ Passwords are not used to update entries in Java wallets. Entries in Java wallets are stored in partitions, or application-level keys. In each retail application that has been installed, the wallet is located in <WEBLOGIC_DOMAIN_HOME>/retail/<appname>/config Example:
/u00/webadmin/config/domains/wls_retail/RPMDomain/retail/rpm/config

§ Application installers should create the Java wallets for you, but it is good to know how this works for future use and understanding.

§ Scripts are located in <WEBLOGIC_DOMAIN_HOME>/retail/<appname>/retail-public-security-api/bin for administering wallet entries.

§ Example:

§ /u00/webadmin/config/domains/wls_retail/RPMDomain/retail/rpm/retail-public-security-api/bin

§ In this directory is a script to help you update each alias entry without having to remember the wallet details. For example, if you set the RPM database alias to rms01user, you will find a script called update-RMS01USER.sh.

Note: These scripts are available only with applications installed by way of an installer.

§ Two main scripts are related to this script in the folder for more generic wallet operations: dump_credentials.sh and save_credential.sh.

§ If you have not installed the application yet, you can unzip the application zip file and view these scripts in <app>/application/retail-public-security-api/bin.

§ Example:

§ /u00/webadmin/rpm/application/rpm/Build/orpatch/deploy/retail-public-security-api/bin

update-<ALIAS>.sh

update-<ALIAS>.sh updates the wallet entry for this alias. You can use this script to change the user name and password for this alias. Because the application refers only to the alias, no changes are needed in application properties files.

Usage:

update-<username>.sh <myuser>

Example:

/u00/webadmin/config/domains/wls_retail/RPMDomain/retail/rpm/retail-public-security-api/bin> ./update-RMS01USER.sh

usage: update-RMS01USER.sh <username>

<username>: the username to update into this alias.

Example: update-RMS01USER.sh myuser

Note: this script will ask you for the password for the username that you pass in.

/u00/webadmin/config/domains/wls_retail/RPMDomain/retail/rpm/retail-public-security-api/bin>

dump_credentials.sh

dump_credentials.sh is used to retrieve information from wallet. For each entry found in the wallet, the wallet partition, the alias, and the user name are displayed. Note that the password is not displayed. If the value of an entry is uncertain, run save_credential.sh to resave the entry with a known password.

dump_credentials.sh <wallet location>

Example:

dump_credentials.sh location: /u00/webadmin/config/domains/wls_retail/RPMDomain/retail/rpm/config

Retail Public Security API Utility

=============================================

Below are the credentials found in the wallet at the location/u00/webadmin/config/domains/wls_retail/RPMDomain/retail/rpm/config

=============================================

Application level key partition name:rpm
User Name Alias:WLS-ALIAS User Name:weblogic
User Name Alias:RETAIL-ALIAS User Name:retail.user
User Name Alias:LDAP-ALIAS User Name:RETAIL.USER
User Name Alias:RMS-ALIAS User Name:rms16mock
User Name Alias:REIMBAT-ALIAS User Name:rpmbat

save_credential.sh

save_credential.sh is used to update the information in wallet. If you are unsure about the information that is currently in the wallet, use dump_credentials.sh as indicated above.

save_credential.sh -a <alias> -u <user> -p <partition name> –l <path of the wallet file location where credentials are stored>

Example:

/u00/webadmin/mock16_testing/rpm16/application/retail-public-security-api/bin> save_credential.sh -l wallet_test -a myalias -p mypartition -u myuser

=============================================

Retail Public Security API Utility

=============================================

Enter password:

Verify password:

Note: -p in the above command is for partition name. You must specify the proper partition name used in application code for each Java application.

save_credential.sh and dump_credentials.sh scripts are the same for all applications. If using save_credential.sh to add a wallet entry or to update a wallet entry, bounce the application/managed server so that your changes are visible to the application. Also, save a backup copy of your cwallet.sso file in a location outside of the deployment path, because redeployment or reinstallation of the application will wipe the wallet entries you made after installation of the application. To restore your wallet entries after a redeployment/reinstallation, copy the backed up cwallet.sso file over the cwallet.sso file. Then bounce the application/managed server.

Usage

=============================================

Retail Public Security API Utility

=============================================

usage: save_credential.sh -au[plh]

E.g. save_credential.sh -a rms-alias -u rms_user -p rib-rms -l ./

-a,--userNameAlias <arg> alias for which the credentials

needs to be stored

-h,--help usage information

-l,--locationofWalletDir <arg> location where the wallet file is

created.If not specified, it creates the wallet under secure-credential-wallet directory which is already present under the retail-public-security-api/ directory.

-p,--appLevelKeyPartitionName <arg> application level key partition name

-u,--userName <arg> username to be stored in secure

credential wallet for specified alias*

How does the Wallet Relate to the Application?

The ORACLE Retail Java applications have the wallet alias information you create in an <app-name>.properties file. Below is the reim.properties file. Note the database information and the user are presented as well. The property called datasource.credential.alias=RMS-ALIAS uses the ORACLE wallet with the argument of RMS-ALIAS at the csm.wallet.path and csm.wallet.partition.name = rpm to retrieve the password for application use.

Reim.properties code sample:

datasource.url=jdbc:oracle:thin:@xxxxxxx.us.oracle.com:1521:pkols07

datasource.schema.owner=rms16mock

datasource.credential.alias=RMS-ALIAS

# =================================================================

# ossa related Configuration

# These settings are for ossa configuration to store credentials.

# =================================================================

csm.wallet.path=/u00/webadmin/config/domains/wls_retail/RPMDomain/retail/rpm/config

csm.wallet.partition.name=rpm

How does the Wallet Relate to Java Batch Program use?

Some of the ORACLE Retail Java batch applications have an alias to use when running Java batch programs. For example, alias REIMBAT-ALIAS maps through the wallet to dbuser RMS01APP, already on the database. To run a ReIM batch program the format would be: reimbatchpgmname REIMBAT-ALIAS <other arguments as needed by the program in question>

Database Credential Store Administration

The following section describes a domain level database credential store. This is used in RPM login processing, SIM login processing, RWMS login processing, RESA login processing and Allocation login processing and policy information for application permission. Setting up the database credential store is addressed in the RPM, SIM, RESA, RWMS, and Alloc install guides.

The following sections show an example of how to administer the password stores thru ORACLE Enterprise Manger Fusion Middleware Control, a later section will show how to do this thru WLST scripts.

1. The first step is to use your link to Oracle Enterprise Manager Fusion Middleware Control for the domain in question. Locate your domain on the left side of the screen and do a right mouse click on the domain and select Security > Credentials

2. Click on Credentials and you will get a screen similar to the following. The following screen is expanded to make it make more sense. From here you can administer credentials.

The Create Map add above is to create a new map with keys under it. A map would usually be an application such as rpm. The keys will usually represent alias to various users (database user, WebLogic user, LDAP user, etc). The application installer should add the maps so you should not often have to add a map.

Creation of the main keys for an application will also be built by the application installer. You will not be adding keys often as the installer puts the keys out and the keys talk to the application. You may be using EDIT on a key to see what user the key/alias points to and possibly change/reset its password. To edit a key/alias, highlight the key/alias in question and push the edit icon nearer the top of the page. You will then get a screen as follows:

The screen above shows the map (rpm) that came from the application installer, the key (DB-ALIAS) that came from the application installer (some of the keys/alias are selected by the person who did the application install, some are hard coded by the application installer in question), the type (in this case password), and the user name and password. This is where you would check to see that the user name is correct and reset the password if needed. REMEMBER, a change to an item like a database password WILL make you come into this and also change the password. Otherwise your application will NOT work correctly.

Managing Credentials with WSLT/OPSS Scripts

This procedure is optional as you can administer the credential store through the Oracle enterprise manager associated with the domain of your application install for ReIM, RPM, SIM, RESA, or Allocation.

An Oracle Platform Security Scripts (OPSS) script is a WLST script, in the context of the Oracle WebLogic Server. An online script is a script that requires a connection to a running server. Unless otherwise stated, scripts listed in this section are online scripts and operate on a database credential store. There are a few scripts that are offline, that is, they do not require a server to be running to operate.

Read-only scripts can be performed only by users in the following WebLogic groups: Monitor, Operator, Configurator, or Admin. Read-write scripts can be performed only by users in the following WebLogic groups: Admin or Configurator. All WLST scripts are available out-of-the-box with the installation of the Oracle WebLogic Server.

WLST scripts can be run in interactive mode or in script mode. In interactive mode, you enter the script at a command-line prompt and view the response immediately after. In script mode, you write scripts in a text file (with a py file name extension) and run it without requiring input, much like the directives in a shell script.

The weakness with the WLST/OPSS scripts is that you have to already know your map name and key name. In many cases, you do not know or remember that. The database credential store way through enterprise manager is a better way to find your map and key names easily when you do not already know them. A way in a command line mode to find the map name and alias is to run orapki. An example of orapki is as follows:

/u00/webadmin/product/wls_apps/oracle_common/bin> ./orapki wallet display –wallet /u00/webadmin/product/wls_apps/user_projects/domains/APPDomain/config/fmwconfig

(where the path above is the domain location of the wallet)

Output of orapki is below. This shows map name of rpm and each alias in the wallet:

Requested Certificates:

User Certificates:

Oracle Secret Store entries:

rpm@#3#@DB-ALIAS

rpm@#3#@LDAP-ALIAS

rpm@#3#@RETAIL.USER

rpm@#3#@user.signature.salt

rpm@#3#@user.signature.secretkey

rpm@#3#@WEBLOGIC-ALIAS

rpm@#3#@WLS-ALIAS

Trusted Certificates:

Subject: OU=Class 1 Public Primary Certification Authority,O=VeriSign\, Inc.,C=US

OPSS provides the following scripts on all supported platforms to administer credentials (all scripts are online, unless otherwise stated. You need the map name and the key name to run the scripts below

§ listCred

§ updateCred

§ createCred

§ deleteCred

§ modifyBootStrapCredential

§ addBootStrapCredential

listCred

The script listCred returns the list of attribute values of a credential in the credential store with given map name and key name. This script lists the data encapsulated in credentials of type password only.

Script Mode Syntax

listCred.py -map mapName -key keyName

Interactive Mode Syntax

listCred(map="mapName", key="keyName")

The meanings of the arguments (all required) are as follows:

§ map specifies a map name (folder).

§ key specifies a key name.

Examples of Use:

The following invocation returns all the information (such as user name, password, and description) in the credential with map name myMap and key name myKey:

listCred.py -map myMap -key myKey

The following example shows how to run this command and similar credential commands with WLST:

/u00/webadmin/product/wls_apps/oracle_common/common/bin>

sh wlst.sh

Initializing WebLogic Scripting Tool (WLST)...

Welcome to WebLogic Server Administration Scripting Shell

wls:/offline> connect('weblogic','password123','xxxxxx.us.oracle.com:17001')

Connecting to t3://xxxxxx.us.oracle.com:17001 with userid weblogic ...

Successfully connected to Admin Server 'AdminServer' that belongs to domain 'APPDomain'.

wls:/APPDomain/serverConfig> listCred(map="rpm",key="DB-ALIAS")

Already in Domain Runtime Tree

[Name : rms01app, Description : null, expiry Date : null]

PASSWORD:retail

*The above means for map rpm in APPDomain, alias DB-ALIAS points to database user rms01app with a password of retail

updateCred

The script updateCred modifies the type, user name, and password of a credential in the credential store with given map name and key name. This script updates the data encapsulated in credentials of type password only. Only the interactive mode is supported.

Interactive Mode Syntax

updateCred(map="mapName", key="keyName", user="userName", password="passW", [desc="description"])

The meanings of the arguments (optional arguments are enclosed by square brackets) are as follows:

§ map specifies a map name (folder) in the credential store.

§ key specifies a key name.

§ user specifies the credential user name.

§ password specifies the credential password.

§ desc specifies a string describing the credential.

Example of Use:

The following invocation updates the user name, password, and description of the password credential with map name myMap and key name myKey:

updateCred(map="myMap", key="myKey", user="myUsr", password="myPassw")

createCred

The script createCred creates a credential in the credential store with a given map name, key name, user name and password. This script can create a credential of type password only. Only the interactive mode is supported.

Interactive Mode Syntax

createCred(map="mapName", key="keyName", user="userName", password="passW", [desc="description"])

The meanings of the arguments (optional arguments are enclosed by square brackets) are as follows:

§ map specifies the map name (folder) of the credential.

§ key specifies the key name of the credential.

§ user specifies the credential user name.

§ password specifies the credential password.

§ desc specifies a string describing the credential.

Example of Use:

The following invocation creates a password credential with the specified data:

createCred(map="myMap", key="myKey", user="myUsr", password="myPassw")

deleteCred

The script deleteCred removes a credential with given map name and key name from the credential store.

Script Mode Syntax

deleteCred.py -map mapName -key keyName

Interactive Mode Syntax

deleteCred(map="mapName",key="keyName")

The meanings of the arguments (all required) are as follows:

§ map specifies a map name (folder).

§ key specifies a key name.

Example of Use:

The following invocation removes the credential with map name myMap and key name myKey:

deleteCred.py -map myMap -key myKey

modifyBootStrapCredential

The offline script modifyBootStrapCredential modifies the bootstrap credentials configured in the default jps context, and it is typically used in the following scenario: suppose that the policy and credential stores are LDAP-based, and the credentials to access the LDAP store (stored in the LDAP server) are changed. Then this script can be used to seed those changes into the bootstrap credential store.

This script is available in interactive mode only.

Interactive Mode Syntax

modifyBootStrapCredential(jpsConfigFile="pathName", username="usrName", password="usrPass")

The meanings of the arguments (all required) are as follows:

§ jpsConfigFile specifies the location of the file jps-config.xml relative to the location where the script is run. Example location: /u00/webadmin/product/wls_apps/user_projects/domains/APPDomain/config/fmwconfig. Example location of the bootstrap wallet is /u00/webadmin/product/wls_apps/user_projects/domains/APPDomain/config/fmwconfig/bootstrap

§ username specifies the distinguished name of the user in the LDAP store.

§ password specifies the password of the user.

Example of Use:

Suppose that in the LDAP store, the password of the user with distinguished name cn=orcladmin has been changed to <password>, and that the configuration file jps-config.xml is located in the current directory.Then the following invocation changes the password in the bootstrap credential store to <password>:

modifyBootStrapCredential(jpsConfigFile='./jps-config.xml', username='cn=orcladmin', password='<password>')

Any output regarding the audit service can be disregarded.

addBootStrapCredential

The offline script addBootStrapCredential adds a password credential with given map, key, user name, and user password to the bootstrap credentials configured in the default jps context of a jps configuration file.

Classloaders contain a hierarchy with parent classloaders and child classloaders. The relationship between parent and child classloaders is analogous to the object relationship of super classes and subclasses. The bootstrap classloader is the root of the Java classloader hierarchy. The Java virtual machine (JVM) creates the bootstrap classloader, which loads the Java development kit (JDK) internal classes and java.* packages included in the JVM. (For example, the bootstrap classloader loads java.lang.String.)

This script is available in interactive mode only.

Interactive Mode Syntax

addBootStrapCredential(jpsConfigFile="pathName", map="mapName", key="keyName", username="usrName", password="usrPass")

The meanings of the arguments (all required) are as follows:

§ map specifies the map of the credential to add.

§ key specifies the key of the credential to add.

§ username specifies the name of the user in the credential to add.

§ password specifies the password of the user in the credential to add.

Example of Use:

The following invocation adds a credential to the bootstrap credential store:

addBootStrapCredential(jpsConfigFile='./jps-config.xml', map='myMapName', key='myKeyName', username='myUser', password =’myPass’)

Quick Guide for Retail Password Stores (db wallet, java wallet, DB credential stores)

Retail app	Wallet type	Wallet loc	Wallet partition	Alias name	User name	Use	Create by	Alias Example	Notes
RMS batch	DB	<RMS batch install dir (RETAIL_HOME)>/.wallet	n/a	<Database SID>_<Database schema owner>	<rms schema owner>	Compile, execution	Installer	n/a	Alias hard-coded by installer
RMWS forms	DB	<forms install dir>/base/.wallet	n/a	<Database SID>_<Database schema owner>	<rwms schema owner>	Compile forms, execute batch	Installer	n/a	Alias hard-coded by installer
RPM batch plsql and sqlldr	DB	<RPM batch install dir>/.wallet	n/a	<rms schema owner alias>	<rms schema owner>	Execute batch	Manual	rms-alias	RPM plsql and sqlldr batches
RWMS auto-login	JAVA	<forms install dir>/base/.javawallet
			<RWMS Installation name>	<RWMS database user alias>	<RWMS schema owner>	RWMS forms app to avoid dblogin screen	Installer	rwms16inst
			<RWMS Installation name>	BI_ALIAS	<BI Publisher administrative user>	RWMS forms app to connect to BI Publisher	Installer	n/a	Alias hard-coded by installer
AIP app	JAVA	<weblogic domain home>/retail/<deployed aip app name>/config							Each alias must be unique
			aip	<AIP weblogic user alias>	<AIP weblogic user name>	App use	Installer	aip-weblogic-alias
			aip	<AIP database schema user alias>	<AIP database schema user name>	App use	Installer	aip01user-alias
			aip	<rib-aip weblogic user alias>	<rib-aip weblogic user name>	App use	Installer	rib-aip-weblogic-alias
RPM app	DB credential store		Map=rpm or what you called the app at install time.	Many for app use					<weblogic domain home>/config/fmwconfig/jps-config.xml has info on the credential store. This directory also has the domain cwallet.sso file.
RPM app	JAVA	<weblogic domain home>/retail/<deployed rpm app name>/config							Each alias must be unique
			rpm	<rpm weblogic user alias>	<rpm weblogic user name>	App use	Installer	rpm-weblogic-alias
			rpm	<rpm batch user name> is the alias. Yes, here alias name = user name	<rpm batch user name>	App, batch use	Installer	RETAIL.USER
	JAVA	<retail_home>/orpatch/config/javaapp_rpm							Each alias must be unique
			retail_installer	<rpm weblogic user alias>	<rpm weblogic user name>	App use	Installer	weblogic-alias
			retail_installer	<rms shema user alias>	<rms shema user name>	App, batch use	Installer	rms01user-alias
			retail_installer	<reim batch user alias>	<reim batch user name>	App, batch use	Installer	reimbat-alias
			retail_installer	<LDAP-ALIAS>	cn=rpm.admin,cn=Users,dc=us,dc=oracle,dc=com	LDAP user use	Installer	LDAP_ALIAS
ReIM app	JAVA	<weblogic domain home>/retail/<deployed reim app name>/config							Each alias must be unique
			<installed app name, ex: reim>	<reim weblogic user alias>	<reim weblogic user name>	App use	Installer	weblogic-alias
			<installed app name, ex: reim>	<rms shema user alias>	<rms shema user name>	App, batch use	Installer	rms01user-alias
			<installed app name, ex: reim>	<reim webservice validation user alias>	<reim webservice validation user name>	App use	Installer	reimwebservice-alias
			<installed app name, ex: reim>	<reim batch user alias>	<reim batch user name>	App, batch use	Installer	reimbat-alias
			<installed app name, ex: reim>	<LDAP-ALIAS>	cn=REIM.ADMIN,cn=Users,dc=us,dc=oracle,dc=com	LDAP user use	Installer	LDAP_ALIAS
	JAVA	<retail_home>/orpatch/config/javaapp_reim							Each alias must be unique
			retail_installer	<reim weblogic user alias>	<reim weblogic user name>	App use	Installer	weblogic-alias
			retail_installer	<rms shema user alias>	<rms shema user name>	App, batch use	Installer	rms01user-alias
			retail_installer	<reim webservice validation user alias>	<reim webservice validation user name>	App use	Installer	reimwebservice-alias
			retail_installer	<reim batch user alias>	<reim batch user name>	App, batch use	Installer	reimbat-alias
			retail_installer	<LDAP-ALIAS>	cn=REIM.ADMIN,cn=Users,dc=us,dc=oracle,dc=com	LDAP user use	Installer	LDAP_ALIAS
RESA app	DB credential store		Map=resaor what you called the app at install time	Many for login and policies					<weblogic domain home>/config/fmwconfig/jps-config.xml has info on the credential store. This directory also has the domain cwallet.sso file. The bootstrap directory under this directory has bootstrap cwallet.sso file.
RESA app	JAVA	<weblogic domain home>/retail/<deployed resa app name>/config							Each alias must be unique
			<installed app name>	<resa weblogic user alias>	<resa weblogic user name>	App use	Installer	wlsalias
			<installed app name>	<resa schema db user alias>	<rmsdb shema user name>	App use	Installer	Resadb-alias
			<installed app name>	<resa schema user alias>	<rmsdb shema user name>>	App use	Installer	resa-alias
	JAVA	<retail_home>/orpatch/config/javaapp_resa							Each alias must be unique
			retail_installer	<resa weblogic user alias>	<resa weblogic user name>	App use	Installer	wlsalias
			retail_installer	<resa schema db user alias>	<rmsdb shema user name>	App use	Installer	Resadb-alias
	JAVA	<retail_ home>/orpatch/config/javaapp_rasrm							Each alias must be unique
			retail_installer	<alloc weblogic user alias>	<alloc weblogic user name>	App use	Installer	weblogic-alias
Alloc app	DB credential store		Map=alloc or what you called the app at install time	Many for login and policies					<weblogic domain home>/config/fmwconfig/jps-config.xml has info on the credential store. This directory also has the domain cwallet.sso file. The bootstrap directory under this directory has bootstrap cwallet.sso file.
Alloc app	JAVA	<weblogic domain home>/retail/config							Each alias must be unique
			<installed app name>	<alloc weblogic user alias>	<alloc weblogic user name>	App use	Installer	weblogic-alias
			<installed app name>	<rms schema user alias>	<rms schema user name>	App use	Installer	dsallocAlias
			<installed app name>	<alloc batch user alias>	<SYSTEM_ADMINISTRATOR>	Batch use	Installer	alloc14
	JAVA	<retail_ home>/orpatch/config/javaapp_alloc							Each alias must be unique
			retail_installer	<alloc weblogic user alias>	<alloc weblogic user name>	App use	Installer	weblogic-alias
			retail_installer	<rms schema user alias>	<rms schema user name>	App use	Installer	dsallocAlias
			retail_installer	<alloc batch user alias>	<SYSTEM_ADMINISTRATOR>	Batch use	Installer	alloc14
	JAVA	<retail_ home>/orpatch/config/javaapp_rasrm							Each alias must be unique
			retail_installer	<alloc weblogic user alias>	<alloc weblogic user name>	App use	Installer	weblogic-alias
SIM app	DB credential store		Map=oracle.retail.sim	Aliases required for SIM app use					<weblogic domain home>/config/fmwconfig/jps-config.xml has info on the credential store. This directory also has the domain cwallet.sso file.
	JAVA	<weblogic domain home>/retail/<deployed sim app name>/batch/resources/conf	oracle.retail.sim	<sim batch user alias>	<sim batch user name>	App use	Installer	BATCH-ALIAS
	JAVA	<weblogic domain home>/retail/<deployed sim app name>/wireless/resources/conf	oracle.retail.sim	<sim wireless user alias>	<sim wireless user name>	App use	Installer	WIRELESS-ALIAS
RETL	JAVA	<RETL home>/etc/security	n/a	<target application user alias>	<target application db userid>	App use	Manual	retl_java_rms01user	User may vary depending on RETL flow’s target application
RETL	DB	<RETL home>/.wallet	n/a	<target application user alias>	<target application db userid>	App use	Manual	<db>_<user>	User may vary depending on RETL flow’s target application
RIB	JAVA	<RIBHOME DIR>/deployment-home/conf/security							<app> is one of aip, rfm, rms, rpm, sim, rwms, tafr
JMS			jms<1-5>	<jms user alias> for jms<1-5>	<jms user name> for jms<1-5>	Integra- tion use	Installer	jms-alias
WebLogic			rib-<app>-app-server-instance	<rib-app weblogic user alias>	<rib-app weblogic user name>	Integra- tion use	Installer	weblogic-alias
Admin GUI			rib-<app>#web-app-user-alias	<rib-app admin gui user alias>	<rib-app admin gui user name>	Integra- tion use	Installer	admin-gui-alias
Application			rib-<app>#user-alias	<app weblogic user alias>	<app weblogic user name>	Integra- tion use	Installer	app-user-alias	Valid only for aip, rpm, sim
DB			rib-<app>#app-db-user-alias	<rib-app database schema user alias>	<rib-app database schema user name>	Integra- tion use	Installer	db-user-alias	Valid only for rfm, rms, rwms, tafr
Error Hospital			rib-<app>#hosp-user-alias	<rib-app error hospital database schema user alias>	<rib-app error hospital database schema user name>	Integra- tion use	Installer	hosp-user-alias
RFI	Java	<RFI-HOME>/retail-financial-integration-solution/service-based-integration/conf/security
			<installed app name>	rfiAppServerAdminServerUserAlias	<rfi weblogic user name>	App use	Installer	rfiAppServerAdminServerUserAlias
			<installed app name>	rfiAdminUiUserAlias	<ORFI admin user>	App use	Installer	rfiAdminUiUserAlias
			<installed app name>	rfiDataSourceUserAlias	<ORFI schema user name>	App use	Installer	rfiDataSourceUserAlias
			<installed app name>	ebsDataSourceUserAlias	<EBS schema user name>	App use	Installer	ebsDataSourceUserAlias
			<installed app name>	smtpMailFromAddressAlias	<From email address>	App use	Installer	smtpMailFromAddressAlias

Product	Version
Oracle Retail Insights	16.0
Oracle Retail Data Extractor for Merchandising (RDE)	16.0
Oracle Retail Price Management (RPM)	16.0
Oracle Retail Allocation	16.0
Oracle Retail Invoice Matching (ReIM)	16.0
Oracle Retail Store Inventory Management (SIM)	16.0
Oracle Retail Warehouse Management System (RWMS)	16.0
Oracle Retail Advanced Inventory Planning (AIP)	16.0
Oracle Retail Merchandise Financial Planning (MFP)	16.0
Oracle Retail Demand Forecasting (RDF) (including the Grade module)	16.0
Oracle Retail Predictive Application Server (RPAS)	16.0
Oracle Retail Xstore Suite	16.0
Oracle Commerce Retail Extension Module (RXM)	16.0

Integration Technology	Version
Oracle Retail Extract, Transform and Load (RETL)	13.2.9
Oracle Retail Integration Bus (RIB)	16.0
Oracle Retail Service Backbone (RSB)	16.0

Field Title	RETAIL_HOME
Field Description	The pre-existing location where RMS (database, batch, and/or application) was installed along with the ORPATCH utility. This location should contain directories with your installed files as well as the “orpatch” directory.
Example	/path/to/retail_home
Note	The ORPatch files in this RETAIL_HOME may need to be updated in order to be able to run the analysis. The Analyze tool will take care of this automatically.

Oracle Retail VAR Applications

Preinstallation Tasks

Check Supported Database Server Requirements

Check Supported Application Server Requirements

References for Configuration:

Database Installation Tasks—Full

Establish a Database Partitioning Strategy

Instance Creation Using the Generic Template via DBCA

Set Up Additional RMS Users

Batch Installation Tasks—Full

Create Staging Directory for RMS Installer

Application Server Installation Tasks – Full

Oracle BI EE Configuration for RMS Reports

Database Installation Tasks – Upgrade

Upgrade RMS Database using the Installer

Create Staging Directory for RMS Installer

Application Server Installation Tasks – Upgrade

Reports Installation Tasks – Upgrade

Data Migration

Oracle Retail Deploy Patch (ORDeploy)

Changes with 16.0

New technologies

Cumulative Patches

Incremental Patches

Apply all Patches with Installer or ORPatch

Retained Installation Files

Preparing for Patching

Single Patching Session

Shutdown Applications