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

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

DpDly

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

DpHrly

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

EnrDly

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

EnrDlyGas

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

EnrEvents

Ack

No

Acknowledge/Clear Events, when specified, acknowledges and clears Enron events.

Value options are Boolean.

EnrEventsS

Ack

No

Acknowledge/Clear Events, when specified, acknowledges and clears supplemental Enron events.

Value options are Boolean.

EnrHrly

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

EnrHrlyGas

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

FmsAlarm

Ack

No

Acknowledge/Clear Events, when specified, acknowledges and clears FMS alarm events.

Value options are Boolean.

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.

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

Ack

No

Acknowledge/Clear Events, when specified, acknowledges and clears FMS events.

Value options are Boolean.

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.

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.

FmsHistD

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.

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.

FmsHistH

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.

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.

HistRec

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

PlgrCycHis

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

PlgrMinHis

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

SnglCoilRo

DataType

Yes

Data Type defines the type of data stored at the specified register number.

Value options appear in the Data Type drop-down list in the Single Read-Only Coil data group dialog box.

Desc

No

Description

Value options are strings.

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).

Value options are strings that specify a Facility.UDC combination.

RegNum

Yes

Register Number specifies the register number used to retrieve data from a single element.

Value options are valid register numbers.

SnglCoilRw

DataType

Yes

Data Type defines the type of data stored at the specified register number.

Value options appear in the Data Type drop-down list in the Single Read/Write Coil data group dialog box.

Desc

No

Description

Value options are strings.

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).

Value options are strings that specify a Facility.UDC combination.

RegNum

Yes

Register Number specifies the register number used to retrieve data from a single element.

Value options are valid register numbers.

SnglRegRo

DataType

Yes

Data Type defines the type of data stored at the specified register number.

Value options appear in the Data Type drop-down list in the Single Read-Only Register data group dialog box.

Desc

No

Description

Value options are strings.

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).

Value options are strings that specify a Facility.UDC combination.

RegNum

Yes

Register Number specifies the register number used to retrieve data from a single element.

Value options are valid register numbers.

SnglRegRw

DataType

Yes

Data Type defines the type of data stored at the specified register number.

Value options appear in the Data Type drop-down list in the Single Read/Write Register data group dialog box.

Desc

No

Description

Value options are strings.

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).

Value options are strings that specify a Facility.UDC combination.

RegNum

Yes

Register Number specifies the register number used to retrieve data from a single element.

Value options are valid register numbers.

TrbDly

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 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.

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.

GetLatest

No

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

TrbHrly

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 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.

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.

GetLatest

No

 

Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache).

Value options are Boolean.

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.

Note: If you specify GetLatest="true", a start date or end date is not required. If GetLatest="false", a start date is required.

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

SnglCoilRw

DataType

Yes

Data Type defines the type of data stored at the specified register number.

Value options appear in the Data Type drop-down list in the Single Read/Write Coil data group dialog box.

Desc

No

Description

Value options are strings.

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).

Value options are strings that specify a Facility.UDC combination.

RegNum

Yes

Register Number specifies the register number used to retrieve data from a single element.

Value options are valid register numbers.

Value

Yes

Value defines a value to be sent to a "Single Read/Write Coil" (SnglCoilRw) data group.

SnglRegRw

DataType

Yes

Data Type defines the type of data stored at the specified register number.

Value options appear in the Data Type drop-down list in the Single Read/Write Register data group dialog box.

Desc

No

Description

Value options are strings.

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).

Value options are strings that specify a Facility.UDC combination.

RegNum

Yes

Register Number specifies the register number used to retrieve data from a single element.

Value options are valid register numbers.

Value

Yes

Value defines a value to be sent to a "Single Read/Write Register" (SnglRegRw) data group.

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.