6 Install the Application Configuration Console Client

Follow the instructions in this chapter to install Application Configuration Console Clients on end-user machines.

6.1 System Requirements

Ensure that the machines on which you are installing Application Configuration Console Clients comply with the hardware, software, and browser requirements stated in Table 2-4 in Chapter 2.

6.1.1 Client Prerequisites

Note these prerequisites:

  • The Core Server must be installed before installing Client software. You will need the server host name and port numbers during the Client installation.

  • Each Client system must have a working version of Java (JDK or JRE) to run the installation program, and its location must be included in the PATH.

  • If using SSH certificates, you must use Open SSH to generate certificates.

6.2 Installing Application Configuration Console Clients

The Client software comes complete in a ready-to-install executable file.

  1. Insert the Application Configuration Console Installation CD and double-click client/ApplicationConfigurationConsoleClient.exe to start the automated installation program.

    Click Next on the Welcome panel to proceed with the installation.

  2. Use the default installation location, or click Browse to navigate to a different location. You should not install a new version of the Client in the same directory as a previous version.

    Click Next to proceed with the installation.

  3. The Client requires a JDK. If you want to continue to use your existing version, select the second option on this panel and then specify the JDK installation directory on the follow-on panel. If you want to use a dedicated version with Application Configuration Console, select the first option to install it with the Client.

    Click Next to proceed with the installation.

  4. The Client needs to connect to the Application Configuration Console's Core Server. Type the host name and server ports where the Core Server was installed.

    Set the memory (Java heap size) allocated for the Application Configuration Console Client. Do not decrease the Initial Java heap size; the Client requires at least 256 MB of memory. You can leave this default value, or set a larger number if you expect to work with large data sets.

    Click Next to proceed with the installation.

  5. Select whether the installation is available only to the user who is logged in, or to all users. Also select whether to include an icon for the Uninstaller.

    Click Next to proceed with the installation.

  6. Confirm all of your settings and click Next to install the software, or click Back to alter settings.

  7. When the installation completes, click Finish to exit the wizard.

6.3 Starting the Application Configuration Console Client

To start the Client after the installation, simply double-click the desktop icon (if you installed one), or go to the Start menu and select All Programs > Oracle Application Configuration Console > Client>Start.

When you first log in to the Client, it creates an application log file (mvApp.log) and properties file (mvApp.properties), where Client preferences such as the Core Server URL are stored. The default location for these files is as follows:

%USERPROFILE%\Application Data\ApplicationConfigurationConsole

Where %USERPROFILE% defaults to C:\Documents and Settings\username.

The Client creates other properties files as users set specific preferences related to tracking (mvAppTrack.properties) and comparison (mvAppComparison.properties) operations. Together with the log and application properties files, these combine to make a Client profile on the host machine.

Note:

As the person who installs the Client, you must grant (operating system) permissions to anyone who will need to start the Client on this machine.

6.3.1 Connecting to Multiple Server Instances with the Same Client Version

Oracle discourages use of separate Client instances of the same version on a Client host. Rather, you should use the same Client login to connect to different server instances, for example staging and development. You can facilitate this by setting a preference in the Application Configuration Console application to prompt for a URL pointer each time you start up the Client.

  1. In the Client, select Window > Preferences.

  2. In the General tab, select the Prompt for server URLs at each login checkbox.

  3. Click OK.

Now, each time you start up the Client, you will be prompted to type or select the URL of the Core Server you want to connect to.

6.3.2 Using Different Client Versions on the Same Host

User sites often want to run different Application Configuration Console versions in parallel. When you want to run different Client versions on the same host, create discrete Client environments, as follows:

  • Install to separate directories

  • Create distinct properties profiles and logs

So, for example, if you want to run Application Configuration Console 5.3.1 and 5.3.x on the same Client host, you might install to the separate directories:

C:\Program Files\Oracle\oacc\Client-5.3.1
C:\Program Files\Oracle\oacc\Client-5.3.x

