ContextStoreManager attribute descriptions

Last Updated : Dec 16, 2021 |
Prolog information
Metadata
Keywords:
After configuring the following ContextStoreManager attributes which control the data grid you must restart all servers in the cluster:
  • ContextStore DataGrid type
  • ContextStore ManagerSpace DataGrid Settings
  • ContextStoreSpace DataGrid Settings
Context Store supports runtime configuration or re-configuration of the ContextStoreManager GEO attributes. First, disable the applicable attribute for this feature and then enable it again after modifying or adding the connection details:
  • For the External Data Mart connection, restart is automatic.
  • For the Geo-Redundancy connection, GEO: Enable session preservation
Note:
The ContextStore DataGrid Type or ContextStoreSpace DataGrid Settings attributes cannot be changed dynamically. If this value is not already set to GEO or PROVISIONED-GEO type, you must remove the existing data-grid, and restart the cluster.
Field
Description
License Features
FEAT_CS_EXPIRATION
Context Store expiration feature
VALUE_CS_AEP_CONNECTOR
Context Store AEP connector
VALUE_CS_API
Context Store API
VALUE_CS_GEO_REDUNDANT_1
Context Store Geo Redundancy
VALUE_CS_SERVER
Context Store server
VALUE_CS_USERS
Context Store users
Startup Configuration
ContextStore DataGrid type
Mandatory attribute
The type of Context Store data grid. Four options are available:
  • STANDARD: A single cluster deployment with non-provisioned data grid.
  • GEO: A geo-redundant deployment with non-provisioned data grid.
  • PROVISIONED: A single cluster deployment with provisioned data grid.
  • PROVISIONED-GEO: A geo-redundant deployment with provisioned data grid.
The default deployment option is STANDARD.
ContextStore ManagerSpace DataGrid Settings
Mandatory attribute
A comma-separated list of two numbers: {memoryCapacityPerContainer},{maximumMemoryCapacity}.
The default values are 128m, 256m.
The system interprets a numeric value only as megabytes. You can specify megabytes with an m or mb after the number. For example, 256m, 1024m.
You can specify gigabytes with a g or gb after the number. For example, 1g, 2g.
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
ContextStoreSpace DataGrid Settings
Mandatory attribute
A comma-separated list of two numbers: {memoryCapacityPerContainer},{maximumMemoryCapacity}.
The default values are 512m, 10240m.
The system interprets a numeric value only as megabytes. You can specify megabytes with an m or mb after the number. For example, 512m, 10240m.
You can specify gigabytes with a g or gb after the number. For example, 1g, 2g.
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
Solution Type
The type of deployment.
The options are:
  • Standalone
  • Oceana
  • Elite
External Data Mart Configuration
Secure Connections to EDM
Specifies whether communication between Context Store and EDM uses a secure connection.
The default value is true.
Note:
For unsecured connections from Context Store to EDM, you must set the value to false. The unsecured EDM connections is only for lab use. It is not intended for Context Store instances that conform to security policies.
EDM: Enable Persistence to database
Setting this to true enables persistence of context data to the customer-provided External Data Mart. The accepted values are:
  • true: Enables persistence to the external data mart.
  • false: Disables persistence to the external data mart
The default value is false.
EDM: Persistence Type
Specifies how Context Store data is stored in EDM.
The options are:
  • Audit: Enables persistence of Audit context data to EDM.
  • Journey: Enables persistence of Customer Journey and Context Resurrection related data to EDM.
For more information, see External Data Mart persistence.
Important:
Avaya Oceana® deployment must use the Journey persistence type.
EDM: Enable Provisioning from database
Setting this to 'true' will enable provisioning of context data from the customer-provided External Data Mart. The accepted values are:
  • true: Enables provisioning to the external data mart.
  • false: Disables provisioning to the external data mart
The default value is false.
EDM: Database type
The type of EDM database. The accepted values are:
  • Microsoft SQL Server
  • PostgreSQL
EDM: TLS version
The TLS version for connection to the EDM database.
EDM: Database host
The host for the EDM database.
EDM: Database port
The port for the EDM database.
EDM: Database name
Name of the database used as External Data Mart
EDM: Database username
User name for the External Data Mart database connection.
EDM: Database password
Password for the External Data Mart database connection.
EDM: Disable persistence of personally identifiable data
The attribute to ensure that any potentially personally identifiable, such as the data field and the collected digits within Avaya Oceana®, are not replicated to External Data Mart.
You must enable this attribute if any Personally Identifying Information is written into the data field, or entered into the collected digits, to comply with Data Privacy Laws.
For Avaya Oceana®, the default value is true.
EDM: Keep closed contacts for
The attribute to ensure that contexts related to closed contacts are kept for a period of time after being removed from the EDM.
The value range is 0-3650.
Setting this attribute to 0 keeps the closed contacts permanently. However, it is not recommended because of performance implications.
The default value is 30.
EDM: Run maintenance at hour
The hour of the day at which EDM maintenance runs.
The value range is 0-23. The default value is 2 (02:00).
EDM: Mirror Service container size
Memory required for the External Data Mart Mirror Service deployment.
The default value is 128m.
The system interprets a numeric value only as megabytes. You can specify megabytes with an m or mb after the number. For example, 128m.
You can specify gigabytes with a g or gb after the number. For example, 1g.
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
EDM: Mirror Service redo log size
The amount of context data to store for retry if disconnected from the External Data Mart (EDM). The system discards the oldest data when this size limit is reached.
Range: 10000 to 250000
The default value is 60000.
The configuration for this attribute provided for different deployment scenarios in the Data-grid Configuration Settings under ContextStoreManager Attributes section of the Context Store Release Notes, is designed to store approximately 30 minutes of data.
Run-Time Service Configuration
Cluster Deny Service on two node outage
Determines whether to deny or accept service when two nodes in a cluster are unavailable. If disabled, the last remaining node continues to attempt service requests. The accepted values are:
  • true: If two nodes in a cluster are unavailable, the third node also denies service.
  • false: Even if two nodes in a cluster are unavailable, the third node tries to serve incoming requests.
