Jump to: navigation, search

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>)))

more...

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>
more...

geo-location

Section: gim-etl
Default Value: “”
Valid Values: Any string
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.
Introduced: 8.1.2

On the extraction DAP, specifies the location of the IDB. On the Info Mart DAP, specifies the location of the Info Mart database. Genesys Info Mart compares the string value of the option on the Info Mart DAP against the value of the geo-location option in redundant extraction DAPs. If the values are the same, the IDB for which the extraction DAP provides the connection information is considered to be local; if the values are not the same, the IDB is considered to be remote.

In an HA environment, Genesys Info Mart uses geolocation as a tie-breaker to determine the best IDB from which to extract data: If data-quality criteria do not identify one IDB as the best, Genesys Info Mart gives preference to the local IDB.

more...

default-schema

Section: gim-etl
Default Value: No default value
Valid Values: Any valid database owner or schema name
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 the database schema or owner name, if it is different from the database user ID. If you do not specify this option, the database tables and other database objects are assumed to be owned by the user name that you specify on the DB Info tab.

Note for PostgreSQL: Genesys recommends that you use lower case for all schema names. If you cannot do so, specify the value in case-sensitive mode by surrounding the value with a set of double quotes.

role

Section: gim-etl
Default Value: No default value
Valid Values: ICON_CFG, ICON_CORE, ICON_MM, ICON_OCS, INFO_MART
Changes Take Effect: For an extraction DAP, the next time that extraction jobs are launched; for the Info Mart DAP, on restart of the Genesys Info Mart Server.


Extraction DAPs

Specifies which data domain Genesys Info Mart will extract through the DAP:

  • ICON_CFG — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Configuration details. This role must be associated with one and only one DAP, or with redundant DAPs that constitute one HA set.
  • ICON_CORE — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Voice details, including agent activity details. This role is optional, but you need at least one DAP with a role of ICON_CORE or ICON_MM.
  • ICON_MM — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Multimedia details, including agent activity details. This role is optional, but you need at least one DAP with a role of ICON_CORE or ICON_MM.
    Warning
    You cannot reconfigure the DAP role from ICON_CORE to ICON_MM, or vice versa, once data extraction occurs.
  • ICON_OCS — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Outbound Contact details.
  • For the supported topologies that combine data domains (see Interaction Concentrator Topologies in the Genesys Info Mart Deployment Guide), specify all the applicable roles, separated by commas — for example: ICON_CFG,ICON_CORE,ICON_OCS.
Important
Ensure that the extraction role you specify is consistent with the role that is specified for ICON (in the [callconcentrator] section in both the ICON application and DAP). For more information about the corresponding ICON roles, see ICON role in the Deployment Guide.

Info Mart DAP

  • INFO_MART — The DAP specifies connection information for the Genesys Info Mart Server to access the Info Mart database to read and write data. This role is required; it can be associated with only one DAP.

jdbc-sid

Section: gim-etl
Default Value: No default value
Valid Values: Any valid SID name
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.


(For Oracle only) Specifies the SID name, which Genesys Info Mart uses as a connection parameter to connect to Oracle databases. DB Server uses the Transparent Network Substrate (TNS) name, which is specified in the DBMS Name field on the DB Info tab of the DAP Application object. Configure this option if the SID name is not the same as the TNS name.

Note: If the jdbc-url option is defined, the SID name that is specified in the URL overwrites the value of jdbc-sid.

jdbc-port

Section: gim-etl
Default Value: 1433 (for Microsoft SQL Server), 1521 (for Oracle), or 5432 (for PostgreSQL)
Valid Values: Any valid port number
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 the port of the DBMS listener. Configure this option if the DBMS uses a nondefault listener port.

Note: If the jdbc-url option is defined, the port name that is specified in the URL overwrites the value of jdbc-port.

jdbc-host

Section: gim-etl
Default Value: No default value
Valid Values: Any valid host name
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 the host on which the DBMS is running. Configure this option if the DBMS server for the IDB is not on the same host as the DB Server.

Note: If the jdbc-url option is defined, the host name that is specified in the URL overwrites the value of jdbc-host.

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>
more...

geo-location

