View source for PE-GPR/9.0.0/Deployment/cfgAsc

{{Article
|Standalone=No
|DisplayName=Deploy Data Loader
|TocName=Deploy Data Loader
|Context=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.
|ComingSoon=No
|Platform=GenesysEngage-onpremises
|Prereq=
|Section={{Section
|sectionHeading=About Data Loader
|anchor=
|alignment=Vertical
|Media=
|image=
|structuredtext=Deploying Data Loader has the following main phases:

*Download the Data Loader IP and unzip the installation files.
*Create the Data Loader user for your account and assign it the SERVICE role, which is a special role to be used only by Data Loader. For instructions, see {{Link-SomewhereInThisVersion|manual=Help|topic=cfgUserMgmt|anchor=service|display text=Create the Data Loader user}} in the ''Predictive Routing Help''.
*{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=cfgApp|display text=Create and configure the Data Loader <tt>Application</tt> object}} in your Genesys configuration application.
*Create, and set appropriate values for, [https://docs.genesys.com/Documentation/Options/Draft/GPM/GPM_DL 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.
*{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=installasc|display text=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 <tt>Application</tt> objects under the Environment folder, in either a single-tenant or multi-tenant configuration environment.
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Download and prepare the Data Loader IP files
|anchor=downloadIP
|alignment=Vertical
|Media=
|image=
|structuredtext=The Data Loader IP contains the following items:

*The '''gpr''' folder, which contains subfolder, '''ai-data-loader''', that in turn contains the '''&lt;''version_number''&gt;.tar.gz''' file.
*The '''ai-data-loader-scripts.tar.gz''' zipped archive, which contains initialization scripts Data Loader uses during deployment.

To deploy Data Loader, perform the following steps:

#Copy the Data Loader IP files from the Docker Linux IP repository to the desired installation directory.
#*Genesys recommends that you use the gpr home directory as the destination for the Data Loader installation package.
#Unzip the '''ai-data-loader-scripts.tar.gz''' file. The following files and folders are extracted into your installation directory:
#*'''docker-compose''' Linux executable file
#*The '''/scripts''' folder, which contains all the installation and other helper files
#*The '''/conf''' folder, which contains the '''dl.env''' file. The '''dl.env''' file contains the environment variables used to configure Data Loader.
#*The '''/templates''' folder, which contains the files used to create the Application Template and Application objects for Data Loader.
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Configure the Data Loader Application
|anchor=cfgApp
|alignment=Vertical
|Media=
|image=
|structuredtext=#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=apptemp|display text=Import the Application Template}}
#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=appobj|display text=Create a Data Loader Application Object}}
#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=gentab|display text=Configure the General tab}}
#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=svrinfo|display text=Configure the Server Info tab}}
#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=startinfo|display text=Configure the Start Info tab}}
#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=opttab|display text=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.
#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=tenants|display text=Configure the Tenants tab}}
#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=conntab|display text=Configure the Connections tab}}
#{{Link-SomewhereInThisManual|topic=cfgAsc|anchor=sectab|display text=Configure the Security tab}}
{{AnchorDiv|apptemp}}
===Import the Application Template===
Before you can configure an <tt>Application</tt> object for Data Loader, you must import its <tt>Application</tt> template. The <tt>Application</tt> template provides a majority of the configuration options, as well as the default values for them. You can use this <tt>Application</tt> template to create as many <tt>Application</tt> objects of the same type as you need.
{{NoteFormat|For an explanation of how to use Genesys Administrator Extension to import the <tt>Application</tt> template and to create a new <tt>Application</tt> object, see [https://docs.genesys.com/Documentation:GA:user:CMEnvironment:latest the Genesys Administrator Extension Help file], which is directly available from Genesys Administrator Extension user interface, as well as from the link given here.}} 

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

The next step is to configure a Data Loader <tt>Application</tt> object.
{{AnchorDiv|appobj}}
===Create a Data Loader Application Object===
After you import the application template, you can create and configure an <tt>Application</tt> 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.

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

{{AnchorDiv|gentab}}
===Configure the General tab===
In the '''Properties''' dialog box, click the '''General''' tab, and then enter a name for this application. 

{{AnchorDiv|svrinfo}}
===Configure the Server Info tab===
Click the '''Server Info''' tab, and then specify the following properties:

*Host&mdash;Select the host for the Docker container containing Data Loader and Local Control Agent (LCA).
*:The LCA port is set to to 4999 in the <tt>Host</tt> object.
*Port&mdash;Enter the value <tt>0</tt> (zero) for the port number.
{{NoteFormat|In IPv6 deployments, you cannot set the IP address of the host&mdash;only IPv4 addresses can be set for the host. Therefore, enter the ''name'' of the host instead.}}

{{AnchorDiv|startinfo}}
===Configure the Start Info tab===
Click the '''Start Info''' tab, and then specify the following properties:

*Working Directory&mdash;/dl
*Command Line&mdash;./DataLoader.sh
*Command Line Arguments&mdash;Add the following startup arguments, which are used in the startup script:
*:<tt>-host &lt;''configuration_server_hostname''&gt; -port &lt;''configuration_server_port''&gt; -app &lt;''DataLoader_Application_object_name''&gt;</tt>

{{AnchorDiv|opttab}}
===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 {{Link-SomewhereInThisVersion|manual=Deployment|topic=DL-CfgFile|display text=Configure Data Loader to upload data}} for specific guidelines.
*Data Loader access to the GPR Core Services platform. To configure this:
*#Enter the account information you receive when you start using Predictive Routing in the {{Optionslink|link=Options:DataLoader:default:password}} and {{Optionslink|link=Options:DataLoader:default: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.
*#Configure the URL used to access the GPR Core Platform, set in the {{Optionslink|link=Options:DataLoader:default:platform-base-url}} option.
*#Configure the API key used to access the GPR Core Platform, set in the {{Optionslink|link=Options:DataLoader:default:platform-api-key}} option. This API key is available in the {{Link-SomewhereInThisVersion|manual=Help|topic=cfgAccounts|display text='''Settings &gt; Account'''}} window of the GPR web application.
*:YOu must specify the ''same'' username, password, API key, and URL in the corresponding options on the Predictive_Route_DataCfg <tt>Transaction List</tt> object so the URS Strategy Subroutines component can access the platform.

*For information about the entire set of Data Loader configuration options, see [https://docs.genesys.com/Documentation/Options/Current/GPM/GPM_DL 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 [https://docs.genesys.com/Documentation/Options/Current/GPM/GPM_DL-log Log Options] and the {{Repository|81fr_ref-co.pdf|c2abc188-e635-4abb-9222-76e42ed0b986|<i>Framework Configuration Options Reference Manual</i>}}.
*:{{NoteFormat|The path to the log file is correctly set by default and should not be edited. Genesys recommends that you retain the default log file name as well.}}

{{AnchorDiv|tenants}}
===Configure the Tenants tab===
{{NoteFormat|The Tenants tab is displayed only in a multi-tenant environment.|2}} 

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

{{AnchorDiv|conntab}}
===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 <tt>Application</tt> object for the primary server and add the backup server on the primary server’s '''Server Info''' tab.
{{AnchorDiv|sectab}}
===Configure the Security tab===
To configure the Security tab settings:

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

When your environment is configured for anonymization on-premise, assign Read, Change, Execute, and Read & Execute permissions to the following configuration objects. 

*The Data Loader '''Application''' object.
*The Predictive_Route_DataCfg '''Transaction List''' object, which is used by the GPR URS Strategy Subroutines.
*All levels of the folder/directory structure within which the Data Loader '''Application''' object and the Predictive_Route_DataCfg '''Transaction List''' object exist.

This ensures that Data Loader can create and read the options specific to anonymization in the Data Loader '''Application''' object and the Predictive_Route_DataCfg '''Transaction List''' object.
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Install Data Loader
|anchor=installasc
|alignment=Vertical
|Media=
|image=
|structuredtext=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:

*{{Link-SomewhereInThisManual|topic=envPrereqs|anchor=dockerPrereqs|display text=Important Considerations Related to Docker}}
*{{Link-SomewhereInThisManual|topic=envPrereqs|anchor=ascPrereqs|display text=System Requirements and Required Components/Versions}}
{{AnchorDiv|dockerinstall}}
===Preliminary Steps: Install and Start Docker===
{{NoteFormat|
*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 {{Link-SomewhereInThisManual|topic=envPrereqs|anchor=ascPrereqs|display text=System Requirements and Required Components/Versions}} for supported Docker versions. 
*You might need an active Internet connection to download additional libraries when installing Docker.
|}}

#Install {{#Widget:ExtLink|link=https://docs.docker.com/install/linux/docker-ee/centos/|displaytext=Docker-ee}} or {{#Widget:ExtLink|link=https://docs.docker.com/install/linux/docker-ce/centos/|displaytext=Docker-ce}}. Click the desired version to access the relevant deployment instructions on the Docker site.
#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.
#During Docker deployment, create a user with the name '''gpr''' and the user ID of '''1010'''.
#Run the following commands to add the gpr user to the '''gpr''', '''docker''', and '''systemd-journal''' groups:
#:<source lang="bash">$ 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
</source>
#*You must have '''sudo''' rights to execute these commands.
#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.
#To enable the Docker service, execute the following command:
#:<source lang="bash">$ sudo systemctl enable docker</source>
#To start the Docker service, execute the following command:
#:<source lang="bash">$ sudo service docker start</source>

===Install Data Loader and Start the Container===
Preliminary notes:

*Perform the installation using the '''gpr''' user. The '''gpr''' user must have sudo rights to perform the installation.
*Do NOT use the root user to install Data Loader.
*You should have created the Data Loader user and assigned it the SERVICE role before starting Data Loader for the first time. For instructions, see {{Link-SomewhereInThisVersion|manual=Help|topic=cfgUserMgmt|anchor=service|display text=Create the Data Loader user}} in the ''Predictive Routing Help''.

#To install Data Loader, execute the '''install.sh''' script, using the following command from the folder containing the Data Loader IP package:
#:<source lang="bash">$ cd ./ai-data-loader-scripts/scripts</source>
#:<source lang="bash">$ bash install.sh</source>
#: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 belongs to the Docker group.
#*gpr belongs to the systemd-journal group (for container log checking).
#*The Docker service is running.
#(Optional) To disable the target server verification checks, execute '''install.sh''' with the <tt>-s</tt> parameter:

<tt>$ bash install.sh -s</tt>
===Mapping Between Folders on the Host and 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:
{{{!}} border="1"
{{!}}-
!'''Host Folder Path'''
!'''Docker Container Folder Path'''
{{!}}-
{{!}}<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 {{Link-SomewhereInThisManual|topic=startStop|anchor=ASCstartStop|display text=Start and Stop Data Loader}} for how to start, stop, and restart the Data Loader container and Data Loader itself.
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Configure HTTPS proxy
|anchor=https
|alignment=Vertical
|Media=
|image=
|structuredtext=If HTTPS proxy is configured in your environment, configure the JVMPARAMS environment variable, as follows:

#Open the '''<''DL installation folder''>/ai-data-loader-scripts/conf/dl.env''' file.
#Add the following parameters to the value of the JVMPARAMS environment variable:
#:<tt>-Dhttps.proxyHost=<''proxy_host_name''> -Dhttps.proxyPort=<''proxy_port''></tt>
#Save the '''dl.env''' file.
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Ports for the Data Loader Docker container
|anchor=changePort
|alignment=Vertical
|Media=
|image=
|structuredtext=Data Loader uses the default ports shown in the following table, which also provides links to the procedures for changing those port numbers, if your environment requires it.  
{{{!}} border="1"
{{!}}-
!'''Source Client'''
!'''Server'''
!'''Protocol'''
!'''Direction'''
!'''Port Number'''
!'''Comments'''
{{!}}-
{{!}}GPR Data Loader
{{!}}Genesys Info Mart DAP
{{!}}TCP
{{!}}To
{{!}}For Microsoft SQL Server, the default communication port is 1433; for Oracle, it is 1521; for PostgreSQL, it is 5432.
{{!}}The database access point (DAP) for the Genesys Info Mart database. For more information about configuring this DAP, see [https://docs.genesys.com/Documentation/GIM/Current/Dep/GIMConfigDAPs Configuring Required DAPs] in the ''Genesys Info Mart Deployment Guide''.
{{!}}-
{{!}}GPR Data Loader
{{!}}Configuration Server
{{!}}TCP
{{!}}To
{{!}}2020
{{!}}To change the port number, see Application Parameter Options and Sample Configuration Server Configuration
File on p. 105 of the {{Repository|85fr_ref-co.pdf|4b6870e4-2d5f-479c-ac29-11e43011db63|Framework Configuration Options Reference Manual}}.
{{!}}-
{{!}}GPR Data Loader
{{!}}Message Server
{{!}}TCP
{{!}}To
{{!}}2030
{{!}}To change the port number, see Configuring Client-Side Port Definition on p. 53 of the {{Repository|85fr_ref-co.pdf|4b6870e4-2d5f-479c-ac29-11e43011db63|Framework Configuration Options Reference Manual}}.
{{!}}-
{{!}}Local Control Agent (LCA)
{{!}}Solution Control Server
{{!}}TCP
{{!}}To
{{!}}4999
{{!}}This is the instance of LCA deployed in the Docker container with Data Loader. This port number is not configurable.
{{!}}-
{{!}}GPR Data Loader
{{!}}Local Control Agent (LCA)
{{!}}TCP
{{!}}To
{{!}}4999
{{!}}This port number is not configurable.
{{!}}-
{{!}}GPR Data Loader
{{!}}GPR Core Platform
{{!}}HTTPS
{{!}}To
{{!}}443
{{!}}This port number is not configurable.
{{!}}-
{{!}}Prometheus
{{!}}GPR Data Loader
{{!}}HTTP
{{!}}To
{{!}}9105
{{!}}Prometheus is an optional third-party application which you can use to monitor health and metrics in your environment. To change the port number, see the instructions following this table.
{{!}}}
The following steps enable you to change the default port for viewing the Data Loader Spring Boot application metrics, using Prometheus.

#Stop the Data Loader application by running the following command:
#:<source lang="bash">$ bash stop.sh</source>
#Edit the '''scripts/docker-compose.yml''' file:
##Locate the <code>ports</code> label.
##Replace the listening port number with the new port number.
#:For example, to replace the default Prometheus port, 9105, with port 9090, replace <code>ports: "9105:9105"</code> with <code>ports: "9090:9105"</code>.
#Restart Data Loader using the following command:
#:<source lang="bash">$ bash restart.sh</source>
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Clean up unnecessary Docker data
|anchor=cleanup
|alignment=Vertical
|Media=
|image=
|structuredtext=Use the following commands to remove unnecessary Docker data:
<source lang="bash">$ docker container prune -f</source>
<source lang="bash">$ docker volume prune -f</source>
<source lang="bash">$ docker network prune -f</source>
To schedule regular cleanup jobs, use the crontab functionality to execute the appropriate command on every server where GPR is installed. The following example schedules the cleanup job for every Saturday at 1:00 am:
<source lang="bash">$ echo "0 1 * * Sat (docker container prune -f; docker volume prune -f; docker network prune -f)" )</source>
|structuredtextwide=
|FAQHeading=
|Status=No
}}
}}