FB Net – UIS Command Component Parameters

Devices > Remote Devices > FB Net 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:

CYUPDTPT
CYWAITPT

DG_F_DEV
DG_T_DEV

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
FcuTrend	EDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
FcuTrend	MaxRec	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. Value options are integers.
GMRConfig	MeterId	No	Meter ID Override, if specified, provides a measurement meter name that is used instead of the one obtained from the field device. For instance, if a meter is identified as TX_123 at the field device but is overridden by this parameter using the identifier TX_789, the measurement system recognizes and displays only TX_789. Value options are alphanumeric characters.
GMREvent	Alarms	No	Include Alarms, if specified, includes alarm events for the requested date-range. Value options are Boolean.
	ECDateTm	Yes	End Contract Date/Time defines the ending contract date and time of a date-range request for measurement events. Value options are strings in formats described in Selecting Date and Time.
	Events	No	Include Events, if specified, includes events for the requested date-range. Value options are Boolean.
	MeterId	No	Meter ID Override, if specified, provides a measurement meter name that is used instead of the one obtained from the field device. For instance, if a meter is identified as TX_123 at the field device but is overridden by this parameter using the identifier TX_789, the measurement system recognizes and displays only TX_789. Value options are alphanumeric characters.
	SCDateTm	Yes	Start Contract Date/Time defines the starting contract date and time of a date-range request for measurement events. Value options are strings in formats described in Selecting Date and Time.
GmrHist	ECDateTm	Yes	End Contract Date/Time defines the ending date and time of a date-range request for measurement history. Value options are strings in formats described in Selecting Date and Time.
	MeterId	No	Meter ID Override, if specified, provides a measurement meter name that is used instead of the one obtained from the field device. For instance, if a meter is identified as TX_123 at the field device but is overridden by this parameter using the identifier TX_789, the measurement system recognizes and displays only TX_789. Value options are alphanumeric characters.
	SCDateTm	Yes	Start Contract Date/Time defines the starting date and time of a date-range request for measurement history. Value options are strings in formats described in Selecting Date and Time.
RtuTrend	EDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
RtuTrend	MaxRec	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. Value options are integers.
TrendData	EDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
	MaxRec	No	Max records to save in DDS specifies the maximum number of records to save in a single transaction. Value options are integers.
	SDate	No	Start Date defines the starting date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
TrendGmr	EDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
	MaxRec	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. Value options are integers.
	SDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
TrendIv	EDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
TrendIv	MaxRec	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. Value options are integers.
TrendPod	EDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
TrendPod	MaxRec	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. Value options are integers.
TrendRtu	EDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
TrendRtu	MaxRec	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. Value options are integers.
TrendWh	EDate	No	End Date defines the ending date and time for a date-range request. Value options are strings in formats described in Selecting Date and Time.
TrendWh	MaxRec	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. Value options are 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
CmdMsg	CommandId	Yes	Command ID defines the Command Action (CA) to be enacted by the "Command Message" (CmdMsg) data group. Value options are as follows: 0: Turn Well On 1: Force Well Into Idle Time 2: Clear Errors 3: Force Off Until Reset
Control	ClrTot	No	Clear Totals Value options are low=0, high=1.
	DoTrig	No	DO Trigger
	ManOff	No	Start Off-Cycle Value options are low=0, high=1.
	ManOn	No	Start On-Cycle Value options are low=0, high=1.
	TubClose	No	Close Tubing Valve Value options are low=0, high=1.
	TubOpen	No	Open Tubing Valve Value options are low=0, high=1.
GasParms (Gas Parameters)	AtmPres	No	Atmospheric Press Value options are floating-point numbers.
	CPrime	No	C Prime Value options are floating-point numbers.
	DpCutOff	No	Low DP Cutoff Value options are floating-point numbers.
	InjMtrFlg	No	Gas Meter Inj
	IntlUnits	No	International Units
	Send	Yes	Send to device sends data to the device. Value options are Boolean.
	VolToday	No	Volume Today Value options are floating-point numbers.
	VolYest	No	Volume Yesterday Value options are floating-point numbers.
GasParms (Gas Parms)	Send	Yes	Send to device sends data to the device. Value options are Boolean.