Server Side Tags

<< Click to Display Table of Contents >>

 

Server Side Tags

Item

Operation

N1

Meaning

PointName

Writing

0 (zero)

Receives the current value, timestamp, and quality of a point from an application. The PointName Tag must be declared in the ICCPServer.blt file

PointName:Source

Writing

0 (zero)

Changes the default source of a Point. Possible values are 0: Telemetry, 1: Calculated, 2: Entered, or 3: Estimated

DeviceName:Select

Reading and Writing

0 (zero)

Indicates whether a device is selected on the Client side, by using the value "1". An application must write back this value "1" to confirm that it accepted the selected operation or "0" to reject this operation. This operation must be completed within the maximum time informed in the Msg Timeout (ms) option on the ICCP General tab

DeviceName:Operate

Reading and Writing

0 (zero)

Indicates whether a device is in operation on the Client side. This Tag's value is sent by the Client side. An application must send the same value back to confirm a successful operation or any other value to reject this operation. This operation must be completed within the maximum time informed in the Msg Timeout (ms) option on the ICCP General tab

DeviceName:Tag

Reading and Writing

0 (zero)

A Block with two Elements containing device's tags. Element 0 (zero) indicates the device's status and it is a bit mask, where Bit 0: 1 (one, Armed) or 0 (zero, Not Armed); Bits 1 and 2: 0 (zero, No Tag), 1 (one, CloseOnlyInhibit), or 2 (two, OpenAndCloseInhibit). Element 1 (one) indicates the reason for tagging, in Text format. NOTE: If a device is tagged with an Armed status, this device is set back to its Idle status after the time-out of the Select command

ServerStatus

Reading

0 (zero)

Returns the internal status on the ICCP Server side. Possible values are 0: Starting, 1: Reading .ld files, 2: Retrieving Server's directory (GetServerDirectory), or 3: Processing an ld file (Tag Browsing)

ServerConnection

Reading

0 (zero)

Indicates the connection status. Possible values are 1: Connected or 0: Disconnected

UpdatePointDatabase

Writing

0 (zero)

Inserts or updates a point on Server's database. Receives a Block with two, three, or four Elements. Values for Elements are 0: Point's name; 1: Point's type, between zero and 15 (0: Discrete, 1: DiscreteQ, 2: DiscreteQTimeTag, 3:  DiscreteQTimeTagExtended, 4: DiscreteExtended, 5: Real, 6: RealQ, 7: RealQTimeTag, 8: RealQTimeTagExtended, 9: RealExtended, 10: State, 11: StateQ, 12: StateQTimeTag, 13: StateQTimeTagExtended, 14: StateExtended, or 15: Tag_Value); 2: Scope (0: VCC or 1: ICC); and 3: Source (0: Telemetry, 1: Calculated, 2: Entered, or 3: Estimated). Default value is 0 (zero)

UpdateDeviceDatabase

Writing

0 (zero)

Inserts a device on Server's database. It must receive a Block containing between two and six Elements. Values for Elements are 0: Device's name as a String; 1: Device's type as a String (N: None, C: CMD, D: SP_DISCRETE, or R: SP_REAL); 2: Scope, optional (0: VCC or 1: ICC); 3: Tag, optional (0: No or 1: Yes); 4: SBO, optional (0: No or 1: Yes); 5: CheckBackID, optional; and 6: Description, an optional String

DeleteDatabase

Writing

0 (zero)

Deletes all definitions from a Bilateral Table (BLT) file. It must receive a String with the name of a BLT file. This file's name and path are not modified. Users must write to this Tag only when this Driver starts in Offline mode, allowing to delete the current database, redefine its content, and finally use the SaveDatabase Tag

SaveDatabase

Writing

0 (zero)

Saves the Bilateral Table (BLT) file. It must receive a String with the name of the BLT file. This file's name and path are not modified

UpdatePoint

Writing

0 (zero)

Updates a point in memory. It must receive a Block with two or three Elements. Values for Elements are 0: Point's name; 1: New value; and 2: Source (0: Telemetry, default, 1: Calculated, 2: Entered, or 3: Estimated). NOTE: This Tag represents the same writing operation as the PointName Tag, except that it allows source's information on the same operation

SelectConfirm

Writing

0 (zero)

Receives a confirmation from an application that a device was selected. It must receive a Block with two Elements. Values for Elements are 0: Device's name; and 1: 1 (one, a fixed numerical value). NOTE: This Tag represents the same writing operation as the DeviceName:Select Tag

OperateConfirm

Writing

0 (zero)

Receives a confirmation from an application that a device was operated. It must receive a Block with two Elements. Values for Elements are 0: Device's name and 1: The same value received to confirm or a different value to reject. NOTE: This Tag represents the same writing operation as the DeviceName:Operate Tag

Tagging

Writing

0 (zero)

Inserts a tag in a device, similar to the writing operation DeviceName:Tag. It must receive a Block with three Elements. Values for Elements are 0: Device's name; 1: Device's status as a bit mask whose bits 0 (zero) and 1 (one) indicate the Tag (No Tag, OpenCloseInhibit, or CloseOnlyInhibit) and bit 2 (two) indicates the status (Armed or Idle); and 2: Reason for tagging in Text format. NOTE: If a device is tagged with the Armed status, this device is set back to its Idle status

Was this page useful?