Release 4.

0 Installation Guide
Featuring Excel Add-in Installation Guide

This document contains complete installation details for installation of PipelineStudio , including the
PipelineStudio Excel Add-in.

Contents
Contents .................................................................................................................................................. 1
System Specifications ............................................................................................................................. 2
Upgrading From PipelineStudio 2.6 and Above ...................................................................................... 2
Upgrading From Earlier Than PipelineStudio 2.6 ................................................................................... 2
Energy Solutions Integration ................................................................................................................... 2
Installing PipelineStudio .......................................................................................................................... 2

Installation Menu ................................................................................................................................. 3

Installation Pre-requisites ................................................................................................................... 4
Installing PipelineStudio .................................................................................................................... 10
PipelineStudio Installation Known Issues ......................................................................................... 22

Uninstalling PipelineStudio.................................................................................................................... 25
Cleaning up ........................................................................................................................................... 27
Problems with installing on top of an older release .............................................................................. 27
Installing the PipelineStudio Excel Add-in............................................................................................. 28

Supported Versions of Microsoft Office ............................................................................................ 28

Installation: Macro Security ............................................................................................................... 28
Excel 2010 Security Settings ............................................................................................................ 28
Excel 2013 Security Settings ............................................................................................................ 31
Installation of PipelineStudio Excel Add-in ....................................................................................... 34
Post Installation of PipelineStudio Excel Add-in ............................................................................... 39
Post Installation of PipelineStudio Excel Add-in (Contd) .................................................................. 43
Installing the PipelineStudio Excel toolbar manually ........................................................................ 44
PipelineStudio Excel Add-in Installation Known Issues .................................................................... 44

Creating a Test Excel Report via PipelineStudio .................................................................................. 45

Uninstalling the PipelineStudio Excel Add-in ........................................................................................ 48
Uninstalling the PipelineStudio Excel Add-in (Contd) ........................................................................... 51
Chinese, Spanish and Portuguese Help Files ...................................................................................... 52
Notation ................................................................................................................................................. 53

1
System Specifications

Please refer to the PipelineStudio release notes for the latest system specifications.

Upgrading From PipelineStudio 2.6 and Above

In order to migrate as many settings from a previous installation of PipelineStudio as possible you
should install the latest release of PipelineStudio without uninstalling the previous release. For
example if you have 2.8 installed and have added items to the equipment libraries, the easiest way of
making the library data available in the new release is to allow the latest installer to backup any data
that can be preserved. The installer will then make sure that this data is reinstated once the new
release is installed.

Upgrading From Earlier Than PipelineStudio 2.6

If you are upgrading from a release of PipelineStudio earlier than PipelineStudio 2.6 you will need to
manually uninstall the previous release before installing this release of PipelineStudio. This can be
done by opening the control panel and selecting the Add / Remove Programs option. From there you
should uninstall the Excel Reporting Add-in for PipelineStudio (if installed) and from there uninstall
PipelineStudio.

Energy Solutions Integration

PipelineStudio is integrated with Energy Solutions suite of products, including PipelineManager and it
is recommended that a customer that has more than one Energy Solutions product contact the
Customer Care team at Energy Solutions for integration compatibility at [email protected]
for further information prior to installing PipelineStudio.

Installing PipelineStudio
To install PipelineStudio a user account with Administrative privileges is required and it is also

recommended that you save any open documents and close all your Microsoft Windows applications
including any instances of PipelineStudio prior to starting installing PipelineStudio.

If you have the PipelineStudio media then insert it into in the appropriate drive:

If "Autoplay" is turned off on the drive where the PipelineStudio media is located the installation menu
will have to be launched manually, usually via clicking [Start] and choosing Run and entering the
following command:

<Media Drive >:\Launch.exe

where <Media Drive > is the single letter assigned to the drive where the PipelineStudio media is
located. Alternatively the installation menu may be launched by opening the media drive and the
double-clicking "Launch.exe".

If you downloaded the PipelineStudio self-extracting archive from the Energy-Solutions Web Site
then you should double click the self-extracting archive, choose an appropriate directory to extract the
files to and enter the password. The password is available from technical support for customers on
active product support and you should choose to extract the installation to a folder on a drive with
sufficient free disk space (>300MB). Once the archive has decompressed the installation menu may
be launched by opening the folder the archive was extracted to and the double-clicking "Launch.exe".

2
Installation Menu

The installation menu presents a

number of options which may be
selected with a mouse click:

Read Me: Opens the Read Me First

document, containing essential
information regarding the installation
of PipelineStudio.

PipelineStudio: Starts the

PipelineStudio software installation.

Installation Guide: Opens this

document.

Release Notes: Opens the release

notes document, describing new and
updated features, issues resolved
and any known issues for this
version of PipelineStudio.

Excel Add-in (part 1): Starts the

Excel Add-in part 1 software
installation.

Excel Add-in (part 2): Starts the

Excel Add-in part 2 software
installation (only required for 64-bit
versions of Microsoft Excel).

Add-in Documentation: Opens the

User Documentation for the Excel
Add-in.

ODBC Documentation: Opens the

User Documentation for the ODBC
Interface.

Exit: Exits the installation menu.

3
Installation Pre-requisites

PipelineStudio uses a number of

components that can be shared by
numerous Windows applications.

The installer will check for the

presence of any components and list
any that need to be installed.

Requirements which you may see in

this list are as follows:

Sentinel System Driver (this is

actually optional, if you are not using
a hardware license key / bitlock then
this option is not required and you
may choose not to install this item)

Microsoft XML (MSXML 6.0) - this

comes pre-installed on Windows 7
and Windows Server 2008.

Microsoft .NET Framework 4.0

Please note that having only the
Microsoft .NET Framework 4.0 Client
Profile installed is not enough. The
installation needs to include
Microsoft .NET Framework 4.0
Extended. If you do not see the
Microsoft .NET Framework 4.0 entry
in the display seen on the right, then
you have at least Microsoft .NET
Framework 4.0 client profile
installed. It is advisable to verify that
you also have the extended profile
for Microsoft .NET Framework 4.0
also installed. Note: also that
Microsoft .NET Framework version
4.5 and 4.6 (Windows 10
Professional systems) are also
supported by PipelineStudio.

Sentinel System Drivers

If you are using a hardware key /

bitlock that plugs into the USB port
then you will need to accept the
installation of the Sentinel System
Drivers.

4
Simply follow the installation wizard
for this component until the
installation is complete. Accept the
license agreement and choose
complete install.

5
When you click the install button a
progress display appears and
several command Windows displays
might occur prior to installation is
complete.

6
Microsoft .NET Framework 4.0

If you do not have any Microsoft

.NET Framework 4.0 installed on
your machine the display to the right
appears.

After you have ticked the I have

read and accept the license terms
box, press the install button to start
installing Microsoft .NET Framework
4.0

7
Follow the installation wizard for this
component until the installation is
complete.

8
Microsoft XML (MSXML 6.0)

You may have to accept to install the

Microsoft XML component.

Follow the installation wizard for this

component until the installation is
complete.

9
Installing PipelineStudio

Step 1

Welcome. The installer will guide

you through the choices to make in
order to install PipelineStudio.

Choose "PipelineStudio" to begin the

installation.

The PipelineStudio installer will

initialize, click "Cancel" to exit if you
do not want to install PipelineStudio.

Now go to Step 2.

Step 2

The InstallShield Wizard initializes.

Click "Cancel" to exit if you do not
want to install PipelineStudio,
otherwise click "Next".

Now go to Step 3.

10
Step 3

License Agreement.

The user is advised that by clicking

"I Accept" and installing this software
they are accepting the terms and
conditions implicit in the End User
License Agreement ("EULA"), which
is a legal agreement between you
and Energy Solutions International
Inc.

Do not install this software or click "I

Accept" until you have read and
accepted all the terms of the EULA
and wish to become the licensee of
the software. If you do not wish to
accept the terms of the EULA click "I
Decline" and return the software
media and hardware-locking device
to Energy Solutions for a full refund.

Please read the license agreement

carefully, and then choose your
action.

Now go to Step 4.

Step 4

Registration Code

You require a personal registration

code to continue the installation of
PipelineStudio. There are now two
options available:

1. If you have already received a

registration code from the Technical
Support team at Energy Solutions for
the release of PipelineStudio that
you are installing please enter it in
the code display and then press next
then go to Step 7.

2. If you do not have a registration

code for the current release of
PipelineStudio that you are
attempting to install go to Step 5.

11
Step 5

To request a registration code

please fill in your name, company
and bitlock information and select
the Get Code button to email the
request directly to the Technical
Support team. Now go to Step 6.

If you do not have a default email on

the machine that you are installing
PipelineStudio on, please send us a
fax or email with your name,
company and bitlock number
accordingly. Now go to Step 8.

Step 6

If you have a default email installed

on the machine that you are
attempting to install PipelineStudio
on then after you have clicked the
Get Code button an email similar to
the one seen here will come up.

Please press send to send the

request to the Technical Support
team at Energy Solutions.

Now go to Step 7.

12
Step 7

After sometime (usually within 24

hours) you will receive a personal
registration code associated to the
release of PipelineStudio that you
are attempting to install.

Please Paste the newly received

personal registration code into the
code display as shown and press
Next

If the registration code was accepted

and no error message appears
please go to Step 9.

If an error message does appear,

please go to Step 8.

Step 8

If the registration code was not

accepted then the following
message appears and you would
need to make sure that you pasted
the received registration code
correctly into the code display and
try Step 7 above again, otherwise
you would need to go back to Step
5.

Step 9

If you have a previous release of

PipelineStudio installed, any settings
that can be migrated to the new
release will be moved, and then the
old products will be un-installed.

Older releases of PipelineStudio

must be removed for the installation
to proceed. Choosing Next will un-
install the products listed.

Once the old products have been

un-installed, installation of
PipelineStudio will proceed.

If you do not have a previous

release of PipelineStudio installed
and you do not see this screen then
go to step 16.

If you do see this screen (called

13
Found old versions) then you do
have a previous release of
PipelineStudio and the
PipelineStudio Excel Add-in
installed.

Choose "Next" to start un-installing

the old release and go to step 11.

Select "Back" to re-visit the last

screen.

Select "Cancel" to abort the

installation leaving the old
applications intact.

Step 10

Uninstall PipelineStudio

The uninstall wizard is automatically

launched and you are prompted as
to whether or not you would like to
uninstall the release of
PipelineStudio that you currently
have installed.

Click OK to continue uninstalling

the release that you have been
using.

Click Cancel to cancel the

installation of the latest release of
PipelineStudio

If you did have PipelineStudio Excel

Add-in installed then go to Step 11.

If you only had PipelineStudio

installed then go to Step 15.

14
Step 11

The installation shield has detected

that you have had PipelineStudio
Excel Add-in installed as well and it
will be uninstalled upon your
request.

Click Next to uninstall it or Cancel to

discontinue the current installation of
the latest release of PipelineStudio.

Step 12

Uninstall PipelineStudio Excel Add-in

The uninstall wizard is automatically

launched and you are prompted as
to whether or not you would like to
uninstall the PipelineStudio Excel
Add-in that you currently have
installed.

Click OK to continue uninstalling

the release that you have been
using.

Click Cancel to cancel the

installation of the latest release of
PipelineStudio

Now go to Step 13.

15
Step 13

Excel Add-in has partly completed

uninstalling.

Click Finish to start removing

components installed in Microsoft
Excel

Now go to Step 14.

Step 14

To complete the uninstallation of the

Excel Add-in, Microsoft Excel must
start in order to unload the Add-in. A
prompt to tell you that Microsoft
Excel will be launched will be
displayed. Click "OK".

Microsoft Excel will launch.

The InstallShield Wizard for the

installed release of PipelineStudio
may appear and partially obscure
Microsoft Excel. If so, then just click
anywhere in Microsoft Excel to bring
the Microsoft Excel window to the
front.

Click the Enable Content button if it

appears

16
A further prompt will be presented to
inform you that the Add-in and
templates will be removed. Click
"Yes".

Once the templates have been

uninstalled a prompt will be
displayed to tell you the templates
have been uninstalled. Click "OK".

A further prompt will be displayed to

inform you that the PipelineStudio
Excel Add-in uninstallation has been
successful. Click "OK".

Once the Add-in has been

uninstalled a prompt will be
displayed to tell you the Add-in has
been uninstalled. Click "OK".

Close Microsoft Excel

Now go to Step 15.

17
Step 15

The release of PipelineStudio that

