Devices > Remote Devices > Flow Automation 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.

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

Alarm

EDate

No

End Date defines the ending date and time for an alarm date-range request.

Value options are strings in formats described in Selecting Date and Time.

SDate

No

Start Date defines the starting date and time for an alarm date-range request.

Value options are strings in formats described in Selecting Date and Time.

Audit

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.

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.

FlowPLCycH

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

History

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.

For more information, see History Retrieval Optimization.

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.

Type

No

Hourly or Daily retrieves and displays hourly or daily history.

Value options are 0=hourly history and 1=daily history.

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

WriteAO

Password

  

Password field is displayed on data group editors whenever a user attempts to edit a data group, if the password is not specified on the Device page.

Value options are strings.

Value

Yes

Analog Output Value (0-100) enables setting the percent value (0 to 100%) for the specified analog output point .

Value options are 0 (range low) to 100 (range high).

WriteDO

Password

  

Password field is displayed on data group editors whenever a user attempts to edit a data group, if the password is not specified on the Device page.

Value options are strings.

PulseDur

  

Pulse Duration (secs) enables you to set the pulse duration in seconds.

Value options are floating-point numbers where 0.0 = range low.

Value

  

New Output State (0 or 1) enables setting the discrete output value for the specified discrete output point.

Value options are 0 (range low) to 1 (range high).
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.