Section: gim-etl
Default Value: “”
Valid Values: Any string
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.
Introduced: 8.1.2

On the extraction DAP, specifies the location of the IDB. On the Info Mart DAP, specifies the location of the Info Mart database. Genesys Info Mart compares the string value of the option on the Info Mart DAP against the value of the geo-location option in redundant extraction DAPs. If the values are the same, the IDB for which the extraction DAP provides the connection information is considered to be local; if the values are not the same, the IDB is considered to be remote.

In an HA environment, Genesys Info Mart uses geolocation as a tie-breaker to determine the best IDB from which to extract data: If data-quality criteria do not identify one IDB as the best, Genesys Info Mart gives preference to the local IDB.

more...

default-schema

Section: gim-etl
Default Value: No default value
Valid Values: Any valid database owner or schema name
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 the database schema or owner name, if it is different from the database user ID. If you do not specify this option, the database tables and other database objects are assumed to be owned by the user name that you specify on the DB Info tab.

Note for PostgreSQL: Genesys recommends that you use lower case for all schema names. If you cannot do so, specify the value in case-sensitive mode by surrounding the value with a set of double quotes.

role

Section: gim-etl
Default Value: No default value
Valid Values: ICON_CFG, ICON_CORE, ICON_MM, ICON_OCS, INFO_MART
Changes Take Effect: For an extraction DAP, the next time that extraction jobs are launched; for the Info Mart DAP, on restart of the Genesys Info Mart Server.


Extraction DAPs

Specifies which data domain Genesys Info Mart will extract through the DAP:

  • ICON_CFG — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Configuration details. This role must be associated with one and only one DAP, or with redundant DAPs that constitute one HA set.
  • ICON_CORE — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Voice details, including agent activity details. This role is optional, but you need at least one DAP with a role of ICON_CORE or ICON_MM.
  • ICON_MM — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Multimedia details, including agent activity details. This role is optional, but you need at least one DAP with a role of ICON_CORE or ICON_MM.
    Warning
    You cannot reconfigure the DAP role from ICON_CORE to ICON_MM, or vice versa, once data extraction occurs.
  • ICON_OCS — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Outbound Contact details.
  • For the supported topologies that combine data domains (see Interaction Concentrator Topologies in the Genesys Info Mart Deployment Guide), specify all the applicable roles, separated by commas — for example: ICON_CFG,ICON_CORE,ICON_OCS.
Important
Ensure that the extraction role you specify is consistent with the role that is specified for ICON (in the [callconcentrator] section in both the ICON application and DAP). For more information about the corresponding ICON roles, see ICON role in the Deployment Guide.

Info Mart DAP

  • INFO_MART — The DAP specifies connection information for the Genesys Info Mart Server to access the Info Mart database to read and write data. This role is required; it can be associated with only one DAP.

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>
more...

geo-location

Section: gim-etl
Default Value: “”
Valid Values: Any string
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.
Introduced: 8.1.2

On the extraction DAP, specifies the location of the IDB. On the Info Mart DAP, specifies the location of the Info Mart database. Genesys Info Mart compares the string value of the option on the Info Mart DAP against the value of the geo-location option in redundant extraction DAPs. If the values are the same, the IDB for which the extraction DAP provides the connection information is considered to be local; if the values are not the same, the IDB is considered to be remote.

In an HA environment, Genesys Info Mart uses geolocation as a tie-breaker to determine the best IDB from which to extract data: If data-quality criteria do not identify one IDB as the best, Genesys Info Mart gives preference to the local IDB.

more...

default-schema

Section: gim-etl
Default Value: No default value
Valid Values: Any valid database owner or schema name
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 the database schema or owner name, if it is different from the database user ID. If you do not specify this option, the database tables and other database objects are assumed to be owned by the user name that you specify on the DB Info tab.

Note for PostgreSQL: Genesys recommends that you use lower case for all schema names. If you cannot do so, specify the value in case-sensitive mode by surrounding the value with a set of double quotes.

role

Section: gim-etl
Default Value: No default value
Valid Values: ICON_CFG, ICON_CORE, ICON_MM, ICON_OCS, INFO_MART
Changes Take Effect: For an extraction DAP, the next time that extraction jobs are launched; for the Info Mart DAP, on restart of the Genesys Info Mart Server.


