Skip Headers
Oracle® Retail Central Office Installation Guide
Release 14.1
E54458-02
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

3 Installation

Before proceeding, you must install the database, create the database users, and install the application server software. For a list of supported versions, see Chapter 1.

During installation, the Central Office database schema is created and the Central Office application is deployed to an Oracle WebLogic domain within the WebLogic installation. When the domain was created, the JDK was selected. This is the JDK that is used to run the Central Office application. For the remainder of this chapter, the JDK installation directory is referred to as <JDK_INSTALL_DIR>.

Update Oracle WebLogic for JPA and RSA

Before installing Central Office, upgrade WebLogic with the latest version of the JPA jars that are tested with Central Office. The jars are shipped with the Central Office installer and are available in the ORCO-14.1.zip file. After extracting the zip file, the jars are available in the following folder:

<staging_directory>/centraloffice/lib/thirdparty

For information on extracting the zip file, see "Expand the Central Office Distribution".

The following JPA jar files need to be upgraded:

  • eclipselink.jar

  • javax.persistence_2.1.0.v201304241213.jar

If using the RSA Data Protection Manager, WebLogic needs to be updated for the RSA jars and log4j jar. The RSA jar files must be obtained from your provider for the RSA Data Protection Manager. The following RSA and log4j jar files need to be added:

  • cryptojce.jar

  • cryptojcommon.jar

  • jcm.jar

  • jcmFIPS.jar

  • kmsclient.jar

  • LB.jar

  • LBJNI.jar

  • sslj.jar

  • log4j-1.2.17.jar

To update WebLogic for JPA and RSA:

  1. To upgrade the JPA jar files:

    1. Copy the two jar files from <staging_directory>/centraloffice/lib/thirdparty to the <WebLogic_HOME>/modules directory.

    2. To set the CLASSPATH, edit commEnv.sh in the <WebLogic_HOME>/wlserver_10.3/common/bin directory:

      PRE_CLASSPATH="${MODULES_DIR}/javax.persistence_2.1.0.v201304241213.jar:${MODULES_DIR}/eclipselink.jar"
      
  2. To set up the jars to use RSA Data Protection Manager:

    1. Copy the RSA jar files and the log4j.jar file to the appropriate directories.

    2. To set the CLASSPATH, edit commEnv.sh in the <WebLogic_HOME>/wlserver_10.3/common/bin directory:

      PRE_CLASSPATH="${MODULES_DIR}/javax.persistence_2.1.0.v201304241213.jar:${MODULES_DIR}/eclipselink.jar:<RSA_JARS_LOCATION>/cryptojce.jar:<RSA_JARS_LOCATION>/cryptojcommon.jar:<RSA_JARS_LOCATION>/jcm.jar:<RSA_JARS_LOCATION>/jcmFIPS.jar:<RSA_JARS_LOCATION>/kmsclient.jar:<RSA_JARS_LOCATION>/LB.jar:<RSA_JARS_LOCATION>/LBJNI.jar:<RSA_JARS_LOCATION>/sslj.jar:<APACHE_JARS_LOCATION>/log4j-1.2.17.jar"
      
  3. After setting the variable, look on the console and make sure the jars are added to the CLASSPATH. If they are not added, shut down WebLogic and add the jars to the WEBLOGIC_CLASSPATH variable in the same file. Put the jar files ahead of the WebLogic jar files.

Create a New WebLogic Domain for Central Office

You can skip this section if you are manually redeploying to an existing domain.

The Central Office application must be deployed to its own dedicated domain. For information on how to perform the following steps, consult your Oracle WebLogic Server documentation.

Server Name Considerations

Each server instance in your WebLogic environment must have a unique name, regardless of the domain or cluster in which it resides, or whether it is an Administration Server or a Managed Server. Within a domain, each server, machine, server, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.


Note:

Back Office, Central Office, Returns Management, and the Mobile Point-of-Service server must have all unique domain names and server names in order to integrate successfully.

Enabling Trust Between WebLogic Server Domains

The WebLogic Server enables you to establish global trust between two or more domains. You do this by specifying the same Domain Credential for each of the domains. By default, the Domain Credential is randomly generated and therefore, no two domains have the same Domain Credential. During installation, the WebLogic domain credential is configured to the value entered in the Domain Details installer window. For more information, see Figure A-35.


Note:

All domains running Oracle Retail applications must have the same domain credentials.

Secure Sockets Layer

Central Office is accessed through a secure HTTP connection. Enable the Secure Sockets Layer (SSL) when creating the domain and set the listen port and SSL list port number so that the numbers are unique for each domain in your configuration.

Verify that the domain's administrative server is started and in running mode.

Managed Servers

