SimSci

SIM4ME Reports 1.0

User Guide

May 2014
All rights reserved. No part of this documentation shall be reproduced, stored in a retrieval system, or
transmitted by any means, electronic, mechanical, photocopying, recording, or otherwise, without the
prior written permission of Invensys Systems, Inc. No copyright or patent liability is assumed with
respect to the use of the information contained herein. Although every precaution has been taken in the
preparation of this documentation, the publisher and the author assume no responsibility for errors or
omissions. Neither is any liability assumed for damages resulting from the use of the information
contained herein.

The information in this documentation is subject to change without notice and does not represent a
commitment on the part of Invensys Systems, Inc. The software described in this documentation is
furnished under a license or nondisclosure agreement. This software may be used or copied only in
accordance with the terms of these agreements.

2014 by Invensys Systems, Inc. All rights reserved.

Invensys Systems, Inc.

26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://www.simsci.com/

For comments or suggestions about the product documentation, send an e-mail message to
ProductDocumentationComments@invensys.com.

All terms mentioned in this documentation that are known to be trademarks or service marks have been
appropriately capitalized. Invensys Systems, Inc. cannot attest to the accuracy of this
information. Use of a term in this documentation should not be regarded as affecting the validity of any
trademark or service mark. Invensys, Invensys logo, SIM4ME, and SimSci are trademarks of Invensys
plc, its subsidiaries and affiliates.
Table of Contents

SIM4ME REPORTS OVERVIEW .......................................................................................................... 4

FLOWSHEET EXPLORER ....................................................................................................................... 5
REPORT PANE ........................................................................................................................................... 7
REPORT MANAGER ................................................................................................................................10
PLOTS ..........................................................................................................................................................11
HOW TO... ...................................................................................................................................................14
FREQUENTLY ASKED QUESTIONS ....................................................................................................19
 SIM4ME Reports - Overview

SIM4ME Reports Overview

SIM4ME Reports application adds the ability to export configurable reports to Excel
worksheet from PRO/II software. Going forward, other products will leverage this
modularized utility for faster deployment and to help to drive consistency across
products.

SIM4ME Reports application has the following benefits:

Allows the user to easily

Configure and generate MS Excel-based reports for the simulation model
Share reports among users by Exporting / Importing them

In summary, users will be able to extract the data of their interest easily and quickly to
increase their productivity from SIMSCI products.

Click the PRO/II Output menu, select Report Manager, and click New to access the
SIM4ME Reports GUI.

The three components of a SIM4ME Reports GUI are Flowsheet Explorer, Report Pane,
and Report Manager.

SIM4ME REPORTS 4
 Flowsheet Explorer

Flowsheet Explorer
The Flowsheet Explorer displays a tree view of the unit operations, streams and plots
available in the flowsheet. The unit operations, streams and plots 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
point on the Report Manager Pane. The user also has the option to switch off the
Flowsheet Explorer pane.

The illustration shown below indicates a sample Flowsheet Explorer Tree that has been
expanded down to the parameter level.

SIM4ME REPORTS 5
 Flowsheet Explorer

To expand an entry at any level of the hierarchy, click the expansion control icon to the
left of that level. The entries in the next lower level are displayed. To collapse an
expanded branch, click the same control icon again.

The user can view the values associated with the parameter or parameter group of the unit
operation, stream or plot with the drag and drop support. Just drag the parameter or
parameter group or the unit operation, stream or a plot of interest from the Flowsheet
Explorer and drop them in the report pane to include in the report.

The Flowsheet Explorer will also display non-flowsheet objects such as plots, which the
user can drag and drop to the report pane and include them in the output report. PRO/II
software supports different types of plots for data analysis and reporting. SIM4ME
Reports application will also support these configured plots and will be exported in
reports.

The user can search for a unit operation, stream or a plot in the flowsheet explorer. For
example, if you want to search for a stream called CRUDE01, expand Streams list in
the flowsheet explorer. Type the first few letters of the string CRU. The first
occurrence of the match is highlighted.

SIM4ME REPORTS 6
 Report Pane

Report Pane
The Report Pane can be used to do the following:

Display data of the selected unit operation or stream for individual parameter.
(parameter name, value, description, unit of measure)
Drag and drop parameter groups or individual parameters from the flowsheet
explorer.
View and Generate excel report of the parameters and their groups displayed
in the report pane.
Change the unit of measure of parameter points.
Toggle the report view to Summary, Detailed or Custom.
Disable parameter groups to be excluded from the excel report.

The illustration shown below indicates a sample Report Pane that has been expanded
down to the parameter level.

SIM4ME REPORTS 7
 Report Pane

The Report Pane is displayed by clicking the File menu and selecting New. Now, click
Summary, Detailed or Custom to display the corresponding report pane.

If you select Custom, drag and drop parameter groups or parameters from the flowsheet
explorer.

The user may start with a Summary or Detailed view and then modify the report pane
using the right-click options.

A summary of the column names and their description are listed below:

Name Name of the unit operation or stream as defined in the flowsheet.

Class The class to which the unit operation, stream or plot belongs. For example,
Name HX and Column are class names. The unit operation, say HX1001 belongs
to the HX class.

SIM4ME REPORTS 8
 Report Pane

View A drop-down list of the available report views. The options available are
Summary, Detailed, Custom, and the views currently defined in PRO/II
software under the Options menu for both unit operation and streams. The
default option is Summary.

Section Allows the user the to select the section name of the excel report where the
attributes are to be reported. Each section is a separate excel worksheet
within the report. By default, there is only one section in the report
MAIN. The user can double-click on the section cell of the Report pane
and type the name of the section.

Disable Check the option to skip the unit operation or stream from being reported in
the final excel output report.

Apply To Click this button to apply the same view to all or selected unit operations or
streams. For example, a user created view, MyValveView, could be
applied to the selected valves or all the valves.

Parameter Name of the parameter.

Value Value of the parameter. The user has the option of controlling the precision
display of the attribute. Right-click and select Format cell. Change the
number of decimal places that you would like to display.

UOM The unit of measure of the parameter value. You can change the UOM to
SI, Metric or English.

SIM4ME REPORTS 9
 Report Manager

Report Manager
The Report Manager menu bar is displayed at the top of the Main Window below the title
bar and above the toolbar. It contains all the commands that perform various functions as
shown below:

Create new reports and Open a saved report.

Delete an active report.
View and Generate excel report of the parameters and their groups displayed
in the report pane.
Display error messages.

A few of the menu bar functions are available as buttons on the toolbar. For example,
View Report, Generate Report, S4M Report Messages.

The Report Manager functions are also available in the Output menu options of the
PRO/II GUI. Click the Output menu, and select Report Manager.

SIM4ME REPORTS 10
 Plots

Plots
PRO/II software supports different types of plots for data analysis and reporting.
SIM4ME Reports application will also support these configured plots and will be
exported in reports. The pre-configured plots are displayed in the Flowsheet Explorer and
the user can drag and drop them to the report pane and include them in the output report.

The Plots are classified into:

Heating Curve
Phase Envelope
Distillation Column
Case Study
Depressuring Unit
Assay plots

Heating Curve A Heating Curve configured on the PRO/II flowsheet will be

supported by SIM4ME Reports application. A Heating Curve can be
configured for a stream or a unit operation. A Heating Curve has six types of
plots:

1. Pressure-Enthalpy Vs Temperature
2. Liquid Fraction and Latent Heat Vs Temperature
3. Vapor and Liquid Thermal Conductivity Vs Temperature
4. Vapor and Liquid Density Vs Temperature
5. Vapor and Liquid Viscosity Vs Temperature
6. Liquid Surface Tension Vs Temperature

Phase Envelope Phase envelope plots can be configured for streams. Phase
envelope plot contains data of temperature Vs pressure for given mixture of
components.
Note The phase envelope plots are distinguished based on the label. User
must specify the label while configuring phase envelope plots in PRO/II
software.

Distillation Column Plots Following plots are available for distillation column:

1. Tray Vs Temperature
2. Tray Vs Liquid and Vapor Rates
3. Tray Vs Surface Tension
4. Tray Vs Density
5. Tray Vs Viscosity
6. Tray Vs Thermal Conductivity

SIM4ME REPORTS 11
 Plots

Note: For surface tension, viscosity and thermal conductivity, the relevant
transport property methods need to be selected in PRO/II software. If not, these
data will be blank.
Users could cross check the data with PRO/II software by clicking Tools menu
and selecting Spreadsheet/Distillation.

Case Study Plots A case study can be configured in PRO/II software by

clicking the Input menu and selecting Casestudy Data. The parameters and results
can be specified during configuration.
A case study plot can be configured in PRO/II software through Output--
>Casestudy-->Plots. X Axis and Y Axis data is given in the plot configuration.
SIM4ME Reports application will generate the case study plots based on the
configuration data in PRO/II software.

Depressuring Unit Plots A Depressurizing unit supports the following plots:

1. Pressure Profile Pressure Vs Time

2. Temperature Profile Content temperature and Wall Temperature Vs
Time
3. Vent Gas Composition Profile Vent Gas composition Vs Time
4. Cumulative Moles discharge Profile Cumulative Mole Discharge from
the depressuring unit Vs Time
5. Cumulative Mass discharge Profile Cumulative Mass Discharge from
the depressuring unit Vs Time
6. Mass Rate Profile Depressurization Mass Rate Vs Time
7. Mole Rate Profile Depressurization Mole Rate Vs Time
8. Volume Rate Profile Depressurization Volume Rate Vs Time
9. Volume Inventory Volume Inventory Vs Time (Represents the volume
of the contents inside the depressuring unit with time)
10. Mass Inventory Mass Inventory Vs Time (Represents the amount of
contents inside the depressuring unit (weight basis) with time)
11. Mole Inventory Mole Inventory Vs Time (Represents the amount of
contents inside the depressuring unit (mole basis) with time).

Assay Plots The following assay plots are available in PRO/II software:

1. Input D2887 Data

2. Fitted TBP Curve
3. Component Cuts
4. Include Lightends.

The corresponding plots implemented in SIM4ME Reports application are the

following:

1. Input Data Input Data plot, Percent Distill Vs Temperature

2. Fitted TBP Curve - Percent Distill Vs Temperature

SIM4ME REPORTS 12
 Plots

3. Component Cut - Percent Distill Vs Temperature

4. Fitted TBP Curve (including Light Ends) - Percent Distill Vs
Temperature. The plot includes Light Ends also.
5. Component Cut (including Light Ends) - Percent Distill Vs Temperature.
The plot includes Light Ends also.

SIM4ME REPORTS 13
 How To...

HOW TO...
How to customize the PRO/II toolbar to display the Report Manager options?

1. Click the View menu on the PRO/II GUI, and click Toolbar. The Toolbar
Customization dialog box is displayed.

2. Select the report item to be customized from the Available Items list box. The
available report items are New Report, Select Active Report, Open Active Report,
Delete Active Report, View Excel Report, Generate Excel Report, Add to Active
Report.

3. Click Add. The selected item from the available item list is added to the selected
item list.

How to create a new report?

1. Click the New Report button on the toolbar or select and click New from the
Report Manager options in the Output menu.

2. The SIM4ME Reports GUI is displayed and the Report pane is initially blank.

3. Drag and drop unit operations or streams or attribute group(s) / attribute(s) into
the table area.

4. Rename the report using the right-click option or from the File menu.

5. Click Save.

Tip: The user may start with a Summary or Detailed Report and then modify it by
adding, deleting, or reordering the attributes of the unit operation or stream by using
the right-click option.

How to exclude a unit operation or stream from the excel report?

1. Check the disable option for the particular unit operation(s) or stream(s) to be
excluded from the excel report.

2. Click Generate Excel Report.

Note: The unit operation or stream excluded from the excel worksheet output will be
retained in the report pane.

SIM4ME REPORTS 14
 How To...

How to search for a stream or a unit operation in the flowsheet explorer?

1. In the flowsheet explorer, expand the unit operation or streams list. Type the first
few alphabets of the unit operation name or stream name. The first occurrence of
the match is highlighted.

How to export a report?

1. Select and click a report from the Export Report slide out list available in the
Report Manager options in the Output menu.

