SiteSearch Administrator Tools Installation
Table of Contents
Software
Installation
Ini File Directory Structure Setup
Database Setup
Sample Configuration Files
Software
To install SiteSearh Administrator Tools, you will need the following Software.
J2SDK 1.3.1
Jakarta-tomcat 3.2.1
Cocoon 1.8.2
Log4J 1.0.4
Soap 2.2
JavaMail 1.2
MySQL 3.23.35
JDBC driver mm.mysql-2.0.2-bin.jar
Installation
Download and install J2SDK 1.3.1 from http://java.sun.com/j2se/1.3/download.html.
Download and install Jakarta-tomcat 3.2.1 from http://jakarta.apache.org/builds/jakarta-tomcat/archives/v3.2.1/bin/.
Download and install Cocoon 1.8.2 from http://xml.apache.org/cocoon1/dist/.
Change $TOMCAT_HOME/lib/parser.jar to $TOMCAT_HOME/lib/zparser.jar and $TOMCAT_HOME/lib/jaxp.jar to $TOMCAT_HOME/lib/zjaxp.jar before you restart Jakarta-tomcat to test Cocoon installation.
Download and install Log4J 1.0.4 from http://jakarta.apache.org/log4j/docs/earlier.html.
Download and install Soap 2.3 from http://xml.apache.org/dist/soap/version-2.2/.
Download and install JavaMail 1.2 http://java.sun.com/products/javamail/javamail-1_2.html.
Download and install MySQL 3.23.35 from http://sourceforge.net/projects/mysql/.
Download JDBC driver mm.mysql-2.0.2-bin.jar from http://mmmysql.sourceforge.net/oldDist.html.
Copy log4j.jar to $TOMCAT_HOME/lib.
Copy soap.jar to $TOMCAT_HOME/lib and copy soap.war to $TOMCAT_HOME/webapps.
Copy mail.jar to $TOMCAT_HOME/lib
Copy activation.jar to $TOMCAT_HOME/lib.
Copy mm.mysql-2.0.2-bin.jar to $TOMCAT_HOME/lib
Copy ssa_classes.jar to $TOMCAT_HOME/lib
Edit $TOMCAT_HOME/conf/server.xml. Add new context path points to your $INIFILE_ROOT (See "Ini File Directory Structure Setup" section for more details).
<Context path="/export/home/pcharoen/AdminTools/ROOT"
docBase="/export/home/pcharoen/AdminTools/ROOT"
crossContext="false"
debug="0"
reloadable="true" >
</Context>
Extract ssa_webapp.tar to $TOMCAT_HOME/webapps
Edit $TOMCAT_HOME/webapps/ssa/WEB-INF/iconfig.xml. Modify parameters following your configuration (see iconfig.dtd for details).
Edit $TOMCAT_HOME/webapps/ssa/WEB-INF/log4jconfig.xml (see log4j.dtd for details). The value of "File" parameters are the log file name in full path for information log file and debug log file.
<appender name="AFile" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="/export/home/pcharoen/AdminTools/logs/ssi.log">
...
<appender name="ADebugFile" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="/export/home/pcharoen/AdminTools/logs/ssi_debug.log">
...
Start MySQL server and create database using setup_ssadb.sql. Change directory to $TOMCAT_HOME/webapps/ssa and run following commands.
bash-2.03$ mysqladmin create ssadb
bach-2.03$ mysql ssadb < setup_ssadb.sql
Setup ini file directory structure. See details in "Ini File Directory Structure Setup" section.
Start jakarta-tomcat server.
Deploy AlertEmailServer Web Service.
Change directory to $TOMCAT_HOME/webapps/ssa.
Run soap.sh deploy $HOST_NAME:$PORT_NO.
Ini File Directory Structure Setup
Create directory to store symbolic link to your SiteSearch configuration files.
bash-2.03$ mkdir $INIFILE_ROOT
Create symbolic links point to your SiteSearch configuration files for each environment.
bach-2.03$ cd $INIFILE_ROOT
bach-2.03$ ln –s $YOUR_SITESEARCH $ALIAS
Ex: ln –s /usr/sitesearch/dev2/SS4_1_1 SS4_1_1
ln –s /usr/sitesearch/dev1/SS4_1_2a SS4_1_2a
ln –s /usr/sitesearch/dev2/SS4_2_0a SS4_2_0a
.
.
Create symbolic links point to your AdminTools log files.
bach-2.03$ ln –s $YOUR_ADMINTOOLS_LOGS $LOGS
Ex: ln –s /export/home/pcharoen/AdminTools/logs logs
Make sure that your iconfig.xml - <home> points to $INIFILE_ROOT.
Database Setup
Browse SiteSearch Administrator Tools index page at http://$HOST_NAME:$PORT_NO/ssa
Login system using user-id "admin" password "admin" then click "Tools" on tool bar menu.
Add new servers. Click Edit Server à New. Add new server and enter information for production server, staging server, and developer servers.
Edit Server
Id: server-id (number only)
Name: server name (Ex: Production)
IniFile Path: full path (symbolic link in ini file structure directory) point to ini file directory for this server (Ex: $INIFILE_ROOT/SS4_1_1/ini)
JDBC URL: JDBC URL to accessdb for this server (Ex: jdbc:mysql://localhost/production_accessdb)
Driver: JDBC Driver class name (Ex: org.gjt.mm.mysql.Driver)
User-Id: MySQL user-id
Password: MySQL password
Edit user group. Click Edit User Group à Edit (Administrator Group) à Edit Server Privileges. Click check box in front of "Server Name" you want to access. Click "Default" check box on the server you want to be a default server. Click "Save" when you are done. Click "New Privileges". Select "Folder Name" and give permissions to read, write, and create on this folder. You can also set other properties for the folder such as sort field, order by (ascending/descending), file's extension filter, and page size. Click "Save" when you are done. See details in following field descriptions.
Edit User Group
Edit Group Detial
Group Id: user group id (number)
Group Name: user group Name
Group Type: administrator group or user group
Toolbar Name: tool bar name for this user group
Navbar Name: navigator bar name for this user group
Server Privileges
Checkbox in front of "Server Name": to grant server privilege for this user group
Default checkbox: to set default server for this user group
Edit Folder Privileges
Folder Name: folder Name for this user group (select from drop down list)
Read: read file permission
Write: modify file permission
Create: create folder permission
Sort Field: file Name / File Size / Last Modify Date
Order by: ascending / Decending
Context Path: map to Servlet Path ( Yes / No)
File Filter: (Yes / No)
File Extension: file extensions to be shown (delimited by comma)
Page Size: number of file show in browse screen
Add new user and assign a group to user.
Edit User Information
User Id: adminstrator tools user-id
User Name: adminstrator tools user name
Password: administrator tools password
User Group: group of user.
Status: active / in-active
Stylesheet: default
Test URL: URL to SiteSearch test environment
Logout and Login as new user.
Sample Configuration files
$TOMCAT_HOME/webapps/ssa/server.xml
$TOMCAT_HOME/webapps/ssa/setup_ssadb.sql
$TOMCAT_HOME/webapps/ssa/WEB-INF/cocoon.properties
$TOMCAT_HOME/webapps/ssa/WEB-INF/iconfig.dtd
$TOMCAT_HOME/webapps/ssa/WEB-INF/iconfig.xml
$TOMCAT_HOME/webapps/ssa/WEB-INF/log4J.dtd
$TOMCAT_HOME/webapps/ssa/WEB-INF/log4Jconfig.xml