When a domain is created with a managed server using the Oracle JDK, the default WebLogic settings may leave the server without enough memory to configure and stop the running managed server. A careful inspection of the log files may indicate an out-of-memory exception.

To avoid the out-of-memory exceptions, increase the PermSize space:

  1. In the WebLogic Administration console, under Environments, select Servers.

  2. In Summary of Servers, select <managedServerName>.

  3. In Settings, select the Server Start tab.

  4. In the Arguments text box, add the following if it does not already exist:

    -Xms512m -Xmx512m -XX:PermSize=512m -XX:MaxPermSize=512m
    
  5. Click Release Configuration.

Before launching the Central Office installer, create a directory for the persistent store:

<WEBLOGIC_HOME>/user_projects/domains/<orco-domain>/servers/<ManagedServerName>/data/store/orco-persistent-store

Configuring a Cluster

For an example of configuring a cluster on WebLogic, see the following document available through My Oracle Support. Access My Oracle Support at the following URL:

https://support.oracle.com

Oracle Retail POS Suite Cluster Configuration on WebLogic (Doc ID: 1597886.1)

This document provides examples of installing WebLogic, creating and configuring a WebLogic domain, and deploying the web application.

General Steps for Creating a New Domain

In addition to specific steps previously described, you can use the following steps to create a new domain using the WebLogic Configuration Wizard:

  1. Log on to the server, which is running your WebLogic installation, as the user who owns the WebLogic installation.

  2. Launch the Weblogic Configuration Wizard.

  3. Select Create a new WebLogic Domain. The domain can be a basic WebLogic server domain.

  4. Choose a unique name for the new domain. In the remainder of this installation guide, <orco-domain> is used for the name.

  5. Configure the administrator user name and password.

  6. Configure the server start mode and JDK.

  7. Configure the Administration Server.

Before launching the Central Office installer:

  1. If using a Managed Server, start the Managed Server.

  2. Start the Administration Server.

  3. Verify that all servers in the domain are started and in running mode.

WebLogic Domain Startup Mode

WebLogic can be run in production mode or development mode.

Boot Identity Files

When a domain is created in development mode using the Configuration Wizard, a boot identity file, named boot.properties, is created in the Administration Server's root directory. The boot identity file contains an encrypted version of the user name and password which lets you bypass the login prompt during instantiations of the server. In production mode, WebLogic prompts for credentials on the command line.

To install Central Office on a domain using production mode, you must first create a boot identity file so that the Administration Server can bypass the prompt for user name and password when the installer restarts the server.

Consult your WebLogic documentation for more information and options for creating boot identity files. Following is an example of one method, that can be used after domain creation, to create the boot identity file:

  1. Start the Administration Server at least once and provide the user credentials on the command line.

  2. Create the Administration Server's security directory, if it does not already exist.

    <WEBLOGIC_HOME>/user_projects/domains/<orco-domain>/servers/<AdminServerName>/security
    
  3. Place the following two lines in a file named boot.properties in the security directory:

    password=<password>
    username=<username>
    

    Note:

    There should be no spaces on either side of the equal sign.

  4. Stop and restart the Administration Server to verify that the credential prompts are bypassed.

Deploying to a Managed Server or Cluster

If you are deploying Central Office to a managed server or cluster, note the following:

  • If any of the servers are remote from the admin server, copy the contents of the domain/lib directory to the corresponding directory on the remote systems. Also, a directory for the persistent store needs to be created on the remote systems. It should be located in the following location:

    <WEBLOGIC_HOME>/user_projects/domains/<orco-domain>/servers/<serverName>/data/store/orco-persistent-store
    
  • Although the installer will deploy all components of the application to all cluster members, it is suggested that in production, the web services and EJBs are deployed to a cluster and the web application is deployed to a non-clustered managed server.

  • If you are deploying Central Office to a cluster, you must use web services for retrieving transactions from Point-of-Service.

  • If you are deploying Central Office to a cluster and using the RSA Data Protection Manager, set the client.app_name to a unique name in each RSA client configuration file used in the cluster.

  • To ensure that the SSL certificates match between WebLogic and Central Office:

    1. Start the node manager.

    2. Edit the nodemanager.properties file at the following location:

      <WEBLOGIC_HOME>/wlserver_10.3/common/nodemanager/nodemanager.properties

      Update the following values:

      StartScriptEnabled=true
      StartScriptName=startWebLogic.sh
      KeyStores=CustomIdentityAndCustomTrust
      CustomIdentityKeyStoreFileName=<KEYSTORE_PATH>/<Keystore_Name>
      CustomIdentityKeyStorePassPhrase=<KeyStorePassPhrase>
      CustomIdentityAlias=<PrivateKeyAlias>
      CustomIdentityPrivateKeyPassPhrase=<PrivateKeyPassPhrase>
      CustomTrustKeyStoreFileName=<TRUSTSTORE_PATH>/<Truststore_Name>
      
    3. Restart the node manager.

