Weatherford WellPilot DLQ/K-Series EIE – UIS Command Component Parameters

Devices > Remote Devices > Weatherford WellPilot DLQ/K-Series EIE > UIS Command Component Parameters

UIS Command Component Parameters

The following tables list and describe the parameters specific to the UIS command component types for this remote device:

CLRHSTXA
CONFIG
CYUPDTPT
CYWAITPT
DG_F_DEV
DG_T_DEV
GETTIME
SETTIME
STATUS

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.

CONFIG

Get RTU Configuration retrieves configuration information from the field device. CONFIG has no parameters.

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
AlgHist	Date	Yes	History Date enables you to specify the calendar day by which to collect historical data. Value options are strings in formats described in Selecting Date and Time.
CtdEvents	EDate	Yes	Ending Contract Date defines the ending contract time and date for a date-range request. Value options are strings in formats described in Selecting Date and Time.
CtdEvents	SDate	Yes	Starting Contract Date defines the starting contract time and date for a date-range request. Value options are strings in formats described in Selecting Date and Time.
CtdHistory	EDate	Yes	Ending Contract Date defines the ending contract time and date for a date-range request. Value options are strings in formats described in Selecting Date and Time.
	GetLatest	No	Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache). Value options are Boolean. For more information, see History Retrieval Optimization.
	ReqClosed	No	Request Closed Days Only requests any completed contract day for which all applicable CTD history records have been generated by the field device and no further CTD history records or events are added. Value options are Boolean.
	ReqExt	No	Request Sum of Extensions requests the CTD history sum of extensions. Sum of extensions is also known as integral value, which is the terminology typically used by CygNet. Value options are Boolean.
	SDate	Yes	Starting Contract Date defines the starting contract time and date for a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsAlarm	EDate	No	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsAlarm	SDate	Yes	Start Device Date/Time defines the starting device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsEvent	EDate	No	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsEvent	SDate	Yes	Start Device Date/Time defines the starting device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsHistDGm	EDate	Yes	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsHistDGm	SDate	Yes	Start Device Date/Time defines the starting device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsHistHGm	EDate	Yes	End Device Date/Time defines the ending device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
FmsHistHGm	SDate	Yes	Start Device Date/Time defines the starting device date and time of a date-range request. Value options are strings in formats described in Selecting Date and Time.
PrdHist	Date	Yes	Production History Date enables you to specify the calendar day by which to collect historical data. Value options are strings in formats described in Selecting Date and Time.
Trend	Date	Yes	Days Back enables you to specify the number of passed days by which to collect historical data. Value options are strings in formats described in Selecting Date and Time.
	ETime	No	Ending Trend Hour defines the ending time for a time-range request. Value options are strings in formats described in Selecting Date and Time.
	Time	No	Starting Trend Hour defines the starting time for a time-range request. Value options are strings in formats described in Selecting Date and Time.

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
DateTime	Time	Yes	Contract Hour defines the contract hour to be sent to a field device. Value options are integers 0 - 23.
DOutputCmd	State	Yes	Action (Latch, Unlatch, Pulse) enables you to change the Action state setting. Value options are strings.
DOutputCmd	Time	No	Pulse Duration enables you to set the pulse duration when Action is set to Pulse. Value options are integers.
FlowCtrl	FCSetpoint	Yes	Setpoint enables you to set the flow control setpoint value. Value options are integers.
Password	Val1	Yes	Old Password enables you to specify the old password. Value options are strings.
Password	Val2	Yes	New Password enables you to specify the new password. Value options are strings.
SetPntCmd	Val1	Yes	Set Point Value enables you to set the analog output setpoint value. Value options are integers.

GETTIME

Get RTU Time retrieves time from the field device. GETTIME has no command parameters.

SETTIME

Set RTU Time sets time for the field device. SETTIME has no command parameters.

STATUS

Get Current Status retrieves current status from the field device. STATUS has no command parameters.