you had installed on your machine is
now completely uninstalled from
your machine

Click Finish to continue.

Now go to Step 16.

Step 16

From this dialogue choose the

location where the PipelineStudio
application is to be installed.

It is recommended that the software

is installed to the default location as
seen in the screenshot in the next
column.

Choose "Next" to advance and

"Back" to re-visit the last screen.

Now go to step 17.

18
Step 17

From this dialogue choose whether

to create a desktop shortcut to
PipelineStudio.

Choose "Next" to advance and

"Back" to re-visit the last screen.

Now go to step 18.

Step 18

This dialogue summarises the

installation options.

Take a brief moment to check the

selections. You will notice that both
the Gas and Liquid Simulators are to
be installed. This is OK as you will
only be able to run the simulators
that you are licensed for.

Use the "Back" button to make any

necessary changes.

Choose "Next" to commit the

PipelineStudio installation.

Now go to step 19.

19
Step 19

A progress bar details the

progression of the PipelineStudio
installation.

Now go to step 21.

Step 20

On completion of the installation a

request to restart the computer may
be made. If it is not, go to step 21.

If "Yes, I want to restart my

computer now" is selected, the
computer will be shut down and will
be restarted automatically after
clicking on the Finish button.

If "No, I will restart my computer

later" is selected the necessary
updates will be completed next time
the computer is shut down and
restarted.
It is recommended to restart now to
use PipelineStudio.

Once the computer has

restarted and a user log on
completed, a progress bar may be
seen briefly as the installer updates.

Now go to step 21.

20
Step 21

On completion of the installation a

dialogue may be shown informing
that the installation has completed.
Select "Finish" to complete the
installation.

The PipelineStudio main installation

menu will be displayed at the end of
the installation. From here you can
choose to install the Excel Add-in or
to Exit. If you want to install the
Excel Add-in follow the instructions
under Installing the PipelineStudio
Excel Add-in, otherwise click "Exit".

Step 22

On exiting the installation (with or

without installing the Excel Add-in)
and upon opening PipelineStudio for
the first time the following dialog may
appear if you have an existing My
Simulations folder. Pressing Yes
in this dialog would allow
PipelineStudio to replace the existing
demo configurations installed from a
previous release and allow you to
use the latest and greatest demo
configurations available. Pressing
No would not install the latest demo
configurations to your My
Simulations folder.

Upon running PipelineStudio the first

time a number of template files are
also made available.

21
PipelineStudio Installation Known Issues

TZ Environment Variable

Using the TZ environment variable may affect your simulation if the variable differs from the Windows
Time Zone. When PipelineStudio is started it will inform you if there is a potential problem.

Security Key Incompatible with Driver for hard bitlock device

The symptom of this problem is that your PC fails to see the parallel port or USB Sentinel SuperPro
security key. When you try to launch PipelineStudio with the parallel port or USB bitlock attached and
your machine disconnected from the network you will see the following error message:

If you try to launch PipelineStudio with the parallel port or USB bitlock attached and your machine
connected to the network you will see the following error message followed by the above message:

This message and similar messages for GASandLIQUID and Liquid are generated because the
security key driver does not recognize the security key.

This problem only occurs when using versions 7 or higher of the security key driver in conjunction with
very old versions of the parallel port Sentinel SuperPro security keys with the batch number
9521L2202. The batch number can be found on the side of the bitlock. The current version of
PipelineStudio ships with version 7.5.0 of the security key driver and therefore if you see this problem
with a standalone bitlock then you should contact [email protected] for assistance.

22
Network license manager connection

If you connect to a network license manager over the LAN for licensing purposes the following dialog
might be shown if the registry settings are not correct.

Press OK to continue. Note that similar dialogs might appear for GASandLIQUID and Liquid, before
the following dialog appears:

Press Cancel to continue. This is caused by the registry settings for the license server not being set
correctly at the following location:

HKEY_CURRENT_USER -> Software -> Energy Solutions International -> PipelineStudio -> 4.0 ->
Licensing -> License Servers

23
Correctly configured license server settings can be seen in the display below, where the network
license manager is installed at IP address: 172.21.1.27.

If entries do not exist at this location they can easily be created by right clicking and selecting New ->
String Value. Please note that the keys seen in the display above are case sensitive and need to be
created as seen above.

24
Uninstalling PipelineStudio
Please note that if the PipelineStudio Excel Add-in has been installed, it must be uninstalled
before you uninstall PipelineStudio.

Follow the procedure below to uninstall PipelineStudio. Once uninstalled, any files that may contain
user-entered data that you may like to retain for future use with PipelineStudio will be placed in the
folder: My Documents\My Simulations\PipelineStudio [version number] Backup
Data

PipelineStudio can be uninstalled

using Add/Remove Programs or
Uninstall a program in Control
Panel.

Note: If the Excel Add-in is installed

it should be uninstalled first, please
refer to the instructions in the
Uninstalling the PipelineStudio Excel
Add-in section.

Select the PipelineStudio

application and select Uninstall.

You will be prompted to confirm your

selection to uninstall PipelineStudio.
Click "OK" to confirm the uninstall of
PipelineStudio.

If you have other PipelineStudio

applications installed the following
display will appear. Click Next to
continue uninstalling the
PipelineStudio application or select
Cancel to interrupt the uninstall.

25
After pressing Next in the above
screen you will be prompted to
confirm that you would completely
remove the PipelineStudio
associated applications, as indicated
in the display on the right with
regards to PipelineStudio Chinese
Language Pack. Select Yes, to
continue the uninstall.

After the uninstall is complete the

following display appears, click
Finish. If you have several
PipelineStudio related applications
(language packs etc.) then the three
rows above would need to be
repeated for each PipelineStudio
related application.

A progress bar shows details during

the uninstall process.

If PipelineStudio is removed from the

computer, the application and all
components associated with the
original installation are removed.
This includes:

PipelineStudio

Registry keys

26
When the uninstall process has
completed, choose "Finish".

Cleaning up
After uninstalling or upgrading any residual files that are left at the old installation path can be safely
removed (default: C:\Program Files\Energy Solutions\PipelineStudio*).

Release 3.6.1

The Following folders are left behind and can be removed:

C:\Program Files\Energy Solutions\PipelineStudio 3.61\PLStudio

Problems with installing on top of an older release

Please note that if you are encountering problems with installing this release of PipelineStudio due to
the existence of an older release of PipelineStudio and PipelineStudio Excel Add-in, the easiest way
to overcome this is by manually uninstalling firstly the PipelineStudio Excel Add-in and then
PipelineStudio, prior to installing this newer release of PipelineStudio.

27
Installing the PipelineStudio Excel Add-in
Supported Versions of Microsoft Office

The PipelineStudio Excel Add-in is supported with the following versions of Microsoft Office:

Microsoft Excel 2010

Microsoft Excel 2013

You can check your version of Microsoft Excel by choosing About Microsoft Excel from the Help
menu in Excel.

Installation: Macro Security

Since the PipelineStudio Add-in relies on Excel macros, there are some things that must be checked
with security settings in Excel. These need to be checked before running the installation program
(because the installation program itself runs macros to install the Add-in).

Excel 2010 Security Settings

The following settings need to be in place so that the PipelineStudio Excel Add-in and Macros
embedded in the Excel documents can function to generate PipelineStudio reports.

As part of the installation, an Excel document is opened that contains a Macro which installs the Add-
in into the correct location. These settings need to be updated before the Excel Add-in is installed.

Open Microsoft Excel 2010 and

select the File menu (top left).

Choose the [Options] button at the

bottom of the menu.

28
From the Customize Ribbon section
make sure the Developer Ribbon is
ticked.

You should now have a developer

ribbon. Choose Macro Security
from the developer Ribbon. The
Trust Center display should appear.

In the Trust Center window select

the Macro Settings page.

From the Macro Settings select the

option Disable all macros except
digitally signed macros.

From the Developer Macro Settings

tick the option to Trust access to the
VBA project object model.

29
In the Trust Center window select
the Trusted Locations page.

Add the PipelineStudio Excel Report

Templates as a trusted location.

Note: if the folder: C:\Program

Files (x86)\Energy
Solutions\PipelineStudio
4.x\PLStudio\Reporting\Repo
rt Templates does not get
created by the PipelineStudio
installer, it may be necessary to
manually create the below folders in
order to add this location as a
trusted location in Excel:

C:\Program Files
(x86)\Energy
Solutions\PipelineStudio
4.x\PLStudio\Reporting

C:\Program Files
(x86)\Energy
Solutions\PipelineStudio
4.x\PLStudio\Reporting\Repo
rt Templates

Select [OK] to close the two

windows.

You can now close Microsoft Excel

and continue to the Installation of
PipelineStudio Excel Add-in section.

30
Excel 2013 Security Settings

The following settings need to be in place so that the PipelineStudio Excel Add-in and Macros
embedded in the Excel documents can function to generate PipelineStudio reports.

As part of the installation, an Excel document is opened that contains a Macro which installs the Add-
in into the correct location. These settings need to be updated before the Excel Add-in is installed.

Open Microsoft Excel 2013, open a

Blank workbook, and select the File
menu (top left).

Choose the [Options] menu / button

at the bottom of the menu.

From the Customize Ribbon section

make sure the Developer Ribbon is
ticked.

31
You should now have a developer
ribbon. Choose Macro Security
from the developer Ribbon. The
Trust Center display should appear.

In the Trust Center window select

the Macro Settings page.

From the Macro Settings select the

option Disable all macros except
digitally signed macros.

From the Developer Macro Settings

tick the option to Trust access to the
VBA project object model.

In the Trust Center window select

the Trusted Locations page.

Add the PipelineStudio Excel Report

Templates as a trusted location

Note: if the folder: C:\Program

Files (x86)\Energy
Solutions\PipelineStudio
4.x\PLStudio\Reporting\Repo
rt Templates does not get
created by the PipelineStudio
installer, it may be necessary to
manually create the below folders in
order to add this location as a
trusted location in Excel:

C:\Program Files
(x86)\Energy
Solutions\PipelineStudio

32
4.x\PLStudio\Reporting

C:\Program Files
(x86)\Energy
Solutions\PipelineStudio
4.x\PLStudio\Reporting\Repo
rt Templates

Select [OK] to close the two

windows.

You can now close Microsoft Excel

and continue to the Installation of
PipelineStudio Excel Add-in section.

33
Installation of PipelineStudio Excel Add-in

After you have performed all the security and macro configurations requested in the sections above,
you can now install the PipelineStudio Excel Add-in.

Install the PipelineStudio Excel Add-

in using the supplied installation.

Please ensure that PipelineStudio is

not running during the installation of
the PipelineStudio Excel Add-in.

Note: that if you have Microsoft

Excel 32-bit, you only need to run
the Excel Add-in (part 1). If you have
Microsoft Excel 64-bit, you will need
to run the Excel Add-in (part 1),
followed by the Excel Add-In (part 2).

You can determine if you have the

32-bit or 64-bit version of Microsoft
Excel by checking the following:

Microsoft Excel 2010:

Open Microsoft Excel 2010, select

the File menu (top left), and choose
the [Help] menu / button at the
bottom of the menu.

The About Microsoft Excel section

displays the version you have.

34
Microsoft Excel 2013:

Open Microsoft Excel 2013, open a

Blank workbook, and select the File
menu (top left).

Choose the [Account] menu / button

at the bottom of the menu, and click
the About Excel button.

The About Microsoft Excel dialog

displays the version you have.

35
Pre-requisites:

If this is the first time you have

installed the PipelineStudio Excel
Add-in on your computer, you may
be prompted to install the Microsoft
Add-ins Fix. If so, click Install to
install this component.

If the Microsoft .NET Framework is

not installed or if an earlier version
than that required by the
PipelineStudio Excel Add-in is
installed, a prompt to install the
Microsoft .NET Framework will be
shown. This is needed in order for
the PipelineStudio Excel Add-in to
function. Installation of the Microsoft
.NET Framework may take some
time.

The PipelineStudio Excel Add-in

installer will initialise, click "Cancel"
to exit if you do not want to install the
PipelineStudio Excel Add-in.

You may see a Program

Compatibility Assistant message
box. If you get this message box,
choose the option to confirm that
This program installed correctly.

36
To continue the PipelineStudio Excel
Add-in installation click Next,
otherwise click Cancel

Enter your customer information and

select the appropriate installation
option. Click Next, otherwise click
Cancel

37
Review the installation summary and
click Next to continue, otherwise
click Cancel

A progress bar will display the