Create the Database Schema Owner and Data Source Users

The following recommendations should be considered for schema owners:

  • Database administrators should create an individual schema owner for each application, unless the applications share the same data. In the case of Oracle Retail Back Office and Point-of-Service, the database schema owner is the same because these applications share a database.

  • The schema owners should only have enough privileges to install the database.

For information on best practices for passwords, see the Oracle Retail POS Suite Security Guide.


Note:

Do not delete the database schema owner after installation. When using Data Import (DIMP), the schema owner privileges are needed for DIMP processing which includes creating and dropping tables. For information on DIMP, see "Enable Data Import".

To create the database schema owner and data source users:

  1. Log in using the database administrator user ID.

  2. Create a role in the database to be used for the schema owner.

    CREATE ROLE <schema_owner_role>;
    
  3. Grant the privileges, shown in the following example, to the role.

    GRANT CREATE TABLE, CREATE VIEW, CREATE SEQUENCE, CREATE PROCEDURE, ALTER SESSION, CONNECT TO <schema_owner_role>;
    
  4. Create a role in the database to be used for the data source user.

    CREATE ROLE <data_source_role>;
    
  5. Grant the privileges, shown in the following example, to the role.

    GRANT CONNECT, CREATE SYNONYM TO <data_source_role>;
    

    Note:

    After the product is installed successfully, the CREATE SYNONYM privilege must be revoked from the data source role. Before the installer exits, it prompts for a database administrator to revoke the privilege.

  6. Create the schema owner user in the database.

    CREATE USER <schema_username>
    IDENTIFIED BY <schema_password>
    DEFAULT TABLESPACE users
    TEMPORARY TABLESPACE TEMP
    QUOTA UNLIMITED ON users;
    
  7. Grant the schema owner role to the user.

    GRANT <schema_owner_role> TO <schema_username>;
    
  8. Create the data source user.

    CREATE USER <data_source_username>
    IDENTIFIED BY <data_source_password>
    DEFAULT TABLESPACE users
    TEMPORARY TABLESPACE TEMP
    QUOTA UNLIMITED ON users;
    
  9. Grant the data source role to the user.

    GRANT <data_source_role> TO <data_source_username>;
    

The installer grants the data source connection user access to the application database objects. If you choose No in the Manual Deployment Option window, you need to grant the access after the installer completes. For more information, see "Manual Deployment of the Central Office Application".

Expand the Central Office Distribution

To extract the Central Office files:

  1. Extract the Central Office 14.1 distribution zip file.

  2. Log on to the server as the user who owns the Oracle WebLogic installation. Create a new staging directory for the Central Office application distribution (ORCO-14.1.zip), for example, /tmp/j2ee/<orco-domain>/orco-staging.


    Note:

    The staging directory (staging_directory) can exist anywhere on the system. It does not need to be under tmp.

  3. Copy or upload ORCO-14.1.zip to staging_directory and extract its contents. The following files and directories should be created under
    staging_directory/ORCO-14.1:

    ant/
    ant-ext/
    antinstall/
    centraloffice/
    connectors/
    external-lib/
    installer-resources/
    .postinstall.cmd
    .postinstall.sh
    .preinstall.cmd
    .preinstall.sh
    antinstall-config.xml
    build.xml
    build-common.xml
    build-common-esapi.xml
    build-common-oas.xml
    build-common-retailinv.xml
    build-common-was.xml
    build-common-webapps.xml
    build-common-wl.xml
    checkdeps.cmd
    checkdeps.sh
    install.cmd
    install.sh
    prepare.xml
    revokesyn.sql
    wallet.xml
    

For the remainder of this chapter, staging_directory/ORCO-14.1 is referred to as <INSTALL_DIR>.

Replace the ojdbc6 Jar File in the WebLogic Installation

The ojdbc6 jar file in the WebLogic installation must be replaced with the ojdbc6 jar included with Central Office.

To replace the ojdbc6 jar:

  1. Stop the application server.

  2. Change to the <INSTALL_DIR>/centraloffice/db directory.

  3. Expand the centralofficeDBInstall.jar file.

    jar -xvf centralofficeDBInstall.jar
    
  4. Copy the ojdbc6.jar file from the lib directory to the <WebLogic_HOME>/wlserver_10.3/server/lib directory.

  5. Start the application server:

    • If Central Office is deployed to an admin server, start the application server for the admin server.

    • If Central Office is deployed to a managed server or cluster, start the application server for the managed servers.

