Jump to: navigation, search

assignment-reset-delay

Section: OCCExtension
Default Value: 30000
Valid Values: Positive integer
Changes Take Effect: After restart
Dependencies: java-extension-jar = OCCStatExtension.jar

This option specifies the reset delay, in milliseconds, for agent assignments-related actions. The delay is applied upon an Outbound Contact Server disconnect or upon an Outbound Contact Server explicit request to reset these actions. Genesys recommends to keep this option at default value, unless explicitly instructed otherwise.

print-level

Section: OCCExtension
Default Value: standard
Valid Values: debug, standard, or trace
Changes Take Effect: After restart
Dependencies: java-extension-jar = OCCStatExtension.jar

This option sets the logging verbosity level of OCC Extension.

java-extension-jar

Section: OCCExtension
Default Value: OCCStatExtension.jar
Valid Values: OCCStatExtension.jar
Changes Take Effect: After restart


This mandatory option indicates that other parameters in this section are submitted to OCC Extension upon extension load.

jvm-path

Section: java-config
Default Value: No default value
Valid Values: Any valid, fully specified path (including file name) to the particular file
Changes Take Effect: After restart, or upon setting the enable-java configuration option to true.
Dependencies: enable-java = true

The value of this option must contain the path to JVM:

  • jvm.dll on Windows
  • libjava.so, libjvm.so, libjvm.a, or libjvm.sl on UNIX

Starting with release 8.5.101, the JVM will not be initialized if the option is set to a relative path (absolute paths are mandatory).

jvm-path

Section: java-config
Default Value: No default value
Valid Values: Any valid, fully specified path (including file name) to the particular file
Changes Take Effect: After restart, or upon setting the enable-java configuration option to true.
Dependencies: enable-java = true

The value of this option must contain the path to JVM:

  • jvm.dll on Windows
  • libjava.so, libjvm.so, libjvm.a, or libjvm.sl on UNIX

Starting with release 8.5.101, the JVM will not be initialized if the option is set to a relative path (absolute paths are mandatory).

debug-level

Section: statserver
Default Value: Init
Valid Values: all, Action, Client, Cluster, Init, HA, Java, Mngmnt, Reset, Server, Shmem, SPT, SQL, Status
Changes Take Effect: Immediately upon notification


A comma-separated list of debug categories that are visible in the Stat Server log:

  • all Synonymous with Init,Server,Client,Status,Action,SQL,Mngmnt,Java,Reset for Stat Server in regular mode. Synonymous with Init,Server,Client,Cluster,Status,Action,Mngmnt,Reset for Stat Server in cluster mode. The debug level that you designate for this category supersedes any debug level that you designate for other categories.
  • Action Logs changes to the internal Stat Server object model and provides a significant source of troubleshooting data, which includes entries following every TEvent.
  • Client Logs all Stat Server communication with its clients, such as the opening of statistics and all statistical values sent to the client. This value generates a large amount of data, and should be sparingly used for troubleshooting reproducible problems with statistics.
  • Cluster Logs activity related to Stat Server operating in cluster mode.

Note: This value does not apply to Stat Server operating in regular mode.

  • Init Used for capturing data related to Configuration Server that affects Stat Server, including dynamic Configuration Server changes made as Stat Server starts--such as the addition, deletion, and/or change of objects or their properties having an affect on Stat Server. This value is useful for tracking initial configuration and dynamic changes and is much more compact than the information provided in the Configuration Server log. Genesys recommends that you always include this value in this option.
  • HA Logs messages related to HA functionality.
  • Java Displays information related to Java extension functionality. Use this value only for statistics in the Outbound Contact 7.2.0+ or MCR 7.0.1+.

