Query Manipulation Server 24.2

# Statistics Server Parameters

Set general parameters to configure machine information, time display options, and data storage locations.

## ActionEvent

Set this parameter to `True` to enable the Event action.

Type: | Boolean
Default: | False
Required: | No
Configuration Section: | [Server]
Example: | `ActionEvent=True`
See Also: | Event

## DateString

Set this parameter to `False` to display time in Epoch time, or `True` to display time in YYYY-MM-DD format.

Type: | Boolean
Default: | False
Required: | No
Configuration Section: | [Server]
Example: | `DateString=True`

## EventClients

Specify the IP addresses or host names of machines that are permitted to send events to the Statistics Server. Separate multiple values with a comma.

Type: | String
Default: | 127.0.0.1
Required: | No
Configuration Section: | [Server]
Example: | `EventClients=*.*.*.*`

## EventField

Specify the field in the XML event that contains the name of the IDOL Server. Use this parameter if you are using multiple IDOL Servers.

Type: | String
Default: | None
Required: | No
Configuration Section: | [IDOLStatistics]
Example: | `EventField=idolname`
See also: | IDOLName Number

## EventPort

Specify the number of the port that receives events.

Type: | Integer
Default: | None
Required: | No
Configuration Section: | [Server]
Example: | `EventPort=19871`

## EventThreads

Specify the number of event threads.

Type: | Integer
Default: | 8
Required: | No
Configuration Section: | [Server]
Example: | `EventThreads=80`

## ExternalClock

The `ExternalClock` parameter determines when Statistics Server begins recording events. If you do not use this parameter, the server begins recording events as soon as it starts. If you set a value (in seconds), the Statistics Server uses that value as a timestamp for each statistic. The first time the server receives an XML event with a `<timestamp>` value equal to or greater than the `ExternalClock` value, it begins recording statistics from that point onward. Each subsequent event must have a `<timestamp>` value greater than the previous one to be recorded.

NOTE: To use `ExternalClock`, configure a `<timestamp>` field in the XML events. For more information, see Push Events to Statistics Server.

Type: | Integer
Default: | 0
Required: | No
Configuration Section: | [Server]
Example: | `ExternalClock=100`

## History

Specify the directory in which statistical results are stored.

Type: | String
Default: | `./history`
Required: | No
Configuration Section: | [Paths]
Example: | `History=./results`

## IDOLName

Specify the name of the IDOL component from which the statistic is received. Set this parameter if you are using multiple IDOL components.

NOTE: To use `IDOLName`, you must configure a field that contains the name of the IDOL component in the XML events. For more information, see Push Events to Statistics Server.

Type: | String
Default: | None
Required: | No
Configuration Section: | [MyStatistic]
Example: | `IDOLName=IDOL1`
See also: | EventField Number

## Main

Specify the directory in which database files are stored. The database files contain information about the fields defined in the Statistics server configuration file.

Type: | String
Default: | `./main`
Required: | No
Configuration Section: | [Paths]
Example: | `Main=./dbfiles`

## Number

Specify the number of IDOL components from which to measure statistics. Set this parameter if you are using multiple IDOL components.

Type: | Integer
Default: | None
Required: | No
Configuration Section: | [IDOLStatistics]
Example: | `Number=2`
See also: | EventField IDOLName

## Port

Specify the Statistics server ACI port number.

Type: | Integer
Default: | None
Required: | Yes
Configuration Section: | [Server]
Example: | `Port=19873`

## SafeModeActivated

Set this parameter to `True` to activate safe mode. See Preserve Data during Service Interruptions.

Type: | Boolean
Default: | False
Required: | No
Configuration Section: | [Server]
Example: | `SafeModeActivated=True`

## StatLifetime

Specify how long you want to keep statistical data stored on disk. After the specified time period has elapsed, all statistical data is removed. You can specify the period that you want to elapse before deleting statistical data by using the following format:

    <number><timeUnit>

where `<number>` is the number of time units that you want to elapse, and `<timeUnit>` is the time unit to specify. The following units are available:

- second

- seconds

- minute

- minutes

- hour

- hours

- day

- days

- week

- weeks

- month

- months

If you do not specify a `timeUnit`, Statistics Server reads the specified number as seconds. You can also enter -1 for an unlimited time (no data is deleted).

Type: | String
Default: | -1 (no data is deleted)
Required: | No
Configuration Section: | [Server]
Example: | `StatLifetime=1week`

## TemplateDirectory

Specify the directory that contains an XSL template file, used for reporting.

Type: | String
Default: | None
Required: | No
Configuration Section: | [Paths]
Example: |
    TemplateDirectory=C:\IDOL\IDOLServer\IDOL\templates

## Threads

Specify the number of ACI threads.

Type: | Integer
Default: | 4
Required: | No
Configuration Section: | [Server]
Example: | `Threads=100`

## XSLTemplates

Set this parameter to `True` to enable XSL reporting.

Type: | Boolean
Default: | False
Required: | No
Configuration Section: | [Server]
Example: | `XSLTemplates=True`

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Query Manipulation Server 24.2

Topic Title: Statistics Server Parameters