Difference between revisions of "PEC-REP/Current/GIMPEGuide/PlanningGIM"

From Genesys Documentation
Jump to: navigation, search
Line 7: Line 7:
 
|LimitationsText=Instructions are provided for a single-tenant deployment.
 
|LimitationsText=Instructions are provided for a single-tenant deployment.
 
|HelmStatus=No
 
|HelmStatus=No
−
|HelmText=To configure and deploy Genesys Info Mart, you must obtain the Helm charts included with the Info Mart release. These Helm charts provision Info Mart plus any Kubernetes infrastructure Info Mart requires to run.
+
|HelmText=GIM and GIM monitoring are the only services that run in the GIM Docker container. The Helm charts included with the GIM release provision GIM and any Kubernetes infrastructure necessary for GIM to run.
  
−
Genesys Info Mart and GIM monitoring are the only services that run in the Info Mart container.  
+
See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=GIMHelm}} for the Helm chart version you must download for your release.
  
−
For the correct Helm chart version for your release, see {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=GIMHelm}}. For information on downloading from the Genesys JFrog image repository, see {{SuiteLevelLink|helmchart}}.
+
For information about how to download the Helm charts, see {{SuiteLevelLink|helmchart}}.
 
|ThirdPartyStatus=No
 
|ThirdPartyStatus=No
 
|ThirdPartyText=For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.
 
|ThirdPartyText=For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.
Line 18: Line 18:
 
|SectionThirdPartyItem={{SectionThirdPartyItem
 
|SectionThirdPartyItem={{SectionThirdPartyItem
 
|ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
 
|ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
−
|Notes=You must create the Info Mart database (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGIM|anchor=CreateGIMDB}}).
+
|Notes=You must create the Info Mart database (see [[{{FULLPAGENAME}}#CreateDB|below]]).
 
}}{{SectionThirdPartyItem
 
}}{{SectionThirdPartyItem
 
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0
 
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0
−
|Notes=The Kafka topics GIM will consume must exist in the Kafka configuration. GIM consumes the topics GSP produces. For more information, see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGSP|anchor=GSP_KafkaTopics|display text=GSP Kafka topics}}.
+
|Notes=The Kafka topics GIM will consume must exist in the Kafka configuration. GIM consumes the topics GSP produces. For more information, see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGSP|anchor=Kafka|display text=Kafka configuration}}.
 
}}{{SectionThirdPartyItem
 
}}{{SectionThirdPartyItem
 
|ThirdPartyItem=9ae24d71-5263-4a2e-8d1b-f65660f1cdc0
 
|ThirdPartyItem=9ae24d71-5263-4a2e-8d1b-f65660f1cdc0
Line 36: Line 36:
 
{{AnchorDiv|PostgreDB}}
 
{{AnchorDiv|PostgreDB}}
 
===PostgreSQL — the Info Mart database===
 
===PostgreSQL — the Info Mart database===
−
The Info Mart database stores data about agent and interaction activity, Outbound Contact campaigns, and usage information about other services in your contact center. A subset of tables and views created, maintained, and populated by Reporting and Analytics Aggregates (RAA) provides the aggregated data on which Genesys CX Insights (GCXI) reports are based.
+
The Info Mart database stores data about agent and interaction activity, Outbound Contact campaigns, and other services usage in your contact center. A subset of tables and views created, maintained, and populated by Reporting and Analytics Aggregates (RAA) provides the aggregated data on which Genesys CX Insights (GCXI) reports are based.
  
 
A sizing calculator for Genesys Multicloud CX private edition is under development. In the meantime, the interactive tool available for on-premises deployments might help you estimate the size of your Info Mart database, see ''{{Repository|GIMSize_85.xlsx|b00cf06a-61e6-4f01-82d3-c6fcbf15dee7|Genesys Info Mart 8.5 Database Size Estimator}}''.
 
A sizing calculator for Genesys Multicloud CX private edition is under development. In the meantime, the interactive tool available for on-premises deployments might help you estimate the size of your Info Mart database, see ''{{Repository|GIMSize_85.xlsx|b00cf06a-61e6-4f01-82d3-c6fcbf15dee7|Genesys Info Mart 8.5 Database Size Estimator}}''.
Line 42: Line 42:
 
Genesys recommends a minimum 3 IOPS per GB.
 
Genesys recommends a minimum 3 IOPS per GB.
  
−
For information about creating the Info Mart database, see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGIM|anchor=CreateGIMDB}}
+
For information about creating the Info Mart database, see [[{{FULLPAGENAME}}#CreateDB|Create the Info Mart database]].
 
<!--{{Editgrn_open}}<font color=red>'''Writer's note:''' Borys, if you have time now to review an additional database-related enhancement, please see the modified Dep Guide content on https://all.docs-qa.genesys.com/User:Jdruker/PE_GIMPrep_AboutGIMdatabase. Otherwise, I'll post that content for your review at a later time.</font>{{Editgrn_close}}-->
 
<!--{{Editgrn_open}}<font color=red>'''Writer's note:''' Borys, if you have time now to review an additional database-related enhancement, please see the modified Dep Guide content on https://all.docs-qa.genesys.com/User:Jdruker/PE_GIMPrep_AboutGIMdatabase. Otherwise, I'll post that content for your review at a later time.</font>{{Editgrn_close}}-->
  
−
{{AnchorDiv|CreateGIMDB}}
+
{{AnchorDiv|CreateDB}}
 
====Create the Info Mart database====
 
====Create the Info Mart database====
 
Use any database management tool to create the Info Mart ETL database and user.
 
Use any database management tool to create the Info Mart ETL database and user.
−
 
 
#Create the database.
 
#Create the database.
−
#Create a user for all of the Genesys Info Mart services to use. Grant that user full permissions for the database.  
+
#Create a user for the Genesys Info Mart services to use, and grant full permissions to the user for that database.  
−
#:This user’s account is used by Info Mart jobs to access the Info Mart database schema.
+
#:This user’s account is used by Genesys Info Mart jobs to access the Info Mart database schema.
−
#:The name of the Info Mart schema name is <code>public</code>.
+
#:The Info Mart schema name is <tt>public</tt>.
−
#:{{NoteFormat|Make a note of the database and user details. You need this information when you configure GIM and GCA Helm chart override values.}}
+
#:{{NoteFormat|Make a note of the database and user details, which you use to populate database-related Helm chart override values for GIM and GCA.}}
  
 
===Object storage — Data Export packages===
 
===Object storage — Data Export packages===
−
The GIM Data Export feature enables you to export data from the GIM database so it is available for other purposes. Unless you elect to store your exported data in a local directory, GIM data is exported to an object store. GIM supports export to either Azure Blob Storage or the S3-compatible storage provided by OpenShift and Google Cloud Platform (GCP).  
+
The GIM Data Export feature enables you to export data from your Info Mart database. Unless you elect to store your exported data in a local directory, your Info Mart data is exported to an object store. GIM supports export to Azure Blob Storage or S3-compatible storage provided by OpenShift and Google Cloud Platform (GCP).  
  
−
If you want to use S3-compatible storage, follow the {{Link-AnywhereElse|product=PEC-REP|version=Current|manual=GIMPEGuide|topic=PlanningGSP|anchor=GSP_Plan_CreateS3Storage}} instructions for GSP to create the S3-compatible storage for GIM.  
+
If you want to use S3-compatible storage, follow the {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGSP|anchor=S3|display text=Create object storage}} instructions for GSP to create the S3-compatible storage for GIM.  
  
−
{{NoteFormat|GSP and GCA use object storage to store data during processing. For safety and security reasons, Genesys strongly recommends that you use a dedicated object storage account for the GIM persistent storage, and do not share the storage account created for GSP and GCA. GSP and GCA can share an account, and this is the expected deployment.}}
+
{{NoteFormat|GSP and GCA use object storage to store data during processing. For safety and security reasons, Genesys strongly recommends that you use a dedicated object storage account for the GIM persistent storage, and do not share the storage account created for GSP and GCA.}}
  
−
If you are not using obect storage, you can configure GIM to store exported data in a local directory. In this case, you do not need to create the object storage.
+
As another alternative, you can configure GIM to store your exported data in a local directory<!--{{Editgrn_open}} (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=ConfigureGIM|anchor=Options|display text=Configure GIM behavior}}){{Editgrn_close}}-->. In this case, you do not need to create the object storage.
 
