data V8.0 SP1 2 templates - Industry Support Siemens...Modifying supplied log templates SIMATIC...

� SIMATIC BATCH - Views of the log

�data V8.0 SP1

___________________

___________________

___________________

___________________

___________________

___________________

___________________

SIMATIC

Process Control System PCS 7SIMATIC BATCH - Views of the log data V8.0 SP1

Programming Manual

12/2012 A5E31481226-AA

Modifying supplied log templates

1

Creating custom report templates

2

Introduction 3

Description of the views 4

Description of the table value functions

5

Description of the enumerations

6

Examples of links 7

Siemens AG Industry Sector Postfach 48 48 90026 NÜRNBERG GERMANY

A5E31481226-AA Ⓟ 11/2012 Technical data subject to change

Copyright © Siemens AG 2012. All rights reserved

Legal information Warning notice system

This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are graded according to the degree of danger.

DANGER indicates that death or severe personal injury will result if proper precautions are not taken.

WARNING indicates that death or severe personal injury may result if proper precautions are not taken.

CAUTION indicates that minor personal injury can result if proper precautions are not taken.

NOTICE indicates that property damage can result if proper precautions are not taken.

If more than one degree of danger is present, the warning notice representing the highest degree of danger will be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property damage.

Qualified Personnel The product/system described in this documentation may be operated only by personnel qualified for the specific task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified personnel are those who, based on their training and experience, are capable of identifying risks and avoiding potential hazards when working with these products/systems.

Proper use of Siemens products Note the following:

WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems. The permissible ambient conditions must be complied with. The information in the relevant documentation must be observed.

Trademarks All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.

Disclaimer of Liability We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions.

SIMATIC BATCH - Views of the log data V8.0 SP1 Programming Manual, 12/2012, A5E31481226-AA 3

Table of contents

1 Modifying supplied log templates............................................................................................................... 7

2 Creating custom report templates.............................................................................................................. 9

3 Introduction.............................................................................................................................................. 11

4 Description of the views........................................................................................................................... 13

4.1 vOrderCategory ...........................................................................................................................13

4.2 vOrder ..........................................................................................................................................13

4.3 vBatch ..........................................................................................................................................14

4.4 vRecipeElement...........................................................................................................................15

4.5 vContainer....................................................................................................................................16

4.6 vRecipeUnitProcedure .................................................................................................................17

4.7 vRecipeOperation ........................................................................................................................18

4.8 vSUP............................................................................................................................................19

4.9 vMonitor .......................................................................................................................................20

4.10 vTermTrans..................................................................................................................................21

4.11 vProcedure...................................................................................................................................22

4.12 vMonitoredObjects .......................................................................................................................23

4.13 vTargetObjects.............................................................................................................................24

4.14 vAction .........................................................................................................................................24

4.15 vChangedItems............................................................................................................................25

4.16 vComment....................................................................................................................................26

4.17 vModification ................................................................................................................................27

4.18 vAllocation....................................................................................................................................28

4.19 vAllocationCandidate ...................................................................................................................28

4.20 vPCell...........................................................................................................................................29

4.21 vCategory.....................................................................................................................................29

4.22 vInstance......................................................................................................................................30

4.23 vDataType....................................................................................................................................30

4.24 vDataTypeValue ..........................................................................................................................31

4.25 vUoM............................................................................................................................................31

4.26 vMaterial.......................................................................................................................................32

4.27 vParameterDescription ................................................................................................................32

Table of contents

SIMATIC BATCH - Views of the log data V8.0 SP1 4 Programming Manual, 12/2012, A5E31481226-AA

4.28 vOnlineParameterValue .............................................................................................................. 33

4.29 vOfflineParameterValue .............................................................................................................. 35

4.30 vOnlineConditions ....................................................................................................................... 36

4.31 vOfflineTag.................................................................................................................................. 36

4.32 vOnlineTag.................................................................................................................................. 37

4.33 vCDVMessage ............................................................................................................................ 38

4.34 vFormulaCategory....................................................................................................................... 39

4.35 vFormula ..................................................................................................................................... 39

4.36 vExtendedError ........................................................................................................................... 40

4.37 vExtendedErrorState................................................................................................................... 41

4.38 vOfflineEsigs ............................................................................................................................... 42

4.39 vExecutedEsigs........................................................................................................................... 42

4.40 vBatchUserRole .......................................................................................................................... 43

4.41 vBatchArchive ............................................................................................................................. 44

4.42 vOnlineUnitAllocation .................................................................................................................. 45

5 Description of the table value functions ................................................................................................... 47

5.1 batch_GetElementsByBatch_Sorted........................................................................................... 47

5.2 batch_GetStandardReport .......................................................................................................... 48

5.3 batch_GetConditionRows............................................................................................................ 50

6 Description of the enumerations .............................................................................................................. 51

6.1 ObjectType.................................................................................................................................. 51

6.2 StartMode.................................................................................................................................... 52

6.3 BatchState................................................................................................................................... 52

6.4 BatchExState .............................................................................................................................. 53

6.5 StepType..................................................................................................................................... 53

6.6 RpeState ..................................................................................................................................... 54

6.7 RpeExState ................................................................................................................................. 54

6.8 Level............................................................................................................................................ 54

6.9 ScaleFunc ................................................................................................................................... 55

6.10 OPDActiv..................................................................................................................................... 55

6.11 OPDIsQuit ................................................................................................................................... 55

6.12 StepCommand ............................................................................................................................ 55

6.13 ActionType .................................................................................................................................. 56

6.14 ActionState.................................................................................................................................. 57

6.15 UserConstraints .......................................................................................................................... 58

Table of contents


6.16 AllocStrategy................................................................................................................................58

6.17 Usage...........................................................................................................................................58

6.18 MessageState ..............................................................................................................................58

6.19 MessageType...............................................................................................................................59

6.20 ChangeType.................................................................................................................................59

6.21 ErrorClass ....................................................................................................................................59

6.22 ErrorReason.................................................................................................................................60

6.23 ErrorState.....................................................................................................................................61

6.24 FormulaState, RecipeState..........................................................................................................62

6.25 RecipeExState .............................................................................................................................62

6.26 SubObjectType ............................................................................................................................62

6.27 SignState......................................................................................................................................63

6.28 ValueSource.................................................................................................................................63

6.29 ClassId .........................................................................................................................................63

7 Examples of links..................................................................................................................................... 65

7.1 Introduction ..................................................................................................................................65

7.2 Root object - subobjects ..............................................................................................................65

7.3 Direct recipe element - subobjects ..............................................................................................67

7.4 Recipe element - properties.........................................................................................................68

Index........................................................................................................................................................ 71

Table of contents



Modifying supplied log templates 1

The standard software Microsoft SQL Server and Microsoft Reporting Services is used for creating logs for SIMATIC BATCH. An introduction to this topic is provided below. You can find additional information for the corresponding product in the online help for Microsoft SQL Server.

Opening the Reporting Services Configuration Manager The Reporting Services Configuration Manager and Report Builder from Microsoft SQL Server 2008 R2 are used as the main applications for adapting the BATCH standard report templates. This describes the actions that need to be taken to make simple changes, for example, to names, descriptions, pictures and formatting in BATCH standard report templates to suit your needs.

Procedure 1. Open the Reporting Services Configuration Manager from the following start menu: Start

> Programs > Microsoft SQL Server 2008 R2 > Configuration Tools > Reporting Services Configuration Manager.

2. Connect on the corresponding BATCH server to the Report Server instance "INFSERVER" and click "Connect".

3. In the left navigation pane, click "Report Manager URL" and then on the blue colored link provided in the display window, for example: http://computer name:TCP port number/Reports_INFSERVER. A user name and passwords may be requested in a dialog to establish the connection. Users who have permission for Reporting Services come from the "SIMATIC BATCH" Windows group. Enter your user name and password and then click "OK". A dynamic Web page is displayed in the Internet Explorer.

4. Click on the folder "SIMATIC BATCH 8.0 SP1 Reports". This folder contains all the report templates that have already been loaded to the database.

5. If you would you like to use an existing report template as a base, and then change it for use in SIMATIC BATCH, first copy the desired report template. To do this, move your cursor over the desired report template and right-click to open the shortcut menu. In the shortcut menu, click "Download". Save the report template at a location of your choice. The files saved as report templates are used to import/export to the SQL database.

6. The next step involves using this report template and loading it into the report server database. Click "Upload file" in the toolbar. A new Web page opens.

7. Click the "Browse" button and select the report template you have just saved in the search dialog. Then click "Open". Only the report templates loaded to the database can be used in BatchCC.

Modifying supplied log templates


8. Enter a new name for the report template in the text box and click "OK". The following naming conventions apply to the file name. Example: TemplateFamily_ReportObjectType_*.RDL; "MyReport_bacth_optional.RDL". The copied batch report with the new name is displayed in the folder under SIMATIC BATCH 8.0 SP1 Reports.

9. Now you can open your own batch log in the report generator (Report Builder). To do this, move the mouse cursor over the element and left-click. In the shortcut menu, click "Edit in Report Builder". Your custom report template is then displayed in Report Builder.

10. There you can change some elements to suit your needs. For example: Static texts, fonts, alignment, pictures, etc.

11. Save your changes in the Report Builder.

Result Open the "Report" folder in the project settings of BatchCC. In the "Template for generating report" table, your own "Modified" report template is now available for selection in addition to the standard report template. You can select your custom report template for print preview or for printing objects of BatchCC.


Creating custom report templates 2Views of the batch data

Knowledge of Microsoft SQL Server 2008 R2 is required to create custom report templates for SIMATIC BATCH. The following example roughly describes the interaction of SQL applications. You can find additional information in the online help for the SQL applications employed. The definitions of the BATCH views are used as the basis for the compilation of BATCH data in custom report templates.

Note Alternative procedure

We recommend that you modify the provided standard report templates to suit your needs, save them under a new name and then publish them. This ensures that the correct format is used for the parameters for "objectguid".

Requirements ● You have read the two chapters "Definition of views" and "Modifying supplied report

templates".

● The dynamic web page or the home page of the Report Manager is displayed in the Microsoft Internet Explorer.

Procedure 1. Click the Report Builder button. This launches the wizard that helps you to create a new

report in SQL Server Report Builder.

2. Click "New Report" and then "Blank Report". The empty report is shown in SQL Server Report Builder.

3. A data source must be added to the report. To do this, select the "Data Sources" folder and click the shortcut menu command "Add Data Source". In the "Data Source Properties" dialog, assign a name to the data source and enable the "Use a shared connection or report model" option. Click the "Browse" button to select the data source "SimaticBatch_DataSource" in the "SIMATIC BATCH 8.0 SP1 Data Sources" folder. Click the "Test Connection" button, and then, if the connection test is successful, click the "OK" button.

4. An embedded dataset must be used in your report. To do this, select the "Datasets" folder and click the shortcut menu command "Add Dataset". Enter a name for the dataset and enable the option "Use a dataset embedded in my report". Click on the selection character under "Data Source" and select your data source. Under "Query type", keep the "Text" option selected by default. Then click on the "Query Designer" button.

Creating custom report templates


5. The Query Designer is started. All BATCH views with the corresponding fields are listed in the "Views" folder. At this point, you basically have to decide on the data of the underlying views that you want to query in a report. The "vBatch" view with all fields is used here as an example.

6. Click on the dataset that has been added in the "Datasets" folder and then select the shortcut menu command "Dataset Properties". In the text box under "Query", add the filter condition "WHERE SIMATIC_BATCH.vBatch.OGUID = @objectguid" at the very end and click "OK".

7. Select the "Parameters" folder and then select the shortcut menu command "Add Parameter". SIMATIC BATCH requires a parameter to know which type of report object is involved. In the "Report Parameter Properties" dialog, enter "objectguid" for the name and also "objectguid" for the "Prompt". Select "Text" as the data type and "Hidden" for the parameter visibility. Click "Defaults" and select the "No default value" option. Now use the "Run" button to start a query. For example, enter a default value for the "objectguid" that you have derived from the standard report template for batches.

8. In the SQL Server Report Builder, you can add the desired data of the "vBatch" view to your report. Report data is filled into text boxes. In the example, "Batch name", "Product name", "Quantity" and "Master recipe name" are used. Use the corresponding report data labels from the description of the Batch views. They are identified by square brackets after they are inserted into the report. Save your report in the SIMATIC BATCH 8.0 SP1 Reports folder. When assigning names, note that the name part "_batch" must be included in the file name for a batch log. Only then can the template be identified in BatchCC and used for the batch log. Example: "MyReport_batch.rdl".

9. Click on the "Run" button to read the data from the SQL Server database.

Result The name "MyReport" can be selected as a template in BatchCC for the commands "Print" and "Print Preview". If you use this template for printing or for a print preview, the data for the selected batch is displayed in the text boxes in the report.


Introduction 3

This document describes views provided in SIMATIC BATCH V8.0 SP1 for the BATCH data in the SQL Server database.

The data may be located:

● In the SQL Server instance (INFSERVER) on the BATCH Server PC. In this case, this is data of the objects that have already been logged.

● On the Process Historian PC. This is data that has been explicitly transferred to the PH via DeltaArchive or after archiving batches.

In addition to the views that are described below, there are also configured views in the form of table value functions. These are used to restrict the output per parameters.

Introduction



Description of the views 44.1 vOrderCategory

Order categories This view shows the available order categories.

Definition

Name Data type Description OGUID Uniqueidentifier GUID of the object (order category) OBJID Int ID of the object OTID (1) Int Type ID of the object Name nvarchar(255) Name of the order category CreationDateTime Datetimeoffset(3) Creation date of the object Description nvarchar(max) Description of the order category

4.2 vOrder

Orders This view shows the available orders.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (order

category) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object OGUID Uniqueidentifier GUID of the object (order) OBJID Int ID of the object OTID (1) Int Type ID of the object Name nvarchar(255) Name of the order

Description of the views 4.3 vBatch


Name Data type Description CreationDateTime Datetimeoffset(3) Creation date of the object EarliestDateTime Datetimeoffset(3) Earliest start for the batches LatestDateTime Datetimeoffset(3) Latest end for the batches Quantity Float Planned quantity Description nvarchar(max) Description of the order

4.3 vBatch

Orders This view shows the available batches.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (order) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type of the root object OBJID Int ID of the object OTID (1) Int Type of the object OGUID Uniqueidentifier GUID of the object Name nvarchar(255) Name of the batch Description nvarchar(max) Batch description MaterialGUID Uniqueidentifier GUID of the product Quantity Float Planned quantity UoMId Int ID of the physical unit FormulaCategoryName nvarchar(255) Name of the formula category FormulaName nvarchar(255) Name of the formula FormulaVersion nvarchar(255) Version of the formula FormulaGUID Uniqueidentifier GUID of the formula MRecipeName nvarchar(255) Name of the master recipe MRecipeVersion nvarchar(255) Version of the master recipe MRecipeGUID Uniqueidentifier GUID of the master recipe PlanStart datetimeoffset(3) Planned start time for the batch PlanEnd datetimeoffset(3) Planned end time for the batch ActStart datetimeoffset(3) Actual start time of the batch ActEnd datetimeoffset(3) Actual end time of the batch StartMode (2) Int Start mode of the batch

Description of the views 4.4 vRecipeElement


Name Data type Description State (3) Int (*) Status of the batch ExState (4) Int (*) Extended status of the batch PCellGUID Uniqueidentifier GUID of the BATCH process cell

(PCell) CreationDateTime Datetimeoffset(3) Creation date of the object BatchVersion nvarchar(255) SIMATIC BATCH version

4.4 vRecipeElement

Recipe elements This view shows the existing recipe elements (containers, terminals, transitions).

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (batch, master

recipe or library) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the higher-level object POTID (1) Int Type ID of the higher-level object OBJID Int ID of the object OTID (1) Int Type ID of the object ActivationCounter Int Run of the object ParentActivationCounter Int Run of the parent of the object Name nvarchar(255) Name of the object Description nvarchar(max) Description of the object StepNo Int Number of the object

(contid*10000+termid) State (6) Int Status of the container ExState (7) Int Expanded status of the container Start datetimeoffset(3) Start time of the container End datetimeoffset(3) End time of the container DurationPlanned Int Planned duration in seconds DurationActual Int Actual duration in seconds MonitoringTime Int Monitoring time of the object in seconds OverwriteDuration Bit Runtime calculated by the system. Can

be changed or overwritten.

Description of the views 4.5 vContainer


Name Data type Description ScaleFunc (9) Int Modification of the duration UnitRel Bit Unit is released at the end AlloID Int ID of the allocation ExecuteInPLC Bit Execute in AS-based mode

4.5 vContainer

Recipe elements This view shows the existing recipe elements (containers, terminals, transitions).

