Methods of sending data to AVEVA Enterprise SCADA

Tag Name

Name (Tag)

The name of the point (tag).

Note: The first character of the tag must be alphanumeric. Control characters and the following characters are not allowed: * ‘ ? ; { } [ ] | \ ",

Tag Descriptor

descriptor

A text field that may be used in reports.

PI Point

Source

PointSource

Is a unique character that is used to identify the point that belongs to a particular PI-OASyS interface.

Note: Use the character O for the AVEVA Enterprise SCADA points.

PointType

Device point types that do not need to correspond to point types. For example, integer values from a device can be sent to floating point or digital PI Tags. The PI-OASyS interface supports the following point types: Digital, Float16, Float32, Float64, Int16, Int32.

OASyS-PI Interface Instance

Location 1

An integer. It indicates the PI-OASyS interface instance number in case multiple PI-OASyS interfaces are running concurrently. The number should match exactly the "PIInterfceNum" defined in PIOASYS.json file.

Collection Type

Location 2

An integer. It is used to inform the PI-OASyS interface on how to retrieve the value of the point from OASyS.

1

Read any field without data quality checking (using v_fldget).

2, 3, 4, 5

• Read the analog.*.curval field checking DQ.

• Read the status.*.cursta field checking DQ.

• Read the rate.*.currate field checking DQ.

• Read the rate.*.acccur field checking DQ.

  Note: Numbers 2, 3, 4 and 5 are disabled. In ADE use 1 or 11 instead.

6

Read only the DQ from any point (flag structure must exist).

11

Read any field without DQ checking.

12

Read any field checking DQ.

13

Using PubSub to read any field in the RealTime database (RTDB).

14

Using PubSub to read any field in RTDB checking DQ.

15

Generic PubSub subscription (any data source, but not for the RTDB).

16

Using PubSub to get data from packed<table>Rt Virtual field.

For more information, refer to Configure a packed<table>Rt virtual field.

17

Using PubSub to only get the data quality from packed<table>Rt virtual field.

For more information, refer to Configure a packed<table>Rt virtual field.

Note: The collection type 16 and 17 should be used as a pair, one for field value and another for the data quality. These two tags will have the same time stamps. We suggest that these two collection types should be used for trending purpose.The collection types 1, 6, 11 and 12 are used for the points that use scan class (the points were scanned in a fixed frequency). A valid scan class should be set in the Location 4 field.The collection types 13-17 like exception collection. The points use PubSub to get the data so that the scan class (value in the Location4) is not relevant. These collection types will give fewer values than the scan class types because the PubSub will only publish a new value when the value is changed.

Location 3

An integer. It is used for setpoint or status commands (currently is not used).

Command Timeout Period (secs)

Not used.

Scan Class (defines

collect period)

Location 4

An integer. It is the scan class number. The scan class numbers are defined in PIOASYS.json file. It is not relevant to a point, which uses PubSub, to get the data.

Location 5

Not used.

Telemetry Point

ExDesc

This is the extended descriptor. It is used to store the completed path to the record and field in the RTDB and custom functions.

Engineering Units

engunits

The engineering unit string described the units of the measurement. You may use any string of any length, however PI-APS will retrieve only the first 12 characters. PI-SDK retrieves the whole string.

Instrument Tag

instrumenttag

Not used.

Source Tag (output trigger)

sourcetag

Not used.

Data Type (Pointtypex)

pointtype

Point data type.

Digital Set

digitalset

A digital state set is a collection of digital sets. For digital point, the digitalset attribute specifies the name of the digital state set associated with the tag.

Span

span

The span is the difference between the top of the range and the bottom of the range. It is required for all numeric data type point.

Zero

zero

Zero is required for all numeric data type points to indicate the lowest possible value.

Typical Value

typicalvalue

Typical value is used to document an example of a reasonable value for the point.

Number Of Digits To Display

displaydigits

