Jump to: navigation, search

warn-unsent-sql-statements

Section: statserver
Default Value: 5000 (SQL statements)
Valid Values: Any positive value, both less than 2147483648 (231) and less than the value that is specified by the max-unsent-sql-statements configuration option
Changes Take Effect: After restart
Related Options: max-unsent-sql-statements

Defines the threshold upon which Stat Server begins logging warning messages about the number of unsent SQL statements.

To avoid data loss, Stat Server must remain connected to DB Server or to database for the entire period of the records submission to the RDBMS. If you use DB Server for connection to RDBMS, your addp timeout for connection from Stat Server to DB Server should be set as large as possible to prevent disconnection by addp. Refer to the Management Framework Deployment Guide for information about setting addp.

voice-reasons-table

Section: statserver
Default Value: no
Valid Values: yes, no
Changes Take Effect: Immediately upon notification


Specifies whether Stat Server stores the reasons for agents to change or continue Ready and NotReady states and AfterCallWork work mode. If this option is set to yes, Stat Server writes the reasons records directly to the VOICE_REASONS table in the Stat Server database. Refer to the The VOICE_REASONS Table in the Stat Server Deployment Guide for more information.

use-server-id

Section: statserver
Default Value:
Valid Values: Any integer from 0 (zero) to 63
Changes Take Effect: Immediately
Related Options: status-table

This option prevents constraint-violation errors from occurring in a database when more than one Stat Server application attempts to write to the same database. If only one Stat Server application writes to the same database table or you have set the value of the status-table option to no, you do not have to specify a value for this option. The default template does not include this option.

To set this option, enter any number from 0 to 63. Use a different value for each Stat Server application writing to the same database table. Each Stat Server application uses its assigned value to generate internally stored IDs.

Note: Configure this option only for those Stat Server applications writing to the same database and monitoring different switches. Do not configure Stat Server applications to write to the same database if they monitor the same switches.

This option was previously named UseServerID.

time-format

Section: statserver
Default Value: %m/%d/%Y %H:%M:%S
Valid Values: See table for a complete listing of valid time formats.
Changes Take Effect: After restart
Dependencies: local-time-in-status-table = yes

Specifies the time format of data stored in the StartLocalTime and EndLocalTime fields in the STATUS table. You must set the local-time-in-status-table option to yes to use the time-format option.

The format string consists of one or more codes preceded by a percent sign (%). Character strings that do not begin with % are copied unchanged to strDest.

This option was previously named TimeFormat.

Example:

Suppose you are using the default time format %m/%d/%Y %H:%M:%S. If the start time for a particular state is Tuesday, January 1, 1999, at 3 PM and 10 seconds, character data stored in the STARTLOCALTIME field in the STATUS table is stored as 01/01/1999 15:00:10. Changing the format codes for the date in the time-format option to %Y/%m/%d means the date is stored in the international date format as 1999/01/01. Spaces can also be used. For example, %Y %m %d would store as 1999 01 01.

Valid Time-Format Codes:

