Analytics on AIX Server Installation Guide

Analytics on AIX server Installation Guide

[Siebel Business Analytics Platform 7.8.5.1]

Date: 16 January 2007

------

Siebel Analytics version: Analytics 7.8.5.1 platform Siebel Analytics Server OS: AIX 5.3

Database version: Oracle 10g release 2 Database Server OS: AIX 5.3

Web Server OS: IBM Web sphere Application Server 5.1 / IBM HTTP Server 2.0.47 Siebel Analytics Administration Tools OS: Windows Server 2000 SP4

Web Client version: Internet explorer 6.0.2900

------Europe Oracle|Siebel IBM Support Center Montpellier – PSSC

INTRODUCTION...... 4

DOCUMENT PURPOSE...... 4 DOCUMENT CONTEXT...... 4 SIEBEL ANALYTICS DESCRIPTION...... 8 SIEBEL ANALYTICS ARCHITECTURE...... 8 PREREQUISITES...... 11

HARDWARE REQUIREMENTS...... 11 CLIENT ENVIRONMENT REQUIREMENTS...... 11 SERVER ENVIRONMENT REQUIREMENT...... 11 WEB SERVER REQUIREMENT...... 11 DATABASE REQUIREMENT...... 12 SIEBEL ANALYTICS REQUIREMENT...... 12 PREPARING INSTALLATION...... 13

AIX TASKS...... 13 WEB SERVER TASKS...... 15 WAS 5.1 Installation Steps...... 16 IHS 2.0.47.1 Installation Steps...... 23 LICENSE TASKS...... 27 JAVA TASKS...... 27 DATABASE TASKS...... 28 SIEBEL ANALYTICS TASKS...... 29 INSTALLATION STEPS...... 30

FIRST STEP...... 30 “DO NOT FORGET” STEPS...... 31 RUN STEPS...... 33 CHECKING INSTALLATION LOGS STEP...... 40 POST INSTALLATION STEPS...... 41

FIRST THINGS TO DO...... 41 CREATING AND TRANSFERRING ANALYTICS REPOSITORY...... 43 Siebel Analytics Administration Tool Installation...... 43 Creating Siebel Analytics Repository...... 47 Transferring Siebel Analytics Repository...... 48 STARTING ANALYTICS SERVER...... 49 UPDATING CONFIGURATION SETTINGS...... 52 TARGET DATABASE SETTINGS...... 52 TESTING ANALYTICS CLIENT INSTALLATION...... 53 STARTING ANALYTICS WEB SERVER...... 56 About Siebel Analytics Web Server...... 56 Configuring Analytics Web Plan...... 56 Creating a news Web Archive (war file)...... 57 Deploying the Web Archive file...... 57 Update the web server plug-in...... 64 Restart Web sphere server...... 65 Restart Siebel Analytics server and Web server...... 65 STARTING BROWSER CLIENT TO TEST INSTALLATION...... 66 Launch a supported browser client...... 66 POSSIBLE ERRORS...... 67 Oracle driver not found in answers...... 67 Chart graphics display in Dashboard doesn’t work...... 68 Refresh link in Dashboard doesn’t work...... 70 APPENDIX...... 71 How to customize user interface...... 71 How to insert auto-refresh functionality in Siebel Dashboard...... 74 Analytics Useful Folders and Files Structure...... 75

2/75 [author] Christophe Menichetti Europe Oracle|Siebel IBM Support Center Montpellier – PSSC

Introduction

Document Purpose

The goal of this document is to explain all different steps mandatory to success Siebel Analytics 7.8.5.1 installation on IBM AIX 5.3 server (IBM p520 machine). This paper will also provide you a guide through installation steps to help you to understand all different components necessary and its functionalities.

At the end of this documentation, you should be able to better understand Siebel Analytics Installation tasks and architecture and be able to use Siebel Analytics Intelligence Dashboards.

Reader must be aware that he can not find any information about Siebel Analytics Administration or performance customizations.

Document Context

In this document, we are using the following hardware configuration:

 1 IBM power5 logical partition (LPAR) on one IBM p520 machine for all Analytics Servers  2 IBM power5 logical partitions on another IBM p520 machine for Oracle Database part (oracle 10g R2 RAC)  IBM Fast Storage

We are also using the following software components:

 Siebel Analytics 7.8.5.1 servers (web server and server)  Oracle Database 10gR2 Real Application Cluster  Web sphere Application Server 5.1 Fix Pack1  AIX 5.3 L  Java Runtime Environment 1.4.2

You are going to find 3 architecture schemas summarizing the previous descriptions.

