PISubBatch properties

Name

This is a string that usually represents the name of the PISubBatch but can be used for anything.

PIHeading

This field is a PIHeading that usually represents the PISubBatch type (for example, Phase). It is in the form of a drop-down menu which contains all of the PIHeadings from all of the PIHeadingSets from the server referenced in the Server field below.

PIUnit

Read-only. This is the PIUnit to which the PISubBatch belongs. The field contains only the name of the PIUnit. It is read-only because a PISubBatch is not directly owned by the PIUnit, it is owned by its parent (which could be a PISubBatch or a PIUnitBatch), which is ultimately owned by a PIUnitBatch. The PIUnit is here to provide context to the PISubBatch. To see the full hierarchy of this PISubBatch, see the search results list at the bottom-left of the plug-in.

StartTime

This is a string that represents the start time of the PISubBatch. It can take the form of any Windows or PI time string (including *, T, Y, Monday, etc. and time arithmetic). It cannot be left blank (indicated by the bold label).

EndTime

This is a string that represents the end time of the PISubBatch. It can take the form of any Windows or PI time string (including *, T, Y, Monday, and so on. and time arithmetic). A blank field (or the string still running) indicates a running PIBatch.

Server

Read-only. This is the Data Archive server that the PISubBatch belongs to.

UniqueID

Read-only. Uniquely identifies the PISubBatch. It is globally unique (that is, no other PISubBatch on any other Data Archive will have the same ID). It is assigned at the time the PISubBatch is created and cannot ever change. If this PISubBatch is copied, the copy will have a different ID, regardless of the PIUnitBatch it is copied to.

PISubBatches

Read-only. This is a brief list of the PISubBatches that belong to this PISubBatch (one level only). To see these in detail, use the search results list and explore the PISubBatch hierarchy.

PIBatch

Read-only. This is the PIUnitBatch that this PISubBatch belongs to. Although this PISubBatch may be the child of a PISubBatch, the PIUnitBatch that ultimately owns this PISubBatch is provided here for context. To see the full hierarchy of this PISubBatch, see the search results list at the bottom-left of the Batch Database tool.