SIM4ME Portal Excel Simulation

Interface 3.3 With PRO/IIT M Process

Engineering User Guide
© 2018 AVEVA Group plc and its subsidiaries. All rights reserved.

No part of this documentation shall be reproduced, stored in a ret rieval sy stem, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AVEVA assumes no
responsibility for errors or omissions. The information in this documentation is subject to change without
notice and does not represent a commitment on the part of AVEVA. The soft ware described in this
documentation is furnished under a license agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, Int el aTrac,
InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROV ISION, ROMeo, SIM4ME, SimCentral, SimSci,
Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:
https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: 11/28/2018
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 OHB. UK
https://sw.aveva.com/
For information on how to cont act sales, customer training, and technical support, see
https://sw.aveva.com/contact.
 SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

Contents
Chapter 1 Overview ............................................................................................................... 7
Features ................................................................................................................................... 7
64-bit Operating System/MS-Office Compatibility ........................................................................ 7
Software Requirements ............................................................................................................. 7
Guidelines for Installing the Required Soft ware Products ............................................................. 8
Verification for .NE T Programmability Support ............................................................................ 8
Microsoft (MS ) Excel Security Settings ....................................................................................... 8
SIM4ME Portal Checklist ......................................................................................................... 12

Chapter 2 Getting Started................................................................................................... 13

Standalone Mode.................................................................................................................... 13
Launch from PRO\II Software .................................................................................................. 16
Double-click Pre-configured SIM4ME Portal file ........................................................................ 17
Command Prompt ................................................................................................................... 17
Components of S IM4ME Portal ................................................................................................ 18
SIM4ME Portal Doc ument Actions Pane ............................................................................. 19
MS Excel Workbook .......................................................................................................... 20
Important Features of SIM4ME Portal ....................................................................................... 20
Parameters ....................................................................................................................... 20
Color Coding Standards..................................................................................................... 21
UOM (Units of Measurement)............................................................................................. 22
Parameter Details ............................................................................................................. 22
Special Drag-Drop feature ................................................................................................. 23
Mouse Drag-Drop: ....................................................................................................... 23
Ctrl + Mouse Drag-Drop: .............................................................................................. 24
Alt + Mouse Drag-Drop: ............................................................................................... 24
SIM4ME Portal Excel Simulation Interface Ribbon Bar ......................................................... 24
Case Study ............................................................................................................................. 25
Multi-simulation Link ................................................................................................................ 28
Remove Simulations ............................................................................................................... 31
Assay Handling....................................................................................................................... 31
Stream Composition Link ......................................................................................................... 33
Macro Support ........................................................................................................................ 34
Sim4MePortalRunMacro: ................................................................................................... 35
Sim4MePortalCaseStudy RunMacro "CS#XX": .................................................................... 35
Sim4MePortalRunCounterMacro (YY): ............................................................................... 35
Sim4MePortalRestoreInput DataMacro: ............................................................................... 35
RunS electedSimulations ("Full Simulation path" ): ................................................................ 35

3
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Contents

Copy/Cut-Paste Linked Parameters ......................................................................................... 35

Copy Special:.................................................................................................................... 36
Copy Vector Formula: .................................................................................................. 36
Paste Special: ................................................................................................................... 38
Paste Links: ................................................................................................................ 38
Paste Values: .............................................................................................................. 38
Manual Editing of Links ........................................................................................................... 39
Replace Simulation ................................................................................................................. 42
Creation of Audit Log............................................................................................................... 43
Save As Functionality .............................................................................................................. 44
Total Stream Link: ................................................................................................................... 45
Ability to select Individual vector elements ................................................................................ 47
Visibility of the Run button ....................................................................................................... 47
Forward Compatibility of Portal files ......................................................................................... 47
Support for Microsoft Excel’s R1C1 Reference Style ................................................................. 47
Update Initial Estimates ........................................................................................................... 47
+ All:................................................................................................................................. 48
+ Recycle Streams: ........................................................................................................... 48
+ Columns: ....................................................................................................................... 48
+ Controller, MVC and Optimizer: ....................................................................................... 48
Component Properties............................................................................................................. 48
Refinery Inspection Properties:........................................................................................... 49
Stream Property Tables ........................................................................................................... 49
Unit Operation Property Tables ................................................................................................ 50
Plots ...................................................................................................................................... 50
SIM4ME Portal as an OP CUA Client ........................................................................................ 53

Chapter 3 Demo ................................................................................................................... 55

StandAloneLaunchDemo.swf: .................................................................................................. 55
PortalLaunchFrom ProII.swf: .................................................................................................... 55
PortalUs e.swf: ........................................................................................................................ 55
LinkedP arameters.swf: ............................................................................................................ 55
DisconnectFromP2.swf: ........................................................................................................... 55
AutoRun_UOM.swf: ................................................................................................................ 56
ExcelSaveThruStdAloneCombine.swf:...................................................................................... 56
ExcelSaveThruP roII.swf: ......................................................................................................... 56
Office2010 support to Portal2.4.swf: ......................................................................................... 56
Case-Study.swf: ...................................................................................................................... 56
Multi-Sim-Link.swf: .................................................................................................................. 56
Stream Link.swf: ..................................................................................................................... 56
Assay handling.swf: ................................................................................................................ 56

4
Contents SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

Total Stream Link Demo.swf: ................................................................................................... 56

Macro Support for ease of use.swf: .......................................................................................... 56

Appendix A Known Issues.................................................................................................. 57

Appendix B FAQs ................................................................................................................ 59

5
 SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

C HAPTER 1
Overview
The S IM4ME P ortal is an application t hat integrates SimSci simulation software products with Microsoft®
Excel®. It provides access to the simulation models and data to the people who don’t traditionally use
simulation soft ware, like plant operators, maintenance staff, and management staff. SIM4ME Portal has
been integrated with PRO/II, PIPEPHASE, INPLA NT, VISUA L FLARE, ARPM and ROMeo.

In This Chapter
Features ........................................................................................................................................ 7
64-bit Operating System/MS-Office Compatibility .............................................................................. 7
Software Requirements ................................................................................................................... 7
Guidelines for Installing the Required Soft ware Products ................................................................... 8
Verification for .NE T Programmability Support .................................................................................. 8
Microsoft (MS ) Excel Security Settings ............................................................................................. 8
SIM4ME Portal Checklist............................................................................................................... 12

Features
1. Open/Edit/Run/Stop Simulations
2. Case Studies
3. Link Multiple Simulations
4. View Results
5. Stream composition Link
6. Copy/Cut- Paste Links
7. Component Properties (Fixed/ RIP)
8. SPT and UP T
9. Plots
10. Edit Links
11. Copy Formula

64-bit Operating System/MS-Office Compatibility

 SIM4ME Portal 3.0 and onwards is compatible with 64-bit Micros oft Operating systems as well as
64-bit MS-Office versions.

Software Requirements
 32/64 bit Operating Systems: Microsoft Windows, 7, 8, 8.1, Server 2012 and Windows 10.
 32/64 bit Microsoft Offic e®: Microsoft Office 2007 Professional Plus and above office versions.

7
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Overview

 .Net Framework 4.0

 VSTO 2005 SE
 VSTO 4. 0
 Microsoft Office Primary Interop Assemblies (PIAs)

Guidelines for Installing the Required Software Products

 .Net Framework 4.0: To install .Net Framework 4.0, double -click dotNetFx40_Full_x86_x64.exe
(setup file) available in Microsoft .NE T Framework 4 Setup folder in the installation directory.
 VSTO 2005 SE: To install VS TO 2005 SE, double -click vstor.ex e (setup file) available in
VSTO2.0SE folder at the following location: "…\ThirdPartySoftware\VS TO2.0SE."
 VSTO4.0: To install VSTO4.0, double-click vstor40_x86. exe (setup file) if the system type is 32 bit
operating system, otherwise double-click vstor40_x64.exe. Both vstor40_x86.exe and
vstor40_x64.exe are available in VS TO4.0 folder at the following location: "…\ ThirdPartySoftware\
VSTO4.0."
 Microsoft Office PIAs : Install Microsoft Office P IAs only if Office 2007 is installed. To install
Microsoft Office 2007 PIAs, run the "o2007pia.msi" file from the following path
"…\ThirdPartySoft ware\O2007PIA."

NOTE: Versions above MS -Office 2007 do not need any PIAs.

Verification for .NET Programmability Support

To verify .NE T Programmability Support in Microsoft Office 2007, 2010, 2013, 365 or 2016 on the Start
menu, click Run, type "appwiz.cpl" in the Run window, and then click OK. In the listed programs, Right
click on Microsoft Office 2007/2010/2013/365/2016 in Programs and features window then click on
"Change".

