cassandraKeyspace Section

Important

Starting in 9.0.005.15, Cassandra support is deprecated in Genesys Co-browse and Redis is the default database for new customers. Support for Cassandra will be discontinued in a later release.

Important

Starting from 9.0.014.XXX, Co-browse Server does not support External Cassandra. Therefore, cassandraKeyspace section was removed from the Co-browse_Cluster_900 and Co-browse_Node_900 application templates and not supported.

dataCompression

Default Value: lz4
Valid Values: lz4, snappy, deflate
Changes Take Effect: Applied when the keyspace is created

Specifies data compression algorithm used when data is stored on the disk. Compression maximizes the storage capacity of Cassandra nodes by reducing the volume of data on the disk and disk I/O, particularly for read-dominated workloads. Cassandra quickly finds the location of rows in the SSTable index and decompresses the relevant row chunks. See http://docs.datastax.com/en/cassandra/2.0/cassandra/operations/ops_config_compress_t.html

name

Default Value: Cobrowse
Valid Values: string
Changes Take Effect: Applied when the keyspace is created

Specifies the Cassandra keyspace name where Co-browse server data will be stored. If the keyspace with this name does not exist in the cluster, it will be created automatically.

readConsistencyLevel

Default Value: LOCAL_QUORUM
Valid Values: ALL , EACH_QUORUM , QUORUM , LOCAL_QUORUM , ONE , TWO , THREE , LOCAL_ONE , ANY
Changes Take Effect: After Co-browse server restart

Specifies the consistency level. Determines the number of replicas on which the read must succeed before returning any data to the client application.

writeConsistencyLevel

Default Value: LOCAL_QUORUM
Valid Values: ALL , EACH_QUORUM , QUORUM , LOCAL_QUORUM , ONE , TWO , THREE , LOCAL_ONE , ANY
Changes Take Effect: After Co-browse server restart

Specifies the consistency level. Determines the number of replicas on which the write must succeed before returning an acknowledgment to the client application.

replicationStrategy

Default Value: NetworkTopologyStrategy
Valid Values: SimpleStrategy , NetworkTopologyStrategy
Changes Take Effect: Applied when the keyspace is created.

Specifies the keyspace replica placement strategy. See http://docs.datastax.com/en/cassandra/2.1/cassandra/architecture/architectureDataDistributeReplication_c.html.

Warning

Genesys strongly recomends not using SimpleStrategy. If you use SimpleStrategy, you cannot use more than one data center and KeySpaces you create will be difficult to migrate to NetworkTopologyStrategy once they contain a lot of data. Also see https://docs.datastax.com/en/cassandra/2.0/cassandra/architecture/architectureDataDistributeReplication_c.html

If you set your replication strategy to SimpleStrategy you must also:

• Configure a replication factor in the replicationStrategyParams option.
• For external Cassandra, set endpoint_snitch: SmipleSnitch in your cassandra.yaml file.

replicationStrategyParams

Default Value: 'OperationalDC':1
Valid Values:

For NetworkTopologyStrategy set the value to comma separated pairs of '[Some_Data_Center_Name]':[replication factor number]

When the replication strategy is SimpleStrategy, value should contain either a number or 'replication_factor':<number of replication factor>. For example, 3 or 'replication_factor':3.

Changes Take Effect: After Co-browse server restart.

Comma separated parameters which define how many replicas you want per data center.

retention.entity.all

Default Value: 1
Valid Values: Positive integer in time-units. Must be equal to or greater than any other retention.entity value.
Changes Take Effect: After Co-browse server restart.

Specifies the default duration in time-units (days by default) to keep data in a column family if a special duration is not present for the column family.

retention.entity.live_sessions

Default Value: 1
Valid Values: Positive integer in time-units. Must be greater than the amount of time expressed by the cometd/maxInterval option.
Changes Take Effect: After Co-browse server restart.

Warning

Starting with 8.5.003.04, the retention.entity.livesessionentity opton is now retention.entity.live_sessions. As documented in this known issue, the old option name is still in the configuration option template.

Specifies the duration in time-units (days by default) to keep data in the live_sessions column family. The column family stores the core Co-browse session state shared in the Co-browse cluster. In a normal situation, data from this column family is removed automatically shortly after a session is deactivated (when cometd/maxInterval elapses), but the retention policy mechanism guarantees that the data will be removed anyway. Default is 1 time-unit.

retention.entity.session_history

Default Value: 1
Valid Values: Positive integer in time-units. Must be greater than the amount of time expressed by the cometd/maxInterval option.
Changes Take Effect: After Co-browse server restart.

Warning

Starting with 8.5.003.04, the retention.entity.sessionhistoryentity option is now retention.entity.session_history. As documented in this known issue, the old option name is still in the configuration option template.

Specifies the duration in time-units (days by default) to keep data in the session_history column family.

retention.entity.window_history

Default Value: 1
Valid Values: Positive integer in time-units. Must be greater than the amount of time expressed by the cometd/maxInterval option.
Changes Take Effect: After Co-browse server restart.

Warning

Starting with 8.5.003.04, the retention.entity.windowhistoryentity option is now retention.entity.window_history. As documented in this known issue, the old option name is still in the configuration option template.

Specifies the duration in time-units (days by default) to keep data in the window_history column family. The column family is a temporary store for page navigation information.

retention.time-unit

Default Value: day
Valid Values: sec, min, hour, day, or month
Changes Take Effect: After Co-browse server restart.

Specifies the retention time unit to define retention.entity values.