Definition Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (batch, master


(contid*10000+termid) State (6) Int Status of the container ExState (7) Int Expanded status of the container Start datetimeoffset(3) Start time of the container End datetimeoffset(3) End time of the container DurationPlanned Int Planned duration in seconds DurationActual Int Actual duration in seconds MonitoringTime Int Monitoring time in seconds OverwriteDuration Int Runtime exceeded ScaleFunc (9) Int Scaling the runtime UnitRel Bit Unit is released at the end

Description of the views 4.6 vRecipeUnitProcedure


Name Data type Description AllocId Int ID of the allocation ExecuteInAS Int Executed in PLC GraphicType tinyint Type of stored graphic (1: png) Graphic Varbinary(max) Graphic in BLOB format

4.6 vRecipeUnitProcedure

Recipe elements This view shows the available recipe unit procedures. It is a specialization of the vContainer view.



(contid*10000+termid) State (6) Int Status of the container ExState (7) Int Expanded status of the container Start datetimeoffset(3) Start time of the container End datetimeoffset(3) End time of the container DurationPlanned Int Planned duration in seconds DurationActual Int Actual duration in seconds MonitoringTime Int Monitoring time of the object in

seconds OverwriteDuration Int Runtime calculated by the system. Can

be changed or overwritten. ScaleFunc (9) Int Modification of the duration UnitRel Bit Unit is released at the end

Description of the views 4.7 vRecipeOperation


Name Data type Description AllocId Int ID of the allocation UnitId Int ID of unit UnitName Int Name of the unit ExecuteInPLC Int Executed in AS-based mode GraphicType tinyint Type of stored graphic (1:png) Graphic Varbinary(max) Graphic in BLOB format

4.7 vRecipeOperation

Recipe operations This view shows the available recipe operations. It is a specialization of the vContainer view.

Definition


recipe or library) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the higher-level object POTID (1) Int Type ID of the higher-level object OBJID Int ID of the object OTID (1) Int Type ID of the object ActivationCounter Int Run of the object ParentActivationCounter Int Run of the parent of the object Name nvarchar(255) Name of the object StepNo Int Number of the object

(contid*10000+termid) Description nvarchar(max) Description of the object State (6) Int Status of the container ExState (7) Int Expanded status of the container Start datetimeoffset(3) Start time of the container End datetimeoffset(3) End time of the container DurationPlanned Int Planned duration in seconds DurationActual Int Actual duration in seconds MonitoringTime Int Monitoring time of the object in

seconds

Description of the views 4.8 vSUP


Name Data type Description OverwriteDuration Int Runtime calculated by the system. Can

be changed or overwritten. ScaleFunc (9) Int Modification of the duration ExecuteInPLC Int Executed in AS-based mode GraphicType tinyint Type of stored graphic (1:png) Graphic Varbinary(max) Graphic in BLOB format

4.8 vSUP

Recipe elements This view shows the available substructures. It is a specialization of the vContainer view.



(contid*10000+termid) State (6) Int Status of the container ExState (7) Int Expanded status of the container Start datetimeoffset(3) Start time of the container End datetimeoffset(3) End time of the container DurationPlanned Int Planned duration in seconds DurationActual Int Actual duration in seconds MonitoringTime Int Monitoring time in seconds

Description of the views 4.9 vMonitor


Name Data type Description OverwriteDuration Int The runtime calculated by the system can

be changed or overwritten ScaleFunc (9) Int Modification of the duration ExecuteInPLC Int Executed in AS-based mode GraphicType tinyint Type of stored graphic (1: png) Graphic Varbinary(max) Graphic in BLOB format

4.9 vMonitor

Recipe elements This view shows the available monitoring. It is a specialization of the vContainer view.



(contid*10000+termid) State (6) Int Status of the container ExState (7) Int Expanded status of the container Start datetimeoffset(3) Start time of the container End datetimeoffset(3) End time of the container DurationPlanned Int Planned duration in seconds DurationActual Int Actual duration in seconds MonitoringTime Int Monitoring time in seconds OverwriteDuration Int The runtime calculated by the system can

be changed or overwritten ScaleFunc (9) Int Modification of the duration ExecuteInPLC Int Executed in AS-based mode

Description of the views 4.10 vTermTrans


Name Data type Description GraphicType tinyint Type of stored graphic (1: png) Graphic Varbinary(max) Graphic in BLOB format

4.10 vTermTrans

Recipe elements This view shows the available terminals (RF, command step, equipment operation, operator instruction, library reference) and transitions. It is a specialization of the vContainer view.



(contid*10000+termid) State (6) Int Status of the container ExState (7) Int Expanded status of the container Start datetimeoffset(3) Start time of the container End datetimeoffset(3) End time of the container DurationPlanned Int Planned duration in seconds DurationActual Int Actual duration in seconds MonitoringTime Int Monitoring time in seconds OverwriteDuration Int The runtime calculated by the system can

be changed or overwritten ScaleFunc (9) Int Modification of the duration UnitRel Bit Unit is released at the end AllocId Int ID of the allocation UnitId Int ID of unit

Description of the views 4.11 vProcedure


Name Data type Description UnitName nvarchar(255) Name of the unit. Only relevant for flat

recipes. CategoryGUID Uniqueidentifier GUID of the library, if it is a library

reference OPDActiv (11) tinyint Activation status of the operator

instruction OPDIsQuit (12) tinyint Status of the acknowledgment ContinousFlag Bit Continue ExecuteInPLC Bit Executed in AS-based mode StepCommand (13) smallInt Command FilterState smallInt Filter set Target nvarchar(max) List of target objects (jump, command

step) GateLogic nvarchar(255) Linking logic of the transition conditions

4.11 vProcedure

Recipes This view shows the existing recipes (master recipes (OTID = 125), library (OTID = 126), control recipe (OTID = 127)). The root object is the object itself, if it is a master recipe or a library. In the case of a control recipe, the batch corresponds to the root object.

Definition Name Data type Description Name nvarchar(255) Name of the object Description nvarchar(max) Description of the object Model Int Recipe model (2:Flat, 1:Hierarchical) Version nvarchar(255) Version of the object State (30) Int Status of the procedure ExState (31) Int Extended status of the procedure Start datetimeoffset(3) Start time of the container End datetimeoffset(3) End time of the container DurationPlanned Int Planned duration in seconds ScaleFunc (9) Int Modification of the duration StartMode (2) Int Start mode of the batch AutomaticVersioning Bit System-aided versioning MajorVersion Int Major version, with system supported

versioning

Description of the views 4.12 vMonitoredObjects


Name Data type Description MinorVersion Int Minor version, with system supported

versioning ModificationDateTime datetimeoffset(3) Last change QuantityMin Float Minimum quantity of a batch QuantityReference Float Standard set for quantity adjustment QuantityMax Float Maximum quantity of a batch ProductGUID Uniqueidentifier GUID of the product. From the

vMaterial view ProductName nvarchar(255) Name of the product Quality nvarchar(255) Quality of the product UOMId ID of the physical unit GraphicType tinyint Type of stored graphic (1:png) Graphic Varbinary(max) Graphic in BLOB format (offline only)

4.12 vMonitoredObjects

Monitored objects View of the objects which are tracked by the monitor. The (1:n) link of the vMonitor views (vContainer, vRecipeElement) to this view is based on the columns ROOTGUID, POBJID, POTID, OBJID, OTID.


recipe or library) ROOTOBJID Int ID of the root object ROOTOTID (1) InI Type ID of the root object OBJID Int ID of the higher-level object of the

monitoring POTID (1) Int Type ID of the higher-level object of the

monitoring OBJID Int ID of the monitoring OTID (1) Int Type ID of the monitoring object MonitoredStepNo Int Number of the monitored object

(contid*10000+termid) MonitoredStepPath nvarchar(512) Hierarchical path of the monitored

object

Description of the views 4.13 vTargetObjects


4.13 vTargetObjects

Command step and jump objects View of the command step and jump object. The link to the vTermTrans view (vRecipeElement) is based (1:1) on the columns ROOTGUID, POBJID, POTID, OBJID, OTID.


recipe or library) ROOTOBJID Int ID of the root object ROOTOTID (1) InI Type ID of the root object POBJID Int ID of the higher-level object of the jump

or command step POTID (1) Int Type ID of the higher-level object of the

jump or command step OBJID Int ID of the monitoring OTID (1) Int Type ID of the object (jump or

command step) TargetStepNo Int Number of the monitored object

(contid*10000+termid) TargetStepPath nvarchar(512) Hierarchical path to the target object

4.14 vAction

User actions User actions are shown here. User actions are those actions initiated by the user on a batch or batch elements.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (batch) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the container object

Description of the views 4.15 vChangedItems


Name Data type Description POTID (1) Int Type ID of the container object P2OBJID Int ID of the higher-level object of the

container object P2OTID (1) Int ID of the higher-level object of the

container object OBJID Int ID of the action OTID (1) Int Type of the action ActionType (14) Int Action State (15) Int Status of the action EsigDynDataId Int ID of EsigDynData (*) UserLogin nvarchar(255) Login UserLoginLong nvarchar(255) Processor CreationTimeStamp datetimeoffset(3) Creation date of the action CreationHostName nvarchar(255) Original computer of the action ExecutionTimeStamp datetimeoffset(3) Execution date of the action ExecutionHostName nvarchar(255) Execution computer of the action