Extraction DAPs

Specifies which data domain Genesys Info Mart will extract through the DAP:

  • ICON_CFG — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Configuration details. This role must be associated with one and only one DAP, or with redundant DAPs that constitute one HA set.
  • ICON_CORE — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Voice details, including agent activity details. This role is optional, but you need at least one DAP with a role of ICON_CORE or ICON_MM.
  • ICON_MM — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Multimedia details, including agent activity details. This role is optional, but you need at least one DAP with a role of ICON_CORE or ICON_MM.
    Warning
    You cannot reconfigure the DAP role from ICON_CORE to ICON_MM, or vice versa, once data extraction occurs.
  • ICON_OCS — The DAP specifies the connection information for an IDB from which Genesys Info Mart will extract ICON Outbound Contact details.
  • For the supported topologies that combine data domains (see Interaction Concentrator Topologies in the Genesys Info Mart Deployment Guide), specify all the applicable roles, separated by commas — for example: ICON_CFG,ICON_CORE,ICON_OCS.
Important
Ensure that the extraction role you specify is consistent with the role that is specified for ICON (in the [callconcentrator] section in both the ICON application and DAP). For more information about the corresponding ICON roles, see ICON role in the Deployment Guide.

Info Mart DAP

  • INFO_MART — The DAP specifies connection information for the Genesys Info Mart Server to access the Info Mart database to read and write data. This role is required; it can be associated with only one DAP.

Database Access Point

Also known as a DAP. An object that provides the interface between an application in the Genesys installation and the databases to which the application requires access. Refer to the Framework Database Connectivity Reference Guide for more information about configuring and using DAPs.



Glossary

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Configuring Required DAPs

This page provides instructions for configuring the database access points (DAPs) that Genesys Info Mart requires to access source and target databases. For general information about DAPs in your Genesys Info Mart deployment, see Enabling Database Access.

Overview: Preparing Required DAPs

The following steps summarize the task flow to enable Genesys Info Mart to access source and target databases.

  1. Enable access to the source databases from which Genesys Info Mart needs to extract data.
    For each IDB from which Genesys Info Mart might need to extract data, configure an extraction DAP, which specifies the connection information and other options for Genesys Info Mart to access the IDB. For each IDB, do one of the following:
  2. Enable access to the target database in which Genesys Info Mart processes and stores data.
    Create and configure the Info Mart DAP, which specifies the connection information and other options for Genesys Info Mart to access the Info Mart database. For more information, see Preparing the Info Mart DAP.
Important
The preceding task summary does not include information about how to configure the JDBC connection to use Secure Socket Layer (SSL). For information about how to set up a secure JDBC connection, see your RDBMS vendor documentation.

Preparing Extraction DAPs

A separate DAP is required for each IDB from which Genesys Info Mart will extract data. You can create and configure a new, dedicated JDBC DAP, or you can reuse the non-JDBC DAP that you have already configured for ICON to access IDB.

Use one of the following procedures, as applicable, to enable Genesys Info Mart to access the IDBs:

Procedure: Configuring a JDBC extraction DAP

Purpose: To create and configure a new, dedicated DAP that enables Genesys Info Mart to access IDB through JDBC, for the purposes of extracting data.

Prerequisites

Steps

  1. Create a JDBC DAP application, as described in the Help references above. Note the following Genesys Info Mart–specific configuration requirements:
    • General tab: Ensure that the JDBC Connection and State Enabled check boxes are selected.
    • Tenants tab: No configuration of tenants is required. Skip the Tenants tab if it displays.
    • DB Info tab: In the Database Name text box, enter the exact name of the IDB to which this DAP will connect. For example, on Oracle, this is the Transparent Network Substrate (TNS) name.

      In the User Name and Password text boxes, enter the user name and password of a user account that has the required privileges for the Info Mart user on the IDB.

    • JDBC Info tab: From the Role drop-down list, select Role Main. Genesys Info Mart ignores all other fields on the JDBC Info tab.
    • Server Info tab: From the Host drop-down list, select the host name of the database server. If the host name does not appear in the list, you must add it.

      If necessary, specify the communication port for the database server, by modifying the Communication Port property of the default port. For Microsoft SQL Server, the default communication port is 1433; for Oracle, it is 1521; for PostgreSQL, it is 5432.

  2. On the Options tab, create a new configuration section, named gim-etl, and create and configure the options that are required for Genesys Info Mart.

    Genesys Info Mart uses the following [gim-etl] options. Click the option name to see more information.

  3. Repeat the preceding steps for each IDB from which Genesys Info Mart will extract data and for which you are not reusing an existing Interaction Concentrator DAP. If your deployment topology involves HA, you must also repeat the preceding steps to provide a DAP for each redundant IDB.

