Configuring Supervisor database properties

Database configuration establishes names, credentials and other properties that enable the Supervisor station to connect to the external, third-party database.
Prerequisites: You are using Workbench and are connected to your Supervisor station. You have installed a third-party database that supports secure communication. The database is running.
  1. Right-click your database name under Drivers > RdbmsNetwork in the Nav tree, and click Views > Property Sheet.
    The Property Sheet opens.
    Image

    Above is an example using the MySQLDatabase Property Sheet.

    The Components chapter in this guide documents all properties. The following table indicates which properties are available based on the rdb database device.

    RdbmsNetwork database properties

    Property HsqlDb (controller only) MySQL Oracle SqlServer
    Status (Information) - - - -
    Enabled
    Fault Cause (Information) - - - -
    Health (Information) - - -  
    Alarm Source Info
    Host Address -
    User Name
    Password -
    Worker
    Export Mode
    Use Unicode Encoding Scheme
    Timestamp Storage -
    Points
    Sql Scheme Enabled
    Tls Min Protocol -
    Verify Subject in Certificate -
    Base Directory - - -
    Database Name - -
    Instance Name - - -
    Service Name - - -
    Port -
    Histories -
    Extra Connection Properties - -
    Version - - -
  2. Configure at least these properties:
    • User Name and Password (database credentials)
    • Database Name
    • Host Address
  3. To configure full UTF-8 Unicode support (NVARCHAR columns instead of VARCHAR columns), set Use Unicode Encoding Scheme to true.
    To preserve compatibility with legacy systems, this property defaults to false and must be changed before you connect to your database for the first time.

    Most databases (except MySQL) have a property called Timestamp Storage. This property can configure the driver to update and export history timestamps using Coordinated Universal Time (UTC).

  4. As a best practice, set Export Mode to By History Type as most database administrators would rather manage a few tables instead of thousands of individual tables.
    When exporting by By History Type, the driver exports histories of the same data type (Boolean, Numeric, Enum, String) to the same table. For example, all numeric type histories export to a table named HISTORYNUMERICTRENDRECORD. This table contains an additional column named HISTORY_ID, which stores the history ID reference (ORD) from the station for each record in the table.
  5. To configure UTC timestamps, change Timestamp Storage from the default (Dialect Default) to one of the UTC options.
    With Dialect Default, you must set both Use Last Timestamp and Use History Config Time Zone to true. This exports histories using the History Config Timezone. If you set the two properties to false, the driver exports histories using the station timezone.

    Selecting the Utc Timestamp takes precedence over the Use Last Timestamp and Use History Config Time Zone properties in the history device extension, rendering them effectively irrelevant.

    Switching back and forth between Dialect Default and Utc Timestamp pollutes the database with inconsistent timestamps, which can negatively affect any query you run to determine whether or not to export newer records.

  6. Select the minimum TLS protocol, which can be negotiated when establishing encrypted communications with the database server.
  7. Enable Verify Subject in Certificate for the Rdbms driver to verify that the existing Subject in the server’s certificate matches the expected value.
  8. Select the server certificate for the database from the My Sql Server Cert drop–down list at the bottom of the Property Sheet.
    This certificate must have been signed by the root CA certificate of a third-party CA (Certificate Authority) or by your company’s own root CA certificate (if your company serves as its own CA). If your company serves as its own CA, its root CA certificate must be in the platform/station’s User Trust Store. For certificate management, refer to the Niagara Station Security Guide
  9. To complete the configuration, click Save.