Custom Big Table Data Store

The Custom Big Table Data Store object allows the user to create and configure multiple Big Table data stores in addition to System Big Table data store. The object can be created in the I/O Model beneath the Core or a Data Store Group object.

Quick Configuration

  1. Right click on the Core or a Data Store Group object and select Admin  New  Data Stores  Custom Big Table Data Store from the context menu to open the Create Object wizard.

  2. Give the object a unique name and enter a description if necessary.

  3. Click on the Big Table Data Store options from the wizard sidebar to view the data store settings. The default database name can be changed here and if necessary, the MongoDB connection settings can also be changed (for example, if you wish to connect to a remote MongoDB instance or configure replication sets).

  4. Click Create to create the object in the I/O model tree.

To select the newly created Custom Big Table Data Store as an archive for a particular property, go to the relevant property and configure the Big Table property capability. See the DataStudio documentation for more details.

Object Properties

Common

Object Name

The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description

This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

Display Alias

Alternate label for objects to be used for easier identification in the displays.

Attachments

File attachments stored in MongoDB file store.

Big Table Data Store

Custom Big Table data store configuration.

Database

The user-defined database storing Big Table data.

Purge Orphaned Tables

Delete Big Table data owned by objects which have been deleted.

MongoDB Connection

This property compound combines the properties of the MongoDB Connection e.g. the connection strings to the mongoDB.

Connection String

The connection string for the external system; depending on the type of connection.

Replication Set Name

Configuration name for MongoDB Replica Set.

Replication Set 1

The connection string for the core service to replication set 1.

Replication Set 2

The connection string for the core service to replication set 2.

Authentication Mode

Authentication mode to be used connecting the MongoDB instance.

  • No Authentication: No Authentication is performed when the System connects to a certain instance of MongoDB.

  • Challenge-Response: MONGODB-CR is the default authentication mechanism supported by MongoDB. Username and Password needs to be provided.

  • SCRAM-SHA-1 Authentication: Salted Challenge Response Authentication Mechanism (SCRAM) means that the password is never actually sent over the wire, but rather a computed proof that the client password is the same as the password the server knows.

  • X.509 Certificate: MONGODB-X509 mechanism authenticates a username derived from the distinguished subject name of a X.509 certificate.

  • LDAP (Lightweight Directory Access Protocol): Lightweight Directory Access Protocol (LDAP) service is used for MongoDB authentication.

  • SCRAM-SHA-256 Authentication: SCRAM-SHA-256 authentication means that the password is never actually sent over the wire, but rather a computed proof that the client password is the same as the password the server knows (non-ASCII characters in passwords are not supported).

  • Auto: Detect the default authentication mechanism for users with stored SCRAM-SHA-1 and SCRAM-SHA-256 credentials (requires MongoDB 4.0 or newer).

User Name

User Name.

Password

Password.

Compression

Compress MongoDB data on the wire.

Secure connections

Enable TLS for MongoDB connections.

Allow Invalid Hostnames

Allow invalid hostnames in the server certificate for TLS connections.

Allow Invalid Certificates

Allow invalid server certificates for TLS connections.

MongoDB URI

If not empty, the MongoDB URI takes precedence, overriding all other MongoDB connection settings. The string needs to be URL-encoded.

Effective MongoDB URI

The actual MongoDB URI used for current connection.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String

A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name

A custom property name which can be used programmatically.

Property Value

The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name

A custom table name which can be used programmatically.

Table Data

Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.