Enable Data Import

Data Import (DIMP) is used by external systems to send data bundles to Central Office for routine data loading of certain types of data. To use DIMP, you need to create a directory for the incoming bundles and a directory where the bundles are archived after being processed.

In the Enable DIMP installer window, you select whether DIMP will be used. See Figure A-12. If Yes is selected in the window, you then provide the paths to the directories in the DIMP Configuration installer window. See Figure A-13.

For detailed information on DIMP, see the Oracle Retail POS Suite/Merchandising Operations Management Implementation Guide.

Enable Cross Version Support

A retailer may want to use DIMP with Release 14.1 of the POS Suite applications but with an earlier release of the Oracle Retail Merchandising Operations Management products. Cross version support enables this integration.

In the Enable Cross Version for DIMP installer window, you select whether cross version support is enabled. See Figure A-14. If Yes is selected in the window, you then provide the information needed for cross version support in the Cross Version Compatibility Configuration installer windows. See Figure A-15 and Figure A-16.

For detailed information on cross version support, see the Oracle Retail POS Suite Implementation Guide, Volume 1 - Implementation Solutions.

Enable Commerce Anywhere Integration

Commerce Anywhere enables retailers to integrate with e-commerce and order management solutions for processing customer transactions in stores and through web applications.

In the Enable Commerce Anywhere installer window, you select whether integration with Commerce Anywhere is enabled. See Figure A-19. If Yes is selected in the window, you then provide information on accessing the web services for Commerce Anywhere. See Figure A-20 through Figure A-23.

For more information on Commerce Anywhere, see the following documents available through My Oracle Support. Access My Oracle Support at the following URL:

https://support.oracle.com

Oracle Retail Commerce Anywhere Technical Integration Solution (Doc ID: 1598187.1)

This set of architectural diagrams and related business processes depict the Commerce Anywhere solution and its major integration points. The conceptual representation that is depicted is intended to support an integrated implementation of an Oracle Retail Commerce Anywhere solution that includes Oracle Retail Merchandising System, Oracle Retail Store Inventory Management, Oracle Retail Warehouse Management System, Oracle Retail POS Suite, and Oracle Retail Advanced Inventory Planning.

Oracle Retail Commerce Anywhere Functional White Papers (Doc ID: 1598177.1)

This library contains a collection of white papers that outline functional aspects of the Commerce Anywhere solution in Oracle Retail applications. One document provides an overview of the solution from an enterprise perspective, and it is accompanied by product specific-papers addressing Oracle Retail Merchandising System, Oracle Retail Store Inventory Management, Oracle Retail Warehouse Management System, Oracle Retail POS Suite, and Oracle Retail Advanced Inventory Planning.

Installation Options

During installation, there are options that enable you to select whether the installer completes parts of the installation or if you want to complete those parts manually. For information on the available options, see the following sections:

Install Database Options

The database schema must be created and populated before configuring the application server. In the Install Database Option window, you select whether the installer creates and populates the database schema or if you want to do this manually. See Figure A-17.

  • If you choose Create schema with sample dataset, the installer creates and populates the database schema with sample data. This is the default selection in the window. The sample dataset includes the minimum dataset. If you want data available to use for demonstrating Central Office functionality after installation, you can select this option.

    To use this option, you must provide the location of the zip file containing the sample dataset in the Sample Dataset installer window. See Figure A-18. You can obtain the sample-dataset-14.1.zip file from Oracle Software Delivery Cloud at the following web site:

    https://edelivery.oracle.com/
    
  • If you choose Create schema with minimum dataset, the installer creates and populates the database schema with the minimum amount of data needed to launch and run Central Office. If you want to load your own data after installation, you can select this option.

  • If you choose Skip schema creation and data loading, the installer does not create and populate the database schema. You choose this option if you want to create and populate the database schema manually. For information on manually creating and populating the database, see "Manually Create the Database Schema".


    Note:

    If Central Office is being installed for the first time and a clean schema is being used, do not select the Skip schema creation and data loading option. The installer will fail at some point if there is no data available in the database. You must populate the database schema before running the installer by selecting one of the other options.

    If the schema is already populated and you want to manually restore or update the data, select the Skip schema creation and data loading option.


Manually Create the Database Schema