Notes: This value does not apply to Stat Server operating in cluster mode. MCR has been renamed to eServices in release 8.0.

  • Mngmnt Displays profiling information, including the number of currently connected clients, statistics being computed at the moment, and statistics to be reported to clients.
  • Reset Enables the log messages Stat Server sends to clients while sending statistics requested with a reset-based notification mode.
  • Server Logs T-Server events pertaining to Stat Server. Genesys recommends that you not include this value if you maintain logs for the related T-Server(s).
  • Shmem Logs shared memory communication among Stat Server cluster nodes. Applicable for Stat Server in cluster mode only.
  • SPT Logs events related to Stat Server startup. This value is provided to maintain backward compatibility and may be eliminated in future releases.
  • SQL Displays the SQL statements issued if you have configured a database for Stat Server.

Note: This value does not apply to Stat Server operating in cluster mode.

  • Status Logs events related to the current state of objects and is useful for troubleshooting Stat Server-Router problems.

This option is enabled only if you have set the verbose common log option to all.

In graphical environments, log output often takes more than half of a server's execution time. To maintain performance, use only the debug levels that you need and run Stat Server in the background. Also, minimize the Stat Server window or redirect log output to a different device, such as a file. Be very careful, however, when directing log output to a file and consider the available free disk space, directory and file permissions, and possible conflicts with different software trying to use the log file at the same time.

For each debug category, you can also set the level of debug logging by specifying a numerical value from [0–9] (with 9 being the most verbose) and appending the number to each category.

For example: Init, Status:6, Cluster:8

Debug level 0 is synonymous to no logging at all for the specified debug category.

Debug levels 1–4 provide less logging information than was provided in prior releases but more than debug level 0.

Debug level 5 provides exactly the same logging information that was provided in prior releases. This level is the default level if none is otherwise specified.

Debug levels 6–7 provide more detailed output than level 5.

Debug levels 8–9 provide the most extensive log output requiring further internal processing which, in turn, further degrades Stat Server performance.

The SIP Server 8.1.1 product provides a troubleshooting tool that parses the log output of several Genesys servers including Stat Server. Refer to the SipSpan2 User's Guide, available on the SIP Server CD, for information on how to use this tool.

This option was previously named DebugLevel.

enable-java

Section: statserver
Default Value: false
Valid Values: true, false
Changes Take Effect: After restart, or upon setting the value to true.
Related Options: jvm-path

When you set the value of this option to true, Stat Server tries to load JVM at startup. The jvm-path configuration option defines the location of JVM. If you set this value to false at Stat Server startup, but later set it to true, Stat Server attempts to load JVM at runtime.

Note: Stat Server ignores the change in setting from true to false. To unload JVM, you must stop Stat Server.

Java Sections

Important
For Stat Server release 8.x, Java functionality is reserved for use in conjunction with Genesys-provided reports for Outbound Contact and eServices (formerly known as Multimedia).
Starting with release 8.5.1, Stat Server is extended to include support for the Orchestration Server (ORS) Java Extension.
You cannot use Java extensions while Stat Server operates in cluster mode.

Upon startup, Stat Server reads the enable-java configuration option to determine whether SSJE (Stat Server Java Extension) functionality is enabled. Adding Java to the value of the debug-level configuration option enables Stat Server to log messages that are related to Java extension functionality. If the value of the enable-java option is true, Stat Server processes the information specified in the following Stat Server sections (See the RTME Options Reference for details):

  • [java-config]
  • [jvm-options]
  • [java-extensions]

using the following high-level procedure:

  1. Stat Server verifies that the [java-config] section exists.
  2. Stat Server verifies that the jvm-path option within that section has been specified.
  3. Stat Server verifies that the [jvm-options] section exists.
  4. If all three are true, Stat Server loads Java Virtual Machine (JVM) from the path specified by jvm-path using any options that you might have specified within the [jvm-options] section.
    For Stat Server to be able to load JVM, a platform-appropriate environment variable has to be set on the host:
    • LD_LIBRARY_PATH for Linux/Solaris.
    • LIBPATH for AIX.
    • PATH for Microsoft Windows.

    In general, the parent folder of the jvm.dll or libjvm.so (specified in the jvm-path option) should be included within the value of the environment variable.
    For example:

    • On Linux or Solaris, if the location of the file is /usr/java/jdk1.7.0_60/jre/lib/amd64/server/libjvm.so, then LD_LIBRARY_PATH should contain /usr/java/jdk1.7.0_60/jre/lib/amd64.
    • On AIX, if the location of the file is /usr/java/sdk7/jre/lib/ppc64/j9vm/libjvm.so, then LIBPATH should contain /usr/java/sdk7/jre/lib/ppc64.
    • On Windows, if the location of the file is C:\Java\jre7\bin\server\jvm.dll, then PATH should contain C:\Java\jre7\bin.
  5. Stat Server loads Java classes from the Genesys Platform SDK (kv65_adapter.jar and kvlists.jar) and from the Stat Server Java SDK (statserver.jar and statserver_impl.jar).
  6. Stat Server loads the Java libraries indicated by the java-libraries-dir configuration option of the [java-config] section.
  7. If Stat Server successfully loads the Java host environment, Stat Server next tries to load Java Extensions (specified by the java-extensions-dir configuration option of the [java-config] section) from archives specified in the [java-extensions] section.
  8. Stat Server takes the initial parameters for each <extension.jar> extension from the section where java-extension-jar=<extension.jar>, and uses them for this extension execution.

For configuration options for which you specify true/false values, any of the following additional values are also valid:

  • yes and no
  • y and n
  • 1 and 0
  • on and off

How to Configure a Particular Java Extension

When Stat Server loads SSJE, Stat Server passes a set of parameters during the initialization phase. To specify those parameters in Stat Server, follow these steps:

  1. Create a new configuration section, with an arbitrary name, on the Stat Server Options tab in Configuration Server.
  2. Within this section, create the java-extension-jar option and, as its value, specify the relative path of the corresponding SSJE jar archive with respect to the SSJE installation directory; for example, MySSJE.jar.
  3. Add any other options to this section. Stat Server passes the corresponding name:value pairs to SSJE during the initialization phase.

How to Configure a Particular Java Extension Stat Type

Some Stat Server clients (such as CC Analyzer) require an explicit statistical type (stat type) configuration in Configuration Server. Java stat types are configured slightly differently than regular stat types. To configure a particular stat type defined in a Java Extension:

  1. Create a new section, with an arbitrary name, on the Stat Server Options tab in Configuration Server.
  2. Within the newly created section, create these new mandatory options:
  • Category
  • Objects
  • JavaSubCategory

The first two are standard for all stat types. (Refer to Statistical Type Sections for a description of these and other options.)

The value of the third option must have the format extension-jarpath:stat-type-name, where:

  • extension-jar-path is the relative path of the Java Extension jar archive with respect to the SSJE installation directory described by [jvm-options]/java-extensions-dir.
  • stat-type-name is the name of the stat type residing in SSJE.
  • Add any other options to the newly created section. Stat Server will pass the corresponding name:value pairs to SSJE whenever the statistics associated with this corresponding stat type are requested.
  • How to Configure Logging Level and Agent Assignment Reset Delay for the OCC Extension

    OCC Extension supports the ability to reset agent assignments-related actions both by the explicit request from Outbound Contact Server and upon Outbound Contact Server disconnect. This functionality is required for proper functioning of agent assignments in scenarios involving switchovers between a primary/backup Outbound Contact Server pair.

    Configure logging levels and agent assignment reset delays in the [OCCExtension] section of the Stat Server application by setting the following options:

    Troubleshooting Tips

    If Windows 2008 does not have the appropriate 32-bit or 64-bit Microsoft Visual C++ 2010 Redistributable Package, Stat Server is unable to load JVM shared library.

    Feedback

    Comment on this article:

    blog comments powered by Disqus
    This page was last modified on November 11, 2016, at 04:54.