Professional Documents
Culture Documents
OMS 190 Instg
OMS 190 Instg
Installation Guide
Release 19.0
F25732-01
December 2019
Oracle® Retail Order Management System Installation Guide, Release 19.0
F25732-01
This software and related documentation are provided under a license agreement containing
restrictions on use and disclosure and are protected by intellectual property laws. Except as
expressly permitted in your license agreement or allowed by law, you may not use, copy,
reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or
display any part, in any form, or by any means. Reverse engineering, disassembly, or
decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be
error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it
on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated
software, any programs installed on the hardware, and/or documentation, delivered to U.S.
Government end users are "commercial computer software" pursuant to the applicable Federal
Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,
disclosure, modification, and adaptation of the programs, including any operating system,
integrated software, any programs installed on the hardware, and/or documentation, shall be
subject to license terms and license restrictions applicable to the programs. No other rights are
granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications,
including applications that may create a risk of personal injury. If you use this software or
hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe,
backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its
affiliates disclaim any liability for any damages caused by use of this software or hardware in
dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be
trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC
trademarks are used under license and are trademarks or registered trademarks of SPARC
International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or
registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open
Group.
This software or hardware and documentation may provide access to or information on content,
products, and services from third parties. Oracle Corporation and its affiliates are not responsible
for and expressly disclaim all warranties of any kind with respect to third-party content, products,
and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle
Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to
your access to or use of third-party content, products, or services, except as set forth in an
applicable agreement between you and Oracle.
Value-Added Reseller (VAR) Language
(i) the MicroStrategy Components developed and licensed by MicroStrategy Services Corporation
(MicroStrategy) of McLean, Virginia to Oracle and imbedded in the MicroStrategy for Oracle Retail
Data Warehouse and MicroStrategy for Oracle Retail Planning & Optimization applications.
(ii) the Wavelink component developed and licensed by Wavelink Corporation (Wavelink) of
Kirkland, Washington, to Oracle and imbedded in Oracle Retail Mobile Store Inventory
Management.
(iii) the software component known as Access Via™ licensed by Access Via of Seattle, Washington,
and imbedded in Oracle Retail Signs and Oracle Retail Labels and Tags.
(iv) the software component known as Adobe Flex™ licensed by Adobe Systems Incorporated of
San Jose, California, and imbedded in Oracle Retail Promotion Planning & Optimization
application.
You acknowledge and confirm that Oracle grants you use of only the object code of the VAR
Applications. Oracle will not deliver source code to the VAR Applications to you. Notwithstanding
any other term or condition of the agreement and this ordering document, you shall not cause or
permit alteration of any VAR Applications. For purposes of this section, "alteration" refers to all
alterations, translations, upgrades, enhancements, customizations or modifications of all or any
portion of the VAR Applications including all reconfigurations, reassembly or reverse assembly, re-
engineering or reverse engineering and recompilations or reverse compilations of the VAR
Applications or any derivatives of the VAR Applications. You acknowledge that it shall be a breach
of the agreement to utilize the relationship, and/or confidential information of the VAR
Applications for purposes of competitive discovery.
The VAR Applications contain trade secrets of Oracle and Oracle's licensors and Customer shall
not attempt, cause, or permit the alteration, decompilation, reverse engineering, disassembly or
other reduction of the VAR Applications to a human perceivable form. Oracle reserves the right to
replace, with functional equivalent software, any of the VAR Applications in future releases of the
applicable program.
iii
Contents
Send Us Your Comments ............................................................................................... vii
Preface .............................................................................................................................. ix
Audience ................................................................................................................................ ix
Related Documentation........................................................................................................ ix
Customer Support ................................................................................................................. ix
Review Patch Documentation ...............................................................................................x
Improved Process for Oracle Retail Documentation Corrections ....................................x
Oracle Retail Documentation on the Oracle Help Center .................................................x
Conventions .............................................................................................................................x
Pre-installation Tasks ....................................................................................................... 1
Prerequisites ............................................................................................................................ 1
Implementation Capacity Planning .............................................................................. 1
Check Supported Database Server Requirements ....................................................... 1
Check Supported Application Server Requirements .................................................. 1
Check Supported Business Intelligence Publisher Server Requirements ................ 2
Supported Oracle Retail Products ................................................................................. 2
Linux User Account Privileges to Install the Software ............................................... 2
WebLogic User Privileges to Configure WebLogic ..................................................... 2
Oracle WebService Manager – Policy Manager ........................................................... 2
WebLogic Security ........................................................................................................... 2
Installation Steps .............................................................................................................. 3
Before You Start....................................................................................................................... 3
Third-Party Integrations ................................................................................................. 3
Download the Installation Package ...................................................................................... 3
Order Management System Application Information ....................................................... 3
Required Information ...................................................................................................... 3
Database ................................................................................................................................... 5
Application Installation........................................................................................................ 10
Servers in Cluster ........................................................................................................... 11
Data Sources .......................................................................................................................... 11
Data Source for OrderManagementNonXADS.......................................................... 11
Messaging / JMS Modules ........................................................................................... 12
Cache Coherence ............................................................................................................ 13
Security Realms Provider ............................................................................................. 13
SerenadeSeam Deployment .......................................................................................... 14
Modern View Deployment ........................................................................................... 14
Server Start and Deployment Start .............................................................................. 15
Business Intelligence Publisher Setup ......................................................................... 15
Validation Prior to OKM Encryption ................................................................................. 16
v
Testing the Order Management Application .................................................................... 17
Testing the Modern View Application ....................................................................... 18
Creating Users and Additional Configuration Options ........................................... 18
Deployment Hardening ................................................................................................ 19
vi
Send Us Your Comments
Oracle Retail Order Management System, Installation Guide, Release 19.0
Oracle welcomes customers' comments and suggestions on the quality and usefulness of
this document.
Your feedback is important, and helps us to best meet your needs as a user of our
products. For example:
Are the implementation steps correct and complete?
Did you understand the context of the procedures?
Did you find any errors in the information?
Does the structure of the information help you with your tasks?
Do you need different information or graphics? If so, where, and in what format?
Are the examples correct? Do you need more examples?
If you find any errors or have any other suggestions for improvement, then please tell us
your name, the name of the company who has licensed our products, the title and part
number of the documentation and the chapter, section, and page number (if available).
vii
Preface
The Oracle Retail Order Management System Installation Guide describes the steps
required to install the application.
Audience
This Installation Guide describes the requirements and procedures to install Release 19.0
Order Management System.
This installation guide is written for the following audiences:
System administrators and operations personnel
Database administrators
System analysts and programmers
Integrators and implementation staff personnel
Related Documentation
For more information, see the following documents in the Order Management System
Release 19.0 documentation set:
Order Management System Release Notes
Order Management System Administration Guide
Order Management System Online Help
Order Management System Implementation Guide
See the Order Management System documentation library at the following URL:
https://www.oracle.com/documentation/retail.html
Customer Support
To contact Oracle Customer Support, access My Oracle Support at the following URL:
https://support.oracle.com
When contacting Customer Support, please provide the following:
Product version and program/module name
Functional and technical description of the problem (include business impact)
Detailed step-by-step instructions to re-create
Exact error message received
Screen shots of each step you take
ix
Review Patch Documentation
When you install the application for the first time, you install either a base release (for
example, 16.3) or a later patch release (for example, 16.3.1). If you are installing the base
release or additional patch releases, read the documentation for all releases that have
occurred since the base release before you begin installation. Documentation for patch
releases can contain critical information related to the base release, as well as information
about code changes since the base release.
Conventions
Navigate: This is a navigate statement. It tells you how to get to the start of the procedure
and ends with a screen shot of the starting point and the statement “the Window Name
window opens.”
This is a code sample
It is used to display examples of code
Note: Oracle Retail assumes that the retailer has applied all
required fixes for supported compatible technologies.
Prerequisites
Implementation Capacity Planning
There is significant complexity involved in the deployment of Oracle Retail applications,
and capacity planning is site specific. Oracle Retail strongly suggests that before
installation or implementation you engage your integrator (such as the Oracle Retail
Consulting team) and hardware vendor to request a disk sizing and capacity planning
effort.
Sizing estimates are based on a number of factors, including the following:
Workload and peak concurrent users and batch transactions
Hardware configuration and parameters
Data scarcity
Application features utilized
Additional considerations during this process include your high availability needs as
well as your backup and recovery method.
Installation Guide 1
Prerequisites
WebLogic Security
The Order Management System applications run on a WebLogic 12c application server.
Proper configuration of this application server is important to insure a secure
environment. The following are links to WebLogic security considerations:
https://docs.oracle.com/middleware/1221/opss/JISEC.pdf
https://docs.oracle.com/cd/E24329_01/web.1211/e24446/security.htm
For more information about security recommendations, see the Oracle Retail Order
Management System Technical Security Guide.
Third-Party Integrations
All integrations with third-party systems will need to be configured prior to using the
Order Management System Application. For details refer to the Oracle Retail
Documentation on the Oracle Help Center.
The following information is needed in order to complete the installation. All values are
required. Fill in the Value column of this table as a reference to be used later in the
installation.
Information Value
Installation Guide 3
Order Management System Application Information
Information Value
Database
The Order Management System database is made up of one database with one user /
schemas. The Order Management System install contains a Database folder with SQL
scripts for creating the database objects and data. The SQL scripts can be used to
complete the following database set up tasks. Do the following manual steps with the
answers from the information supplied in the above chart.
1. Open the file oms_tablespace.sql under the Directory Database, replace below tokens
and save the file:
$(DbTablspaceData) ORDER_MANAGEMENT_DATA
$(DbTablspaceIndex) ORDER_MANAGEMENT_INDEX
$(DbTablspaceLobs) ORDER_MANAGEMENT_LOBS
2. Login as sys user to Database Server, using SQL Plus and execute the file created in
step 1. Verify that following table spaces got created.
ORDER_MANAGEMENT_DATA
ORDER_MANAGEMENT_INDEX
ORDER_MANAGEMENT_LOBS
3. Open the file oms_users.sql under the Directory Database, and replace below tokens
with username and password and save the file:
&DbUser = ORDER_MANAGEMENT
&DbUserPassword
4. Login as sys user to Database Server, using SQL Plus and execute the file created in
step 3.
5. Open the file build_database.sql under the Directory Database, and replace below
tokens and save the file:
$(DbTablspaceData) ORDER_MANAGEMENT_DATA
$(DbTablspaceIndex) ORDER_MANAGEMENT_INDEX
$(DbTablspaceLobs) ORDER_MANAGEMENT_LOBS
6. Login as DB user created in step 4, to Database Server, using SQL Plus and execute
the file created in step 5. This will take a few minutes to complete.
7. Open the file oms_base_data_common_script.sql under the Directory
Database/base_data, and replace below tokens and save the file:
Installation Guide 5
Database
8. Login as DB user created in step 4, to Database Server, using SQL Plus and execute
the file created in step 7.
9. Open the file oms_company_49_script.sql under the Directory Database/base_data,
and replace below tokens and save the file:
$(DbTablspaceData) ORDER_MANAGEMENT_DATA
$(DbTablspaceIndex) ORDER_MANAGEMENT_INDEX
$(DbTablspaceLobs) ORDER_MANAGEMENT_LOBS
The user ID of the Order Management System initial user. Use this $(ADMINUSER) and
initial user to initially sign in to the application and also to set up &ADMINUSER
other users. This user is initially granted all access authority, but
should be restricted once other users are created. The user ID is a
maximum of 10 characters and must be in all uppercase.
The user ID of the Order Management System default user. The $(DEFAULTUSER)
default user is needed in Order Management System in order to run and
certain background jobs and web services. The default user ID must &DEFAULTUSER
be different from the initial user ID. The user ID is a maximum of 10
characters and must be in all uppercase.
The default date format to use for this Order Management System $(DATEFORMAT)
installation. Valid values are DMY, MDY, and YMD. and
&DATEFORMAT
10. Login as DB user created in step 4, to Database Server, using SQL Plus and execute
the file created in step 9.
11. Open the file oms_company_51_script.sql under the Directory Database/base_data,
and replace below tokens and save the file:
$(DbTablspaceData) ORDER_MANAGEMENT_DATA
$(DbTablspaceIndex) ORDER_MANAGEMENT_INDEX
$(DbTablspaceLobs) ORDER_MANAGEMENT_LOBS
The user ID of the Order Management System initial user. Use this $(ADMINUSER) and
initial user to initially sign in to the application and also to set up &ADMINUSER
other users. This user is initially granted all access authority, but
should be restricted once other users are created. The user ID is a
maximum of 10 characters and must be in all uppercase.
The user ID of the Order Management System default user. The $(DEFAULTUSER)
default user is needed in Order Management System in order to run and
certain background jobs and web services. The default user ID must &DEFAULTUSER
be different from the initial user ID. The user ID is a maximum of 10
characters and must be in all uppercase.
The default date format to use for this Order Management System $(DATEFORMAT)
installation. Valid values are DMY, MDY, and YMD. and
&DATEFORMAT
12. Login as DB user created in step 4, to Database Server, using SQL Plus and execute
the file created in step 11.
13. Open the file 1099_build_JIRAupdates.sql under the Directory Database, and replace
below tokens and save the file:
$(DbTablspaceData) ORDER_MANAGEMENT_DATA
Installation Guide 7
Database
$(DbTablspaceIndex) ORDER_MANAGEMENT_INDEX
$(DbTablspaceLobs) ORDER_MANAGEMENT_LOBS
14. Login as DB user created in step 4, to Database Server, using SQL Plus.
a. Execute the file created in step 13.
If you check the import log there will be a warning "SP_SCHEMA_DIFF created
with compilation warnings". This is okay, it will be fixed in step 15.
b. Ensure that OROMS is properly configured for on premise by checking that the
following property is set to true.
Select * from property where property = ' ON_PREMISE_ENABLED';
c. Ensure that IDCS is disabled by checking that the following property is set to
false.
Select * from property where property = 'IDCS_ENABLED';
d. Update the user table to set only one user as the “system user.”
Select * from users where name = 'DEFAULTCSU';
Update as needed using,
Update USERS set SYSTEM_DEFAULT = 'N' where name = 'DEFAULTCSU';
iv. Once the job is complete (no rows will be returned from
DBA_DATAPUMP_JOBS) you can continue with the upgrade.
Installation Guide 9
Application Installation
Application Installation
1. Copy the contents of the OMSApplicationServer folder to the folder that contains the
Order Management System Domain in WebLogic. For example:
/u00/webadmin/OROMS/config/domains/OROMS/OMSDomain. Overwrite anything if asked.
Verify that the files are owned by a user ID that has authority to run WebLogic.
a. Unzip the <OMS Domain folder>/< OMSApplicationServer>/oms-conf-
19.0.zip to <OMS Domain folder>. This will create the folder and contents for
<OMS Domain folder>/conf
b. Unzip the <OMS Domain folder>/< OMSApplicationServer>/oms-sharedLibs-
19.0.zip to <OMS Domain folder>. This will create the folder and contents for
<OMS Domain folder>/lib.
c. Copy the <OMS Domain folder>/< OMSApplicationServer>/OMSToDeploy
folder to <OMS Domain folder>/OMSToDeploy. This contains the OROMS
EAR and WAR files that get deployed to WebLogic.
d. File and folder privileges should be set properly from the zip file.
e. Ensure the owner of these files and folders is the user that runs WebLogic.
2. Do the following manual steps with the answers from the information supplied in
the above chart. All files are located in the Order Management System Domain
within the conf folder.
Servers in Cluster
Change the following settings on the servers in the cluster.
1. Go to Environment > Clusters and click on the cluster to get to the cluster settings.
2. Click on the Control tab.
3. Make sure the servers in the cluster are not running. If they are running, shut the
servers in the cluster down using the Force Shutdown Now option.
4. Click on one of the servers to get its properties, and go to the Server Start tab.
5. Click the Lock & Edit button in the upper left to allow editing of this server.
6. Enter the following into the Argument field:
-Xms1024m -Xmx4096m -XX:+UseG1GC -XX:+ParallelRefProcEnabled -
DUseSunHttpHandler=true -
Dweblogic.security.SSL.minimumProtocolVersion=TLSv1.2 -
Dcoherence.distributed.localstorage=true
Click the Save button.
7. Click the Activate Changes button in the upper left corner to activate the changes.
8. Repeat steps 4 - 7 for each server in the cluster.
Data Sources
Note: Take the default setting if the setting is not mentioned
in these instructions.
Create the following data sources in WebLogic by going to Services > DataSources >
New > Generic Data Source.
Installation Guide 11
Data Sources
Create the following JMS Modules in WebLogic by going to Services > Messaging > JMS
Modules.
OROMSJMSModule
1. Name: OROMSJMSModule
2. Descriptor File Name: jms/oromsjmsmodule-jms.xml
3. Target: All servers in the cluster
4. Resource:
a. Type: Foreign Server
b. Name: AqJmsForeignServer
c. Target: All servers in the cluster
d. JNDI Initial Context Factory: oracle.jms.AQjmsInitialContextFactory
Cache Coherence
1. At the administration console, expand the Environment section at the Domain
Structure box and then click on Coherence Clusters. Create a default coherence
cluster configuration with name "defaultCoherenceCluster".
2. Click next, enter cluster mode as unicast, cluster listen port and multicast listen
address.
3. Click next and select cluster members i.e. AdminServer, oms_cluster, then click
fininsh. Activate changes if necessary.
4. Now from the left panel “Domain Structure” click on Environment then click on
servers.
5. Select OMS1 server, and then go to server start tab from top navigation, click on Lock
and Edit from top left corner.
6. Add this argument -Dtangosol.coherence.distributed.localstorage=true to Argument
section, if it does not already exist.
7. Do it for all OMS servers in cluster, i.e OMS1, OMS2, OMS3 ….. etc.
8. This will look something like below:
Installation Guide 13
Data Sources
SerenadeSeam Deployment
Install the SerenadeSeam distribution in WebLogic by doing the following:
1. Go to Deployments and click Lock & Edit in the upper left corner.
2. Click Install on top of the table.
3. Change the path to OMS_DOMAIN/OMSToDeploy where OMS_DEPLOY is the location of the
Order Management System domain directory. An example is
/scratch/u00/webadmin/OROMS/config/domains/OROMS/OMSDomain1/OMSToDeploy then
press enter.
4. Select SerenadeSeam-19.0.ear and click Next.
5. Take the defaults on the Installation Type and Scope screen. Click Next.
6. Set the target to All servers in the cluster. Click Next.
7. Take the default on the last screen by clicking Finish.
8. When prompted give it a name such as SerenadeSeam.
9. Click Activate Changes in the upper left corner to prepare this distribution.
Note: you may want to read about the CC_RESOURCE_URI in the documentation to see
if using this property applies to your environment.
Installation Guide 15
Validation Prior to OKM Encryption
1. Log into the Order Management application with your new user.
2. Navigate using the fast path to the “CPRP” menu option.
3. Search for “OKM” in the property column.
4. Verify that the “value” field is empty for both rows for the following properties
a. OKM_ACCESS_ALIAS
b. OKM_ACCESS_ALIAS_SWITCH
5. If either rows contain “ADMIN” or any other value, clear the field for only those two
rows.
6. You may also review this in the ORDER_MANAGEMENT database schema in the
“property” table.
Note: Be patient, since the first time you log in to the Order
Management System application it may take longer than
normal for the first screen to come up. If you happen to get
a blank screen, close the browser and launch Order
Management System again.
d. At this point you should be logged in to the application. On the first log in, it
may take the initial screen a couple minutes to completely load. Allow the screen
to completely load before starting to maneuver around from screen to screen.
This is necessary only after the Order Management System service is restarted
and not on every login.
e. To check the application level and database level do the following:
i. Click on the My Jobs icon to get to the My Jobs screen.
ii. Click on the About button located on the side bar.
iii. On the About window, make sure the settings below match what is on the
window:
Version = 19.0.0
Installation Guide 17
Testing the Order Management Application
Deployment Hardening
HTTP Header X-Frame-Options
To prevent site content from being embedded into other sites (clickjacking), it is strongly
recommended that an Apache web server or Load balancer be placed in front of the
WebLogic application server. X-Frame-Options in the HTTP response header can be used
to indicate whether or not a browser should be allowed to open a page in frame or
iframe. This option should be set to SAMEORIGIN.
More Information
For more information on secure configuration, see the Technical Security Guide on My
Oracle Support Doc ID 1988467.1.
Installation Guide 19