Emerson ROCPlus 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
LOGINSEC
SETTIME
STATUS
TXHISTRG

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	Value Options
Alarm800	EDate	No	End Contract Date defines the ending contract time and date for a date-range request.	Strings in formats described in Selecting Date and Time.
Alarm800	SDate	No	Start Contract Date defines the starting contract time and date for a date-range request.	Strings in formats described in Selecting Date and Time.
ConOpCode	Cnt	Yes	Number of Locations defines the number of table entries to include in the "Configurable Opcode Data" data group.	Integers from 1 to 44 Starting location + number of locations must be less than or equal to 44.
ConOpCode	Val1	Yes	Starting Location defines which table entry to begin with when generating table entries for the "Configurable Opcode Data" data group.	Integers from 1 to 44 Starting location + number of locations must be less than or equal to 44.
EventsLog	EDate	No	End Contract Date defines the ending contract time and date for a date-range request.	Strings in formats described in Selecting Date and Time.
EventsLog	SDate	No	Start Contract Date defines the starting contract time and date for a date-range request.	Strings in formats described in Selecting Date and Time.
FmsAlarm	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.
FmsAlarm	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.
FmsEvent	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.
FmsEvent	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.
FmsHistDGm	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.
FmsHistDGm	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.
FmsHistDGq	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.
FmsHistDGq	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.
FmsHistHGm	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.
FmsHistHGm	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.
FmsHistHGq	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.
FmsHistHGq	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.
Hist800	SDate	No	Date defines the starting date and time for a "History – Daily/Periodic for Day" data group.	Strings in formats described in Selecting Date and Time.
HistMultiD	EDate	Yes	Ending 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.
	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. For more information, see History Retrieval Optimization.	Boolean
	NumHistPt	Yes	Number of Hist Pts defines the number of history points to be retrieved. Value options are integers from 1 to 200, which is the maximum number of history points in a segment. The combination of Starting Hist Pt and Number of Hist Pts should not exceed 200.	Integers from 1 to 200
	SDate	Yes	Start defines the starting date and time of a date-range request for row-based daily history for multiple points.	NumHistPt
	StHistPt	Yes	Starting Hist Pt defines the beginning of the range of history points to be retrieved. Value options are integers from 1 to 200, which is the maximum number of history points in a segment.	Integers from 1 to 200
HistMultiM	EDate	Yes	End Date defines the ending date and time of a date-range request for row-based minute history for multiple points.	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). Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required. For more information, see History Retrieval Optimization.	Boolean
	NumHistPt	Yes	Number of Hist Pts defines the number of history points to be retrieved. Value options are integers from 1 to 200, which is the maximum number of history points in a segment. The combination of Starting Hist Pt and Number of Hist Pts should not exceed 200.	Integers from 1 to 200
	SDate	Yes	Start Date defines the starting date and time of a date-range request for row-based periodic history for multiple points.	Strings in formats described in Selecting Date and Time.
	StHistPt	Yes	Starting Hist Pt defines the beginning of the range of history points to be retrieved. Value options are integers from 1 to 200, which is the maximum number of history points in a segment.	Integers from 1 to 200
HistMultiP	EDate	Yes	End Date defines the ending date and time of a date-range request for row-based periodic history for multiple points.	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). Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required. For more information, see History Retrieval Optimization.	Boolean
	NumHistPt	Yes	Number of Hist Pts defines the number of history points to be retrieved. Value options are integers from 1 to 200, which is the maximum number of history points in a segment. The combination of Starting Hist Pt and Number of Hist Pts should not exceed 200.	Integers from 1 to 200
	SDate	Yes	Start Date defines the starting date and time of a date-range request for row-based periodic history for multiple points.	Strings in formats described in Selecting Date and Time.
	StHistPt	Yes	Starting Hist Pt defines the beginning of the range of history points to be retrieved. Value options are integers from 1 to 200, which is the maximum number of history points in a segment.	Integers from 1 to 200
PerHst	EDate	Yes	End Date defines the ending date and time of a date-range request for row-based periodic history for multiple points.	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). Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required. For more information, see History Retrieval Optimization.	Boolean
	SDate	Yes	Start Date defines the starting date and time of a date-range request for row-based periodic history for multiple points.	Strings in formats described in Selecting Date and Time.
PerHstD	EDate	Yes	End Date defines the ending time and date for a date-range request for periodic daily history.	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). Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required. For more information, see History Retrieval Optimization.	Boolean
	SDate	Yes	Start Date defines the starting time and date for a date-range request for periodic daily history.	Strings in formats described in Selecting Date and Time.
SingleTlp	DataType	Yes	Data Type defines the type of data stored at the specified register number.	Value options appear in the Data Type drop-down menu in the Single Register data group dialog box.
	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.
	TLP	Yes	T,L,P (one-based) defines the Point Type, Logical, Parameter combination to be retrieved from the device.	Options are integers, separated by commas, in the form T,L,P. The Point Type (T) portion of the value can be any valid point type on the device. The Logical (L) portion of the value is one-based and can be any valid logical for the specified point type. The Parameter (P) portion of the value can be any valid parameter of the specified point type.
	TLPDesc	No	TLP Description provides for a user-defined description of the TLP in the event that the user does not want to use the default description.	Alphanumeric characters
TxHist	EDate	Yes	End Date defines the ending date and time of a date-range request for historicized transactional data on a per-transaction set basis.	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). Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required. For more information, see History Retrieval Optimization.	Boolean
	SDate	Yes	Start Date defines the starting date and time of a date-range request for historicized transactional data on a per-transaction set basis.	Strings in formats described in Selecting Date and Time.
WMEvtLog	EDate	No	End Date defines the ending date and time for a date-range request.	Strings in formats described in Selecting Date and Time.
WMEvtLog	SDate	No	Start Date defines the starting date and time for a date-range request.	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	Value Options
AO800Send	Val1	Yes	Auto Value defines a current value for the "Analog Output - Auto Value" data group.	Floating-point numbers
ConOpCode	Item	Yes	Table Item # defines which table entry a value is sent to in a "Configurable Opcode Data" data group.	Integers from 1 to 44
ConOpCode	Value	No	Value defines a value to be sent to a "Configurable Opcode Data" data group.	Options are determined by the table entry type and can be integer, string, or others.
DO800SAO	Val1	Yes	Auto Output defines the auto output value to send to the field device.	Boolean
DO800SEU	Val1	No	TDO EU Value enables you to set the timed discrete output engineering unit value.	Floating-point numbers
Login	AccLevel	No	Access level defines the security access level assigned to the corresponding operator ID. Set a value between 1 and 5.	Char values 0 - 5
	OpID	Yes	Operator ID defines the identifier of an operator.	Strings
	Password	No	Password defines the password assigned to the corresponding operator ID.	Integers from 0 - 9999
SingleTlp	DataLen	No	String Length specifies the string length of data stored at the specified register number.
	DataType	Yes	Data Type defines the type of data stored at the specified register number.	Value options appear in the Data Type drop-down menu in the Single Register data group dialog box.
	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.
	TLP	Yes	T,L,P (one-based) defines the Point Type, Logical, Parameter combination to be retrieved from the device.	Options are integers, separated by commas, in the form T,L,P. The Point Type (T) portion of the value can be any valid point type on the device. The Logical (L) portion of the value is one-based and can be any valid logical for the specified point type. The Parameter (P) portion of the value can be any valid parameter of the specified point type.
	TLPDesc	No	TLP Description provides for a user-defined description of the TLP in the event that the user does not want to use the default description.	Alphanumeric characters
	Value	Yes	Value defines the value of the TLP.

GETTIME

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

LOGINSEC

Login Secure sends enhanced security credentials to a device using login credential information from the "Login secure" section of the Device page on the remote device editor. LOGINSEC 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.

TXHISTRG

This command is only exposed in the Emerson ROCPlus EIE template file. The parent XML Element is specCmds.

Parameter Required Description

Parameter	Required	Description
TxSet	Yes	Transactional History Trigger defines a transaction set numeric ID, each of which corresponds to an Emerson transaction set numeric ID. Up to 10 transaction sets can be available, containing up to 100 transaction points each. One TxSet parameter is required for each transaction set trigger you want to initiate from CygNet. You can use a UIS Command Button in CygNet Studio or some other mechanism for manually triggering a transaction, but you cannot trigger a transaction from a transactional data group editor dialog box in the Device Definition Service (DDS). If you want to maintain a record of transaction set triggers initiated from CygNet, you must instantiate a "Transactional History Trigger" data group for each applicable transaction set. Records of CygNet-initiated triggers cannot be viewed as DDS transactions without this data group, although fields in the "Transactional History Cfg" data group editor(s) reflect the number of transactions. Value options are 1 - 10 where each value represents a single transaction set. Multiple TXHISTRG command components can be added to a single UIS command. This UIS command component and its parameters are only exposed in the Emerson ROCPlus EIE template file in the specCmds element. Emerson RocPlus XML Example Copy specCmds XML `<specCmds visible="true" canBeScheduled="true" clientCanInvoke="true" inheritsSecurity="true"> <TXHISTRG niceName="Transactional History Trigger"> <uccParms> <TxSet desc="Transaction Set" type="ui1" required="true" rangeLow="1" rangeHigh="10" ordinal="0"/> </uccParms> </TXHISTRG> </specCmds>`

TxSet

Yes

Transactional History Trigger defines a transaction set numeric ID, each of which corresponds to an Emerson transaction set numeric ID. Up to 10 transaction sets can be available, containing up to 100 transaction points each.

One TxSet parameter is required for each transaction set trigger you want to initiate from CygNet. You can use a UIS Command Button in CygNet Studio or some other mechanism for manually triggering a transaction, but you cannot trigger a transaction from a transactional data group editor dialog box in the Device Definition Service (DDS).

If you want to maintain a record of transaction set triggers initiated from CygNet, you must instantiate a "Transactional History Trigger" data group for each applicable transaction set. Records of CygNet-initiated triggers cannot be viewed as DDS transactions without this data group, although fields in the "Transactional History Cfg" data group editor(s) reflect the number of transactions.

Value options are 1 - 10 where each value represents a single transaction set. Multiple TXHISTRG command components can be added to a single UIS command.

This UIS command component and its parameters are only exposed in the Emerson ROCPlus EIE template file in the specCmds element.

Emerson RocPlus XML Example

Copy

specCmds XML

1
2
3
4
5
6
7
<specCmds visible="true" canBeScheduled="true" clientCanInvoke="true" inheritsSecurity="true">
    <TXHISTRG niceName="Transactional History Trigger">
        <uccParms>
            <TxSet desc="Transaction Set" type="ui1" required="true" rangeLow="1" rangeHigh="10" ordinal="0"/>
        </uccParms>
    </TXHISTRG>
</specCmds>