installation progress. Cancel may
be selected to terminate the
installation at this point if required

On completion select Finish to

complete the installation and
initialise the PipelineStudio Excel
Add-in.

38
Post Installation of PipelineStudio Excel Add-in

At the end of the installation of the PipelineStudio Excel Add-in (i.e. when the Finish button is
pressed) the version of Microsoft Excel that is on your computer will automatically appear and the
following post installation needs to occur within Microsoft Excel.

Tip: You can exit out of the PipelineStudio installation box prior to attempting this.

At the end of the installation (if the

installation is successful), the
PLStudio\Reporting\Install.
xls workbook is automatically
opened using Microsoft Excel.

Select OK to continue.

Enable macros if prompted by

Microsoft Excel.

Microsoft Excel 2010

Click [Enable Content} when

Microsoft Excel 2010 starts after the
InstallShield part of the installation
has finished in Microsoft Excel 2010.

39
Microsoft Excel 2013

Click [Enable Content} when

Microsoft Excel 2013 starts after the
InstallShield part of the installation
has finished in Microsoft Excel 2013.

If prompted to install any additional

components of Microsoft Office, do
so at this point.

Select Yes to continue.

When the following message is

displayed, (the exact file path will
vary), select OK to continue.

On completion of this stage of the

installation select "OK".

If a message that the PipelineStudio Excel toolbar was not successfully installed is displayed, follow
the instructions "Installing the PipelineStudio Excel toolbar manually" below.

If the Install.xls workbook does not close automatically, close it. Close Microsoft Excel.

40
Microsoft Excel 64-bit only (not required for Microsoft Excel 32-bit):

Proceed with running the Excel Add-

in (part 2) from the PipelineStudio
Installation home screen.

To continue the PipelineStudio Excel

Add-in installation click Next,
otherwise click Cancel.

41
Review the installation options and
click Next to continue, otherwise
click Cancel.

Review the installation summary and

click Next to continue, otherwise
click Cancel.

42
A progress bar will display the
installation progress. Cancel may
be selected to terminate the
installation at this point if required.

On completion select Close to

complete the installation.

Post Installation of PipelineStudio Excel Add-in (Contd)

The PipelineStudio Installation home screen will still be displayed. You should press the Exit button
to exit. The installation is now complete.

Note for Users who installed under an account with administrative privileges and / or have changed
accounts:

43
If you have installed the Excel Add-in using another Windows Login that has administration privileges
(for example because you do not have sufficient user privileges to install software) then once you
have logged back in under your normal user account you should perform the following steps:

Start Microsoft Excel and make sure the PipelineStudio Add-in is active via checking the
PipelineStudio item in the list of available add-ins from the Tools | Add-Ins. dialog;

Make the PipelineStudio Toolbar available by following the instructions in section 'Installing
the PipelineStudio Excel toolbar manually' below.

If in the future you re-install your copy of Microsoft Excel, you may have to re-install the
PipelineStudio add-in afterwards.

Note:

Before you can use the Excel Reporting you will need to run a clean (un-run) PipelineStudio
configuration. The quickest way to do this is to select one of the supplied templates presented to you
from the PipelineStudio File | New menu, save it with a different name to your simulation folder and
then perform a transient run. As well as generating the data necessary for the report, the reporting
templates will get copied to the correct location on your hard disk drive.

Installing the PipelineStudio Excel toolbar manually

If a message that the PipelineStudio Excel toolbar was not successfully installed was displayed or if
you cannot see the PipelineStudio toolbar when you start up Microsoft Excel; start Microsoft Excel
and choose the Toolbars tab on the Tools | Customize dialog. Make sure that the PipelineStudio
entry in the list is checked. This ensures that the PipelineStudio toolbar is visible, if the PipelineStudio
toolbar is not in the Toolbars list, please press Attach so that you can select from a new dialog. The
toolbar should look like that shown below:

PipelineStudio Excel Add-in Installation Known Issues

If the 'DisableMSI' system policy is set to either 1 or 2 then the PipelineStudio Excel Add-in will be
prevented from installing with the error "The installation is forbidden by system policy. Contact your
system administrator. [Install Media]\ExcelAdd-in\PipelineStudio Excel Add-in.msi".

44
Creating a Test Excel Report via PipelineStudio
A quick test can be done with a demo configuration.