Format CodeDescription
%aAbbreviated weekday name
%AFull weekday name
%bAbbreviated month name
%BFull month name
%cDate and time representation appropriate for locale
%dDay of month as decimal number (01-31)
%HHour in 24-hour format (00-23)
%IHour in 12-hour format (01-12)
%jDay of year as decimal number (001-366)
%mMonth as a two-digit number (01-12)
%MMinute as a two-digit number (00-59)
%pCurrent locale's AM/PM indicator for 12-hour clock
%SSecond as decimal number (00-59)
%UWeek of year as a two-digit number, with Sunday as the first day of week (00-51)
%wWeekday as a one-digit number (0-6; Sunday is 0)
%WWeek of year as decimal number, with Monday as first day of week (00-51)
%xDate representation for current locale
%XTime representation for current locale
%yYear without century, as a two-digit number (00-99)
%YYear with century, as a four-digit number
%z, %ZTime-zone name or abbreviation; no characters if timezone is unknown
%%Percent sign
%#cLong date and time representation, appropriate for current locale; for example, Wednesday, March 14, 2001, 12:41:29
%#xLong date representation, appropriate to current locale; for example, Wednesday, March 14, 2001
#The pound sign (#) can precede any formatting code. This changes the meaning of the format code as shown in entries with the pound sign in this table.
Notes:
  • The pound sign is ignored in these format codes: %#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#%
  • The pound sign in these format codes removes any leading zeroes: %#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#Y
  • status-table-update-end-time-at-end-only

    Section: statserver
    Default Value: no
    Valid Values: yes, no
    Changes Take Effect: After restart


    Setting this option to yes enables Stat Server to update EndTime and EndLocalTime fields of the STATUS table for long running statuses only once, after those statuses have ended. Stat Server also sets the EndTime and EndLocalTime fields of the STATUS table to 0 (zero) during updates, provided that the corresponding status has not yet ended. A zero value implies 0 for integer fields and "" (empty string) for character fields. As soon as the status completes, Stat Server updates those fields with the time that the status ended.

    status-table

    Section: statserver
    Default Value: off
    Valid Values: on, off
    Changes Take Effect: Immediately


    Specifies whether Stat Server writes records about agent statuses directly to the STATUS table in the Stat Server database. Refer to the The STATUS Table in the Stat Server Deployment Guide for more information.

    This option was previously named StatusTable.

    qinfo-table

    Section: statserver
    Default Value: off
    Valid Values: on, off
    Changes Take Effect: Immediately upon notification


    Specifies whether Stat Server writes records about queue statuses directly to the QINFO table in the Stat Server database. Refer to the The QINFO Table in the Stat Server Deployment Guide for more information.

    This option was previously named QInfoTable.

    multimedia-activity-in-status-table

    Section: statserver
    Default Value: yes
    Valid Values: yes, no
    Changes Take Effect: After restart
    Related Options: ixn-id-in-status-table

    Specifies whether multimedia-related actions are counted while computing status values that are written to the STATUS table. (For a complete classification of actions, refer to the Stat Server User's Guide.) If this option is set to no, Stat Server ignores multimedia-related actions in its computation of place and agent status.

    Stat Server also reads the value of the multimedia configuration option in the TServer section of the monitored DN (whose type is Extension) to determine whether the corresponding DN is a multimedia DN, capable of processing interactions of different media types, such as those DNs that are controlled by a SIP-compliant T-Server. Refer to the Factors Affecting Stat Server in the Stat Server Deployment Guide for more information.

    Note: If you set this option to yes, you might also consider setting the ixn-id-in-status-table configuration option to yes so that Stat Server populates the IxnID field for multimedia interactions.

    max-unsent-sql-statements

    Section: statserver
    Default Value: 100000 (SQL statements)
    Valid Values: Integers greater than or equal to 100,000 and less than 2147483647 (231).
    Changes Take Effect: After restart


    Specifies the maximum number of SQL statements that Stat Server is allowed to maintain in memory. As soon as Stat Server's connection to the RDBMS is broken, Stat Server starts storing SQL statements in memory. These statements will be issued against the Stat Server database once the connection is restored. If the number of SQL statements in memory exceeds the value that is specified by this option, data loss might result.

    To avoid data loss, Stat Server must remain connected to DB Server or to database for the entire period of the records submission to the RDBMS. If you use DB Server for connection to RDBMS, your addp timeout for connection from Stat Server to DB Server should be set as large as possible to prevent disconnection by addp. Refer to the Management Framework Deployment Guide for information about setting addp.

    If the number of SQL statements in memory ever exceeds this option's value, data loss of the entire memory pool will result and the accumulation of SQL statements will begin anew.

    Please be aware that setting this option's value too high might cause your system to run out of memory. Configure this option in conformance with the amount of RAM installed on the machine where Stat Server operates.

    If you specify any value that is less than the default (100000), Stat Server resets it to 100000.

    login-table

    Section: statserver
    Default Value: off
    Valid Values: on, off
    Changes Take Effect: Immediately upon notification


    Specifies whether Stat Server writes records about login and logout TEvents directly to the LOGIN table in the Stat Server database. Refer to the The LOGIN Table in the Stat Server Deployment Guide for more information.

    This option was previously named LoginTable.

    local-time-in-status-table

    Section: statserver
    Default Value: off
    Valid Values: on, off
    Changes Take Effect: Immediately upon notification
    Related Options: time-format; enable-binding

    Specifies whether to populate the StartLocalTime and EndLocalTime fields in the STATUS table. If you set the value of this option to off, or if you do not specify a value, the StartLocalTime and EndLocalTime fields will contain no data. For Solution Reporting applications, set this option to off; such reports do not use the local time fields, and setting this option to on could affect performance. When setting this option to on, also set the time-format option to the desired format. Refer to the Table and Column Description in the Stat Server Deployment Guide for a complete description of the STATUS table.

    This option was previously named LocalTimeInStatusTable.

    Warning! To avoid data loss, do not change the value of this option in runtime if you have also set enable-binding to yes.

    ixn-id-in-status-table

    Section: statserver
    Default Value: off
    Valid Values: on, off
    Changes Take Effect: Immediately upon notification
    Related Options: multimedia-activity-in-status-table; enable-binding

    Specifies whether Stat Server will populate the IxnID field for records written to the STATUS table. If you set this option to off or if you do not set configure this option, the IxnID field will be null. This field provides functionality, comparable to connection IDs for calls, for Multimedia interactions that rely predominantly on the number generated by Interaction Server for identification in the interaction flow.

    Note: If you set this option to on, consider also setting the multimedia-activity-in-status-table configuration option to yes so that Stat Server will record information about the status of multimedia interactions in the other fields of the STATUS table.

    Warning! To avoid data loss, do not change the setting of this option in runtime if you have also set enable-binding to yes.

    identity-in-login-table

    Section: statserver
    Default Value: off
    Valid Values: on, off
    Changes Take Effect: After restart


    Turning this option on enables Stat Server to operate with an Oracle Real Application Clusters (RAC). This option requires a database access point connection to an Oracle RAC database. The user must also initialize their LOGIN table with the oracle/login_oracle.sql script that comes with the Stat Server installation.

    enable-binding

    Section: statserver
    Default Value: no
    Valid Values: yes, no
    Changes Take Effect: Immediately upon notification
    Related Options: binding-threshold

    Specifies whether to enable binding functionality. By default, Stat Server uses a regular method of sending requests. If you set the value of this option to yes, Stat Server uses binding for sending requests. This option works in conjunction with the binding-threshold configuration option and is supported for Oracle, Microsoft SQL, and DB2 relational database management systems. The default template does not include this option.

    This option was previously named OracleBinding.

    binding-threshold

    Section: statserver
    Default Value: 10
    Valid Values: Any positive integer less than 2147483648 (231)
    Changes Take Effect: After restart
    Dependencies: enable-binding = yes

    Specifies the number of records in a binding block—that is, the number of records to be sent to the DBMS simultaneously. This option is enabled only if you have set the value of the enable-binding configuration option to yes. The default template does not include this option.

    db-direct-connection

    The [db-direct-connection] section is defined on the Options tab of the Stat Server Application object.

    Stat Server 8.5 is capable of working with the DBMS through:

    • A direct database connection, without using DB Server. Make sure to install the corresponding DBMS client software on the Stat Server host for direct database connection. Refer to Framework Database Connectivity Reference Guide for more information.
    • An indirect database connection, using DB Server (backward compatibility mode)

    By default, Stat Server connects through a configured DB Server. To enable the direct database connection, create the [db-direct-connection] section.




         


    debug

    Default Value: 0
    Valid Values: 0 - 5
    Changes Take Effect: After restart


    This option controls advanced debugging information such as function calls.

    enable

    Default Value: off
    Valid Values: on, off
    Changes Take Effect: After restart


    This option enables direct database connection to the DBMS.

    verbose

    Default Value: 0
    Valid Values: 0 - 4
    Changes Take Effect: After restart


    This option controls the SQL statement and message sending debug information.



    See also options listed in the [statserver] section to configure a Stat Server application to write data to a database:

    Starting with the 8.5 release Stat Server installation package includes the following additional executables:

    • On Unix
      • dbclient_db2_32
      • dbclient_db2_64
      • dbclient_oracle_32
      • dbclient_oracle_64
    • On Windows
      • dbclient_db2.exe
      • dbclient_oracle.exe
      • dbclient_msql.exe

      These executables are located in the same directory as your Stat Server executable.

      The appropriate executable is used to establish the connection to a particular database, using DB Info provided in the connected Database Access Point.

      See Framework Database Connectivity Reference Guide for more information.

    This page was last edited on May 10, 2019, at 12:49.
    Comments or questions about this documentation? Contact us for support!