Go to primary content
Oracle® Retail Category Management Planning and Optimization/Macro Space Optimization (CMPO/MSO) Installation Guide
Release 14.1.2
E70805-01
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

2 Full Installation on UNIX Environments

The installation of the server-side RPAS components on UNIX operating systems is accomplished using Java-based installation programs that are included with the installation package.

The Category Management Planning and Optimization/Macro Space Optimization Installer automates the following:

This document assumes that the RPAS installer process (from the Oracle Retail Predictive Application Server Installation Guide) has been completed prior to using the CMPO/MSO installer.

Preparation

The RPAS server components required prior to this installation process are available from Oracle's E-Delivery web site, http://edelivery.oracle.com, and My Oracle Support, https://support.oracle.com.

Environment Variable Setup Script

Before running the solution installer, source the retaillogin.ksh script. The script is located in the root of the base directory where RPAS was installed unless the default was overwritten when specifying directory paths.

Source the script from inside the directory where the script is located:

. ./retaillogin.ksh

Or, include the full path after the period and space ”.”:

. /<base_directory>/retaillogin.ksh


Notes:

The preceding period and space (”. ”) must be included at the beginning of the command when running the script.

Include this path and script in the .profile in your home directory (~/.profile) if you want to have this environment setup script run during login.


This script sets up environment variables, such as RPAS_HOME and RIDE_HOME, which are required for RPAS to run properly.

Additional Environment Variables

In addition to the running of retaillogin.ksh, export the following environment variable prior to starting the installer.

export RPAS_JAVA_CLASSPATH=$RPAS_HOME/applib/aaijni.jar:$RPAS_HOME/applib/aaiCatMan.jar:$RPAS_HOME/applib/rseCatMan.jar:$RPAS_HOME/lib/rpasjni.jar:$RPAS_HOME/lib/oracleRpasUtils.jar

Note:

There are additional Java environment variables that must be set for your particular operation system. These variables are the same for all applications on RPAS. See the ”Java Environment” section of the Oracle Retail Predictive Application Server Installation Guide for these environment variables.

Alternate Domain Name

Using the RPAS installer process, the built domain name is catman. You can change the default domain name with the following procedure:

  1. Locate the file, bin/environment.ksh.

  2. Update this line to reflect the new name of the domain:

    export CM_MASTERDOMAIN=$CM_DOMAINHOME/catman

    For example:

    export CM_MASTERDOMAIN=$CM_DOMAINHOME/catman_new

  3. The install should run normally and produce a domain under the new name.


    Note:

    Other standard RPAS files will need to be updated to reflect the new domain location, For example, globaldomainconfig.xml, Foundation.xml, and so on.

Downloading and Extracting the CMPO/MSO Media Pack

The following procedure provides information about downloading and extracting the CMPO/MSO media pack and its contents.

  1. Create a directory to store the CMPO/MSO media pack on the target server. This directory is referred to as [Category Management Installation]. It is the location where the CMPO/MSO installation routine is run.

  2. Download and extract the media pack to this location. Once extracted, two directories appear, CDROM and DOCS.

    • The CDROM folder contains the catman.zip file. This file contains the CMPO/MSO solution.

    • The DOCS folder contains the CMPO/MSO documentation.


Note:

Files contained within the installation package are intended to be used by the installer only.

Installing CMPO/MSO

Perform the following steps to install CMPO/MSO


Note:

