GRAT Configuration Options

Important

Where the table below indicates that a GRAT (re-)start is required, this means the GRAT Web Application must be restarted. This can be accomplished in different ways depending upon the application server. In Tomcat, JBOSS or Websphere, GRAT can be stopped and started from the administration console. This does not require restarting the entire app server (there could be other applications deployed to the same container, not only GRAT). If GRAT is the only application deployed, you can simply restart the application server (for example, restart Tomcat server).

Settings in GRAT

Description	Valid values	Default value	Takes effect
group-by-level (group rules by business level)
There are three levels of rules: global, department, and process. With value true, rules are grouped by business level: All global rules belong to agenda group level0. Department rules belong to agenda group level1. Process rules belong to agenda group level2. When a rule package is executed, level0 rules are executed first. Updates from this first pass then influence the department (level1) rules which are executed in the second pass. Updates from this second pass then influence any process rules (level2), which are executed in a third pass. Note: The GRE option sequential-mode must be false when group-by-level is set to true. When group-by-level is set to false, all rules are executed in a single pass. Changes made by a rule do not influence which other rules are executed (unless a Drools “update” or “insert” command is used). CEP functionality Genesys Web Engagement's CEP functionality strips out the rule attribute that indicates which level a rule is associated with. So, the setting of the group-by-level has no influence on rule execution.	true/false	true	Immediately
max-connections
Specifies the maximum number of different users that may be connected to the server. Multiple connections from the same user ID are only counted once.	Any positive integer	99	After GRAT (re-)start
session-timeout
Specifies the amount of time (in minutes) a client session can have no communication with the Rules Authoring Server before timing out. If no value is specified, the timeout (if any) defined by the application server applies. If the value is less than or equal to 0, the session will not time out.	Any positive integer	30	Immediately
session-timeout-alert-interval
The amount of time (in minutes), prior to an expected timeout, for a user to be warned of a pending timeout. If no value is specified, or if the value is less than or equal to 0, the default warning period of 1 minute will be used. For example, if you set the value of this option to 3, the user will be warned 3 minutes prior to an expected timeout. This warning dialog box will prompt the user to extend the session. If the session is not extended, the user will be logged out and the login dialog box will be displayed. Any unsaved changes that the user made during their session will be lost.	Any positive integer	1	Immediately
strict-mode
This option controls whether or not the rules authoring tool enables strict mode in the DROOLS rule compiler. Strict mode will cause the compiler to catch common mistakes when the rule author attempts to validate or save a rule.Genesys recommends leaving this option set to its default value true.	true/false	true	Immediately
verify-deployer-address
Indicates whether to verify the TCP address of the application deploying rules to be that of a valid associated Genesys Rules Engine (one in the valid list of application connections). With its default value of true, this option protects against illegal attempts to deploy packages from any other application.	true/false	true	Immediately
display-n-template-versions
Specifies the maximum number of versions to display for any published template. Note: if the current rule package is using an older version that is not included in the last "n" versions, it will also be shown, in order to allow the user to upgrade to a more recent template. For example, if "n" is 3, and there are 10 versions of a template, GRAT will show only version 10, 9, and 8. If the rule package is currently associated with an older version, for example, version "5", then that will also be shown, and the checkbox will be selected.	Minimum value 1	3	Immediately
deploy-response-timeout (not in application template by default)
Specifies the timeout (in seconds) applied to the deployment of a rule package before an error condition is indicated. If the timeout is reached, the deployment fails (is this true?) and an error is returned.	Any positive integer	300	Immediately
require-checkin-comment
Specifies whether users must add a check-in comment when committing changes to rules. These comments show up when viewing package history. If the value is set to false (default), users can save changes to rules without specifying a comment.	true/false	false	Immediately
force-snapshot-on-deployment
Specifies whether users can deploy only a package snapshot. If the value is true, users can only deploy a package snapshot. If false (default), users can deploy either the LATEST package or a snapshot.	true/false	false	Immediately
encoding (not in application template by default)
Activates Unicode support for the conversion of data between the local character set that is used by Configuration Manager and the UTF-8 encoding that is used by the Rules Authoring Server. By default, code page conversion is disabled. To activate this functionality, set this option to the name of a converter that can translate the local character set to UTF format. The converter that is suitable for a particular deployment can be found by using the ICU Converter Explorer. There is no default value for this option. For valid values, see the ICU Home > Converter Explorer pages (http://demo.icu-project.org/icu-bin/convexp).			After GRAT restart
clear-repository-cache
The GRAT server builds and maintains a cache of the rules repository database (for example, index files, and so on), and stores this on the file system under WEB-INF/classes/repository. The cache improves performance when accessing frequently used rules, calendars, and so on. However, this cache must stay synchronized with the rules repository database. Normally, if GRAT is restarted, it re-uses the existing cache, which is synchronized with the rules repository database. In this case, the clear-repository-option should be set to false (default). However, if you are configuring a second GRAT for warm standby (see High Availability Support), this option should be set to true for both the primary and the standby instances of GRAT. Since either GRAT could be brought online in the event of a failure, this option forces GRAT always to rebuild the cache and re-synchronize it with the rules repository database. Setting this option to true can delay the startup of GRAT, since the cache must be rebuilt, but it ensures that it is properly synchronized with the rules repository database.	true/false	false	After GRAT (re-)start
evaluate-decision-table-rows-top-down (new in 8.5.0)
Determines the order that the Decision Table rows are written out to the DRL. The default value is false, meaning that the rows are executed from the bottom up. If you change this default option, the behavior of GRAT's Test Scenario feature changes immedately, but you will need to re-deploy the rule package in order for the change to be observed in GRE.	true/false	false	Immediately
single-sign-on (new in 8.5.0)
Note: This configuration option should only be used when deploying in a Genesys Engage cloud single-sign on environment, and does not apply for Genesys on-premise customers deploying GRS. Indicates the login method: either single sign-on, or legacy login. With value false, the /index.jsp page will redirect to /login.jsp for legacy user login. With value true, then /index.jsp will redirect to /singlesignon.	true/false	false	After GRAT (re-)start
link-to-hub (new in 8.5.0)
Note: This configuration option should only be used when deploying in a Genesys Engage cloud single-sign on environment, and does not apply for Genesys on-premise customers deploying GRS. This option specifies the URL to which GRAT should redirect once the GRAT SSO session completes. This URL is used in two situations: First, when the user clicks the log out button in GRAT, the browser will be redirected to this URL. Second, if an SSO login is successful but the subsequent login to Configuration Server fails, then an error box is displayed to the user. Once the error box is dismissed, the browser will be redirected to the specified URL. Note: The user must have logged in via SSO for this to occur.	string	No default value	After GRAT (re-)start
decision-table-enable-wildcards (new in 8.5.001)
Controls whether the wild card feature is enabled in decision tables.	true/false	true	After GRAT (re-)start
help-file-url (new in 8.5.001)
Specifies the base URL location of online help for GRAT. You can specify a local protected URL to install the wiki Help files if your organization prefers. If you change the default value, you must specify the location of your locally hosted Help files.	String	http://docs.genesys.com/Special:HelpLink/GRATHelp?context=<GRAT version>.index	Immediately
use-legacy-language-pack-webhelp (introduced in 8.5.001 and removed in release 8.5.1)
With value true, when the GRAT user clicks the Help button in non-English environments, GRAT will use the legacy WebHelp files shipped with the various language packs. These legacy files may not reflect the full set of current functionality. With value false (default), GRAT will retrieve online Help from the docs.genesys.com website in the desired language (if available). In release 8.5.1, translated online Help is available, so this option is not required.	true/false	false	After GRAT (re-)start
context-services-rest-api-protocol (new in 8.5.001)
The protocol that GRAT uses for the Context Services metadata REST API. Valid values are: http https	http, https	http	After GRAT (re-)start
context-services-rest-api-host (new in 8.5.001)
The hostname of the Context Services that GRAT connects to.	String		After GRAT (re-)start
context-services-rest-api-port (new in 8.5.001)
The port of the Context Services metadata API	String		After GRAT (re-)start
context-services-rest-api-base-path (new in 8.5.001)
The base path of the Context Services API.		/	After GRAT (re-)start
list-object-use-name (new in 8.5.001.21)
Enables users to control whether either the name or the display name of a Configuration Server list object is encoded in the DROOLS rule file.		true/false	After GRAT (re-)start
enable-nested-solutions (new in 8.5.100.21)
Controls whether users can create new rule packages under any node of the hierarchy. For iWD, it is recommended to set this option to false.	false	true/false	After GRAT (re-)start
deploy-method (new in 8.5.100.21))
Enables users to override the automatic detection of the protocol to construct the "callback" URL used by GRE to fetch the DRL. GRE will use the selected method to connect with the GRAT server during deployment.	auto	auto / http / https	After GRAT (re-)start
enable-cep-calendars (new in 8.5.200)
Enables users to enable/disable business calendars for rules that are based on the Complex Event Processing (CEP) template.	false	true/false	After GRAT (re-)start
allow-partial-cluster-deployment (new in 8.5.200)
With value true, allows GRAT to perform a partial deployment to a GRE-type application cluster, as distinct from pre-8.5.2 behavior in which cluster deployment fails if even a single node fails.	false	true/false	Immediately
rest-api (new in 8.5.200)
Defines whether the REST API is enabled. In addition, this configuration option will enable them to determine whether or not to force only SSL communications. Genesys recommends running over SSL in order to protect the authentication tokens that flow on each request from compromise. SSL can be disable where appropriate (for example, testing labs, positioning server behind firewalls, and so on).	disabled	disabled—The REST API is disabled and will not accept any requests enabled—The REST API is enabled and will accept both secure (https) and non-secure (http) requests requireSSL—The REST API is enabled and will only accept secure (https) requests.	After GRAT (re-)start