| Oracle® Retail Advanced Inventory Planning Installation Guide Release 14.1.2 E70815-01 |
|
 Previous |
 Next |
| Oracle® Retail Advanced Inventory Planning Installation Guide Release 14.1.2 E70815-01 |
|
Previous |
Next |
This chapter details the steps needed to install the AIP Dashboard, which is an optional feature of AIP.
The AIP Dashboard Installation media includes an Oracle installer that you must run to install the AIP Dashboard. The installer installs the application based on the parameters specified in an installation properties file.
You can install the application in either of these modes:
Silent Mode
Silent mode is non-interactive. In silent mode, the installer processes the values set in the properties file with no manual intervention required. Refer to Running the AIP Dashboard Installer—Silent Mode.
Graphical or Text Mode
In graphical or text mode, the Oracle Installer prompts you to enter or modify the value of properties specified in the installation properties file. Refer to Running the AIP Dashboard Installer—Graphical or Text Mode.
Before starting the AIP Dashboard Installer, ensure that these items are installed and active:
RPAS Fusion Client
JDBC driver (installed in the WebLogic server's class path)
ODBC server
|
Note: After the RPAS ODBC server user is created, run the usermgr utility on the RPAS DOMAIN. Before logging on to the AIP Dashboard, use the following command so that the password is not reset:
|
RPAS_ODBC_Agent
RPAS_DATA_Service
|
Note: Refer to the Oracle Retail Predictive Application Server Administration Guide for the Fusion Client for additional information on installing the RPAS JDBC driver, the ODBC server, RPAS_ODBC_Agent, and RPAS_DATA_Service. |
Perform these tasks in order:
To install AIP Dashboard, it is recommended that you set up the installation properties file (ant.install.properties) before running the installer.
|
Note: Before installing the AIP Dashboard in silent mode, you must set up the installation properties file. This step is optional when installing in text or graphical mode. |
To set up your install.properties file, perform the following steps:
Navigate to the CDROM directory, use an unzip utility to unzip AIP-dashboard-installer.zip.
Copy the ant.install.properties.sample file to the same directory, and rename it ant.install.properties.
Edit the ant.install.properties file using any text editor, specifying values as described within the file, and save it. For more information on the parameters, refer to Installation Properties File Parameter Reference
|
Note: Ensure that the ant.install.properties file is available in the same directory with theinstall.sh/install.cmd script. |
Table 9-1 describes the parameters in the ant.install.properties file that you must set up before you install the AIP Dashboard application in silent mode:
Table 9-1 Installation Properties File Parameters
| Parameter Name | Description |
|---|---|
|
Retrieve Credentials |
|
|
input.retrieve.credentials input.ssh.authentication.mode = default input.ssh.username.alias = input.ssh.keyfile = input.app.log.location= |
This applies to GUI mode of install. For silent, you must set it to Yes. You should set the value to Yes if you have stored user credentials to retrieve them later. If you do not have user credentials stored in the secure wallet, or if you want to overwrite the existing credentials or store new credentials, set the value to No. If using the silent mode installer, then you must set |
|
Wallet Directory |
|
|
input.wallet.dir |
Specify the location of the Credential Store Manager where the user credentials are to be saved or retrieved (This is the wallet created by the retail security API). |
|
WebLogic Admin Server Information |
|
|
input.wls.target |
Specify the host name where the application server is running. If the application server is running on the same host as the installer, you may use local host and enter any of the following:
If the application server is running on a different host as the installer, enter the DNS name or IP address of the host where the application server is running. |
|
input.admin.port |
Specify the port number associated with the administrative server. |
|
input.admin.user |
Specify the administrative user name for the application server. |
|
input.admin.username.alias |
For GUI mode of install:
For silent mode (where the Java wallet is already created):
|
|
Application Configuration Information |
|
|
input.is.multiple.hosts |
To specify that your domain contains at least one managed server machine that is different from the admin server machine, set the value to yes. If all the managed server machines are on the same machine as the admin server machine, then set the value to no. In other words, even if you have a cluster with multiple managed servers or have multiple standalone managed servers, the value should be no if all of these managed servers are on the same machine as the admin server machine. |
|
Application Server Information |
|
|
input.target.name |
Specify the cluster or managed application server names where you want to install the AIP Dashboard. This should be the same managed server or cluster on which the Fusion client is installed, for example: AIP. |
|
Application Deployment Details |
|
|
input.solution.id |
Specify the Solution details for the AIP Dashboard. This should match the Solution name from the Fusion Client's Foundation.xml file. For example, input.solution.id = AIP |
|
input.app.name.customlib |
Specify the application deployment name. For example: aip.shared.lib. |
|
Data Source Details |
|
|
input.datasource.url |
Specify the Datasource URL in the format: jdbc:RPAS://<server>:<RPAS_Data_Service port>;ServerDataSource=gdom Where: <server> is the hostname of the server where RPAS_HOME is installed <RPAS_Data_Service port> is the port in which the RPAS_DATA_Service is running |
|
input.datasource.jndiname |
Specify the JNDI name. For example: jdbc/AIPDashboardDS |
|
input.datasource.alias |
Specify a DataSource alias name. The alias for the AIP RPAS user as stored in the Java wallet. |
|
input.datasource.username |
This is the username of a user that exists in the AIP Domain. If a user does not exist, then create a user in the AIP Domain and specify the details here. This is the username that the AIP Dashboad application uses to connect to the AIP Domain to retrieve data for dashboard |
|
RPAS Fusion Client |
|
|
fusion.configpath |
Specify the Fusion Client Configuration Directory, where the fusion client configuration files are located. |
|
input.targetMachines |
Specify the hostname/IP of the machine where the Fusion Client is installed (comma separated list where the Fusion Client config roots are). |
Before you start the installation, ensure that the following environment variables are set in the system:
WEBLOGIC_DOMAIN_HOME
Location where the WebLogic domain is installed.
ORAINST_HOME
An absolute path to the file containing the central inventory information. This file is created during Weblogic/Oracle Middleware Installation and defines the inventory_loc and inst_group variables in it. The inst_group value should be the UNIX group for the opatch utility.
Example 9-1 Content of the oraInst.loc File
ORAINST_HOME env variable is set as: export ORAINST_HOME=<full path to>/oraInstl.loc
|
Note: Although it is recommended that these variables be set up in relevant bash shell startup files (.bash_profile) of the system, you can also set up the variables using the EXPORT command at the UNIX prompt. For more information on setting up these variables in the startup files, refer to the Oracle Retail Advanced Inventory Planning Implementation Guide. |
Information such as user credentials for the AIP Dashboard installation 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.
|
Note: Before installing the AIP Dashboard in silent mode, you must create user credentials in an Oracle Wallet. This step is optional when installing in text or graphical mode. |
Installing the AIP Dashboard in silent mode requires two kinds of credentials to be stored in the wallet before it starts:
Weblogic Admin UserID and Password
Stored against the alias wlsalias (or whatever alias is configured within the ant.install.properties file against the input.admin.username.alias property).
Datasource UserID and Password
This is the username and password used to connect to the AIP RPAS Domain. Stored against the alias dsAlias (or whatever alias is configured within the ant.install.properties file against the input.datasource.alias property)
|
Note: The respective passwords are prompted for by thesave_credential.sh script |
To create the user credentials, perform the following steps:
Set and export the JAVA_HOME variable.
CD to <installer>/retail-public-security-api/bin.
Run ./save_credential.sh -a <userNameAlias> -u <username> -l <locationOfWalletDir>.
For example: ./save_credential.sh -a wlalias -u weblogic -l ./wallet/
The following table describes the field options to run the script:
| Field Option | Description |
|---|---|
| <userNameAlias> | The keyname for which the credentials need to be stored. |
| <username> | The username to be stored in a secure credential wallet for the specified userNameAlias. |
| <locationOfWalletDir> | The directory where the wallet will be created. This is an optional parameter.
If omitted, it creates the wallet under: |
|
Note: Credentials can be used in GUI mode if you select Yes to Retrieve Credentials from the wallet as shown in Figure 9-2, "Retrieve Credentials? Window". |
To install the AIP Dashboard in silent mode, perform the following steps:
Ensure that you have completed the task, Setting Up Your Installation Properties File.
|
Note: Ensure that the ant.install.properties file is available in the same directory with the install.sh script. |
Ensure that you have saved these user credentials in an Oracle Wallet:
Weblogic domain admin user credential (the entry alias is configurable)
Database user credential
The silent mode installer does not ask for user credentials. Instead it retrieves them from the Oracle Wallet.
For more information, refer to Creating User Credentials in an Oracle Wallet.
|
Note: The installation property input.retrieve.credentials must be set to Yes. |
Ensure that the WebLogic Server is running and the datasource is accessible.
Navigate to the AIP Dashboard installation folder, enter the following command:
./install.sh silent
If you prefer to use GUI (graphical user interface), you can use the Oracle Installer in the graphical or text mode. Although this section describes how you can install the AIP Dashboard in graphical mode, the same on-screen instructions appear as text instructions in the text mode.
|
Note: Although you do not have to set up the installation properties file when installing in graphical or text mode, it is helpful. If you set up values in the properties file, those values will be the default values in the graphical or text mode dialog.For instructions on setting up this file, refer to Setting Up Your Installation Properties File. |
To install the AIP Dashboard in graphical mode, perform the following steps:
Ensure that the WebLogic server is running and the Database is accessible.
If you are viewing the installer from a Windows client:
On the Windows client, start an Xserver program that enables you to emulate the X terminal.
On the application server, set the display for the Windows client where you want the Oracle Installer to display as follows:
export DISPLAY=<IP address>:0.0
From your application server machine, enter the following command:
./install.sh
When the installer runs, it attempts to validate the version of WebLogic and the associated Oracle Application Development Framework that are used by the WebLogic domain. If you encounter a validation error, fix the problem and try again.
The AIP Dashboard Installer Window opens. Click Next.
The Retrieve Credentials? Window opens.
In the Credentials store directory text box, specify the location of the Oracle Wallet you want to use to save or retrieve user credentials.
Select whether to retrieve user credentials from the Oracle Wallet:
| Option | Description |
|---|---|
| Yes, retrieve saved credentials | Indicates that the installer will read the user credentials from an Oracle Wallet |
| No, enter the credentials by hand | Indicates that you will enter the user credentials in the user interface. |
Click Next.
The WebLogic Admin Server Details Window opens. Enter appropriate information for the following fields and click Next:
| Field | Description |
|---|---|
| Admin Server Host Name | Specify the host name of the application server. |
| Admin Server Port Number | Specify the port number associated with the admin server of application server. |
| Admin User Name | Specify the administrative user name for the application server. |
| Admin User Name Alias | Specify an alias name for the administrative user. Specifying this name enhances the security for the application. When left blank, the alias name defaults to the administrative user name. |
| Admin Password | Specify the password associated with administrative user name. |
| Test admin server connection? | Select Yes if you want to test the connection to the admin server.
Select No if you want to advance to the next window without testing the connection. |
| Application Solution ID | Enter the solution ID for AIP that matches the solution name from Fusion Client's Foundation.xml.
For example: |
| Deployment Library Name | Enter the deployment library name:
|
| App log file | Location to create the AIP Dashboard application log. |
The Application Configuration Window opens.
Specify whether or not you are installing to more than one host:
| Option | Description |
|---|---|
| Yes | This indicates an installation where at least one managed server is running on a remote machine (remote to the admin server machine).
Go to Step 8. |
| No | This indicates an installation where all of the managed servers for deploying the Fusion Client are running on the same machine as the admin server machine, or if you are deploying to the admin server only.
Go to Step 9. |
If you selected Yes on the Application Configuration Window, then the SSH Credentials Window opens, otherwise continue to Step 9
Enter the relevant information in the following fields and click Next:
| Field | Description |
|---|---|
| Authentication method | Select one of the following authentication methods:
|
| SSH User Name | Specify the SSH user name to connect to the remote hosts. |
| SSH User Name Alias | Specify the alias name associated with the SSH user name. Specifying an alias name enhances the security for the application. When left blank, the alias name will default to the administrative user name. |
| SSH password or passphrase | Based on the authentication method you selected, enter the relevant SSH password or passphrase. |
| SSH Key File Path | In case you selected the Passphrase option in the Authentication Method field, enter the location of the SSH key file.
When left blank, the installer will retrieve the file from ${user.home}/.ssh/id_dsa directory, where user.home is your home directory. To use this default location, ensure that you have the private DSA key stored at this location. |
The Application Server Details Window opens. Enter relevant information for the following fields and click Next:
| Field | Description |
|---|---|
| Cluster or Managed Server Name(s), comma-separated | Enter the cluster or managed server names where you want to deploy the AIP Dashboard. It should be the same managed server as the Fusion Client. |
The Application Data Source Details Window opens. Enter relevant information for the following fields and click Next:
| Field | Description |
|---|---|
| Datasource JDBC URL | Enter the JDBC URL in the format:
|
| Datasource Jndi Name | Enter the JNDI name.
For example, |
| Datasource Schema user | Enter the datasource user name user name. |
| Dashboard Datasource Password | Enter the password for the datasource user name. |
| Database User Security Alias | Enter the security alias for datasource user. |
The Fusion Location Information Window opens. Enter relevant information for the following fields and click Next:
| Field | Description |
|---|---|
| Configuration Directory | Specify the location where the RPAS Fusion Client is installed. |
| Machine Names (hostname/Ip) | Enter the hostname/IP of the machine where Fusion Client is installed. |
The Installation Summary Window opens. Review the installation summary and click Next.
The Installation Progress Window opens. To start the installation, click Install.
|
Note: If the AIP Dashboard has already been installed with the Fusion Client and you are reinstalling the AIP Dashboard, you need to stop the Fusion Client application first from the WebLogic console before running the AIP Dashboard installer. |
After successfully completing installation, complete Fusion Client Install postinstallation.
For details on Fusion Client setup refer to the Oracle Retail Predictive Application Server Installation Guide.
After the AIP Dashboard installation is complete, the RPAS Fusion Client must be re-installed with the same properties used during the initial install, except providing values for the following three properties:
List of bundles
List of shared libraries
Homepage module value
|
Note: These properties are found in the RPAS Fusion Client Installer, Installed Bundles Details Window |
|
Note: Edit the ant.install.properties file using any text editor and set
Where |
After the installation is finished, login to the AIP-RPAS application using the Fusion Client to verify that the AIP Dashboard displays in the home page.