The default value is false.
Note:
This attribute is not applicable for one or two-node deployments.
CS Audit: Event limit
Configure the limit of event entries in the audit trail of context objects.
  • Range: 0 to 50
  • Default value: 1
Setting this value to 0 disables the Audit Trail feature. You can update this attribute dynamically. Changes you make do not become effective on a context until the next interaction with that object.
Note:
If you enable the Audit trail feature in a geo-redundant deployment, the CS Audit: Event limit attribute must be set identically in both clusters.
CS Default Lease Time
Default lease time, in seconds, for context data to live in the in-memory data cache. Context Store automatically removes a context if the context remains in Context Store for the lease period without any change.
This attribute specifies the default lease time that Context Store uses when you do not specify any lease time for a context entry.
  • Range: 1 to 86400
  • Default value: 7200
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
Note:
CS Default Lease Time is not applicable to the contexts in the CS_PROVISION table. The contexts in the CS_PROVISION table have an infinite lease time and remain in the data grid permanently until they are deleted manually.
CS Maximum Lease Time
Maximum lease time, in seconds, for context data. The system logs warnings for leases longer than this value.
If the average lease time for the cluster exceeds this value, Context Store raises an error event. If a context is created or updated with a lease time that exceeds this value, Context Store logs only a warning.
  • Range: 1 to 86400
  • Default value: 14400
CS Threshold: Instance High Requests per Second
High threshold on Context Store instance requests per second. Must be greater than related Minima. If the requests per second for an instance exceeds this value, the Context Store instance rejects the further requests and raises an event.
  • Range: 1 to 650
  • Default value: 14
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
CS Threshold: Instance Low Requests per Second
Low threshold on Context Store instance requests per second. Must be lower than related Maxima. If the requests per second for an instance exceeds this value, the Context Store instance raises an event, without rejecting any further requests.
  • Range: 1 to 650
  • Default value: 12
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
CS Threshold: Max Error Rate
Threshold for maximum tolerated Context Store request error rate in percentage
  • Range: 1 to 100
  • Default value: 20
CS Threshold: Max Latency
Threshold for maximum tolerated Context Store request latency in milliseconds. When the average latency exceeds the value you have specified in this field, Context Store raises an event.
  • Range: 1 to 5000
  • Default value: 250
Note:
The average latency of a request in an hour, is less than 250 milliseconds with a maximum latency of two seconds.
CS Threshold: Service High Requests per Second
High threshold on Context Store service requests per second. Must be greater than related Minima. If the service requests per second for a Context Store cluster exceeds the value you have specified in this attribute, Context Store rejects the further service requests and also raises an event.
  • Range: 1 to 1240
  • Default value: 35
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
CS Threshold: Service Low Requests per Second
Low threshold on Context Store service requests per second. Must be lower than related Maxima. If the service requests per second for a Context Store cluster exceeds the value you have specified in this attribute, Context Store raises an alarm, without rejecting the further service requests.
  • Range: 1 to 1240
  • Default value: 25
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
Geo Redundancy Configuration
GEO: Enable session preservation
Setting this to 'true' enables Geo-Redundancy between configured Context Store clusters. The accepted values are:
  • true: Enables geo redundancy
  • false: Disables geo redundancy
The default value is false.
Geo: Gateway Service container size
Memory required for Geo-Redundancy Gateway Service deployment.
The system interprets a numeric value only as megabytes. You can specify megabytes with an m or mb after the number. For example, 128m.
You can specify gigabytes with a g or gb after the number. For example, 1g.
For values specific to your deployment type, see the Certified Deployments section in Avaya Context Store Snap-in Release Notes.
The default value is 1g.
GEO: Keystore file name
Certificate name of the geo redundancy keystore.
GEO: Keystore password
Password of the geo redundancy keystore.
GEO: Target cluster Id
Name of the target cluster on the geo redundant site
Streams Configuration
Note:
Streams is no longer supported in Context Store.
Event Stream: Enable Event Streaming
Setting this to 'true' enables clients to subscribe for personalized events from Context Store.
Supplier
Supplier Id
The supplier Id that Avaya provides.
The default value is 10000000.
Advanced Configuration
Enable Centralized Logging
This value indicates that centralized logging is needed by the snap-in. Enables centralized logging after the snap-in is installed.