*: (action.ROOTGUID = executedesig.ROOTGUID, action.POBJID= executedesig.POBJID, action.POTID= executedesig.POTID, action.P2OBJID= executedesig.P2OBJID, action.P2OTID= executedesig.P2OTID, action.EsigDynDataId = executedesig.EsigDynDataId)

4.15 vChangedItems

Changes The changes resulting from actions are shown here, for example, changed objects (parameters) from an "Online parameter change" action.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (batch) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type of the root object POBJID Int ID of the action POTID (1) Int Type of the action P2OBJID Int ID of the container object of the action P2OTID (1) Int Type ID of the container object of the

action

Description of the views 4.16 vComment


Name Data type Description P3OBJID Int ID of the higher-level object of the


container object OBJID Int ID of the object OTID (1) Int Type of the object EntryType Int Type of the object ObjectName nvarchar(255) Name of the object ChangeType (26) Int Type of change OldValue Int Old value NewValue Int New value UoMId Int Physical unit

4.16 vComment

Comments This view contains comments of objects or messages.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (batch) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the container object POTID (1) Int Type ID of the container object P2OBJID Int ID of the higher-level object of the


container object OBJID Int ID of the comment OTID (1) Int Type ID of the comment ActivationCounter Int Name of the object Commentary nvarchar(max) Comment ActivationCounter Int Run in which the comment was enteredEsigDynDataId Int ID of EsigDynData (*) UserLogin nvarchar(255) Login UserLoginLong nvarchar(255) Processor

Description of the views 4.17 vModification


Name Data type Description ComputerName nvarchar(255) Computer name TimeStamp datetimeoffset(3) Creation date of the comment MsgTimeStamp datetimeoffset(3) Creation date of the commented

message ServerPrefix nvarchar(255) Prefix of the OS server (for the

message) MsgNumber Bigint Number of the message when

transferring the batch data. A server prefix can have multiple messages with the same MsgNo.

MsgCounter Bigint Sequential ID of the message generated by the PCS 7 OS.

*: (comment.ROOTGUID = executedesig.ROOTGUID, comment.POBJID= executedesig.POBJID, comment.POTID= executedesig.POTID, comment.P2OBJID= executedesig.P2OBJID, comment.P2OTID= executedesig.P2OTID, comment.EsigDynDataId = executedesig.EsigDynDataId)

4.17 vModification

Changes to objects This involves the logging of changes made to objects (batch, master recipe, library, formula).

Definition


recipe, library, formula) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the container object POTID (1) Int Type ID of the container object OBJID Int ID of the change OTID (1) Int Type ID of the change Description nvarchar(max) Description of the change Action Int ID of the action UserLogin nvarchar(255) Login UserLoginLong nvarchar(255) Processor ComputerName nvarchar(255) Computer name ModificationTimeStamp datetimeoffset(3) Revision date

Description of the views 4.18 vAllocation


4.18 vAllocation

Changes to objects This involves logging of the unit allocations.


recipe or library) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object OBJID Int ID of the allocation OTID (1) Int Type ID of the allocation Name nvarchar(max) Name of the allocation Description nvarchar(max) Description of the change UnitId Int ID of the unit if known UnitClassName nvarchar(255) Name of the unit class UseConstraints (17) tnyint The unit is selected by a set of

conditions Start Int Calculated start time relative to the

start of the first unit DauerPlanned Int Calculated time based on the time

values specified in the recipe steps AllocMode Int 1 ("Start Allocation"): Start batch

processing only when the unit is released.

UnitAllocStrategy (18) Int Allocation strategy ProcessParameter Int Variable with the "Unit" data type

(selection of unit depending on the process)

4.19 vAllocationCandidate

Changes to objects This involves logging of the candidates of the unit allocations.

Description of the views 4.20 vPCell



recipe or library) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the allocation POTID (1) Int Type ID of the allocation OBJID Int ID of the candidates OTID (1) Int Type ID of the candidates InstanceID Int ID of unit

4.20 vPCell

Changes to objects All BATCH process cells in the database are logged.

Definition Name Data type Description OGUID Uniqueidentifier GUID of the process cell OBJID Int ID of the process cell PartID Int Version of the process cell. This ID is

always incremented when the process cell is updated.

Name nvarchar(255) Name of the process cell Description nvarchar(max) Description of the process cell ProjectName nvarchar(255) Name of project DBIdent nvarchar(255) Database identification of the process

cell CreationDateTime datetimeoffset(3) Creation date of the process cell ModificationDateTime datetimeoffset(3) Last change to the process cell

4.21 vCategory

Phase and process tag types This involves the logging of all phase and process tag types from PCS 7 engineering.

Description of the views 4.22 vInstance


Definition Name Data type Description PCellGUID Uniqueidentifier GUI of the process cell object PCellPartID Int Part ID of the process cell object OBJID Int ID of the object Name nvarchar(255) Name of the object Description nvarchar(max) Description of the object

4.22 vInstance

Process cell instances This involves the logging of all process cell instances (PCell, Unit, EMOD, EP, EUP, EOP, EPH, TagCollect).

Definition Name Data type Description PCellGUID Uniqueidentifier GUI of the process cell object PCellPartID Int Part ID of the process cell object POBJID Int Instance ID of the higher-level object OBJID Int ID of the instance Name nvarchar(255) Name of the instance Description nvarchar(max) Description of the instance RTName nvarchar(255) Runtime name of the instance VersionNr Int Name of the block Level (8) TinyInt Level of the equipment Category Int ID of the category of the object from the

vCategory view

4.23 vDataType

Process cell instances This involves logging all data types of the process cell.

Description of the views 4.24 vDataTypeValue


Definition Name Data type Description PCellGUID Uniqueidentifier GUI of the process cell object PCellPartID Int Part ID of the process cell object OBJID Int ID of the data type Name nvarchar(255) Name of the data type Description nvarchar(max) Description of the data type

4.24 vDataTypeValue

Values of the enumeration data types This involves logging all values of the enumeration data types from the vDataType view.

Definition Name Data type Description PCellGUID Uniqueidentifier GUI of the process cell object PCellPartID Int Part ID of the process cell object POBJID Int ID of the container object (DataTypeID) OBJID Int ID of the Enum value Name nvarchar(255) Name of the Enum value Description nvarchar(max) Description of the Enum value

4.25 vUoM

Values of the enumeration data types This involves the logging of all physical units of measure of the transferred process cells.

Definition Name Data type Description PCellGUID Uniqueidentifier GUI of the process cell object PCellPartID Int Part ID of the process cell object OBJID Int ID of the unit of measure OTID (1) Int Type ID of the unit of measure

Description of the views 4.26 vMaterial


Name Data type Description Name nvarchar(255) Name of the unit of measure Description nvarchar(max) Description of the unit of measure

4.26 vMaterial

Materials used This involves one-time logging of all materials of the BATCH process cell as well as all materials used in the batches. The material data of batches at the time of the printout or archiving of the batch are listed.

Definition Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (PCell, batch) OGUID Uniqueidentifier GUID of the object OBJID Int ID of the object Name nvarchar(255) Name of the material Code nvarchar(16) Code of the material Description nvarchar(max) Description of the material InputMaterial Bit Input material OutputMaterial Bit Output material

4.27 vParameterDescription

Description of the parameters This involves logging all descriptions of the parameters.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the container object

Description of the views 4.28 vOnlineParameterValue


Name Data type Description POTID (1) Int Type ID of the container object P2OBJID Int ID of the higher-level object of the


container object OBJID Int ID of the parameter Name nvarchar(255) Name of parameter Description nvarchar(max) Description of the object Usage (21) Int Type of parameter DataTypeID Int ID of the data type UoMID Int ID of the technical unit of measure SpProt Int Setpoint reserved for user data ActProt Int Process value: Reserved for user data

4.28 vOnlineParameterValue

Parameter data for the batch This view contains the parameter data of the batches. Only parameters of the batches and the recipe elements that have already been started are logged.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type of the root object POBJID Int ID of the container object POTID (1) Int Type ID of the container object P2OBJID Int ID of the higher-level object of the


container object OBJID Int ID of the parameter ActivationCounter Int Run of the parent of the object Name nvarchar(255) Name of parameter Usage (21) Int Type of parameter DataTypeID Int ID of the data type DataTypeName nvarchar(255) Name of the data type

Description of the views 4.28 vOnlineParameterValue


Name Data type Description UoMID Int ID of the technical unit of measure UoMName nvarchar(255) Name of the technical unit of measure HighValue Float High limit of the value LowValue Float Low limit of the value sp_float Float Setpoint (float) asp_float Float Process setpoint (float) av_float Float Process value (float) sp_int Int Setpoint (int) asp_int Int Process setpoint (int) sv_int Int Process value (int) sp_string nvarchar(255) Setpoint (string) asp_string nvarchar(255) Process setpoint (string) av_string nvarchar(255) Process value (string) loc_unitallocname nvarchar(255) Assignment name of the transfer

