Main -> Documentation -> WebZ System Administration -> WebZ Configuration Files -> SSAdmin Configuration Files

SSAdmin Configuration Files

The Open SiteSearch WebZ ssadmin interface enables system administrators to monitor system status and issue commands directly to the WebZ system components or the WebZ system components or the system components for the Record Builder application included with Database Builder.

OpServe reads SSAdmin.ini every time you start ssadmin with the ssadmin command. The variables defined in SSAdmin.ini set the default values for the location of the OpServe.conn file, the instructions for starting the ssadmin tool (a command line interface), and the system information displayed when you issue the list or poll commands from the ssadmin prompt. Similarly, if you start ssadmin with the ssadmin_rb command (in a SiteSearch environment with Record Builder), the system obtains similar information from SSAdmin_rb.ini.

This document begins by describing the sections and variables in SSAdmin.ini and SSAdmin_rb.ini. An example of an SSAdmin configuration file, along with an example of changing the ssadmin display by modifying the SSAdmin configuration file follows.

Document Conventions

  • <WebZ_root> is the location of your WebZ environment.
  • hostname is the name of the system where your WebZ environment is installed.
  • "Default value" is the value of a variable when WebZ was initially installed on your system.
  • Unless otherwise specified, all variables must contain a value; their value cannot be left empty.
  • The default value shown in the Default column applies to both SSAdmin.ini and SSAdmin_rb.ini unless otherwise indicated.

File Location

The SSAdmin.ini and SSAdmin_rb.ini files are located in the <WebZ_root>/ini/ directory of your installation.

Sections and Variables in SSAdmin.ini

SSAdmin.ini and SSAdmin_rb.ini each have the following sections (shown as [section_name]):

[SSAdmin] Section

Variable
Description
Default

ConnFile

Specifies the location of the OpServe.conn file that is created when the OpServe component starts. The OpServe.conn file contains the current host and port that the OpServe component is bound to. This file is automatically deleted when the OpServe is stopped, and a new one is created when the OpServe is restarted.

<WebZ_root>/ops/OpServe.conn

OpServeExecCmd

Defines the location of the startup script for the ssadmin interface that is executed by the software when you start ssadmin from the host system command prompt.

SSAdmin.ini:
<WebZ_root>/scripts/ssmgr.hostname opserve

SSAdmin_rb.ini:
<WebZ_root>/scripts/ssmgr.hostname opserve OpServe_rb.ini

 

MaxConnectRetries

Specifies the number of times that ssadmin tries to connect to the OpServe before assuming that the execution of the server was not successful.

10

[BatchTrace] Section

This section is used when you run ssadmin in batch mode with <WebZ_root>/scripts/ssadminbatch.

Variable
Description
Default

traceLevel

Specifies the level of detail in the trace messages written to the log file for ssadminbatch.

You can also set logging manually using the settrace command in the ssadmin interface.

 TRACE_NONE

traceDirectory

Defines the directory that stores the ssadmin log file.

<WebZ_root>/logs

traceFilename

Defines the base name that ssadmin uses for the log file. ssadmin also adds the host, port, time, and date stamps to this base name before saving the log file.

OpServe.ini:
  ssadminbatch.log

OpServe_rb.ini:
 ssadminbatch_rb.log

[List] Section

Variable
Description
Default

Item1
...
Itemn

OR, beginning with version 4.0,2:

Item*
...
Item*

Defines the list of items that appear when you issue a list or poll command in ssadmin. After installation, SSAdmin.ini contains the following items by default:

  • Server - type of server (e.g., JaSSI, OpServe, ZBase, or Access; for Record Builder, the server types also include JaSSIRB, ZBaseRB, AccessRB, and Lock).
  • Host - names the host server that the WebZ or Record Builder server is running on (e.g., dev1 or cypress).
  • Port - port number of the host that the server is running on.
  • ResTime - average response time the server takes to process a request.
  • Sessions - the number of user sessions currently active on the server.

In addition to the default items above, you can also display the following:

  • ConnClients - number of clients connected to WebZ or Record Builder.
  • Files - includes the number of files that are actively being used by the WebZ or Record Builder server. The following types of files are included in this number: HTML, log, statistics, sockets, and database files.
  • Load - an integer that serves as a measure of the server resources being used. As the integer value increases, the server is running a greater load.
  • OpPort - the port at which each WebZ or Record Builder server communicates with the Operations component.
  • Status - describes the status of the WebZ or Record Builder server as either 'ACTIVE' or 'QUIESCED'.
  • Threads - states the number of single, lightweight processes (or threads) that are running on the server to complete a request.
  • TotMem - states the total memory reserved for the server to use at one time.
  • TransRate - contains the number of transactions per second.
  • UsedMem - states the amount of memory the server is currently using.
  • Version - lists the version of the software related to the server.

Beginning with version 4.0.2, you can use either numerals or asterisks to indicate the items to appear in response to a list or poll command, but do not mix the two; use either all numerals or all asterisks.

Note:

The format command in ssadmin temporarily changes the items displayed in the system information for the current ssadmin session. By editing the SSAdmin.ini file, you permanently change the information displayed with the ssadmin list and poll commands.
Item 1 = Server
Item 2 = Host
Item 3 = Port
Item 4 = ResTime
Item 5 = Sessions

SSAdmin Configuration File Example

The SSAdmin.ini file delivered with SiteSearch 4.1.0 contains the following information upon installation:

# SSAdmin.ini
[SSAdmin]
ConnFile = <WebZ_root>/ops/OpServe.conn
OpServeExecCmd = <WebZ_root>/scripts/ssmgr.hostname opserve
MaxConnectRetries = 10
[BatchTrace]
traceLevel = TRACE_NONE
traceDirectory =<WebZ_root>/logs
traceFilename  = ssadminbatch.log
# Default list for SSAdmin list display
[List]
Item1=Server
Item2=Host
Item3=Port
Item4=ResTime
Item5=Sessions

Default ssadmin Display

Using the information from the example above, ssadmin displays the following table when you issue a list or poll command:

Changing the ssadmin Display

To include the used memory information for each server in this table, edit the SSAdmin.ini file by adding a new line to the [List] section (Item6=UsedMem), as shown in bold blue print below:

# SSAdmin.ini
[SSAdmin]
ConnFile=/<WebZ_root>/ops/OpServe.conn
OpServeExecCmd=/<WebZ_root> /scripts/ssmgr.hostname opserve
MaxConnectRetries=10
# Customized list for SSAdmin list display
[List]
Item1=Server
Item2=Host
Item3=Port
Item4=ResTime
Item5=Sessions
Item6=UsedMem

According to the new information defined above, the ssadmin tabular display would now reveal the following system information:

Note that the information displayed now includes the used memory for each system component.

See Also

WebZ Configuration Files
Record Builder Configuration Files
ssadmin Command Reference
Operating the WebZ System
Operating Record Builder

[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]
Last Modified: