Jump to: navigation, search

Creating the GRE Application Object in Configuration Manager

Procedure

To create the application object for GRE in Configuration Manager, do the following:

Import the GRE Application Template into Configuration Manager

  1. In Configuration Manager, navigate to the Application Templates folder.
  2. Right-click the Application Templates folder, and select Import Application Template.
  3. Browse to the templates folder of the installation CD, and select the appropriate template for your version of Management Framework.
  • For Management Framework 8.1.1, select Genesys_Rules_Engine.apd..
  • For Management Framework 8.1 and earlier, select Genesys_Rules_Engine_Generic_Server.apd..
  • Click OK to save the template.
  • Configure the GRE Application in Configuration Manager

    1. Right-click the Applications folder and select New > Application.
    2. Select the template that you imported in the previous procedure.
    3. On the General tab, enter a name for the application, such as Rules_Engine.
    4. On the Tenants tab, add the Tenants that will be available to the Rules Engine.
    5. On the Server Info tab, select the Host on which the application will be installed.
    6. Add a default listening port.
    7. Add an additional port. This port is the connector port on which the Rules Engine Servlet receives requests:
      • The ID value is the name of the Rules Engine web application. The default name of this application is genesys-rules-engine.
      • The Listening Port is the connector port of the Servlet Container. For example, on Tomcat the default listening port is 8080.
      • The Connection Protocol must be http.
    8. On the Start Info tab, enter x for each field. These fields are not used, but you must enter some text there in order to save the configuration.
    9. On the Options tab, configure options. Logging options are as follows:

      log

      Description Valid values Default value Takes effect
      all

      Specifies the outputs to which an application sends all log events. The log output types must be separated by a comma when more than one output is configured. For example: all = stdout, logfile

      • stdout—Log events are sent to the Standard output (stdout).
      • stderr—Log events are sent to the Standard error output (stderr).
      • network—Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database. Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
      • memory—Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
      • [filename]—Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
      stdout After restart
      expire

      Determines how many log files will be kept on disk. If set, expire specifies the maximum number of log files kept on disk.


      Any number

      (blank) After restart
      segment

      Determines whether a log output written to file is split in multiple segments. If it is, segment specifies the maximum size of each segment file.


      Any number that represents the log size in megabyte

      (blank) After restart
      standard

      Specifies the outputs to which an application sends the log events of the Standard level. The log output types must be separated by a comma when more than one output is configured. For example:

      standard = stderr, network

      • stdout—Log events are sent to the Standard output (stdout).
      • stderr—Log events are sent to the Standard error output (stderr).
      • network— Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
      • memory—Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
      • [filename]—Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
      stdout After restart
      trace (not in application template by default)

      Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels). The log outputs must be separated by a comma when more than one output is configured. For example: trace = stderr, network

      • stdout—Log events are sent to the Standard output (stdout).
      • stderr—Log events are sent to the Standard error output (stderr).
      • network—Log events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
      • memory—Log events are sent to the memory output on the local disk. This is the safest output in terms of the application performance.
      • [filename]—Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application's working directory.
      stdout After restart
      verbose

      Determines whether a log output is created. If it is, specifies the minimum level of log events generated. The log events levels, starting with the highest priority level, are Standard, Interaction, Trace, and Debug.


      • all—All log events (that is, log events of the Standard, Trace, Interaction, and Debug levels) are generated.
      • debug—The same as all.
      • trace—Log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels) are generated, but log events of the Debug level are not generated.
      • interaction—Log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels) are generated, but log events of the Trace and Debug levels are not generated.
      • standard Log events of the Standard level are generated, but log events of the Interaction, Trace, and Debug levels are not generated.
      • none—No output is produced.
      standard After restart
    10. Configure the options on the Settings tab as follows:

      Settings in GRE

      Description Valid values Default value Takes effect
      deployed-rules-directory

      Specifies the directory in which to keep the working copy of deployed rule packages. When a package is deployed, a copy of the deployed package is placed here. When the rules engine is restarted, all packages defined in this directory are loaded and made available for execution. Specifying a deployed-rules-directory is recommended. If a value is not assigned to the deployed-rules-directory, the rule packages are placed in the WEB-INF\config sub-directory within the genesys-rules-engine web application directory. At this location the deployed rule packages may be deleted when an updated .war file is deployed.

      If you choose to change the default value, ensure that the path exists and that the application server can write to the specified directory.

       

      /GCTI/logs/GRS_Engine After restart
      max-number-rule-executions

      The maximum number of rules to be executed during a request. This is used to detect unwanted recursion when sequential-mode is false. If this maximum is reached an error is reported.

      May be set to -1 to denote no maximum.

      Any positive integer or -1

      10,000 Next rules execution
      sequential-mode

      Indicates whether to run the rules engine in sequential mode. In sequential mode, after the initial data set, no more data can be inserted or modified. This allows for the rules engine to operate in a simplified way.

      true/false

      false On rules deployment
      verify-deployer-address

      Indicates whether to verify the TCP address of the application deploying rules to be that of an associated Genesys Rules Authoring Tool.

      true/false

      true Immediately
      esp-worker-threads

      Specifies the maximum number of worker threads available when using the ESP interface to execute rules.

      Any positive integer

      5 Immediately
      load-packages-on-start

      Indicates whether to load deployed rule packages at application start up. If packages are not loaded at startup (value=false), then a package is loaded on its first execution request.

      true/false

      true Immediately
      json-hierarchical-driver

      With value true, the JsonHierarchicalStreamDriver class is used to serialize JSON responses. With value false, the JettisonMappedXmlDriver class is used. The Jettison driver is unaware of the original data type and will try to detect numerical values and omit the quotes, whereas the JsonHierarchicalStreamDriver will maintain the data type.

      true/false

      false Immediately
      cache-operational-parameters (new in 8.5.0)

      Operational parameters are rule parameters whose value is obtained at rule execution time. They are configured in GAX as Parameter Groups, and stored in the Configuration Server database. Prior to 8.5, whenever an operational parameter was referenced during the execution of a rule, GRE would fetch the current value from Configuration Server. In high-volume environments, this could put unnecessary stress on Configuration Server.

      In GRS 8.5, the value of the operational parameters can be cached inside GRE, to make fetching faster. Instead of fetching the value with each reference, GRE will set up a listener to Configuration server and maintain the value in a local cache. When the administrator changes the value of the parameter using GAX, GRE will receive an event and update its local cache.

      If cache-operational-parameters is set to true (default), this new caching mechanism will be enabled.

      If cache-operational-parameters is set to false, no caching will be used and each reference will fetch the current value from Configuration Server (as was done prior to 8.5).

      true/false

      true Immediately
      parameter-cache-timeout (new in 8.5.0)

      When cache-operational-parameters is set to true, parameter-cache-timeout defines how long (in hours) an operational “parameter group” will remain in the cache. After the timeout expires, the transaction will be removed from the cache until the next time the value is requested. This is used to clean up old subscriptions to parameter groups which are no longer being referenced. The default value for this will be 168 (168 hours = 1 week).

      Integer

      168 Immediately
      clear-cache-on-disconnect (new in 8.5.0)

      When cache-operational-parameter is set to true, the clear-cache-on-disconnect parameter defines what the behavior should be if GRE loses connection with the Configuration Server. If clear-cache-on-disconnect is set to false, GRE will continue to use the cached value for any rule evaluations, until such time as the Configuration Server is restored. With this option, there is a risk that GRE could use “stale” values for rule evaluation during the time the connection to Configuration Server is down. If clear-cache-on-disconnect is set to true, the cache will be cleared and a null (“”) value will be used in the rules. With this option, there is potential that rules will fail evaluation during the period that the Configuration Server connection is down.

      true/false

      false Immediately
      include-rule-evaluation-detail-in-response (new in 8.5.001)

      Returns disqualified rules (rules that did not fire), conditions that evaluated false and rule evaluation time back to the REST client invoking the rule evaluation request. Prior to 8.5.001, only the results of rules that fired were returned.

      Note: Currently, the rulesDisqualified and executionTime is not returned via ESP to iWD.

      true/false

      false Immediately
    11. Save your changes.
    This page was last modified on September 4, 2014, at 11:19.

    Feedback

    Comment on this article:

    blog comments powered by Disqus