2. The report is exported and saved as an xml file in the specified location. The
report will have the names of the units and streams, attributes and their values.

How to import a report?

1. Select and click a report from the Select Active Report available in the Report
Manager options in the Output menu. The user can also select an active report
from the drop-down list available on the toolbar.

2. Click Import. During import, the user will be prompted to override the existing
report with the imported one. Save that and import into a new one.

How to change the view of a unit operation or stream?

1. In the Report pane, select the cell View of a unit op or stream. You will see a
drop-down list containing pre-defined views based on PRO/II Stream Properties
table. You can select any view from the drop-down list.

How to quickly change the views of all streams or a few flashes?

1. Select the stream for which you want to change the view.

2. Click Apply To button. A list of all the streams in the simulation are displayed.

3. Select All or only a few from the list.

4. Click OK and wait for a few seconds. The views of all the selected items will
change to the new view.

Tip: If you want to drag and drop a few flashes with a particular view say My
View, then drag and drop one flash unit and change the view to My View from the

SIM4ME REPORTS 15
 How To...

View drop-down menu. Click Apply To for the selected flashes. The selected
flashes will be automatically dragged and dropped.

How to add selective attributes to a particular section?

1. Drag and drop an attribute. By default, the section name is Main.

2. Double-click on Main and rename the section name to My Main.

3. Drag and drop all the attributes onto this section as shown below:

4. The attributes get added to the section My Main now.

How to delete or re-order rows in the Report Pane?

All Excel worksheet supported options like cut/copy/paste, multiple-control clicks, shift-
Up arrow, and shift-Dn arrow are allowed.

1. To delete rows, use the right-click menu option or use the Delete button on the
keyboard.

2. To re-order rows, select the row and use the right-click options to Move Up, Move
Down, Move to Top, Move to Bottom.

How to change the setting preferences in Report Pane, Flowsheet Explorer, or

Report Manager?

The SIM4ME Reports menu bar has a Settings menu where the settings of the Report
Pane, Flowsheet Explorer or UOM slate can be set.

The options for Report Pane settings are shown in the figure below:

SIM4ME REPORTS 16
 How To...

The options for S4M Report Message settings are shown in the figure below:

The options for S4M Report Message settings are shown in the figure below:

SIM4ME REPORTS 17
 How To...

The options for UOM Slate are SI, Metric and English. The user can select any of the
UOM slates.

SIM4ME REPORTS 18
 Frequently Asked Questions

Frequently Asked Questions

Q1) Sometimes it seems that the last item selected (during multiple selects) is
missing after a "drag and drop" operation. Why?
A) The observed behavior is a limitation in the current implementation. The
"CONTROL" or "SHIFT" button needs to be pressed until the drag-drop operation is
completed. Also, two consecutive clicks unchecks the last item. The user after
performing a multiple drag and drop operation, should check if all the desired objects are
highlighted in the Flowsheet Explorer. If not highlighted, it will be copied with the rest of
the selected objects. This happens most often when the user selects the last object once
and then again clicks it to "drag and drop". The second click unchecks the last item. The
user is advised to select the last item and directly drag them all without clicking again.

Q2) Can I search for a stream say "CRUDE" or a Unit Operation say
"PREHEATER" on the Flowsheet Explorer?
A) Yes. In this case, go to streams and expand it. Now select "Streams" and type in the
first few letters of the string you want to search say "CRU". You will be navigated to the
first match. The same applies for unit operations. Note that you need to expand "Streams"
or "UnitOps" to use the search functionality.

Q3) Why is it that I get "MISSING" values even when I clear the check-box "Show
Missing Values" in Report Manager settings?
A) The option "Excel Comparison Report" may be "ON". In this option, the software just
looks at the entire list of attributes and ignores the "Show Missing Values" check-box.

Q4) I have selected "Excel Comparison Report" but Columns are not being
compared. Why?
A) Only unit operations that lend themselves to comparison are allowed in the "compare
mode". For example, streams, flashes, heat exchangers, pumps, expanders, compressors
have unchanging formats and can be compared side by side. Unit operations such as
columns, reactors, controllers etc cannot be compared because of variations in report
formats for individual units.