To manually create and populate the database schema:

  1. Change to the <INSTALL_DIR>/centraloffice/db directory.

  2. Set the JAVA_HOME and ANT_HOME environment variables.

    JAVA_HOME=<JDK_INSTALL_DIR>; ANT_HOME=<INSTALL_DIR>/ant; export JAVA_HOME ANT_HOME
    
  3. Add $JAVA_HOME/bin and $ANT_HOME/bin to the front of the PATH environment variable.

    PATH=$JAVA_HOME/bin:$ANT_HOME/bin:$PATH; export PATH
    
  4. Expand the centralofficeDBInstall.jar file.

    jar -xvf centralofficeDBInstall.jar
    
  5. If you are using sample data, enter the path to the sample dataset file. Use forward slashes in the path:

    # identifies the sample dataset file
    dataset.sample.zip=FILE_DATASET_SAMPLE
    
  6. Modify the db.properties file:

    1. Uncomment the Oracle properties and comment out the properties for the other vendors.

    2. In the Oracle properties, update the settings to the following:

      db.product=jdbc
      db.version=12.1.0.1.4
      
    3. Set the following properties with your database settings. The values to be set are shown in bold in the examples.

      Set the hash algorithm, for example, to SHA-256.

      # Hash Algorithm
      inst.hash.algorithm=HASH_ALGORITHM
      

      Enter the values for the users shown in bold in the following example:

      inst.app.admin.user=my-co-admin-user
      inst.app.admin.password-encrypted=
       
      db.user=DB_USER_ID
      db.password-encrypted=
       
      db.owner.user=DB_OWNER_USER_ID
      db.owner.password-encrypted=
      

      Before running the ant target to encrypt the passwords, clear the encrypted password entries as shown in the preceding examples. The ant target prompts for the passwords. Run the following ant target to encrypt the passwords:

      ant -f db.xml encrypt-webapp-passwords
      

      Enter the values for the URL used by the Central Office application to access the database schema. See Appendix D for the expected syntax:

      db.jdbc-url=jdbc:oracle:thin:@DB_HOST_NAME:1521:DB_NAME
      

      If you are using a service name, the URL has the following format:

      db.jdbc-url=jdbc:oracle:thin:@DB_HOST_NAME:1521/SERVICE_NAME
      

      Enter the value for the store ID shown in the following example:

      configured.store.id=04241
      

      Enter the value for the supported locales shown in the following example:

      gen.locales=fr,zh
      

      Add a default locale as shown in bold in the following example:

      mock.locales=none
      default.locale=en_US
      
    4. Add entries for tablespaces. If you are using the default tablespaces, leave the name blank:

      db.table.space=pos_data_ts
      db.index.table.space=pos_indx_ts
      
    5. Set the port number for the parameters.apphost property to point to your Central Office installation. Use the rmi, managed server, or application server domain port number.

      parameters.apphost=t3://<hostname>:<port_number>
      
    6. In the parameters.classpath property, replace the semicolons used as separators with colons. This is needed to run with Linux systems.

    7. If loading sample data, replace FILE_DATASET_SAMPLE with the full path and file name for the sample dataset zip file.

      dataset.sample.zip=FILE_DATASET_SAMPLE
      
  7. If you are using Commerce Anywhere, update the store IDs shown in bold:

    ############################################################
    # Default stores in cross channel store group, store_1 and store_2.
    # If one of them is selected as configured.store.id, configured.xc_store_group_store_backup.id
    # will be used to replace it.
    ############################################################
    configured.xc_store_group_store_1.id=05100
    configured.xc_store_group_store_2.id=05101
    configured.xc_store_group_store_backup.id=04241
    
  8. Run one of the available Ant targets to create the database schema and load data:

    • load_sample: creates the database schema containing the sample dataset. The sample dataset includes the minimum dataset.

      To use this option, you must provide the location of the zip file containing the sample dataset. You can obtain the sample-dataset-14.1.zip file from the Oracle Software Delivery Cloud at the following web site:

      https://edelivery.oracle.com/
      
    • load_minimum: creates the database schema containing the minimum dataset.

    For example: ant load_sample

Secure the JDBC for the Oracle 12c Database

In the Enable Secure JDBC window, you select whether secure JDBC will be used for communication with the database. See Figure A-10.

  • If Yes is selected, the installer sets up the secure JDBC.

  • If No is selected and you want to manually set up the secure JDBC after the installer completes, see the Oracle Retail POS Suite Security Guide.

Obtain the Files Needed for RSA Data Protection Manager


Note:

Central Office with the RSA Data Protection Manager was not tested on IBM AIX or Oracle Solaris.

If you are using the RSA Data Protection Manager, you must do the following:

Obtain the RSA Client Configuration File

You must provide the installer with the name and location of the configuration property file in the RSA Client Configuration window. See Figure A-29. For detailed information on the content of this file, see the Java client documentation provided by your provider for the RSA Data Protection Manager.

Obtain the RSA Data Protection Manager Jar Files

You must obtain the required jar files from your Data Protection Manager provider. You provide the location of the jar files in the RSA Client JAR Files window. See Figure A-28. The directory for the jar files must contain only the RSA Java client jar files.

