2 Installation and Basic Setup

This chapter provides instructions for installing and deploying the Oracle Retail Artifact Generator.

Determining the Type of Installation

The Oracle Retail Artifact Generator can be installed and used in any of the following configurations:

Standalone application
Application inside rib-home
Web-application in Oracle WebLogic

Installing As a Standalone Application

To install the Oracle Retail Artifact Generator, complete the following steps.

Determine the user and the location to install the Artifact Generator.
Verify the JAVA_HOME environment variable is set for the user. The JAVA_HOME must be set to a Java 1.7 JDK. If the user is located on the same server as the Application Server, then setting the JAVA_HOME to $ORACLE_HOME/jdk is recommended.
```
> echo $JAVA_HOME 
>/home/aia1/oracle/middleware/jdk
```
Create a directory for the Artifact Generator.
```
> mkdir ArtifactGeneratorStandalone
```
Download and extract the Artifact Generator to the Artifact Generator home directory.
```
> cd ArtifactGeneratorStandalone
> cp /u00/stage/RIB14.0.0/ ArtifactGenerator14.0.0ForAll14.0.0_eng_ga.tar.
> tar -xvf  ArtifactGenerator14.0.0ForAll14.0.0_eng_ga.tar
```
This step creates the Artifact Generator root directory structure. For example: /user/aia1/ArtifactGenerator/retail-func-artifact-gen.

This structure becomes AG_HOME.

Note:
AG_HOME is assumed to be the artifact-generator-home directory in the following steps.
```
> export AG_HOME=/user/home/aia1/ArtifactGenerator/retail-func-artifact-gen
```
Note:
For a base artifact, use the RibFunctionalArtifacts for RIB. For Retail Services Backbone, use the RetailFunctionalArtifacts instead.
Download the RIB Functional Artifact tar or the Retail Functional Artifact tar to the AG_HOME/base-func-artifacts directory.
```
> cd $AG_HOME/base-func-artifacts
> cp /u00/stage/RIB14.0.0/RibFuncArtifact14.0.0ForAll14.0.0Apps_eng_ga.tar.
```
Do not untar it. This will be handled by the setup scripts.

Make groovy executable.

> cd $AG_HOME
> chmod 711 ./integration-lib/third-party/groovy/2.0.1/bin/groovy

Set the groovy environment variable. The GROOVY_HOME must be set. The Artifact Generator ships with the groovy jar files.
```
> cd $AG_HOME
> export GROOVY_HOME=`pwd`/integration-lib/third-party/groovy/2.0.1
```

Execute the setup script.

>$GROOVY_HOME/bin/groovy com/oracle/retail/integration/artifact/generator/SetupWorkArea.groovy

Installation is complete. See Chapter 3, "General Usage."

Installing As an Application Inside rib-home

For the following steps, $RIB_HOME is assumed to be the rib-home directory in the rib-app-builder directory tree structure.

For example: /u00/rib/Rib1400ForAll14xxApps/rib-home

Verify the JAVA_HOME environment variable. The JAVA_HOME must be set to a Java 1.7 JDK. If the <RIB_HOME> workspace is located on the same server as the Application Server, then setting the JAVA_HOME to $ORACLE_HOME/jdk is recommended.
```
> echo $JAVA_HOME 
> /home/aia1/oracle/middleware/jdk
```
Download and extract the Artifact Generator to the Artifact Generator into the rib-home/tools-home directory. There already will be a placeholder directory /retail-func-artifact-gen.
```
> cd $RIB_HOME/tools-home
> cp /u00/stage/RIB14.0.0/ ArtifactGenerator14.0.0ForAll14.0.0_eng_ga.tar.
> tar -xvf  ArtifactGenerator14.0.0ForAll14.0.0_eng_ga.tar
```
Note:
For a base artifact, use the RibFunctionalArtifacts for RIB. For Retail Services Backbone, use the RetailFunctionalArtifacts instead.
Download the RIB Functional Artifact tar or the Retail Functional Artifact tar to the AG_HOME/base-func-artifacts directory.
```
> cd $AG_HOME/base-func-artifacts
> cp /u00/stage/RIB14.0.0/RibFuncArtifact14.0.0ForAll14.0.0Apps_eng_ga.tar.
```
Do not untar it. This will be handled by the setup scripts.

