Revision as of 14:28, March 26, 2013 by Peter Chaplin (talk | contribs) (→‎Deploying GRE in Genesys Administrator)
Jump to: navigation, search

Deploying GRE in Genesys Administrator

The GRE can be configured by using either Genesys Administrator or Configuration Manager. If you use Genesys Administrator, you can deploy the installation package from within Genesys Administrator. If you use Configuration Manager, you will have to create the application first and then run the installation package manually.

Procedure: Deploying the Genesys Rules Engine in Genesys Administrator

Purpose

  • To configure the GRE application and deploy the GRE installation package (IP) by using Genesys Administrator.


Genesys Administrator needs to be at Release 8.1.0 or later to install the GRE on 8.1.0 or later Configuration Servers. Start <OL><li>Import the installation package into Genesys Administrator:</li> <OL type="a"> <li>On the <tt>Deployment</tt> tab of Genesys Administrator, select <tt>Import</tt>.</li><li>Select <tt>Installation CD-ROM</tt>.</li> <li>Click <tt>Next</tt>.</li> <li>Browse to the <tt>MediaInfo.xml</tt> file on the CD or the CD image location on the network (the path must be in UNC format). </li> <li>Click <tt>Next</tt>.</li> <li>Select GRE for your operating system as well as the appropriate type in the list in order to import the installation package.</li>

  • For Management Framework 8.1, the type is <tt>Business Rules Execution Server</tt>.
  • For Management Framework 8.0 and earlier, the type is <tt>Genesys Generic Server</tt>.

<li>Select <tt>Next</tt> to start the import. </li> <li>Click <tt>Finish</tt> when the import is complete.</li> <li>Install the GRE IP. Select the <tt>Deployment</tt> tab in Genesys Administrator. The list of installation packages will now show the GRE. Right-click and select <tt>Install Package</tt> for the IP for your operating system and type (see Step 1). Click <tt>Next</tt> to start the installation wizard. The following parameters must be defined/selected: </li> </OL><OL type="a"> <li>Application Name for the GRE application</li><li>Target Host"he host to which the .<tt>war</tt> file will be copied during the installation procedure</li> <li>Working Directory"he directory in which the <tt>.war</tt> file will be created</li> <li>Client Side IP Address (optional)</li> <li>Client Side Port (optional)</li> <li>Configuration Server hostname</li> <li>Configuration Server port. </li>

Warning: For a secure connection, the Configuration Server port should be of type <tt>Auto Detect (Upgrade)</tt>.

<li>Connection delay time in seconds</li> <li>Reconnect Attempts.</li>

Warning: Items a through i will be written to the <tt>bootstrapconfing.xml</tt> file in the <tt>.War</tt> file. Any subsequent updates to the parameters will have to be made in that file.

</OL><blockquote>On the next screen, enter Connection ID and Connection Port for the GRE.</blockquote><blockquote>Edit the Connection port for the genesys-rules-engine connection. The Connection Port is the connector port of the servlet container. For example, on Tomcat the default listening port is 8080.</blockquote><blockquote>The Connection Protocol can be set in the configuration part under Provisioning.</blockquote><blockquote>Verify the previously-defined installation parameters on the Deployment Summary screen. </blockquote><li>Configure the Rules Engine application:</li> </OL><OL type="a"> <li>In the <tt>Server Info </tt>section, verify the default listening port, as well as the connector port on which the Rules Engine Servlet receives requests:</li><p-SubStepBulletList>* The <tt>ID</tt> value is the name of the Rules Engine web application. The default name of this application is "<tt>genesys-rules-engine</tt>".

  • The <tt>Listening port</tt> is the connector port of the servlet container. For example, on Tomcat the default listening port is 8080.
  • The <tt>Connection Protocol</tt> must be <tt>http</tt>.

<li>On the <tt>Tenants</tt> tab, add the Tenants that will be available to the Rules Engine.</li> <li>On the <tt>Connections</tt> tab, add a connection to Message Server if you want to use network logging.</li> <li>On the <tt>Options</tt> tab, configure options. In addition to the standard logging options that you can configure, you can configure an option named <tt>fileEncoding </tt>in the<tt> logging </tt>section. </li> </p-SubStepBulletList><blockquote><tt>fileEncoding</tt> specifies the encoding that is to be used during creation of the log file"or example, <tt>UTF-8</tt>. This value is optional. If you do not specify this option, the server's locale information will determine the log file encoding. </blockquote><blockquote>This option is available for both the GRE and the Genesys Rules Authoring Tool. Also, the <tt>log4j.properties</tt> file that is included in both components supports a similar option, <tt>log4j.appender.runtime.Encoding</tt>. The <tt>log4j.properties</tt> file is used for initial log configuration prior to the reading of the log configuration from the Configuration Server database.</blockquote><li>There are several optional configuration options in the <tt>settings</tt> section:</li>

  • <tt>verify-deploy-address</tt> indicates whether to verify that the TCP address of the application that is deploying rules is that of an associated Genesys Rules Authoring Tool. The default value is <tt>true</tt>.
  • <tt>sequential-mode</tt> specifies whether to run the GRE in sequential mode. In sequential mode, no additional data can be inserted or modified after the initial data set, simplifying the GRE operations. The default value is <tt>false</tt>.
  • <tt>max-number-rule-executions</tt> specifies the maximum number of rules to be executed during a request. This option is used to detect unwanted recursions when <tt>sequential-mode</tt> is <tt>false</tt>. Once the maximum is reached, an error is reported. The default value is <tt>10000</tt>.
  • <tt>deployed-rules-directory</tt> (which must be manually added if you want to assign it a value) 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 GRE is restarted, all packages that are defined in this directory are loaded and made available for execution. Specifying a <tt>deployed-rules-directory</tt> is recommended. If <tt>deployed-rules-directory</tt> is not assigned a value, the rule packages will be placed in the <tt>WEB-INF\config</tt> sub-directory within the <tt>genesys-rules-engine</tt> web application directory. At this location the deployed rule packages may get deleted when an updated <tt>.war</tt> file is deployed.
  • <tt>esp-worker-threads</tt> (new in release 8.1.2), specifies the maximum number of worker threads available when using the ESP interface to execute rules. The default for this value is 5 threads.

<li>S<tt>ave</tt> your changes.</li> </OL></ol> End Next Steps <ul> <li>Deploy the<tt> genesys-rules-engine.war</tt> file to your application server. See Procedure: Deploying the .war files.</li> </ul>

Comments or questions about this documentation? Contact us for support!