First, the following schema will show you hardware and network quick description:

Siebel Analytics 7.8.5.1 servers

Logical Partition: Node12

IBM P520

Network

Oracle 10gR2 RAC

Logical Partition 1: Logical Partition 2: SHARK BALI

IBM P520

Then, this schema will show you component architecture quick description:

NB: Oracle BI EE means Oracle Business Intelligence Enterprise Edition, the new name of Siebel Analytics In this square the following initials mean:

 W.S = web server, in other word Web sphere Application Server  P.S = Presentation Server (former Siebel Analytics Web Server)  BIS = BI Server (former Siebel Analytics Server)

To finish, this schema will show you oracle database functional overview description:

Siebel Analytics description

Siebel Business Analytics is a Business Intelligence tool helping decision makers to analyze enterprise data and take right decisions. It is composed by 2 main components:

 Siebel Analytics Server  Siebel Analytics Web Server

Siebel Analytics Server is the core server behind Siebel Analytics. It provides the power behind Siebel Dashboards (web-displayed Reports) for access and analysis of structured data. It allows a single information request (for reports for example) to query multiple data source.

Siebel Analytics Web Server is the core server behind HTML pages viewed by users. It provides the formatting and presentation of Siebel Dashboards (web-displayed Reports). Siebel Analytics presents a lot of reports (table, chart, pivot and so on …) to web users.

You can install Siebel Analytics in stand-alone mode (now called “platform”) or install Siebel Analytics integrated into Siebel CRM application (now called “application”).

Siebel Analytics architecture

The following architecture schema will give you more details about Siebel Components organization and how it is working:

Prerequisites

Hardware Requirements

For Siebel Analytics Server components:

CPU: 800 MHz RAM: 2 GB Disk: 2GB + disk space for cache storage

For Siebel Analytics Web Server components:

CPU: 800 MHz RAM: 2 GB Disk: 2GB + disk space for cache storage

Client Environment Requirements

Siebel Analytics supports the following Web browsers:

Internet Explorer 6.0+ with Windows 2000 Pro SP3 Internet Explorer 6.0+ with Windows XP SP1 or above Mozilla 1.7x with Sun Solaris 9, 10 Fire fox 1.0.x and Netscape 7.2.x on all 3 OS above

Server Environment Requirement

In this documentation, Server Operating System is AIX v5L (5.3)

Web Server Requirement

Web sphere Application Server 5.1 FP1 (and IHS 2.0.47) with Java JRE 1.4.2

Database Requirement

In this documentation, Database Server is Oracle 10g R2 and Database Server Operating System is AIX v5L (5.3)

Siebel Analytics Requirement

Product we are going to install, is Oracle Business Intelligence Enterprise Edition and Siebel Analytics Platform version 7.8.5.1 UNIX programs

Preparing installation

AIX Tasks

The following tasks should be completed before installing Siebel Analytics software under AIX:

1. If you are planning to run the AIX installation remotely, or on a PC-based machine, install third-party X window software (for graphic mode install)

a. Create a VNC desktop, by running VNC server

b. Connect to this virtual VNC desktop with VNC viewer

c. Think about DISPLAY variable

Export DISPLAY = node12:0 (an example)

2. Determine your installation directory and create it if it is necessary (here installation directory will be /Siebel/analytics7851Install)

Do not forget to change permissions for Siebel user id

And create 2 sub directories: SiebelAnalytics and SiebelAnalyticsData

3. Choose a user ID that can run all Siebel Analytics processes (here user is siebel)

Web Server Tasks

Before installing Siebel Analytics components (especially Siebel Analytics Web server) you should install web server on AIX (it will be WAS 5.1/IHS 2.0.47).

To launch WAS5.1 installer, you must execute the following steps:

1. Setup PATH variable to point to java repository present in WAS install repository

2. Execute : ./install

If you got an error: a suitable JVM could not be found

You can check:

a. If you are pointing to the right java repository in WAS installing repository

b. If you have execution permission on this java repository

c. If you have the right java version in PATH variable (jvm 1.3)

d. If you have the right PATH variable

e. If you are able to execute “./launchpad.sh” in WAS installing repository

f. If you created the right JAVA_HOME variable (excluding “bin” repository in the java path)

WAS 5.1 Installation Steps

Disable also java doc component and MQ component

Then install WAS 5.1 fixpack 1 (was 5.1.1) Do not forget to execute “setupCmdLine.sh” in Websphere bin directory

To finish install WAS 5.1.1 SR 1

IHS 2.0.47.1 Installation Steps

Now we are going to install IBM Http Server v2.0.47 (that’s why we unchecked IHS component in WAS installation). It is not mandatory

License Tasks

Before installation, you should be sure to get right license key and right XML file corresponding to installation file.

If you don’t have right license keys or you don’t know where you can get these files, go to this following link:

http://licensecodes.oracle.com/oracle_bi.html

Java Tasks

You must install Java Runtime Environment (JRE) (or JDK) 1.4.2 (or above). To determine if JRE (JDK) is already installed on the machine, use the following command:

 Java -version

If you got no information with this command, you must install a JRE/JDK 1.4.2 (go to sun internet site or other java machine provider)

Database Tasks

Before installation, you should be sure to get right Database connection client (it will be oracle database).

Here it is Oracle client 10g and oracle guys have set up Oracle client under our AIX machine correctly to connect Oracle database.

For your information, you can read below tsnnames.ora file (oracle connection configuration file):

Siebel Analytics Tasks

Before installing Siebel Analytics components, you should know that you will need to install Server Administration Tool (it is a Siebel Analytics Component) on Windows Platform.

Indeed you will be able to create and configure Siebel Analytics repository file and then you will transfer it on your AIX platform (with FTP tool for instance).

You will find further in this documentation how to install Siebel Analytics Administration tool. You could install now or later. You have choice but you must keep in mind that you need a windows platform!!!

Installation Steps

First Step

In our example, we are using a tar file containing Siebel Analytics code. So we are obliged to “untar” this file before any steps.

We execute the following command after transferring tar file (by ftp for example) on target machine:

After decompressing, we got an AIX repository which is the install repository. All following steps will be based on this requisite.

“Do not forget” Steps

Then you need to not forget following stuffs:

1. change file and directories permission for all directories and files in Siebel Analytics installation directory (chmod –R a+rwx *)

2. change OS user (to Siebel user)

3. export again DISPLAY variable to be able to use graphics mode

node 9: xhost + (to authorize all client to use node9 X11 server)

node12: Export DISPLAY=node9:5 (your VNC session display)

4. Change PATH variable to point to right java version (from java 1.3 for was to java 1.4.2 for analytics)

Export PATH=/usr/java14/bin:$PATH

Run Steps

To run installer in graphics mode, use the following command in right install (DVD- like) repository:

 Server/Siebel_Analytics_All/setup.sh

Browse up to find Analytics license key (prerequisite task, see previously)

This error could be due to a wrong copy of the license file during transferring this file from windows machine to UNIX machine (for example with ftp software, check you transferred with binary mode)

After you fix the problem, specify your Siebel Analytics installation path (if you want to change from Siebel default one = /usr/local)

Choose a custom installation in order to customize our installation

Enter the full path to the directory in which JAVA is installed (equivalent JAVA_HOME). Do not enter “bin” directory in the path

Checking installation logs Step

INSTALLDIR is the absolute path of the Analytics Server installation directory. It is the path you entered in response to the installer prompt (here /Siebel/analytics7851install).

Check the following file:

 INSTALLDIR/SiebelAnalytics/Log/Install.log

Post Installation Steps

First things to do

Note: Siebel Analytics DOES NOT SUPPORT more than one server instance on the same machine at one time

First you must determine your shell: execute env command

We are working with Korn shell.

You will find below the list of different scripts allowing you to start/stop all Siebel Analytics Servers or Siebel Analytics clients (of course these following commands may change according to the type of shell):

Note: all of these scripts are located in INSTALLDIR/SiebelAnalytics/setup

Creating and Transferring Analytics Repository

First thing to do is to create your Analytics Repository. To do that you must install Siebel Analytics Administration Tool (ONLY on windows Platform).

Siebel Analytics Administration Tool Installation

This Siebel tools is available only on Windows platform

Enter the right license file

Creating Siebel Analytics Repository

Launch Siebel Analytics Administration Tool

Create a new repository (or use your already created repository)

You can find below an example of a consistent (correct repository):

For more information about how to create a repository, you can read:

Siebel Analytics 7.7.1 Administration Tools First Steps.doc

Transferring Siebel Analytics Repository

You must transfer the xxx.rpd file from your windows machine to your UNIX server.

You can use FTP software as WinSCP our FileZilla.

Think about binary mode for transfer and about file permissions under UNIX server.

Edit the following configuration file: NQSConfig.ini

Do not forget to check if the repository name in NQSConfig.ini is the same as your xxx.rpd file.

Starting Analytics Server

Execute the following command:

Result:

If you read the log as it is written in standard output, you may see the following error:

tail -f /usr/local/SiebelAnalytics/Log/NQServer.log

… 2005-03-08 17:10:13 [47013] NLS locale english-usa is not supported by the operating system. 2005-03-08 17:10:13 [nQSError: 47013] NLS locale english-usa is not supported by the operating system. …

If you do not have the proper locale installed, the Siebel Analytics server does not start, and the NQSServer.log file contains the following error:

[47013] NLS locale xxx is not supported by the operating system.

48/75 [author] Christophe Menichetti Europe Oracle|Siebel IBM Support Center Montpellier – PSSC where xxx is the locale specified in the NQSConfig.INI file for the SORT_ORDER_LOCALE parameter.

The response to this error is to install the locale indicated in the table for the requested language.

So we added additional language support (according to Siebel Service Request: #: 38-1092579421 ).

It can be done by following:

 UNIX admin instructions:

SMITTY > System Environment > Manager Language environment > Add additional language env. > Cultural convention > Escape 4 > US-english

To test again Siebel Analytics Server, Do not forget TO STOP server:

 $ ./run-sa.sh forcestop

This will kill all your Main win applications. Are you sure? (Y/n) Y

Then you can start again Siebel Analytics (sa) server and read the log:

Updating Configuration Settings

Execute the following command:

Target Database Settings

You must verify the validity of the database setup script, because it is called from Siebel Analytics startup script.

Edit the file “user.sh” in “setup” directory to include the right environment settings for the database client of your choice (here Oracle):

 uncomment lines for oracle configuration

Testing Analytics Client Installation

Run Siebel Analytics Client by opening another session. From the setup directory $INSTALLDIR/setup, run one of the following scripts:

And then to test the client/server connectivity, run:

Enter your Database (Oracle here) source name (alias here: ALBBASIC, the same one present in TNSNAME.ora file) identifying your database and Repository user id and password:

Then you enter user/password id:

You may get the following error:

Solution: You need to provide a correct entry in ODBC.ini file.

Under UNIX, the file odbc.ini contains the standard Siebel Analytics ODBC connection details that are used by the Siebel Analytics Web Server and nqcmd processes.

Siebel Analytics Server uses ODBC layer to call OCI (Oracle communication) layer.

So you must add an ODBC section in odbc.ini file with the same ODBC name as you set up in your ODBC configuration on windows platform when you created your Analytics Repository used on UNIX machine.

Go to INSTALLDIR/SiebelAnalytics/setup directory and edit odbc.ini file

Then you add your ODBC section:

So you will get the following successful screen with client:

Starting Analytics Web Server

About Siebel Analytics Web Server

SAW server functions as the connection between any user of Siebel Analytics and the processes of the Siebel Analytics Server processes.

Siebel Analytics Web consists of the SAW server and the Web (pr HTTP) integration server running as separate processes.

 The Analytics Web Server process (sawserver.exe) hosts most of the business logic of Siebel Analytics Web and performs all the functions

 The Web (HTTP) integration server is a J2EE application server that hosts a Java servlet which creates socket connections to Siebel Analytics Web server and uses TCP/IP to redirect HTTP requests to Siebel Analytics Web Server

Configuring Analytics Web Plan

After installing Siebel Analytics Web, you must execute the following steps:

1. Configure a third-party Web Integration server

2. Create a link to the Siebel Analytics Web server from the third-party Web Server

Creating a news Web Archive (war file)

Go to the Siebel Analytics installation directory

Then execute the following jar command:

DON’T FORGET the period at the end of the command

Deploying the Web Archive file

We are going to deploy the web application contained in the analytics.war file

Open a web browser and got to http://yourmachine:9090/admin

Go to application > install new application

Browse the war file

Click next

Click continue

Click next

Click FINISH

And then save the configuration

Update the web server plug-in

After the successful deployment the web server plug-in has to be updated, to reflect the new access URL to the application.

In the WAS console go to  Environment  Update Web server Plug-in

Click OK to update

Restart Web sphere server

Stop/Start Web Sphere application server

Restart Siebel Analytics server and Web server

If they are running, Stop/Start all Siebel Analytics Servers

Starting Browser Client to test installation

Launch a supported browser client

For instance, execute mozilla browser and go to the following URL:

http://:/

Where:

 is AIX server where you install all Siebel Analytics Servers  is the port where your web server is listening  is the web server directory where you can reach Siebel Analytics

In our case, enter the following URL:

http://localhost:9080/web/app

Possible errors

Oracle driver not found in answers

Error:

After you installed Siebel Analytics, you can get the following errors, launching Siebel Analytics Answers in your client browser:

Solution: The source of the problem is an incorrect oracle path variable in OS environment. The system could not access right libraries. One path is missing.

You have probably setup oracle libraries path in “user.sh” file but not in OS environment.

So put in “.profile” (located in home directory of Siebel user) file the following line:

Chart graphics display in Dashboard doesn’t work

Error:

After you installed Siebel Analytics, you got dashboards page without chart pictures (instead of chart pictures, you got a warning picture)

Just for your information:

Siebel Analytics version 7.5.x uses Corda PopChart Image Server version 3.8.3 to display charts in analytics reports.

The Corda callback method works as follows:

A browser requests a report with a chart of a certain type.

Siebel Analytics Web server generates HTML source to display tabular data and embedded commands in the HTML source to display specific charts and sends the HTML response to the browser.

The browser receives the HTML response and displays the HTML page. The browser also uses the embedded chart commands to issue another call directly to the Corda PopChart server.

On receiving the browser call, the Corda PopChart server calls back the analytics web server using the information in the embedded URL to get the data needed to create the chart.

The image server creates the chart image and sends it back to the web browser for the graph image to be displayed.

The following diagram further demonstrates these steps:

Solution:

The source of the problem is an incorrect javahost startup. Your javahost have not started, that’s why your Corda Server have not could generate Analytics Chart.

If you read javahost log (in SA_INSTALL_DIR/Log), you will probably read the following error:

 Run.sh: Java can be found

The solution to fix this problem is to put in AIX environment a correct JAVA_HOME to allow javahost service to find java command and then to start.

Stop Siebel Analytics Web Server and export JAVA_HOME variable. Then restart SAW server.

Refresh link in Dashboard doesn’t work

Error:

After you installed Siebel Analytics, when you click on refresh link in your Siebel Analytics Intelligence Dashboards, no refresh action happens (no data refresh).

Solution:

The source of the problem is a problem of cache. By default, Siebel Analytics Server uses its query cache when you ask it for refresh. You can set up each tables of the repository about caching, but we will use a more general solution: we are going to disable Siebel Analytics Server (queries server) cache.

To do that, we change cache configuration value in the server configuration file named NQConfig.INI (in directory SA_INSTALL_DIR/Conf)

Appendix

How to customize user interface

You can change Siebel Analytics User Interface Rendering (or Skins). To better understand what we call Skins, let us show you 2 screenshot of the same page: logon page.

In the first picture we are using Siebel default skin and in the second one we are using the skin that we want to install.

User interface rendering is the result of the interaction between style and skin. Style is rendered by a repository named “s_name” and Skin by a repository named “sk_name”

You must copy these repositories into Siebel Analytics Server web directory and 3rd-party Web server deployment directory.

So to change rendering, you should follow these steps:

1. Copy the 2 repositories into SAINSTALLDIR/web/app/Res

2. Copy the 2 repositories into <3rd-party>//Res

3. To finish you must specify your new style and skin in configuration file of Siebel Analytics Web Server (instanceconfig.xml)

Edit this file and insert 2 new entries in the xml file:

(You don’t need to specify the prefix “s_”/”sk” in the value between xml tags)

In our example, our style directory is named “s_OracleTest” and our skin directory is named “sk_OracleTest”.

So we entered only the value “OracleTest”

How to insert auto-refresh functionality in Siebel Dashboard

This is a JavaScript solution to enable dashboards to be automatically refreshed at a given interval, for example to display on wallboards etc.

Siebel Analytics allows text to be added to the report output, and this text can be plain text, HTML or even JavaScript. The text can be added as a separate 'Static Text' view, or even as part of the 'Heading' view. Both of these are accessed from the 'Customize View' mode from the Results tab in Siebel Answers.

In each of these examples, the Siebel Analytics function HereLink() is called to perform the refresh, which is the function called when the user manually requests a refresh using the hyperlink on the page. If you would like to use this for other web pages, you can call window.location.reload() instead of the HereLink call, which is equivalent to reloading the current page (or pressing F5).

To know more about how to implement different solutions which allow you to use this JavaScript functionality, refer you to the following documentation

 Analytics Auto Refresh.doc

Analytics Useful Folders and Files Structure

Server Directory File Description

Siebel  Setup/ Run-sa.sh Start/stop script for Siebel Analytics Run-saw.sh analytics server and web server Server Sa.sh Containing Siebel environment Saw.sh variables to be exported in the current shell User.sh Odbc.ini

 Config/ NQSConifg.INI Configuration file of the Siebel Analytics Server (SAS) (cache,logging,repository …)

 Web/app/Res S_