Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Administrative Database

The following properties are relevant for the connection to the administrative database and for logging on to the database.

Property

Description

Database.Type

Type of database system to be used:

  • None: use of an in-memory database (default value)

  • MsSqlServer: Microsoft SQL Server

  • PostgreSql: PostgreSQL

  • MongoDb: MongoDB

Database.Host

Name or IP address of the database server

Default value: localhost

Database.Port

Numerical specification of the IP port to be used if a port is used that is different from the standard of the database system

Database.Name

Name of the database

The database might either already exist or it will be newly created by the program. To create a database, the program must have the appropriate permissions.

The base name is automatically supplemented with the name of the (default) tenant.

Default value: xSuiteInterface5

Database.User(*)

Database.Password(*§)

User name and password for logging into the database. These credentials are not used if: 1) an anonymous login is used for a MongoDB database, or 2) Windows authentication is used for one of the SQL databases.

Database.WindowsLogin

Boolean value determining whether Windows authentication with the current user will be performed for either an SQL-server database system or a PostgreSQL database system

Default value: TRUE

Database.Encrypt

Type of TLS encryption of the connection to the server:

  •  Optional: automatically negotiated with server (default value)

  • Mandatory: absolutely necessary

  • Strict: mandatory according to TDS 8.0

SSL encryption must be set up on the server side.

This property is only relevant for the database system Microsoft SQL Server.

Default value: TRUE

Database.ConnectionString

As an alternative to the connection and authentication properties listed above, you can define a connection string directly in the syntax of the specific database system; this connection string will then be used instead of the connection and authentication properties.

The .Password property can also be defined separately when using a connection string, inserted into the string via the %Password% variable.

Database.SqlDbScheme

Name of a database schema that is used differently from the default schema of an SQL Server database or PostgreSQL database (optional)

The schema must be specified when the database is initially created by the program. Existence checks of the database that are carried out later do not explicitly check whether the schema has changed. The database must then be completely deleted, and recreated by the program. The use of different schemas is not a suitable means of creating tenant-specific tables within a database.

Database.MongoDbAuthDb

Name of the authentication database when using a MongoDB system with an active user login

Default value: admin

Database.MongoDbTransactions

Boolean value determining whether transactions are used when using a MongoDB system

This feature is not supported by all MongoDB installations.

Default value: TRUE

Database.ResetWorkingDocsOnStartup

Boolean value determining whether incompletely processed batch and document records that are still in "Working" status are automatically reset to "Waiting" when the program is started

This might occur when the program is abruptly terminated while objects in a step are being processed. The processing of objects in this step can be restarted only by resetting the status.

Default value: TRUE

In this section: