BSAP EIE – UIS Command Component Parameters

Devices > Remote Devices > BSAP 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:

CLRCACHE
CLRHSTXA
CYUPDTPT
CYWAITPT
DG_F_DEV
NRTBCAST
NRTSEND
SETFRAME

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.

CLRCACHE

Clear Device Cache clears the internal caches for signal metadata, array dimensions, archive field map, missing signal map, and the list column cache. CLRCACHE has no command parameters.

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
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.
FmsHistDGq	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.
FmsHistDGq	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. A maximum of 16 characters may be used.
FmsHistHGq	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.
FmsHistHGq	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.
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	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.
	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.
	SDate	Yes	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.
GmrHist	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.
	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.
	SDate	Yes	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.
HistDlyArc	EDate	Yes	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.
HistDlyArc	SDate	Yes	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.
HistDlyAry	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 the size of the field device buffer. Subsequent transactions might be required to retrieve all required data. If not specified, all remaining records will be read.
	EDate	Yes	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.
	SDate	Yes	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.
HistHlyArc	EDate	Yes	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.
HistHlyArc	SDate	Yes	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.
HistHlyAry	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 the size of the field device buffer. Subsequent transactions might be required to retrieve all required data. If not specified, all remaining records will be read.
	EDate	Yes	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.
	SDate	Yes	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.

NRTBCAST

NRT/TimeSync Broadcast sends a broadcast NRT to all the devices in the hierarchy. NRTBCAST has no command parameters.

NRTSEND

NRT/TimeSync Targeted sends a targeted NRT to all the devices in the hierarchy. NRTSEND has no command parameters.

SETFRAME

Set Frame and DB Sequence Number overrides the version and framing number for protocol specific data. SETFRAME has the following command parameters:

Parameter	Required	Description
DbSeqNum	No	Database sequence number
DbVerNum	No	Database version number
FrameNum	No	Frame number