aggregate-duration
Section: schedule
Default Value: 5:00
Valid Values: 00:00-24:00
Changes Take Effect: Immediately
Dependencies: run-aggregates, aggregate-schedule
Specifies the amount of time, in 24-hour format, that Job_AggregateGIM will run after it is launched. When the run-aggregates option is set to TRUE, the scheduler will stop the aggregation job when this interval expires. The aggregation job is launched in accordance with a schedule defined by the aggregate-schedule option. After the aggregation job is launched, it runs continuously until the aggregation-duration interval expires.
aggregate-schedule
Section: schedule
Default Value: 0 1
Valid Values: A valid CRON expression
Changes Take Effect: Immediately
Dependencies: run-aggregates
Specifies the daily schedule for Job_AggregateGIM to start. The job will start in accordance with this schedule when aggregation is being controlled by the scheduler (in other words, the run-aggregates option is set to true). Between them, the aggregate-schedule and aggregate-duration options define daily time intervals within which Job_AggregateGIM will run continuously.
The schedule is defined in the format of a CRON expression that represents a set. The expression comprises two fields, which are separated by whitespace:
- The first field specifies minutes. Valid values are 0–59 and optional special characters (see below).
- The second field specifies hours. Valid values are 0–23 and allowed special characters.
The following special characters are allowed in the CRON expression:
- , (comma)—Separates items in a list. For example, specifying the first field (minutes) as 0,30,45 means the 0th, 30th, and 45th minutes of the hour.
- - (hyphen)—Defines a range. For example, specifying the first field (minutes) as 30-35 means every minute between the 30th and 35th minute of the hour, inclusive; this is the same as specifying 30,31,32,33,34,35.
- * (asterisk)—Indicates that the CRON expression will match for all values of the field. For example, specifying the second field (hours) as * means every hour in the day.
- / (forward slash)—Describes increments. For example, specifying the first field (minutes) as 0/10 means the 0th minute of the hour and every 10 minutes thereafter.
run-aggregates
Section: schedule
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately
Dependencies: None
Specifies whether the scheduler will manage the aggregation job, to run the aggregation engine inside the Genesys Info Mart process.
aggregation-engine-class-name
Section: gim-etl
Default Value: none
Valid Values: Any string
Changes Take Effect: On restart
Dependencies: None
Specifies the class name of the aggregation package, if it is installed. If your deployment uses the Genesys historical reporting presentation layer—Genesys CX Insights (GCXI)—or the separately installed Reporting and Analytics Aggregates (RAA) package, specify the following value: "GIMAgg.GimInterfaceImpl.AggregationImpl"
For more information, see the Reporting and Analytics Aggregates Deployment Guide.
agg-jdbc-url
Section: gim-etl
Default Value: No default value
Valid Values: Any valid JDBC URL
Changes Take Effect: On restart of the Genesys Info Mart Server.
In an Oracle RAC configuration in which you want aggregation to use a separate node, specifies the connection parameters for the JDBC connection to the Info Mart database for Reporting & Analytics Aggregates (RAA). If this option is defined, the aggregation process uses the connection string specified by agg-jdbc-url instead of the jdbc-url connection string. For the required syntax for this option, consult the vendor documentation for your JDBC driver.
For performance reasons, Genesys recommends that you divide processing by function, allocating separate functions to specific nodes in the cluster. Use the Oracle RAC Server Control Utility (SRVCTL) to configure named services, including a named service for RAA, and associate those services with particular nodes. For more information, see "Oracle RAC Configuration" and "DAP Objects for Genesys Info Mart" in the Genesys Info Mart 8.x chapter in the Genesys Hardware Sizing Guide.
Example for Oracle
Oracle requires the following format to specify connection parameters for the Oracle thin client:
jdbc:oracle:thin:@(DESCRIPTION = (LOAD_BALANCE=OFF)(ADDRESS = (PROTOCOL = TCP)(HOST = <database_host_name>)(PORT = 1521))(CONNECT_DATA = (SERVER = DEDICATED)(SERVICE_NAME=<named service>)))
jdbc-url
Section: gim-etl
Default Value: No default value
Valid Values: Any valid JDBC URL
Changes Take Effect: For an extraction DAP, at the next run of the extraction job for the particular data domain; for the Info Mart DAP, on restart of the Genesys Info Mart Server.
Specifies all of the connection parameters for JDBC connection to the IDB or the Info Mart database. For the required syntax for this option, consult the vendor documentation for your JDBC driver.
- Example for Microsoft SQL Server
Microsoft SQL Server requires the following format to specify connection parameters for the Microsoft JDBC driver: jdbc:sqlserver://<dbserver>;DatabaseName=<dbname>;SelectMethod=cursor - Example for Oracle
Oracle requires the following format to specify connection parameters for the Oracle thin client: jdbc:oracle:thin:@(DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = <database_host_name>)(PORT = 1521))(CONNECT_DATA = (SERVER = DEDICATED)(SID = <Oracle_SID>))) - Example for PostgreSQL
PostgreSQL requires the following format to specify connection parameters for the PostgreSQL JDBC driver: jdbc:postgresql://<database_host_name>:<port>/<dbname>
Enabling Aggregation
The following steps summarize the task flow to enable Genesys Info Mart to support the aggregation process and to populate aggregate tables in the Info Mart database.
- Install the aggregation engine software.
Install Reporting and Analytics Aggregates (RAA).
For information about how to install GCXI, see the Genesys CX Insights Deployment Guide. For information about how to install RAA, see the Reporting and Analytics Aggregates Deployment Guide for your release.
- Configure the Genesys Info Mart Application object and other applications and objects in your Genesys environment, as required, to support aggregation.
Settings on the Genesys Info Mart Application object — as well as settings for ICON filtering options, and other applications — affect aggregation. Be aware that GCXI has specific requirements for certain settings.- For full information about how to configure Genesys Info Mart for aggregation, see the Reporting and Analytics Aggregates Deployment Guide for your release.
TipYou must restart the Genesys Info Mart Server if you modify the following settings during runtime:
- jdbc-url option in the Info Mart DAP
- agg-jdbc-url option in the Info Mart DAP (optional, in Oracle RAC deployments only, if you want aggregation to use a separate node)
- aggregation-engine-class-name in the Genesys Info Mart Application
- User name for the Info Mart database
- Password for the Info Mart database
- For information about how to configure MicroStrategy and GCXI, see the Genesys CX Insights Deployment Guide.
- For full information about how to configure Genesys Info Mart for aggregation, see the Reporting and Analytics Aggregates Deployment Guide for your release.
- (Optional) Configure custom calendars.
See Creating Custom Calendars.ImportantIf your reports use custom calendar dimensions, create the custom calendars before you start aggregation. - Start the aggregation engine.
If you have configured the Genesys Info Mart scheduler to control the aggregation process (run-aggregates = true), the aggregation job will start automatically at the scheduled time, as specified by aggregate-schedule, and will run continuously for the amount of time specified by aggregate-duration.
For full information about how to start the aggregation engine, see the Reporting and Analytics Aggregates Deployment Guide for your release. For more information about how to schedule and manage the aggregation job in Genesys Info Mart, see Managing and Scheduling Jobs in the Genesys Info Mart Operations Guide.