|NetworkStatus=No
 
|NetworkStatus=No
 
|NetworkText=No special network requirements.
 
|NetworkText=No special network requirements.
 
|BrowserStatus=No
 
|BrowserStatus=No
 
|DependenciesStatus=No
 
|DependenciesStatus=No
−
|DependenciesText=*You must have your Tenant ID information available.
+
|DependenciesText=
−
*There are no strict dependencies among the Genesys Info Mart services, but the logic of your particular pipeline might require them to be deployed in a particular order. Depending on the order of deployment, there might be temporary data inconsistencies until all the Genesys Info Mart services are operational. For example, GCA might try to access the Info Mart database to synchronize configuration data but if GIM has not yet been deployed, the Info Mart database will be empty.
+
*You must have your Tenant ID information available.
 +
*There are no strict dependencies between the Genesys Info Mart services, but the logic of your particular pipeline might require Genesys Info Mart services to be deployed in a particular order. Depending on the order of deployment, there might be temporary data inconsistencies until all the Genesys Info Mart services are operational. For example, GCA might try to access the Info Mart database to synchronize configuration data; if GIM has not yet been deployed, the Info Mart database will be empty.
  
 
For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
 
For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
 
|GDPRStatus=No
 
|GDPRStatus=No
−
|GDPRText={{Editgrn_open}}GIM provides full support for you to comply with Right of Access ("export") or Right of Erasure ("forget") requests from consumers and employees with respect to personally identifiable information (PII) in the Info Mart database.
+
|GDPRText=GIM does not yet support GDPR compliance. For details about the Info Mart database tables and columns that potentially contain personally identifiable information (PII), see the description of the [https://docs.genesys.com/Documentation/GIM/latest/PDMPostgre/Table-CTL_GDPR_HISTORY CTL_GDPR_HISTORY table] in the Genesys Info Mart on-premises documentation.
−
 
 
−
[LB: How something along these lines (first draft + new girl allowances etc.), as a workaround because we have not yet gotten to this ticket. NOTE: This itself may not be right, but I think it is the right level of detail for the treatment here. We can fix the details if I have it wrong.]
 
−
 
 
−
Genesys Info Mart is designed to comply with General Data Protection Regulation (GDPR) policies. Support for GDPR includes the following:
 
−
 
 
−
* The way that Genesys Info Mart processes customer files complies with Right of Access ("export") and Right of Erasure (""forget") requirements.
 
−
* Genesys Infor Mart supports configuring data retention policies.
 
−
* GDPR processing is fully audited.
 
−
 
 
−
[For now, until feel able to publish the target page, we hide the reference below. (I mean, I don't really see why we can't give the table name for PII data.) It is a workaround, but I think it is works well enough.]
 
−
 
 
−
For more information about how Genesys Info Mart implements support for GDPR requests, see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=GDPR}}.{{Editgrn_close}} For details about the Info Mart database tables and columns that potentially contain PII, see the description of the [https://docs.genesys.com/Documentation/GIM/latest/PDMPostgre/Table-CTL_GDPR_HISTORY CTL_GDPR_HISTORY table] in the Genesys Info Mart on-premises documentation.
 
 
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
 
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
 
}}
 
}}

Revision as of 16:46, September 2, 2022

This topic is part of the manual Genesys Info Mart Private Edition Guide for version Current of Reporting.

Find out what to do before deploying GIM.

Limitations and assumptions

Instructions are provided for a single-tenant deployment.

Download the Helm charts

GIM and GIM monitoring are the only services that run in the GIM Docker container. The Helm charts included with the GIM release provision GIM and any Kubernetes infrastructure necessary for GIM to run.

See Helm charts and containers for Genesys Info Mart for the Helm chart version you must download for your release.

