Configuring the Text Sink block

Properties

Filename:

Click to browse, select a folder and specify a resulting filename for your data sink.

Delimiter:

Specifies the file delimiter to use when writing data to the file. Fields will be delimited using the specified character. Valid characters are listed on the drop-down.

Save headings:

If enabled, headings will be saved to the file. If disabled, no headings will be written to the file and the first row in the file will contain the first row data.

Output file rollover:

If enabled, File rollover interval can be configured, enabling the sink to close and save the file every specified time period and start a new file in the same directory specified.

Rollover Interval:

If enabled, specifies the rollover period for the created file in days, hours and minutes.

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:

Save execution timestamp

If enabled, saves the execution timestamp to the table.

Timestamp Precision:

Possible values for this property are:

• Milliseconds – Timestamps will be written with millisecond timestamp precision. Any microseconds will be truncated.

• Microseconds – Timestamps will be written with microsecond timestamp precision.

Quality Output mode:

Three options are available for this property:

Don't save any quality:

No will 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:

Results are written to the file on every execution, regardless of timestamps, qualities and values.
Save when all quality is good:

Only writes data to the target text file when all fields in the input port are good quality.
Save when timestamp has changed:

Only writes data to the text file when a timestamp changes on any one of the input fields.

Save when all fields have changed:

Every time a value changes on any one of the input fields the results are written to the file.

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.

Return to top