User:Jdruker/GIMPEGuide Architecture2 - Revision history

WikiSysop at 16:46, April 12, 2022

2022-04-12T16:46:35Z

WikiSysop at 15:15, April 8, 2022

2022-04-08T15:15:58Z

WikiSysop at 14:45, April 8, 2022

2022-04-08T14:45:32Z

WikiSysop at 12:30, April 7, 2022

2022-04-07T12:30:38Z

WikiSysop at 12:15, April 7, 2022

2022-04-07T12:15:38Z

WikiSysop at 00:30, April 7, 2022

2022-04-07T00:30:31Z

WikiSysop at 00:15, April 7, 2022

2022-04-07T00:15:31Z

WikiSysop: Created page with "=Architecture= [Proposed extension of the GIM PE Guide Architecture page.] ==Introduction== Genesys Info Mart is the his..."

2022-04-07T00:00:32Z

Created page with "=Architecture= [Proposed extension of the GIM PE Guide Architecture page.] ==Introduction== Genesys Info Mart is the his..."

New page

=Architecture=
[Proposed extension of the GIM PE Guide [[Draft:PEC-REP/Current/GIMPEGuide/ArchitectureMain|Architecture]] page.]

==Introduction==
Genesys Info Mart is the historical reporting back-end service that performs extract, transform, and load (ETL) processing of data generated by contact center activity. Genesys Info Mart comprises the following services:

*GIM Config Adapter (GCA) — Reads configuration data from the contact center Configuration Database and stores the data into Kafka topics for consumption during transformation processing. There is a separate GCA service for each tenant.
*GIM Stream Processor (GSP) — Processes GCA-sourced configuration data and raw event data streamed to Kafka from upstream services handling interaction and agent activity on Voice and Digital channels. GSP transforms the data into data structures suitable for a data mart for contact center historical reporting.
*GIM — Pulls the transformed data from Kafka and loads the transformed data into the Info Mart database. The GIM service also performs other database-related tasks, such as a regular maintenance job and an export job to export Info Mart data. There is a separate GIM service and Info Mart database for each tenant.

All the Genesys Info Mart services are stateful. This has implications for high availability (HA) and disaster recovery (DR) (see [[Draft:PEC-REP/Current/GIMPEGuide/HADR|High availability and disaster recovery]]) as well as for upgrade methods, because you cannot deploy mirrored services in parallel.

For information about the overall architecture of Genesys Multicloud CX private edition, see the high-level [[Draft:PrivateEdition/Current/PEGuide/Architecture|Architecture]] page.

{{Editgrn_open}}The following diagrams show the Genesys Info Mart architecture. {{Editgrn_close}}
* {{Editgrn_open}}[[{{FULLPAGENAME}}#DataFlows|Architecture diagram — Data flows]] is from the point of view of data.{{Editgrn_close}}
* {{Editgrn_open}}[[{{FULLPAGENAME}}#Connections|Architecture diagram — Connections]] is from the point of view of network connections.{{Editgrn_close}}

{{Editgrn_open}}See also [[Draft:PEC-REP/Current/GIMPEGuide/HADR|High availability and disaster recovery]] for information about high availability/disaster recovery architecture.{{Editgrn_close}}

{{AnchorDiv|DataFlows}}
=={{Editgrn_open}}Architecture diagram — Data flows{{Editgrn_close}}==
{{Editgrn_open}}The numbers on the connection lines refer to the connection numbers in the [[{{FULLPAGENAME}}#ConnectionsTable|Connections table]] that follows the diagrams. The direction of the arrows indicates the direction of data flows.{{Editgrn_close}}

{{Editgrn_open}}<font color="red">'''Writer's note:''' Diagram will be the same as the Connections one except for the arrows. The current Connections diagram is used here as a placeholder.</font>{{Editgrn_close}}
[[File:pe_gim_architecture_diagram.png]]

{{AnchorDiv|Connections}}
==Architecture diagram {{Editgrn_open}}— Connections{{Editgrn_close}}==
{{Editgrn_open}}The numbers on the connection lines refer to the connection numbers in the [[{{FULLPAGENAME}}#ConnectionsTable|Connections table]] that follows the diagrams. The direction of the arrows indicates where the connection is initiated (the source) and where it connects to (the destination), from the point of view of Genesys Info Mart as a service in the network. In the [[{{FULLPAGENAME}}#ConnectionsTable|Connections table]], ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination.{{Editgrn_close}}

[[File:pe_gim_architecture_diagram.png]]

{{AnchorDiv|ConnectionsTable}}
{{#cargo_query:tables=PEConnections
|fields=Connection,SourceType,Source,DestinationType,Destination,Protocol,Port,Purpose,Classification
|intro=<h2>Connections table</h2><table class="sortable"><tr><th>Connection</th><th>Source</th><th>Destination</th><th>Protocol</th><th>Port</th><th>{{Editgrn_open}}Connection{{Editgrn_close}} Classification</th><th>Data that travels on this connection</th></tr>
|outro=</table>
|named args=yes
|default=
|format=template
|template=PEConnectionsPrint
|where=PEConnections._pageName="Draft:PEC-REP/Current/GIMPEGuide/ArchitectureMain" AND Connection IS NOT NULL
|order by=Connection ASC
}}
===Ports used for internal purposes===
{{Editgrn_open}}<font color=red>'''Writer's note:''' The original requirement was to document all ports used across the PE deployment, so customers would be able to pre-empt conflicts if they change port allocations. However, both the diagram and the table seem to have been taken over by the focus on network connections, and I don't know if this means it's crowded out info about internal ports that customers might still want to know. Should we include information like the following table, which I populated from ports specified in the values.yaml?</font>{{Editgrn_close}}

{{Editgrn_open}}GSP uses the following ports for internal connections with Flink.{{Editgrn_close}}
{{{!}}
! '''Port'''
! '''Protocol'''
{{!}}-
{{!}} colspan="2" {{!}} Task manager
{{!}}-
{{!}} 6122
{{!}} RPC
{{!}}-
{{!}} colspan="2" {{!}} Job manager
{{!}}-
{{!}} 6123
{{!}} RPC
{{!}}-
{{!}} 6124
{{!}} Blob
{{!}}-
{{!}} 8081
{{!}} REST
{{!}}}</font></div>

@@ Line 44: / Line 44: @@
 {{AnchorDiv|ConnectionsTable}}
 ==Connections table==
-The connection numbers refer to the numbers on the connection lines in the diagrams above. The '''Source''', '''Destination''', and '''Connection Classification''' columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where an initiated connection connects to, from the point of view of Genesys Info Mart as a service in the network. ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination. ''Intra-cluster'' means the connection is internal.
+The connection numbers refer to the numbers on the connection lines in the diagrams above. The '''Source''', '''Destination''', and '''Connection Classification''' columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where an initiated connection connects to, from the point of view of Genesys Info Mart as a service in the network. ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination. ''Intra-cluster'' means the connection is between services in the cluster.
 {{#cargo_query:tables=PEConnections
 |fields=Connection,SourceType,Source,DestinationType,Destination,Protocol,Port,Purpose,Classification

@@ Line 35: / Line 35: @@
 {{AnchorDiv|ConnectionsTable}}
 ==Connections table==
-{{Editgrn_open}}The connection numbers refer to the numbers on the connection lines in the diagrams above. The '''Source''', '''Destination''', and '''Connection Classification''' columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where the connection connects to, from the point of view of Genesys Info Mart as a service in the network. ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination.{{Editgrn_close}}
+{{Editgrn_open}}The connection numbers refer to the numbers on the connection lines in the diagrams above. The '''Source''', '''Destination''', and '''Connection Classification''' columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where an initiated connection connects to, from the point of view of Genesys Info Mart as a service in the network. ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination.{{Editgrn_close}}
 {{#cargo_query:tables=PEConnections
 |fields=Connection,SourceType,Source,DestinationType,Destination,Protocol,Port,Purpose,Classification

@@ Line 29: / Line 29: @@
 {{AnchorDiv|Connections}}
 ==Architecture diagram {{Editgrn_open}}— Connections{{Editgrn_close}}==
-{{Editgrn_open}}The numbers on the connection lines refer to the connection numbers in the [[{{FULLPAGENAME}}#ConnectionsTable|table]] that follows the diagrams. The direction of the arrows indicates where the connection is initiated (the source) and where it connects to (the destination), from the point of view of Genesys Info Mart as a service in the network.{{Editgrn_close}}
+{{Editgrn_open}}The numbers on the connection lines refer to the connection numbers in the [[{{FULLPAGENAME}}#ConnectionsTable|table]] that follows the diagrams. The direction of the arrows indicates where the connection is initiated (the source) and where an initiated connection connects to (the destination), from the point of view of Genesys Info Mart as a service in the network.{{Editgrn_close}}
 [[File:pe_gim_architecture_diagram.png]]
@@ Line 35: / Line 35: @@
 {{AnchorDiv|ConnectionsTable}}
 ==Connections table==
-{{Editgrn_open}}The connection numbers refer to the numbers on the connection lines in the diagrams above. The '''Source''', '''Destination''', and '''Connection Classification''' columns in the table relate to the direction of the arrows in the Connections diagram: The source is where the connection is initiated, and the destination is where the connection connects to, from the point of view of Genesys Info Mart as a service in the network. ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination.{{Editgrn_close}}
+{{Editgrn_open}}The connection numbers refer to the numbers on the connection lines in the diagrams above. The '''Source''', '''Destination''', and '''Connection Classification''' columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where the connection connects to, from the point of view of Genesys Info Mart as a service in the network. ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination.{{Editgrn_close}}
 {{#cargo_query:tables=PEConnections
 |fields=Connection,SourceType,Source,DestinationType,Destination,Protocol,Port,Purpose,Classification

@@ Line 1: / Line 1: @@
 =Architecture=
-[Proposed extension of the GIM PE Guide [[Draft:PEC-REP/Current/GIMPEGuide/ArchitectureMain|Architecture]] page.]
+''Proposed extension of the [[Template:ArticlePEServiceArchitecture|ArticlePEServiceArchitecture template]]. This example extends [[Draft:PEC-REP/Current/GIMPEGuide/ArchitectureMain|GIM Architecture]].''<br/>
 ==Introduction==
 Genesys Info Mart is the historical reporting back-end service that performs extract, transform, and load (ETL) processing of data generated by contact center activity. Genesys Info Mart comprises the following services:
@@ Line 9: / Line 17: @@
 *GIM —  Pulls the transformed data from Kafka and loads the transformed data into the Info Mart database. The GIM service also performs other database-related tasks, such as a regular maintenance job and an export job to export Info Mart data. There is a separate GIM service and Info Mart database for each tenant.
-All the Genesys Info Mart services are stateful. This has implications for high availability (HA) and disaster recovery (DR) (see [[Draft:PEC-REP/Current/GIMPEGuide/HADR|High availability and disaster recovery]]) as well as for upgrade methods, because you cannot deploy mirrored services in parallel.
+All the Genesys Info Mart services are stateful. This has implications for high availability (HA) and disaster recovery (DR) (see [[Draft:PEC-REP/Current/GIMPEGuide/HADR|High availability and disaster recovery]]) as well as for upgrade methods, because you cannot deploy mirrored services in parallel.</font>
 For information about the overall architecture of Genesys Multicloud CX private edition, see the high-level [[Draft:PrivateEdition/Current/PEGuide/Architecture|Architecture]] page.
-The following diagrams show the Genesys Info Mart architecture.
+<font color="#B24DE7">The following diagrams show the Genesys Info Mart architecture.
 *[[{{FULLPAGENAME}}#DataFlows|Architecture diagram — Data flows]] is from the point of view of data.
-*[[{{FULLPAGENAME}}#Connections|Architecture diagram — Connections]] is from the point of view of network connections.
+*[[{{FULLPAGENAME}}#Connections|Architecture diagram — Connections]] is from the point of view of network connections.</font>
 See also [[Draft:PEC-REP/Current/GIMPEGuide/HADR|High availability and disaster recovery]] for information about high availability/disaster recovery architecture.
-{{AnchorDiv|DataFlows}}
+{{AnchorDiv|DataFlows}}<font color="#B24DE7">
 ==Architecture diagram — Data flows==
-{{Editgrn_open}}<font color="red">'''Writer's note:''' The diagram will be the same as the Connections one except for the arrows. The current Connections diagram is used here as a placeholder.</font>{{Editgrn_close}}
+</font>{{Editgrn_open}}<font color="red">'''Writer's note:''' The diagram will be the same as the Connections one except for the arrows. The current Connections diagram is used here as a placeholder.</font>{{Editgrn_close}}
-The numbers on the connection lines refer to the connection numbers in the [[{{FULLPAGENAME}}#ConnectionsTable|table]] that follows the diagrams. The direction of the arrows indicates the direction of data flows.
+<font color="#B24DE7">The numbers on the connection lines refer to the connection numbers in the [[{{FULLPAGENAME}}#ConnectionsTable|table]] that follows the diagrams. The direction of the arrows indicates the direction of data flows.</font>
 [[File:pe_gim_architecture_diagram.png]]
@@ Line 35: / Line 44: @@
 {{AnchorDiv|ConnectionsTable}}
 ==Connections table==
-The connection numbers refer to the numbers on the connection lines in the diagrams above. The '''Source''', '''Destination''', and '''Connection Classification''' columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where an initiated connection connects to, from the point of view of Genesys Info Mart as a service in the network. ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination.
+The connection numbers refer to the numbers on the connection lines in the diagrams above. The '''Source''', '''Destination''', and '''Connection Classification''' columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where an initiated connection connects to, from the point of view of Genesys Info Mart as a service in the network. ''Egress'' means the Genesys Info Mart service is the source, and ''Ingress'' means the Genesys Info Mart service is the destination. ''Intra-cluster'' means the connection is internal.
 {{#cargo_query:tables=PEConnections
 |fields=Connection,SourceType,Source,DestinationType,Destination,Protocol,Port,Purpose,Classification
@@ Line 47: / Line 56: @@
 |order by=Connection ASC
 }}
 ===Ports used for internal purposes===
-GSP uses the following ports for internal connections with Flink.
+<font>
 {{{!}}
 ! '''Port'''
@@ Line 68: / Line 80: @@
 {{!}} 8081
 {{!}} REST
-{{!}}}
+{{!}}}</font>

@@ Line 21: / Line 21: @@
 {{AnchorDiv|DataFlows}}
 =={{Editgrn_open}}Architecture diagram — Data flows{{Editgrn_close}}==
 {{Editgrn_open}}The numbers on the connection lines refer to the connection numbers in the [[{{FULLPAGENAME}}#ConnectionsTable|table]] that follows the diagrams. The direction of the arrows indicates the direction of data flows.{{Editgrn_close}}
 [[File:pe_gim_architecture_diagram.png]]