Microsoft (MS) Excel Security Settings

If MS Excel 2007, 2010, 2013, 2016, or 365 (Desktop version) is installed in your computer, enable
Macros, VBA access, ActiveX controls to use it with SIM4ME Portal.

8
Overview SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineerin g User Guide

To enable the required MS Excel security settings

1. On the MS Excel File menu, click Excel Options, click Trust Center, and then click Trust Center
Settings. The Trust Center dialog box appears.

Figure 1. Excel Options and Trust Center Settings

2. In the Trust Center window, do the following:

9
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Overview

a. Click Macro Settings and then under Macro Settings, select the "Enable all macros" radio
button and under Development Macros Settings, select the "Trust acce ss to the VBA object
model" check box.

Figure 2. Trust Center with Macro Settings

10
Overview SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineerin g User Guide

b. Click ActiveX Settings, select the "Prompt me before enabling Unsafe for Initialization
(UFI) control s with additional restrictions and Safe for Initialization (SFI) control s with
minimal restrictions" radio button, and click OK.

Figure 3. Trust Center with ActiveX Settings

NOTE: If you do not have the permission to change these settings, add a Us er Folder (or folder
where .xlsm file resides) to the Trusted Locations tab in Excel workbook.

To add the User Folder to the Trusted Locations tab in Excel workbook
1. In the Trust Center window, click the Trusted Locations tab, and then click the Add new location
button. The Microsoft Office Trusted Location dialog box appears
2. Click Browse, search for the required folder, and select it.
3. Select the "Subfolders of thi s location are also trusted" check box and click OK.

11
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Overview

Figure 4. Add New Location button for user Trusted Location

SIM4ME Portal Checklist

SIM4ME Portal automatically checks the availability of the pre-requisite soft ware products and their
settings. If any of them is not found, SIM4ME Portal triggers a warning message, and you need to install
the missing products or change their settings to match the Portal requirements.
You can manually check whether these pre -requisites are installed in your computer by opening
Add/Remove Program s in the Control Panel. To navigate to Add/Remove Programs, on the Start
menu, click Control Panel, and then click Add/Remove Programs.
For more information on pre-requisite software products, contact the SIMSCI technical support team.

12
 SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

C HAPTER 2
Getting Started
The SIM4ME Portal can be launched using one of the following ways:
1. In Standalone mode
2. From PRO/II Software
3. By double-clicking pre-configured S IM4ME Portal file
4. From command prompt (S IM4ME Portal has the capability to Run and update the simulation through
command prompt without launching its user interface.)

In This Chapter
Standalone Mode ......................................................................................................................... 13
Launch from PRO\II Software ........................................................................................................ 16
Double-click Pre-configured SIM4ME Portal file .............................................................................. 17
Command Prompt......................................................................................................................... 17
Components of S IM4ME Portal ...................................................................................................... 18
Important Features of SIM4ME Portal ............................................................................................ 20
Case Study .................................................................................................................................. 25
Multi-simulation Link ..................................................................................................................... 28
Remove Simulations ..................................................................................................................... 31
Assay Handling ............................................................................................................................ 31
Stream Composition Link .............................................................................................................. 33
Macro Support .............................................................................................................................. 34
Copy/Cut-Paste Linked Parameters ............................................................................................... 35
Manual Editing of Links ................................................................................................................. 39
Replace Simulation ....................................................................................................................... 42
Creation of Audit Log .................................................................................................................... 43
Save As Functionality.................................................................................................................... 44
Total Stream Link:......................................................................................................................... 45
Ability to select Individual vector elements ...................................................................................... 47
Visibility of the Run button ............................................................................................................. 47
Forward Compatibility of Portal files ............................................................................................... 47
Support for Microsoft Excel’s R1C1 Reference Style ....................................................................... 47
Update Initial Estimates................................................................................................................. 47
Component Properties .................................................................................................................. 48
Stream Property Tables ................................................................................................................ 49
Unit Operation Property Tables ...................................................................................................... 50
Plots ............................................................................................................................................ 50
SIM4ME Portal as an OP CUA Client .............................................................................................. 53

Standalone Mode
SIM4ME Portal can be launched in standalone mode either by clicking the shortcut available on the
desktop or by navigating to SIM4ME Portal from the Start menu.
To launc h SIM4ME Portal from the Start menu, on the Start Menu, point to All Programs, click SIMSCI,
click PRO/II, and then click SIM4ME Portal.

13
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Figure 5. Stand-alone mode for launching SIM4ME Portal

Once you have double-clicked SIM4ME Portal (either from desktop or Start menu), complete the
following steps to set up the MS Excel workbook.
1. In the Open/Create SIM4ME Portal window, enter a name for the new MS Excel Portal file you wa nt
to create and click Open.

Figure 6. Open/Create SIM4ME Portal dialog box

14
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

The following message appears.

Figure 7. Pop-up displaying file does not exists message

2. Click Yes. The Sim4Me Portal - Choose Simulation window appears.

Figure 8. SIM4ME Portal - Choose Simulation dialog box

15
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

3. Browse and select the .prz file that needs to be linked to SIM4ME Portal. Selected .prz file opens
along with the Flowsheet Explorer as shown in Figure9.

Figure 9. .prz file along with the Flowsheet Explorer

4. Select the required variable from the Flow sheet Explorer and then drag and drop it on any
worksheet in the workbook.
5. Modify the simulation variables in the worksheet and click Run.
The simulation with the modified values is run from within the Excel workbook and the out put is written
back to the Excel worksheet.

Launch from PRO\II Software

Verify that PRO/II is installed in your computer. If yes, open any simulation in it and complete the
following steps:
1. On the Output menu, click Report Manager, and then click SIM4ME Portal. The Open/Create
SIM4ME Portal dialog box appears.

16
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

NOTE: You can also add a shortcut to the PRO/ II toolbar by adding a SIM4ME Portal icon from the
View menu.

Figure 10.: SIM4ME Portal option in PRO/II Output menu

2. In the Open/Create SIM4ME Portal dialog box, enter a name for the new MS Excel Portal file you
want to create and click Open.

NOTE: By default, the name selected is the name of the .prz file. However, you can overwrite it to suit
your preference.

Double-click Pre-configured SIM4ME Portal file

If a SIM4ME Portal file is already created on your computer, either from Standalone mode or from
PRO\II, double-click this file to launch SIM4ME Portal.
If the SIM4ME Portal files are migrated from one computer to another, open them either from P RO/II or
SIM4ME Portal for proper schema evolution of simulation database.

Command Prompt
You can run a SIM4ME Portal worksheet from the command prompt. The portal worksheet automatically
refres hes when it is opened and reconciles itself wit h the underlying database, which means it overwrites
or ret ains the old values depending on commands you have provided in the command prompt.
Example:
Following commands are entered to run SIM4ME Portal file through command prompt.
/progid = {progid of product adapter}
/regsubkey = {registry key for the product}
/portalFileName = {name of excelspreadsheet file}
/updateExcelFromDatabase = {0, 1}

17
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

where
"1" implies that the workbook will be overwritten with the database values,
"0" implies that values in Excel spreadsheet get retained in portal file.

/run= {0, 1}
where
"1" implies run the simulation

Figure 11.Sample command to run SIM4ME Portal file

In this example, the intent is to use the Portal as an Excel workbook report generat or. A Portal file is
configured by the user with t he desired parameters. Subsequently the P ortal file is invoked by the P RO/ II
RTS via the command prompt.

The likely sequence of events:

1. The PRO/II RTS runs the PRO/II simulation and then Portal file is invoked via the command line.
2. The Port al file then gets updated with the new database values and/ or retains the excel values
depending on user arguments – "updat eExcelFromDat abase" and "run".
3. After the refresh, the Portal file gets disconnected and is available as a normal Excel workbook file.
4. The RTS then automatically emails this file to users who then have a report of the database in
Microsoft Excel workbook.

Components of SIM4ME Portal

The SIM4ME Portal consists mainly of two parts. They are:
1. SIM4ME Portal Doc ument Actions Pane

18
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

1. MS Excel Workbook

Figure 12. Components of SIM4ME Portal

SIM4ME Portal Document Actions Pane

The components of S IM4ME Portal Document Pane are:

Feature Description

Flowsheet Explorer The Flowsheet Explorer displays a tree view of the unit operations and
streams available in the flows heet. The unit operations and streams are
grouped under their respective classes. Each class has a hierarchical
structure of entries. Each unit operation or stream is associated with a
parameter group, which may have one or more parameters associated
with the group.
The Flowsheet Explorer is a floating window, which can be resized and
moved to any preferred location.

Run Sequencer Tab The Run Sequencer tab allows the user to define the order of simulation
in which the user wants to execute them. When a simulation is
disconnected, the sequence is automatically updat ed. It contains a list
box to define the sequence of simulation files.

19
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Linked Parameters Tab If a large number of parameters from the Flowsheet Explorer is dragged
and dropped onto the worksheet, it can become difficult to quickly locate
the paramet ers in the Excel worksheet.
The Link ed Paramet ers tab displays the live linked parameters.
Double-click any parameter to know the parameter’s location in the
Excel worksheet.

Messages Tab The Messages Tab displays the pre -processing warnings/errors
generated by PRO/ II software.

Run Aut o Run The Run button executes the .prz file from Excel workbook.
The Auto Run option is used to run the .prz file automatically, whenever
the input parameters are changed in the Excel workbook.

User Mode Upon selecting User Mode check box, following changes t ake place:
The Flowsheet explorer becomes inactive and the new drag- drop to
spreadsheet does not work. Remaining functions work as usual.
Add Case Study, Use Horizontal Cas e Studies Layout, Add Simulations,
Remove/Replace Simulations, Stream Composition Link, Tot al Stream
Link, and Restore Input Data become inactive in SimSci Add-in
drop-down list.

Filter The Filter button filters the parameters based on the string you supply.
Note that it does not filter at a group level or at a Unit operations level. In
the current implementation, it only filters at the attribute level.
For example: Enter " Temp" as the string. It gives all instances of Temp
in the Flowsheet Explorer.

MS Excel Workbook
The Workbook consists of the "Solution History" worksheet and other worksheets. Variables can be
dragged and dropped from Flowsheet Explorer ont o any worksheet except the "Solution History"
worksheet because the SIM4ME Portal program gene rates it. Input values can be changed in the
worksheets and the simulation can be run by clicking the Run button in Flowsheet Explorer.

Important Features of SIM4ME Portal

Parameters
The input values and out put (calculated) values of all the parameters can be identified with the color of
the icon available in front of the parameter.

20
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

1. Input values for all the Unit Operation and Stream parameters appear with a BLUE ic on.

Figure 15: Input Values - Blue icon

2. Calculat ed values for all the Unit Operations and Stream parameters appear with a GREEN icon.

Figure 16: Calculated Values - Green icon

Color Coding Standards

Input Parameters
Color of the icon is Blue
1. For Input parameters that are dragged and dropped on MS Excel.
2. When Run is successful after modifying the Input Parameters.
3. When specified keyword file is not found.
Color of the icon is Red when
1. Input Parameters are modified. (E ven the parameters that are linked to the changed parameters are
displayed in red color.)
2. Run fails after modifying the Input Parameters.
3. Run fails after Input Parameters are modified and Restore Input Data is selected.
4. Input parameters are modified and Run is not processed. When the same parameters are dragged
and dropped again on MS Excel worksheet, they appear with red icons.

Color of the icons for read-only parameters is Green.

Run Button
Color of the icon is Blue when
1. Simulation is solved with no errors or warnings.
2. Simulation is solved with warnings.

Color of the icon is Yellow

1. When simulation is solved with errors.

Color of the icon is Red when

1. Simulation is not solved.
2. Specified keyword file is not found.

21
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Color of the icon is Pink when "Restore Input Dat a" option is selected.

UOM (Units of Measurement)

The UOM Slat e in S IM4ME P ortal is same as the slate used in PRO/II flows heet. You cannot override the
slate in the current phase. You can change the UOM of individual scalar attributes or full vectors by
clicking the UOM cell on the worksheet and selecting "Change Units" or "Convert Value". Change Units
button is inaccessible for Read-only Scalars/Vectors.
If you select the "Long description" check box, detailed description the UOM is displayed.

Figure 13. Units of Measure Conversion dialog box

NOTE: Change Units button leaves the associated value unchanged when units are changed. Convert
Value button converts the value along with the associated UOM.

Parameter Details
It is possible to provide "custom descriptions" for the variables if required. For example, user can
customize or rename the default description as "F1.Temperature (Us er Input)" to "Flash Temp".

22
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

When a worksheet has many cells containing variables linked to t he P RO/II software and cells containing
description modified by the user, it can become very difficult to identify the variable that was originally
available in the cell. To avoid this confusion, right-click the cells and select "SIM4ME –View parameter
details" to view the details of the actual link connected to PRO/II soft ware.

Figure 14. Parameter Details for Active Cell

Linked parameters window is enhanced by adding UOM Class, UOM Value and Parameter location
details for any selected port al paramet er. SIM4ME-View parameter details window is enhanced by
adding UOM Value for any selected parameter.
The following figure shows the newly available data in their respective windows.

Figure 15. UOM value in Linked Parameters tab

Figure 16. UOM value in SIM4ME- View Parameter Details window

Special Drag-Drop feature

SIM4ME Portal 3.3 is providing Ctrl/Alt + Mouse Drag -Drop support to drag the parameters from flex grid
to drop on Portal worksheet. These two features provide the flexibility of designing S IM4ME Portal
worksheets in user convenient way.

Mouse Drag-Drop:
You can drag and drop of Portal parameter ont o worksheet with Mous e left click action. This action drops
a scalar/ vector ont o worksheet with Parameter Description, Value and its UOM (if the property is having)
as a group of selection.

23
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Ctrl + Mouse Drag-Drop:

You can also drag and drop a Port al parameter onto worksheet with "Keyboard’s Ctrl key + Mouse left
click" action. This action drops a scalar/ vector ont o worksheet with Value and its UOM (if the property is
having) as a group of selection and avoiding Paramet er Description.

Alt + Mouse Drag-Drop:

You can drag and drop a Portal parameter ont o worksheet wit h "Keyboard’s Alt key + Mouse left click"
action. This action drops a scalar/ vector onto worksheet with only its Value and avoiding Paramet er
Description and UOM fields.

SIM4ME Portal Excel Simulation Interface Ribbon Bar

The SIM4ME Portal Excel Simulation Interface Ribbon Bar provide options to communicate with
simulation database to perform user actions such as modifying simulation input data and to fetch the
output to excel interface.
Following is a brief description of all the options available on the SIM4ME Portal Excel Simulation
Interface Ribbon Bar:

Flowsheet Explorer If Flowsheet Explorer is closed, it can be opened again using this option.

Disconnect It disconnects Simulations from the workbook.

Simulations

Refresh After creating the workbook, if the PRO/ II simulation file is modified, the
Refresh option updates the Excel workbook cells in SIM4ME Portal wit h the
current values of the PRO/ II simulation file (.prz).

Refresh Plots If the product simulation file is modified then this option updat es the plots
present in workbook.

Delet e Plots This option deletes th.e plots data pres ent in the workbook.

Update Initial This option is useful to invoke the "Update Initial Estimates" command in
Estimates PRO/II software from within the SIM4ME Portal.

Add Cas e Study It allows you to add a case study grid.

Use Horizont al/ Case This option toggles the format of case study grid arrangement from
Studies Layout Horiz ontal to Vertical cycles and vice -versa.

Suppress/Publish It allows you to suppress/publish case study warnings during case study
Case Study Warnings run.

24
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

Add Simulations This option is used to add a simulation to the SIM4ME Portal file.

Remove/Replace It allows you to remove or replace the simulation from SIM4ME Portal.
Simulations

Stream Composition It provides ability to link composition vector from one simulation to anot her.
Link

Total Stream Link This option is used to transfer stream data from one simulation (source
stream) to another (destination stream) by dragging and dropping the
name parameter into the grid.

Restore Input Data This is useful to invoke the "Restore Input Dat a" command in PRO/ II
software from within the SIM4ME Portal.

Save Database This option allows you to save the product database

About It allows you to view the SIM4ME Portal version information

Help It allows you to view the product’s SIM4ME Portal Help file.

Case Study
Use this feat ure to add a Case Study in SIM4ME Port al.
To add a Case Study and work on it
1. Click a cell in the worksheet and then click Add Case Study on the SIMS CI menu. An empty Case
Study grid is created at the selected cell location on the worksheet with
 Run button inactive.
 Delet e button active – selecting delete option removes the case study grid completely.

Figure 17. Layout of empty Case study grid

2. Drag-drop the parameters on the worksheet cell, "Add Param+". The parameters, after being
dropped on the case study grid, take the appropriate format, as shown in the following figure and the
Run button gets activated.

25
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

On Flowsheet Explorer, the input parameters are indicated with Blue flag and calculat ed
parameters are indicated with Green flag.

