View table: PEConfigOption
Table structure:
- OptionName - Wikitext
- DefaultValue - String
- ValidValues - String
- ConfigLevel - List of String
- ShortDesc - Wikitext
- ExtendedDesc - Wikitext
- Introduced - String
- Modified - String
- Discontinued - String
This table has 146 rows altogether.
Page | OptionName | DefaultValue | ValidValues | ConfigLevel | ShortDesc | ExtendedDesc | Introduced | Modified | Discontinued | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Draft:PEC-AD/Current/WWEPEGuide/RichMessage | chat-nexus.service-url | "" | A valid web-socket URL. | Agent • Agent Group | Specifies the web-socket url of the Nexus service url to access the Chat API. | 9.0.000.97 | |||||||||||||||||||||||
Draft:PEC-AD/Current/WWEPEGuide/RichMessage | chat-nexus.web-components.url | "" | A valid web-socket URL | Agent • Agent Group | Specifies the Nexus-ux WebComponents url to display the nexus-ux view. Use this option if the URL is different from the standard URL. | 9.0.000.97 | |||||||||||||||||||||||
Draft:PEC-AD/Current/WWEPEGuide/RichMessage | privilege.chat-nexus.can-use | false | true, false | Agent • Agent Group | Enables agents to access the contents of the Digital Channels Conversation tab in the Agent Workspace Case Side View of the Chat interaction view. | 9.0.000.97 | |||||||||||||||||||||||
Draft:PEC-AD/Current/WWEPEGuide/RichMessage | privilege.chat-nexus.can-use-contact-history-detail | false | true, false | Agent • Agent Group | Enables agents to access Digital Channels chat interaction Rich Message content in the Details tab of the Contact History view. | 9.0.000.97 | |||||||||||||||||||||||
Draft:PEC-AD/Current/WWEPEGuide/RichMessage | privilege.chat-nexus.communication.can-send | false | true, false | Agent • Agent Group | Enables agents to manage contact subscriptions and send messages to contacts from the Communication tab. | 9.0.000.97 | |||||||||||||||||||||||
Draft:PEC-AD/Current/WWEPEGuide/RichMessage | privilege.chat-nexus.communication.can-use | false | true, false | AGent • Agent Group | Enables agents to manage contact subscriptions and send messages to contacts from the Communication tab. | ||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | aggregate-duration | 23:00 | 00:00-24:00 | Specifies the amount of time, in 24-hour format, that Job_AggregateGIM runs after it is launched. When the run-aggregates option is set to TRUE, the scheduler stops 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. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | aggregate-schedule | 30 0 | A valid CRON expression | Specifies the daily schedule for Job_AggregateGIM to start. The job starts 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 runs 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 following special characters are allowed in the CRON expression:
ExamplesThe following values for aggregate-schedule illustrate sample schedules:
Genesys recommends against configuring a schedule that has the aggregation job running in a series of short bursts—for example, aggregate-schedule=30 * and aggregate-duration=00:15. When the time specified by aggregate-duration expires, the scheduler immediately stops the aggregation job, even if it is in the middle of processing a batch of data. If you want Job_AggregateGIM to run continuously for 24 hours a day, without any breaks for maintenance activities (which is not recommended), set aggregate-schedule=0 0 and aggregate-duration=24:00. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | appender.ConsoleLogger.Threshold | info | trace, debug, info, warn, error, all, off | For information about this option, refer to the Apache logging site: http://logging.apache.org/index.html | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | chunk-size-seconds | 86400 | Any positive integer | Specifies the size of the time interval, in seconds, for which data is exported in each job. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | console-pattern-layout | %d{ISO8601} %-5p %-12t %m%n | Any valid pattern string | For information about this option, refer to the Apache logging site: http://logging.apache.org/index.html | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | date-time-max-days-ahead | 400 | Any positive integer | Specifies, in number of days, how far ahead the calendar dimension table is populated. The default value specifies that the calendar dimension is populated up to a year in advance (365 days + 1 day for leap years). Genesys does not recommend that you populate the calendar tables more than a year in advance, in case there are changes to DST or other international time standards that might invalidate the prepopulated data. | Note: Ensure that you populate the calendar far enough ahead to meet the requirements of your reporting intervals. | ||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | date-time-min-days-ahead | 183 | Any positive integer | Specifies, in number of days that remain in the prepopulated calendar, when the calendar table is updated with the next batch of days ahead. The default value specifies that the maintenance job updates this calendar approximately 6 months before it expires. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | date-time-start-year | 2020 | 1970-2038 | Specifies the year that the calendar starts. When you are setting this option, ensure that you choose a start year that provides sufficient buffer to prevent inconsistencies or unexpected missing dimensions around the start of the calendar. Genesys recommends that you set the value so that the calendar starts at least one year prior to any date that might be encountered in the data. Be aware that Genesys Info Mart uses GMT for internal time references, and this affects exactly when the calendar starts. | For example, if the other [date-time] options that affect the start date are set so that the calendar starts at 00:00 AM on January 1, 2022, and the date-time-tz option is set to Eastern European Time (GMT + 2), the calendar table is populated with dimensions starting at 02:00 AM on January 1, 2022. | ||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | date-time-tz | GMT | Any valid Java time zone | Specifies the time zone for the calendar. You can use any valid time zone that is supported by the version of the Java Runtime Environment (JRE) that runs the Genesys Info Mart Server. For more information about supported time zones, see the documentation about calendar time zones on the Java developer website or other public resources. | Sample public resources:
Important Particularly in deployments that use GCXI or RAA, ensure that the time zone is set appropriately for your deployment before you initialize Genesys Info Mart or before aggregation starts. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-active-facts | 27 | Any positive integer | Specifies the maximum number of days to retain active multimedia interactions in GIDB and the dimensional model, including certain Staging tables, after which the interactions become eligible for purging. Depends on the value of days-to-keep-gim-facts. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-deleted-annex | 2 | Any positive integer | Specifies the number of days to retain deleted records in the *_ANNEX dimension tables. | The default value of days-to-keep-deleted-annex is small, because there is likely little reason to retain deleted data for significant periods of time. The major reason that Genesys Info Mart provides *_ANNEX data is to support GCXI visibility controls, and GCXI uses only active *_ANNEX data for this purpose. For example, with the default value (2 days), if Job_MaintainGIM is running on September 4, 2022, the job purges *_ANNEX records that terminated (in other words, the configuration setting on the object’s Annex tab was deleted) before September 2, 2022. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-gidb-facts | 27 | Any positive integer | Specifies the number of days to retain fact data in GIDB. Facts that have a start time that is earlier than the retention period are eligible to be purged. Related Options: days-to-keep-active-facts | The retention period for multimedia facts in GIDB is determined solely by the value of days-to-keep-gidb-facts. Genesys expects the value of days-to-keep-gidb-facts to be less than 30. Although many GIDB tables contain personally identifiable information (PII), Genesys Info Mart does not include most GIDB tables in General Data Protection Regulation (GDPR) processing. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-gim-facts | 400 | Any positive integer | Specifies the number of days to retain fact data in the dimensional model. Facts that have a start time that is earlier than the retention period are eligible to be purged. Job_MaintainGIM does not purge active fact data, dimension data, or aggregate tables (if aggregation is enabled). Genesys Info Mart enforces that the value of days-to-keep-active-facts' be less than the value of days-to-keep-gim-facts and days-to-keep-gidb-facts be less than the value of days-to-keep-gim-facts. | Genesys Info Mart does not enforce a limit on the length of the retention period. However, Genesys strongly recommends against setting days-to-keep-gim-facts, and likewise days-to-keep-active-facts, to an excessively large value (for example, thousands of days). To avoid performance issues or job failures when Genesys Info Mart operates against an excessively large Info Mart database, be realistic about your requirements and available database resources, and apply best practices and recommendations from your RDBMS vendor. If you choose a very long retention period, you must carefully choose and tune the storage used for the Info Mart database; also carefully consider settings for partition size and other database- and performance-related configuration options, as well as parameters on the RDBMS side. By definition, all voice interaction data in the dimensional model relates to completed interactions. How Purge Options WorkTo illustrate how various days-to-keep-* options combine to determine when data is purged, the following tables provide examples of different scenarios for GIDB and the dimensional model, respectively. Purge examples
|
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-output-files | 30 | Any positive integer | Specifies how many days to store exported files before deleting them. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | etl-end-time | 23:30 | 00:00-23:59 | Specifies the time of day, in 24-hour format, when the last ETL cycle can start running. If the value that you specify is before the ETL start time, the end time is for the next day (past midnight). If etl-start-time=etl-end-time, the ETL cycle runs continuously. |
Ensure that you configure etl-start-time and etl-end-time so that there is sufficient time for the last ETL cycle of the day to complete and for Job_MaintainGIM to run (see the maintain-start-time option), before the start of the first ETL cycle of the next day. | ||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | etl-frequency | 1 | 0-1440 | Specifies the number of minutes that pass between the start times of each ETL cycle. If the amount of time that it takes to complete a cycle is shorter than the specified value, the next cycle is delayed until the time elapses. If the amount of time that it takes to complete a cycle is longer than the specified value, the next cycle is started immediately. | The ETL frequency must not be greater than the chunk size for data extraction, as specified by the extract-data-chunk-size option. Otherwise, Genesys Info Mart can not keep pace with ICON. When it checks the deployment, Genesys Info Mart verifies the internal consistency between the ETL frequency and extraction chunk size. By default, the value of etl-frequency is much smaller than the value of extract-data-chunk-size. Genesys recommends that you retain this relationship, to minimize data latency. For example, say that extract-data-chunk-size=900 (15 minutes), etl-frequency=1, and all data from the last chunk has been processed; when the next ETL cycle starts 1 minute later, there is only 1 minute’s worth of new data, and this can be processed very quickly. Alternatively, if there is a backlog of data, and it takes less than 15 minutes to process a 15-minute chunk, the next ETL cycle starts almost immediately, to continue catching up. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | etl-start-date | Any date after 1970 in the format yyyy-mm-dd hh:mm:ss | Specifies the earliest date for which Genesys Info Mart considers IDB data for extraction in a new deployment or when the Info Mart database is re-initialized. IDB data that has timestamps earlier than the ETL start date is never extracted. | The option is used only when Job_InitializeGIM initializes the database. If the etl-start-date option is not specified, the earliest starting point for Genesys Info Mart processing is IDB data that has timestamps 30 days prior to the Info Mart database initialization. The main purpose of the option is to pre-empt performance and maintenance issues when Genesys Info Mart is introduced into a deployment with much older existing IDB data. Specifying the ETL start date enables users to:
Genesys Info Mart ignores this option value for Configuration details; after the database has been initialized or re-initialized, Genesys Info Mart extracts all cfg data going back as far as 2010, regardless of the value of etl-start-date. |
|||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | etl-start-time | 00:00 | 00:00-23:59 | Specifies the time of day, in 24-hour format, when the first ETL cycle starts running. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | export-schedule | 0/30 | A valid CRON expression | Defines the time intervals at which Job_ExportGIM runs. The job starts and runs periodically in accordance with this schedule when the run-export option is set to true. By default, the job runs at 00:20, 08:20, and 16:20 every day. | The default schedule, run in conjunction with the default chunk-size-seconds option in the [gim-export] section, is designed to keep daily disruptions or delays from carrying over to the next day.Job_ExportGIM can run in conjunction with the ETL jobs, but not in conjunction with Job_MaintainGIM. 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 following special characters are allowed in the CRON expression:
|
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | first-day-of-week | 1 | 1-7 (Sunday-Saturday) | Specifies the day of the week that is considered to be the start of the week. For example, 1 (Sunday) is usually the first day of the week in the United States; for countries that use the ISO 8601 standard, 2 (Monday) is the first day of the week. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | fiscal-year-end | Any valid combination of month and day, in M-d format. | Specifies the month and day that the fiscal year ends. For example, 1-31 means January 31; 11-30 means November 30. Set either this value, or fiscal-year-start, but not both. | For example, to have calendar date 2022-11-01 in fiscal year 2023, set no value for fiscal-year-start, and set fiscal-year-end=10-31. This option requires that fiscal-year-week-pattern be set to a valid pattern. |
|||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | fiscal-year-start | Any valid combination of month and day, in M-d format | Specifies the month and day that the fiscal year starts. For example, 1-1 means January 1; 10-1 means October 1. Set either this value, or fiscal-year-end, but not both. | If simple-week-numbering=true, every fiscal year starts on the fixed date that is specified by this option. If simple-week-numbering=false, the fiscal year starts on the first day of the week that contains the date that is specified by this option; however, the actual start date depends on the value of the first-day-of-week option. Genesys Info Mart adjusts automatically for the floating fiscal year. For example, if simple-week-numbering=false, fiscal-year-start=3-1, and first-day-of-week=1, then:
This option requires that fiscal-year-week-pattern be set to a valid pattern. |
|||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | fiscal-year-week-pattern | none | none, 544, 454, 445 | Specifies the pattern for the number of weeks in each month of a fiscal quarter. For example, 544 means 5 weeks in the first month, 4 weeks in the second month, and 4 weeks in the third month of each quarter. A value of none means that the calendar is not a fiscal one. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | level | info | debug, info, warn, error, none, all, off | Determines whether local logging is enabled, and specifies the minimum level of events to log. The DEBUG, INFO and WARN values correspond to the Genesys Management Layer DEBUG, TRACE, and STANDARD logging values, respectively. |
|||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | maintain-start-time | 23:40 | 00:00-23:59 | Specifies the time of day, in 24-hour format, when Job_MaintainGIM is started. This job is scheduled to start at this time when the run-maintain option is set to TRUE. The value that you specify must be outside the range that is specified by etl-start-time and etl-end-time. Tip If the time of day that is represented by the new value has already passed, the new value is applied to the following day. |
|||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | max-chunks-per-job | 10 | 1-100 | Specifies the number of extracted data chunks that the transformation job processes in one ETL cycle. As long as it seems practical from the performance perspective, increase the option value to transform a larger amount of data in a single cycle. | In deployments using the Data Export feature, the option also controls the maximum number of export chunks that can be created by the export job during each job run. In situations where the time range to be exported exceeds the export chunk size (for example, if there is a backlog because data is being re-exported), a larger number of export chunks reduces the time required to process a large export backlog. | ||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | max-retries | 3 | Any non-negative integer | Specifies the maximum numbers of retries the job does in the case of intermittent failures before failing the job. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | max-time-deviation | 30 | 1-120 | Specifies the maximum time deviation, in seconds, to consider for time synchronization inaccuracy between host-system clocks. This option also specifies the maximum acceptable delay the transformation job accommodates in scenarios in which ICON creates delayed records in the GM_F_USERDATA table in IDB. | If the maximum time deviation or delay is exceeded, Genesys Info Mart results become unreliable. Genesys recommends the following relationship between the value of this option and the Advanced Disconnect Detection Protocol (ADDP) timeout, which is the Local Timeout parameter configured for ADDP connections to data sources on the Connections tab of the ICON Application: [(ADDP Local Timeout) * 2] + (actual maximum difference in time synchronization between hosts) <= max-time-deviation In HA deployments, Genesys Info Mart uses max-time-deviation for reliable analysis of the “no data” information in IDB; (NoData – max-time-deviation) is considered to be reliable for all data sources for a particular ICON provider. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | memory-threshold | 0 | 0-99 | Specifies the percentage of available memory that must be exceeded before Genesys Info Mart logs a message (55-20101) that indicates that the memory threshold has been exceeded. If the value of this option is 0, the feature is disabled. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | min-days-in-first-week | 1 | 1-6 | Specifies the minimum number of days from the new year that must be in the first week of the year, if simple week numbering is not used and there are no partial weeks in the calendar year. The ISO 8601 standard does not use simple week numbering. | The ISO 8601 definition of the first week in the year is the week that has the first Thursday in it. To conform to the ISO 8601 standard, set simple-week-numbering=false, first-day-of-week=2, and min-days-in-first-week=4. For example, if simple-week-numbering=false, first-day-of-week=2, and January 1 of the new year is on a Friday, there are 3 days from the new year in the week that starts on Monday, December 28. Therefore:
|
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | on-demand-migration | true | true, false | Controls whether Genesys Info Mart runs Job_MigrateGIM automatically if the Info Mart database schema is not up to date following migration of the Info Mart server.
Important Genesys does not recommend enabling migration on demand unless policies and procedures are in place to ensure that essential pre-migration and post-migration steps are also performed without manual intervention — for example, frequent database backup and re-creation of read-only views following migration. |
The value of false preserves previous Genesys Info Mart behavior, which requires you to run Job_MigrateGIM manually before ETL functioning resumes if Genesys Info Mart has entered the migration state. Enabling on-demand migration is suitable only if you always want to apply schema updates immediately, without review and without controlling the timing of the schema update or required system preparation. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | output-directory | gim-export | Valid directory path (might not exist) | Specifies the directory where exported files are stored. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | output-files-encoding | utf8 | Character encoding supported by Java | Specifies the character encoding for exported files. For Java-supported encodings, see Supported Encodings. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | partitioning-ahead-range | 31 | Any positive integer | Specifies, in terms of number of days, how far ahead Job_InitializeGIM (in the first instance) and Job_MaintainGIM (on an ongoing basis) create partitions for GIDB, Control, and Info Mart fact tables that are partitioned. These jobs add partitions for the number of days ahead of the time that the job is running. (Job_InitializeGIM also adds partitions from etl-start-date up to the time that the job is running.) The number of partitions that Job_MaintainGIM actually creates during each run depends on the partition sizes and the job frequency. | ExampleIf partitioning-interval-size-gidb=86400 (one day), partitioning-interval-size-gim=604800 (one week), and partitioning-ahead-range=14, Job_MaintainGIM creates as many other partitions as necessary to provide partitions for GIDB, Control, and Info Mart fact tables up to 14 days ahead. If Job_MaintainGIM runs daily, then:
To guarantee that partitions are always available for use by the ETL, ensure that run-scheduler is set to true (the default value). This option applies only in deployments that use partitioning. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | partitioning-interval-size-gidb | 604800 | Any positive integer | Specifies the size of partitions, in seconds, for GIDB tables that are partitioned. Job_MaintainGIM creates partitions of the specified size in the Info Mart database in preparation for future ETL cycles. The default size of GIDB table partitions is 24 hours (86400 seconds). | In PostgreSQL deployments, Genesys recommends setting the size of GIDB table partitions to one week (604800 seconds). This option applies only in deployments that use partitioning. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | partitioning-interval-size-gidb-mm | 604800 | Any positive integer | Specifies the size of partitions, in seconds, for partitioned GIDB tables that store multimedia interaction data. When this option is set, Job_MaintainGIM creates partitions of the specified size in the Info Mart database in preparation for future ETL cycles. If the option is not specified, the value of partitioning-interval-size-gidb, which has a default value of 24 hours (86400 seconds), is used. | Genesys recommends increasing the size of GIDB partitions for multimedia interactions, which typically live longer than voice interactions but generate a smaller volume of data. In PostgreSQL deployments, Genesys recommends setting the size of GIDB table partitions to one week (604800 seconds). Transformation performance is optimal when partitions are large enough that data that is being actively used is in the fewest number of partitions, and the partitions are small enough that their indexes can fit into the cache. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | partitioning-interval-size-gidb-ocs | 604800 | Any positive integer | Specifies the size of partitions, in seconds, for partitioned GIDB tables that store Outbound Contact–related data. When this option is set, Job_MaintainGIM creates partitions of the specified size in the Info Mart database in preparation for future ETL cycles. If the option is not specified, the value of partitioning-interval-size-gidb, which has a default value of 24 hours (86400 seconds), is used. | In PostgreSQL deployments, Genesys recommends setting the size of GIDB table partitions to one week (604800 seconds). Transformation performance is optimal when partitions are large enough that data that is being actively used is in the fewest number of partitions, but small enough that their indexes can fit into the cache. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | partitioning-interval-size-gim | 2592000 | Any positive integer | Specifies the size of partitions, in seconds, for Info Mart fact and Control tables that are partitioned. Job_MaintainGIM creates partitions of the specified size in the Info Mart database in preparation for future ETL cycles. | In PostgreSQL deployments, the recommended size of partitions for dimensional-model data depends on your plans for data retention in the Info Mart database. For PostgreSQL, Genesys recommends setting the size of fact table partitions to:
This option applies only in deployments that use partitioning. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | purge-thread-pool-size | 32 | Any positive integer | Specifies the maximum number of concurrent purging transactions. The optimum value for this option depends on the characteristics and capacity of your deployment. Consider increasing the value of this option if you think that there is scope to improve performance of the purge operation. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | purge-transaction-size | 100000 | Any positive integer | Specifies the number of deleted records per table that are committed in a single transaction. | For example:
|
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | retry-delay-seconds | 30 | Any non-negative integer | Specifies the amount of time, in seconds, that the job waits (in the case of intermittent failure) before attempting to run again. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | run-aggregates | true | true, false | Specifies whether the scheduler manages the aggregation job, to run the aggregation engine inside the Genesys Info Mart process. |
For example, if run-aggregates=true, aggregate-schedule=0 1, and aggregate-duration=05:00, the aggregation job runs continuously between 01:00 AM and 06:00 AM daily. The scheduler does not allow you to launch a second instance of Job_AggregateGIM manually from the management GUI (Genesys Info Mart Manager or the Genesys Info Mart Administration Console) within that time period. Furthermore, if you try to launch an instance of Job_AggregateGIM manually from the management GUI outside that time period (for example, at 08:00 AM), the scheduler identifies that the job is not supposed to be running at that time and stops it. If you want to run Job_AggregateGIM manually from the management GUI outside the scheduled times, you must first set run-aggregates to false. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | run-export | true | true, false | Specifies whether Job_ExportGIM runs. When the value of this option is set to true, the scheduler starts and runs the job at the time and intervals specified by the export-schedule option. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | run-maintain | true | true, false | Specifies whether to run Job_MaintainGIM at the scheduled time, as specified by the maintain-start-time option. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | run-scheduler | true | true, false | Specifies whether to stop or start the scheduler. If the value of this option was set to TRUEso that the scheduler is scheduling jobs, and you change the value of this option to FALSE, the scheduler pauses, with no effect on any jobs that might already be running. If you then reset the value to TRUE, the scheduler resumes at the point at which it stopped. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | run-update-stats | true | true, false | Specifies whether Job_UpdateStats runs in PostgreSQL deployments, at the time and intervals specified by the update-stats-schedule option. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | says-to-keep-discards-and-job-history | 60 | Any positive integer | Specifies the number of days to retain data in the discard tables and audit and history tables. | The discard tables are Staging tables that store operational data that the transformation job was unable to process—for example, voice interaction data with unresolved IS-Links, or Configuration details records with missing configuration objects. The audit and history tables are Control tables that store information about data lineage and about ETL processing activity. Information in the discard, audit, and history tables is useful for troubleshooting. Records in the discard, audit, and history tables are purged based on the timestamp of the ETL processing event—ETL_TS for the discard (Staging) tables and CREATED_TS for the audit and history (Control) tables. For example, if Job_MaintainGIM is running on August 23, 2022 (day 235 of the year) and days-to-keep-discards-and-job-history=600, Job_MaintainGIM purges all records in the discard, audit, and history tables that were written by instances of the ETL jobs that ran before January 1, 2021 (day 1 of the previous year). |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | simple-week-numbering | true | Specifies whether the calendar year and the week-numbering year coincide. | For simple week numbering, Week 1 always begins on the first day of the calendar year (for Gregorian calendars, January 1; for fiscal calendars, the day that is specified in the fiscal-year-start option). As a result, the first and last weeks of the year might be partial weeks, because the first week does not necessarily start with the day that is specified by the first-day-of-week option. To comply with ISO 8601 week numbering, set the value of this option to false. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | start-date | Any date after 1970 in the format yyyy-mm-dd hh:mm:ss | Specifies the earliest date for which Job_ExportGIM exports data, and then continues with incremental exports. If no date is specified (the default), Job_ExportGIM starts exporting from the beginning of the Info Mart data. Requires that the value of days-to-keep-discards-and-job-history is greater than or equal to the value of days-to-keep-gim-facts. |
|
|||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | thread-pool-size | 10 | Any positive integer | Specifies the maximum number of worker threads that are used to export data concurrently. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | timezone | UTC | Specifies the time zone in which the schedule is defined. Internally, Genesys Info Mart maintains the schedule in UTC time. For convenience, you can use this option to specify a local time zone that makes it easier for you to plan and manage the schedule. You can use any valid time zone that is supported by the version of the JRE that runs the Genesys Info Mart Server. | For more information about supported time zones, see the documentation about calendar time zones on the Java developer website or other public resources. For sample reference sites, see the description of the date-time-tz option. | |||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | update-stats-schedule | 0/10 | A valid CRON expression | Defines the time intervals at which Job_UpdateStats runs. The job starts and then runs periodically in accordance with this schedule. By default, the job runs every 10 minutes throughout the day. Job_UpdateStats can run in conjunction with the ETL jobs, but not in conjunction with Job_MaintainGIM. | The schedule is defined in the format of a CRON expression that represents a set. The expression comprises two fields, which are separated by white space:
The following special characters are allowed in the CRON expression:
The schedule that you configure for Job_UpdateStats does not need to specifically allow for a maintenance window: A running instance of Job_UpdateStats does not prevent Job_MaintainGIM from starting, and once Job_MaintainGIM has started as part of the schedule, the scheduler suspends the schedule for Job_UpdateStats until Job_MaintainGIM finishes. For values that illustrate sample schedules, see the examples for the aggregate-schedule option. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GIMConfigOptions | use-export-views | true | true, false | Controls whether Genesys Info Mart exports data using export views, which represent a snapshot of the Info Mart schema at the time the export views were created.
|
|||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | adjust-vq-time-by-strategy-time | false | true, false | standard | Specifies whether GSP adjusts the mediation duration in mediation segment facts (MSFs) for virtual queues to include time spent in strategies but not in associated virtual queues — for example, if an interaction spends 3 minutes in a strategy and is in a virtual queue for 2 of those minutes, whether the MSF for the virtual queue reports the duration as 3 minutes or 2 minutes.
|
In digital scenarios in which an interaction is bounced between a mediation resource (for example, an Interaction Queue or a Workbin) and a strategy as the strategy repeatedly retries busy agents, this option comes into effect only for the virtual queue that is associated with the last strategy party, before the interaction is routed successfully or else terminated. Genesys Info Mart does not report on virtual-queue activity that overlaps the repeated interim mediations. | |||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | canceled-queues | iWD_Canceled | A comma-separated list of queue names | standard | In digital deployments that use archive queues in their business processes, specifies the Interaction Queues that are used as archives for canceled interactions. When an interaction is placed into one of these queues, GSP considers the interaction to be terminated. The transformation job assigns the technical result/reason combination of COMPLETED/CANCELED in the IRF of the handling resource that placed the interaction in the queue, and GSP excludes the interaction from further processing. | The option parallels the completed-queues configuration option available in Interaction Server. The default value of the GSP option matches the archive queue for canceled interactions in the default business process for the Genesys intelligent Workload Distribution (iWD) solution. | |||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | completed-queues | iWD_Completed | A comma-separated list of queue names | standard | In digital deployments that use archive queues in their business processes, specifies the Interaction Queues that are used as archives for completed interactions. When an interaction is placed into one of these queues, GSP considers the interaction to be terminated. The transformation job assigns the technical result/reason combination of COMPLETED/ARCHIVED in the IRF of the handling resource that placed the interaction in the queue, and GSP excludes the interaction from further processing. | The option parallels the completed-queues configuration option available in Interaction Server. The default value of the GSP option matches the archive queue for completed interactions in the default business process for the Genesys iWD solution. | |||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | interaction-type-ignore-list | InboundReport, InboundDisposition | A comma-separated list of interaction types | standard | In digital deployments, specifies the interaction types or subtypes you want to exclude from reporting. GSP does not transform any interactions with the interaction type(s) or subtype(s) you specify. No records are generated in fact tables for interactions of this type. If you disable a subtype, the parent interactions of that subtype as well as any child interactions of those parent interactions are disabled, even if the child interactions themselves are of a different subtype, one that is configured to be transformed. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | max-ixn-duration-days | 30 | Any positive integer | standard | Specifies the maximum duration, in days, of interactions in the deployed environment. For long-living digital interactions, specifies the maximum number of days to process active interactions, after which the interactions become eligible for artificial termination. Consider using a value that is consistent with the value of the option days-to-keep-active-facts. |
Artificial termination of long-living interactionsThis functionality is intended primarily to prevent problems with aggregation — for example, when updates to long-living digital interactions trigger unnecessary re-aggregation, which results in overflow errors. If an interaction is still active when the max-ixn-duration-days period expires, the transformation job terminates the interaction artificially in fact tables. Any activity that is related to this interaction that occurs after termination is discarded. |
|||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | max-msfs-per-irf | 50 | 10-10000 | standard | Specifies the maximum number of MSF records associated with a given digital interaction that are represented in the Info Mart database. When the number of MSF records associated with a single IRF record exceeds the limit, the transformation job processes only the first n mediation DNs and the last n mediation DNs in the interaction, where n = max-msfs-per-irf/2. In this way, ETL performance avoids being degraded by huge numbers of MSF records for unsuccessful routing attempts for "stuck strategy" scenarios. | The first n mediation records for a given interaction are processed by the transformation job and populated in the MSF table as they occur. The last n records are postponed until an associated IRF record has been created. The option does not affect the mediation durations that are reported in the IRF (QUEUE_DURATION, ROUTING_POINT_DURATION, MEDIATION_DURATION, and PREVIOUS_MEDIATION_DURATION); all these metrics correctly report the full overall mediation time. Log message number 55-20120 is generated when the max-msfs-per-irf limit is exceeded, triggering the behavior to abbreviate the representation of unsuccessful routing attempts in the Info Mart database. You can set an alarm on the log message, to prompt you to investigate strategies that might be inappropriate for your deployment. |
|||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | populate-ixnqueue-facts | true | true, false | standard • script: standard | Enables or disables the population of digital Interaction Queue activity to the MSF table. GSP uses the value configured at the standard level for all configured Interaction Queues, but you can override that value for specific Interaction Queues by configuring a different value for those Interaction Queues at the script: standard level.
GSP always creates an MSF record for the first Interaction Queue that an inbound interaction enters, regardless of the setting of this option. |
Strategy time is not included in the mediation duration, with the following exceptions:
Tip Ideally, set populate-ixnqueue-facts to true only for Interaction Queues for which mediation reporting is meaningful, so that the MSF table does not become cluttered with unnecessary information. Some Interaction Queues are not useful for reporting, such as the Interaction Queues that are associated with Interaction Workbin objects only through a configured Interaction Queue View. |
|||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | populate-workbin-as-hold | true | true, false | standard | Specifies whether the time that an interaction is in an Interaction Workbin is considered to be hold time or mediation.
|
For time in an Interaction Workbin to be considered hold time, the Agent or Place resource must place the interaction into its own personal workbin. For example, if Agent1 places an email interaction into its personal workbin, the workbin time is considered to be hold; however, if another resource, such as another agent or a strategy, places the interaction into the workbin for Agent1 to handle, the workbin time is not considered to be hold. If a handling resource places an interaction into more than one of its own personal workbins, all of the personal workbin time is considered to be hold, and there is no distinction between the hold time in the various workbins. For example, if Agent1 places an email interaction into a Drafts workbin, then pulls the interaction to continue handling it and subsequently places it into a FollowUp workbin, the hold duration that is reported in the IRF record for Agent1’s association with the interaction combines the time that is spent in both workbins. The following table summarizes the results of different permutations of the populate-workbin-as-hold and populate-workbin-facts options, in combination with the specifics of the interaction flow. If the values of the populate-workbin-as-hold and populate-workbin-facts options are both set to false, the workbin activity is not represented in the dimensional model.
|
|||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | populate-workbin-facts | true | true, false | standard • script: standard | Enables or disables the population of digital Interaction Workbin activity to the MSF table. For workbins that are associated with handling resources of type Agent or Place, this option comes into effect only if GSP has not been configured to consider workbin time as hold (populate-workbin-as-hold=false). For the circumstances under which GSP considers workbin time as hold, see the description of the populate-workbin-as-hold option. GSP uses the value configured at the standard level for all configured Interaction Workbins, but you can override that value for specific Interaction Workbins by configuring a different value for those Interaction Workbins at the script: standard level. |
|
|||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | q-answer-threshold | 60 | 1-600000 for digital, 1-10000 for voice. | media • dn: media • script: media | Specifies the default duration, in seconds, that is used on all configured queues as a target time to accept an interaction that entered a queue. You can configure a different threshold for each media type. GSP uses the value configured at the media level for all configured queues, but you can override the value for interactions of that media type that come through particular virtual queues, digital interaction queues, or workbins by configuring a different value:
|
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | q-short-abandoned-threshold | 10 | 1-1000 | media • dn: media • script: media | Specifies the maximum duration of mediation, in seconds, that is used on all configured queues to indicate that an interaction that was abandoned while in a queue should be considered a “short” abandon. GSP uses this value to determine the state of SHORT_ABANDONED_FLAG in the MSF row for an interaction abandoned in a queue. You can configure a different threshold for each media type. GSP uses the value configured at the media level for all configured queues, but you can override the value for interactions of that media type that come through particular virtual queues, digital interaction queues, or workbins by configuring a different value:
|
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | short-abandoned-threshold | 10 | 0-100 | media | Specifies the minimum duration, in seconds, of an abandoned interaction in order for it to be considered truly abandoned. GSP uses this value to determine the state of SHORT_ABANDONED_FLAG in the IRF row. You can configure a different threshold for each media type. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | show-non-queue-mediation | false | true, false | standard | Controls whether all mediation time for digital interactions, even mediation time that does not occur within a queue, is represented by an MSF.
For digital interactions, mediation that occurs in a virtual queue is always represented in Genesys Info Mart by an MSF. However, depending on the setting for populate-ixnqueue-facts, mediation that occurs in an Interaction Queue might not be represented by an MSF; in fact, often it is not. When show-non-queue-mediation is set to true, the additional MSFs that are created occur between MSFs for Interaction Queues (in other words, when an interaction moves during mediation from one Interaction Queue that is represented by an MSF to another that is represented by an MSF), or between the MSF for an Interaction Queue and a routing target (agent). The additional, non-queue MSFs may overlap with MSFs for virtual queues, since an interaction may also be in a virtual queue for some (or all) of the mediation time that occurs outside of an Interaction Queue MSF. Furthermore, the additional MSFs may include time that the interaction spent in Interaction Queues that are not represented by an MSF. ExampleConsider the scenario in which a digital interaction enters the contact center at time t0 and, after mediation involving various queues and routing strategies, is routed for handling at time t4. Following first handling, there is additional mediation before the interaction is routed for further handling. The following table summarizes the mediation reporting results, depending on configuration option settings.
Important There are other scenarios, not controlled by this option, where non-queue time might be incorporated into an MSF for a queue, such as when a digital interaction bounces back and forth between the same queue and a strategy. In such cases, the repeated bounce-backs are collapsed into a single MSF, which might include non-queue time when the routing strategy was attempting to find a routing target before returning the interaction to the same queue. For more information, see the description of the MEDIATION_DURATION field in Populating mediation segments. |
||||||||||||||||||||||||
Draft:PEC-REP/Current/GIMPEGuide/GSPConfigOptions | stop-ixn-queues | No default value | A comma-separated list of queue names | standard | In digital deployments that use stop-interaction queues in their business processes, this option specifies the Interaction Queues that are used to handle stopping an interaction (for example, Twitter_StopIxn). When an interaction is placed into one of these queues, GSP considers the interaction to be terminated:
|
If you do not specify a value for this option, GSP handles these situations as transfers to a queue. | |||||||||||||||||||||||
PEC-AD/Current/WWEPEGuide/RichMessage | chat-nexus.service-url | "" | A valid web-socket URL. | Agent • Agent Group | Specifies the web-socket url of the Nexus service url to access the Chat API. | 9.0.000.97 | |||||||||||||||||||||||
PEC-AD/Current/WWEPEGuide/RichMessage | chat-nexus.web-components.url | "" | A valid web-socket URL | Agent • Agent Group | Specifies the Nexus-ux WebComponents url to display the nexus-ux view. Use this option if the URL is different from the standard URL. | 9.0.000.97 | |||||||||||||||||||||||
PEC-AD/Current/WWEPEGuide/RichMessage | privilege.chat-nexus.can-use | false | true, false | Agent • Agent Group | Enables agents to access the contents of the Digital Channels Conversation tab in the Agent Workspace Case Side View of the Chat interaction view. | 9.0.000.97 | |||||||||||||||||||||||
PEC-AD/Current/WWEPEGuide/RichMessage | privilege.chat-nexus.can-use-contact-history-detail | false | true, false | Agent • Agent Group | Enables agents to access Digital Channels chat interaction Rich Message content in the Details tab of the Contact History view. | 9.0.000.97 | |||||||||||||||||||||||
PEC-AD/Current/WWEPEGuide/RichMessage | privilege.chat-nexus.communication.can-send | false | true, false | Agent • Agent Group | Enables agents to manage contact subscriptions and send messages to contacts from the Communication tab. | 9.0.000.97 | |||||||||||||||||||||||
PEC-AD/Current/WWEPEGuide/RichMessage | privilege.chat-nexus.communication.can-use | false | true, false | AGent • Agent Group | Enables agents to manage contact subscriptions and send messages to contacts from the Communication tab. | ||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | aggregate-duration | 23:00 | 00:00-24:00 | Specifies the amount of time, in 24-hour format, that Job_AggregateGIM runs after it is launched. When the run-aggregates option is set to TRUE, the scheduler stops 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. | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | aggregate-schedule | 30 0 | A valid CRON expression | Specifies the daily schedule for Job_AggregateGIM to start. The job starts 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 runs 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 following special characters are allowed in the CRON expression:
ExamplesThe following values for aggregate-schedule illustrate sample schedules:
Genesys recommends against configuring a schedule that has the aggregation job running in a series of short bursts—for example, aggregate-schedule=30 * and aggregate-duration=00:15. When the time specified by aggregate-duration expires, the scheduler immediately stops the aggregation job, even if it is in the middle of processing a batch of data. If you want Job_AggregateGIM to run continuously for 24 hours a day, without any breaks for maintenance activities (which is not recommended), set aggregate-schedule=0 0 and aggregate-duration=24:00. |
||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | appender.ConsoleLogger.Threshold | info | trace, debug, info, warn, error, all, off | For information about this option, refer to the Apache logging site: http://logging.apache.org/index.html | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | chunk-size-seconds | 86400 | Any positive integer | Specifies the size of the time interval, in seconds, for which data is exported in each job. | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | console-pattern-layout | %d{ISO8601} %-5p %-12t %m%n | Any valid pattern string | For information about this option, refer to the Apache logging site: http://logging.apache.org/index.html | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | date-time-max-days-ahead | 400 | Any positive integer | Specifies, in number of days, how far ahead the calendar dimension table is populated. The default value specifies that the calendar dimension is populated up to a year in advance (365 days + 1 day for leap years). Genesys does not recommend that you populate the calendar tables more than a year in advance, in case there are changes to DST or other international time standards that might invalidate the prepopulated data. | Note: Ensure that you populate the calendar far enough ahead to meet the requirements of your reporting intervals. | ||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | date-time-min-days-ahead | 183 | Any positive integer | Specifies, in number of days that remain in the prepopulated calendar, when the calendar table is updated with the next batch of days ahead. The default value specifies that the maintenance job updates this calendar approximately 6 months before it expires. | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | date-time-start-year | 2020 | 1970-2038 | Specifies the year that the calendar starts. When you are setting this option, ensure that you choose a start year that provides sufficient buffer to prevent inconsistencies or unexpected missing dimensions around the start of the calendar. Genesys recommends that you set the value so that the calendar starts at least one year prior to any date that might be encountered in the data. Be aware that Genesys Info Mart uses GMT for internal time references, and this affects exactly when the calendar starts. | For example, if the other [date-time] options that affect the start date are set so that the calendar starts at 00:00 AM on January 1, 2022, and the date-time-tz option is set to Eastern European Time (GMT + 2), the calendar table is populated with dimensions starting at 02:00 AM on January 1, 2022. | ||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | date-time-tz | GMT | Any valid Java time zone | Specifies the time zone for the calendar. You can use any valid time zone that is supported by the version of the Java Runtime Environment (JRE) that runs the Genesys Info Mart Server. For more information about supported time zones, see the documentation about calendar time zones on the Java developer website or other public resources. | Sample public resources:
Important Particularly in deployments that use GCXI or RAA, ensure that the time zone is set appropriately for your deployment before you initialize Genesys Info Mart or before aggregation starts. |
||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-active-facts | 27 | Any positive integer | Specifies the maximum number of days to retain active multimedia interactions in GIDB and the dimensional model, including certain Staging tables, after which the interactions become eligible for purging. Depends on the value of days-to-keep-gim-facts. | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-deleted-annex | 2 | Any positive integer | Specifies the number of days to retain deleted records in the *_ANNEX dimension tables. | The default value of days-to-keep-deleted-annex is small, because there is likely little reason to retain deleted data for significant periods of time. The major reason that Genesys Info Mart provides *_ANNEX data is to support GCXI visibility controls, and GCXI uses only active *_ANNEX data for this purpose. For example, with the default value (2 days), if Job_MaintainGIM is running on September 4, 2022, the job purges *_ANNEX records that terminated (in other words, the configuration setting on the object’s Annex tab was deleted) before September 2, 2022. |
||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-gidb-facts | 27 | Any positive integer | Specifies the number of days to retain fact data in GIDB. Facts that have a start time that is earlier than the retention period are eligible to be purged. Related Options: days-to-keep-active-facts | The retention period for multimedia facts in GIDB is determined solely by the value of days-to-keep-gidb-facts. Genesys expects the value of days-to-keep-gidb-facts to be less than 30. Although many GIDB tables contain personally identifiable information (PII), Genesys Info Mart does not include most GIDB tables in General Data Protection Regulation (GDPR) processing. |
||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-gim-facts | 400 | Any positive integer | Specifies the number of days to retain fact data in the dimensional model. Facts that have a start time that is earlier than the retention period are eligible to be purged. Job_MaintainGIM does not purge active fact data, dimension data, or aggregate tables (if aggregation is enabled). Genesys Info Mart enforces that the value of days-to-keep-active-facts' be less than the value of days-to-keep-gim-facts and days-to-keep-gidb-facts be less than the value of days-to-keep-gim-facts. | Genesys Info Mart does not enforce a limit on the length of the retention period. However, Genesys strongly recommends against setting days-to-keep-gim-facts, and likewise days-to-keep-active-facts, to an excessively large value (for example, thousands of days). To avoid performance issues or job failures when Genesys Info Mart operates against an excessively large Info Mart database, be realistic about your requirements and available database resources, and apply best practices and recommendations from your RDBMS vendor. If you choose a very long retention period, you must carefully choose and tune the storage used for the Info Mart database; also carefully consider settings for partition size and other database- and performance-related configuration options, as well as parameters on the RDBMS side. By definition, all voice interaction data in the dimensional model relates to completed interactions. How Purge Options WorkTo illustrate how various days-to-keep-* options combine to determine when data is purged, the following tables provide examples of different scenarios for GIDB and the dimensional model, respectively. Purge examples
|
||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | days-to-keep-output-files | 30 | Any positive integer | Specifies how many days to store exported files before deleting them. | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | etl-end-time | 23:30 | 00:00-23:59 | Specifies the time of day, in 24-hour format, when the last ETL cycle can start running. If the value that you specify is before the ETL start time, the end time is for the next day (past midnight). If etl-start-time=etl-end-time, the ETL cycle runs continuously. |
Ensure that you configure etl-start-time and etl-end-time so that there is sufficient time for the last ETL cycle of the day to complete and for Job_MaintainGIM to run (see the maintain-start-time option), before the start of the first ETL cycle of the next day. | ||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | etl-frequency | 1 | 0-1440 | Specifies the number of minutes that pass between the start times of each ETL cycle. If the amount of time that it takes to complete a cycle is shorter than the specified value, the next cycle is delayed until the time elapses. If the amount of time that it takes to complete a cycle is longer than the specified value, the next cycle is started immediately. | The ETL frequency must not be greater than the chunk size for data extraction, as specified by the extract-data-chunk-size option. Otherwise, Genesys Info Mart can not keep pace with ICON. When it checks the deployment, Genesys Info Mart verifies the internal consistency between the ETL frequency and extraction chunk size. By default, the value of etl-frequency is much smaller than the value of extract-data-chunk-size. Genesys recommends that you retain this relationship, to minimize data latency. For example, say that extract-data-chunk-size=900 (15 minutes), etl-frequency=1, and all data from the last chunk has been processed; when the next ETL cycle starts 1 minute later, there is only 1 minute’s worth of new data, and this can be processed very quickly. Alternatively, if there is a backlog of data, and it takes less than 15 minutes to process a 15-minute chunk, the next ETL cycle starts almost immediately, to continue catching up. |
||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | etl-start-date | Any date after 1970 in the format yyyy-mm-dd hh:mm:ss | Specifies the earliest date for which Genesys Info Mart considers IDB data for extraction in a new deployment or when the Info Mart database is re-initialized. IDB data that has timestamps earlier than the ETL start date is never extracted. | The option is used only when Job_InitializeGIM initializes the database. If the etl-start-date option is not specified, the earliest starting point for Genesys Info Mart processing is IDB data that has timestamps 30 days prior to the Info Mart database initialization. The main purpose of the option is to pre-empt performance and maintenance issues when Genesys Info Mart is introduced into a deployment with much older existing IDB data. Specifying the ETL start date enables users to:
Genesys Info Mart ignores this option value for Configuration details; after the database has been initialized or re-initialized, Genesys Info Mart extracts all cfg data going back as far as 2010, regardless of the value of etl-start-date. |
|||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | etl-start-time | 00:00 | 00:00-23:59 | Specifies the time of day, in 24-hour format, when the first ETL cycle starts running. | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | export-schedule | 0/30 | A valid CRON expression | Defines the time intervals at which Job_ExportGIM runs. The job starts and runs periodically in accordance with this schedule when the run-export option is set to true. By default, the job runs at 00:20, 08:20, and 16:20 every day. | The default schedule, run in conjunction with the default chunk-size-seconds option in the [gim-export] section, is designed to keep daily disruptions or delays from carrying over to the next day.Job_ExportGIM can run in conjunction with the ETL jobs, but not in conjunction with Job_MaintainGIM. 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 following special characters are allowed in the CRON expression:
|
||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | first-day-of-week | 1 | 1-7 (Sunday-Saturday) | Specifies the day of the week that is considered to be the start of the week. For example, 1 (Sunday) is usually the first day of the week in the United States; for countries that use the ISO 8601 standard, 2 (Monday) is the first day of the week. | |||||||||||||||||||||||||
PEC-REP/Current/GIMPEGuide/GIMConfigOptions | fiscal-year-end | Any valid combination of month and day, in M-d format. | Specifies the month and day that the fiscal year ends. For example, 1-31 means January 31; 11-30 means November 30. Set either this value, or fiscal-year-start, but not both. | For example, to have calendar date 2022-11-01 in fiscal year 2023, set no value for fiscal-year-start, and set fiscal-year-end=10-31. This option requires that fiscal-year-week-pattern be set to a valid pattern. |