Obtain the RSA Libraries for Lockbox

Lockbox is an RSA feature the provides protection for RSA configuration information. Obtain these libraries from your RSA Data Protection Manager.

You must also update the path variable, LD_LIBRARY_PATH, for the lockbox libraries. For AIX, you must also update the path variable, LIBPATH, for the lockbox libraries.

Install the Java Cryptography Extension (JCE)

You must update the security for your JRE. You need to obtain version 7.0 of the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files.

  1. Make a backup copy of local_policy.jar and US_export_policy.jar.

    cd <JAVA_INSTALL_DIR>/<jdk>/jre/lib/securitymv local_policy.jar local_policy.jar.bakmv US_export_policy.jar US_export_policy.jar.bak
    
  2. Download version 7 of the JCE.

    1. Go to the following web site:

      http://www.oracle.com/technetwork/java/javase/downloads/index.html
      
    2. Under Additional Resources, find Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files 7.

    3. Click Download.

    4. Follow the instructions to download the JCE.

  3. Copy the local_policy.jar and US_export_policy.jar files into the JRE security directory. The files are bundled as UnlimitedJCEPolicyJDK7.zip.

Set Up Masking for Phone Number and Postal Code

The Customer tab provides the capability to add and update customer information in a central database. When Central Office is integrated with Commerce Anywhere, the Customer tab is not available.

When entering customer information, the formatting of the phone number and postal code entry fields is dependent on the country selected in the window. The format of the data that is entered by the user is determined by the masking for the phone number and postal code defined for the country.

For each country you will be using, you must define the phone number and postal code masking in the application.properties file. The file is found at
<INSTALL_DIR>/centraloffice/templates/applications.properties.

The masking for the United States and Canada is defined in the released version of the file. The masking for the other countries is set to alphanumeric with a maximum length of 30 characters for the phone number and 20 characters for the postal code.


Caution:

If the masking is not defined for a country you are using, the formatting of the entered data will not match the format required for the country. The data entered in these fields may not be correctly saved to the database.

After installation, the application.properties file is found in the properties.jar file at <WEBLOGIC_HOME>/user_projects/domains/
<orco-domain>/lib/properties.jar.

Create Queues Required for Parameter Export

When a store is added to the enterprise store hierarchy or the default store number is not used, the <INSTALL_DIR>centraloffice/appservers/weblogic/
jmsconfiguration.dat
file must be updated with the correct queue definitions. The queues used to export parameters to each store must reflect the current store hierarchy for the enterprise.

The jmsconfiguration.dat file contains at least one line defining a store queue, for example, for store ID 04241. You can copy the line and replace all the occurrences of the store ID with your store ID. There are several occurrences of the store ID in the line.

The following example shows the queue definition for store ID 04241 in the jmsconfiguration.dat file. In the following example, the store ID that you would change is shown in bold.

DISTR_QUEUE:store_04241:jms/store_04241

For example, if you have a store numbered 10000, the queue definition for the store should look like the following definition.

QUEUE:store_10000:jms/store_10000

For information on adding stores to the store hierarchy, see the Oracle Retail POS Suite Implementation Guide, Volume 1 - Implementation Solutions.

Run the Central Office Application Installer

Once you have a WebLogic domain that is configured and started, you can run the Central Office application installer. This installer will configure and deploy the Central Office application.


Note:

To see details on every window and field in the application installer, see Appendix A.

  1. Change to the <INSTALL_DIR> directory.

  2. Set the JAVA_HOME environment variable. JAVA_HOME should point to
    < JDK_INSTALL_DIR>.


    Note:

    The installer is not compatible with versions of Java earlier than Java 7.

  3. If you are using an X server such as Exceed, set the DISPLAY environment variable so that you can run the installer in GUI mode (recommended). If you are not using an X server, or the GUI is too slow over your network, unset DISPLAY for text mode or use the install.sh script.


    Caution:

    Password fields are masked in GUI mode, but in text mode your input is shown in plain text in the console window.

  4. Run the installer:

    1. Log on to the server as the user who owns the WebLogic installation.

    2. Change the mode of install.sh to executable.

    3. Run the install.sh script. This will launch the installer.


      Note:

      The usage details for install.sh are shown below. The typical usage for GUI mode does not use arguments.
      install.sh [text | silent]
      

    After installation is complete, a detailed installation log file is created: orco-install-app.<timestamp>.log

    The installer leaves behind the ant.install.properties and cwallet.sso files for repeat installations.

  5. After the installation is successfully completed, the CREATE SYNONYM privilege must be revoked. In the installer console window, it prompts for a database administrator to run the revokesyn SQL script to revoke the privilege. The script is found in the <INSTALL_DIR> directory.

    Figure 3-1 Installer Prompt to Run revokesyn

    Surrounding text describes Figure 3-1 .

    For information on granting this privilege to the data source user, see Create the Database Schema Owner and Data Source Users.