Figure 18. Active Run button

3. Provide the case study iterations by entering random values in Input Parameter (Blue) column in the
case study grid. Case study grid expands and indicat es the entered value as CY CLE2 in the Input
Parameter column. This is iteration 2 of the case study run.
4. Right -click the cell in the Input Parameter column in case study grid to find the SIM4ME - Generate
Points menu.
5. Click SIM4ME - Generate Points to define the case study cycles. The Define Case Study Cycles
dialog box appears.
6. Enter the required data for the case study cycles. Three different sets of data can be defined for the
case study cycles. In the following figure, one set of three cycles is defined with a step size of 10.

Figure 19. Define Case Study Cycle dialog box

7. Click the Run button in the Case Study grid. The Case Studies Run Configuration window appears. It
displays the details of the iterations under execution. The calculated parameters get updated
simultaneously for changes in the respective input parameters.

Figure 20. Case Studies Run Configuration dialog box

26
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

8. Change the "Include/Exclude" Flags from 1 to 0 for columns to exclude a particular parameter from
the case study run. Similarly, change the "Run/Exclude" flags from 1 to 0 for rows to exclude a
particular cycle from the case study run.

Figure 21. Changing flags to exclude a particular cycle from case study run

9. On the SIMS CI menu, click Case Studies Layout.

10. This option toggles the format of case study grid arrangement from Horizontal to Vertical Cycles and
vice-versa. After this, the cycles are shown in columns and parameters are shown in rows for new
case study grid. The rest of the functionalities are same as described above.

Figure 22. Case study layout change dialog box

11. On the SIMS CI menu, click Suppress Case Studies Warnings to suppress the warnings and click
Publish Case Studies Warnings to publish the warnings.

27
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Figure 23. Suppress Case study warnings

Figure 24. Publish Case study warnings

NOTE: The Case study feature also gives an option to continue the case study iterations even if some
preceding iterations fail during Case Study Run. The relevant messages are displayed in the Messages
tab of the action pane.

Figure 25. Showing warnings/errors on Case study iterations

If you change a case study paramet er outside t he case study, the Run button changes to red color to
inform you that the case study needs to be run one more time to update the out put values.

Figure 26. Run Case study one more time to update results

Multi-simulation Link
This feat ure is used to add multiple simulations to the SIM4ME Portal file.

28
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

To add multiple simulations to the SIM4ME Portal file

1. On the SIMS CI menu, click Add Simulations. The Sim4Me Portal - Choose Simulation dialog box
appears.

Figure 27. SIM4ME Portal - Choose Simulation dialog box

2. Select the required simulations and click Open. The new simulations are added to the Flowsheet
Explorer in the tree node and to the Simulations Added box of the Run Sequencer tab.

Figure 28. Run Sequencer tab

29
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

3. Use the options available in the Run Sequencer tab to make the required changes in the newly
added simulations.
The Run Sequencer tab has the following options:
o Simulations Added box: The added simulations are shown in this box.
o Simulation Run Sequence box: The simulations to be executed using Run button are shown
here.
o Suppress Warnings check box: Warnings that appear while running the simulation are
suppressed if this check box is selected.
o Run Counter field: The defined run sequence completes number of iterations mentioned in this
field.
o Add button: If the Add button is clicked after selecting simulations from the Simulations Added
box, the selected simulations are added to the Run Sequence.
o Remove button: If the Remove button is clicked after selecting simulations from the Simulations
Run Sequence box, the selected simulations are removed from the Run Sequence.
o Move to Top, Move Up, Move Down, and Move to Bottom arrows: These arrows are used to
redefine the order of run sequence.
Drag-drop the required parameters from the newly added simulations onto the worksheet and use
Linked Parameter tab to work with these parameters.
The Link ed Paramet er tab has the following components:
o Unit Class: The Unit class of the parameter dropped on the worksheet is displayed in this
column.
o Unit Name: The Unit Name of the parameter dropped on the worksheet is displayed in this
column.
o Parameter Name: The name of the parameter dropped on the worksheet is displayed in this
column.
o UOM Class: UOM Class of the parameter dropped on worksheet is display in this column.
o UOM Value: UOM V alue of the parameter dropped on worksheet is display in this column.
o Parameter Location: Location of the dropped parameter on worksheet is display in this column.
o Simulation Name: When a parameter is dropped on the worksheet, the complet e path of the
simulation that the parameter belongs to is displayed in this column.
When any of the parameters is double -clicked in any of the rows, its corresponding parameter
reference in the worksheet is highlighted.

Figure 29. Linked Parameters tab

4. Run the simulations after defining the run sequence in the Run Sequencer tab. The following
changes take place:

30
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

o The status of the simulation being run is displayed in the status bar.

Figure 30. Simulation under Run Sequence

o The solution history worksheet gets updated in the same order as defined in the Run Sequence.
o Messages that appear during Run are displayed in the Messages tab.
o If any of the files is not converged, a confirmation message "Do you want to continue?" appears.
Select "Yes" to continue to the next simulation in run sequence or select "No" to stop the Run
activity complet ely.
o The files that converge are indicated in Blue color on the Run Sequence section while the files
that fail are shown in Red color.

Remove Simulations
To remove a simulation from the SIM4ME Portal file 1.
1. On the SIMSCI menu, click Remove Simulations. The Remove/Replace Simulations dialog box
appears.

Figure 31. Remove Simulations dialog box

2. Select the simulation that needs to be removed and click OK. The Flowsheet Explorer tree node
corresponding to the removed simulation disappears, parameters corresponding to the removed
simulation become grayed out in the worksheet, and names of the simulations removed get deleted
from the Run Sequencer tab and Linked Parameter tab.

Assay Handling
This feat ure allows you to work wit h the Assay Characterization options.
Stream 1 in the R1.prz simulation is an Assay Stream. Expand Flowsheet Explorer, go to Stream 1
expansion, and do the following:

31
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

1. See that the Assay Characterization Options folder is added as the last group.

Figure 32. Assay Characterization Option under Stream 1

2. Expand Assay Characterization Options to check if you have access to the Assay Distillation Profile
Inputs:
o Distillation Type [Read]
o Assay Basis [Read] (Liquid volume / Weight)
o Gravity Data [Write]
o Vector of Percent distilled vs. gravity [Write]
o A verage Value for Gravity [Write]
o Distillation Pressure [Write]
o Vector for Percent Distill Vs Temp [Write]
o Molecular Weight [Write]

32
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

o Lightends Data [Write]

Figure 33. Assay Characterization View

3. Drag-drop P ercent Distilled vector or any writeable attribute on the worksheet and change its values.
Pseudo component Deletion" message appears indicating that new set of pseudo components will
be generated.
4. Click Run. Simulation is executed with the updat ed values.

Stream Composition Link

Use Stream Composition Link is used to link a stream composition vector from one simulation to another.
This feat ure provides the ability to handle multiple simulations in a worksheet.
For example, using stream composition link, you can link an out put vector stream from a simulation
earlier in the sequence to an input vector in a simulation later in the sequenc e.
You can use stream composition link by first clicking any particular cell in the worksheet and then clicki ng
Stream Composition Link on the SIMS CI menu.
1. When two vectors like composition vectors from different simulations are c onnected, the composition
of components gets connected via Excel work book formulas. You can modify the formulas to use the
links as per your requirement.
2. Whenever users run the early simulation, the associated stream composition data gets aut omatically
passed to the later simulations by using the provided Excel workbook formulas.
3. This linking is useful mostly in cases where large number of elements is present in the stream vector.

33
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

4. For large vectors, if the linking is performed outside the Stream Composition Link grid, the
performance of the application slows down.
5. As shown in the below figure, the output vector needs to be dropped into the second column of the
stream composition link grid, whereas the input vector needs to be dropped into the forth column. By
default, there is no formula link between the t wo vectors. You can modify the formulas based on y our
requirement.
6. By clicking the DelSL#1 button, you can select either one or both of the vectors.
7. Selecting the "Both Streams" option clears the stream composition link grid from the worksheet.

Figure 34. Clearing the stream composition link grid from the worksheet

Figure 35. Stream Composition Link dialog box

Macro Support
SIM4ME PORTAL provides macro support for Portal Run button, Case Study Run, Editing of Run
Counter Field, and Restore Input Data. These macros help customizing the worksheet as per the user
requirement.

34
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

You can write your own macros to perform different tasks in the SIM4ME Portal file.
Following are the pre-defined macros available in SIM4ME Portal.