Then, for each installation, create a unique profile.

  1. Navigate to the runtime folder under the 5.3.1 installation directory. For example:

    C:\Program Files\Oracle\oacc\Client-5.3.1\runtime
    
  2. Open the startup.bat file in a text editor and edit the following line to point to a unique location:

    -Dmv.userfile.dir="%USERPROFILE%/Application Data/
    ApplicationConfigurationConsole"
    

    Where %USERPROFILE% defaults to C:\Documents and Settings\username. For example, change the last folder to ApplicationConfigurationConsole-5.3.1. A folder of that name does not have to exist; Application Configuration Console will create it upon startup.

  3. Save the file.

  4. Repeat the first three steps for the 5.3.x installation, changing the folder name appropriately.

Now, when you start up the 5..3.1 Client, the preferences reflect the appropriate settings to connect to the 5.3.1 Core Server. Likewise, when you start up the 5.3.x Client, the preferences are appropriate to the 5.3.x Core Server.

6.4 Repointing Web Reports

Application Configuration Console Client installation places a shortcut on the Start menu to open Web Reports in a browser (All Programs > Oracle Application Configuration Console > Client>Start Web Reports). If, for some reason, you want to change the URL that this shortcut points to, take the following steps:

  1. Navigate to the following location in the Client default installation directory:

    C:\Program Files\Oracle\oacc\Client\runtime
    
  2. Right-click webreports and select Properties in the popup menu.

  3. Click the Web Document tab and edit the URL value as appropriate.

  4. Optionally type a shortcut key combination.

  5. Click OK.

You may want to do this, for example, if you decide to redeploy the Web Reports server, as described in Section D.2.1, "Redeploying Web Reports Server."

6.5 Integrating Custom Reports

Web Reports can accommodate custom reports developed by Professional Services to meet the reporting needs of individual customers. Custom reports must be coded as JSPs and deployed to the Tomcat server, after which they can be integrated into Web Reports and made accessible on the menu bar. You must use BIRT design formatting if you want to schedule report generation. The default location for Web Reports JSPs is as follows:

$OACC_INSTALL/appserver/tomcat/webapps/mvwebreports/jsp

To integrate a custom report, you have to edit the Web Reports Registry (webreports_registry.xml) to recognize the JSP. This in turn allows users to schedule the report and select it on a menu. You can either add the report as a menu item to an existing menu or create a custom menu. The same report can appear on multiple menus, if desired.

Specific edits to the Web Reports Registry include the following:

  • Add a report definition to the report-definitions element that consists of a report name, a target JSP, and a unique identifier (URI). For example:

    <report name="Your Report"
    target="/mvwebreports/jsp/YourReport.jsp"
    uri="http://mvalent.com/2003/reportDefinitionType#YourReport"/>
    
  • If you are adding a custom report to an existing menu, add a menu item to the appropriate menu element, Planning, say. For example:

    <menu name="Planning">
    <menu-item uri="http://mvalent.com/2003/reportDefinitionType#YourReport"/>
    </menu>
    

    Use the same URI value as specified in the report definition.

  • If you are adding a custom report to a new menu, add a new menu element that includes the menu item. For example:

    <menu name="Your Menu">
    <menu-item uri="http://mvalent.com/2003/reportDefinitionType# YourReport"/>
    </menu>
    

    In fact, the Web Reports Registry includes an element placeholder for a new menu that you can uncomment, replacing "Custom Report" with your menu name and "tbd" with an appropriate URI.

Add report definitions and menu items for each custom report you want to integrate.

Note:

Report scheduling depends on the uniqueness of a report's URI. It cannot be altered or reused for some other report. If it is altered in any way (or deleted), scheduling for the report will no longer work. For this reason, be careful as well not to inadvertently change existing elements when editing the Web Reports Registry.

6.5.1 Edit the Web Reports Registry

To edit the Web Reports Registry:

  1. Open the Application Configuration Console Client.

  2. In the Navigator view, locate the configuration file, as follows:

    System > System Configuration > Common Configuration > MV_CONFIG > Resource View

  3. Right-click webreports_registry.xml and select Open.

  4. In the Editor area, click the Edit button and add the necessary elements.

  5. Save the file.

  6. In the Navigator view, right-click the System Configuration folder and select Make Configuration Changes Live to render the new report selection in Web Reports.