Configuring the Tabular Database Sink block

Properties

Data Source:

Specifies the connection provider for this database connection.

Table:

The table containing the data to be imported. Either select or specify the required table. Depending on the option selected here, the table option below will vary.

Selected/Specified Table:

The table containing the field definitions for this source.

Clear the table on startup:

If enabled, the blueprint will clear all data from the database on every first execution.

Saved timestamp reference:

Possible values for this property are:

• Local – All timestamps will be written in local time.

• UTC – All timestamps will be converted to UTC before being written, taking into consideration Daylight Saving Time.

You will need to know if the text file or database table was written using UTC or local time. UTC must be used during realtime execution in the Server Manager.

Blueprints executing in the Server Manager are unaffected by a changeover to Daylight Saving Time. However, blueprints containing this block must have the “Saved timestamp reference” values set to UTC.

Timestamp output mode:

If enabled, saves the execution timestamp to the table.

Quality output mode:

Three options are available for this property:

  • Don't save any quality:

    No quality will be saved to the database.

  • Save all quality:

    An associated quality entry will be made in the table for every field value written to the table, including an overall quality field indicating overall quality for the entire row of data written to the table.

  • Save master quality:

    Only one quality entry per row will be written to the table.  This quality will be bad should any of the field qualities be bad.

  • Save quality per field:

    An associated quality entry will be made in the table for every field value written to the table

Data save behaviour:

Three options are available for this property:

  • Save on every execute:

    Every executions results are written to the table.

  • Save when all quality is good:

    Only writes rows to the database when all fields in the row are good quality.

  • Save when all fields have changed:

    Only writes a row data to the table when all fields have changed on a given execution.  

Automatic reconnects:

If enabled, execution will not stop if the connection to the server fails.  If disabled, blueprint execution will be stopped should the connection to the specified database fails.

Runnability

NOTE: The block will not be runnable when there are duplicated field names.

Note that a Quality field is generated for each Selected Field, and is named Field_Quality.

 

Potential issues: Because of this automatically added postfix _Quality, there is the potential to have duplicate field names in the Selected Fields list.


For example: If the following two fields are in the Available Fields list - Field1 and Field1_Quality -  and Field1 is selected, the generated Quality field will be Field1_Quality. This would create a duplicate if Field1_Quality was originally selected as well, and the block will not be runnable.

Timestamp and Quality are reserved words and must also not be added as a field. They will potentially cause duplication of field names and the block will not be runnable.

Selection TAB

Use the selection tab to select the fields you wish to sink by moving them from the Available fields list to the Selected fields list.

NOTE: Runnability issues: The following names are reserved as column names and cannot be used as field names:

  • Timestamp (if the option Writing execute timestamp is enabled)

  • Quality (if the option Save all quality or Save master quality is enabled)

  • Field, where a field with the same name ending in _Quality is also selected (if Save all quality or Save quality per field is enabled. In this case, having a field named X and X_Quality will prevent the block being runnable, as the block will try to create a column for the quality of field X named X_Quality, which will clash with the field you selected X_Quality.

NOTE: Any field that is named as such will need to be renamed before they can be written to the sink block. Duplicate names created from the above scenario will cause the block runnability to fail.

Return to top


Related topics:

  

CSense 2023- Last updated: June 24,2025