For information about how to download the Helm charts, see Downloading your Genesys Multicloud CX containers.

Third-party prerequisites

For information about setting up your Genesys Multicloud CX private edition platform, see Software requirements.

The following table lists the third-party prerequisites for GIM.

Third-party services
Name Version Purpose Notes
PostgreSQL 11.x Relational database.You must create the Info Mart database (see below).
Kafka 2.x Message bus.The Kafka topics GIM will consume must exist in the Kafka configuration. GIM consumes the topics GSP produces. For more information, see Kafka configuration.
Object storage Persistent or shared data storage, such as Amazon S3, Azure Blob Storage, or Google Cloud Storage.(Optional) For the Data Export feature, GIM uses object storage to store the exported data. Alternatively, you can elect to store the exported data in a directory on a local machine.
A container image registry and Helm chart repository Used for downloading Genesys containers and Helm charts into the customer's repository to support a CI/CD pipeline. You can use any Docker OCI compliant registry.
Command Line Interface The command line interface tools to log in and work with the Kubernetes clusters.

Storage requirements

GIM uses PostgreSQL for the Info Mart database and, optionally, uses object storage to store exported Info Mart data.

PostgreSQL — the Info Mart database

The Info Mart database stores data about agent and interaction activity, Outbound Contact campaigns, and other services usage in your contact center. A subset of tables and views created, maintained, and populated by Reporting and Analytics Aggregates (RAA) provides the aggregated data on which Genesys CX Insights (GCXI) reports are based.

A sizing calculator for Genesys Multicloud CX private edition is under development. In the meantime, the interactive tool available for on-premises deployments might help you estimate the size of your Info Mart database, see Genesys Info Mart 8.5 Database Size Estimator.

Genesys recommends a minimum 3 IOPS per GB.

For information about creating the Info Mart database, see Create the Info Mart database.

Create the Info Mart database

Use any database management tool to create the Info Mart ETL database and user.

  1. Create the database.
  2. Create a user for the Genesys Info Mart services to use, and grant full permissions to the user for that database.
    This user’s account is used by Genesys Info Mart jobs to access the Info Mart database schema.
    The Info Mart schema name is public.
    Important
    Make a note of the database and user details, which you use to populate database-related Helm chart override values for GIM and GCA.

Object storage — Data Export packages

The GIM Data Export feature enables you to export data from your Info Mart database. Unless you elect to store your exported data in a local directory, your Info Mart data is exported to an object store. GIM supports export to Azure Blob Storage or S3-compatible storage provided by OpenShift and Google Cloud Platform (GCP).

If you want to use S3-compatible storage, follow the Create object storage instructions for GSP to create the S3-compatible storage for GIM.

Important
GSP and GCA use object storage to store data during processing. For safety and security reasons, Genesys strongly recommends that you use a dedicated object storage account for the GIM persistent storage, and do not share the storage account created for GSP and GCA.

As another alternative, you can configure GIM to store your exported data in a local directory. In this case, you do not need to create the object storage.

Network requirements

No special network requirements.

Browser requirements

Not applicable

Genesys dependencies

  • You must have your Tenant ID information available.
  • There are no strict dependencies between the Genesys Info Mart services, but the logic of your particular pipeline might require Genesys Info Mart services to be deployed in a particular order. Depending on the order of deployment, there might be temporary data inconsistencies until all the Genesys Info Mart services are operational. For example, GCA might try to access the Info Mart database to synchronize configuration data; if GIM has not yet been deployed, the Info Mart database will be empty.

For detailed information about the correct order of services deployment, see Order of services deployment.

GDPR support

GIM does not yet support GDPR compliance. For details about the Info Mart database tables and columns that potentially contain personally identifiable information (PII), see the description of the CTL_GDPR_HISTORY table in the Genesys Info Mart on-premises documentation.

Retrieved from "https://all.docs.genesys.com/PEC-REP/Current/GIMPEGuide/PlanningGIM (2025-06-19 13:12:59)"
Comments or questions about this documentation? Contact us for support!