Sim4MePortalRunMacro:
Use this macro to run the simulation as per the run sequence under the Run Sequencer tab.
A12345 cell in the active worksheet is used to convey the run status. When SIM4MEPortalRunMacro is
running, this cell has "-1" in it. When Run successfully completes, it changes to "1" and when Run fails, it
changes to "0". Upon completion of the Run actio n, the status remains same until the macro is run again.
Example:
Private Sub Button1_Click () Sim4MePortalRunMacro
End Sub

Sim4MePortalCaseStudyRunMacro "CS#XX":
Use this macro to execute the Run command in the provided Case Study. XX in "CS#XX" indicates that
case study number.
Case study Run button gets disabled when you modify the c ase study parameters from outside the Case
Study. Therefore, generally, it is recommended to run the "Sim4MePort alRunMacro" macro first to
enable the Case Study Run button.
Example:
Private Sub Button2_Click () Sim4MePortalCaseStudyRunMacro "CS#1"
End Sub

Sim4MePortalRunCounterMacro (YY):
Use this macro to edit the Run Counter field of the Run Sequencer tab. YY in this macro indicates the
number of times the added simulation needs to be run. You can provide a number up to 10000 for YY.
Only integer and non-negative digits are allowed.
Example:
Private Sub Button3_Click () Sim4MePortalRunCounterMacro (10)
End Sub

Sim4MePortalRestoreInputDataMacro:
Use this macro to invoke the Restore Input Data command in P RO/II software from within the SIM4ME
Portal.
Example:
Private Sub Button4_Click () Sim4MePortalRestoreInputDataMacro
End Sub

RunSelectedSimulations ("Full Simulation path"):

Use this macro to RUN a particular simulation in Run Sequencer tab. Simulation should be added with its
full path as an example given below. When running this macro, Simulation from the Flowsheet explorer
will be added to the Run Sequencer tab. RUN the simulation.
Example:
Private Sub Button5_Click ()
RunSelectedSimulations ("C:\Users\Documents\Simsci\PROII94\a1.prz") End Sub

Copy/Cut-Paste Linked Parameters

Following are the basic use cases for the Copy/Cut and Paste Link feature:

35
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

 Sim4Me Port al paramet ers can be cut/ copied to all available worksheets in the workbook.
 Sim4Me Port al paramet ers can be cut/ copied by pressing Ctrl + X / Ctrl + C on the keyboard, by
clicking Cut/Copy on the Edit menu, or by right-clicking the required cells and clicking Cut/Copy.
 Cut/Copy- paste of the linked parameters functions same as the usual copy -paste of the MS Excel.
 Trans posing link ed parameters (through paste special) results in a static copy. The copied cont ents
are not live. Warning messages are displayed to inform about this behavior.
When cut/copied parameters are live,
o They are linked to the flowsheet.
o They are properly restored back upon reopening the workbook.
o They are shown in the linked parameters tab.
o Their associated UOM controls, if any, are active.
o They are deleted properly upon performing delete, their associated UOM controls are cleaned
up, and their references are removed from the linked parameters tab.
 Copy -pasting of the case studies is supported. You can copy a case study in its entirety, but if only
some parameters are present in the selection, those parameters cannot be copied to other parts of
the MS Excel workbook. However, if only the cycle inputs and outputs are selected, they can be
copied normally.
 Some validations are performed while linked parameters are copied to the destination range and
following workflows are prevented:
o Overlap with the existing linked parameters.
o Overlap with the existing case studies.
 Copying the whole worksheet content into another worksheet is supported.

Copy Special:
This feature gives you the ease of usability in copying a single element from a vector and applying single
element formula to multiple elements.

Copy Vector Formula:

If you select any value of vector then the whole vector will get selected and you will be able to edit that
particular element. You will also be able to apply any excel formula but not with multiple values in it. This
drawback is solved with the Copy Vector Formula by right-clicking the mouse.
Following are the steps to work with Copy Vector Formula:
 Select any element in writable vector and assign an excel formula.
 Observe that assigned formula is not able to apply to remaining elements by excel dragging action.
 Click on the cell where you have applied excel formula and right click on the mouse.
 Click "Copy Vector Formula", option.

36
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

 You will be able to apply the same formula on multiple cells by dragging it with the mouse.

Figure 36. Copy Vector Formula and Copy Vector Element option by mouse right click menu

Copy Vector Element:

If you select any value of vector then the whole vector will get selected and you will be able to select a
single element in it. This drawback is solved with the Copy Vector Formula by right -clicking the mous e.
Following are the steps to work with Copy Vector Element:
 Select any element in writable vector and right click on the mouse. Click on "Copy Vector Element"
option.
 Paste the element on any cell in the workbook.

37
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Paste Special:
This feat ure provides with the ease of usability in pas ting the text of a scalars and/or vectors and Port al
links.

Figure 37. Paste special: Paste links and Paste Values by mouse right click menu

Paste Links:
This feat ure allows efficient way of pasting the SIM4ME Port al links.
1. Click any scalar or vector element and copy it by right clicking on the mouse or via keyboard.
2. Select any other empty cell and right click on the mouse. Select "Portal Paste" option.
3. This will paste the Port al link in the desired cell.

Note: If the content is not adjusted in the selected area the a warning message is displayed.

Paste Values:
This feat ure allows pasting of SIM4ME Portal link information (scalar or vector element ). It also pastes
the elements that is no longer synchronized with the Simulation databas e.
1. Click any scalar or vector element and copy it by right clicking on the mouse or via keyboard.
2. Select any other empty cell and right click on the mouse. Select "Portal Paste" option
3. This will paste the Port al link in the desired cell.

38
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

Note: If the content is not adjusted in the selected area the a warning message is displayed.

Manual Editing of Links

Use this feat ure to update variables and parameters directly in the Linked Parameters tab or SIM4ME
Portal worksheet instead of dragging and dropping them.
To manually edit a link from the Linked Parameters tab or SIM4ME Portal worksheet
1. Select the variable that need to be edited, right-click the row or cell, and select "SIM4ME-Edit Links."

39
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Figure 38. Linked Parameters Tab

Figure 39. Portal Worksheet

40
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

The following dialog box appears:

Figure 40. SIM4ME-Edit Links

2. Select the Unit Name from the Replace with Uni t Name drop-down list with which the variable needs
to be replaced or edited.
For example: If you have selected "Stream 1.Temperature (User Input)" and want to edit it to see the
values of "2. Temperature," select "2" from the drop-down list and click OK.
3. Temperat ure (User Input) is replaced with 2. Temperature.

Figure 41. SIM4ME-Edit Links – Unit Name

41
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Replace Simulation
Use this feat ure to replace a simulation connected to the Port al file with another one.
To replace existing simulation with another simulation
1. On the SIMSCI menu, click Remove/Replace. The Remove/Replace Simulations dialog box
appears. It has the list of the existing simulations in it.

Figure 42. Replace Simulations

2. Select the simulation that needs to be replaced with another one and click Replace.
3. Select the new simulation from the available P RO/ II simulations that appear in the Open window and
click OK.

Figure 43. Available PRO/II Databases

The Flowsheet Explorer shows the new simulation in the tree node.
If there are any parameters on the worksheet corresponding to the simulation repl aced, they get
activated and the remaining are grayed out until they are edited.

42
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

The name of the replaced simulation gets replaced for the active as well as the inactive parameters on
Linked Parameters tab.

Creation of Audit Log

This feat ure records all the changes done in SIM4ME Portal and maintains chronological sequenc e of
events. For support and analyzing problems, a log of all of the values changed in a simulation via
SIM4ME Portal is recorded in the log.
This log is available even when the SIM4ME Portal file is closed and opened.

Figure 44. Messages Tab

Following are the basics of the Audit Log:

 Messages are labeled as Info, Error, and Warning depending on the user actions performed on the
SIM4ME Portal file. The error and warning messages are displayed during the run-time of the
simulation while Info captures the other us er actions performed on the worksheet.
 Various events are capt ured in the Audit Log Messages tab. For example:
o Changing the parameter value for a scalar or vector.
o Replacing a Simulation from the SIM4ME Port al file.
o Running a Simulation.
o Running a Simulation using Macro.
o Refreshing the SIM4ME Portal worksheet.
 When you close and open the SIM4ME Portal file, the message log retains the messages captured in
the previous session

43
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

 Run Messages (in case of any warnings from the solver) appear in various colors depending on the
success or failure of the run. However, the old messages appear in black color. No other color is
applied to them. This allows the Portal file to open quickly.
 The Messages tab displays the messages in Rich Text format. This window is editable. You can add
notes, delete the unwanted messages, and edit the messages as per the requirement. If the
SIM4ME Portal file is saved with all these changes, these changes ar e retained in the next session.
 You can clear all the messages by clicking the Clear button.
 You can search and find a particular string from the Message s tab using the Find button. It is a