Q5) Energy UOMs in the PRO/II output report are reported as "MM Btu/hr" but
the prefix "MM" is not used in SIM4ME Reports application. Why?
A) The prefixes such as MM for millions when English units are selected, are not
available. These prefixes may be included at a later date.

Q6) I dragged and dropped an attribute to a specific row but it is added to the
bottom. Why?
A) Location specific attribute addition is not supported in this version of SIM4ME
Reports application. It gets appended to the bottom of the Report pane only.

Q7) When I add/delete any attribute to a summary report, why does the name of the
report change automatically?

SIM4ME REPORTS 19
 Frequently Asked Questions

A) "Summary" and "Detailed" reports are standard, pre-configured reports. Once you
start to customize these reports, the saved name is changed to avoid overwriting these
reports.

For example: If the user starts with a "Summary report" and then adds a unit operation,
it is renamed as "Summary ReportAdd1" to indicate that the report is based on the
"Summary Report" with added objects.

Q8) Sometimes I do not see "Transport properties" or "Refinery Inspection

Properties" in my Excel reports. Why?
A) "Transport properties" and "Refinery properties" must be selected in the PRO/II
thermodynamics set for these values to be available in SIM4ME Reports application.

Q9) Sometimes I do not see Tray Hydraulics data when I drag and drop them onto
the reports. Why?
A) There are three options under "Perform Tray sizing Calculations". The first option "At
output time" is the default. In this case, PRO/II software updates these data only when
the text output report is generated. If you generate SIM4ME Reports application before
generating the text report, these data will not be available. If you generate the text report
first, these data will become available and will be included in SIM4ME Reports
application. You could also select either the second or third options under "Perform Tray
sizing Calculations" which will cause tray hydraulic calculations to be executed during
the run operation, in which case the data will be available to SIM4ME Reports
application before creating a text report.

Q10) In PRO/II output options, I have selected the option "Two reports, one in
Input UOM, one in Output UOM". However, I do not see both the UOM slates in
my SIM4ME Reports application. Why?
A) At present, only the PRO/II output slate is supported in SIM4ME Reports application.
You can manually select the desired UOM slate under Report Settings/Current UOM
Slate.

Q11) Why do not my reports save the UOM information? I opened "Summary"
report and changed the UOM slate to "SI". I closed and re-opened the flowsheet to
see that the UOM slate has changed to PRO/II Output slate. Why?
A) The UOM slate settings provide an option to temporarily over-ride the UOM slate for
the current reports only. These are temporary UOM overrides and they are not stored at
this point. Once the report is closed and re-opened, the PRO/II Output UOM slate is
assumed.

Q12) I tried to drag and drop individual elements of vectors. I see that the entire
vector is dragged and dropped. Why?
A) Drag and drop of individual elements is not yet supported in SIM4ME Reports
application. Also, any operations like "Move Up, Move Down, Delete, Format Cell" etc.
do not work on individual elements of vectors. These will addressed in future versions.

SIM4ME REPORTS 20
 Frequently Asked Questions

Q13) How do I generate formatted reports, e.g., TEMA reports, using SIM4ME
Reports application?
A) Formatted reports are not yet supported. They will be implemented in future versions
of SIM4ME Reports application.

Q14) The Excel report generated using SIM4ME Reports application looks different
from Tools->Spreadsheet. Why? Which one should I use?
A) The SIM4ME Reports application is a new reporting tool that gives the user the
flexibility of configuring the units and parameters that show up in the report whereas the
Spreadsheet option generates pre-defined reports. User can use either one based on his
needs.

Q15) What happens when I import a report in a different simulation?

A) You could import a report exported from say a1.prz to a2.prz. In this case, the
units with same name and class in both files will be displayed. All the views in the
imported file will be available for the simulation as local views.

Q16) If I have a custom view with the same name as global view which one takes
precedence?
A) The custom (local) view will take the precedence.

SIM4ME REPORTS 21
Invensys Systems, Inc.
26561 Rancho Parkway South
Lake Forest, CA 92630
United States of America
http://iom.invensys.com

Global Customer Support

Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424 or contact your
local Invensys Representative.
Email: Invensys.iom.support@Schneider-electric.com
Website: http://support.ips.invensys.com