Make Groovy executable.

> cd $RIB_HOME/tool-home/ retail-func-artifact-gen
> chmod 711 ./integration-lib/third-party/groovy/2.0.1/bin/groovy

Set the groovy environment variable.

> cd $RIB_HOME/tools-home/retail-func-artifact-gen   
> export GROOVY_HOME=`pwd`/integration-lib/third-party/groovy/2.0.1

Execute the setup script.

$GROOVY_HOME/bin/groovy com/oracle/retail/integration/artifact/generator/SetupWorkArea.groovy

Installation is complete. See Chapter 3, "General Usage."

Installing As a Web Application in Oracle WebLogic

The steps below describe how to deploy the Oracle Retail Artifact Generator to an Oracle WebLogic Application Server as a Web application.

Note:

See the section "Supported Operating Systems," in Chapter 1.

Prerequisites

The following are prerequisites for installation.

The retail-func-artifact-gen-gui.war file is located within the directory structure of the ArtifactGenerator14.0.0ForAll14.0.0_eng_ga.tar. It is recommended that the Artifact Generator be deployed from the rib-home location, although the.war file can be obtained from the stand-alone installation as well.

Note:
See the section, "Installing As an Application Inside rib-home," in this chapter.
The installation and base configuration of the Oracle WebLogic Server is beyond the scope of this document. Work with the Application Server Administration team to determine the physical and logical placement of the retail-func-artifact-gen-gui component within the WebLogic Server deployment.

Note:
See Oracle WebLogic Server 11g Release 3 (10.3.6) Installation Guide.

Deploying the Artifact Generator Application

Using the WebLogic Server Administration Console, complete the following steps:

Note:

For instructions with illustrations (screen captures), see "Appendix: Install the Artifact Generator."

Navigate to the Deployments page.
Click Install.

Note:
If the application has already been installed, see the section, "Redeploying the Application," in this chapter.

The "Locate deployment to install and prepare for deployment" page is displayed. Follow the instructions to locate the retail-func-artifact-gen-gui.war file.
Select Upload Files.
On the Upload a Deployment to the admin server page, use the Browse button to locate the retail-func-artifact-gen-gui.war file in the "Deployment Archive."
Select the retail-func-artifact-gen-gui.war
Click Next and move to Choose targeting style.
Select Install this deployment as an application. Click Next and move to Select Target Deployments. Select the target server for the Artifact Generator Web application.
Click Next and move to Optional Settings.
Click Next and move to Review your choices and click Finish.
Select No, I will review the configuration later.
Click Finish to deploy the application.

Creating the agAdminGroup

To create the agAdminGroup, do the following:

In WebLogic, click on Security Realms.
Click on myrealm and then Users and Groups.
Click on groups and then New.
Enter agAdminGroup in the name field, leaving the other fields at default.
Click OK.
Add at least one user to the agAdminGroup group.

Verifying the Artifact Generator Web Application

To verify the artifact generator Web application, do the following.

Navigate to the Deployments page.
Locate the retail-func-artifact-gen-gui on the Summary of Deployments page.
Click the name, retail-func-artifact-gen-gui, to move to the "Settings for the rib-func-artifact-gen-gui."
Select the Testing tab.
Click the link for the index.jsp URL in the Test Point. The URL should open to the Retail Artifact Generator Login page.
The installation is complete. For more information, see Chapter 3, "General Usage."
Click on the Setup Work Areas tab.
Click Choose File, navigate to, and select the RibFuncArtifact14.0.0ForAll14.0.0Apps_eng_ga.tar file.
Click Create Work Area.

Redeploying the Application

If the retail-func-artifact-gen-gui application has already been deployed, follow these steps.

If the retail-func-artifact-gen-gui application is running, select Stop and When Work Completes or Force Stop Now, depending on the environment. The recommended option always is When Work Completes.
Click Delete.
The retail-func-artifact-gen-gui should now not show on the Summary of Deployment page.
Return to the appropriate step in Deploy the Application.