11 Setting Up the Online Help

To make the Online Help available in the Java and Web Client, complete the following steps:

Note: The following configuration parameters are not supported by standard help, but could still be used for customer specific help: - EDB-HLP-MASK - EDB-HLP-MASK-MSH - EDB-HLP-PATH - EDB-HLP-PATH-EDBKERNEL

1. In your Agile e6 installation folder, create the directory structure ".\axalant\htd\htdocs\axalant\doc_ep\eng".

2. Download the Online Help for Java and Web Client from the Oracle Technology Network website:

   http://www.oracle.com/technetwork/documentation/agile-eseries-098047.html

   1. For Agile e6.2.0.0, click on the link HTML.

   2. Download the documentation package Online Help for Agile e6.2.0.0 (Java/Web Client).

   3. Save the zip file into the directory ".\axalant\htd\htdocs\axalant\doc_ep\eng".

3. Extract the zip file into the …\eng directory.

   On UNIX use unzip, and on Windows use Winzip or 7zip to extract the file.

   
   

   Note: The zip file is only available in English. If the dump language is set to German, create a directory structure ..\doc_ep\ger and extract the zip file in the "ger" directory. If the dump language is set to French, create a directory structure ..\doc_ep\fr and extract the zip file in the "fr" directory.

   
   

4. Copy the "axalant" folder, which is located under the htdocs folder, to a Web Server of your choice. Copy the axalant folder directly below your document root of your Web Server.

   Example:

   1. Use the HTTP server of your Admin Server installation (Apache Tomcat) located under:

      Windows:

      %ALLUSERSPROFILE%\agile\installer\6.2.0\admin

      UNIX:

      $HOME/.agile/installer/6.2.0/admin.

   2. Navigate to the directory "webapps".

   3. Create a new directory "help".

   4. Copy the "axalant" folder, which is located under the htdocs folder, to the "help" folder.

5. Log in to Agile e6 as a manager user (e.g. edbcusto, demoep_m).

6. Select System > Other Parameters.

7. In the configuration mask, search for rubric EDB-HLP and select the folder Configuration parameter.

8. Set the documentation root EDB-HLP-ROOT to:

   http://<http server name>:<http port>/help/axalant/

   The program adds /doc_ep/eng/ or /doc_ep/ger/, depending on which language is active, followed by the index file name index.html.

   • English:

     http://<http server name>:<admin http port>/help/axalant/doc_ep/eng/index.html

   • German:

     http://<http server name>:<admin http port>/help/axalant/doc_ep/ger/index.html

On UNIX Systems, Agile e6.2.0.0 starts Mozilla as a default. If the browser is not defined, follow the steps below:

1. Select Manager > External Applications to specify different browsers on different operating systems and client nodes.

   This is where the default browsers for each available UNIX System are defined. For Microsoft Windows the default system HTML browser is used.

2. Copy the line for your hardware architecture and insert the hostname and browser name.

   
   

   Note: Make sure that all of the following are true:

   
   

   • File type is equal to HTML

   • Mode is equal to H (help)

   • "-" is a wildcard and means every possible value (like *)

11.1 Using WebLogic Server

The WebLogic Server can be used to provide the Online Help. In WebLogic you can develop a simple Web application to display static HTML content.

1. Download the Online Help for Java and Web Client from the Oracle Technology Network website:

   http://www.oracle.com/technetwork/documentation/agile-eseries-098047.html

   1. For Agile e6.2.0.0, click on the link HTML.

   2. Download the documentation package Online Help for Agile e6.2.0.0 (Java/Web Client)

2. Save the zip file into a new directory, e.g. online_help.

3. Extract the zip file in this directory.

   On UNIX use unzip, and on Windows use Winzip or 7zip to extract the file.

4. Login to the WebLogic Console and deploy the online_help directory as an application.

5. Click Deployments.

6. Click Lock & Edit.

7. Click Install and set the path to the directory created in step 2.

8. Click Next.

9. Select a Managed Server to deploy to and click Next.

10. Accept the defaults and click Finish.

    The deployment completes successfully.

11. Click Activate Changes.