Open PipelineStudio.

Note: As it is the first time since the

PipelineStudio Excel Add-in was
installed you may see a progress bar
while some maintenance steps are
performed for the current user.

Open demo configurations from your

My Simulations folder in either
Gas\Demos or Liquid\Demos

Run a Steady State or Transient

simulation.

Once the simulation has finished,

select the menu Report |
Create/Run

In the Reports window choose the

[Load] button and select the
Summary.report file.

45
A full set of summary report
definitions will be selected.

Select the [Run] button to start

generating the report.

Microsoft Excel will be launched.

Click the Enable Content button if it
appears.

A Report Progress window will

appear after a few seconds.

Once all the reports have been

generated the progress window will
disappear or list any issues that
were encountered.

46
A new Microsoft Excel workbook will
be created. There may be many
worksheets depending on how many
reports definitions were used. One
report definition can also produce
more than one worksheet.

The timestep shown highlighted in

Red in the capture opposite allows
you to choose a different time to
display.

Device names in summary reports

may be selected, which will produce
a more detailed report for that device
in a new worksheet. Use the
worksheet tabs at the bottom of the
window to see all the other reports
that were produced.

47
Uninstalling the PipelineStudio Excel Add-in

Close Microsoft Excel if it is running.

The PipelineStudio Excel Add-in can

be uninstalled using Add/Remove
Programs or Uninstall a program
in Control Panel.

Note: for Microsoft Excel 64-bit, both

PipelineStudio Excel Add-in
application components will need to
be removed.

Select the first PLSExcelAddIn

application and select Uninstall.

Confirm that you would like to

completely remove the application
and all of its features by pressing
OK

The PipelineStudio Excel Add-in

support files will be removed from
your system.

A status window will now appear

showing the progress of the uninstall
procedure.

Once this is complete choose

Finish.

48
Microsoft Excel will now be launched
to remove the PipelineStudio
settings.

Click the Enable Content button if it

appears.

Follow the prompts; choose Yes to

remove all components.

Choose OK to continue.

49
Choose OK to continue.

Choose OK to continue.

Microsoft Excel 64-bit only (not required for Microsoft Excel 32-bit):

Proceed with uninstalling the Excel

Add-in (part 2) using Add/Remove
Programs or Uninstall a program
in Control Panel. Select the
remaining PLSExcelAddIn
application and select Uninstall.

Click Yes to uninstall the

PipelineStudio Excel Add-in.

50
Uninstalling the PipelineStudio Excel Add-in (Contd)
Note: If the PipelineStudio Excel toolbar is not deleted by this procedure, it may be removed from
Microsoft Excel manually as follows:

1. Starting Microsoft Excel

2. Choose Tools | Customize. and then choose the Toolbars tab

3. Select PipelineStudio from the list of toolbars

Click on the Delete button and enter OK when prompted

51
Chinese, Spanish and Portuguese Help Files
Within the 'Extras' folder of the installation we have included Chinese, Spanish and Portuguese
language packs.

To install a language pack, launch the Setup.exe from the corresponding folder and follow the
prompts:

[Media]\Extras\Languages\Chinese\Setup.exe

[Media]\Extras\Languages\Spanish\Setup.exe

[Media]\Extras\Languages\Portuguese\Setup.exe

Once installed you can switch the language by opening or creating a configuration in PipelineStudio,
then choose the menu Tools | Options. On the General tab select a language from the drop down
list:

Once the language is selected and applied, you will have to close down and re-launch PipelineStudio
for the Online Help to appear in the chosen language.

Activate the online help either via the menu Help | Help Topics or by pressing F1 to get help on the
currently active window.

Language packs will be uninstalled when PipelineStudio is uninstalled.

52
Notation
PipelineStudio, TNet and Energy Solutions are registered trademarks of Energy Solutions International.

Windows, Excel and SQL Server are registered trademarks of Microsoft Corporation.

Intel is a registered trademark of Intel Corporation.

SentinelRMS* 1989-2008 SafeNet, Inc. All rights reserved

SafeNet, Sentinel, SentinelLM, and Sentinel RMS are either trademarks or registered trademarks of SafeNet, Inc.

All other product names referenced herein are trademarks or registered trademarks of their respective
manufacturers.

53