This product's installer includes Ant. If Ant is already installed on your system and is version 1.6.5 or earlier, then you must run unset ANT_HOME on the command line to ensure that the installer uses the included version. The unset ANT_HOME command must be run before ./install.sh.

  1. Extract the CMPO/MSO installer from the [Category Management Installation] directory.

    cd CDROM

    unzip catman.zip

  2. From the [Category Management Installation]/CDROM directory, run the following commands to run the CMPO/MSO installer:

    cd catman

    ./install.sh


    Note:

    The command must be run with the preceding period and slash (./).

    If this process is being run on an X-Windows emulator (such as Exceed), graphical user interface to the Installer opens. If you are running in console mode through a terminal emulator, enter ./install.sh on the text interface.

    In both cases, the requested information is identical. In the GUI, you may be shown a check box to signal whether you want a component installed; in text mode, you are prompted for a response of true or false.


    Note:

    In text mode, the default value displays in square brackets []. To use the default value and continue, press Enter. If you want to use a different value, enter the new value. When prompted to create a directory, respond with yes and press Enter.

  3. The CMPO/MSO Installer Window opens and displays the components that are installed during installation process and the required components.

    Click Next to continue.

    Figure 2-1 CMPO/MSO Installer Window

    Surrounding text describes Figure 2-1 .
  4. The Choose Components to Install Window opens.

    Figure 2-2 Choose Components to Install Window

    Surrounding text describes Figure 2-2 .

    Select one or both of the following options:

    • Category Management — Select this option to install the Category Management domain.

    • RPAS Fusion Client configuration — Select this option to install the RPAS Fusion Client configuration for CMPO/MSO. For more information on the configuration files included for the RPAS Fusion Client, see Configuration Files for the RPAS Fusion Client.


      Note:

      If you do not want to install the RPAS Fusion Client configuration, clear this check box and skip steps 7 and 8.

    Click Next to continue.

  5. The Base Paths for Solution Window opens.

    Figure 2-3 Base Paths for Solution Window

    Surrounding text describes Figure 2-3 .

    Enter the relevant information in the following fields:

    • Dir to store solution — Enter the directory path where your solution should be stored.

    • Path to retaillogin.ksh script — Enter the path and file name to the retaillogin.ksh script created during RPAS installation.


    Note:

    Ensure that the installation paths are located outside the installer directory [CMPOMSO Installation].

    If this directory does not exist, the Installer prompts you to create it.


    Click Next to continue.

  6. The Install Tasks Window opens.

    Figure 2-4 Install Tasks Window

    Surrounding text describes Figure 2-4 .

    Select or clear the Create Category Management Domain option:

    • To create the CMPO/MSO domain, select the Create Category Management Domain option, which is the default.


      Note:

      Domain builds use the environment specified in the retaillogin.ksh environment setup script. If you change any environment details, edit the retaillogin.ksh script and any subsequent scripts called by retaillogin.ksh.

      For more information about the retaillogin.ksh script, see the Environment Variable Setup Script section.


    • To install all required components to support the CMPO/MSO domain, but not create the actual domain, clear the check box.

    Click Next to continue.

  7. The Fusion Location Information Window opens.

    Figure 2-5 Fusion Location Information Window

    Surrounding text describes Figure 2-5 .

    Enter the relevant information in the following fields:

    Field Description
    Enter the number of RPAS Fusion Client servers to install these configurations on: (1-4) Enter the number of servers running the RPAS Fusion Client where you want to install the CMPO/MSO configuration. In case the RPAS Fusion Client is running on a single server, enter 1. If you have a clustered installation, you can enter up to four servers
    Enter the RPAS server hostname: Enter the hostname of the RPAS server.
    Enter the RPAS server port: Enter the port number of the RPAS server.
    RPAS Solution Path Enter the location of the RPAS domain for CMPO/MSO.


    Note:

    The Fusion Location Information windows open when you select the RPAS Fusion Client configuration check box on the Choose Components to Install Window.

    If you are not installing the RPAS Fusion Client configuration, proceed to step 9.


    Click Next to continue.

  8. Based on the number of servers you entered, the Fusion Location Information (Details) Window opens.

    Figure 2-6 Fusion Location Information (Details) Window

    Surrounding text describes Figure 2-6 .

    Enter the server details in the following set of fields for each configuration:

    Field Description
    Hostname or IP Enter the host name or IP address of the server where the RPAS Fusion Client is installed.
    Configuration Directory Enter the location of the config directory available at the location where the RPAS Fusion Client is installed.
    Login username Enter the user name to log on to the server where the RPAS Fusion Client is installed.
    Login password Enter the password associated with the user name.
    Login username alias Specify an alias name for the administrative user. Specifying an alias name for the administrative user enhances the security for the application. When left blank, the alias name defaults to the administrative user name.


    Note:

    Information such as user credentials for the RPAS Fusion Client is encrypted and stored in a secure location in the application installation directory. This location is called the Oracle Wallet.

    When the installation starts, the administrative user credentials are retrieved from the Oracle Wallet based on the alias name specified in this window.


    Click Next to continue.

  9. The Installation Progress Window opens. To start the installation, click Install.

    Figure 2-7 Installation Progress Window

    Surrounding text describes Figure 2-7 .

    This window also displays the progress of the installation routine. Click Show Details to view the log output as the installation is performed. If you do not select to view the details, a graphical representation of the installation steps displays. As each step is completed, the color changes to show you the progress.

    You can toggle between detailed mode at any time during or after the installation.

  10. When the installation has finished, the Finished message displays. Click OK.

  11. To view the installation details, click Show Details. The window displays two tabs, the Output tab and the Error tab. It is recommended that you review these tabs for any issues that may have occurred during the installation process.

    If you want to view the log again at a later date, a text copy is saved in the directory [CMPOMSO Installation]. The log file is named based on the product and timestamp, followed by the.log extension.

    Created as part of this process is the make_domain.catman file located in [Solution Install Dir] entered previously. This file contains the required parameters needed to support the domain installation. If necessary, this file may be modified if the default parameters are not appropriate for your particular environment.


    Note:

    When reviewing Installer output or logs, you may see the following message: [scp] Caught an exception, leaving main loop due to Socket closed. This message is harmless and does not indicate failure.


    Note:

    The domain install process may also include postinstallation data loading scripts specific to the CMPO/MSO configuration. These scripts, if present, may also be modified.

    For additional information on installing RPAS domains manually, see the Oracle Retail Predictive Application Server Installation Guide.


  12. Click Exit to close the installer.