parameter loc_unitname nvarchar(255) Unit name of the transfer parameter sp_locname nvarchar(255) Setpoint (location name) asp_locname nvarchar(255) Process setpoint (location name) av_locname nvarchar(255) Process value (location name) sp_matname nvarchar(255) Setpoint (material name) sp_matcode nvarchar(255) Setpoint (material code) asp_matname nvarchar(255) Process setpoint (material name) asp_matcode nvarchar(255) Process setpoint (material code) av_matname nvarchar(255) Process value (material name) av_matcode nvarchar(255) Process value (material code) sp_EnumValue nvarchar(255) Setpoint (name of Enum value) asp_EnumValue nvarchar(255) Process value setpoint (name of Enum

value) av_EnumValue nvarchar(255) Process value. Name of the Enum

value sp_Unit nvarchar(255) Setpoint. Name of the unit asp_unit nvarchar(255) Actual setpoint. Name of the unit av_Unit nvarchar(255) Process value. Name of the unit sp_prot Int Setpoint: Reserved for user data asp_Prot Int Actual setpoint: Reserved for user data av_prot Int Process value: Reserved for user data

Description of the views 4.29 vOfflineParameterValue


4.29 vOfflineParameterValue

Parameter data of master recipes, libraries and formulas This view contains the parameter data of master recipes, libraries and formulas.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (batch, library,

formula) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the container object POTID (1) Int Type ID of the container object P2OBJID Int ID of the higher-level object of the


container object OBJID Int ID of the parameter Name nvarchar(255) Name of parameter Description nvarchar(max) Description of the parameter DataTypeID Int ID of the data type ScalingId Int Adaption method ValueSource (35) Int Name of the technical unit of measure ValueSourceId Int ID of the source parameter ValueDestId Int ID of the target parameter CalcScript nvarchar(max) Expression for calculating the value LoValue_int Int High limit of the value HiValue_int Int Low limit of the value value_int Int Setpoint (int) LoValue_Float Float High limit of the value HiValue_Float Float Low limit of the value value_float Float Setpoint (float) Value_string nvarchar(max) Setpoint (string) Mat_SpMatGUID Uniqueidentifier GUID of the material Mat_SpMatID Int GUID of the material AllocId Int Unit allocation (transfer parameters) SpProt Int Setpoint: Reserved for user ActProt Int Process value: Reserved for user

Description of the views 4.30 vOnlineConditions


4.30 vOnlineConditions

Conditions of the transitions in batches This view contains the transition conditions of batches. Only the conditions of objects already started are shown here.

Definition



container object OBJID Int ID of the condition ActiveCounter Int Run of the transition gate_result Int Result of the transition cond_result Int Result of the condition Operator nvarchar(8) Operator of the condition left_operand nvarchar(255) Left operand left_datatyp nvarchar(255) Data type ID of the left operand left_UoMName nvarchar(255) Unit of measure of the left operand left_value nvarchar(255) Value of the left operand right_operand nvarchar(255) Right operand right_datatype nvarchar(255) Data type ID of the right operand right_UoMName nvarchar(255) Unit of measure of the right operand rights_value nvarchar(255) Value of the right operand

4.31 vOfflineTag

Configured process tags This view contains the configured process tags.

Description of the views 4.32 vOnlineTag


Definition


recipe or library) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the container object POTID (1) Int Type ID of the container object P2OBJID Int ID of the higher-level object of the


container object OBJID Int ID of the container object PrameterId Int ID of the associated parameters

(vParameterDescription view) AllocId Int ID of the allocation CategoryId Int ID of the unit type or of the block type

(view: vCategory)

4.32 vOnlineTag

Process tags of the batch data management This view contains the process tags that were collected by batch data management (CDV).

Definition



container object OBJID Int ID of the process tag

Description of the views 4.33 vCDVMessage


Name Data type Description BatchName nvarchar(255) Name of the batch ArchiveName nvarchar(255) Name of the archive (e.g.

SystemArchive) TagName nvarchar(255) Name of variables MinTagValue Float Minimum value MaxTagValue Float Maximum value UoMId Int ID of the unit of measurement of the

process tag StartTime datetimeoffset(3) Start time for collecting measured

values StopTime datetimeoffset(3) End time for collecting measured

values MaxTagValueNo Int Number of collected measured values TagValueTime datetimeoffset(3) Time of the measured value

TagValue Float Value TagValueQuality Int Quality of the measured value

4.33 vCDVMessage

Process tags of the batch data management This view contains the messages of the batch data management.

Definition



container object TimeStamp datetimeoffset (3) Time stamp of the message OS_Server nvarchar(255) Origin of the OS message MsgNumber bigint WinCC message number

Description of the views 4.34 vFormulaCategory


Name Data type Description MsgCounter bigit Consecutive number (OS-specific)

assigned by WinCC ClassId (36) Int WinCC message class TypeId (25) Int WinCC message type State (22) Int Status of the WinCC message

(incoming, outgoing, etc.) UserName nvarchar(256) Operator name UserOperation nvarchar(256) Operator text with operator name and

type ID of the reporting object Origin nvarchar(256) Name of the reporting object Message nvarchar(256) Message in text form Area nvarchar(256) Name of the unit. Only for messages

within a recipe unit. Priority Int Priority of the message

4.34 vFormulaCategory

Formula categories This view contains all the formula categories.

Definition

Name Data type Description OGUID Uniqueidentifier GUID of the object (formula category) OBJID Int ID of the object OTID (1) Int Type ID of the object Name nvarchar(255) Name of the batch Description nvarchar(max) Description of the object ModificationDateTime datetimeoffset (3) Last change date of the object

4.35 vFormula

Formula This view contains all the created categories.

Description of the views 4.36 vExtendedError


Definition Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (formula

category) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object OGUID Uniqueidentifier GUID of the object (formula) OBJID Int ID of the object OTID (1) Int Type ID of the object Name nvarchar(255) Name of the batch Description nvarchar(max) Description of the object State (30) Int Status of the formula AutomaticVersioning Bit System-aided versioning MajorVersion Int Major version (with system supported

versioning) MinorVersion Int Minor version (system supported

versioning) ProcGUID GUID of the master recipe PCellGUID GUID of the process cell (PCell) ProductId ID of the product ModificationDateTime Datetimeoffset(3) Last change date of the object

4.36 vExtendedError

Extended error messages This view contains all the extended error messages of the BATCH server.

Definition


container object

Description of the views 4.37 vExtendedErrorState


Name Data type Description P2OTID (1) Int ID of the higher-level object of the

container object OBJID Int ID of the error OTID (1) Int Type ID of the error ObjectEntryType Int Type ID of the object ErrorClass (27) Int Type of the error ErrorReason (28) Int Reason for the error

4.37 vExtendedErrorState

Status of extended error messages This view contains all statuses of the extended error messages of the BATCH server.

Definition

Name Data type Description ROOTGUID Uniqueidentifier GUID of the root object (batch) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the error POTID (1) Int Type ID of the error P2OBJID Int ID of the container object of the error P2OTID (1) Int Type ID of the container object of the

error P3OBJID Int ID of the higher-level object of the


container object OBJID Int ID of the error status OTID (1) Int Type ID of the error status State (29) Int Status of the error ActivationCounter Int Run of the object TimeStamp Datetimeoffset(3) Time stamp for the status change of

the error ErrorInfo Int Information about the error

Description of the views 4.38 vOfflineEsigs


4.38 vOfflineEsigs

Status of extended error messages This is a simplified view of the configured electronic signatures. Columns POBJID and P2OBJID correspond to the address of the object, where the signature is to be entered.

OfflineEsigs → Recipe element (P) → Parent of the recipe element (P2)

Definition


recipe, library, formula) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the object POTID (1) Int Type ID of the object EsigEnabled Bit ID of the higher-level object of the

container object OperationType (14) Int ID of the higher-level object of the

container object ClosedExamination Bit This means that if more than one

signature is required, all signatures must be entered at the same time, that is, in an open "Signature" dialog box.

InputOrderRandom Bit Order that must be maintained in providing the required signatures

CountOfUserRole Int Number of roles that need to sign

4.39 vExecutedEsigs

Executed signatures This is a simplified view of the executed electronic signatures. Columns POBJID and P2OBJID correspond to the address of the object, where the signature has been entered.

ExecutedEsigs → Recipe element (P) → Parent of the recipe element (P2)

Description of the views 4.40 vBatchUserRole


Definition


recipe, library, formula) ROOTOBJID Int ID of the root object ROOTOTID (1) Int Type ID of the root object POBJID Int ID of the container object POTID (1) Int Type ID of the container object P2OBJID Bit ID of the higher-level object of the


