I nnssttaallllaattiioonn GGuu iiddee —— WWiinddoowwss ... · osql -U -P -d -i For example:...

IInnssttaallllaattiioonn GGuuiiddee —— WWiinnddoowwss aanndd LLiinnuuxx//UUnniixx

RREELLEEAASSEE 88..55

JJUUNNEE 22001133

LEGAL NOTICES

Oracle Instantis EnterpriseTrack Installation Guide — Windows and Linux/Unix

Copyright © 2000, 2013, Oracle and/or its affiliates. All rights reserved.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be

trademarks of their respective owners.

This software and related documentation are provided under a license agreement containing

restrictions on use and disclosure and are protected by intellectual property laws. Except as

expressly permitted in your license agreement or allowed by law, you may not use, copy,

reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish or

display any part, in any form, or by any means. Reverse engineering, disassembly, or

decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be

error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone

licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system,

integrated software, any programs installed on the hardware, and/or documentation, delivered to

U.S. Government end users are “commercial computer software" pursuant to the applicable

Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use,

duplication, disclosure, modification, and adaptation of the programs, including any operating

system, integrated software, any programs installed on the hardware, and/or documentation, shall

be subject to license terms and license restrictions applicable to the programs. No other rights are

granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management

applications. It is not developed or intended for use in any inherently dangerous applications,

including applications that may create a risk of personal injury. If you use this software or

hardware in dangerous applications, then you shall be responsible to take all appropriate failsafe,

backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its

affiliates disclaim any liability for any damages caused by use of this software or hardware in

dangerous applications.

This software or hardware and documentation may provide access to or information on content,

products and services from third parties. Oracle Corporation and its affiliates are not responsible

for and expressly disclaim all warranties of any kind with respect to third-party content, products,

and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or

damages incurred due to your access to or use of third-party content, products, or services.

Customers that licensed EnterpriseTrack Version 8.0.5 and earlier (including Standard and PMO

Editions) and are renewing their existing contracts without modification are only entitled to the

same licenses and modules as agreed in the original contract and associated pricing sheets.

4

TABLE OF CONTENTS

Introduction ...................................................................................................................................... 6

System Requirements .................................................................................................................. 6

Preliminaries ............................................................................................................................... 6

Configuring Oracle Database ........................................................................................................... 7

Installing Oracle Database Client ................................................................................................ 7

Configuring Database Files and Disk Layout ............................................................................. 7

Setting Up Oracle Database ........................................................................................................ 7

Creating Database Users ........................................................................................................ 7

Creating Oracle Text Index .................................................................................................... 8

Configuring SQL Server Database ................................................................................................... 9

Installing SQL Server Client ....................................................................................................... 9

Configuring Database Files and Disk Layout ............................................................................. 9

Setting Up SQL Server Database ................................................................................................ 9

Creating an ETRACK Database User .................................................................................... 9

Installing Full-Text Search Capabilities .............................................................................. 10

Configuring WebLogic on Windows ............................................................................................. 11

Creating a WebLogic Domain .................................................................................................. 11

Starting the WebLogic Admin Server ....................................................................................... 12

Stopping the WebLogic Admin Server ..................................................................................... 12

Customizing the Base HREF URL ................................................................................................. 13

Installing the Oracle HTTP Server (OHS) ..................................................................................... 13

Configuring the Oracle HTTP Server (OHS) ............................................................................ 14

Installing a Secure Socket Layer (SSL) Certificate .................................................................. 15

Configuring the EnterpriseTrack Server ........................................................................................ 15

Configuring EnterpriseTrack Server on Windows .................................................................... 15

Installing JAVA SDK On Windows .................................................................................... 15

Configuring EnterpriseTrack Server on Linux/Unix ................................................................ 16

Software Prerequisites ......................................................................................................... 16

Extracting the SiteWand File ............................................................................................... 16

Configuring the SiteWand Server ........................................................................................ 16

Installing SiteWand ................................................................................................................... 16

Installing SiteWand On Windows ....................................................................................... 16

Installing SiteWand on Linux/Unix ..................................................................................... 17

Enabling Organization-Specific Components in EnterpriseTrack ............................................ 18

Oracle Database Follow-up Setup Steps ................................................................................... 18

Loading Oracle Java Stored Procedures .............................................................................. 18

Registering and Starting the SiteWand Server .......................................................................... 19

Scheduling Automated Tasks .................................................................................................... 19

Installing the Secure Socket Layer (SSL) Certificate ............................................................... 21

Installing SSL on Windows ................................................................................................. 21

5

Installing SSL on Linux/Unix .............................................................................................. 22

Using the EnterpriseTrack Application .......................................................................................... 22

EnterpriseTrack Application Login Page .................................................................................. 22

Accessing the Idea Portal Home Page ...................................................................................... 22

EnterpriseTrack Application Backend (SiteWand) Login ........................................................ 23

Maintenance and Troubleshooting ................................................................................................. 24

Determining Server Status ........................................................................................................ 24

Locating Server Log Files ......................................................................................................... 24

Stopping SiteWand ................................................................................................................... 24

Restarting SiteWand ................................................................................................................. 25

Restart Apache as Root ........................................................................................................ 25

Restart Tomcat as a regular user .......................................................................................... 25

Changing Database Password ................................................................................................... 25

Uninstalling SiteWand .............................................................................................................. 26

Appendix A .................................................................................................................................... 26

Recommendations for Oracle Database Configuration ............................................................. 26

Appendix B .................................................................................................................................... 28

Setting up Linux/Unix Accounts and Directories ..................................................................... 28

Appendix C .................................................................................................................................... 29

Customizing Apache for EnterpriseTrack ................................................................................. 29

Appendix D .................................................................................................................................... 29

Configuring Active Directory ................................................................................................... 29

Setting the Active Directory URL ....................................................................................... 29

Setting the Domain Name .................................................................................................... 30

Enabling Previously Created Users Work with Active Directory ....................................... 31

Appendix E ..................................................................................................................................... 31

Configuring Single Sign-On for Hosted Customers ................................................................. 31

Appendix F ..................................................................................................................................... 32