Postinstallation Configuration

Before starting the DomainDaemon, you must first set the following environment variables.

Environment Variables

Set your CM_HOME environment variable to the directory specified for the Dir to store solution path used in the installer

To do this, either in shell or with additions to your.profile, add:

export CM_HOME=[Dir to store solution path]

Online Help File

If you are on AIX and you have re-installed CMPO/MSO, you must edit a help file to use the CMPO/MSO online help in the RPAS Fusion Client.

Manually edit the [fusion client installation dir]/config/ohwconfig.xml file by removing the following duplicate line:

<helpSet xmlns="" id="<shortProductName>" location="<shortProductName>/<shortProductName>-help.hs"/>


Caution:

If this duplicate line is not removed, a ”500 Page Not Found” error occurs when attempting to access the online help in the RPAS Fusion Client.

Configuration Files for the RPAS Fusion Client

This section describes the optional installation method that involves setting up the RPAS Fusion Client configuration for the CMPO/MSO configuration. If you chose to install the Fusion Client configuration files using the CMPO/MSO installer, you can skip this section.


Note:

Before proceeding, ensure that you have appropriate access privileges on the server running the RPAS Fusion Client.

During the CMPO/MSO installation, these files are automatically copied over (when the Configure Fusion Client option is selected) to the configuration directory where the RPAS Fusion Client is installed. The installation also ensures that the following RPAS Fusion Client configuration files are updated to reflect the CMPO/MSO installation:

  • Foundation.xml - Located in the [RPAS Fusion Client Installation]/ config/rpas directory. This XML file includes the domain configuration available for use with the RPAS Fusion Client.


    Note:

    For more information on the Foundation.xml file, refer to the Oracle Retail Predictive Application Server Installation Guide and the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.

If you do not install the Fusion Client configuration files during the CMPO/MSO installation, you can choose to do one of the following tasks:

  • Run the CMPO/MSO installer again, and select to install only the RPAS Fusion Client configuration.

  • Run the RPAS Fusion Client installer again, and specify the CMPO/MSO domain configuration. For more information on the RPAS Fusion Client installation, refer to the Oracle Retail Predictive Application Server Installation Guide.

  • Configure the RPAS Fusion Client for CMPO/MSO manually. For more information, see the ”Configuring Additional Domains” section in the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.

Taskflow Files

This section provides information about the files needed for taskflow configuration.

If you selected the option to build a domain, you will find two taskflow files (taskflow.xml and the taskflowBundle.properties resource file) in the fusionClient subdirectory within the domain. For information about how to use these files to configure the Multi-solution Taskflow, refer to the section, ”Postinstallation Configuration” in the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client.

If you selected the option to install the fusion client configuration, the translation files for the taskflow have been copied to [RPAS Fusion Client Installation]/resources. For information about how to use these files with the Multi-solution Taskflow, refer to the section, ”Creating a Multi-solution Taskflow” in the Oracle Retail Predictive Application Server Configuration Tools User Guide.