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.
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 |
|---|---|---|---|---|
|
EDate |
No |
End Device Date defines the ending device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
SDate |
Yes |
Start Device Date defines the starting device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
EDate |
Yes |
End Device Date defines the ending device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
SDate |
Yes |
Start Device Date defines the starting device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
EDate |
Yes |
End Device Date defines the ending device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
SDate |
Yes |
Start Device Date defines the starting device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
EDate |
Yes |
End Device Date defines the ending device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
SDate |
Yes |
Start Device Date defines the starting device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
EDate |
Yes |
End Device Date defines the ending device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
SDate |
Yes |
Start Device Date defines the starting device date and time of a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
Day |
No |
Number of Days Back enables you to specify the number of days from which to collect historical data. |
Integers from 0 to 40 |
|
|
EDate |
No |
End Date defines the ending date and time of a date-range request for row-based daily history for multiple points. |
Strings in formats described in Selecting Date and Time. |
|
|
EITEM |
No |
Ending Sequence Number defines the last sequence number in the requested range. |
Integers |
|
|
SDate |
No |
Start defines the starting date and time of a date-range request for row-based daily history for multiple points. |
Strings in formats described in Selecting Date and Time. |
|
|
SDateLast |
No |
Start from Last Date/Time retrieves history from the most recently cached history timestamp. |
Boolean |
|
|
SITEM |
No |
Starting Sequence Number defines the first sequence number in the requested range. |
Integers |
|
|
Day |
No |
Number of Days Back enables you to specify the number of days from which to collect historical data. |
Integers from 0 to 40 0=range low, 40=range high |
|
|
EDate |
No |
End Date defines the ending date and time of a date-range request for row-based daily history for multiple points. |
Strings in formats described in Selecting Date and Time. |
|
|
EITEM |
No |
Ending Sequence Number defines the last sequence number in the requested range. |
Integers |
|
|
SDate |
No |
Start defines the starting date and time of a date-range request for row-based daily history for multiple points. |
Strings in formats described in Selecting Date and Time. |
|
|
SDateLast |
No |
Start from Last Date/Time retrieves history from the most recently cached history timestamp. |
Boolean |
|
|
SITEM |
No |
Starting Sequence Number defines the first sequence number in the requested range. |
Integers |
|
|
EDate |
No |
End Date/Time defines the ending date and time of a daily history date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
EITEM |
No |
Ending Sequence Number defines the last sequence number in the requested range. |
Integers |
|
|
SDate |
No |
Start Date/Time defines the starting date and time of a daily history date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
SDateLast |
No |
Start from Last Date/Time retrieves history from the most recently cached history timestamp. |
Boolean |
|
|
SITEM |
No |
Starting Sequence Number defines the first sequence number in the requested range. |
Integers |
|
|
Day |
No |
Number of Days Back enables you to specify the number of days from which to collect historical data. |
Integers from 0 to 40 |
|
|
EDate
|
No |
End Date defines the ending date and time of a date-range request for row-based daily history for multiple points. |
Strings in formats described in Selecting Date and Time. |
|
|
EITEM |
No |
Ending Sequence Number defines the last sequence number in the requested range. |
Integers |
|
|
SDate |
No |
Start Date/Time defines the starting date and time of a daily history date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
SDateLast |
No |
Start from Last Date/Time retrieves history from the most recently cached history timestamp. |
Boolean |
|
|
SITEM |
No |
Starting Sequence Number defines the first sequence number in the requested range. |
Integers |
|
|
FileName |
Yes |
Trend File Name specifies the name of the trend file from which to retrieve data. |
Strings |
|
|
EDate |
No |
End Date defines the ending date and time for a date-range request. |
Strings in formats described in Selecting Date and Time. |
|
|
EITEM |
No |
Ending Sequence Number defines the last sequence number in the requested range. |
Integers |
|
|
SDate |
No |
Start Date defines the starting date and time for a date-range request for history. |
Strings in formats described in Selecting Date and Time. |
|
|
SDateLast |
No |
Start from Last Date/Time retrieves history from the most recently cached history timestamp. |
Boolean |
|
|
SITEM |
No |
Starting Sequence Number defines the first sequence number in the requested range. |
Integers |
|
| Folder | No |
Trend Folder specifies the name of the trend folder from which to retrieve data. |
Strings |
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 |
|---|---|---|---|---|
|
CommandId |
Yes |
Command ID defines the Command Action (CA) to be enacted by the "Command Message" (CmdMsg) data group. |
Options are as follows:
|
|
|
BlowClose |
- |
Blow Valve Close sends a close valve command to the device. |
Boolean | |
|
CaptClose |
- |
Capture Close Manual |
Boolean | |
|
CaptOpen |
- |
Capture Open Manual |
Boolean | |
|
EndFlwcyc |
- |
End Flow Cycle |
Boolean | |
|
MainClose |
- |
Main Close Now |
Boolean | |
|
MainClose |
- |
Main Valve Close sends a close valve command to the device. |
Boolean | |
|
MainOpen |
- |
Main Valve Open sends an open valve command to the device. |
Boolean | |
|
RstCtrl |
- |
Reset Controller |
Boolean |
|
|
RstDef |
- |
Reset Values to Default |
Boolean |
|
|
RstPlgrCtr |
- |
Reset Plunger Counters |
Boolean | |
|
RstVcb |
- |
Reset VCBs (register addresses) |
Boolean | |
|
StFlwcyc |
- |
Start Flow Cycle |
Boolean | |
|
ValvClose |
- |
Main Valve Open sends a close valve command to the device. |
Boolean | |
|
ValvOpen |
- |
Blow Valve Open sends an open valve command to the device. |
Boolean | |
|
AfFlTmLim |
- |
After Flow Time |
Strings |
|
|
ClsTmLim |
- |
Off Time |
Strings |
|
|
FallDlyEn |
- |
Fall Delay Enable (1=enabled) |
Integers |
|
|
FallDlyTm |
- |
Fall Delay Time |
Strings |
|
|
FlCyTmLim |
- |
On Time |
Strings |
|
|
HldOnceAc |
- |
Hold Once Action |
Integers |
|
|
HldOnceEn |
- |
Hold Once (0 or 4) |
Integers |
|
|
HldOnceTm |
- |
Hold Once Time |
Strings |
|
|
OAftFloTC1 |
- |
Option After Flow Enable (1=enabled) |
Integers |
|
|
ORecTimO |
- |
Mandatory Shut-in Time (1, 2, or 3) |
Integers |
|
|
OTotalCyc |
- |
Sync Off/On (0 or 2) |
Integers |
|
|
RecTimLim |
- |
Mandatory Recovery Time limit |
Strings |
|
|
TF464 |
- |
Plunger Control # |
Integers |
|
|
MainVlvCls |
No |
End Flow Cycle |
Integers from 0 to 1 |
|
|
MainVlvOpn |
No |
Start Flow Cycle |
Integers from 0 to 1 |
|
|
PlnCtlNum |
No |
Plunger Control |
Integers from 0 to 2 |
|
|
RstPlgrCtr |
No |
Reset Plunger Counters |
Integers from 0 to 1 |