Frequently Asked Questions (FAQs) ........................................................................................ 32

ENTERPRISETRACK INSTALLATION GUIDE- WINDOWS AND LINUX

6

INTRODUCTION

This document describes how to install EnterpriseTrack software on the following platforms.

Windows operating system with WebLogic, Oracle HTTP Server (OHS), and Oracle or

Microsoft SQL Server database.

Linux/Unix operating system with Oracle database

Install the supporting software individually using the relevant installers of each software product

listed above to set up the environment for EnterpriseTrack.

This installation guide describes how to

Set up and configure the database

Configure the middle-tier server

Configure OHS

Configure EnterpriseTrack Server

Install SiteWand, the EnterpriseTrack server runtime

Install and deploy the EnterpriseTrack application

SYSTEM REQUIREMENTS

Refer to the Tested Configurations documents on the OTN website for the minimum hardware

requirements and supported versions of operating systems and databases.

PRELIMINARIES

The distribution or CD has a top level zip file named using the format “yyyy-mm-dd-sitewand-

<win_or_linux>-<oracle or sqlserver>.zip”. For example, 2009-03-02-sitewand-linux-oracle.zip.

Unzip this file into a directory on the EnterpriseTrack server machine after logging in as a

Windows or Linux user with administrator privileges To set up Linux user accounts setup, refer

to Appendix B. This directory is referred to as IETRACK_ROOT.

Directory names with embedded spaces are not supported.


7

CONFIGURING ORACLE DATABASE

INSTALLING ORACLE DATABASE CLIENT

Refer to the Tested Configurations document on the OTN website to verify the appropriate

version of the Oracle database client is installed. Alternatively, download and install the correct

database client from the Oracle website.

CONFIGURING DATABASE FILES AND DISK LAYOUT

Oracle recommends configuring a single RAID 1+0 (stripe and mirror) disk partition and

distributing all data files on this partition. This distributes the I/O requests across several spindles

and avoids a single disk being a performance bottleneck while allowing for good space

utilization.

SETTING UP ORACLE DATABASE

Refer to Appendix A for recommendations related to Oracle database configuration parameters

and support for international languages.

Create a database user named ETRACK on the oracle database server.

CREATING DATABASE USERS

Create database users in the Oracle database as follows.

1. Login to Oracle as a user with permissions to create users

or

From the database server, execute the following command.

shell-command-prompt> sqlplus /nolog

SQL> connect / as sysdba;

2. After logging in, execute the following command.

SQL> >@/home/oracle/etrack.sql

3. Locate the Oracle database dump in the directory, IETRACK_ROOT /data/mydata.dmp


8

4. Use the Oracle IMP utility to import the oracle database dump using the following syntax:

shell-command-prompt> imp etrack file=mydata.dmp log=mylog.log

(or)

shell-command-prompt> imp sys fromuser=x touser=etrack

file=mydata.dmp

log=mylog.log

CREATING ORACLE TEXT INDEX

To enable document search capabilities in EnterpriseTrack, complete the following steps:

1. Ensure Oracle Text is installed.

2. In the directory, IETRACK_ROOT/utils/, locate the SQL script, Oracle

Textindex_11g.sql for Oracle 11g

3. Edit the script to set the appropriate database user, password, CTXSYS user, CTXSYS

password, and DB connection string.

4. Login to the database as the database user created for EnterpriseTrack and run the TextIndex

SQL script:

By default CTXSYS user is locked after installation.

5. To unlock the account and reset the password for CTXSYS execute the following commands.

shell-command-prompt> sqlplus /nolog

…

SQL> connect sys/<password> as sysdba

Connected.

SQL> alter user CTXSYS account unlock;

SQL> alter user CTXSYS identified by <password_for_CTXSYS>;

After installation is complete, ensure the CTXSYS user to its locked state.


9

CONFIGURING SQL SERVER DATABASE

This section describes how to configure the SQL Server database for EnterpriseTrack.

INSTALLING SQL SERVER CLIENT

The Microsoft JDBC driver for SQL Server will be installed in the domain's lib directory on the

server where EnterpriseTrack will be installed. Alternatively, based on the SQL Server version,

download the correct JDBC driver from the Microsoft website. For more details on installing the

SQL Server client, refer to the section, Configuring WebLogic for Enterprise Track on Windows.

CONFIGURING DATABASE FILES AND DISK LAYOUT

Oracle recommends configuring a single RAID 1+0 (stripe and mirror) disk partition and

distributing all data files on this partition. This distributes the I/O requests across several spindles

and avoids a single disk being a performance bottleneck while allowing for good space

utilization.

SETTING UP SQL SERVER DATABASE

The assistance of a DBA is typically required for this step.

CREATING AN ETRACK DATABASE USER

To create a database user ETRACK in SQL Server, complete the following steps:

1. Create a database named ETRACK with collation name Latin1_General_BIN on the SQL

Server database.

2. Restore the database (Force Restore the DB) using the SQL Server Enterprise Manager and

the database dump included in IETRACK_ROOT\data\db_export.dmp.

3. The DB restore creates a DB user/password, viz., etrack/etrack.

4. From the command prompt, connect to the database as an administrator using osql

(osql –U <admin> -P -<adminPasswd> -d <database>)

5. Run the following query.

sp_addlogin 'etrack'

go

sp_change_users_login 'Update_One', 'etrack','etrack'

go


10

sp_change_users_login 'auto_fix’, 'etrack'

go

6. In SQL Server Enterprise Manager, for the current group, select Security, Logins

a. Select the user 'etrack' (in this case),

b. Right click and select properties,

c. Change the password, confirm the password, and save.

INSTALLING FULL-TEXT SEARCH CAPABILITIES

Full-text search is an optional component of the SQL Server database engine for SQL Server

2008 R2. To enable full-text searching capabilities in EnterpriseTrack, perform the following

procedures.

Creating a full- text catalog

Indexing PDF profiles

CREATING A FULL-TEXT CATALOG

Create a full-text catalog named enterprisetrack as follows.

1. On the C drive of the database server, create a folder, textsearch.