Store Hierarchy

After the store hierarchy is imported into the database, link the administration user created during the install to the correct store group.

Resolve Errors Encountered During Application Installation

If the application installer encounters any errors, it will halt execution immediately. You can run the installer in silent mode so that you do not have to reenter the settings for your environment. For instructions on silent mode, see Appendix B.

For a list of common installation errors, see Appendix E.

Since the application installation is a full reinstall every time, any previous partial installs will be overwritten by the successful installation.

Disable Non-SSL Port

You can choose to disable the non-SSL port in the Turn Off the Application Server's Non-SSL Port window. See Figure A-51. If you select Yes in the window, you must delete the transaction log files.


Note:

This should be done immediately after the Central Office install completes and before Back Office is installed. Otherwise, a transaction with the non-SSL port number may corrupt your system and stop JMS messages from being pushed to the stores.

To delete the files:

  1. Stop the application server.

  2. Delete the transaction log files:

    <orco-domain>/server/<serverName>/data/store/default/WLS*.dat
    <orco-domain>/server/<serverName>/data/store/or*-persistent-store/*.dat
    
  3. Start the application server:

    • If Central Office is deployed to an admin server, start the application server for the admin server.

    • If Central Office is deployed to a managed server or cluster, start the application server for the managed servers.

For more information, see the following web site. Refer to the Moving a Server section.

http://download.oracle.com/docs/cd/E12839_01/web.1111/e13731/trxman.htm#i1053371

Manual Deployment of the Central Office Application

Skip this section if you chose the default option of allowing the installer to complete installation to the application server in the Manual Deployment Option window. See Figure A-48.

The installer includes the option to configure the application locally and skip deployment to the application server. If this option is chosen, the installer will make the configured application files available under
<INSTALL_DIR>
/centraloffice/configured-output/.

If you chose this installer option, you can deploy the Central Office ear file by following these steps:

  • To deploy using the ant target:


    Note:

    The application server's non-SSL listen port must be enabled before running the ant target described here. The non-SSL listen port can be enabled using the WebLogic Admin Console. After these steps are completed, the non-SSL listen port can be disabled so the server can only be reached on the SSL listen port.

    1. Set the JAVA_HOME environment variable. JAVA_HOME should point to <JDK_INSTALL_DIR>.

    2. Update the following property in the ant.install.properties file.

      input.install.to.appserver = true
      
    3. Run the following ant target:

      ./install.sh ant init app-ear-deploy -propertyfile ant.install.properties
      
  • To deploy from the application server console:

    1. Set the JAVA_HOME environment variable. JAVA_HOME should point to <JDK_INSTALL_DIR>.

    2. Run the following target:

      ./install.sh ant init app-ear-deploy
      
    3. Deploy the ear file from the following location:

      <INSTALL_DIR>/centraloffice/centraloffice.ear
      

    Note:

    When deploying the ear file, provide the same application name and context root you gave to the installer. These values were stored in the <INSTALL_DIR>/ant.install.properties file by the installer.


    Note:

    If the initial set of parameters has not been imported because deployment of the application was performed using the manual deployment option, see "Import Initial Parameters" for details on how to import the parameters.

Install Parameters Option

The application parameters must be installed before the Central Office application is fully operational. In the Install Parameters Option window, you select whether the installer completes installation of the parameters or if you want to do this manually.

  • If you chose Yes, you do not need to perform any further steps to install the parameters. This is the default selection in the window.

  • If you chose No, the installer did not install the parameters. For information on installing the parameters, see "Import Initial Parameters".

Import Initial Parameters


Note:

If you did not choose to have the installer set the initial parameters, you must import an initial set of parameters before you can use Oracle Retail Central Office. For more information on parameters, see the Oracle Retail POS Suite Configuration Guide.

This section provides an overview of the procedures for importing an initial set of parameters. You can import the parameters through the Oracle Retail Central Office user interface or by using an ant target after the installation is complete. You only need to use one of the procedures. The procedure for importing parameters through the application user interface is described in more detail in the Oracle Retail Central Office User Guide.

Import Parameters Through the User Interface

To import the initial parameters through the user interface:

  1. Open the Oracle Retail Central Office application in a web browser. The address is provided at the end of the installer output and in the log file.

    https://<your host name>:<your port number>/<context root>
    
  2. Log in to the application with a user ID that has full administrative rights.

  3. Click the Data Management tab. The Available Imports window appears.

  4. To import the master parameter set, click the File link in the Import Parameters for Distribution row. Follow the instructions to import parameterset.xml from the <INSTALL_DIR>/centraloffice/configured-output/db folder.

  5. To import the initial set of Oracle Retail Central Office application parameters, click the File link in the Import Application Parameters row. Follow the instructions to import centraloffice.xml from the
    <INSTALL_DIR>
    /centraloffice/configured-output/db folder.

Import Parameters by using an Ant Target


Note:

The application server's non-SSL listen port must be enabled before running the ant target described here. The non-SSL listen port can be enabled using the WebLogic Admin Console. After these steps are completed, the non-SSL listen port can be disabled so the server can only be reached on the SSL listen port.

To import parameters using an ant target:

  1. Change to the <INSTALL_DIR>/centraloffice/configured-output/db directory.

  2. In db.properties, set the host name and port number for the parameters.apphost property to point to your Central Office installation.

    parameters.apphost=t3://<host name>:<port number>
    
  3. Set the JAVA_HOME and ANT_HOME environment variables.

    JAVA_HOME=<JDK_INSTALL_HOME>; ANT_HOME=<INSTALL_DIR>/ant; 
    export JAVA_HOME ANT_HOME
  4. Run the following command:

    ant load_parameters
    

Load Optional Purge Procedures

For information on how to invoke the procedures provided for purging aged data, see the Oracle Retail POS Suite Operations Guide.

To load the purge procedures:

  1. Run the available Ant target to load the procedures.

    ant load_purge_procedures

  2. Log in as the database schema owner, <schema_username>.

  3. Create a user for running the purge procedures. This user should only have the privileges required to run the purge procedures.

Install Multibyte Fonts for Transaction Tracker

Transaction Tracker output can be exported to PDF. In order for this PDF file to display and print correctly with multibyte characters, the multibyte fonts must be defined.

Central Office uses Apache Formatting Objects Processor (FOP) to create a PDF that is compatible with Adobe Acrobat. FOP and Adobe Acrobat require information about the fonts to use in the PDF. You must install and configure any multibyte fonts needed for the PDF.

To update the fonts:

  1. Install the required fonts.

  2. Generate a font metrics file.

    The fop.jar file provides a TTFReader program to generate this file. For information on this file, see the Apache FOP documentation. The fop.jar file is found in <INSTALL_DIR>/centraloffice/centraloffice.ear. Extract the fop.jar file into the current directory.

    The following are examples of the commands to use:

    • To specify a collection of fonts (TTC font):

      java -classpath ./fop.jar org.apache.fop.fonts.apps.TTFReader -ttcname "Gulim" /home/oracle/fonts/gulim.ttc gulim.xml
      
    • To specify a specific font (TTF font):

      java -classpath ./fop.jar org.apache.fop.fonts.apps.TTFReader /home/oracle/fonts/SIMSUN.TTF SIMSUN.xml
      
  3. Create a userconfig.xml file. This file has pointers to the font metrics file and the fonts on your local file system. For information on this file, see the Apache FOP documentation.

    The following is an example of the structure of the configuration file based on the commands in the previous step.

    <configuration>
    .................
    <fonts>
    .................
    .................
      <font metrics-file="/home/oracle/config/gulim.xml" embed-file="/home/oracle/fonts/gulim.ttc" kerning="yes">
         <font-triplet name="Gulim" style="normal" weight="normal"/>
         <font-triplet name="Gulim" style="normal" weight="bold"/>
         <font-triplet name="Gulim" style="italic" weight="normal"/>
         <font-triplet name="Gulim" style="italic" weight="bold"/>
     </font>
    .................
    .................
    </fonts>
    .................
    </configuration>
    
  4. Define the Java system property pdf.report.userconfig to point the userconfig.xml file for the application server JVM. See the documentation for the application server for more information.

    -Dpdf.report.userconfig=/home/oracle/fonts/userconfig.xml
    
  5. Replace any FOP.xsl file that needs the new font specified in the userconfig.xml file. After editing any FOP.xsl files in the ear file, you must redeploy the ear file.

    For example, change the font family to SimSun in the following file in the
    transaction-webapp-reports.jar
    file:

    oracle/retail/stores/commerceservices/transaction/salereturn/reports/SaleReturnTransactionDTOFOP.xsl
    

Using the Central Office Application


Note:

When you are done installing Central Office, log out and close the browser window. This ensures that your session information is cleared and prevents another user from accessing Central Office with your login information.

After the application installer completes and you have run the initial parameter load, you should have a working Central Office application installation. To launch the application, open a web browser and go to https://<servername>:<portnumber>/<context root>

For example, https://myhost:7002/centraloffice