container object OBJID ID of the object OTID (1) Type ID of the object EsigDynDataId ID of EsigDynData BatchUserRoleID ID of the role OperationType (14) Type of the action LoginName Login FullLoginName Processor WorkstationName PC on which the electronic signature

was executed TimeStamp datetimeoffset(3) Execution time of the signature Valid Bit Signature is valid execesig_comment nvarchar(max) Comment entered for the electronic

signature

4.40 vBatchUserRole

User roles for batches Describes the user roles that are configured in the existing batches.

Definition

Name Data type Description BatchGUID Uniqueidentifier GUID of the batch ID Int ID of the role Name nvarchar(max) Name of the role

Description of the views 4.41 vBatchArchive


Name Data type Description Description nvarchar(max) Description of the role IsSuperUserRole Bit If this the super user role?

4.41 vBatchArchive

Archived batches View of archived batches. This data is relevant only if you have archived batches in the database of a Process Historian.

Definition

Name Data type Description AutoValueID Int Internal ID BatchGUID Uniqueidentifier GUID of the batch BatchName Int Name of the batch BatchID Int Batch ID BatchDescription nvarchar(max) Batch BatchVersion nvarchar(32) Version of the software BatchStartTime datetimeoffset(3) Start time of the batch BatchEndTime datetimeoffset(3) End time of the batch RuntimeDBIdent nvarchar(64) DBIdent PCS7ProjectName nvarchar(256) Project name PCellName nvarchar(256) Name of the process cell ProductName nvarchar(256) Name of the product MasterRecipeName nvarchar(256) Name of the master recipe MasterRecipeVersion nvarchar(32) Version of the master recipe FormulaName nvarchar(256) Name of the formula FormulaVersion nvarchar(32) Version of the formula FormulaCategoryName nvarchar(256) Name of the formula category OrderName nvarchar(256) Name of the order OrderCategoryName nvarchar(256) Name of the order category ArchiveVersion nvarchar(32) Version of the XML ArchiveTimeStamp datetimeoffset(3) ArchiveDataType nvarchar(32) XML or PDF ArchiveData varbinary(max)

Description of the views 4.42 vOnlineUnitAllocation


4.42 vOnlineUnitAllocation

Unit allocation by batches in runtime View for unit allocation by batches in runtime.

Definition

Name Data type Description ROOTGUID Uniqueidentifier Internal ID ROOTOBJID Int Batch ID AllocID Int ID of the allocation AllocName nvarchar(255) Name of the allocation UnitID Int ID of unit UnitName nvarchar(255) Name of the unit StartTime datetimeoffset(3) Start time of allocation of the unit EndTime datetimeoffset(3) End time of allocation of the unit

Description of the views 4.42 vOnlineUnitAllocation



Description of the table value functions 55.1 batch_GetElementsByBatch_Sorted

Transfer parameter @batchguid (Uniqueidentifier): GUID of the batch Returns a list of started objects of a batch in the order they appear in the sequence report (SIMATIC BATCH standard log) (order: start time, hierarchical). For reasons of performance, the use of this function is recommended if you need to identify recipe elements of a batch.

Definition

Name Data type Description ORDINAL Int Number of the element. Determines the order of the elements.ROOTGUID Uniqueidentifier GUID of the root object (batch, master recipe or library) POBJID Int ID of the parent of the object POTID (1) Int Type ID of the parent of the object OBJID Int ID of the object OTID (1) Int Type ID of the object ActivationCounter Int Run of the object Name nvarchar(255) Name of the object Description nvarchar(max) Description of the object StepNo Int Number of the object (contid*10000+termid) Path nvarchar(255) Hierarchical path to the object Level Int Level of the object State (6) Int Status of the object ExState (7) Int Expanded status of the object Start Int Status of the object End datetimeoffset(3) End time of the object DurationPlanned datetimeoffset(3) Planned duration (in seconds) DurationActual Int Actual duration (in seconds) ContinousFlag Int Continue option set ExecuteInPLC Bit Executed in AS-based mode MonitoringTime Bit Monitoring time of the object (in seconds) AllocId Int ID of the allocation UnitId Int ID of unit

Description of the table value functions 5.2 batch_GetStandardReport


Name Data type Description UnitName nvarchar(255) Name of the unit GateLogic nvarchar(255) Linking logic of the transition conditions Parameters nvarchar(max) Parameter or condition in XML format

5.2 batch_GetStandardReport

Transition parameter 1. @lcid (integer): Language ID (1031: German, 1033: English, etc.)

2. @batchguid (Uniqueidentifier): GUID of the batch.

This function returns the data that is displayed in the main report of a batch. There are two types of data in the returned data records:

● ELEM (TYPEID: 0): These are elements of the batch (batch and recipe elements). The elements are sorted by start time and hierarchy. The RSOid column of hierarchyid type determines the order.

● SUBELEM (TYPEID: 10): The sub-elements of an element are displayed under the same section as the container element.

Definition

Name Data type Description ORDINAL Int Number of the element. Determines the order of the elements.RSO Nvarchar(255) Grouping number in the report RSOid Hierarchyid Grouping number in the report TYPEID Int Type of data record (0: ELEM, 10: SUBELEM, 11:

STATECHANGE) OBJID Int ID of the object OTID Int Type ID of the object POBJID Int ID of the container object POTID Int Type ID of the container object ActivationCounter Int Run of the object Name Nvarchar(255) Name of the object StepNo Number of the object (contid*10000+termid) Description Nvarchar(max) Description of the object DataDescription Nvarchar(max) Description of the function from the engineering OPDActiv (11) Int Activation status of the operator dialog ScaleFunc Int Modification of the duration

Description of the table value functions 5.2 batch_GetStandardReport


Name Data type Description Path nvarchar(255) Hierarchical path to the object Level Int Level of the object ProcModel Int Recipe model (2:Flat, 1:Hierarchical) SOT (32) Int Extended type of the object cmd_filter Status that the respective recipe phase must have in runtime

for a corresponding command to be passed State Int Status of the object ExState Int Expanded status of the object Flags Int ContinousFlag Bit Continue option set ExecuteInPLC Bit Executed in AS-based mode START datetimeoffset(3) Status of the object STOP datetimeoffset(3) End time of the object DurationPlanned Nvarchar(255) Planned duration (format: DD HH:MM:SS) DurationActual Nvarchar(255) Actual duration (format: DD:HH:MM:SS) Deviation Nvarchar(255) Deviation between planned and measured duration (format:

DD:HH:MM:SS) MonitoringTime Nvarchar(255) Monitoring time for the object (format: DD HH:MM:SS) GateLogic Nvarchar(255) Linking logic of the transition conditions Conditions Nvarchar(max) Conditions in XML format StartEventId Bigint StartEventID of the object TAGS Nvarchar(max) Configured process tags in XML format ExStartTime datetimeoffset(3) Extended start time of the object* ExEndTime datetimeoffset(3) Extended end time of the object* SP_CS Nvarchar(255) Setpoint of the control strategy AV_CS Nvarchar(255) Process value of the control strategy AllocName4Rpe Nvarchar(255) Unit allocation of the element UnitClassName4Rpe Nvarchar(255) Unit class AllocStrategy4Rpe Nvarchar(255) Allocation strategy AllocMode4Rpe Nvarchar(255) 1 ("Start Allocation"): Start batch processing only when the

unit is free AllocRunTime4Rpe Nvarchar(255) Duration of allocation (format: DD:HH:MM:SS) UnitName4Rpe Nvarchar(255) Unit name hasTags Bit Process tags are configured for the element hasComments Bit Comments are available for the element hasActions Bit Actions are available for the element hasErrors Bit Error are pending for the element hasParameters Bit The element has parameters hasRefreshParameters Bit Current parameters are available for the element

*: The extended times are there to ensure that no messages, actions etc. are lost. The reason for this is that such messages are sent, for example, a few milliseconds before the start or after the end of the object. If the object has only been run once, this time period is set so that all the information fits within it.

Description of the table value functions 5.3 batch_GetConditionRows


5.3 batch_GetConditionRows

Transition parameter: 1. @xmlParam (nvarchar(max)): Conditions in XML format

2. @batchguid (Uniqueidentifier): GUID of the batch

3. @pcellguid (Uniqueidentifier): GUID of the process cell

The passed XML format of the conditions of a transition are represented in tabular form.

Definition

Name Data type Description OBJID Int ID of the condition gate_result Int Result of the transition cond_result Int Result of the condition operator nvarchar(8) Operator of the condition left_operand nvarchar(255) Left operand left_datatype nvarchar(255) Data type ID of the left operand left_UoMName nvarchar(255) Unit of the left operand left_value nvarchar(255) Value of the left operand right_operand nvarchar(255) Right operand right _datatype nvarchar(255) Data type ID of the right operand right _UoMName nvarchar(255) Unit of the right operand right _value nvarchar(255) Value of the right operand


