Deploy Data Loader

Data Loader has multiple capabilities, including the following:

• It connects to Genesys Info Mart to retrieve data for the Agent Profile Dataset.
• It connects to Genesys Info Mart to collect interaction data, which is saved in one or more Datasets for use in creating Predictors and Models.
• It enables you to upload CSV files containing customer and outcome data, which is used to create the Customer Profile and outcome Datasets.
• It can join agent and customer data to an interaction Dataset for more broad-based predictive analysis.

Related documentation:

• How Predictive Routing works

About Data Loader

Deploying Data Loader has the following main phases:

• Download the Data Loader IP and unzip the installation files.
• Create and configure the Data Loader Application object in your Genesys configuration application.
• Create, and set appropriate values for, configuration sections and options. In addition to controlling aspects of Data Loader performance and connections, these options also specify Dataset schemas and data upload parameters.
• Install Data Loader.

Environment Assumptions

• Data Loader must be deployed on a host that has no other instances of Local Control Agent installed.
• The instructions in this section assume that you are creating new Application objects under the Environment folder, in either a single-tenant or multi-tenant configuration environment.

Configure the Data Loader Application

1. Import the Application Template
2. Create a Data Loader Application Object
3. Configure the General tab
4. Configure the Server Info tab
5. Configure the Start Info tab
6. Configure the Options tab - The configuration options control many aspects of Data Loader behavior, including the password and URLs for connections to the GPR Core Platform, data schemas and upload parameters, and the ability to control threading and timeouts.
7. Configure the Tenants tab
8. Configure the Connections tab
9. Configure the Security tab

Import the Application Template

Before you can configure an Application object for Data Loader, you must import its Application template. The Application template provides a majority of the configuration options, as well as the default values for them. You can use this Application template to create as many Application objects of the same type as you need.

Important

For an explanation of how to use Genesys Administrator Extension to import the Application template and to create a new Application object, see the Genesys Administrator Extension Help file, which is directly available from Genesys Administrator Extension user interface, as well as from the link given here.

1. On the Configuration Manager window in Genesys Administrator Extension, select the Environment > Application Templates folder.
2. From the File menu, select Import Application Template.
3. In the Look In box, click the down arrow.
4. Browse to the IP for Data Loader and open the TEMPLATES folder.
5. Select the template file for Data Loader; it is called DataLoader_900.apd.
6. Click Open to open the Properties dialog box for the template.
7. Make any changes that you require.
8. Click OK to save the template and close the Properties dialog box.

The next step is to configure a Data Loader Application object.

Create a Data Loader Application Object

After you import the application template, you can create and configure an Application object for Data Loader by using the Configuration Manager tab in Genesys Administrator.

NOTE: When using a primary-backup high-availability architecture (recommended for all production environments), configure each Data Loader instance in a primary-backup pair with the same configuration option values. If there is a discrepancy between the primary and backup, the values set for the backup instance are used.

1. On the Configuration Manager window, select the Environment > Applications folder.
2. From the File menu, select New > Application.
3. From the available application templates in the Browse dialog box, select the template that you imported for Data Loader.
4. On each of the Application tabs, enter the settings appropriate for your environment, as explained in detail in the section that follow.
5. Click OK to save your changes, then close the Properties dialog box.

Configure the General tab

In the Properties dialog box, click the General tab, and then enter a name for this application.

Configure the Server Info tab

Click the Server Info tab, and then specify the following properties:

• Host—Select the host for the Docker container containing Data Loader and Local Control Agent (LCA).

  By default, the LCA port is set to to 4999 in the Host object. If you change it, make sure to change the LCA listening port mapped in the docker-compose.yml file as well. See Procedure: Change the default port for the Data Loader Docker container for details.

• Port—Enter the value 0 (zero) for the port number.

Important

In IPv6 deployments, you cannot set the IP address of the host—only IPv4 addresses can be set for the host. Therefore, enter the name of the host instead.

Configure the Start Info tab

Click the Start Info tab, and then specify the following properties:

• Working Directory—/dl
• Command Line—./DataLoader.sh
• Command Line Arguments—Add the following startup arguments, which are used in the startup script:

  -host <configuration_server_hostname> -port <configuration_server_port> -app <DataLoader_Application_object_name>

Configure the Options tab

Click the Options tab, and then specify or change the values of the configuration options, as suitable for your deployment. Among other configuration, you must configure options to enable the following functionality:

• The automatic upload of Genesys Info Mart data to Datasets and the Agent Profile. See Configure Data Loader to upload data for specific guidelines.
• Data Loader access to the GPR Core Services platform. To configure this:
  1. Enter the account information you receive when you start using Predictive Routing in the password and platform-username options.
     • After you set up the initial account access, these options are hidden and Data Loader automatically updates the password every 90 days. Log messages appear in Solution Control Interface indicating when the password is about to expire and when it has been successfully updated.
     • Data Loader sets passwords that comply with Genesys Cloud security standards.
  2. Configure the URL used to access the GPR Core Platform, set in the platform-base-url option.

  The same username, password, and URL must also be configured in the corresponding options on the Predictive_Route_DataCfg Transaction list object so the URS Strategy Subroutines component can access the platform.

• For information about the entire set of Data Loader configuration options, see Data Loader options.

Log Options

• Configure both Data Loader-specific log options and common log options in the log-related configuration sections. For option descriptions, see Log Options and the Framework Configuration Options Reference Manual.

  Important

  You must set the log file path to the correct location for use within the Docker container. For details, see the all configuration option description.

Configure the Tenants tab

Tip

The Tenants tab is displayed only in a multi-tenant environment.

• Click the Tenants tab, and then click Add to add all tenants that this Data Loader application will serve. Data Loader only monitors objects that are associated with the tenants you specify.
• If this Data Loader instance is required to monitor the objects that are configured under the Environment folder, assign the Environment tenant among the other tenants.

Configure the Connections tab

Click the Connections tab, and then add the following connections:

• Configuration Server (connection to Configuration Server Proxy is not supported)
• the Database Access Point (DAP) Application for the Genesys Info Mart Database
• Message Server

High Availability

In high availability (HA) environments using primary and backup pairs of servers, the servers listed on the Connections tab are handled as primary. To specify the backup servers for any primary servers, open the Application object for the primary server and add the backup server on the primary server’s Server Info tab.

Configure the Security tab

To configure the Security tab settings:

1. Click Permissions.
2. Double-click SYSTEM.
3. Verify that the following are selected for the Change (H) option: Read, Change, Execute and Read & Execute.
4. Click OK.
5. Verify that the Log On As parameter is configured as the SYSTEM account.
6. Click OK.

Install Data Loader

Data Loader is deployed in a Docker container. The container also provides Local Control Agent (LCA), which communicates with Solution Control Server, enabling real-time monitoring of the status of the Data Loader container in Solution Control Interface.

Refer to the following sections of this Guide to make sure you have set up your environment correctly before starting to install Data Loader:

• Important Considerations Related to Docker
• System Requirements and Required Components/Versions

Preliminary Steps: Install and Start Docker

Important

• Genesys does not ship Docker as a part of Data Loader. You must install Docker in your environment before you can load the Data Loader containers. See System Requirements and Required Components/Versions for supported Docker versions.
• You might need an active Internet connection to download additional libraries when installing Docker.

1. Install Docker-ee or Docker-ce. Click the desired version to access the relevant deployment instructions on the Docker site.
2. During Docker deployment, create a Linux group with the name gpr and the group ID of 1010. You will use this group for Data Loader.
3. During Docker deployment, create a user with the name gpr and the user ID of 1010.
4. Run the following commands to add the gpr user to the gpr, docker, and systemd-journal groups:

   $ sudo groupadd -g 1010 gpr
   $ sudo useradd -u 1010 gpr
   $ sudo usermod -aG gpr gpr
   $ sudo usermod -aG docker gpr
   $ sudo usermod -aG systemd-journal gpr
   $ sudo passwd gpr

   • You must have sudo rights to execute these commands.
   • In the example commands, the user is given as gpr. You can replace this user name with any valid Unix name. This topic refers throughout to gpr; if you choose a different name, substitute that actual name in its place.
5. Grant SSH access to gpr so that you can copy the Data Loader installation package to the target server. The Data Loader installation package should always be copied to the target server by gpr into the gpr home directory.
6. To enable the Docker service, execute the following command:

   $ sudo systemctl enable docker

7. To start the Docker service, execute the following command:

   $ sudo service docker start

Install Data Loader and Start the Container

Preliminary notes:

• Perform the installation using the gpr user (or the name you assigned when you set up Docker).
• You do not need sudo rights to install Data Loader.
• Do NOT use the root user to install Data Loader.

1. To install Data Loader, execute the install.sh script, using the following command from the folder containing the Data Loader IP package:

   $ cd ./ai-data-loader-scripts/scripts

   $ bash install.sh

   The installation script verifies the following:

   • The target server has sufficient hardware resources. If not, the installation process terminates without performing the install.
   • The installed Docker package is docker-ce or docker-ee.
   • The Docker version is supported.
   • The number of cores in the server is sufficient.
   • The root partition free space is sufficient.
   • gpr (or your username) belongs to the Docker group.
   • gpr (or your username) belongs to the systemd-journal group (for container log checking).
   • The Docker service is running.
2. (Optional) To disable the target server verification checks, execute install.sh with the -s parameter:

$ bash install.sh -s

Folder Mapping in the Container

The following list shows the full path to the various folders on the host machine where the Data Loader container is deployed and the corresponding Docker container folders:

• <IP folder>/ai-data-loader-scripts/scripts/datasets_agents /datasets/agents/
• <IP folder>/ai-data-loader-scripts/scripts/datasets_customers /datasets/customers/
• <IP folder>/ai-data-loader-scripts/scripts/datasets_outcomes /datasets/outcomes/
• <IP folder>/ai-data-loader-scripts/scripts/log_dl /log/dl/
• <IP folder>/ai-data-loader-scripts/scripts/log_lca /log/lca

See Start and Stop Data Loader for how to start, stop, and restart the Data Loader container and Data Loader itself.