"Word" search and not a letter searc h. For example: Typing "Info" and clicking the Find button will
fetch all the instances of "Info" in the log. It will not highlight the words that have "Info" as a part of
them.
 You can search the next instance of the required word in the message log using the Find Next
button. The search continues until it reaches the end of the message log.
 You can refresh the previous search results and clear the highlighted text using the Refre sh button.

Save As Functionality
Use Save As to save the simulation dat abase with a different name. If changes are made to the newly
saved simulation, the original simulation does not get modified.
Once the simulation is saved with a different name, the new name is displayed in the SIM4M E Portal file.

Figure 45. Save Simulation(s) As Dialog Box

Following are the basics of the Save As feature:

 While closing the portal session, "Save Simulation As" is prompt ed if any changes are made. By
default, the Simulation Name displays the name of the simulation to which Portal file is connected. If
you do not change the name of the simulation and click Save, the changes made in SIM4ME Portal
overwrite the values in the original simulation database. The SIM4ME Portal file remains connected
to original simulation database.
 Simulation Name field is editable. You can type different name for the simulation in this field. If you
provide a different name and click Save, the changes made in SIM4ME Portal get saved in the newly
provided simulation dat abas e. The original simulation database is not modified with these c hanges.
The SIM4ME Portal file gets connected to newly created simulation dat abas e.
 If you click Don’t Save, all the changes are ignored and no modifications happen to the original
simulation. The S IM4ME Portal file remains connected to original simulation database.

44
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

Total Stream Link:

Total Stream Link feature can be accessed by selecting the required cell in the worksheet and clicking
Total Stream Link on the S IMSCI menu.

Figure 46. Empty Grid of Total Stream Link

Total Stream Link grid is almost same as the Stream Composition grid. The difference between the two
grids is indicated by the labels of the delete buttons available in both the grids.
Total Stream Link has the following functions, uses, and limitations:
 Unlike Stream Composition Link grid, in Total Stream Link, you can add only the Name paramet er of
the stream.

Figure 47. Add only "name" parameter into Total Stream Link grid

 You can use this feature across 2 or more simulation databases, provided their UOM slate is same.
 You must drag and drop name parameter first to the Source simulation and then to the Destination
simulation.
 Once the paramet ers are dragged and dropped for both source and destination simulations, a link is
established between these two simulations. It is a one way link – from sourc e to destination.
 Only the parameters stream composition, temperature, pressure, and flow rate are copied from the
source simulation to the destination simulation aut omatically.
 Any stream from the source simulation can be link ed only to the input stream of the destination
simulation.

45
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

 If composition of the destination simulation is different from that of the source simulation, values of
the common components are passed from source to the destination simulation.

Figure 48. Before adding Destination stream’s "name" parameter

Figure 49. After adding Destination stream’s "name" parameter

46
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

 If the user opens Portal through the PRO/II simulation, the values changed in the simulation in
PRO/II GUI do not reflect in Port al immediately. Refresh has to be clicked on t he SimSci Addin menu
for the changes to reflect in Portal. The changed values are first updated in the source simulation and
then because of the total stream link they are updated in the destination simulation.
 To delet e Total Stream Link Grid, click DelSDT#xx. The entire grid is removed and link between
source and destination streams is broken. Therefore, changes in the source stream database do not
affect the destination stream database.
 The main purpose of this feat ure is to provide link between source and destination stream without the
Excel formulas.

Ability to select Individual vector elements

SIM4ME Portal allows the selections of individual elements of a vector such as individual components in
a stream, rather than all components of the stream.

Visibility of the Run button

SIM4ME Portal keeps Run button static so that it is always visible, no matter how much the variable tree
is expanded.

Forward Compatibility of Portal files

SIM4ME Portal supports forward migration of all Portal files. Any portal file, which is prepared using
versions prior to the current version, gets automatically upgraded when opened in current version. A
backup of the original portal file is kept as _v10.xls at the same location that can be opened in the
previous version of SIM4ME Portal.

Support for Microsoft Excel’s R1C1 Reference Style

SIM4ME Portal supports the R1C1 Reference Style.

Update Initial Estimates

Figure 50. Update Initial Estimates Ribbon bar

47
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Use this feature to update the Initial estimates of PRO/II Simulation’s Streams and Unit Operations after
running the SIM4ME Portal flowsheet. The fly-out menu of this icon has the following options:

+ All:
This feat ure is useful to invoke the Update Initial Estimates fo r "All" command in PRO/II Soft ware from
within the S IM4ME Portal, which updates "Recycle Streams", "Columns" and "Controller, MVC and
Optimizer" Units.

+ Recycle Streams:
This feat ure is useful to invoke the Update Initial Estimates for Recycle Streams command in P RO/II
Software from within the SIM4ME Port al.

+ Columns:
This feat ure is useful to invoke the Update Initial Estimates for Columns command in PRO /II Software
from within the SIM4ME Portal.

+ Controller, MVC and Optimizer:

This feat ure is useful to invoke the Update Initial Estimates for "Cont roller, MVC and Optimizer"
command in P RO/II Soft ware from within the S IM4ME Portal, which updates the variables corresponding
to streams, unit operations, and thermodynamic systems that are modified by the Controller, MVC, or
Optimizer to meet their specific ations.

Component Properties
Component Properties in PRO/ II Software is now available within the SIM4ME Portal. Currently this is
implemented for "Fixed" and "Refinery Inspection Properties", available in S IM4ME Portal flowsheet
window as shown in below:

Figure 51. Component Fixed Properties

48
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

Fixed Properties:
These properties do not change with temperat ure such as molecular weight, standard density, boiling
point, critical properties, molec ular constants, heats of formation and a number of miscellaneous
properties.
User has the facility to modify these fixed properties (Properties of library and petroleum components)
from SIM4Me Portal flowsheet interfac e. If the properties are modified in PRO/ II software then us er has
to perform Refresh action in SIM4Me Port al to reflect modified changes in worksheet.

Refinery Inspection Properties:

These properties are used in refinery applications. User has the facility to give t his component data for all
library and petroleum components within S IM4ME Portal application. Data provided in SIM4Me Portal
worksheet can be reflected in Component Refinery Inspection Property Selection Window in PRO/II
software and vice versa.

Stream Property Tables

The stream property table in PRO/ II is now available within S IM4ME Portal. This convenient tool in
PRO/II software became more flexible to view the composition and properties of selected process
flowsheet streams pres ent in the SIM4ME Portal flowsheet.
Stream Property Tables in SIM4ME Portal is limited to show the standard/ default stream property lists
available in PRO/ II software. Table data is automatically updated when S IM4ME Portal Flowsheet is
solved, or if simulation is already solved in PRO/II soft ware then do "Refresh" action in S IM4ME Portal.

Figure 52. Stream Property Tables

49
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Unit Operation Property Tables

The Unit Operation property table in PRO/II is now available within SIM4ME Portal. This convenient tool
in PRO/ II software became more flexible to view t he list of properties selected for Specific Unit Operation
present in the SIM4ME Portal flowsheet.
Unit Property Tables in SIM4ME Portal is limited to show the standard/default Unit pro perty lists for all
Units available in PRO/ II software. Table data is automatically updated when SIM4ME Portal Flowsheet
is solved, or if simulation is already solved in PRO/II software then do " Refresh" action in SIM4ME Portal.

Figure 53. Unit Operation Property Tables

Plots

Figure 54. Plots

PRO/II supports different types of plots for data analysis and reporting. SIM4ME reports have already
had this capability to support these configured plots and will be exported in reports. This feature is now
available in SIM4ME Portal.

50
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

Pre-configured plots in PRO/II are provided in the S IM4ME Portal Flowsheet Explorer and the user can
select/click them to populat e plot data on selected Worksheet Cell as shown in below:

Figure 55. Plots Input Data

Refresh Plots:
Plot data can be updated if product simulation is modified either by P RO/ II or c hanges in SIM4ME Portal.
User has to click "Refresh Plots" icon in SIM4ME Portal Excel Simulation Interfac e Ribbon Bar then plot
data will be updated and the corresponding plot will also be updated. The picture below shows the
"Refresh Plots" icon in SIM4ME Portal Excel Simulation Interface Ribbon Bar.

51
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Getting Started

Figure 56. Refresh Plots Selection

Delete Plots:
To delet e the configured plot data on worksheet, user has to click "Delete Plots" icon in SIM4ME Portal
Excel Simulation Int erface Ribbon Bar, but to delet e the plot itself the us er has to perform
keyboard/Mouse actions. This feat ure is specially provided to the user to clean plot information
completely from excel database. Henc e user won’t face any disturbances in plot dat a deletion.

