Getting started. Wonderware InBalance

Below you will find brief information for InBalance.

Document

Wonderware Finland InBalance Module

6) After importing the IBObjects.aaPKG file, the galaxy contains InTouch application template $TDensityDemo, derived from the base template $InTouchViewApp. The instance DensityDemo is derived from this $TDensityDemo template and demonstrates gas pipeline leak location detection feature, using demo model IBDensity.xml.

Getting started

After InBalance objects are installed and deployed, the InTouch application (instance

IBDemoApp_001) and demo models IBManual.xml (using manually entered data) and

IBHist.xml (using simulated data from Historian database) can be used to become familiar with the basic InBalance functionality. The InTouch application DensityDemo and model

IBDensity.xml can be used to become familiar with the gas pipeline leak location detection feature of the InBalance.

Perform the following steps:

Importing model from XML file

1. Start the InTouch Application Manager, select $InBalance application and click on

WindowViewer icon. The following window will be opened:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 10

Note, that to be able to start the InTouch Managed application, computer needs to be connected to the network.

2. Select the menu command File ->Import from XML

…

3. Browse for IBManual.xml file (demo model using manually entered data) and click the

“Open” button. The IBManual.xml demo model will appear on Model Editor window:

Configuring nodes and streams

4. Check the configuration of streams S1, NMS, S2 and storage node Tank by doubleclicking on them:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 11

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 12

The streams

and

are measured streams,

NMS

is a non-measured stream and

Tank

is a storage node with measured accumulation. For S1, S2 and Tank the values are entered

manually

in “Value” field, what means: for streams it is constant flow rate during time interval used in calculation and for storage node it is accumulation difference during the time interval used in calculation (i.e.: end volume - start volume).

In this demo model all measured data (data in the

“Value” field) are m

/day (for streams) and m set 800 kg/m

(for storage node). Density is required for calculation; in this demo we

for oil streams and storage node.

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module

Saving model to database

5. Create/save model configuration to internal MS SQL database

– by invoking “Save

Model” dialog (from Model Editor main menu -> File -> SaveAs...):

Here the following information related with model (stored in internal MS SQL database and used by InBalance) can be entered:

Server

Computer node name where internal MS SQL database is located.

Use Windows Authentication

If selected, then currently logged Windows User credentials will be used.

Login and Password

If SQL Server Authentication is used, then the Login and Password for accessing the internal MS SQL database should be entered.

Login

By pressing this button, currently available models will be displayed in “Model(s) on” listbox.

New

By pressing this button the “New Model” dialog will be invoked:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 14

Here the

Model name

and

Description

can be entered.

Save

Save the model selected from listbox.

Delete

Delete the model selected from listbox.

Cancel

Return without changes.

Note:

To create model database, you need to logon to MS SQL with user that have rights to create a database, since a new MS SQL database will be created that is used to store the model.

After clicking “OK” in “New Model” dialog, the “New Model” and “Save Model” dialogs will be closed and current model name entered (“IBManual” in our case) will be displayed on

Model Editor window:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 15

Configuring Calculator

6. Start ArchestrA IDE.

7. Open the Calculator configuration editor, by double-clicking the instance

MBDataRecon_001_001, then click on the “License Server” tab. Here a

Software Key

Demo license

or licensing under

License Server

can be enabled.

The

Software Key

should be purchased and currently it is available for 4 product levels, based on total number of model streams used in deployed Calculator object on one computer. To get and enable the software key:

select the appropriate

“ProductID” (e.g. PR00161 103)

copy/paste the automatically generated “PC Code” to e-mail (or text file or similar) and provide this “PC Code” string when ordering the InBalance product

when InBalance product is purchased, copy the received

“Software Key” to corresponding “License Server” tab “Software Key” field and check that it is evaluated as “Valid Key”:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 16

The

Demo license

is for free and provides an unlimited functionality, but is valid only for a limited time period. After demo license expiration the mass balance calculation request will be rejected (it still will be possible to use the Model Editor). The demo license can be obtained by sending request to [email protected]

The Demo license is a text string containing 64 Hex symbols. When received, paste the demo license text string to the

“Demo license text” field and check that it is evaluated as “Valid Key”.

To enable the licensing under

License Server

in case InBalance is delivered as a part of Wonderware Finland

Automation Intelligence Suite

package

, the proper “Product

ID” and “Product Version” should be selected, the “IP Address” of License Server node entered and proper “Customer ID” entered (“Customer ID” is generated automatically when License file (.kllic file) is obtained or it can be received via e-mail. About licensing under License Server, see more in separate “Automation Intelligence Suite License

Server” guide.

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 17

Note:

All included demo models (IBManual.xml, IBHist.xml and IBDensity.xml) do not require licensing, because the 3 stream limit is not exceeded.

. Click on the “Data Source” tab. The following window will be displayed:

9. Enter following Calculator configuration for IBManual model

Cfg.Node: enter the computer name where InBalance internal MS SQL database is located (“localhost”).

Cfg.Database: enter the model database name (“IBManual”).

Cfg.Login: enter the username for operator user, who has access rights to read the model (“IBOperator”).

Cfg.Password: enter the password for operator, who has access rights to read the model (“123”).

Cfg.ModelName: enter the model name (“IBManual”).

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 18

Press “Reconnect” button to read the model configuration from the internal MS SQL database.

10. Check whether the model is loaded correctly

– select the “Model” tab:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 19

If there are no nodes and streams in the list, then check “Data source” tab configuration and Wonderware (SMC) logger for a possible reason.

11. In order to be able to invoke the MS Excel with mass balance demo report, it is necessary to set the

“History extension” checkbox at “Extensions” tab for certain attributes:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 20

Below is a list of these attributes:

Calc.TotalMeasInput

Calc.TotalMeasOutput

Calc.TotalMeasAccum

Calc.TotalRecInput

Calc.TotalRecOutput

Calc.TotalRecAccum

Pump.TotalMeasInput

Pump.TotalMeasOutput

Pump.TotalRecInput

Pump.TotalRecOutput

Tank.TotalMeasInput

Tank.TotalMeasOutput

Tank.TotalRecInput

Tank.TotalRecOutput

Tank.Meas.ReconMass

Tank.Meas.MeasuredMass

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module

S1.Meas.MeasuredMass

S1.Meas.ReconMass

NMS.Meas.MeasuredMass

NMS.Meas.ReconMass

S2.Meas.MeasuredMass

S2.Meas.ReconMass

12. Save and close the MBDataRecon_001_001 configuration by clicking on the icon , located at the top right corner of the configuration editor.

13. Right-click MBDataRecon_001_001 and deploy it, using following settings:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 22

14. Return to the InTouch application. The IBManual demo model now is ready for use.

The data reconciliation, mass balance calculation, visualization and reporting of results now can be done from the

InTouch “InBalance Demo” window:

Besides the Model Editor pane, there are following elements in the

InTouch “InBalance

Demo” window:

“Start time”

and

“End time”

are used to enter the calculation time interval; currently th ere are default settings “Start time” 2/28/2010 12:00 PM and “End time” 2/28/2010

13:00 PM

– one hour calculation interval;

“Solvable”

shows whether model is solvable;

“Iterations”

– shows the count of mathematical iterations used to perform the calculation;

“

Progress

” – displays the calculation progress in % from 0 to 100;

“Status”

indicates the possibility of calculation: “Ready” or “Not ready”; the “Ready” status indicates next/new calculation can be done by pressing the

“Calculate” button;

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 23

“Deploy ready”

indicates the system state of Calculator object (MBDataRecon) deployment: “Ready” or “Not ready”; the “Ready” state indicates next/new calculation can be done by pressing the “Calculate” button;

“Calculate”

button is used to perform the calculation for time interval specified in “Start time” and “End time” field; by pressing this button the “Mass balance” window will open, where total volumes in m

and mass balances in kg are displayed:

“Reconciled data”

button is used to open window with last calculation reconciled data for all streams (in m

/day and kg/day) and gross errors (if any) displayed:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module

“Report”

button can be used to invoke the MS Excel with simple mass balance report generated based on last calculation:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 25

“Model Editor”

button can be used to invoke the separate “Model Editor” window;

“About”

button can be used to invoke the InBalance general description window.

“Calculation status”,

at the bottom of the

“InBalance Demo” window, shows the current calculation status. In case of error an error message will be displayed here.

15.

Now, by changing the “Start time” and “End time”, the calculation can be performed for different time intervals (using same default manually entered values).

16. You can experiment and change the parameters of streams or nodes within existing model and perform the calculation by using changed parameters (model remains unchanged

– number of nodes and streams, their names and links between them remain the same). For example, to change stream NMS from “non-measured” to

“measured/manually entered value”, go to the Model Editor, double click on stream

NMS to change its configuration

– check “Measured variable” and ““Value” as Primary

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module

data source”, enter “Value”: 140 (in m

/day), leave “Transformation to mass (kg/s) coefficient” equal to 1 and “Max. Error %”: 5 and click “OK”:

17. Save model configuration to internal MS SQL database (select command File -> Save in the Model Editor main menu).

18. Open ArchestrA IDE and double click the MBDataRecon_001_001 object to open its configuration editor:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 27

19. Save and close the MBDataRecon_001_001 configuration by clicking on the icon , located at the top right corner of the configuration editor.

20. Right-click the MBDataRecon_001_001 and deploy it.

21. When the deploy is completed, return to the InTouch application and wait until “Deploy ready” parameter, indicating the system state of the Calculator object (internally named MBDataRecon_001_001) deployment, changes from “Not Ready” to “Ready.

22. Click on the

”Calculate” button to perform the calculation. Now, by changing the “Start time” and “End time”, the calculation can be performed for different time intervals

(using the same model configuration).

Using model with data from Historian database

23. Now, let’s use another demo model IBHist.xml (using simulated data from Historian database). The simulated data for InBalance calculations are available in two ways: a) there are generated & stored data for time period from 2010/02/27 00:00:00 till

2010/03/01 00:00:00 (supplied as IBHistorianData.zip file); b) new data generation is started automatically after Historian is started and InBalance objects deployed. New data are generated by the $DataGenerator object scripts

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 28

GenData and GenDataS3. GenData script generates data for streams S1 (150 m

/day

± 6 m 3

/day) and S2 (110 m

/day

± 4.4 m 3

/day) once per minute. GenDataS3 script generates data for storage node Tank. Initial value is 25 and every hour it is incremented by 0.073, until after 24 hours is reaches 26.75 and then is reset back to

25. The data are stored in the Historian database.

In order to switch to this model, in InTouch application Model Editor window select the menu command File ->

Import from XML…

24. Browse for IBHist.

xml file and click the “Open” button. The IBHist.xml demo model will appear in the Model Editor window:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 29

25. Check the configuration of streams S1, NMS, S2 and storage node Tank by doubleclicking on them:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 30

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 31

The streams

and

are measured streams,

NMS

is a non-measured stream and

Tank

is a storage node with measured accumulation. For S1, S2 and Tank the values are taken from Historian database

– correspondingly Historian tagnames dg.S1, dg.S2 and dg.TankLevel are used.

In this demo model all measured data are m

/day (for streams) and m

(for storage node), Density is required for calculation in this demo we set 800 kg/m3 for oil streams and storage node.

26. Save model to internal MS SQL database IBHist (from Model Editor main menu -> File

-> Save...):

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 32

Click on the

“New” button. The following dialog box will be displayed:

Enter the Model name and click on the OK button.

Note:

To create model database, you need to logon to MS SQL with user that have rights to create a database, since a new MS SQL database will be created that is used to store the model.

T he current database name “IBHist” will be displayed in Model Editor window:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 33

27. Start ArchestrA IDE:

28. Right-click and undeploy MBDataRecon_001_001:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 34

29. Right-click and delete MBDataRecon_001_001:

30. Create new instance by right-clicking the

$MBDataRecon_001

in IDE Template

Toolbox “InBalance” Toolset and then by selecting “New”/“Instance” from drop-down menu:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 35

The new MBDataRecon_001_001 instance will be added to the Unassigned Host.

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 36

32. Drag and drop MBDataRecon_001_001 instance to IBArea_001:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 37

33. Double click on MBDataRecon_001_001 to open its configuration editor.

34. Enter the following configuration for IBHist model:

Cfg.Node: enter the computer name where InBalance internal MS SQL database is located in our case (“localhost”).

Cfg.Database: enter the model database name (“IBHist”).

Cfg.Login: enter the username for operator user, who has access rights to read the model (“IBOperator”).

Cfg.Password: enter the password for operator, who has access rights to read the model (“123”).

Cfg.ModelName: enter the model name (“IBHist”).

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 38

35. Press the

“Reconnect” button to read the model configuration from internal MS SQL database.

36. Check if model is loaded correctly

– select the “Model” tab:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 39

If there are no any nodes and st reams loaded then check “Data Source” tab configuration and Wonderware (SMC) logger for possible reason.

37. In purpose to be able to invoke the MS Excel with simple mass balance report (this report supports also the IBHist.xml model), it is necessary to enable appropriate

“History extensions” at “Extensions” tab (see step 11 in this chapter).

38. Save and close the MBDataRecon_001_001 configuration by clicking on the icon , located at the top right corner of the configuration editor.

39. Right-click and deploy the MBDataRecon_001_001.

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 40

40. Return to the InTouch application:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 41

41. The IBHist demo model now is ready for use. The mass balance calculation and reporting of results can be done by clicking “Calculate”, “Reconciled data” and “Report” buttons:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 42

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 43

Using model for gas leak detection

42.

Now, let’s use another demo model IBDensity.xml, demonstrating the InBalance gas pipeline leak detection feature. Start InTouch Application Manager, select the application $DensityDemo and start WindowViewer:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 44

43. In the WindowViewer open the w indow “InBalance Demo”:

44.

Click on the button “Editor” to start Model Editor:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 45

45. Select the menu command File -

>Import from XML…

46.

Browse for IBDensity.xml file and click the “Open” button. The IBDensity.xml demo model will appear on the model Editor window:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 46

47. Select the menu command

“Global parameters” and check the global parameter values:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 47

48. Double-click on the S1 stream and check the configuration:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module

Set “Use global temperature value” checkbox means that for S1 stream calculation the temperature value will be taken from the Global parameters.

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module

Set “Use global Molar mass value” checkbox means that for S1 stream calculation the molar mass value will be taken from the Global parameters.

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module

49. Doubleclick on the “PipelineNode” and check the configuration. The node has two configured pressure measurement points (block valve stations BVS-1 and BVS-2):

50. Double-click on the S2 stream and check the configuration:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 51

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 52

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 53

51. Select the menu command File -> Save As and save the model as a new model with name “IBDensity” to the internal MS SQL database. After saving the Model Editor window will have a following look:

52. Close the Model Editor.

53. Start ArchestrA IDE and open the Calculator configuration editor, by double-clicking the instance MBDataRecon_001_001.

54. Enter following Calculator configuration for IBDensity model:

Cfg.Node: enter the computer name where InBalance internal MS SQL database is located in our case (“localhost”).

Cfg.Database: enter the model database name (“IBDensity”).

Cfg.Login: enter the username for operator user, who has access rights to read t he model (“IBOperator”).

Cfg.Password: enter the password for operator, who has access rights to read the model (“123”).

Cfg.ModelName: enter the model name (“IBDensity”).

Click on the

“Reconnect” button to read the model configuration from internal MS

SQL database.

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 54

55. Check whether the model is loaded correctly

– select the “Model” tab:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 55

If there are no any nodes and streams loaded then check “Data source” tab configuration and Wonderware (SMC) logger for possible failure reason.

56. Save and close the MBDataRecon_001_001 configuration by clicking on the icon , located at the top right corner of the configuration editor.

57. Right-click MBDataRecon_001_001 and deploy it, using following settings:

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 56

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module

58. Return to the InTouch application. The IBDensity demo model now is ready for use. The data reconciliation, mass and volume balance calculation, visualization now can be done from the

InTouch “InBalance Demo” window.

59. Click on the “S1 Pressure” field and enter value 6700 kPa.

60. Click on the button

“Calculate volume from pressure”, to calculate “S1 Volume”.

61. Move the

“Actual leak location” slider between the pipeline endpoints.

62. Click on the button “Calculate” to calculate reconciled gas mass and volume.

Predicted leak location is displayed with red arrow under PipelineNode.

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Wonderware Finland InBalance Module 58

InBalance Ver 1.x User Manual Rev 1.4 PR0016xm14

Key features

Data validation/reconciliation
Mass balance calculation
Integration with Wonderware System Platform
Model Editor for creating system models
Calculator for data validation and mass balance calculation
Data reconciliation using least squares method
Mass balance checking for leakage detection
Accessible results as Calculator object attributes
Model import/export from/to XML file
Historian data integration for measured data

Frequently asked questions

InBalance is a module that provides a solution for mass balance calculation, including data validation/reconciliation. It is integrated into Wonderware System Platform, allowing easy integration into existing and new projects.

InBalance consists of two main submodules: Model Editor and Calculator. The Model Editor is used to create a system model consisting of nodes and streams. The Calculator performs data validation/reconciliation and mass balance calculation.

InBalance offers several advantages over traditional dedicated systems, including reliable and proven solution, easy implementation, wide application scope, easy integration, low investment cost, and easy maintenance and upgrades.