2. Copy IETRACK_ROOT \utils\index.txt into C:\textsearch

3. Run the following script:

osql -U <dbuser> -P <dbpassword> -d <databasename> -i

<script>

For example:

osql -U etrack -P etrack -d etrack -i index.txt

The script can also be run from Microsoft SQL Server Management

Studio interface.

A full-text catalog, enterprisetrack, is created.

INDEXING PDF FILES

To enable indexing pdf files download and install the Adobe PDF iFilter DLL from Adobe which

implements the iFilter interface defined by Microsoft as follows.

1. Download the DLL (ifilter50.exe) from the following URL.

http://www.adobe.com/support/downloads/detail.jsp?ftpID=1276

http://www.adobe.com/support/downloads/detail.jsp?ftpID=1276


11

2. Copy the DLL file and install it on the server where MS SQL Server database is installed.

The Adobe PDF IFilter 5.0 is not thread- safe but the callers of it can run multiple threads. To

ensure that only one thread executes the IFilter 5.0 at a time, use Microsoft SQL Server Service

Pack 3 or modify the Windows Registry to do the work around described in Microsoft

Knowledge Base Article 323040 - FIX: SQL Server Full-Text Population by Using a Single-

Threaded Filter DLL or a PDF Filter DLL May Not Succeed.

CONFIGURING WEBLOGIC ON WINDOWS

Configure WebLogic only for an EnterpriseTrack installation on Windows. This section describes

how to perform the following tasks in WebLogic for EnterpriseTrack:

Creating a WebLogic Domain for EnterpriseTrack on Windows

Starting the WebLogic Admin Server

Stopping the WebLogic Admin Server

CREATING A WEBLOGIC DOMAIN

To create a WebLogic Domain for EnterpriseTrack:

1. Run the WebLogic Configuration Wizard.

2. In the Welcome window, select Create a new WebLogic domain, and click Next.

3. In the Select Domain Source window, accept all default selections and click Next.

4. In the Specify Domain Name and Location window,

a. Enter the domain name, and domain location.

b. Click Next.

5. In the Configure Administrator User Name and Password window,

a. Enter the user name and password information.

b. Click Next.

6. In the Configure Server Start Mode and JDK window:

a. Select Production Mode in the left pane.

b. Select an appropriate JDK in the right pane.

c. Click Next.


12

7. In the Select Optional Configuration window,

a. Select the Administration Server option.

b. Click Next.

8. In the Configuration Summary window, click Create.

9. Click Done if available, or continue to the next step.

10. Navigate to the domain's WebLogic directory and copy the JDBC driver in the lib folder.

11. In the Creating Domain window:

a) Select Start Admin Server.

b) Click Done.

12. When prompted, enter the administrator user name and password created in the above steps.

STARTING THE WEBLOGIC ADMIN SERVER

To deploy the Enterprise Track application in WebLogic, start the admin server as follows.

Oracle recommends to set the Java heap space for the Weblogic server to "-Xms256m -

Xmx1400m".

1. From the Start menu, navigate to the Oracle WebLogic submenu.

2. Choose the menu options, User Projects, Domain, then Start Server.

3. In the WebLogic console window, enter the Weblogic server administrative user name and

password you specified when creating the domain.

If the WebLogic precompile option has been enabled, the WebLogic console displays the

message,"Server started in RUNNING mode" when precompiling finishes. For detailed

information on enabling precompilation, see WebLogic Server documentation.

STOPPING THE WEBLOGIC ADMIN SERVER

To stop the WebLogic admin server on Windows complete the following steps.


2. Select User Projects, Domain, then Stop Server.

3. If prompted for a user name and password in the WebLogic console window, enter the

WebLogic server administrative user name and password you specified when creating the

domain.


13

The WebLogic console closes automatically when shutdown.

CUSTOMIZING THE BASE HREF URL

All icons and logos used by EnterpriseTrack are located using a base URL. By default this base

URL is set to point to a server at Oracle. You can configure the base URL from EnterpriseTrack's

Admin user interface. To customize the icons or logos, install them on a web server in your

organization and change the base URL to point to your web server as follows.

1. Access the EnterpriseTrack Login page.

2. Enter your system administrator credentials to authenticate and login.

3. In the upper left corner, select the menu options, Go To, Administration.

The Administration page displays.

4. On the Administration page, click the Base URL link. The current URL displays.

Save the current base URL as a backup.

5. Enter the new value for the Base URL and click the .Validate button. Upon successful

validation, a green check mark displays.

6. Click Update to complete the change.

INSTALLING THE ORACLE HTTP SERVER (OHS)

Install the Oracle HTTP server (OHS) to support compression with EnterpriseTrack on Windows

installations. For supported version levels, see the Tested Configurations document. For

installation instructions, refer to the Administrator's Guide for Oracle HTTP Server document at

http://docs.oracle.com/cd/E23943_01/web.1111/e10144/toc.htm

http://docs.oracle.com/cd/E23943_01/web.1111/e10144/toc.htm


14

CONFIGURING THE ORACLE HTTP SERVER (OHS)

After installing the Oracle HTTP Server (OHS), configure the web server as follows.

1. Modify the $ORACLE_INSTANCE/config/OHS/ohs1/httpd.conf file:

a. Change the default listen port from 7777 to 80.

Before changing the port #, shut down any other applications using port 80 (such as IIS on

Windows).

b. Load the deflate module and configure the compression as follows:

LoadModule deflate_module

"${ORACLE_HOME}/ohs/modules/mod_deflate.so"

<IfModule mod_deflate.c>

# Compression for saving on transmission-time/bandwidth

SetOutputFilter DEFLATE

SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary

SetEnvIfNoCase Request_URI \.(?:exe|t?gz|zip|bz2|sit|rar)$ no-gzip

dont-vary

SetEnvIfNoCase Request_URI \.pdf$ no-gzip dont-vary

SetEnvIfNoCase Request_URI \.avi$ no-gzip dont-vary

SetEnvIfNoCase Request_URI \.mov$ no-gzip dont-vary

SetEnvIfNoCase Request_URI \.mp3$ no-gzip dont-vary

