| Oracle® Retail Predictive Application Server Administration Guide for the Fusion Client Release 14.1 E59119-01 |
|
 Previous |
 Next |
| Oracle® Retail Predictive Application Server Administration Guide for the Fusion Client Release 14.1 E59119-01 |
|
Previous |
Next |
After you install the RPAS Fusion Client, before letting users access the application, you must configure it based on the specified business needs. This chapter describes the configuration options available with the RPAS Fusion Client. It also includes information on how you can configure additional domains that are created after installing the RPAS Fusion Client as well as information about logging into the Fusion Client. This chapter includes the following sections:
The RPAS Fusion Client layout and formatting capabilities are used along with Save Format/All (and sometimes Group) for each template. Mass, consistent formatting is important in this case.
Periodically, the layout and formatting of an installed application will need to be revised, and these capabilities will be used once again.
With RPAS, when the domain's configuration is patched in a way that includes structural changes, or sometimes when the RPAS software is upgraded, the format database in the domain can be invalidated. In these cases, all saved formatting (Template All, Group, and User, plus the workbooks themselves) must be cleared out and recreated. Mass, consistent formatting is especially important in these cases.
You use the Configuration Properties (config.properties) file to set up the session timeout properties.
To set up the config.properties file:
Navigate to the following location where the RPAS Fusion Client is installed:
<RPAS_Fusion_Client_Installation>/config/
In a text editor, open the config.properties file and set the following parameters:
session.timeout: set a time limit (in minutes) after which the current user session will expire. The default value is 35 minutes. Do not use a value that is less than 5 minutes. A reminder dialog is presented to users at a defined number of minutes prior the expiration. The defined number of minutes is set by the session.remindin parameter in the web.xml file. See "Updating the Session Reminder" for more information about updating the web.xml file.
sso.logout.url=<logoutURL>: use this URL to log out from both SSO and RPAS.
If this property is not specified, then the following occurs. The logout link on the Fusion Client page states "end session". Clicking the link only terminates the RPAS session. The user is taken to a page that states "session has ended". A login link is provided. If the user clicks the login link, the user is taken back to the Fusion Client home page.
For Oracle 11g SSO, set this property to /oam/pages/logout.jsp.
isSSO: set the value to true to indicate that the application is running in an Single Sign-On environment.
|
Note: For information about Single Sign-On, see the Oracle Retail Predictive Application Server Installation Guide. |
Save the file and, for the changes to take effect, restart the WebLogic server.
In 14.0, the Fusion Client introduced a basic latency measurement capability. This helps you to get an idea of the latency on the network and analyze any slowness of the application. An estimate of the latency is obtained and displayed in the bottom of the home page and the workbook page.
Latency is the time it takes for data to move between the browser and the application server, in any direction. RPAS measures latency as the time it takes for a small image file to be fetched from the application server into the browser. The request and response are processed in several layers of the network stack on both ends. So it should be treated as an approximation of the latency.
The feature can be disabled by setting the property "latency.measurement.enabled" to false. This is the default value. If you are not concerned about latency, you might want to leave this feature disabled.
The frequency of measurement is specified by a property named "latency.measurement.interval". The value is the number of seconds between measurements. The default value is 30 seconds. Higher values cause less of a performance hit on the ongoing user session, but the latency measurement is less recent.
These two properties areset in "config.properties".
In addition to the config.properties file, there are several more properties files located in the config folder of the Fusion Client installation. The majority of these files should not be altered. For information about the ones you can alter, see "Appendix: Fusion Client Properties Files".
Config.properties: Overall application configuration settings such as timeout and SSO configuration.
Log4jconfig.xml: Logging settings: detail levels and locations for log files.
The log file that is configured here contains configuration errors from the taskflow and the foundation. For example, if the taskflow and foundation do not have any solution IDs in common, you will see a "NO CONNECTABLE SOLUTIONS from Taskflow and Foundation" error in this log and nobody will be able to log in. In addition, end users cannot in general see why they are not able to connect to a particular solution. An administrator may want to inspect these logs to diagnose such problems.
Jps-config.xml: Internal configuration file used for application security.
FormatConfig.xml: Configuration information used to determine what styles or formats to use for specific types.
FormatMapping.xml: Internal file used to read FormatConfig.xml.
GraphConfig.xml: Configuration information used to determine default styles for graphing and graph types. For more information, see "GraphConfig.xml File".
GraphMapping.xml: Internal file used to read GraphConfig.xml.
LanguageMap.properties: Used to map Browser locales to RPAS Supported languages.
PivotTableStyles.properties: Used to set some default styles for pivot table cell text and backgrounds. For more information, see "PivotTableStyles.properties File".
Foundation.xml: Specifies connection and domain information for RPAS domains. For more information, see "Configuring Additional Domains".
rpasConfig.properties: Configuration properties for RPAS applications deployed on the Fusion Client. For more information, see "rpasConfig.properties File".
Before a Fusion Client session times out, a reminder message appears, informing the user that the session will expire. The number of seconds before expiration can be configured in the web.xml file.
By default, sessions will expire after 35 minutes of inactivity. The default reminder message appears two minutes prior to session expiration. This means that after 33 minutes of inactivity, the default reminder appears. After two addition minutes of inactivity, the session expires.
To change the amount of time before session expiration when the reminder message appears, complete the following steps:
Locate the Fusion Client ear file called rpas.ear.
Make a temporary folder called tmp. In that folder, extract the rpas.war file from the rpas.ear file.
mkdir tmp cd tmp jar xvf ../rpas.ear rpas.war
Extract the web.xml file from the rpas.war file:
jar xvf rpas.war WEB-INF/web.xml
Edit the web.xml file as follows:
From the beginning of the file, search for the string WARNING_BEFORE_TIMEOUT.
Update the param-value property that is directly below the WARNING_BEFORE_TIMEOUT line by entering the number of seconds you want the reminder message to appear before session expiration.
For example, if you want the reminder to appear 180 seconds before session expiration, enter the following:
<context-param>
<description>Number of seconds before timeout when warning must be
displayed</description>
<param-name>oracle.adf.view.rich.sessionHandling.WARNING_BEFORE_
TIMEOUT</param-name>
<param-value>180</param-value>
</context-param>
Save the web.xml file.
Update rpas.war while in tmp folder:
jar uvf rpas.war WEB-INF/web.xml
Update rpas.ear while in the tmp folder. Delete the tmp folder after you are finished.
jar uvf ../rpas.ear rpas.war cd .. rm -rf tmp
Announcements can be created and broadcast to Fusion Client users. These messages appear on the Login screen, a user's home page, and the workbook.
The properties file is called announcements_<locale-abbreviation>.properties and is located in <configroot>/announcements. The text of a message can be customized for different locales and countries. For example, to display a message in US English (the default), in German for all locales where that language is spoken, and Brazilian Portuguese:
announcements.properties announcements_de.properties announcements_pt_BR.properties
The properties file contains three types of announcement messages:
loginpage.message=<Message to be shown on login page> homepage.message=<Message to be shown on home page> workbookpage.message=<Message to be shown on workbook page>
For example:
loginpage.message=System will be shutting down in ten minutes.
By default, the latest message appears when a use logs in; however, this is configurable. A new message overwrites an existing one. Set announcements.update.delivery located in config.properties to configure this.
Table 5-1 Settings for announcements.update.delivery
| Setting | Description |
|---|---|
|
onaction |
Enables dynamic loading. The latest announcement appears whenever a user performs an action in the UI that requires an interaction with the server. |
|
never |
Disables dynamic loading. Announcement messages are only loaded into a user's session when the user logs in. No other messages will appear until after a user logs out and then logs in again. |
Messages can be formatted using HTML tags such as <ul> and <li> for bulleted lists, <br> for line breaks, <p> for paragraphs, as well as <a> for hyperlinks.
During the RPAS Fusion Client installation, the installer automatically sets up the RPAS domain connection configuration in the Foundation.xml file. If you choose to set up the domain connection after the installation or set up an additional domain, you must manually set up the connection.
|
Note: Beginning with the 13.3.1 release, ProfileList.xml is no longer used by the Fusion Client. Foundation.xml is used to maintain the required domain-connection information. |
To set up a domain connection manually, complete the following steps:
After you have the additional domain set up, navigate to the following location in the RPAS Fusion Client installation directory:
<RPAS_Fusion_Client_Installation>/config/rpas/
In a text editor, edit the Foundation.xml file, and append connection details for your solution using the following syntax:
<solution>
<name>{Solution Id}</name>
<description>{Solution Description}</description>
<server-name>{RPASServerName}</server-name>
<daemon-port>{Port Number}</daemon-port>
<daemon-name>{Domain Name}</daemon-name>
<domain-path>{location where simple or global domain is
installed}</domain-path>
</solution>
|
Note: In the example above, placeholders have been used as values for the parameters. Ensure that you replace the placeholders with the relevant values. The Solution ID should be the same as the one specified in Taskflow_MultiSolution.xml. |
Where,
Solution ID: The name of the solution that is used in the MultiSolution taskflow file. The ID must match the values that have been set up in that file.
Solution Description: The description for the solution that is displayed in the Fusion Client.
RPAS Server Name: The host where the RPAS Server is installed and the Domain Daemon process is running.
Port Number: The port to specify when starting the Domain Daemon.
Domain Name: The name used for the master domain or the simple domain.
Domain Path: The location where the domain is installed. It must be either a simple domain or a global domain environment.
|
Note: The connection details for every solution ID in the MultiSolution taskflow can appear in the same Foundation.xml file. |
Save and close the Foundation.xml file.
In the <RPAS_Fusion_Client_Installation>/config directory, create a new subdirectory and specify MultiSolution as the name. In addition, create a resources subdirectory within the MultiSolution directory.
Navigate to the fusionClient directory located within the directory where the domain is installed. This subdirectory contains the following files that define the Taskflow configuration:
taskflowBundle.properties
taskflow.xml
These files exist in the domain's fusionClient directory after the domain is created with the rpasInstall script. These files can also be created directly from the report generation tool in the RPAS Configuration Tools. For more information, see the RPAS Configuration Tool User Guide.
|
Note: If using characters outside the "Latin 1" ascii range, you must run the native2ascii command after editing the taskflowBundle.properties file. This ensures that the characters in the taskflow are displayed properly in the Fusion Client. The native2ascii command can be found in any Java JDK $JAVA_HOME/bin folder. |
Copy the two files to the MultiSolution directory you created in step 4.
Obtain the taskflow file from the domain.
If the Fusion Client installation supports only this single solution, then copy the file to the MultiSolution directory and rename the file to Taskflow_MultiSolution.xml.
|
Note: Ensure that the Solution ID in this file matches the Solution ID specified in Foundation.xml. |
If the Fusion Client installation supports multiple solutions, you must combine and arrange them. For more information about taskflow formats and combining taskflows, see the Oracle Retail Predictive Application Server Configuration Tools User Guide.
If the Fusion Client installation supports only this single solution, then copy the file to the MultiSolution/resources directory and rename the file to MultiSolutionBundle.properties.
|
Note: Ensure that the Solution ID in this file matches the Solution ID specified in Foundation.xml. |
If the Fusion Client installation supports multiple solutions, you must combine and arrange them. For more information about taskflow formats, and combining taskflows, see the Oracle Retail Predictive Application Server Configuration Tools User Guide.
For the changes to take effect, restart the RPAS and WebLogic servers.
The following example illustrates a sample configuration of Foundation.xml with two solutions.
<?xml version="1.0" encoding="UTF-8" ?>
<solutions>
<solution>
<name>ap</name>
<description>Assortment Planning</description>
<server-name>RPAS_host</server-name>
<daemon-port>12345</daemon-port>
<domain-path>/folder/APGlobalDomain</domain-path>
</solution>
<solution>
<name>ip</name>
<description>Item Planning</description>
<server-name>RPAS_host</server-name>
<daemon-port>12345</daemon-port>
<domain-path>/folder/IPGlobalDomain</domain-path>
</solution>
</solutions>
Before you log into the Fusion Client, ensure that your system meets the recommended configuration. For more information, see the Oracle Retail Predictive Application Server Installation Guide.
Once you check the configuration, obtain the following information:
Uniform Resource Locator, URL: You must enter the URL or the web address of the application in the web browser to access the application. For example, http://<fullyqualifieddomainname>:<port>/<applicationcontextroot>
User name and password.
|
Note: Although you must provide a user name and password, you are authenticated externally either by SSO or LDAP. |
To log into the Fusion Client:
Start a supported web browser.
In the Address bar, enter the Fusion Client URL, and press Enter. The Fusion Client Login page appears.On the Login page, enter the username and password.Click Login.
