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_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 |
|---|---|---|---|---|
|
CmdDev CmdNode |
CmdId |
No |
The Command ID from the "commands" for a data group in the device template file. |
|
|
CmdName |
No |
The Command Name on the device receiving the UIS command, e.g., the UIS command on the Edge device. |
|
|
|
DataGrpFil |
No |
The name(s) of any Data Group(s) used to Filter (limit) the data group transaction history, e.g., DynaCard. |
|
|
|
EmbedParms |
No |
Specify any optional command parameters and values used by the UIS command in a comma-separated list inside square brackets. For example, Use this format when sending send a UIS command with multiple command parameters from the Data Group dialog box, a pre-configured command in the UIS Command dialog box, or via the API. |
[val1=1,val2=2,val3=3] |
|
|
EndDate |
No |
The End Date for the data in the payload in ISO 8601 format, e.g., YYYY-MM-DD Th:mm:ss.sss or 2024-01-01T18:00:00.000Z. ISO 8601 date and time format is the only accepted timestamp format. Note: Data group transaction history for DynaCards and point history timestamps must use ISO 8601 format. The EIE is very specific in the timestamp format it accepts — the ISO 8601 format is the only accepted string, e.g., 2024-01-01T05:45:15.123Z. |
|
|
| FacId | No |
The Facility ID of the facility on the device receiving the command, e.g., the Edge device. |
|
|
|
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. |
|
|
PntTagFil |
No |
The Point Tag Filter used to limit the point tags to publish in the history backfill command. This matches the pointFilter member specified in the publish object of the CVS endpoint in the Link appsettings.json file. For example, Note: When including a facilityid in a Point Tag Filter, the |
||
|
SiteSvc |
|
The name of the Site.Service on the device receiving the command, e.g., the Site Service on the Edge device. |
|
|
|
StartDate |
No |
The Start Date for the data payload in ISO 8601 format, e.g., YYYY-MM-DD Th:mm:ss.sss or 2024-01-01T18:00:00.000Z. ISO 8601 date and time format is the only accepted timestamp format. Note: Data group transaction history for DynaCards and point history timestamps must use ISO 8601 format. The EIE is very specific in the timestamp format it accepts — the ISO 8601 format is the only accepted string, e.g., 2024-01-01T05:45:15.123Z. |
|
|
|
StatusPnt |
No |
The Status Point ID for the command, if used. A Status Point is a special CygNet point that is used to monitor the status of a UIS command. When a command is in progress (that is, it’s in the communications queue), the value of the Status Point is set to "1:In Progress". Once the command fails or succeeds, the value of the Status Point is set to "2:Failed" or "3:Succeeded," respectively. |
|
|
|
Value |
No |
The Value of the command from the device template file (if indicated) or allows an entry in the field when not set in the device template file. |
|