Controls the format of numeric values on screens and in reports. Zero or a positive number indicates the number of digits to display to the right of the decimal point. A negative number indicates the number of significant digits to display. For example: a value of 23.45 would appear as:

• 23.450 if displaydigits = 3

• 23.45 if displaydigits = -4

Point Security

ptsecurity

Point access permission string. For example: "piadmin: A(r,w) | piadmins: A(r,w) | DNAPIDataEditors: A(r,w) | DNAPIDataViewers: A(r) | PIWorld: A ®"

Data Security

datasecurity

Data Access permission string. For example: "piadmin: A(r,w) | piadmins: A(r,w) | DNAPIDataEditors: A(r,w) | DNAPIDataViewers: A(r) | PIWorld: A ®"

Enable Compression

compressing

True or false. 1 (checked) sets data compressing to "on"; 2 (unchecked) sets data compressing to "off".

Compression Deviation Value

compdev

An event is archived in two circumstances:

• If the elapsed time since the previous event is greater or equal to the Compression time minimum and the value has changed by more than the Compression deviation value.

• If the elapsed time is greater than the Compression time maximum. (It is recommended to set compmax to one work shift e.g. 8 hours.)

  Note: Compdev specifies the compression deviation in engineering units.

Compression Time Maximum

compmax

Compression Time Minimum

commin

Compression Deviation Percentage

compdevpercent

Specifies the compression deviation as a percent of Span. If you change one of compdev or compdevpercent, the other is automatically changed to be compatible. If you try to change both at once, compdevpercent takes precedence.

Exception deviation amount

excdev

An exception is sent in two circumstances:

• If an event occurs and the time since the last event is greater or equal to the Exception minimum time and the value has changed more than the Exception deviation amount.

• If an event occurs and the elapsed time is greater than the Exception maximum time.

  Notes: The Exception deviation amount should be less than the Compression deviation amount by at least a factor of 2.

  Excdev specifies the exception deviation in engineering units.

Exception maximum time (sec)

excmax

Exception minimum time (sec)

excmin

Exception deviation percent

excdevpercent

Specifies the exception deviation in percent of Span. If you change one of excdev or excdevpercent, the other is automatically changed to be compatible. If you try to change both at once, excdevpercent takes precedence.

Enable Archiving

archiving

True or false. 1 (selected) sets data archive to "on"; 2 (cleared) sets data archive to "off".

Step Interpolation

stepflag

On or off. On (selected) treats archived values discretely; an archived value is assumed constant until the next archived value. Off (cleared) treats archived values as a continuous signal; adjacent archived values are linearly interpolated. For example:

• At 12:00:00, the value 101.0 is archived

• At 12:01:00, the value 102.0 is archived.

  If stepflag is on a request for the archive value at 12:00:30 would return 101.5. If stepflag is off a similar request would return a value of 101.0.

  Note: Stepflag also affects the compression calculation. When on, a linear change of value greater or equal to compdev passes compression. When off, the complete swinging-door algorithm is applied.

Enable Scan

Scan

1 = scan is turned on for the point.0 = turns scan off. Set the scan to 1. If the scan=0, the PI-OASyS interface will not retrieve the value for the tag.

Shutdown

Set it to 0.

1

Read any field without data quality checking (using v_fldget).

2, 3, 4, 5

• Read the analog.*.curval field checking DQ.

• Read the status.*.cursta field checking DQ.

• Read the rate.*.currate field checking DQ.

• Read the rate.*.acccur field checking DQ.

  Note: Numbers 2, 3, 4 and 5 are disabled. In Advanced Database Editor (ADE) use 1 or 11 instead.

6

Read only the DQ from any point (flag structure must exist).

11

Read any field without DQ checking.

12

Read any field checking DQ.

13

Using PubSub to read any field in RTDB.

14

Using PubSub to read any field in RTDB checking DQ.

15

Generic PubSub subscription (any data source, but not for the RTDB).