SetEnvIfNoCase Request_URI \.mp4$ no-gzip dont-vary

SetEnvIfNoCase Request_URI \.rm$ no-gzip dont-vary

DeflateFilterNote Ratio ratio

AddOutputFilterByType DEFLATE text/plain text/html

application/postscript

# Some more knobs with their default values (all happen to be max

allowed)

c. DeflateBufferSize 20000

d. </IfModule>

e. # Inode numbers should never be included in ETag for servers in

a cluster

f. FileETag MTime Size


15

2. Add the following to the $ORACLE_INSTANCE/config/OHS/ohs1/mod_wl_ohs.conf

file.

<Location /SiteWand>

SetHandler weblogic-handler

WebLogicHost localhost

WebLogicPort 7001

</Location>

3. Use opmn to restart the OHS server.

INSTALLING A SECURE SOCKET LAYER (SSL) CERTIFICATE

EnterpriseTrack works in secure and non-secure modes. Installing a Secure Socket Layer (SSL)

with a valid certificate is strongly recommended. In its absence, communication between the

server and browser can be compromised.

CONFIGURING THE ENTERPRISETRACK SERVER

The EnterpriseTrack Server runtime is called SiteWand. To configure the EnterpriseTrack server,

you must login to the server as a user with Windows or Linux/Unix administrative privileges.

CONFIGURING ENTERPRISETRACK SERVER ON WINDOWS

The configuration properties for SiteWand server on Windows are set by modifying the

site.properties file. The site.properties file is located in the IETRACK_ROOT

directory. The site.properties file also contains examples to modify the configuration

properties. Use the appropriate example in the properties file to modify the configuration property

specific to this server installation.

INSTALLING JAVA SDK ON WINDOWS

Get Java SDK Windows RPM from Oracle and install it. Refer to the Tested Configurations

document on the OTN website for the current recommended Java version.


16

CONFIGURING ENTERPRISETRACK SERVER ON LINUX/UNIX

SOFTWARE PREREQUISITES

Download and install Perl.

Download and install Java SDK Linux RPM from Oracle.

Refer to the Tested Configurations document for the recommended Java version.

EXTRACTING THE SITEWAND FILE

Change directory to IETRACK_ROOT and untar the IETRACK_ROOT/ sitewand.tar.gz file.

The directory that gets created is referred to as ROOT_DIR in this document. Name this directory

as“sitewand”.

For example, if the sitewand.tar.gz is untar-ed to /home/webserv1/work, then the ROOT_DIR

is /home/webserv1/work/sitewand.

Refer to Appendix B, Setting up Linux/Unix Accounts and Directories.

CONFIGURING THE SITEWAND SERVER

Set the configuration properties for SiteWand server by modifying the linux.properties file

located in the directory, ROOT_DIR/deploy/middleTier/siteProperties/.This file is also

referred to as the site.properties file since it specifies properties specific to the server

installation. The site.properties file also contains examples to modify the configuration properties.

Use the appropriate example to modify the configuration property specific to this server

installation.

To run the server as a non-root user, in the linux.properties file, set the

BASE_APACHE_SERVER_PORT’, and the ‘URL_PORT’ property values to a port number

greater than 1024. Lower-valued port numbers are usually reserved for system services.

INSTALLING SITEWAND

The following sections describe how to install SiteWand on Windows and Linux/Unix operating

systems.

INSTALLING SITEWAND ON WINDOWS

To install SiteWand on a Windows operating system, complete the following steps.

1. Change directory to IETRACK_ROOT\

2. Run the following command.

configMiddleTier application


17

3. Enter database user and password when prompted.

4. Start the WebLogic Admin Server Console for the Domain.

5. Select Lock and Edit to change the Domain.

6. Under Deployments select Install.

7. Select SiteWand.war in the directory IETRACK_ROOT\sitewand\deploy\middleTier

8. Select Next

9. Select Install this deployment as an application

10. Select Next

11. In the Name field, select a name for the deployment.

12. In the Security field, select DD Only: Use only roles and policies that are defined in the

deployment descriptors.

13. In the Source accessibility field select Use the defaults defined by the deployment's targets.

14. Select Finish.

15. Select Activate Changes.

16. In Deployments, select the deployment and Start all requests.

The Admin Console will shut down and not be accessible until launched again.

INSTALLING SITEWAND ON LINUX/UNIX

Complete the following steps to install SiteWand on a Linux/Unix operating system.

1. Change directory to ROOT_DIR/deploy/middleTier

2. Run the following command:

perl -w configMiddleTier.pl all all

3. Specify linux.properties as the properties file and enter the appropriate database user and

password when prompted.

4. To make EnterpriseTrack server auto-start on a machine reboot.

a. Login as "Root".

b. Edit ROOT_DIR/deploy/middleTier/S99instantisSiteWand-example to suit

your environment and then copy it to /etc/init.d as

/etc/init.d/instantisSiteWand.


18

c. Link the following rc-files to /etc/init.d/instantisSiteWand script.

/etc/rc{3,5}.d/S99instantisSiteWand and

/etc/rc{0,1}.d/K99instantisSiteWand

For example,

lrwxrwxrwx 1 root root….. /etc/rc0.d/K99instantisSiteWand

-> ../init.d/instantisSiteWand

lrwxrwxrwx 1 root root….. /etc/rc3.d/S99instantisSiteWand

-> ../init.d/instantisSiteWand

ENABLING ORGANIZATION-SPECIFIC COMPONENTS IN ENTERPRISETRACK

Some of the web page contents, such as images, logos, and style sheets are specific to your

organization. These are provided in the CD or distribution in a directory in the format “<customer

name>bhref”. There are sub-directories such as ‘pix’, ‘css’, and ‘js’ for each component.

To enable these contents to be served by the EnterpriseTrack server, copy the “<customer

name>bhref” directory to the following folders.

On Windows, copy to IETRACK_ROOT\sitewand\install\apache-

X\htdocs\SiteWand\public

On Linux/Unix, copy to INSTALL_DIR/apache-X/htdocs/SiteWand/public