Next Steps

Procedure: Configuring a non-JDBC extraction DAP

Purpose: To modify the configuration of an existing DAP that ICON uses to access an IDB, to enable Genesys Info Mart to access the same IDB, for the purposes of extracting data.

Prerequisites

  • Preparing IDBs.
  • You have the required permissions to access and modify the ICON DAP(s)
  • You are logged in to the interface you use to configure your Genesys applications.

Steps

  1. Locate the DAP that enables ICON to access the IDB to store data for the applicable data domain.
  2. On the Options tab, create a new configuration section, named gim-etl, and create and configure the options that are required for Genesys Info Mart. For details about how to create a configuration section and options, see the Help for the configuration interface you are using — Configuration Manager Help (8.1), Genesys Administrator Help, or Genesys Administrator Extension Help.

    Genesys Info Mart uses the following [gim-etl] options. Click the option name to see more information.

    • role (required)
    • default-schema (optional)
    • geo-location (optional)
    • jdbc-url or jdbc-host, jdbc-port, jdbc-sid. You must configure the jdbc-url option or other jdbc-* options if one of the following conditions applies:
      • DB Server is not running on the same host as the database management system (DBMS) server.
      • The port of the DBMS listener is not the default (1433 for Microsoft SQL Server, 1521 for Oracle, or 5432 for PostgreSQL).
      • For Oracle, the SID name is not the same as the TNS name.
      • You want to enable SSL over the JDBC connection.
  3. Repeat the preceding steps for each IDB from which Genesys Info Mart will extract data and for which you want to reuse an existing ICON DAP.

Next Steps

Preparing the Info Mart DAP

To process and store data, Genesys Info Mart Server requires access to its target database. The following procedure describes how to create and configure the Info Mart DAP.

Procedure: Configuring the Info Mart DAP

Purpose: To create and configure a new, dedicated DAP that enables Genesys Info Mart Server to access the Info Mart database.

Prerequisites

Steps

  1. Create a JDBC DAP application, as described in the Help references above. Note the following Genesys Info Mart–specific configuration requirements:
    • General tab: Ensure that the JDBC Connection and State Enabled check boxes are selected.
    • Tenants tab: No configuration of tenants is required. Skip the Tenants tab if it displays.
    • DB Info tab: In the Database Name text box, enter the exact name of the Info Mart database to which this DAP will connect. For example, on Oracle, this is the Transparent Network Substrate (TNS) name.

      In the User Name and Password text boxes, enter the user name and password of the user account that has the required privileges for the Info Mart user.

    • JDBC Info tab: From the Role drop-down list, select Role Main. Genesys Info Mart ignores all other fields on the JDBC Info tab.
    • Server Info tab: From the Host drop-down list, select the host name of the database server. If the host name does not appear in the list, you must add it.

      If necessary, specify the communication port for the database server, by modifying the Communication Port property of the default port. For Microsoft SQL Server, the default communication port is 1433; for Oracle, it is 1521; for PostgreSQL, it is 5432.

  2. On the Options tab, create a new configuration section, named gim-etl, and create and configure the options that are required for Genesys Info Mart.

    Genesys Info Mart uses the following [gim-etl] options. Click the option name to see more information.

    • role (required value is INFO_MART)
    • default-schema (optional)
    • geo-location (optional)
    • jdbc-url (required only if you want to enable SSL over the JDBC connection)
    • agg-jdbc-url (optional, in Oracle RAC deployments only, if you want aggregation to use a separate node)

Next Steps

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on July 28, 2017, at 13:53.