Home

PI OPC Konfigurations-Tool

1. Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 10 of 36 Automatic and manual historical data recover To read the extended data of a batch actions with signatures or operator comments you can define up to 5 triggers after the end of a batch By each trigger the complete extended data available at this moment will be read for this batch All extended data which are added in Simatic Batch after the last trigger will be ignored Please note You need a license including the option Comments and or Actions amp Signatures to get extended batch data 2 3 2 The Data Manager functionality DM The Data Managers short DM function is to process all data from the DC transform it to batch events and store these to a database The structure of the events is adapted for the OSlsoft part of the interface and is independent from the Simatic Batch versions and project settings Another important functionality of the DM is the database management The structured event data are not stored endless The DM deletes all batches where end time is older than a configured time span After deletion the batches are no longer available for the OSlsoft Interface If you want to recover these batches again by the OSlsoft interface please see chapter2 5 Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 11 of 36 Automatic and manual historical data rec
2. Comment In current version only set for ActionType COMMENT Depending on the Simatic Batch version in future set also for ActionType SIGNATURE Obligatory for ActionType COMMENT All other empty 4 5 Description of the extended batch event types 4 5 1 Operator comments The PI Connect SIMATIC Batch interface captures the operator comments of SIMATIC Batch Each performed operator comment in SIMATIC Batch creates one single event for the OSlsoft interface Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 32 of 36 Here the list of all used event definition parameters Meaning ActionType COMMENT Action ID ID of the operator comment UserID name of the performing user LongUserlD full name of the performing user NodeName name of the performing node Comment Comment text limited to 128 characters 4 5 2 Actions The PI Connect SIMATIC Batch interface captures all changes of batch parameters and all actions to the batch hold resume which have a signature Actions without signature are not provided Actions occur on a specific batch element indentified by the batch path structure of the events A batch element can have multiple actions An action can have multiple events The Action ID allows assigning the action event to a specific action In other words the CREATED PERFORMED SIGNATURE and CHANGE events of one action have the same u
3. s action like terminating a phase is of course transmitted by the interface Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 34 of 36 Transitions branches loops and jumps These structures normally have a condition which controls there function We do not transmit any information about enter and leave of it and also no information about the condition Such structures do not have an equivalent in OSlsoft PI Batch Command Step Command steps are recipe elements which take action to one or more destination elements The occurrence of the Command Step is not transmitted by the interface Only the changes e g aboard on the destination element will be transmitted Object Data extended events From the Batch object data we transmit only the above listed data Especially user actions are only transmitted if they have a signature Some more data transmission is scheduled for the next release Please feel free to request for if you miss any important data SIMATIC Batch AS Execution This new feature is not supported in the current release Please contact us if you need this functionality Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 35 of 36 4 7 Example of the OSISoft interface PISISBatch ini file The following box shows a very simple initialization file of the PISISBatch interface of OSISoft Using the file the OSISoft interfac
4. ActionType ActionName Name of the action Empty for ActionType COMMENT COMMENT ActionType Obligatory Obligatory for ActionType CHANGE ActionType CHANGE event All other empt e SetPoint Changes of parameter set point pty Obligatory for ActionType CHANGE Descript ActionType CHANGE name of the parameter All other empty ActionType CHANGE Obligatory only for ParameterID ID of the Parameter ActionType CHANGE Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 31 of 36 Value ActionType CHANGE the new value of the parameter Eu ActionType CHANGE engineering units if available OldValue ActionType CHANGE the previous value of the parameter UserID Name of the user Obligatory for CREATED PERFORMED SIGNATURE and COMMENT Actions Empty for CHANGE Actions LongUserID Full name of the user Obligatory for CREATED PERFORMED SIGNATURE and COMMENT Actions Empty for CHANGE Actions NodeName Note who the action is created performed or signed Obligatory for CREATED PERFORMED SIGNATURE and COMMENT Actions Empty for CHANGE Actions Status Actual status of the action At ActionType CREATED and PERFORMED normally Closed At ActionType SIGNATURE SIGNED At ActionType CHANGES and COMMENT empty Obligatory for CREATED PERFORMED SIGNATURE Actions Empty for CHANGE and COMMENT Actions
5. CREATED Tag 2 Trigger ACTIONTYPE value PERFORMED Tag 2 Trigger ACTIONTYPE value COMMENT J Tag 2 Trigger ACTIONTYPE value CHANGE Tag 2 Value TIMESTAMP UniqueID BatchID Procedure UnitProcedure UNITACTIVATION UnitContID UnitID Operation OPERATIONACTIVATION OperationContID Phase PHASEACTIVATION PhaseContID PhaseTermID ACTIONTYPE ACTIONID ACTIONNAME Event Descript ParameterID Value EU OLDVALUE USE RID LONGUSERID NODENAME STATUS COMMENT Area PROCESSCELL Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 36 of 36 5 User Guide Revision History p Date Revision 3 1 2014 02 26 Lutter y e service do not need administrative privileges e multiple instances e extended data Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014
6. OldValue previous value LongUserlD full name of the signing user NodeName name of the performing node Status status of the signature normally SIGNED batch end 4 6 Restrictions and limitations The very most of the important data for a processed batch is provided by the Data Access API to the OSlsoft interface The SIMATIC BATCH Source events SIS events contain a lot of minor interesting data like internal IDs and others However only the described data is transmitted It depends on the OSlsoft Interface configuration which of this data will be stored in PI Batch The general structure of a batch is always transmitted completely with some little restrictions In the following these restrictions are described Sub Structures In flat recipes of SIMATIC Bach the structure element Sub may be used for grouping phases Such a Sub can group phases running at different units Subs can also contain Subs in any deep structure These two issues are not compatible to the structure aft OSIsoft PI Batch So we don t transmit any Sub structure We only ignore the Sub but we transmit all contained phases Monitors SIMATIC Batch knows a control structure called Monitor These can observer a part of a recipe and take actions on it We do not support Monitors with the actual release All information about the monitor and all functions within it are not transmitted But the result of the monitor
7. Unit procedure not all parameters are set Unique ID of the PI Batch Simatic Batch Batch ID must be unique at any time of the UniquelD lifecycle obligatory Batch ID of the PI Batch BatchID Simatic Batch Batch Name obligatory Procedure Name and version of the master recipe obligatory Level 2 3 4 obligatory UnitProcedure Name of the unit procedure Level 1 empty Level 2 3 4 obligatory UnitActivation Number of the unit procedure activation Level 1 empty Level 2 3 4 obligatory UnitContID Identifies uniquely a unit procedure within an batch Level 1 empty Level 2 3 4 obligatory UnitID ID of the unit equipment no procedure Level 1 empty Level 3 4 obligatory Operation Name of the operation Level 1 2 empty Level 3 4 obligatory OperationActivation Number of the operation activation Level 1 2 empty Level 3 4 obligatory OperationContID Identifies uniquely a phase within a unit procedure Level 1 2 empty Level 4 obligatory Phase Name of the Phase Level 1 2 3 empty Level 4 obligatory PhaseActivation Number of the phase activation Level 1 2 3 empty Level 4 obligatory PhaseContID Reference to the ContID of the parent operation or unit Level 1 2 3 empty Level 4 obligatory PhaseTermID Identifies uniquely a phase within an operation Level 1 2 3 _ empty Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMEN
8. and limitations cccccceeeeeceeeeeee cece ee eeeeeeeeaeeeeeeeeeeeeeeeeneeeeeeeeees 32 4 7 Example of the OSISoft interface PISISBatch ini file eects 34 5 User Guide Revision SION s tecc5 te ca tice ted eine ete hence a eect 35 Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 5 of 36 1 Preface 1 1 Audience The PI CONNECT Simatic Batch interface software was designed to be an open system This guide is addressed to administrators and software engineers who are interested in function of the interface in detail how to configure and what s about maintenance For hardware software prerequisites and installation refer the PI CONNECT Simatic Batch Installation Guide document 1 2 Relationship between OSlsoft and Siemens software The interface software is split in two parts The OSlsoft interface PI Interface for Siemens SIMATIC Batch and the Siemens interface PI CONNECT Simatic Batch You need both interfaces to transfer data from SIMATIC Batch to OSlsoft PI batch This document only describes the Siemens interface The OSlsoft interface provides an own documentation The current release of the Siemens interface is designed and tested with the version 3 0 14 387 of the OSlsoft interface The OSlsoft interface normally is backward compatible We recommend to ask OSlsoft for actual patches and releases 1 3 Organization Chapter 1 This chapter contains a
9. description of the software structure and the mode of operation Chapter 2 This chapter contains a description of the software structure and the mode of operation Chapier 3 This chapter provides information required to configure the software Chapter 4 This chapter contains information about the structure and content of the Batch events from the Simatic Batch server You need this information to build up the configuration of the OSlsoft interface It also contains Important Remarks Chapter 5 Tracing concept and overview of all important error massages Chapter 6 Document history Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 6 of 36 1 4 Applicable other documents All technical details and descriptions contained in our offer are valid and precede this document in case of differences e g in respect to released versions of the interface and the needed other software components e g Operating system Simatic PCS7 Simatic Batch PI Simatic Batch API Simatic Batch Interface to PI System redundancy supported character sets support of flat recipes and others 1 5 Submitting comments Please feel free to give us your opinion of the usability of this manual to suggest specific improvements and to report errors Mail your comments to Address Siemens AG RC DE CS MTE MHM Dynamostr 4 D 68165 Mannheim Germany e mail info rhm industry siemens com 1 6 Copyrights and Trademar
10. file using a text editor like notepad e Set the Event ID of the first event you want to capture from Simatic Batch In case you want to recover all available data from SIMATIC BATCH set the ID to zero Save the file See chapter 2 6 3 Support for manual historical data recover to find out the Event ID e Open the Configuration Application see chapter 3 1 The Configuration application Set the parameter Minimum batch data buffering chapter 3 3 1 Misc parameters to a time range which contains all recovered batch data If the time range is set to small the recovered batches will be deleted by the Data Manager immediately e Restart the PI CONNECT Simatic Batch service of the instance e Reconfigure and restart the OSlsoft interface to recover the data Please read the OSlsoft manual for details Please keep in mind depending on the amount of data to recover the Siemens and the OSlsoft interface software need CPU performance and time 2 6 Batch Dump Tool The setup also installs a helpful tool called Batch Dump Using this tool you can dump all data of a list of batches from a SIMATIC Batch server to files This tool is needed in case of checking compatibility of data clarification of unexpected data transmission or to find the start Event ID for manual history recover 2 6 1 Using the tool You can start the Batch Dump tool at Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIE
11. interface provides batch event data and optionally extended batch event data 4 1 Supported Simatic Batch Level design Simatic Batch normally organizes batches in a hierarchical structure with 4 levels e batch level e unit procedure level e operation level e phase level Some SIMATIC Batch projects have phases running direct under a unit In this case the interface generates a pseudo operation and puts the phase information into this The name of such operation is identical to the unit procedure name SIMATIC Batch also has a flat structure option with only 2 levels e Batch level e Phase level Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 23 of 36 The Interface always creates 4 level batch events for the PI system In case of flat structure the interface uses the Unit parameter of each SIMATIC Batch phase to create the unit procedure level The name of the unit procedure and the unit equipment is identical The interface also creates a pseudo operation level with the same name as used for the unit Please note The handling of flat or hierarchical batch data is both a license option If you e g don t have a license for flat batches such batch data will be ignored A mixed license is possible 4 2 The batch event structure This chapter describes the structure and the meaning of all event types Each parameter listed in the following can be used in the Initializat
12. will never be deleted by this mechanism Successfully processed String Folder to store all successfully processed empty batch events location SIMATIC Batch events The value of this parameter should be left empty if you don t want to store processed SIMATIC Batch events Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 22 of 36 4 Data description The PI CONNECT SIMATIC Batch Interface provides the data for the OSlsoft Interface The OSlsoft Interface polls structured event data by the Data Access API from the Siemens interface This chapter describes the data structure and contents of all possible data events You need this information to build up the Initialization file PISISBatch ini of the OSlsoft interface We provide a very simple example of the Initialization file PISISBatch ini at the end of this chapter The Batch Data are UTF 16 coded by SIMATIC Batch and transferred without any conversion to the OSI Pl Batch Interface Thereby all special characters are handed over However the PI SDK supports 8 Bit ASCII Thus the OSlsoft PI Batch Interface converts the data For details please refer to the Interface description of the OlSsoft Interface The solution Siemens and OSlsoft part together supports only German and English language and country settings These settings have to be consistent in the complete system Simatic Batch Interface PC and PI Client The
13. 2 22s ccd caidaindscts ced cca datie ch ce ceveaischananndaiid ec ictdiccnadubelcecddiddcntddnds 22 4 2 2 Batch Structure Parameters ccceeeeeeeeececeeeeeeeeeeeeeeaaeeeeeeeeeeeeeseesneaeeeeeeees 23 4 2 3 Equipment structure parameters ccccceeeeeeeeeeeeeeeeeeeeeeeeeeeseensneeeeeeeees 24 4 2 4 Event definition parameters ia 2s xersver sag scvatptetcaat staves teeeeet ka el ge tet 25 4 3 Description of the batch event types cccccceeeeeeeeeeeenneeeeeeeeeeeeeeeteneeeeeeeees 25 4 3 1 Procedure start and end events ecccceecceeeeeeeeeeeeeeenaeeeeeeeeeeeeseeseeeeeeeeeees 26 4 3 2 Recipe header event cccccccceeeeeeeeeeneeceeeeeeeeeeesseaaeeeeeeeeeeesessenneeeeeeeeeees 26 4 33 State change GVGING mirarea e ae a aae 27 4 3 4 Process parameter value notification events csseeeeeeeeeeseeeeeeeeeeeeeeeees 28 4 4 Extended Batch event structure ccccceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeneeeeeeeees 29 4 4 1 Event definition parameters extended batch data ccceeeeeeeeeeteeeeeeees 29 4 5 Description of the extended batch event types ceeeeeeeeeeeeeeeteteeeeeeeees 30 45 1 Operator COMMONS sinckieectsieitend tatendashel glace ttade a a iai 30 Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 4 5 2 ACION Sianna a E E E E E tins 31 4 5 3 Change of parameters PEIE EATE VAE T TAE sclera A NE 32 4 6 Restrictions
14. D 10 ABORTING 12 COMPLETED 11 STOPPED 13 STOPPED 12 STOPPING 14 RELEASE_CHECKING 13 HELD 15 RELEASE_INVALID 14 HOLDING 15 RESUMING 16 PAUSED 17 PAUSING Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 29 of 36 4 3 4 Please note State events less than 07 WAITING batch level or 03 STARTING other levels are normally not processed by the interface It is not possible to store such early events in OSlsoft PI Batch Depending on your SIMATIC Batch version and project settings not all states will be provided by the SIMATIC Batch API Description of the state change event Descript string value of the state see listing above Event SateChange Value Integer value of the new state see listing above Process parameter value notification events The Interface can process Parameter Events on all batch levels Depending on the SIMATIC Batch configuration such events may appear on all levels or not SIMATIC Batch knows four types of process parameters with different data properties Process Process Process Control Data propert Parameter Input Output Strateg Parameter name Parameter ID Actual value set point x x Engineering units optional optional optional Material name x x Material code parameter type e Processinput Pl e ProcessOutput PO e ProcessParameter PP e Control Strategy Simatic Batch p
15. Information depends on the SIMATIC Batch version the project settings and the procedure level The list below shows al possible events If the SIMATIC Batch server does not deliver the information the interface can t create such events The table below shows the available data for all four levels Unit Recipe Header Data Procedure Operation Formular_Name x Formular_Version x Master_Recipe_ Name x Master_Recipe_Version x Start_Time_Planed x End_Time_Planned x Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 28 of 36 Quantity with eng units if available x Product_Name x Product_Code x Order_Category_Name x Order_Name x Description x Recipe_Structure flat or hierarchical x Operator_Dialog Type x x Runtime x x Xx x List of all used parameters Event Recipe Header Descript Parameter name from list above Value Value of the parameter Eu engineering units optional 4 3 3 State change events Each level has state change events The available states depend on the level Batch level states All other levels states 02 PLANNED 01 EDITED 03 CANCELED 02 IDLE 04 RELEASE_PREPARED 03 STARTING 05 RELEASED 04 RUNNING 06 BLOCKED 05 READY 07 WAITING 06 COMPLETING 08 RUNNING 07 COMPLETED 09 PAUSED 08 CONTINIOUS 10 HELD 09 ABORTED 11 ABORTE
16. MENS Page 13 of 36 Start gt All Programs gt PI CONNECT SIMATIC Batch V3 gt Batch Dump This screenshot shows the surface of the tool 5 BatchDump 1 Select Output Folder CA TEMP 2 Select Project amp PCell Project SB_MP PCell Production 3 Select Batches Start 2011 02 13 09 58 53 End 2014 02 13 09 58 53 EM 7 first charge 1 FJ first charge2 first charge3 Batch_HB1 first charge4 first charge5 first charge first charge8 4 Get Events amp Object Data Events 5 Get Materials amp Data Types Materials batches Object Data l Data Types Select an output folder Take care to have write access to this folder Select a Project and PCell by using the E to query the available items and select them on the drop down boxes Select a time range and query the list of batches by pushing l2 button Select the batches Press both buttons to get all SIS Events and Object Data of the selected Press both buttons to get additional information from the batch server Thereafter the output folder contains for each batch an object data file lt BatchID gt _OBJECTDATA _ lt timestamp gt xml and a batch event data file H_ lt timestamp gt _576_0000000000_ lt BatchID gt _ lt H or F gt xml Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 14 of 36 2 6 2 2 6 3 T
17. MENS Page 17 of 36 3 3 Instance configuration If you select an instance at the tree view the CONFIG App shows the configuration parameters of this instance on the right side Ei Mise Connection string Data Source localJ SQLEXPRESS Initial Catalog PCSB Inte Minimum batch data buffering 0 Reconnection Cycle 30 Time offset for Extended Batch data Interval 1 00 00 00 Time offset for Extended Batch data Interval 2 00 00 00 Time offset for Extended Batch data Interval 3 00 00 00 Time offset for Extended Batch data Interval 4 00 00 00 Time offset for Extended Batch data Interval 5 00 00 00 E PI Data Area Batch ID Prefix Batch ID Suffix PCell Unique ID Prefix Unique ID Suffix E SIMATIC Batch API Loader False Project and PCell 22 Time out for batch events 480 E Trace Backup folder Maximum file age 0 Maximum file size 0 Trace folder C ProgramD ata Siemens PiConnectSimaticB atch Trace Level Off E XML batch file handling Failed batch events location Maximum number of batch data files 0 Maximum number of days for batch data files 0 Successfully processed batch events location The default view shows the parameters functionally grouped by Misc PI Data SIMATIC Batch API Trace and XML batch file handling The following tables describe the parameters of each group Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 18 of 36 3 3 1 Misc parameters Parameter Data type D
18. NNECT SIMATIC Batch V3 gt Configuration 3 2 Helpful functions of the Configuration Application If you select the root node host name at the tree view the CONFIG App provides at the right side some helpful functions e Shortcut to the Program Data folder In this folder the interface stores the log files of the instances and the files containing the last captured event ID used for automatically recover at startup e Registration of a Logfile viewer If you want to use an other program than notepad to view the log files you can register your own application here The next screenshot shows the functions on the right side of the CONFIG App Summary Host W TLOOT Application Data Folder C ProgramD ata Siemens PiConnectSimaticB atch Logfile Viewer Registered Program C Windows system32 NOTEPAD EXE c Browse C Notepad Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 16 of 36 If you select an instance and open the context menu by right mouse click you can open the logfile of this service instance At the right top side you can also see some general service information 5 x All Instances Instance Properties oe wi TLOO1 General a xa Dace Seice name PiConnectS daaieaehS evee na GEE mae Description P CONNNECT Simatic Batch Service Service status Stopped Startup type Disabled Path to executable JE Program F
19. PI CONNECT Simatic Batch User Guide V3 1 Siemens AG RC DE I CS MTE MHM 2014 by Siemens AG All rights reserved Produced in Germany Siemens AG RC DE I CS MTE MHM Table of Contents WPT AC Cie ese So eth eda E eee cere ace E See cen aaa R ae oe 5 tA Audience Seas ee gesagt ess ee kcies aa see tcte ovat cha a aa a i 5 1 2 Relationship between OSlsoft and Siemens software ccceceeeeeeteeeeeeeees 5 13 SORQAMIZAUON iseasi cc tael a Sect ete tele etait elie tet tease 5 1 4 Applicable other documents cee eee eeeeeeeeee eee eeeeeeeeeaaeaeeeeeeeeeeeeeesnaaaeeeeeeees 6 tS S bmtting COM MMGING ehet cestsuectnnicues TEENE IAA AREE EAEE 6 1 6 Copyrights and Trademark Notices ccceeeeeeeeeeeeeeeceeeeeeeeeeeeeenneeeeeeeeees 6 2 Function of the PI CONNECT SIMATIC Batch Interface ccccceeeeeeeeeeeetteeeeeees 7 2 1 Software OVervieW ec serio cartel ooh E senha aie eds ie aie bere he uniite hla eaves 7 22 Bata FOW aaea ee oie gre eee aa i aaa a t a Airi 8 2 3 Pl Connect Simatic Batch Service winia teasiewGviewarinGvienaieneawane 9 2 3 1 The Data Collector functionality DC ssseessessennnnnnnsseeeennnrnrrnnsereenennnnneeeene 9 2 3 2 The Data Manager functionality DM eeeeeeeeeeeeeeeeeeeeeeeeeeeeneeeeeeeeeeeeeeees 10 2 4 The Data Access API 2s ecise cetdee sn senshie se tendetedtetesitesa nan doeia vend tansnidead dandedasiamesode 10 2 5 Automatic and man
20. S Page 25 of 36 4 2 3 Equipment structure parameters To support the equipment structure in the OSI PI server the interface also provides structure information This means the name of the units operation modules and phase modules In SIMATIC Batch an operation module and phase module name always equals to the operation and phase name The equipment structure also contains the PCell and Area values see chapter 3 3 2 PI Data parameters Area first level of equipment structure in PI Batch configuration ProcessCell second level of equipment structure in PI Batch configuration name of the unit module for PI Batch equipment structure Level 2 3 4 obligatory Unit Simatic Batch unit name Level 1 empty name of the opration module for PI Batch equipment structure Level 3 4 obligatory Operation Module Simatic Batch operation name Level 1 2 empty name of the phase module for PI Batch equipment structure Level 4 obligatory PhaseModule Simatic Batch phase name Level 1 2 3 empty ExtValue for future use always empty Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 26 of 36 4 2 4 Event definition parameters The last section of each event is the event definition section It includes all what happened at the batch element The usage and meaning of the parameters in the 3 tables above is unique for each event type The meaning of the parameters in the follo
21. Set a unique lt empty gt value of Area PCell for each instance of the interface Batch ID Prefix String Prefix of the batch id lt empty gt Batch ID Suffix String Suffix of the batch id lt empty gt PCell String Value for the process cell in PI Batch Seta lt empty gt unique value of Area PCell for each instance of the interface Unique ID Prefix String Prefix of the unique id lt empty gt Unique ID Suffix String Suffix of the unique id lt empty gt Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 19 of 36 Relation between OSlsoft PI Batch and Siemens SIMATIC Batch terms The PI term Unique ID means the Batch ID of SIMATIC Batch The PI term Batch ID means the Batch name of SIMATIC Batch In the following this document uses the OSlsoft PI Batch terms Batch Unique ID Pre Suffix Normally a single SIMATIC Batch server creates Unique IDs by incrementing the ID at each created batch But in case of setting up a new SIMATIC Batch server or restoring an image of a Batch Data Base this ID may step back and produce ambiguous IDs The consequences of this are overwritten and destroyed data in the OSlsoft PI Batch archive If you are not able to set the ID at Simatic Batch to a good unique value you have to set prefixes and or suffixes to get unique IDs Another case to get ambiguous values is a multi instance environment In such cases you hav
22. ace PI Interface for Siemens Simatic Batch e Simatic Batch Client no license needed at the Interface PC e Siemens Interface PI CONNECT Simatic Batch e SQL Server 2005 Express Not included into the PI Connect Simatic Batch interface delivery Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 8 of 36 2 2 Data Flow This figure shows the dataflow from Simatic Batch to the PI system Not shown are the communication interfaces to Simatic Batch Simatic Batch Client within Simatic Batch API and PI SDK includes PI API and AF Client The PI CONNECT SIMATIC Batch interface software part is shown at the yellow box SIMATIC Batch SIMATIC Batch Server Data Collector I Ii Data Manager Batch Liste Batch 1 Batch 2 Batch Data Access API Interface PC OSlsoft Simatic Batch Interface to PI System i PI System PI Server Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 9 of 36 2 3 PI Connect Simatic Batch Service The PI Connect Simatic Batch Service short SERVICE runs as a service About the detailed settings the service like account startup mode and recovery please refer the document PI CONNECT Simatic Batch Installation Guide The Service includes the Data Collection and Data Management f
23. arameter name lt Act_Val gt or lt SetPoint gt The value of the event engineering units optional MaterilName name of the material only PI and PO Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 30 of 36 4 4 4 4 1 MateriallD ID code of the material only PI and PO ParameterID Simatic Batch Parameter ID Numeric index Only in case the parameter is of data type ExtValue enumeration Extended Batch event structure The extended batch data are a part of the batches object data In the current release actions including a signature and operator comments are supported The object data are not transmitted online The interface reads and provides such data 5 times after the end of the batch see chapter 3 3 1 Misc parameters The main part of the event structure is equal in contend and meaning to the normal event data You can see chapter about the parts e Basic parameters e Batch Structure Parameters e Equipment Structure Parameters The content and structure of the event definition is different Extended batch data have an own event definition structure described at the following Event definition parameters extended batch data parameter Meaning optional obligatory Type of extended batch data CREATED PERFORMED SIGNATURE CHANGE COMMENT Action ID ID of the Action or ID of the operator comment Obligatory Obligatory with the exception
24. bytes of a trace file 10000 Set to zero for maximum size of the file system Trace folder String Folder name all tracing information is Program directed to Data folder Trace level Enum Controls the amount of trace data are Info written to the file Highest level Verbose is not allowed in productive environments Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 21 of 36 3 3 5 XML batch file handling parameters After the Interface has processed a SIMATIC Batch event it will be stored into a xml file in case of successful processing located in the Successfully processed batch events location otherwise in the Failed Successfully processed events location It is recommended to set at least a number of files limit Parameter Data Description Default type value Failed batch events String Folder to store all failed processed empty location SIMATIC Batch events The value of this parameter should be left empty if you don t want to store processed SIMATIC Batch events Maximum number of batch Integer Number of files to be kept in the failed or 10000 data files successful batch events location If set to 0 files will never be deleted by this mechanism not recommended Maximum number of days Integer Number of days the files to be kept in the 0 for batch data files failed or successful batch events location If set to 0 files
25. e creates unique names for all recipe levels and stores all events as raw data to two string tags One tag to store normal event data the other tag to store extended event data You can import the tag data of one batch to EXCEL split them by the character and so you get a complete overview of all available events of this batch Recipe 1 BatchID BATCH BatchID UniqueID Recipe 1 Name Proc Procedure Recipe 2 BatchID RUP UnitProcedure UnitContID UnitACtivation Recipe 2 Name Proc UnitProcedure Recipe 3 Name ROP Operation OperationContID _ OperationActivation Recipe 4 Name RPH Phase PhaseTermID PhaseContID _ PhaseActivation Tag 1 Name AllEvents Tag 1 Trigger Event value System Tag 1 Trigger Event value SetPoint Tag 1 Trigger Event value Act_Val Tag 1 Trigger Event value State Change Tag 1 Trigger Event value Recipe Header Tag 1 Value TIMESTAMP UniqueID BatchID Procedure UnitProcedure UNITACTIVATION UnitContID UnitID Operation OPERATIONACTIVATION OperationContID Phase PHASEACTIVATION PhaseContID PhaseTermID Category Descript Event Value EU Area PROCESSCELL Unit OperationModule PhaseMod ule MaterialName MaterialID ParameterID ExtValue Tag 2 Name AllExEvents Tag 2 Trigger ACTIONTYPE value SIGNATURE Tag 2 Trigger ACTIONTYPE value
26. e to set prefixes and or suffixes at least for Unique ID It is recommended to use the same prefixes and suffixes for Unique ID and Batch ID 3 3 3 SIMATIC Batch API parameters This group contains the connection parameter to SIMATIC Batch Parameter Data Description Default type value Loader bool API connection mode Do not change False without advice by support people Project and PCell String Select a connection to a SIMATIC Batch Empty Server PCell using the button in the value box Please note You must have a valid configuration for the Batch API and you have to be able to connect to the destination SIMATIC Batch Server Time out of batch events Integer Time in minutes an event from SIMATIC 480 Batch is expected After this time without an event the Service of the instance exits and will be restarted by the service control manager of Windows Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 20 of 36 3 3 4 Trace parameters This group contains the tracing control parameters Parameter Data Description Default type value Backup folder String Folder of old trace files If value is empty Empty the Trace folder is used Maximum file age Integer The number of days the trace files to be 0 kept in the backup folder Set to zero no traces will be deleted Maximum file size Integer Maximum file size in K
27. escription Default value Connection string String Connection to the SQL Server database Each instance have to use an own database To set the value open the Connection Properties dialog The Log on to the server settings are only used by this dialog Test Connection Button and select a Database The interface runtime uses an own account lt empty gt Minimum batch data buffering Integer Numbers of days into the past the batches are kept in the PI Connect Simatic Batch database Set zero for endless storage not recommended Reconnection Cycle Integer Seconds to wait after an unsuccessfully connect to SIMATIC Batch 30 Time offset for Extend Batch data Interval 1 5 Time Time spans to wait after batch end or previous read of extended batch data If you do not need all 5 times set the further ones to zero Format of the value DAYS HH MM SS 00 00 00 3 3 2 PI Data parameters The parameters of this group complement the event data to OSlsoft PI Batch by constant values or allow making IDs unique The interface does not use the Production Cell PCell name of Simatic Batch because a single instance is able to connect to one PCell only Thus it is more flexible to have a SIMATIC Batch independent value for the PCell in the configuration Parameter Data Description Default type value Area String Value for the area in PI Batch
28. gt all other empty MateriallD ID of the material obligatory for Event e lt Act_Val gt e lt SetPoint gt all other empty Parameter ID 4 3 Description of the batch event types This chapter describes all type of events that can occur Depending on your SIMATIC Batch project not all types of events may occur in all structure levels batch unit procedure operation and phase The following description explains the meaning of the event definition parameters All other parameters do not depend on the event type Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 27 of 36 The Interface provides 4 different event types e Procedure start and end events e Recipe header events e State change events e parameter value notification events The extended event types are described at an own chapter 4 3 1 Procedure start and end events These events are the first or last event of each element An element can be a batch unit procedure operation or phase To ensure that such an event will be the first or last of the procedure generated in PI Batch the source timestamp from SIMATIC Batch will be decreased increased for one millisecond by the interface software List of all used event definition parameters Meaning Event System Value Start or End 4 3 2 Recipe header events For each procedure in SIMATIC Batch some header information is available This
29. he folder contains also a material list file materials xml and a data type file DATATYPES xml Support for evaluation In some cases we recommend an evaluation of the SIAMTIC Batch data before project start or before commissioning In such case please install the software as described at the document PI CONNECT Simatic Batch Installation Guide You do not need to configure the software but the SIMATIC Batch API must have a connection to the Batch server If you do not want to setup a new batch client station you can use an existing After evaluation you can uninstall the software We recommend making a system image or snapshot before installing the software If you send us evaluation data please select enough batches to have all kind of batch data in the dumps Best way is to select an empty output folder to dump all data zip compress the folder and send the zip file by e mail Support for manual historical data recovery To start a manual historical data recovery you need a start BatchID A start at the middle of a batch makes no sense So you can use the Batch Dump tool to select the first batch you want to start from Get the event data of this batch and open the xml file by notepad The next screenshot shows the EventID of the batches first event Use this ID decremented by one as start BatchlD lt xml version 1 0 encoding UTF 16 gt lt Collection size 124 gt lt Event gt lt Header gt lt Eventdef
30. iles x86 Siemens PI CONNECT Simatic Batch 3 PiConnectSimaticBe Account LocalSystem Configuration Sz 21 E PI Data a Area Batch ID Prefix Batch ID Suffix PCell Unique ID Prefix Unique ID Suffix E SIMATIC Batch API Loader False ProjectPCell 22 Time out for batch events 480 E Sonstiges PeannectianS bing Nats Comeo flnesIKhCNl EYPRECC Initisl Catalan Configuration file C ProgramData Siemens PiConnectSimaticBatch PiC onnectSimaticBatch cfg You also have the functions to start or stop the service of an instance by this context menu B x All Instances Instance Properties at W7TLOOT General a Service name PiConnectSimaticB atchS ervice 1 Uninstall Description PI CONNNECT Simatic Batch Service View Logfile Service status Stopped Startup type Manual Path to executable C Program Files x86 Siemens P CONNECT Simatic Batch V3 PiConnectSimaticB atch exe s 1 Account LocalSystem Configuration s A Z E PI Data a Area Batch ID Prefix Batch ID Suffix PCell Unique ID Prefix Unique ID Suffix B SIMATIC Batch API Loader False ProjectPCell Time out for batch events 480 E Sonstiges ConnectionString Data Source local SQLEXPRESS lnitial Catalog P Minimum batch data buffering 0 x Area Value for the area in Pl batch Instance 2 created Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIE
31. initions gt lt Eventdefinition hdl 29 4 SB6_XYZ 1 gt lt Eventdefigtt lt Info event mestamp 05 10 2012 03 06 56 237 PM UTC notifytype 7 gt lt Root hdl 8 SB0_330104 103771 0 2 id 2 name first charge 1 objecttype 9 gt lt Eventsource name first charge 1 objecttype 9 startmode 0 formulaversion V1 1 formt actend 07 24 2012 03 54 35 757 PM UTC actstart 05 10 2012 03 07 19 084 PM U planstart 05 10 2012 03 06 16 000 PM UTC quantityphysunit kg quantity 500 time contid 0 gt lt Header gt lt State currentstateex 0 currentstate 5 oldstateex 0 oldstate 4 gt lt Parameters gt Daramoater hdl 40 1 GRK 22N1N4 1N2771 N A ID N Ns 1 id 1 nama Dad Diamantc r Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 15 of 36 3 Configuration 3 1 The Configuration application The PI CONNECT SIMATIC Batch Interface provides a configuration application short CONFIG App The description of creating a new instance register itas a service initialize the database and the license handling is described in the PI CONNECT Simatic Batch Installation Guide document The User manual shows how to set the configuration parameters of an instance and some more helpful functions of the CONFIG App You must have administrator privileges to start the CONFIG App You can find the CONFIG App at the start menu Start gt All Programs gt PI CO
32. ion file PISISBatch ini except the hidden parameters level and TimeStampUTC These are for internal use of the OSlsoft interface only The parameters are divided in basic parameters structure parameters event definition parameters and equipment structure parameters Here the complete list of all parameters 4 2 1 Basic parameters Each event provided by the PI Connect Simatic Batch interface contains the following header Information Level 1 Batch 2 Unit Procedure 1 3 Operation 4 Phase obligatory hidden TimeStampUTC Timestamp of the event in seconds since 01 01 1970 Floating 1 point value containing sub seconds obligatory hidden GMT Timestamp of the event in yyyy MM dd hh mm ss 000 Time format Formatted by the OSI Interface obligatory 1 hidden user can t access by OSI Interface Template Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 24 of 36 4 2 2 Batch Structure Parameters The structure parameters describe all what you need to assign the event to a specific Batch element batch unit procedure operation or phase including multiple activations of the element The Unit Container and Terminal IDs can be used to get unique names of the batch elements in the OSI PI Server and to refer the recipe structure of SIMATIC Batch The following table shows the batch structure parameters of an event Naturally depending on the level Batch
33. k Notices Copyright 2014 by Siemens AG All Rights Reserved The PI CONNECT Simatic Batch is the property of Siemens AG The reproduction transmission or use of this document or its contents is not permitted without authority Offenders will be liable for damages All rights are reserved Rights of technical modification reserved Pl is a registered trademark of OSI Software Inc All other trademarks or registered trademarks belong to their respective holders Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 7 of 36 2 Function of the PI CONNECT SIMATIC Batch Interface 2 1 Software overview The Siemens component of the interface consists of three functional units e Data Collector PI Connect Simatic Batch Service e Data Manager e Data Access API The Data Collector connects the Simatic Batch server by using the Simatic Batch API The Data Manager receives the raw data from the Data Collector and transforms it into an event data format Since version 3 of the interface the Data Collector and Data Manager is combined in the PI Connect Simatic Batch Service The OSlsoft part of the Interface has access to the event data via the Data Access API The Data Access API is not an own process The OSlsoft interface uses it to access to the Batch Data The following software must be installed and licensed on each Interface PC e PI System Develop Kit SDK e OSlsoft Interf
34. nique Action D For each action the PI Connect SIMATIC Batch interface creates a CREATE and a PERFORMED event within the following data Meaning ActionType CREATED or PERFORMED Action ID ID of the action ActionName Name of the action UserID name of the performing user LongUserlID full name of the performing user NodeName name of the performing node Status status of the action normally closed after batch end For each transmitted action the interface creates also one or more SIGNATURE events depending on the performed signatures at Simatic Batch containing the following data Meaning ActionType SIGNATURE Action ID ID of the action ActionName Name of the action UserID name of the signing user LongUserlD full name of the signing user NodeName name of the performing node Status status of the signature normally SIGNED batch end Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 33 of 36 4 5 3 Change of parameters If a user changes parameters in SIMATIC Batch and this action needs a signature the PI CONNECT SIMATIC Batch interface creates a parameter change event of type SetPoint Meaning ActionType CHANGE Action ID ID of the action ActionName Name of the action Event SetPoint Descript Name of the changed parameter ParameterID ID of the changed parameter Value new set value EU engineering units of the value if available
35. over An access to the DMs database is not allowed and can have inconsistent and destroyed data as a consequence 2 4 The Data Access API The OSlsoft Interface uses the Data Access API short API to query the Batch and extended Batch data from the DMs database The Data Access API runs in the context of the OSlsoft interface process and has neither a user interface nor a configuration file The data format and mode of query was agreed by OSlsoft and Siemens The Data Access Interface was designed as an API which is a DLL implemented by Siemens and used by the OSI PI Batch interface The API is designed for exclusive use of OSlsoft interface Any other use is not allowed and can have inconsistent and destroyed data as a consequence Siemens PI CONNECT Simatic Batch User Manual V3 1 February 26th 2014 SIEMENS Page 12 of 36 2 5 Automatic and manual historical data recovery After restart or reconnect to Simatic Batch the DC normally recovers beginning at the last captured event ID This ID is stored in the file EventID_ lt Instance gt dat located in the program data folder of the interface accessible in two ways e ProgramData Siemens piconnectsimaticbatch e Link at the PI CONNECT SIMATIC Batch configuration dialog To perform a manually history recover follow the next steps e Stop the PI CONNECT Simatic Batch service of the instance where you want to do a recovery e Open the EventID lt Instance gt dat
36. ual historical data recovery ccccceeeeeeeeeeeeteeeeeeeeeeeeeees 11 26 Batch DUMP TOONE Mattie cee et ete ee ede E E he teehee tease 11 2 6 1 Using the WOO bas55 carer caiscnsh asad ereaehitasanchitenctyostiaendoAsetebt Meany tetchebet eames hae 11 2562 S pp rtfor GVGAIUAMON sce seccncein canal cea A E ticle sthgs 13 2 6 3 Support for manual historical data recovery ssseeeseesesesessessseeseseeseeeees 13 Oe CONIGU ANON i cena eee cee N EE E E ea eA ae aes T 14 3 1 The Configuration application cccccecceeeeeeeeeeeeeeneeeeeeeeeeeeeeeeneeeeeeeeeeeteees 14 3 2 Helpful functions of the Configuration Application ccceeeseeeeeeeeeeeeteees 14 3 3 Instance configuration fetish toe tener duet dec ce aiocedc timc dc bodeene coidesdceaed taped puoeans se 16 Ol MiS parameters iri nena ae ne arn ah N nl a nora head 17 3 3 2 PI Data parameters cat oka ken ice aie ee Manado ake 17 3 3 3 SIMATIC Batch API parameterS c ccccceeeeeeeeeeeeceeeeeeeeeeeeeeeaeeeeeeeeeeeeeeees 18 3 3 4 Trace parameters ina a a saa toptable clash a le eot 19 3 3 5 XML batch file handling parameters ssseeeeesennnnnnneeseeerenrnnnreneserrnrnnnneneeee 20 Ae Data description ee ek e Na AE E T E EEEE 21 4 1 Supported Simatic Batch Level design sssssssssssssnrnnnreeseerrrrrnnnrnnserrrrrnnn 21 4 2 The batch event SiUCTUI Gxssjset teat ciate etealctae els ol eleetttet asst a ee 22 4 2 1 Basic Parameters n
37. unctionality 2 3 1 The Data Collector functionality DC The Data Collector functionality short DC uses the Simatic Batch API to access Data from a Simatic Batch The DC s task is to receive all important batch data from Simatic Batch and store this data in raw format This is the captured data e SIS events of Simatic Batch e Material lists to provide code and name of used materials e Data Type list to translate enumeration type IDs to text strings e Object Data of a Batch to provide the Extended Batch Data The DC needs a local installed Simatic Batch API installed by Simatic Batch Client Setup The local Simatic Batch API covers network connection to stand alone Simatic Batch or redundant Simatic Batch servers The DC checks the connection in a defined cycle The DC is normally configured to exit the service if the check fails or no data is arriving within a defined time range see parameter Time out of batch events at chapter 3 3 3 SIMATIC Batch API parameters Therefore the service is configured to restart by service control manager see also the document PI CONNECT Simatic Batch Installation Guide After each connect or reconnect to the Simatic Batch the DC performs an archive recovery starting at the event ID of the last captured date Thereafter it switches automatically to real time data processing In case of the first start the DC does not perform a recovery If you want to do this please refer to chapter 2 5
38. wing table depends on the parameter event Meaning optional obligatory Category parameter type category e Processinput e ProcessOutput e ProcessParameter e ControlStrategy Obligatory for parameter events e lt Act_Val gt e lt SetPoint gt Descript Event lt StateChange gt e string value of the new state Event lt Act_Val gt lt SetPoint gt e parameter name Event lt Recipe Header gt e recipe parameter name obligatory for Event e lt Act_Val gt e lt SetPoint gt lt Recipe Header gt e lt StateChange gt all other empty Event start end events for all procedures 1 e lt System gt batch recipe header data e lt Recipe Header gt state change for al procedures 1 e lt StateChange gt parameter value event all levels e lt Act_Val gt e lt SetPoint gt Obligatory Value Event lt StateChange gt e integer value of the new state Event lt Act_Val gt lt SetPoint gt parameter value Event lt Recipe Header gt recipe parameter value Event lt System gt e lt Start gt or lt End gt Obligatory engineering units Event lt Act_Val gt lt SetPoint gt e Engineering units of the parameter Not all parameters provides engineering units Event lt Recipe Header gt e recipe parameter engineering units Optional MaterialName name of the material obligatory for Event e lt Act_Val gt e lt SetPoint

PI OPC Konfigurations-Tool

Contents

Download Pdf Manuals

Related Search

Related Contents