Skip to main content

xSuite Archive Prism Installation Guide

Changing Settings in the appsettings.json File

The expert settings are primarily meant for use in private cloud solutions. The standard values deliver good results for use on-premises.

The Expert Settings are available in the appsettings.json and can be used independently of the installation wizard.

Example:

"Settings": {"XFLOW_ARCHIVE_CFG_CONNECTIONSTRING":"mongodb://localhost:27017",
"xSuite.Archive.ConfigDataBase.Connection":"mongodb://localhost:27017",
"xSuite.Archive.BackgroundIndexer":"false",
"xSuite.Archive.StartScheduler":"true",
"xSuite.Archive.ToolsTaskTrigger": "0/30 * * * * ?"
"xSuite.Archive.ConfigDataBase.Database": "xSuiteArchiveConfiguration"}

The expert settings are the values that begin with xSuite.Archive.

The XFLOW_ARCHIVE_ values serve different purposes in the setup of xSuite Archive Prism, and may not be removed.

The value xSuite.Archive.ConfigDataBase.Connection will also be set in during setup. It defines the connection to the configuration database. However, this value can be changed during installation

It is a MongoDB connection string structured as follows:

mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]

Activating and De-activating the Cache

"xSuite.Archive.MemoryCachePolicy"

The default setting for this parameter: no value

The server has numerous caches (e.g., for configuration of the archive, for indexes, and for document types). Access is accelerated through the use of these caches; minutes after use, data is removed from them. This can be configured in the system settings.

xSuite Archive 2.x supports cluster operation with multiple archive nodes and one Encore. xSuite Encore selects whichever of the nodes happens to be first available.

Caution

This procedure has not yet been tested or approved for Version 2.x. To provide for use of the procedure in test operation or as a pilot project, the caches must be shut down. Cluster operation only functions without the server state. For this, enter the value CLUSTER. This setting deactivates all caches, regardless of what cache time period has been entered in the system settings.

Activating and De-activating Asynchronous Indexing

"xSuite.Archive.BackgroundIndexer"

Default setting for this parameter: true.

Starting with xSuite Archive Prism 2.x, standard, synchronous indexing can proceed via the client by queue. This type of indexing is not executed at a later point in time by way of the indexer scheduler task. Instead, it is executed either practically synchronously or seconds later. This lessens the burden for Elasticsearch 7.

To keep the operation identical with Version 1.x, set this value to false or leave the parameter empty.

CRON String for the Tools Scheduler Task

"xSuite.Archive.ToolsTaskTrigger"

Default setting for this parameter: 0/30 * * * * ?

The default value sets execution every 30 seconds.

The ToolsTaskTrigger checks whether tools are ready to be executed, and then executes these tools.

xSuite Group GmbH recommends not changing the default value.

MongoDB Server Services

The services and database connections can be entered into the expert settings appsettings.json file.

Database Connections That Can Be Defined for the Following Services

  • MongoDB connection string for background importing

    "xSuite.Archive.Import.Connection"

    Database connection for import by scheduler task

  • MongoDB connection string for caching

    "xSuite.Archive.Cache.Connection"

    Database connection for caching

  • MongoDB connection string for tools

    "xSuite.Archive.Tools.Connection"

    Database connection for tool execution on the server within the web interface

  • MongoDB connection string for logging

    "xSuite.Archive.Logging.Connection"

    Database connection for logging

Databases That Can Be Defined for the Following Services

  • Database name of file storage for tools

    "xSuite.Archive.FileStorageDataBaseName"

    Name of the database for the new file storage

    The connection to the configuration database server is used.

  • Database name for background import

    "xSuite.Archive.Import.Database"

    Name of the import database for import by scheduler task

  • Database name for system messaging

    “xSuite.Archive.MessagingDataBaseName"

    Name of messaging queue database

  • Database name for caching

    "xSuite.Archive.Cache.Database"

    Name of the database for persistent caches. These are used for purposes such as login sessions.

  • Database name for background tools

    "xSuite.Archive.Tools.Database"

    Name of database for the executing server tools and their results

  • Database name for logging

    "xSuite.Archive.Logging.Database"

    Name of the logging database

In this section: