Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The Database section in the Dataset module facilitates communication with external databases. Users create Dataset DBs within the Datasets DBs section by configuring connection parameters. These connections enable seamless interaction with external databases, enhancing data integration and accessibility.

On this page:

Table of Contents
maxLevel3


DBs

Dataset DB Configuration Properties enable users to customize connections to external databases. The flexible ConnectionString Connection String supports third-party components and macros, while Logon Name and Logon Password manage secure access is managed through LogonName and LogonPassword. Users can optionally specify a Secure Gateway via ServerIP, and a Description field provides additional context.
 Key fields include:

Dataset DB Configuration Properties 

.

Create A New Database DB

To create a new Database connection, follow the steps below

  1. Access Datasets → DBs.
  2. Click the plus icon.
  3. Fill in the Name field and select a Provider and a Database.
  4. Click Ok.

Image Added

Configure A Database DB

To configure a Database DB, follow the steps below.

  1. Access Datasets→ DBs.
  2. Double-click the property you wish to edit on the row corresponding to the channel you want to modify.
  3. Edit the property field.

Image Added

The following table describes each available property you can configure when editing a Database DB:

Info

If a column is not visible on the grid, enable it by right-clicking the grid header and selecting it from the list.


Column

Description

Name

Enter a name for the database configuration. The system allows you to know if the name is not valid.

Provider

Identifies the Provider technology used in this connection 

Database

Identifies to which type of dataset is this connection

ConnectionStringConnection String

Enter the information server path and instance needed to connect with the database. The syntax is defined by the Database Provider used, it , the selected Database Provider defines the syntax. It is a third-party component, and any additional parameter supported by the provider can usually be used normally.     

You can use macros on the connection string too.  Example: for , for example, for the filename in a an SQLite connection string, use <ProjectName> that , which is replaced by the project name of the project.

LogonNameLogon Name

Enter a valid login name for the database.

LogonPasswordLogon Password

Enter the password that corresponds to the database login. (Only accessible by Administrators)

ServerIPServer IP

Optionally, an IP or DNS name for a computer to be used as a Secure Gateway.

Description

Enter a description for the database connection.

Please check the Connecting to SQL Server and Connecting to Excel for additional information.

ConnectionString example for SQL Express 

Image Removed

  • Data Source: The server path and instance that will have the databases.
  • Initial Catalog: The name of the database that will be used.

    Project Test Databases

    and

    Example

    Assume you need to must transition the AlarmHistorian Alarm Historian configuration to a Microsoft SQL production database within your organization. During the development and testing phases of the application, you may prefer not to wait to publish alarm events to that database yet. In other platforms, it would be necessary to manually switch connections between test and production environments or devise workarounds to handle this situation. In our framework, we We provide a built-in, optional feature: configure the AlarmHistorian Alarm Historian DB to target the production database, regardless of its current availability or intended use. Subsequently, run the project in Test Mode, storing data in the local SQLite file <projectName>.dbAlarmHistorianTest.

    When running the Project in Validation Mode, there is a configuration , which is true confirmed by default , that can override the connection of the pre-defined DB, using testing ones instead. Those are The following table lsits the database files that can be enabled to use when running in Validation Mode:

    Database files used when running in Validation Mode

    DB

    Database

    Path Location

    Usage

    Retentive

    SQLite

    <ProjectNameAndPath>.dbRetentiveTest

    Stores values for Retentive Tags.

    RuntimeUsers

    SQLite

     <ProjectNameAndPath>.dbRuntimeUsersTest

    Stores dynamically created Users.

    AlarmHistorian

    SQLite

     <ProjectNameAndPath>.dbAlarmHistorianTest

    Stores Alarm and AuditTrail records.

    TagHistorian

    SQLite

    <ProjectNameAndPath>.dbTagHistorianTest

    Stores Tag Historian and Annotations.




    In this section...

    Page Tree
    root@parent
    spacesV10