For more details on INSTALL_DIR, refer to the linux.properties file.

ORACLE DATABASE FOLLOW-UP SETUP STEPS

After configuring the SiteWand server, complete the following configuration steps in the Oracle

database.

LOADING ORACLE JAVA STORED PROCEDURES

EnterpriseTrack requires some Java stored procedures to be uploaded to the Oracle database. As a

temporary preparatory step, change the database init.ora setting “java_pool_size” to 300M. This

can be reset to normal value after this command is run. For more details on init.ora settings

refer to Appendix A.

Enter the database user ID and password, and run the following command to load the Java stored

procedures into the Oracle database. If you restore the database from the database dump file

IETRACK_ROOT/data/mydata.dmp (recommended), then the following steps are not required.

On Windows,

1. Install Oracle Client on Windows server.

2. Change directory to IETRACK_ROOT.


19

3. Update the ORACLE_HOME property in the site.properties file based on the setting during

Oracle Client installation in step 1.

4. Run the command, configMiddleTier oracleJsp all

On Linux/Unix,

1. Change directory to ROOT_DIR/sitewand/deploy/middleTier

2. Run the command, perl configMiddleTier.pl oracleJsp all

REGISTERING AND STARTING THE SITEWAND SERVER

Before starting the SiteWand server, ensure the database server is started and running. To start the

SiteWand Server, complete the following steps:

On Windows, start the SiteWand server as follows.


2. Choose the menu options, User Projects, Domain, Start Server.

3. If prompted for a user name and password in the WebLogic console window, type in the

administrative user name and password you specified when creating the domain.

On Linux/Unix, start the SiteWand server as follows.

1. Execute the following command to start the SiteWand server from the directory

ROOT_DIR/deploy/middleTier

(Start Apache as ‘root’)

perl launchMiddleTier.pl start apache all

(Start Tomcat as a regular user)

perl launchMiddleTier.pl start tomcat all

2. Wait a few minutes for the server startup to complete.

SCHEDULING AUTOMATED TASKS

The EnterpriseTrack application requires an automated scheduled task, DailyJob.bat

(dailyjob.pl), to be run daily. This job updates the project status based on the associated

project dates and their relation to current date, and sends appropriate notification emails. The

daily job is password protected. Set the password to run for the daily job using EnterpriseTrack's

Adminstration interface as follows.

1. Access the EnterpriseTrack's Login page.

2. In the Login ID field, enter sysadmin.

3. In the Password field, enter the corresponding password,


20

4. Click the Login button.

If you are logging in for the first time as a system administrator, enter the password,

change_on_install. The Change Password page displays. Enter a new password for the system

administrator.

The Projects page displays.

5. In the upper-left-corner, click the menu options, Go To, Administration.

The Adminstration page displays.

6. Click Nightly Job Password link.

The value for Nightly Job Password displays change_on_install.

7. Change the Nightly Job Password value and click the Update button.

Remember this password, since you will need it to configure the script that runs the scheduled

task as described in the appropriate following section.

SCHEDULING THE DAILYJOB.BAT RUN ON WINDOWS

Schedule the DailyJob.bat run on Windows as follows.

1. A template for this job is available in IETRACK_ROOT/utils/DailyJob.bat.

2. Edit this file to specify values for the following parameters to run the DailyJob.exe

program:

IETRACK_ROOT - Enter the full path name to the script file.

nightly_job_error_email - Enter an email address at which you would like to receive

email reporting errors that occur when the Nightly Job is run.

hostname[:port] - Enter the host name and port number at which the SiteWand server

listens. Contact the application server administrator for further assistance.

accountname - Set the value to etrack. In general this would be the name of the SiteWand

account in which EnterpriseTrack is installed.

nightly_job_password - Enter the nightly job password that was configured above.

3. Access the Windows Task Scheduler from the Windows Control panel.

4. Configure the Windows Task Scheduler to schedule the DailyJob.bat file for execution

once every 24 hours (preferably in the night).

SCHEDULING THE DAILYJOB.PL RUN ON LINUX / UNIX

Schedule the DailyJob.pl run on Linux/Unix as follows.


21

1. A script to run this job is located in IETRACK_ROOT/utils/DailyJob.pl.

2. To run the DailyJob.pl every 24 hours (preferably in the night) setup a Cronjob as

follows.

For example, to run a cronjob everyday at 3:00 A.M, set up a cronjob using the following

syntax:

00 3 * * * /usr/bin/perl /space/users/DailyJob.pl

nightly_job_error_email http[s]://host[:port] accountname

nightly_job_password >>enterprisetrackDailyJob.log 2>&1

The Cronjob requires values for ‘CronJobUserPasswd’, and accountname. If the

database dump is used, then the accountname is etrack. The CronJobUserPwd is set to

change_on_install by default. If you attempt to run cronjob without changing the

password, the following error message displays, "Please use Etrack's Administration interface

to set the Nightly Job Password." To set a new password for CronJobUserPasswd, complete

the following steps.

a. Log in to the EnterpriseTrack application as the user, "sysadmin".

b. In the Administration page, click on the Nightly Job Password link. Enter the default

password is "change_on_install".

c. Enter a new password, and save.

3. In the cron entry file, specify values for the cronjob parameters (shown in the syntax of

step 2) and save.

full-path - Enter the full path name to the script file DailyJob.pl.

nightly_job_error_email - Enter an email address at which you would like to receive

email reporting errors that occur when the nightly Job is run.

https://hostname[:port] - Enter the host name and port number at which the

SiteWand server listens. Contact the application server administrator for further assistance.

accountname - Set this to etrack. Usually, it is the name of the SiteWand account in

which EnterpriseTrack is installed.

nightly_job_password - Enter the nightly job password that was configured above.

This completes the cronjob setup.

INSTALLING THE SECURE SOCKET LAYER (SSL) CERTIFICATE

INSTALLING SSL ON WINDOWS

To install SSL on Windows, refer to WebLogic documentation.

http://review.us.oracle.com/review/:/host%5b:port%5d


22

INSTALLING SSL ON LINUX/UNIX

Complete the following task only if you are processing SSL using the EnterpriseTrack server.

If the ENABLE_APACHE_SSL property in the linux.properties file is set to True, then the

server is configured to process SSL using the EnterpriseTrack server. The installation comes with

a "default certificate" for ssl access. You must obtain a company specific certificate and key and

install it in the directory, IETRACK_ROOT/sitewand/install/apache-0/conf/ssl/

Rename the certificate and key as server.crt and server.key, respectively.

Install the Apache openssl shared libraries (libssl.so.*), if you intend to let the EnterpriseTrack

server process SSL. More information on download and installation can be obtained at the

following URL: http://www.openssl.org/source/

This completes the installation of the EnterpriseTrack application. Access the application using

the URLs listed below.

USING THE ENTERPRISETRACK APPLICATION

The URLs for the EnterpriseTrack application are listed below.

ENTERPRISETRACK APPLICATION LOGIN PAGE

http://<hostname>[:<port>]/SiteWand/ServeForm/etrack/login

This URL displays the EnterpriseTrack Portal Login page. Complete the following steps to log in

to EnterpriseTrack

1. In the Login ID field, enter "sysadmin".

2. In the Password field, enter the corresponding password for the administrator. The default

password is "change_on_install".

3. Click the Login button.

The EnterpriseTrack home page displays.

4. Go to the Administration Page and change the password for this login.

For further details, refer to the User Guide or the Administration Guide.

ACCESSING THE IDEA PORTAL HOME PAGE

http://<hostname>[:<port>]/SiteWand/ServeForm/etrack/portal/portalentry

This URL displays the EnterpriseTrack Portal Login page. Complete the following steps to set up

and provide access to users of Idea Portal.

1. Access the EnterpriseTrack Login page.

http://www.openssl.org/source/


23

2. Enter the system administrator credentials as follows.

a. In the Login ID field, enter sysadmin.

b. In the Password field, enter the corresponding password, and click the Login button.

c. In the upper-left corner, click the menu options, Go To, Administration.

The Adminstration page displays.

3. On the Administration page click the Portal Login Name link.

The login name displays the default value, change_on_install.

4. Enter a new login ID for the user and click the Update button.

5. Click the Portal Login Password link.

The password displays the default value, change_on_install.

6. Enter a new login password for the user and click the Update button.

A user can now login to the portal using the new login name and the password created above.

ENTERPRISETRACK APPLICATION BACKEND (SITEWAND) LOGIN

Access the backend URL to login for maintenance work such as, applying patches and upgrades.

Each patch will contain detailed installation instructions. During initial installation, you must

login to set a new password for the backend application as follows.

1. Access the backend URL, http://<hostname>[:<port>]/SiteWand/Login

The Login page displays.

2. In the Login Name field, enter etrack.on_premise.

The part of the login name before the .on_premise suffix is the name of the SiteWand account in

which the EnterprisetTrack application is installed. For example, if EnterpriseTrack is installed in

a SiteWand account called etrack2, then the corresponding backend login name is

etrack2.on_premise.

3. In the Password field, enter change_on_install, and click Login.

The Control Panel page displays.

4. In the upper-left-corner, click the Account button.

The Account Settings page displays.

5. Click the View/Edit button adjacent to the Login Password field.

6. In the Current Password field, enter change_on_install.

7. In the New Password field, enter a new password value and re-enter it again to confirm it.


24

8. Enter a password hint to help remember the password.

9. Enter the e-mail address to which the password hint will be e-mailed.

10. Click OK to confirm the changes made.

11. Log out of the backend application.

MAINTENANCE AND TROUBLESHOOTING

DETERMINING SERVER STATUS

Determine the server status by accessing the following URL.

http://<hostname>[:<port>]/SiteWand/Status

For unexpected application errors, access the following URL (from the user session getting the

error), click the Refresh button in the browser and send the resulting page to Oracle Support.

http://<hostname>[:<port>]/SiteWand/ViewDebugLog/z

LOCATING SERVER LOG FILES

The EnterpriseTrack server logs are located in the IETRACK_ROOT directory.

On Windows installations, log files are located in the WebLogic domain directory, Logs.

On Linux/Unix installations, log files are located as follows.

Apache logs are located in the directory INSTALL_DIR/apache-X/logs

Tomcat logs are located in the directory INSTALL_DIR/\tomcat-X\logs

The X in apache-X and tomcat-X is a small number – usually 0 or possibly a higher valued

number if a more advanced configuration was performed.

For more details, refer to Appendix C, Customizing Apache for EnterpriseTrack.

STOPPING SITEWAND

Oracle recommends stopping SiteWand before a shutting down the database.

To stop the EnterpriseTrack server complete the following steps.

On Windows installations, stop WebLogic as follows.


2. Choose the menu options, User Projects, domain, then Stop Server.


25

If prompted in the WebLogic console window, enter the WebLogic administrator user name

and password.

On Linux/Unix installations, stop SiteWand as follows.

1. Change directory to INSTALL_DIR/sitewand/deploy/middleTier

2. Execute the following command.

perl launchMiddleTier.pl stop all all

RESTARTING SITEWAND

Before restarting SiteWand, ensure the database server is running.

On Windows installations, to restart SiteWand, refer to WebLogic documentation to restart the

server.

On Linux/Unix installations, restart the SiteWand server as follows.

1. Change directory to INSTALL_DIR/sitewand/deploy/middleTier

2. Execute the following command.

perl launchMiddleTier.pl restart all all

RESTART APACHE AS ROOT

Execute the following command.

perl launchMiddleTier.pl restart apache all

RESTART TOMCAT AS A REGULAR USER

Execute the following command.

perl launchMiddleTier.pl restart tomcat all

CHANGING DATABASE PASSWORD

Changes to etrack user database password must be updated in the SiteWand application. To

change the password for the database account used by the EnterpriseTrack server:

1. Stop the EnterpriseTrack server.

2. Change the password on the database side as follows.

On Windows installations,

a. Change directory to IETRACK_ROOT

b. Execute the following command,

configMiddleTier.exe application


26

The SiteWand.war file will be updated with the new password and must be redeployed.