Description of the enumerations 66.1 ObjectType ID Description 3 Batch 4 Possible unit (candidate) 5 Condition 6 Data type 7 Value of the data type (e.g. false, true) 8 Formula 10 Batch instance 11 Change entry in log 12 Order category 13 Batch process cell 15 Description of the parameters 26 Process tag 27 Unit of measure 28 Terminal object, e.g. recipe phase, operator dialog 30 Transition 33 Unit allocation 36 Categories of batch types (operations or phase type) 37 Container in recipes, e.g. RUP, ROP, SUB 40 Order 41 Procedure (master recipe, library or control recipe) 44 Ewiges Logbuch 45 User roles in SIMATIC BATCH 50 WinCC message 64 Material 65 Parameter 89 Monitoring 90 Jump 91 Command step 97 Comment 98 Comment of a message 101 Delete a library reference 107 Action 120 Formula category 125 Grundrezept 126 Bibliothek

Description of the enumerations 6.2 StartMode


ID Description 127 Steuerrezept 128 Substruktur in flchen Rezepten 129 Teilanalgenprozedur 130 Rezeptoperation 131 OPD_RPH (OPD auf RPH-Ebene) 132 OPD_ROP (OPD auf ROP-Ebene) 133 NOP: Leerschritt 134 Warteschritt 135 Bibliotheksverweis 136 Parameterschritt

6.2 StartMode ID Description 0 Operation 2 Immediately 3 Time-driven 4 Zyklisch gesteuert. Wird im Chargendialog nicht angeboten. 5 Ereignis gesteuert. Wird im Chargendialog nicht angeboten.

6.3 BatchState ID Description 1 1 2 Planned 3 Canceled 4 Release prepared 5 Release 6 Locked 7 Waiting 8 Running 9 Paused after step 10 Held 11 Aborted 12 Completed 13 Stopped 14 Testing release 15 Release invalid

Description of the enumerations 6.4 BatchExState


6.4 BatchExState ID Description 1 Error 2 BatchExState_PARTICIPLE_PRESENT 4 Archived 5 Error + Archived 6 Archiving 8 Closed 10 Closing 12 Closed + Archived 16 test 32 Sub-element blocked 64 Sub-element waiting 128 Sub-element active 256 Ready 512 Start command received 1024 Signature 2048 Time expired 4096 Waiting for start allocation 32768 Edited

6.5 StepType ID Description 1 Equipment phase 2 Empty step 3 Operator instruction 6 Library reference 7 Transition 8 Container 10 Command step 11 Jump

Description of the enumerations 6.6 RpeState


6.6 RpeState ID Description 0 Undefined 1 Edited 2 Inactive 3 Starting 4 Running 5 Ready to complete 6 Completing 7 Completed 8 Continuous mode 9 Aborted 10 Aborting 11 Stopped 12 Stopping 13 Held 14 Holding 15 Resuming 16 Paused after step 17 Pausing after step 30 Switched

6.7 RpeExState ID Description 1 + Error

6.8 Level ID Description 1 Batch process cell 2 Unit 3 equipment module 4 equipment procedure 5 equipment unit procedure 6 equipment operation

Description of the enumerations 6.9 ScaleFunc


ID Description 7 equipment phase 8 collection of equipment tags

6.9 ScaleFunc ID Description 1 Linear 2 Quadratic

6.10 OPDActiv ID Description 1 Do not activate 2 Activate and block batch 3 Activate and do not block batch

6.11 OPDIsQuit ID Description 0 Must still be acknowledged 1 Need not be acknowledged 2 Acknowledged

6.12 StepCommand ID Description 6 Start 7 Stop 8 Abort 9 Hold 10 Pause 11 Resume 12 Complete

Description of the enumerations 6.13 ActionType


ID Description 12 Reset 14 Set breakpoint 15 Remove breakpoint 16 Resume breakpoint 32 Reset and start

6.13 ActionType ID Description 3 Start step 4 Pause step (after step) 5 Hold step (immediately) 6 Abort step 7 Resume step 8 Complete step 9 Reset step 10 Remove breakpoint 19 Changing batch parameters 22 Parameter change 23 Parameter change 24 Changing a unit 25 Changing a unit 26 Adding parameters 27 Delete parameter 32 Open master recipe file 49 Delete batch 53 Archive batch 54 Cancel batch 55 Release batch 56 Lock batch 57 Start batch 58 Pause batch after active step 59 Hold batch immediately 60 Resume batch 61 Abort batch 63 Close batch 64 Comment on batch 69 Release formula for production 70 Release formula for testing 71 Revoke formula release

Description of the enumerations 6.14 ActionState


ID Description 89 Release library element for production 90 Release library element for testing 91 Revoke library element release 142 Release master recipe for production 143 Release master recipe for testing 144 Revoke master recipe release 181 Set breakpoint 182 Rename batch 205 Stop batch 206 Unlock 213 Change batch input material 214 Change batch output material 215 Change master recipe process parameters 216 Change master recipe input material 217 Change master recipe output material 218 Change process parameters of library elements 219 Change library element input material 220 Change library element output material 221 Change process parameters of batch elements 222 Change batch element input material 223 Change batch element output material 224 Comment batch element 225 Confirm operator dialog 229 Stop step 250 Abort batch (emergency) 251 Abort step (emergency) 265 Stop step (except for running equipment phases) 270 Change batch quantity

6.14 ActionState ID Description 0 Inactive 1 Not supported 2 Refused 3 In progress 4 Closed 5 Error 6 Aborted

Description of the enumerations 6.15 UserConstraints


ID Description 7 Held 8 Waiting for signature

6.15 UserConstraints ID Description 0 Static candidate selection 1 Dynamic candidate selection via conditions 2 Without restriction

6.16 AllocStrategy ID Description 0 Preferred unit 1 The longest out of use 2 Operator selection 3 Process parameters

6.17 Usage ID Description 1 PP (process parameter) 2 PI (input material) 3 PO (output material) 5 TAG 7 CS (control strategy) 8 RP (transfer parameter)

6.18 MessageState ID Description 1 Incoming 2 Outgoing

Description of the enumerations 6.19 MessageType


ID Description 3 Acknowledged 4 Locked 10 Hidden 11 Displayed 16 System acknowledged 17 Not acknowledged

6.19 MessageType ID Description 1 Messages 2 Operator messages 3 Error messages 4 Limit violations

6.20 ChangeType ID Description 1 Setpoint 2 Process value 4 Duration 8 Unit allocation 16 Allocation strategy 32 Candidate 64 Allocation parameter 128 Start allocation

6.21 ErrorClass ID Description 0 Undefined error 1 No errors 2 Serious error 3 Error 4 Warning

Description of the enumerations 6.22 ErrorReason


ID Description 5 Information 6 Error in child object

6.22 ErrorReason ID Description 101 Undefined error state 103 Timeout 104 No valid unit candidates found 105 Writing data to the database failed 106 Failed to create new process cell 107 Error in transition condition 108 Error logging on at the condition variable 109 Equipment control call failed 110 No connection to the database 200 No connection to equipment 201 Connection to WinCC disrupted 202 Connection to AS disrupted 300 No longer allocated 301 Allocation not possible 302 Reallocation not possible 303 Wrong allocating status 304 Error in release 305 Undefined allocation error 306 Release in active state 307 Failed to get allocation information 308 Not all necessary units could be allocated 309 Unit is not occupied by this recipe 310 Writing data to AS DB failed 311 Reading data of the AS DB failed 312 AS does not have enough free DBs 313 Equipment not allocated 314 Not all AS data blocks could be reallocated 315 Error downloading to the AS 316 Allocation for unit not available 317 Recipe element is waiting for unit allocation 400 Start failed 401 Completion failed 402 Continuous operation failed 403 Start not allowed in this status

Description of the enumerations 6.23 ErrorState


ID Description 404 Command not allowed in this status 405 Command not permitted 406 Command failed 407 Overlapping commands 408 Recipe already completed before command processing 409 Command not allowed in manual mode 500 No server license available 501 No unit license available 502 Not enough unit licenses available 600 Missing batch release 601 Error in the equipment 602 Equipment has wrong status 604 Control strategy error 605 Inconsistent status of the SFC after CPU START 700 Error in child object 701 Command not allowed because child object in manual mode 702 Child object not allocated 800 PROC_ERR set at equipment 801 EXEC_ERR set at equipment. 802 S_ERR set at equipment. Step runtime exceeded 803 LI_ERR set at equipment. Limit violation of a setpoint 804 OP_ERR set at equipment. Faulty operation of equipment 805 EXT_ERR set at equipment 806 ERROR set at equipment. Group error 900 Error in customized phase 901 Registering the customized phase failed 902 Failed to enable the customized phase

