PIBatch properties
- Last UpdatedOct 04, 2024
- 2 minute read
- PI System
- PI Server 2023
- PI Server
|
Property |
Type |
Description |
|---|---|---|
|
BatchID |
String |
Usually represents a batch ID but can be used for anything. |
|
Product |
String |
Usually represents a Product but can be used for anything. This plug-in supports only character strings. |
|
Recipe |
String |
Usually represents a Recipe but can be used for anything. This plug-in supports only character strings. |
|
StartTime |
String |
Represents the start time of the PIBatch. It can take the form of any Windows or PI time string, such as *, T, Y, or Monday, and time arithmetic. It cannot be left blank. |
|
EndTime |
String |
Represents the end time of the PIBatch. It can take the form of any Windows or PI time string, such as *, T, Y, or Monday, and time arithmetic. A blank field or the string indicates a running PIBatch. |
|
Server |
Read-only string |
The server that the PIBatch belongs to. To move a PIBatch from one server to another, copy and paste it to the new server and delete the original. See Copy batch items. |
|
UniqueID |
Read-only string |
The unique identifier of the PIBatch. This property is globally unique; that is, no other PIBatch on any other Data Archive server has the same ID. It is assigned at the time the PIBatch is created and cannot change. |
|
PIUnitBatches |
Read-only string |
A short list of the PIUnitBatches that are linked to this PIBatch. To see the PIUnitBatches in detail, use the search results list and explore the PIBatch's hierarchy. PIUnitBatches can be linked to a PIBatch. See Link or unlink a PIUnitBatch to a PIBatch for details. |
|
PIProperties |
Tree |
The PIProperties hierarchy of the PIBatch. The first node in the tree represents the PIBatch itself. A summary of each PIProperty is shown in the tree in the format . If the data is an array, the first five elements are displayed. Use the buttons to the right of the tree to add, edit, and delete PIProperties from this hierarchy. |