On Linux/Unix installations,

a. Change directory to IETRACK_ROOT/sitewand/deploy/middleTier

b. Execute the following command,

perl configMiddleTier.pl changePassword all

3. Start the EnterpriseTrack server.

UNINSTALLING SITEWAND

To uninstall SiteWand, on Windows installations,

1. Follow WebLogic documentation to undeploy the SiteWand.war application and delete the

domain directory.

2. Restart WebLogic.

To uninstall SiteWand on Linux/Unix installations,

1. Stop the server.

2. Delete the IETRACK_ROOT, INSTALL_DIR and remove the rc-files.

For more information on rc files, refer to the section, Installing SiteWand on Linux/Unix.

APPENDIX A

RECOMMENDATIONS FOR ORACLE DATABASE CONFIGURATION

A lot can vary between different installations depending on the EnterpriseTrack configuration

parameters, the number of projects, the financial categories, the number of months over which

financial numbers are tracked, etc. Also, a lot depends on how the system will be used, in

particular, the ratio of OLTP-like requests such as routine transactional workflow-based page

navigation) to OLAP-like requests (primarily reports). The latter can tax the database with

complex multi-way joins, etc., while the former is typically easier on the database.

Notwithstanding these variations, the following recommendations can give some traction and is

based on observation of a broad data set. Review these changes with a database administrator

before adapting and implementing it to your environment.

For Unicode national language support, consider choosing the following CHARACTER SET

while creating the database. This should match the initial database initialization dump provided

by Oracle.

CHARACTER SET (NLS_CHARACTERSET):AL32UTF8


27

Consider the following recommended or higher values for init.ora parameters:

CACHE AND I/O

db_block_size = 8192

sga_target = 4G

db_file_multiblock_read_count=16

CURSORS AND LIBRARY CACHE

open_cursors = 30000

If specifying the sga_target, then the Pools definitions are not required.

POOLS

java_pool_size = 15M

large_pool_size = 200M

PROCESSES AND SESSIONS

processes = 1000

SORT, HASH JOINS, BITMAP INDEXES

pga_aggregate_target = 2G

workarea_size_policy = 'AUTO'

SAMPLE 11G INIT.ORA

db_name='INDB'memory_target=processes = 150

audit_file_dest='<ORACLE_BASE>/admin/orcl/adump'

audit_trail ='db'

db_block_size=8192

db_domain=''

db_recovery_file_dest='<ORACLE_BASE>/flash_recovery_area'

db_recovery_file_dest_size=2G

diagnostic_dest='<ORACLE_BASE>'

dispatchers='(PROTOCOL=TCP) (SERVICE=ORCLXDB)'

open_cursors=300

remote_login_passwordfile='EXCLUSIVE'

undo_tablespace='UNDOTBS1'


28

# You may want to ensure that control files are created on separate

physical devices

control_files = (ora_control1, ora_control2)

APPENDIX B

SETTING UP LINUX/UNIX ACCOUNTS AND DIRECTORIES

Given below are some sample LINUX commands that are used to setup the user, groups and

directories associated with the SiteWand server.

Assuming the WEBSERV_USER and WEBSERV_GROUP entries in the site-properties file are

specified as webserv1 and webserv1:

groupadd -g 555 webserv1

useradd -u 555 -g webserv1 -s /bin/tcsh webserv1

Assuming the WEBSERV_LOG_GROUP entry in the site.properties file is specified as webacl:

groupadd webacl

vi /etc/group and add user webserv1 to webacl group.

Assuming the INSTALL_DIR entry in the site.properties file is specified as /space/middle-

tier1:

cd /space

mkdir middle-tier1

chown webserv1:webserv1 middle-tier1

chmod o-rwx middle-tier1

Assuming the OLD_LOGS_DIR entry in the site.properties file is specified as /space/middle-

tier1:

cd /space

mkdir old-logs

chown webserv1:webacl old-logs

chmod o-rx old-logs

chmod g+rwx old-logs

To enable EnterpriseTrack server process SSL, install the Apache openssl shared libraries

(libssl.so.*). To download and install the libraries, refer to: http://www.openssl.org/source/

http://www.openssl.org/source/


29

APPENDIX C

CUSTOMIZING APACHE FOR ENTERPRISETRACK

To customize Apache installed as a part of the EnterpriseTrack installation, configure the

following parameters in the site.properties file.

CUSTOM_APACHE_CONFIG_PRE_LOADMODULES

Enter a filename as the value of this parameter. This file must contain “httpd.conf” compatible

commands and will be included just before the first of the “LoadModule” commands is

executed. For example, use this feature to load custom Apache modules, such as SSO.

CUSTOM_APACHE_CONFIG_POST_LOADMODULES

Enter a filename as the value of this parameter. This file must contain “httpd.conf” compatible

commands and will be included just after the last of the “LoadModule” commands is executed

and the following “httpd.conf” directives have been executed: “USER”, “GROUP”,

“ServerAdmin”, “ServerName” and “UseCanonicalName Off”.

For example, use this feature to configure the custom Apache module discussed above.

CUSTOM_APACHECTL_CMDS

Enter a Bourne shell filename as the value of this property. The file will be included

(“sourced”) in the “apachectl” file used to start/stop the Apache “httpd” process. For example,

use this to set environment variables specific to the custom modules discussed above.

APPENDIX D

CONFIGURING ACTIVE DIRECTORY

This document describes how to configure Active Directory support in EnterpriseTrack to

authenticate EnterpriseTrack users. You will have to know the Active Directory server (provider)

URL and a domain name that will be used to authenticate all your users

SETTING THE ACTIVE DIRECTORY URL

To set up the active directory server URL, complete the following procedure. You will need to set

the value of the Active Directory server URL into /confdata/lookupmaster.

1. Navigate to /confdata/lookupmaster and click on Queries for this engine.

2. Click the Predefined Queries tab.

3. For the query ALL, click Add.


30

4. Set Query Name to be _all and click OK.

5. Click on the My Queries tab.

6. On the _all query, click Modify Data.

7. Click on the button to go to the next page of data.

8. Press Ctrl-F to bring up the browser search window.

9. Enter LDAPProviderURL in the Find window.

10. Click the Edit button associated with that row of data.

11. Set valuedesc to be the value of the URL of your Active Directory Server.

12. A typical Active Directory server URL will look like this:

ldap://dhcp1:389/dc = example.com

13. Click the OK button.

14. Click the yellow Back button (not the browser back button).

15. Click the yellow Back button (not the browser back button).

16. Click the Config button associated with lookupmaster.

17. Click the Activate button.

The active directory URL is set. If you need to change it, please repeat the above steps again.

SETTING THE DOMAIN NAME

To set the domain name string, edit the getSecurityPrincipalString function in

/confdata/funcsrvr as follows.

1. Navigate to /confdata/funcsrvr and click on Config for this engine.

2. Click on Edit next to Functions

3. Scroll down to getSecurityPrincipalString and click Edit.

4. Edit the return string as appropriate for you environment.

Replace instantis (the default) with the appropriate domain name.

If this is a Microsoft environment, the return string should look something like this: return

= append(login_id, "@your_company.com");



7. Click the Activate button.


31

This is the basic setup that will enable your ETRACK installation to use an Active Directory

based server to authenticate users.

A single installation of ETRACK only supports users belonging to one domain.

ENABLING PREVIOUSLY CREATED USERS WORK WITH ACTIVE DIRECTORY

To add previously created users to use Active Directory authentication method, complete the

following procedure.

1. Navigate to /userdata/useradmin/usermaster

2. Click the Queries link associated with this engine.

3. Click Modify Data for the “all” query or, click Modify Data for the getUserByLoginId

query and enter the desired user’s login ID.

4. Click the Edit button for the record to be modified.

5. Set UserAuthenticationMethod to LDAP for the users that are to be authenticated using the

Active Directory server.


7. Click the back link on the page (not the browser back button)

8. Click the back link on the page

Tip: To ensure that authentication is accessing the Active Directory server, setup the Active

Directory password different than ETRACK.

APPENDIX E

CONFIGURING SINGLE SIGN-ON FOR HOSTED CUSTOMERS

EnterpriseTrack uses SAML 2.0 standard for Single Sign-On authentication. To configure

EnterpriseTrack for Single Sign-On, your organization must provide the following entities.

identity provider metadata

The identity provider metadata is provided by the client.

The identity provider entity ID

The identity provider entity ID is defined by the identity provider metadata. The entity ID

must match the ID set in the application login engine to redirect the user when there is no

valid SSO session.


32

The attribute containing the end-user login identifier.

Note: The attribute contains a name and a type; and must match exactly. You can send the

attribute as a normal attribute or as a SubjectName. The end-user login identifier value is used

by the REMOTE_USER variable to access the EnterpriseTrack application.

After configuring EnterpriseTrack for SSO for your organization, Oracle will provide the

hostname of the EnterpriseTrack application to your organization.

Log in to EnterpriseTrack using SSO.

APPENDIX F

FREQUENTLY ASKED QUESTIONS (FAQS)

Q. What are the disk space requirements for a middle-tier machine?

Refer to the Tested Configurations document more information.

Q. How do I get the application images to display?

1. Right-click on the image that is not shown and select properties.

2. Ensure that the URL for the image is pointing to the correct server. For more details, refer

to the section in this guide, Enabling Organization-Specific Components in

EnterpriseTrack, detailing the installation of images, and the EnterpriseTrack

Administration Guide to configure the associated URL.

Q. Where are the Apache/Tomcat logs located? What is the log rotation policy?

On Linux/Unix, Apache logs are located in the directory, INSTALL_DIR/apache-X/logs.

Apache logs are rotated using the program “rotatelogs”.

On Linux/Unix, Tomcat logs are located in the directory, INSTALL_DIR/tomcat-X/logs.

These are typically named instantisTrace-*. These log files are periodically rotated,

compressed (gzip) and moved to the ‘old-logs’ directory in INSTALL_DIR on Linux/Unix.

The rotation action simply causes the current log to be switched by renaming it by suffixing a

timestamp or a phrase such as “-full” while continuing to write to a newly created log file. The

archival or removal of these older rotated log files are up to the administrator and need to be

done per the customer’s policies; we recommend keeping each log file for at least a month or

more to help with troubleshooting.


33

Q. How do I backup the EnterpriseTrack application?

The best practice is to do database level backups. A DBA’s help is required here. Perform an

application-level backup as follows.

1. Login to the EnterpriseTrack backend.

2. Change URL to http://hostname:[port]/SiteWand/XMLExport

3. Select Option 3 Export with data and files (But exclude files from groups)

4. Specify values for the local file directory and password. The local file directory name and

password will be required during the recovery process. This will store all the data on the

middle-tier server. Ensure sufficient disk space on the middle-tier server.

5. Click OK to start the Export.

6. Download SiteWandExport.zip and name it appropriately as per your backup naming

convention and store it on a secure machine.

Q. How do I set up a test/training server?

A test/training server can be setup following the Installation steps in this document. To tag all

pages in the application with a “Test/Training” label, contact Oracle.

Q. Apache starts up fine, but Tomcat does not. Why?

This could be due to various reasons. Explore the following:

Is there sufficient disk space on the middle-tier machine?

Can the database connection from middle-tier be established?

Any other details can be found in the tomcat logs?

On Linux installations, in the directory, INSTALL_DIR/tomcat-X/logs, look for the log

file in the format, instantisTrace-yyyy-mm-dd-*.

Q. The application has stopped sending emails. What are the possible causes?

Check for the following:

The mail server is up and accessible from the machine where EnterpriseTrack is installed.

The middle-tier server firewall settings, if any.

Any mail server changes SiteWand must be updated with the new mail servers IP address

details. Contact Oracle to make this change.

I nnssttaallllaattiioonn GGuu iiddee —— WWiinddoowwss ... · osql -U -P -d -i For example:...

Documents

Transcript of I nnssttaallllaattiioonn GGuu iiddee —— WWiinddoowwss ... · osql -U -P -d -i For example:...