6.23 ErrorState ID Description 0 Not initialized 1 Pending 2 Outgoing 3 Removed 4 Aborted 5 Pending and acknowledged 6 Outgoing and acknowledged

Description of the enumerations 6.24 FormulaState, RecipeState


6.24 FormulaState, RecipeState ID Description 0 No status 1 In progress 2 Released for production 3 Release revoked 4 Testing release 5 Release invalid

6.25 RecipeExState ID Description 0 No ExStatus 1 Error 2 Transitional status 4 Archived 16 Test release 1024 Electronic signature required

6.26 SubObjectType ID Description 1 OPD 2 Active 4 Blocking 1024 EOP 4096 NOP 8192 Timer 16348 Softfase 32768 Continuous

Description of the enumerations 6.27 SignState


6.27 SignState ID Description 0 Canceled 1 Canceled

6.28 ValueSource ID Description 1 Value is stored locally 2 Reference to a variable of the surrounding container 3 Boolean or arithmetic expression (stored in text table) 4 Process tag returns a value, e.g. in transition conditions

6.29 ClassId ID Description 5 Process control error (AS, OS) 9 Operator prompt 10 Operator message 16 Status message

Description of the enumerations 6.29 ClassId



Examples of links 77.1 Introduction

This chapter provides examples of how the views are linked semantically. There are 3 types of links.

7.2 Root object - subobjects The linking of a ROOT object with its lower-level objects is based on the GUID of the root object.

1. Return all recipe elements of batch x with OGUID = myGUID: Select * from vRecipeElement where ROOTGUID = myGUID

2. Return all messages of a batch with OGUID = myGUID Select * from vCDVMessages where ROOTGUID = myGUID

Select * from vRecipeElement where ROOTGUID = myGUID

Example:

ROOT (OGUID) = Object(ROOTGUID)

Examples of links 7.2 Root object - subobjects


Figure 7-1 Structure of a hierarchical batch

Examples of links 7.3 Direct recipe element - subobjects


Figure 7-2 Structure of a flat batch

7.3 Direct recipe element - subobjects A recipe element is linked with its immediate subobjects by means of ID, Type and ActivationCounter relationships.

Return all children of a recipe element with ROOTGUID= myGUID, POBJID = myPOBJID, POTID=myPOTID, OBJID=myOBJID, OTID=myOTID, ActivationCounter=myAC and ParentActivationCounter= myPAC.

select * from vRecipeElement as kind where

kind.ROOTGUID = myGUID

and

kind.POBJID = myOBJID

and

kind.POTID = myOTID

and

kind.ParentActivationCounter = myAC

Example:

Parent(ROOTGUID) = Child(ROOTGUID)

Parent (OBJID, OTID) = Child (POBJID, POTID)

Parent(ActivationCounter) = Child(ParentActivationCounter)

Examples of links 7.4 Recipe element - properties


7.4 Recipe element - properties A recipe element is linked with its properties by means of ID, Type and ActivationCounter (or start and end time) relationships.

Figure 7-3 vRecipeElement - properties link

1. Return all comments of a recipe element with ROOTGUID= myGUID, POBJID = myPOBJID, POTID=myPOTID, OBJID=myOBJID, OTID=myOTID, ActivationCounter=myAC and ParentActivationCounter= myPAC.



select * from vComment as cmnt where

cmnt.ROOTGUID = myGUID and

cmnt.POBJID = myOBJID and cmnt.POTID = myOTID and

cmnt.P2OBJID = myPOBJID and cmnt.POTID = myOTID and

cmnt.ActivationCounter = myAC

Example:

Object(ROOTGUID) = Cmnt(ROOTGUID)

Object (OBJID, OTID) = Cmnt (POBJID, POTID)

Object (POBJID, POTID) = Cmnt (P2OBJID, P2OTID)

Object (ActivationCounter) = Cmnt (ActivationCounter)

2. Return all actions of a recipe element (including changes) with ROOTGUID= myGUID, POBJID = myPOBJID, POTID=myPOTID, OBJID=myOBJID, OTID=myOTID, ExStartTime=myStartTime and ExEndTime=myEndTime.

select act.actiontype, act.UserLogin, act.ExecutionHostname, act.State

changeditem.ChangeType, changeditem.Objectname,

changeditem.Oldvalue

changeditem.NewValue

from Action as act LEFT OUTER JOIN ChangedItem as changeditem

on

(act.[OBJID] = changeditem.POBJID AND act.[OTID] = changeditem.POTID

and

act.[POBJID] = changeditem.P2OBJID AND act.[POTID] = changeditem.P2OTID

and

act.[P2OBJID] = changeditem.P3OBJID AND act.[P2OTID] = changeditem.P3OTID

and

act.ROOTGUID = changeditem.ROOTGUID)

where

act.ROOTGUID = myGUID and

act.POBJID = myOBJID and act.POTID = myOTID and

act.P2OBJID = myPOBJID and act.POTID = myOTID and

act.ExecutionTimeStamp <= myEndTime and act.ExecutionTimeStamp >=

myStartTime

3. Return all messages of a container with the following data: ROOTGUID= myGUID, POBJID = myPOBJID, POTID=myPOTID, OBJID=myOBJID, ExStartTime=myStartTime and ExEndTime=myEndTime. Because batch data management (CDV) only uses the main object types Batch (OTID=3), Container (OTID=37) or Terminals (OTID=28), the OTID is explicitly specified.

select * from vCDVMessages as messages where

messages.ROOTGUID = myGUID and

messages.POBJID = myOBJID and messages.POTID = 37

messages.TimeStamp <= myEndTime and messages.TimeStamp >=

myStartTime



4. Return all messages of a terminal term with ROOTGUID= myGUID, POBJID = myPOBJID, POTID=myPOTID, OBJID=myOBJID, ExStartTime=myStartTime and ExEndTime=myEndTime.

select * from vCDVMessages as messages where

messages.ROOTGUID = myGUID and

messages.POBJID = myOBJID and messages.POTID = 28 and

messages.P2OBJID = myPOBJID and

messages.TimeStamp <= myEndTime and messages.TimeStamp >=

myStartTime

The measured values are determined according to 3 and 4.

* Actions, messages, measured values, parameters, ESIGs, comments, etc.


Index

A ActionState, 57 ActionTime, 56 AllocStrategy, 58

B BATCH views, 9 batch_GetElementsByBatch_Sorted, 47 batch_GetStandardReport, 48, 50 BatchExState, 53 BatchState, 52

C ChangeType, 59 ClassId, 63 Custom report templates, 7

D Direct recipe element - subobjects, 67

E ErrorClass, 59 ErrorReason, 60 ErrorState, 61 Export

Report templates, 7

F FormulaState, 62

I Import

Report templates, 7 INFSERVER, 7

M MessageState, 58 MessageType, 59

O ObjectType, 51 OGUID, 10 OPDIsQuit, 55

P Process Historian, 11

Q Query Designer, 10

R Recipe element - properties, 68 RecipeExState, 62 RecipeState, 62 Report, 9 Report Builder, 7, 9 Reporting Services Configuration Manager, 7 Root object - subobjects, 65 RpeExState, 54 RpeState, 54

S ScaleFunc, 55 SQL Server instance, 11 StartMode, 52 StepCommand, 55 SubObjectType, 62, 63

U Upload file, 7 Usage, 58 UserConstraints, 58

Index


V vAction, 24 vAllocation, 28 vAllocationCandidate, 28 ValueSource, 63 vBatchArchive, 44 vBatchUserRole, 43 vCategory, 29 vCDVMessage, 38 vChangedItems, 25 vComments, 26 vContainer, 16 vDataType, 30 vDataTypeValue, 31 vExecutedEsigs, 42 vExtendedError, 40 vExtendedErrorState, 41 vFormula, 39 vFormulaCategory, 39 Views, 7 vInstance, 30 vMaterial, 32 vModification, 27 vMonitor, 20 vMonitoredObjects, 23 vOfflineEsigs, 42 vOfflineParameterValue, 35 vOfflineTag, 36 vOnlineConditions, 36 vOnlineParameterValue, 33 vOnlineTag, 37 vOnlineUnitAllocation, 45 vParameterDescription, 32 vPCell, 29 vProcedure, 22 vRecipeOperation, 18 vRecipeUnitProcedure, 17 vSUB, 19 vTargetObjects, 24 vTermTrans, 21 vUoM, 31

data V8.0 SP1 2 templates - Industry Support Siemens...Modifying supplied log templates SIMATIC...

Documents

Transcript of data V8.0 SP1 2 templates - Industry Support Siemens...Modifying supplied log templates SIMATIC...