Figure 57. Delete Plots Selection

52
Getting Started SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

SIM4ME Portal as an OPCUA Client

For the SIM4ME Port al application to work as an OPCUA Client, the setting in the .ini s hould be changed.
The .ini file is located at the following path:
C:\ProgramFiles\CommonFiles\Simsci\SIM4MEPortal211\ User\SIM4MEPortal.ini. The file contains
appropriate OPCUA Access entry det ails that determine the mode of portal operation (Legacy or OP CUA
mode). By default, SIM4ME launches in the Legacy mode.
To launc h SIM4ME Portal as an OP CUA client, change the flag of the entry to "TRUE" in the [OPCUA
ACCESS] field.

Figure 58. SIM4MEPortal.ini

Note: If there are any invalid entries in the .ini file (entries other than TRUE/FALSE), SIM4ME Portal
continues to launch in Legacy mode. All the operations supported in Legacy Portal mode are also
supported in OPCUA Portal mode.

53
 SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

C HAPTER 3
Demo
The various functions and features provided by S IM4ME Portal are explained t hrough the video files. The
following are the details of video files that are available with PRO/II 9.3 release version. The files are
present in the location: (Install Directory)\SimSci\SIM4MEPortal23\ Help.

In This Chapter
StandAloneLaunchDemo.swf: ........................................................................................................ 55
PortalLaunchFrom ProII.swf: ......................................................................................................... 55
PortalUs e.swf: .............................................................................................................................. 55
LinkedP arameters.swf: .................................................................................................................. 55
DisconnectFromP2.swf: ................................................................................................................ 55
AutoRun_UOM.swf: ...................................................................................................................... 56
ExcelSaveThruStdAloneCombine.swf: ........................................................................................... 56
ExcelSaveThruP roII.swf: ............................................................................................................... 56
Office2010 support to Portal2.4.swf: ............................................................................................... 56
Case-Study.swf: ........................................................................................................................... 56
Multi-Sim-Link.swf: ........................................................................................................................ 56
Stream Link.swf: ........................................................................................................................... 56
Assay handling.swf: ...................................................................................................................... 56
Total Stream Link Demo.swf: ......................................................................................................... 56
Macro Support for ease of use.swf: ................................................................................................ 56

StandAloneLaunchDemo.swf:
A video file that demonstrates how to launch SIM4ME Portal from the standalone mode.

PortalLaunchFrom ProII.swf:
A video file that demonstrates how to launch SIM4ME Portal from the Provision mode.

PortalUse.swf:
A video file that introduces various feat ures of S IM4ME Portal suc h as the Flows heet Explorer, drag -drop
functionality, running a simulation, input values and output parameters.

LinkedParameters.swf:
A video file that explores the link ed parameters feature of SIM4ME Portal along with some other features
such as the messages tab, restore input data, and the user mode options.

DisconnectFromP2.swf:
A video file that demonstrates the use of Disconnect option from PRO/II soft wa re, View Parameter
Details functionality, and the re-invoking option of the Flowsheet Explorer.

55
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide Demo

AutoRun_UOM.swf:
A video file that demonstrates the use of Auto-Run option and compares it with the regular Run option. It
also shows how to change and convert the Unit of Measurement of drag-dropped parameters.

ExcelSaveThruStdAloneCombine.swf:
A video file that demonstrates how to launch SIM4ME Portal through standalone mode using MS Excel
2007. It also shows how to convert the Compatibility Mode Excel spreadsheet that opens in MS Excel
2007 and how to re-launch SIM4ME Portal for the complete use of MS Excel 2007 feat ures.

ExcelSaveThruProII.swf:
A video file that demonstrates how to launch SIM4ME Portal through the Provision mode of Microsoft
Excel 2007 installed in the computer. It also shows how to convert the Compatibility Mode Excel
spreadsheet that opens in MS Excel 2007 and how to launch SIM4ME Portal for the complete use of MS
Excel 2007 features.

Office2010 support to Portal2.4.swf:

A video file that demonstrates the full support of MS Office 2010 to .xlsx, .xlsm, and limited support to .xls
file format of S IM4ME Port al 2.4. It also shows that the S IM4ME Portal 2.4 files are, by default, created in
.xlsm format. If you open an existing .xls SIM4ME Portal 2.4 file in any mode, it opens in .xlsm format. It
opens in .xls format only if you double -click and open it.

Case-Study.swf:
A video file that demonstrates the basic oper ations of adding, defining, running, and deleting the case
studies.

Multi-Sim-Link.swf:
A video file that demonstrates the basic operations of selecting multiple simulations, defining the run
sequence, and adding and removing simulations.

Stream Link.swf:
A video file that demonstrates the efficient way of linking streams through stream link grid and the
operations involved there in.

Assay handling.swf:
A video file that explores the various assay stream pa rameters. It demonstrat es modification and viewing
of input parameters and out put parameters under the Assay Characterization node.

Total Stream Link Demo.swf:

A video file that demonstrates how to use Total Stream Link feat ure.

Macro Support for ease of use.swf:

This video file demonstrates implemented Mac ros of S IM4ME Portal and how to use them.

56
 SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

A PPENDIX A
Known Issues
Following is a list of known issues and observations for SIM4ME Portal and its support for MS Office.
 Default format of the SIM4ME Portal file - .xlsm
A new SIM4ME Port al file gets created only in .xlsm format. It is macro-enabled.
When you open an existing .xls file in any mode, by default, it opens in .xlsm format and when you
save it, it gets saved as a copy of the original file at the same location as .xls file.
 Simulation in a S IM4ME Portal file saved with any format other than .xlsm
E ven when you save the .xlsm file in any other format like .xlsx and .xlsm using Save As option, the
new file can be connected to the simulation.
 Number of rows and columns in a .xls file
If you save a .xlsm file in .xls format, the data beyond 65536th row and 256th column gets truncated
because .xls file has only 65536 rows and 256 columns.
 Compatibility Checker dialog box
When you open or save a .xls file, the Compatibility Checker dialog box appears. Always click
Continue in it to avoid exceptions.
 Region and Language settings
Always select "English (USA)" as the format of the Region and Language settings.
To select the format, on the Start menu, click Control Panel, click Regional and Language Settings,
and then in the Format field select English (USA). If any language other than English (USA) is
selected, error occurs after the vector is drag- dropped onto the worksheet.
SIM4ME Portal displays an error message to inform about the error.
 Windows Operating System in any language other than English
If your Windows operating system is in any language other than English, you need to delete the
following registry key to view the Flowsheet Explorer and action pane.
HKEY_LOCAL_MA CHINE\SOFTWARE\Microsoft\InternetExplorer\ActiveXCom
patibility\{5f61f809-422a-4152-91f5-9ec1b935efd7}
 Renaming a worksheet
If you want to rename a worksheet, rename it before performing any action on the worksheet, else
errors may occur. For example, renaming a worksheet that has a case study will give errors when
new paramet ers are added to it.

57
 SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

A PPENDIX B
FAQs
Q1.When does the data modified in SIM4ME Portal reflect in PRO/II simulation?
If you open SIM4ME Portal in standalone mode, the modified data does not reflect in the PRO/ II
simulation immediately. While closing SIM4ME Portal file if you save changes in the simulation, they are
retained and reflect in the simulation when you open it the next time.
If you open SIM4ME Portal through P RO/II, the modified data reflects immediately in the PRO/ II
simulation. E ven if you delete the changes from SIM4ME Portal, they remain in the simulation database.
Therefore, if you do not want the changes to be saved in the PRO/II dat abas e, close the simulation
without saving it.

Note: As PRO/II GUI and SIM4ME Portal are two independent interfaces interac ting with the PRO/II
database, it is recommended that you use only one interface at a time to update or modify data in the
simulation, else there can be errors and loss of data.

Q2.Why "De scription" and "Value" cells cannot have different alignment formats?
As "Description" and "Value" cells for an attribute are clubbed together, they cannot have different
alignment formats once the attribute is dropped on the worksheet. However, a workaround is available.
To achieve the required alignment, you can format the alignment of the cells before dropping attributes
(Scalar or Vector) on them.
Q3.In SIM4ME Portal, what are the limitations of Specifications and Variables specified in PRO/I I
software?
In PRO/II soft ware, a meaningful sentence is displayed for the specification and variable inputs. In
SIM4ME Portal, you can just change the specification values for units like Cont roller, MVC, Column,
Splitter, and Flas h (Product Specification). You cannot change specification type, say a Duty
specification on a Flash to Isothermal specification from the Port al. For a configured Portal file, you can
change the values of the specification and analyze the results.
Q4.Do MS Excel Security Settings need to be verified before starting any task in SIM4ME Portal?
Yes. If the Security Settings are not set properly, some of the features do not work and cause errors.
Q5.Can a stream, a unit operation, or an attribute be searched on Flowsheet Explorer?
Yes. Type the first few letters of the stream, unit operation, or the attribute you are searching in the Filter
search box available on Flowsheet Explorer. The filtered results will be displayed to you in Flowsheet
Explorer.

Note: You need to expand all the nodes of Flowsheet Explorer to see the filtered results.

Q6.When a vector attribute i s dragged and dropped onto an empty cell just below scalar
attribute, SIM4ME Portal displays the following warning: "Existing parameter reference will be
overwritten." Why?
A) The vector attribute requires two cells above the cell where it is dropped. One for vector heading and
the other for vector UOM. If you drop it just one cell below the scalar attribute, SIM4ME Portal displays
this error to prevent overwriting necessary attributes. Drop the vector two cells below the scalar attribute
to avoid this warning.

59
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide FAQs

Q7.In PRO/II software output options, I have selected "Two reports, one in Input UOM, one in
Output UOM". But, I always see the values only in Output Slate in SIM4ME Portal. Why?
At this point, by default, only the Output Slate is supported in S IM4ME Portal.
Q8.How are the performance specifications shown for the Uni t Operations?
For the unit operations like Column, Controller, MVC, and Splitter, the performance specifications are
shown without their long descriptions and UOMs.
Q9.What should I do when a SIM4ME Portal file is emailed to me from another computer?
When a SIM4ME Portal file is emailed to you, do not double-click it. First save it in your computer, open
it in standalone mode, and then direct it to the supporting simulation it has found out through schema
evolution.
If you double-click the emailed file, it will fail to connect to right simulation.

Q10.What Operating System specifications do I need to have in my computer before installing

SIM4ME Portal?
A) SIM4ME Portal is supported on Windows 7, and Windows 8.

Q11.I s there a sample SIM4ME Portal file to get started with SIM4ME Portal? If yes, how to use it?
Yes, there are a few sample files that you can start with. They are saved at the following location:
"…\Documents\Simsci\PROII94\Applib\S4MWork books".
1. Multiple Simulations Link_Chiller Plant - 1 and 2.xlsm
2. Homotopy.xlsm
3. Column Interfac e.xlsm
4. ColumnProfile.xlsm
5. Napt ha Assay_Case Study.xlsm
You can open these files in standalone mode, from PRO/II software, or by double- clicking them directly.

Q12. How to install the patch for SIM4ME Portal?

A) The SIM4ME Portal patch gets automatically installed when you install PRO/ II software patch.

Q13.I have installed the PRO/II software patch but SIM4ME Portal has not been installed in my
computer. Why?
This can happen if SIM4ME Portal was not installed with the earlier version of PRO/ II or if it has been
manually uninstalled after installing PRO/ II.
In such a situation, you need to install SIM4ME Portal by modifying the current installation from
Add/Remove programs in Cont rol Panel.

Q14. How to use PRO/II software with USB security and SIM4ME Portal with FNPTM 1111
security?
Do the following:

60
FAQs SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

1. From Add-Remove programs in Control Panel, modify PRO/II install and select security as
FNP1111. This will create the required ent ry for the IPASSI_LICENSE_FILE environment variable. A
reboot is must if prompted to do so.
2. After reboot, modify PROII. INI to change the security to USB.
If P RO/II. INI is not modified, both PRO/II soft ware and SIM4ME Portal will use FNP1111security.
Q15.When I double-click a .xlsm file, it displays the following error: ‘Office Document
Customization is not available". Why?
This error is displayed if you do not have S IM4ME Portal installed in your system.

Figure 59. Error message "Office Document Customization is not available" is displayed.

Q16.Sometimes SIM4ME Portal is launched in User mode for Developer's license key. Why?
If all developer licenses on the FNP server are used up, SIM4ME Portal launches in user mode. Check
the availability of developer’s licenses if this happens.
Q17. An error message "Error while adding/locating PRO/II software related menu items. Object
reference not set to instance of the object" i s di splayed when I double -click on PORTAL 2. 3
version file with Portal 2.4 version file already open and vice versa.
A) This is a VSTO and MS Excel limitation (design constraint ). If the user wishes to launc h the two
versions of Portal at the same time, the user should first launch an instance of excel work book and drag
and drop the portal file in to that instance of excel workbook.

61
SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide FAQs

Q18.When I Zoom in/Zoom out on the SIM4ME Portal worksheet, text on UOM widget is invi sible.
What should I do?
This is a limitation of Zoom in/ Zoom out feature in SIM4ME Port al Worksheet. To view the text on UOM
widget properly, set 100% zoom on the worksheet.
Q19.What will happen if I drag-drop scalars below vectors for which the length may change?
If you drag-drop scalars below vectors for which the length may change, t heir ar rangement/ format will be
disturbed.
Drop scalars above such vectors to avoid unnecessary changes in their formats.
Q20.What will happen if Microsoft Offi ce is installed after installing SIMSCI application using
Portal module?
Portal module installation requires MS Office as pre-requisite. If you try to install Portal module before
installing MS Office, an error message is displayed and P ortal installation gets cancelled.
Q21. How can we connect SIM4ME Portal to OPCUA Server 1.1 using certificate securi ty?
Set OPCUA to "True" in SIM4MEPortal.ini file and launch the PRO/II soft ware or SIM4ME Portal in "Run
As Administrator" mode.
Q22.What are the restrictions on double -clicking the pre-configured SIM4ME Portal file?
A) If the Portal file is pre-configured wit h an old version of simulation, open it either through P RO/II
software or through the standalone mode of the c urrent version of SIM4ME Portal. User should complete
this procedure while opening the portal file in a machine different from the working machin e.
Q23. How to migrate the SIM4ME Portal files from the old version to the new version of PRO/II?

A) In t he old version of PRO/II, disconnect the simulation and save the SIM4ME Portal file, and then open
the same file with the same simulation in the new version of P RO/II software.
Q24.What do I do when Reports and SIM4ME Portal are not launching because multiple products
are installed?
Using administrator credentials run "PortalRec overy.bat" file available at Portal bin directory.
Q25.In SIM4ME Portal file, can I copy data from a single row or column?
Due to MS Excel limitations, while selecting single row or column that has Portal links in it, the adjoining
cells also get selected. This prevents copying data from single row or column.
Q26. How to open SIM4ME Portal if the location or name of the simulation database is changed?
Open SIM4ME Portal file. It will try to connect to the configured PRO/ II database. If the associated
simulation file does not exist at the original location or it has been renamed or moved, the following error
message appears.

Figure 60. Simulation file missing message is displayed.

Browse for the missing file and reconnect it with the Portal file.

62
FAQs SIM4 ME Portal Excel Simulation Interface 3.3 With PRO/II Process Engineering User Guide

Q27. Can the user format the cells that contain SIM4ME Portal Parameters?
A) No, formatting such cells may disturb the SIM4ME Portal links.
Q28. How to register S4MReportAdapter.tlb file?
A) To register S4MReportAdapter.tlb file, open the Command Prompt, navigate to the Portal bin
directory, and type "regtlibv12.exe S4MReportAdapter.tlb".

Figure 61. Command entered for registering S4MReportAdapter.tlb file

Q29. What do I do if the adapter crashes/popup window comes while opening/creating a

SIM4ME Portal file?
A). When user is unable to launch/Open a SIM4ME Portal file with the following popup message, then
follow below workaround to res olve it:

1. Rename or delete the "VS TOInstaller.exe.Config" file from below location:

o For 32bit MS-Office : C:\Program Files (x86)\Common Files\Microsoft Shared\VS TO\10.0
o For 64bit MS-Office : C:\Program Files \Common Files\Microsoft Shared\VSTO\10.0
2. Install "S4M.ExcelInterface. vsto" manually by double clicking it from SIM4ME Portal install location
based on bitness of MS-Office installed:
o For 32bit MS-Office : C:\Program Files (x86)\Common Files\SimSci\SIM4MEPort al\Bin
o For 64bit MS-Office : C:\Program Files (x86)\Common Files\SimSci\SIM4MEPort al\Bin
Q30. User have any limitations over accessing SIM4ME Portal with OPCUA = "true"?
A) Yes, there is a problem in restoring of links. If user configured a Portal file using OP CUA = "false" then
opening this same file using OPCUA = "true" fails to restore the links but same situation works perfectly
in revers e case.

63