UIS Command Component Parameters
The following tables list and describe the parameters specific to the UIS command component types for this remote device:
For more general information about UIS command component parameters, see UIS Command Components. The DG_F_DEV (Get data group from device) and DG_T_DEV (Send data group to device) command component types are configured in the template file. The other command component types are considered special and are defined in the EIE editor code. See Special UIS Command Component Types for more information.
CLRHSTXA
Clear All History Tx Info clears all historical data group caches. CLRHSTXA has no command parameters.
Note: If you clear all caches using a UIS command, the cache values in each transaction of historical data groups are not reset; past transactions continue to display actual values. This is done for performance reasons so that each DDS transaction does not have to be updated. The driver ignores these cached values after the command has been issued.
CYUPDTPT
Update CygNet Point updates the record for a CygNet point. CYUPDTPT has the following command parameters:
| Parameter | Required | Description |
|---|---|---|
|
FOnErr |
No |
Fail cmd on update error indicates to abort the UIS command if any update errors are encountered. The errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up. |
|
Fac |
Yes |
Facility for pt identifies the facility of the point to update. |
|
Serv |
No |
Service for pt identifies the SERVICE of the point to update. |
|
Site |
No |
Site for pt identifies the SITE of the point to update. |
|
UDC |
Yes |
UDC for pt identifies the UDC of the point to update. |
|
UType |
No |
Update type indicates the type of update. Value options are 0 - 3, where 0=Completion, 1=Success, 2=Failure, 3=Creation. |
|
UsrMsk |
No |
User bit mask specifies the user bit mask of the point to update. |
|
UsrVal |
No |
User bit value to match specifies the user bit value to match when updating the point record. |
|
Value |
No |
Value indicates the point value to update. |
CYWAITPT
Wait for CygNet Point signals the UIS to wait to perform a command until the value of the specified CygNet point changes to a specified value.
CYWAITPT must be the first command component added to a UIS command. You cannot add other instances of CYWAITPT to a UIS command.
CYWAITPT has the following command parameters:
| Parameter | Required | Description |
|---|---|---|
|
Dur |
Yes |
Duration is the amount of time (in HH:MM:SS or HH:MM or HH) for the UIS command to wait for the point value to change before timing out. |
|
FOnErr |
No |
Fail on point error indicates to abort the UIS command if any error conditions are encountered. The point errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up. |
|
Fac |
Yes |
Facility for pt identifies the facility of the point on which to wait for the point value to change before performing the UIS command. |
|
Int |
Yes |
Interval indicates the frequency (in HH:MM:SS or HH:MM or HH) with which the UIS will check the point’s value to see if it has changed. |
|
Serv |
No |
Service for pt identifies the SERVICE of the point on which to wait for the point value to change before performing the UIS command. |
|
Site |
No |
Site for pt identifies the SITE of the point on which to wait for the point value to change before performing the UIS command. |
|
UDC |
Yes |
UDC for pt identifies the UDC of the point on which to wait for the point value to change before performing the UIS command. |
|
UsrMsk |
No |
User bit mask specifies the user bit mask on which to wait for the status bit change before issuing the UIS command. Note: The user status bit parameters (UsrMsk and UsrVal) only apply to the extended status field of the point record, so they will not match anything in the base status. |
|
UsrVal |
No |
User bit value to match specifies the user bit value to match before issuing the UIS command. |
|
Value |
No |
Value to match specifies the value on which to wait for the point to change to before issuing the UIS command. Note: You can set parameters for both the point user status AND point value. So you can match either one by itself, or you can specify that both must match your parameter values. |
DG_F_DEV
Get data group from device retrieves a data group from a field device. The Parent XML Element is uccRecvParms. The following parameters are available for each specified data group type.
| Data Group Type | Parameter | Required | Description | Value Options |
|---|---|---|---|---|
|
Class0 |
No |
Get class 0 (all points) |
Boolean |
|
|
Class1 |
No |
Get class 1 events |
Boolean |
|
|
Class2 |
No |
Get class 2 events |
Boolean |
|
|
Class3 |
No |
Get class 3 events |
Boolean |
|
|
Count |
No |
Max events |
Integers |
|
|
PtType |
No |
Point type |
Strings |
|
|
Variation |
No |
Point type variation |
Integers |
|
|
Cnt |
No |
Max Records to Read specifies the maximum possible number of records to read in a single transaction. The highest value possible for Max Records to Read is 960 or the size of the field device buffer if it is less than 960. Subsequent transactions might be required to retrieve all required data. If not specified, all remaining records will be read. |
Integers from 1 to 9999. |
|
|
EDate |
No |
End Date defines the ending date and time for a date-range request for history. |
Strings |
|
|
GetLatest |
No |
Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache). Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required. |
Boolean |
|
|
SDate |
No |
Start Date defines the starting date and time for a date-range request for history. |
Strings |
|
|
Seq |
No |
Starting Sequence Number defines the first sequence number in the requested range. |
Integers |
|
|
Cnt |
No |
Max Records to Read specifies the maximum possible number of records to read in a single transaction. The highest value possible for Max Records to Read is 960 or the size of the field device buffer if it is less than 960. Subsequent transactions might be required to retrieve all required data. If not specified, all remaining records will be read. |
Integers from 1 to 9999. |
|
|
EDate |
No |
End Date defines the ending date and time for a date-range request for events. |
Strings |
|
|
GetLatest |
No |
Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache). Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required. |
Boolean |
|
|
SDate |
No |
Start Date defines the starting date and time for a date-range request for events. |
Strings |
|
|
Seq |
No |
Starting Sequence Number defines the first sequence number in the requested range. |
Integers |
|
|
Cnt |
No |
Max Records to Read specifies the maximum possible number of records to read in a single transaction. The highest value possible for Max Records to Read is 960 or the size of the field device buffer if it is less than 960. Subsequent transactions might be required to retrieve all required data. If not specified, all remaining records will be read. |
Integers from 1 to 9999. |
|
|
EDate |
No |
End Date defines the ending date and time for a date-range request for events. |
Strings |
|
|
GetLatest |
No |
Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache). Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required. |
Boolean |
|
|
SDate |
No |
Start Date defines the starting date and time for a date-range request for history. |
Strings |
|
|
Seq |
No |
Starting Sequence Number defines the first sequence number in the requested range. |
Integers |
|
|
DataType |
No |
Data Type defines the type of data stored at the specified point type. |
Strings |
|
|
Desc |
No |
Description |
Strings |
|
|
ElementId |
Yes |
PointType.Index specifies the point type and index number values used to retrieve data from a single element. |
Strings |
|
|
FacUdc |
No |
Facility.UDC for Point Processing provides a means to specify a UDC to which to map the specified data point; it requires a corresponding point in the Point Service (PNT). |
Strings that specify a Facility.UDC combination. |
|
|
Variation |
No |
Point type variation |
Integers |
DG_T_DEV
Send data group to device sends a data group to a field device. The parent XML Element is uccSendParms. The following parameters are available for each specified data group type.
| Data Group Type | Parameter | Required | Description | Value Options |
|---|---|---|---|---|
|
IIN1.7 |
No |
Device Restart 0 to clear |
Boolean |
|
|
Clear |
No |
BO: Clear |
Boolean |
|
|
Count |
No |
BO: Count |
Integers |
|
|
DataType |
Yes |
Data type defines the type of data stored at the specified point type. |
Strings |
|
|
Desc |
No |
Description |
Strings |
|
|
ElementId |
Yes |
PointType.Index specifies the point type and index number values used to retrieve data from a single element. |
Strings |
|
|
FacUdc |
No |
Facility.UDC for Point Processing provides a means to specify a UDC to which to map the specified data point; it requires a corresponding point in the Point Service (PNT). |
Strings that specify a Facility.UDC combination. |
|
|
Len |
Yes (String point type only) |
Len specifies the number of bytes in a data-group element or register. Only used for String point type. |
Integers (a positive whole number) |
|
|
PulseLatch |
No |
BO: Pulse/Latch/No-op |
Strings |
|
|
TimeOff |
No |
BO: Time off (ms) |
Integers |
|
|
TimeOn |
No |
BO: Time on (ms) |
Integers |
|
|
TripClose |
No |
BO: Trip/Close |
Strings |
|
|
Value |
Yes |
Value defines a value to be sent to the specified item. |
Floating-point numbers |
|
|
Variation |
No |
Point type variation |
Integers |
INTEGRTY
An Integrity poll interrogates the DNP3 device for all event data. A special UIS command, INTEGRITY, is used to issue the integrity poll, which consists of events for all classes 1-3 followed by class 0 (all points) in a single message. The data received from an integrity poll is split into the existing Events and AllPoints data group for point processing and data group transaction retention.
An INTEGRTY component type has no command parameters.
See Polling Notes for more information.
