Reporting in HYSYS 1

Reporting in HYSYS

1
© 2003 AspenTech. All Rights Reserved.
EA.1031.31.05
10 Reporting in HYSYS.pdf
2 Reporting in HYSYS

Introduction
Once you have finished a simulation, or during analysis, you may wish
to obtain reports of the data that you have input and that HYSYS has
generated. Reporting data in HYSYS can be achieved in a number of
ways, such as:

• Report manager
• XML
• Excel utilities

Learning Objectives
Once you have finished this module, you will be able to customize
reports in HYSYS using the Report Manager, use XML to create a
summary of the input data from a case, and install and run an Excel
utility to view data from the workbook.

Prerequisites
• Familiarity with the HYSYS interface
• Ability to modify the workbook in HYSYS
• Knowledge of Microsoft Excel.

2
 Reporting in HYSYS 3

Report Manager
The Report Manager in HYSYS allows the user to include data from all
unit operations and streams in a HYSYS case in the order in which the
user desires. This information can then be printed. The information
available through the Report Manager is the same information available
if one prints a unit operation or stream directly from the HYSYS case.

1. Open the solution case from Acid Gas Sweetening with DEA,
Module8.hsc, found in the Solutions folder on the disk with your
training materials.
2. Go to the Tools menu, and select Reports. You are now in the Report
Manager.
3. Click the Create button to create a new report. You are presented
Information about
with a new window that allows you to customize the content of the
operations and streams in
HYSYS used for Printing is report.
contained in objects called
4. Click the Insert Datasheet button to obtain a menu of all the
Datasheets.
information available in the case that can be included in the report:

Figure 1

5. You can filter the lists by object type or by name, using the radio
buttons at the top of the window. In this case, leave the radio button
on Pick a Specific Object by Name.

3
4 Reporting in HYSYS

6. Leave the Flowsheets menu at Case (Main) and choose stream Sour
Gas under the Objects menu. You will notice that all the datablocks
available for stream Sour Gas have been selected by default in the
Available Datablocks window:

Figure 2

7. The only information we want to include in our datasheet is the

stream conditions, so you need to click on the + next to the
Worksheet and deselect all the remaining selections (e.g. properties,
composition and K values). You will also need to deselect
Attachments, Dynamics, User Variables and Notes:

Figure 3

8. Click the Add button to add the Conditions for stream Sour Gas to
the Report. You will notice that the Report now contains the
Conditions for stream Sour Gas.
9. Now, add the Regenerator Design Datablock to the report in the
same way. (HINT: the Flowsheet must be left at Case(Main) in order
to select the Design Datablock for a column.)

4
 Reporting in HYSYS 5

10. In the report manager, you can add information from the Workbook
as well as from Streams and Unit operations. Add the Unit
Operations page from the Main Workbook to the Report.
11. We are now finished adding datasheets to the Report. Close the
Select Datablocks for Datasheet window.
12. On the Report Manager window, you can see that you can change
the order in which the datasheets are presented in the report, and
you can edit the content as well. In addition, you can change the
name of the datasheet. Change the name of this datasheet to Amine
Report.

Figure 4

13. You can also change the format and layout of the report, as well as
the unit set used in the report. Click on the Format/Layout button
and select the Field Unit Set. This unit set will now always be
associated with this report. Close the window.
14. You are now ready to Print or Preview the report. In this case, we will
not print the report to paper, but we will preview it. Click the
Preview button to see what the report would look like when printed.

Note that user specified

values are identified on the
printout with an asterix, ‘*’,
next to them.
Save your case!

5
6 Reporting in HYSYS

HYSYS XML Tool

What is XML? This is the official acronym for the Extensible Markup
Language. XML is a language that uses contextual tags to describe data
so that other applications and tools can correctly read the data and do
interesting things with it. XML is more than just a markup language, as it
has become synonymous with a family of technologies that can be
leveraged to build highly extensible and interoperable software
solutions. An XML Data Schema has been defined so that every object
and piece of data in HYSYS can be represented in an XML format. This
module will only deal with the Reporting uses of XML, but there are
many other uses, including Case Linking, Case Storage options and
Custom Stream Properties. Refer to the HYSYS manuals for more
information on these features.

HYSYS XML Tool

The HYSYS XML tool offers new ways to store, copy, export/import,
browse and print HYSYS case elements, including fluid packages,
streams and unit operations. It also replaces the old
Print…Specsheet…Flowsheet functionality from HYSYS 2.4. This is a
new tool that allows the user to view and printout the case data in a
highly readable format. From the HYSYS XML in the Simulation menu a
whole case or just the user specifications can be browsed, printed or
imported/exported to/from an XML file. There are many options to
define the degree of detail you want stored in this file. If all the data is
saved then it can be imported into another case as an alternative to
creating a template for a set of unit operations. If just the user
specifications are exported to a file then this file can be imported at a
later date in order to restore the case to that defined set of conditions.

6
 Reporting in HYSYS 7

Input Summary
In the HYSYS XML view, an Input summary is generated to report all the
user specifications in the case. This is the same functionality as the
Print…Specsheet…Flowsheet capability in HYSYS 2.4. But in HYSYS 3.2,
more of the specifications are reported producing a more accurate
representation of the case.

1. Continue with the case from the last section.

2. From the Simulation menu, select HYSYS XML
3. Select the Input Summary Format checkbox. The window will
refresh automatically. The Input Summary should appear as shown:

Figure 5

7
8 Reporting in HYSYS

4. This data can now be printed by right-clicking in the background,

and selecting Print from the pop-up menu. Alternatively, you can
select the data you want to copy, and right-click in the background
again, and select copy, then paste the data to another Application,
such as Microsoft Word:

Figure 6

8
 Reporting in HYSYS 9

Excel Tools for Reporting

HYSYS and Excel are compatible using OLE, Object Linking and
Embedding. This feature has been used to create a number of tools to
allow interface between HYSYS and Excel. These tools can be found on
our website at: http://support.aspentech.com under the
Knowledgebase link. The tools that are available include:

• HSR (HYSYS Stream Reporter)

• Wrkdump (Workbook Dump)
• STG (Stream Table Generator).

This module will focus on using the Wrkdump utility.

1. Open the workbook in the HYSYS case. Customize the Material

Streams tab to add the Component Mole Fraction of Water and the
Mass Density to each stream. Ensure that the Material Streams page
is the active page on the workbook.
2. Save the file 75_workbookdump.zip from your Starter disk to the
hard drive of your machine. Any convenient directory is fine. This is
the form that you would receive the utility in if you were to
download it from the website.
3. Unzip the file and extract the files in the zip folder to the hardrive.
Double click on the Excel Spreadsheet (WorkbookDump.xls) to open
it. Click on the Enable Macros button when prompted by Excel.
4. You will see that all the workbooks available in the currently open
case are listed in the window on the Excel spreadsheet. If they are
not, click the Refresh Flowsheet List button.
5. Select the workbook for Case(Main) by clicking once on it, so it is
highlighted in blue.
6. Click the Dump Workbook button. You will see the Material
Streams page of the workbook being recreated in Excel. The user
input values are shown in blue, in addition to having an asterix next
to them.
7. Now, switch to HYSYS and make the Compositions page of the
Workbook the active page. Return to Excel and click the Dump
Workbook button again. Now, the Compositions page is shown in
Excel.

9
10 Reporting in HYSYS

Exercise
You can use the HSR utility that is included on your Starter disk to create
more customized reports from HYSYS in EXCEL. Please be sure that
when you use this in your day-to-day work, that you check our website
at http://support.aspentech.com under the Knowledgebase link.

10