You are on page 1of 63

Aspen Petroleum Supply Chain

Installation Guide
Version Number: V9
May 2016
Copyright (c) 1985 - 2015 by Aspen Technology, Inc. All rights reserved.

Aspen PIMS, Aspen Petroleum Scheduler, Aspen Orion, Aspen Refinery Multi-Blend Optimizer, Aspen Multi-Blend
Optimizer, Aspen PIMS Enterprise Edition, Aspen Report Writer, Aspen SLM, Aspen SLM tools, Aspen PIMS
Advanced Optimization, Aspen Olefins Scheduler, Aspen Olefins Regression Calculator, Aspen Excel Integration
Utility, aspenONE, and the aspen leaf logo are trademarks or registered trademarks of Aspen Technology, Inc.,
Bedford, MA.

All other brand and product names are trademarks or registered trademarks of their respective companies.

This document is intended as a guide to using AspenTech's software. This documentation contains AspenTech
proprietary and confidential information and may not be disclosed, used, or copied without the prior consent of
AspenTech or as set forth in the applicable license agreement. Users are solely responsible for the proper use of
the software and the application of the results obtained.

Although AspenTech has tested the software and reviewed the documentation, the sole warranty for the software
may be found in the applicable license agreement between AspenTech and the user. ASPENTECH MAKES NO
WARRANTY OR REPRESENTATION, EITHER EXPRESSED OR IMPLIED, WITH RESPECT TO THIS DOCUMENTATION,
ITS QUALITY, PERFORMANCE, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

Aspen Technology, Inc.


20 Crosby Drive
Bedford, MA 01730
USA
Phone: (1) (718) 221-6400
Toll Free: (1) (888) 996-7100
URL: http://www.aspentech.com
Contents
1 Introduction .........................................................................................................1
Related Documentation .....................................................................................1
Help .....................................................................................................1
Manuals ................................................................................................1
Technical Support ............................................................................................2

2 Overview ..............................................................................................................3
aspenONE Overview .........................................................................................3
Licensing.........................................................................................................4
Packaging .......................................................................................................4
Organization ....................................................................................................5
aspenONE Licensing Model ................................................................................6
Accessing aspenONE Documentation ..................................................................7
Aspen Petroleum Supply Chain Overview.............................................................8
System Requirements.......................................................................................9
Aspen PSC Hardware Requirements – Desktop...........................................9
Aspen PSC Hardware Requirements – Server ........................................... 10
Aspen PSC Desktop Software Requirements ............................................ 11
Aspen PSC Server Software Requirements............................................... 14
aspenONE PIMS Platinum Software Requirements .................................... 16
User requirements.......................................................................................... 18
Integration Services ............................................................................. 18
Platinum Specific.................................................................................. 18
Service User Accounts .................................................................................... 18

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time................19
Overview....................................................................................................... 19
Before You Install........................................................................................... 19
Installing the Aspen Petroleum Supply Chain Suite for the First Time .................... 20
Installation Welcome Page..................................................................... 21
License Terms and Conditions ................................................................ 23
Choose the aspenONE products you want to install and the location ........... 24
Prerequisite Validation .......................................................................... 26
Specify licensing & security ................................................................... 27
Verify your installation .......................................................................... 27
aspenONE installation progress .............................................................. 28
Aspen Petroleum Supply Chain Suite Post Installation Notes ................................ 29
Using 64 bit version of MS Office (Office 365) with Aspen Petroleum Scheduler
and Aspen Multi-Blend Optimizer Access Databases .................................. 29
Aspen PIMS Post Installation Configuration and Procedures ....................... 30
aspenONE PIMS Platinum Post Installation Configuration and Procedures .... 33
Aspen Olefins Scheduler – Creating the AOS Database.............................. 37

Contents i
Petroleum Scheduler, Olefins Scheduler and Multi-Blend Optimizer Post
Installation Settings ............................................................................. 40
Petroleum Scheduler and Multi-Blend Optimizer Configuration ................... 40
Olefins Scheduler User Configuration ...................................................... 41
Aspen Report Writer, Aspen Refinery Report Wizard and Aspen Excel
Integration Utilities Post-Installation Configuration ................................... 41
Verify Installation........................................................................................... 42

4 Upgrading or Repairing Aspen Petroleum Supply Chain Suite Products..............43


Overview....................................................................................................... 43
Localized Versions Of PSC Products ........................................................ 44
Upgrading Aspen Petroleum Scheduler, Aspen Multi-Blend Optimizer or Aspen
Olefins Scheduler to the Latest Version ................................................... 45
Upgrading aspenONE PIMS Platinum....................................................... 45

5 Removing the Aspen Petroleum Supply Chain Suite ...........................................47


Overview....................................................................................................... 47
Before You Remove ........................................................................................ 47
Removing the Aspen Petroleum Supply Chain Suite of Products ........................... 47

6 Schedule Manager Configuration ........................................................................49


Running Schedule Manager for the First Time .................................................... 50
Changing the Administrative User Name and Password ....................................... 51
Jobs and Workflows ........................................................................................ 51
Creating a Job for aspenONE Simulation Services ..................................... 52
Adding and Configuring Additional Tasks for aspenONE Simulation Services 53
Creating a Job for aspenONE Process Explorer and aspenONE PIMS Platinum54
Configuring Additional Tasks for aspenONE PIMS Platinum and Process
Explorer .............................................................................................. 55
Modifying a Schedule ...................................................................................... 57
Deleting a Job................................................................................................ 57
Viewing Logs for Troubleshooting ..................................................................... 57
Changing the Logging Levels ........................................................................... 58
Checking the Server Statistics ......................................................................... 58

7 Troubleshooting .................................................................................................59
Common Problems ......................................................................................... 59
Error Messages .............................................................................................. 59

ii Contents
1 Introduction

This document addresses the suite-level installation of the Aspen Petroleum


Supply Chain suite of products. Each product-specific, suite-level, or industry-
solution installation guide contains critical information about computer
requirements, product dependencies, and post-installation configuration
procedures.

Note: For information about the installation of an Aspen industry solution


that includes the Aspen Petroleum Supply Chain suite of products, see the
aspenONE Deployment Guide.

Related Documentation
In addition to this document, a number of other documents and files are
provided to help users learn and use the Aspen Petroleum Supply Chain suite
of products. The documentation set consists of the following:

Help
Aspen PIMS Help
aspenONE PIMS Platinum Help
Aspen Petroleum Scheduler Help
Aspen Olefins Scheduler Help
Aspen Refinery Multi-Blend Optimizer Help
Aspen Report Writer Help

Manuals
Aspen Petroleum Supply Chain Planner Release Notes
Aspen PIMS Integration – User Guide
Aspen Petroleum Scheduler Integration – User Guide
Aspen Multi-Blend Optimizer Integration – User Guide
Aspen Olefins Scheduler Integration – User Guide

1 Introduction 1
Technical Support
AspenTech customers with a valid license and software maintenance
agreement can register to access the online AspenTech Support Center at:
http://support.aspentech.com
This Web support site allows you to:
 Access current product documentation
 Search for tech tips, solutions and frequently asked questions (FAQs)
 Search for and download application examples
 Search for and download service packs and product updates
 Submit and track technical issues
 Send suggestions
 Report product defects
 Review lists of known deficiencies and defects
 Registered users can also subscribe to our Technical Support e-Bulletins.
These e-Bulletins are used to alert users to important technical support
information such as:
 Technical advisories
 Product updates and releases
Customer support is also available by phone, fax, and email. The most up-to-
date contact information is available at the AspenTech Support Center at
https://support.aspentech.com.

Note: To access product specific documentation directly from a Petroleum


Supply Chain application, you must have register with the AspenTech Support
Center and obtain a user ID and password.

2 1 Introduction
2 Overview

This chapter provides an overview of the aspenONE installation process,


including the installation requirements and installation process. This chapter
contains the following:
 aspenONE Overview
 Aspen Petroleum Supply Chain Overview
 System Requirements

aspenONE Overview
aspenONE® is AspenTech’s comprehensive set of software solutions and
services. aspenONE products enable process industry companies to optimize
their engineering, manufacturing and supply chain operations. As a result,
AspenTech customers are better able to increase capacity, improve margins,
reduce costs, become more energy efficient, and achieve operational
excellence goals.
aspenONE solutions include the industry’s leading:
 Simulation and design products in the aspenONE Engineering suite
 Plant operations products in the aspenONE Manufacturing suite
 Supply chain management products in the aspenONE Supply Chain suite.
The token-based aspenONE Licensing Model gives customers the flexibility to
access and use any aspenONE product at precisely the time it is needed. This
is especially critical in the dynamic market conditions of the process industries
‒ whether during down economies or in high-growth periods. This enables
customers to lower their risk while maximizing the return on their software
investment.aspenONE is the comprehensive set of software solutions and
professional services provided by AspenTech; these are designed to help
process companies achieve their operational excellence objectives.

2 Overview 3
Licensing
To manage your product entitlement, you will receive one of the following
separately:
 A license file if you are using the SLM Server to manage the products to
which you are entitled.
 A pre-configured dongle containing your customer license file if you are
operating using a dongle to manage the products to which you are
entitled.

Note: An invoice noting which products you are licensed for is also sent
separately from the software shipment.

Packaging
Included in your package from AspenTech, you will find the following items
that you will need prior to installation:
 A packing slip listing the version of the media that you have received.
 One or more of the following USB drives:
o aspenONE Token USB – Contains the media that supports the
aspenONE Licensing Model token-based system. This all-inclusive
token-based licensing model was introduced in July 2009. Under this
licensing model, customers are entitled to install and run all of
AspenTech’s products as long as they have purchased sufficient
tokens. To install software purchased under this commercial
agreement, use this USB. Software installed from the aspenONE Token
USB requires run-time token-based license keys.
o aspenONE Standard USB – Contains the media that supports perpetual
and pre-aspenONE Licensing Model token-based systems. If you have
perpetual license agreements or token-based license agreements by
product (pre-July 2009), you should use the USB labeled Standard.
Software installed from the aspenONE Standard USB requires older
license keys that have been in use since the aspenONE 2004 release.
o Informatica – If you have an MSC perpetual license purchased prior to
2011 and are entitled to Informatica upgrades, you will receive both
the Standard USB and a standalone Informatica USB containing a new
version of Informatica PowerCenter.

Note: The Getting Started brochure and the product Release Notes and
Installation Guides are included under the Aspen Engineering and Aspen
Manufacturing and Supply Chain folders on the USB drive in your package.

4 2 Overview
Organization
aspenONE delivers AspenTech’s Process Modeling, Exchanger Design and
Rating, Economic Evaluation, Energy and Flare Analysis, Process Development
and Operations Support, Plant Operations, Process Control and Supply Chain
Management products and documentation on a single USB.
The contents of the USBs are organized in the following folders:
 Aspen Engineering (32-bit and 64-bit) – includes all Aspen Engineering
products, Aspen PIMS and Aspen Administration components (Aspen SLM,
Aspen SLM tools, ALC Auto Upload Tool).
 Aspen Manufacturing and Supply Chain – includes all Aspen
Manufacturing products (Information Management, Batch, Production
Management, and Advanced Process Control), Aspen Petroleum Supply
Chain products, aspenONE Supply Chain Management products, and
aspenONE Infrastructure products as well as Aspen Administration
components (Aspen SLM, Aspen Security, Aspen SLM tools, aspenONE
Diagnostics, ALC Auto Upload Tool).
Installation Guides and Release Notes are included in the Documentation sub-
folders under each Aspen Engineering and Aspen Manufacturing and Supply
Chain.

Notes:
 SLM Client Tools 8.6 and SLM Server 8.6 are delivered with aspenONE V9.
aspenONE V9 and higher products require SLM Client and Server 8.6 or
higher. Aspen recommends that both the Software License Manager (SLM)
License Server and the SLM Client are at the same version. For example,
when you deploy aspenONE V9 software on client machines, the SLM
server should be from the V9 release. When migrating to a new version of
aspenONE, the SLM Server should always be upgraded first, followed by
the SLM clients. This is done to avoid any potential incompatibility issues.
During this transition period, it is possible to have clients at a lower
version than the SLM Server.
 Some products previously available on CD-ROM or DVD are not included
on the aspenONE USBs. If you do not find a product, please contact
AspenTech Support at https://support.aspentech.com.

2 Overview 5
aspenONE Licensing Model
The aspenONE Licensing Model is a flexible token-based approach to software
licensing. This unique and innovative commercial model makes it easier for
customers to use software when and where they need it. Customers have
access to all current and future AspenTech products with just one contract.

Upgrading to the aspenONE Licensing Model for


Manufacturing and Supply Chain V8.x and above
If you have recently signed a new aspenONE Licensing Model agreement or if
you have superseded an old license agreement with an aspenONE Licensing
Model token-based license agreement for aspenONE Manufacturing and
Supply Chain, you will receive a new token-based license file for V9. During
installation of any product in Aspen Manufacturing and Supply Chain, you will
get a message indicating that the newly installed software will use the token-
based license key. Accepting the warning message enables you to install the
software.

Note: If you do not have the updated token-based license file, please contact
AspenTech Customer Support.

6 2 Overview
Accessing aspenONE
Documentation
Documentation is available directly from the applications. This eliminates the
need to search for the documents that you need and ensures that you can
always find the most current version of the document that you are looking
for.
Documentation can be found in the following ways:
 Installation Guides and Release Notes can be found by clicking the
corresponding link on the Welcome page of the aspenONE Installer or by
selecting Open Folder to view files from the AutoPlay dialog box after
inserting the USB.
 Context-sensitive help can be accessed by:
o Clicking the Help button on an application dialog box
o Pressing F1 while in the application
o Clicking the application’s Help menu and selecting Help
 Additional documents in PDF format can be accessed by:
o Clicking Online Documentation on the product’s Start page or Start
tab or selecting Documentation from the product’s Help menu. This will
open the Online Documentation Center from which you can view
and/or download the product-specific documents.
o Logging onto the AspenTech Customer Support site, clicking the
Documentation link on the left side of the website, and browsing the
Documentation page.
o Downloading all of the available documentation (other than Help files)
from the AspenTech Customer Support website via the zip file of the
aspenONE Documentation.
 For Aspen Plus and HYSYS only, you can access additional documents by:
o Clicking on the link to aspenONE Exchange on the File menu and then
entering a search string in the search box.
o Clicking on the documentation search shortcut on the Resources ribbon
and then entering a search string in the search box or browse through
the list of published training documents.

2 Overview 7
Aspen Petroleum Supply Chain
Overview
The Aspen Petroleum Supply Chain Suite of products provide a
comprehensive set of solutions that address the unique needs of companies
involved in the planning, scheduling, refining, and transporting of crude oils,
intermediates, and refined products.
Product Description

Aspen PIMS Aspen PIMS (Process Industry Modeling System) is a flexible


planning tool used for economic planning in the process
industries. PIMS includes aspenONE PIMS Platinum and
PIMS Assay Management.
Aspen Refinery Aspen Refinery Multi-Blend Optimizer (Multi-Blend Optimizer)
Multi-Blend is a multi-blend optimization tool for refinery products.
Optimizer,
formerly Aspen
MBO
Aspen Petroleum Aspen Petroleum Scheduler is a petroleum refinery and
Scheduler, petrochemicals scheduling application that supports the
formerly Aspen comprehensive scheduling of all plant activities.
Orion
Aspen Olefins Aspen Olefins Scheduler is an application for configuring and
Scheduler scheduling an olefins facility.
Aspen Petroleum Aspen Petroleum Supply Chain Planner is an application is an
Supply Chain economic planning tool used to solve multi-commodity,
Planner, formerly multi-period transshipment optimization problems. PSCP
Aspen DPO solves problems involved in optimization of distribution
networks for any industry having alternate modes of
transporting materials to various plants, terminals and/or
customers.
Aspen Refinery Aspen Refinery Report and Aspen Report Writer are Add-In
Report features that work with Microsoft Excel® to create templates
and custom reports.

8 2 Overview
System Requirements
This section provides hardware, software, and user requirements for Aspen
PIMS, aspenONE PIMS Platinum, Aspen Petroleum Scheduler, Aspen Refinery
Multi-Blend Optimizer, Aspen Olefins Scheduler, Aspen Petroleum Supply
Chain Planner, and Aspen Report Writer. Other application launched from
these applications will have the same requirements as the parent application.

Note: Use of virtualization software Microsoft Hyper-V, VMware ESX Server


5.5.1, and Terminal Services are supported for all Petroleum Supply Chain
products. Other virtualization software, such as Citrix XenApp, is not officially
supported. Please check with your IT department regarding installation,
setup and security requirements when using virtualization technologies.
Starting with V8.5, aspenONE PIMS Platinum (Platinum) can be installed with
Aspen PIMS or Aspen Petroleum Scheduler. Platinum can be installed on a
local machine or as a server installation independent of a particular
application. In addition, Platinum server can be installed and integrated with
aspenOne. Please refer to the aspenONE documentation for aspenONE
specific installation and integration instructions.
You can perform aspenONE searches using Schedule Manager, without full
aspenONE integration. Schedule Manager is installed automatically with
Platinum Server. Refer to the Schedule Manager Configuration chapter in
this document for specifics on how to setup ingestion of documents to support
search.

Aspen PSC Hardware Requirements –


Desktop

Computer and Processor Intel® Core™ i5 2.8 gigahertz (GHz) or faster

Memory (RAM) 16 gigabytes (GB) RAM

Hard Disc 250 gigabytes (GB)

Display Graphics hardware acceleration requires a


DirectX10 graphics card and a 1280 x 1024 or
higher resolution
Network 100MB/Sec or above

Mobile Devices and aspenONE PIMS Platinum client only


Tablets IPad/iPhone
With iOS 9.3
Microsoft Surface Pro
Only with Windows 8.1/Windows 10

2 Overview 9
Aspen PSC Hardware Requirements –
Server
If running PSC software on a server, below are the requirements.

Computer and processor Intel Core-i5 family 2.8 gigahertz (GHz) or


faster for standalone deployment
2 x Intel Wolfdale-DP family 2.66 gigahertz
(GHz) (4 cores) or faster for multi-user
environment
Memory (RAM) 8 or above gigabytes (GB) RAM for standalone
deployment
16 or above gigabytes (GB) RAM for multi-user
environment
Free Hard Disc Space 150 gigabytes (GB) available
300 gigabytes (GB) available for multi-user
environment
Display Graphics hardware acceleration requires a
DirectX10 graphics card and a 1280 x
1024 or higher resolution monitor
Network 100MB/ second or above, Gigabyte network
recommended

10 2 Overview
Aspen PSC Desktop Software Requirements
Note: Only a single instance of PIMS can run on any machine. This includes
virtual environments. If you wish to run multiple instances of PIMS in a
virtual environment, we suggest you run multiple virtual machines each with
a single running instance of PIMS.

Supported Operating Systems Desktop Notes


Windows 10 Professional (64-bit)
Windows 8.1 Update Professional & Enterprise (64-
bit)
Windows 7 SP1 Professional & Enterprise (64-bit)

Supported Web Browsers


Internet Explorer 10 or 11
For aspenONE PIMS
Google Chrome 49
Platinum only
For aspenONE PIMS
Platinum only
Safari required for iPad.
Safari on iOS 9.3
Products only support
version of Safari that
can run on that iOS.

Supported Microsoft Office


Note: Use of Aspen
Report Writer with 64-
Microsoft Office 365 ProPlus (32-bit) bit versions of Office is
Microsoft Office 2010 SP2 or 2013 SP1 (32-bit) not supported.
Access is not supported
in Olefins Scheduler

Required Runtimes
You many need to use
Turn Windows
.NET Framework 4.6 features on or off
.NET Framework 4.5.2 from the Control Panel
in order to enable the
.net requirements after
installation of the
components.
.NET Framework 3.5 For SLM
Required for PIMS.
Visual Studio 2010 Tools for Office Runtime SP1 Required if using Aspen
Report Writer

2 Overview 11
Supported Database Clients

Microsoft SQL Server Express 2014 SP1 PSCP does not support
Express editions of SQL
Microsoft SQL Server Express 2012 SP2 servers

Microsoft SQL Server Express 2008 R2 SP2


Oracle Client 12.1.0.2 Petroleum Scheduler
and Refinery Multi-
Oracle Client 11.2.0.4
Blend Optimizer only
(Oracle Client 11.2.0 or 12.1.0 (32-bit) must be installed to
access data available from a compatible Oracle Server 11.2.0 or
12.1.0.)

Supported Reporting Services


Microsoft SQL Server 2014 Reporting Services
Microsoft SQL Server 2012 Reporting Services
Microsoft SQL Server 2008 R2 Reporting Services

Microsoft Report Viewer 2010 SP1 Olefins Scheduler only

Required Security Frameworks


Aspen Framework (AFW) 5 Required for PIMS only
Required for PIMS and
Microsoft Active Directory / Domain Services aspenONE PIMS
Platinum only

Mobile and Tablet Support


Safari for iOS 9.3 on iPad aspenONE PIMS
Platinum only
Windows 8.1/Windows 10 for Microsoft Service Pro

SLM Server and Tools


Required for licensing.
Client tools install
automatically when
installing the product.
You will need access to
the appropriate licenses
Aspen SLM Server and Aspen SLM Tools must be in order to run
installed and running prior to installing any product. AspenTech software.
Note: SLM can point to
a license file that
resides on the local
machine; therefore,
eliminating the need for
TCP/IP.

12 2 Overview
Other
Required if using PIMS
Analytics and running
SQL; SQL Server
Express is not sufficient
SQL Server Analysis Services associated with since Analysis Services
supported databases is required for PIMS
analytics to function. If
using Express, will need
to install Analytic
Services standalone.
Required for use of
adapters
Specifically:
MSMQ Active Directory
Microsoft Message Queue (MSMQ) Domain Services
Integration (for non-
server computers joined
to a Domain)
MSMQ HTTP Support
Optional for PSCP only.
Required if creating
Microsoft MapPoint 2006 map files using
MapBuilder to produce
.ptm files.

2 Overview 13
Aspen PSC Server Software Requirements

Supported Operating Systems Server Notes


Windows Server 2012 R2
Windows Server 2008 R2 SP1

Required Runtimes
You many need to
use Turn Windows
features on or off
.NET Framework 4.6 from the Control
.NET Framework 4.5.2 Panel in order to
enable the .net
requirements after
installation of the
components.
.NET Framework 3.5 For SLM

Supported Database Server

Microsoft SQL Server 2014 SP1 Standard &


Enterprise
Microsoft SQL Server 2012 SP2 Standard &
Enterprise
Microsoft SQL Server 2008 R2 SP2 Standard &
Enterprise
Oracle Database 12.1.0.2 Petroleum Scheduler
Oracle Database 11.2.0.4 and Refinery Multi-
Blend Optimizer only
(Oracle Client 11.2.0 or 12.1.0 (32-bit) must be
installed to access data available from a compatible
Oracle Server 11.2.0 or 12.1.0.)

Supported Reporting Services


Microsoft SQL Server 2014 Reporting Services
Microsoft SQL Server 2012 Reporting Services
Microsoft SQL Server 2008 R2 Reporting Services

Microsoft Report Viewer 2010 SP1 Olefins Scheduler only

Supported Web Servers

IIS 8.5 or IIS 7.5 Only used by aspenONE


PIMS Platinum Server

14 2 Overview
Required Security Frameworks
Aspen Framework (AFW) 5 Required for PIMS only

Required for PIMS and


Microsoft Active Directory / Domain Services aspenONE PIMS
Platinum only

SLM Server and Tools


Required for licensing.
Client tools install
automatically when
installing the product.
You will need access to
the appropriate licenses
Aspen SLM Server and Aspen SLM Tools must be in order to run
installed and running prior to installing any product. AspenTech software.
Note: SLM can point to
a license file that
resides on the local
machine; therefore,
eliminating the need for
TCP/IP.

Other

SQL Server Analysis Services associated with Required if using PIMS


Analytics and running
supported databases
SQL
Required for use of
Microsoft Message Queue (MSMQ) adapters
MSMQ HTTP Support

2 Overview 15
aspenONE PIMS Platinum Software
Requirements
aspenONE PIMS Platinum (Platinum) solo version is automatically installed
when installing Aspen PIMS or Aspen Petroleum Scheduler. aspenONE PIMS
Platinum Server is a separate installation option on the aspenONE products
installation page.
Below are requirements specific to Platinum solo, Platinum server client and
Platinum Server in addition to previously listed requirements.

Platinum Server Required for aspenONE PIMS Platinum Server


Requirements: installation.
IIS Windows Authentication Using Server Manager | Roles, confirm
installation of Windows Authentication and
IIS 8.5, IIS 8, IIS 7.5
that it is enabled.

Internet Information Services Required for aspenONE PIMS Platinum Solo


and aspenONE PIMS Platinum Server
Specifically, Internet
installation.
Information Services 6
compatibility components Using Server Manager | Roles, confirm
installation of the following under Web
Server (IIS) | Role Services |
Management Tools | IIS 6 Management
Compatibility:
IIS 6 Scripting Tools
IIS 6 WMI Compatibility
IIS 6 Metabase and IIS 6 configuration
compatibility
AND
IIS Management Console

You must also enable Directory Browsing.


Anonymous Authentication must also be
Enabled.

16 2 Overview
Additional Requirements
Enable User Account Control: Required to run cases in PIMS Platinum, both
Admin Approval Mode for solo and server.
Built-in Administrator Account
Policy must be enabled
policy
Set from the Local Security Policy dialog
box (secpol.msc) Security Settings| Local
Policies | Security Options.

OR OR

Modify AspenTech Case Use services.msc to change LogOn user for


Runner Service this service to a non-administrative user
account name.

Important! In regards to aspenONE PIMS Platinum Server installation,


Microsoft does not support moving IIS 7.0 and later from its default location.
Please see Microsoft KB article //support.microsoft.com/kb/2752331.

2 Overview 17
User requirements
Administrative privilege is required to install all AspenTech software. Your
administrative privilege must allow you to write to the registry and also to
specific folders on the installation machine.
SQL Administrative privileges are required to perform any SQL functions
including creating SQL databases and assigning proper permissions to SQL
database accounts.

Integration Services
If installing Aspen Petroleum Scheduler Integration Services, login
information is required if using Microsoft SQL Server as your database. The
user name you enter is the account login name used to connect to SQL.

Platinum Specific
When installing Platinum Solo, we recommend that users have
administrative privileges. However, the machine user can have a non-
administrator account if the same account will be used to log onto the
machine.
Installing PIMS Platinum Client Server requires administrator permissions.
The Network Service account must have permissions to access the
directories containing the system files, model files and database files.

Service User Accounts


If using KPI passing or assay passing from PIMS to APS, the NetworkService
account must have specific rights to successfully access databases.
If using SQL as the APS database, NetworkService on the machine where
APS Integration services have been configured, must have read-write access
to the database location.
If using Access as the APS database, the folder that contains the Access
model must have NetworkService read-write access.

18 2 Overview
3 Installing the Aspen
Petroleum Supply Chain Suite
for the First Time

Overview
This chapter provides instructions for installing Aspen Petroleum Supply Chain
products.

Note: Coexistence is not supported for Aspen Manufacturing and Supply


Chain products (including PIMS). Those products do not support coexistence
of multiple versions on any platform (including coexistence with Aspen
Engineering products of a different version). Also, different patches of the
same version cannot coexist.

Before You Install


Before installing, perform the following pre-installation tasks and
confirmations:
 Obtain the appropriate license file(s) or obtain the I.P. address or name of
the SLM server.
 Ensure that Firewall protection has been disabled. Specifically, if a
Firewall blocking message appears, you should allowing MPICH2 message
passing to occur by permitting Smpd.exe to run.
 Ensure that the system requirements are met:

In addition to the requirements above, check the following:


 Ensure you have local administrative permissions. (See “User
Requirements” section in the “Overview” chapter.)
 Install/configure required third-party software as needed (e.g., Microsoft
Excel).

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 19
Specifically regarding installation of aspenONE PIMS Platinum, you must
ensure that the Windows Firewall service is turned on prior to installation:
1 Start | Control Panel.
2 Search Control Panel for Windows Firewall.
3 Click Turn Windows Firewall on or off.
4 Under the applicable location settings, click Turn on Windows Firewall.

Installing the Aspen Petroleum


Supply Chain Suite for the First
Time
Getting Started
1. Insert the USB drive. The AutoPlay dialog box is displayed.
2. Select Run aspenONE Install Browser. (You also have the option of
viewing the files on the USB.)
3. Select one of the three product suite options – aspenONE Engineering,
aspenONE Manufacturing and Supply Chain, or aspenONE Software
License Manager.
4. Select Begin Install. The Welcome screen for the suite that you
selected is displayed.

Note: Before you begin installation, you will want to review the media kit
brochure and print copies of the Installation Guides for products that will be
installed. Those guides are included under the Aspen Engineering and Aspen
Manufacturing and Supply Chain folders on the USB drive in your package.
Before you see the Welcome page, you may see the following:

You must click Yes to continue.

20 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
If you do not see this dialog box or something similar, you may have
accessed the installation incorrectly and in doing so, appropriate settings may
not occur. The consequence is that the applications may not run correctly or
errors may appear even though the installation seems to complete
succesfully. If this dialog box does not appear, cancel the installation and re-
launch setup.exe to start the installation again.
Carefully read the instructions, make your selections and proceed with the
installation.

Installation Welcome Page


The AspenTech Installation Welcome Page provides options to install or
upgrade aspenONE products, configure licensing, and create install scripts for
unattended installations.
The following links are available on the left side of the aspenONE Installer
Welcome Page:
 Get Started. Opens the AspenTech Deployment Solutions Web site.
 Installation Guides. Opens a folder on the USB drive that contains all
the Installation Guides for the products on the USB drive.
 Release Notes. Opens a folder on the USB drive that contains all the
Release Notes for the products on the USB drive.
 aspenONE Product Documentation. Opens the AspenTech Support
Web site to the Documentation page.
 aspenONE Update Center. Connects to the Aspen Support Update
Center so that you can check to see if there are patches available for the
product(s) that you are installing. You must be a registered user on the
Support Web site to access the Update Center.
 Unattended Install Notes. Provides instruction on creating an
unattended installation.
 Support Services. Connects to the AspenTech Support Web site, where
you can find knowledge base articles, tips, and solutions to known
problems.
 AspenTech Home. Connects to the AspenTech Web site.
 Contact Us. Connects to the AspenTech Support Web site, where you can
obtain the latest e-mail and telephone contact information and find the
AspenTech Support location closest to you. You can see hours of operation
for global support and submit your support issues.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 21
The following options are available on the aspenONE Installer Welcome Page:
 Install aspenONE products. Launches the installation process during
which you will select new products to be installed on this computer.
 Upgrade or repair existing products. Upgrade earlier versions of
products or repair existing installation errors.
 Prepare Deployments. Create install scripts and copy media to
automate software deployment.
 Install and configure SLM (Software License manager) software. Install
and configure the SLM server running on a network.

Notes:
 Aspen Petroleum Supply Chain applications are developed as 32-bit
applications. Though 32-bit applications, they can run on a 64-bit
machine. The installation automatically detects your operating system
and displays allowable applications to install.
 Be sure that the SLM license server or standalone license is available prior
to installation. SLM tools are automatically install when installing
aspenONE products.

22 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
License Terms and Conditions

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 23
Choose the aspenONE products you want to
install and the location

Installation Notes
Options Description
Petroleum Supply If you select a primary PSC product to install,
integration options EIF and mMDM Adapters, are
Chain and Distribution
automatically selected. Without these components,
Products integration between products cannot occur.
Aspen PIMS (with Installs PIMS and aspenONE PIMS Platinum on a
aspenONE PIMS local machine. You do not need any specific
Platinum) privileges to install these options. The Platinum
Administrator role is automatically granted to
anyone with local machine administrator rites.
Please refer to the aspenONE PIMS Platinum
Software Requirements section for additional
runtime requirements.

24 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
Options Description
Aspen PIMS Platinum Installs PIMS Platinum Client Server version.
Server Installing the server version allows you to assign
roles and responsibilities for each data source and
project. A website is created where users can
access a common Platinum server interface when
working with Platinum. Platinum information is
housed on a single server location. Result
databases are accessible to all. There is no
functional difference between the multiple
machine client server version and the single
machine, solo/standalone version of Platinum.
You will need administrator rights to install IIS
prior to proceeding with the installation. See the
Overview Requirements section for specific
information.
When installing Platinum Server, aspenONE
Schedule Manager is also automatically
installed. You can use this component to
configure search for Platinum flowsheets.
Note If you integrate with aspenONE Server,
there are post installation steps to complete to
integrate with aspenONE. These steps automate
the search configuration requirements. If you are
installing aspenONE PIMS Platinum Server and not
integrating with aspenONE Server and yet want to
enable the flowsheet search feature, see the
chapter on Schedule Manager Configuration
after installation completes.

Additional Notes:
 Once the installation of any AspenTech product to the default folder has
been completed, this folder cannot be changed. Any further AspenTech
installations on the computer are made to that folder by default.
 Common features are always installed in the Program files\Common
Files\AspenTech Shared folder regardless of the destination location
selected.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 25
Prerequisite Validation

This screen will only appear if prerequisites are missing. If you have not
already installed Microsoft .NET redistributables, they can be downloaded
from the following location:
Microsoft .NET Framework version 4.x
http://www.microsoft.com/en-us/download/search.aspx?q=.net+4.0
To insure PIMS Platinum runs correctly, you will be prompted to correctly
configure the PIMS Case Runner Service. See the aspenONE PIMS
Platinum Software Requirements section for specifics.

26 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
Specify licensing & security

Verify your installation

Note: If you encounter a Window Firewall security Alert after clicking Install
Now, allow access to enable use of message queuing needed by the selected
application to install.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 27
aspenONE installation progress

28 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
Aspen Petroleum Supply Chain
Suite Post Installation Notes
Using 64 bit version of MS Office (Office
365) with Aspen Petroleum Scheduler and
Aspen Multi-Blend Optimizer Access
Databases
There is a known compatibility issue when running Office 64 bit and using
Access databases. Without performing the following, you will not be able to
open your databases.
Please follow the steps below:
1 Download the Microsoft Access Database Engine 2010 Re-
distributable from the following location:
http://www.microsoft.com/en-
us/download/details.aspx?displaylang=en&id=13255
Select both AccessDatabaseEngine.exe and
AccessDatabaseEngine_x64.exe as downloads.
2 Once downloaded, install AccessDatabaseEngine.exe by opening a
Command prompt, with admin privileges, and then type:
AccessDatabaseEngine /passive.
3 Install AccessDatabaseEngine_x64.exe by opening a Command
prompt, with admin privileges, and then type:
AccessDatabaseEngine_x64 /passive

Note: You cannot install AccessDatabaseEngine.exe or


AccessDatabaseEngine_64.exe by simply double-clicking on the
executable. Be sure to use a Command prompt to install and you must
include /passive in your commands.
Completing these installations will install two drivers that you can see
under Control Panel | Programs | Programs and Features”.
After the steps above, you will need to create a DSN to access the .mdb files
with no issues.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 29
Aspen PIMS Post Installation Configuration
and Procedures

Aspen PIMS – Using SQL as an Output Database


PIMS model execution has a unique identifier, Solution ID, associated with
each run. When an execution run occurs, the solution data is written to an
output database. All report data is obtained from the output database that is
specified from the Output Database tab of the General Model Settings
dialog box.

Note: PIMS does not support exporting information from multiple models
into a single SQL database. Doing so may cause erroneous or unexpected
results.
The following information is applicable if you plan to store PIMS model data
results in a Microsoft SQL Server database.

Create the SQL Server Instance

Note: Aspen Technology recommends that a qualified Database


Administrator (DBA) create and configure the SQL Server database for use
with any Aspen products.
For best results, and in order to avoid disk contention, at a minimum, please
install the following on different physical drives:
 Operating System
 Database
 Logs

For additional information or clarification on SQL Server installation


recommendations, please consult Microsoft for the latest best practices. Also
please note that during SQL role setup, to enable the Grant Connect option
for TSQL Default TCP found under SQL Security | Server Roles | Public |
Permissons.
After installing SQL Server, perform the following related to your server:
1 Enable Allow Remote Connections.
2 Enable TCP/IP.
3 Check the default SQL Server port; 1433 should be automatically added to
the Windows Firewall exceptions list. This is a troubleshooting tip.
Check with your IT department for specific details related to your
organization.

30 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
Create the SQL Server Database
If you are a SQL database administrator, you may already have a procedure
to create a new SQL database. If a database creation procedure is not
available, we have provided a script to help create a blank database, the
description of which is found below.
Once the initial SQL database is created, go to the Create the database
objects using the provided schema section to create the appropriate
tables.

Create the database using the provided SQL script


Complete the following procedures on the computer where SQL Server is
installed to create the target PIMS results database.
1 On the machine where PIMS is installed, go to:
C:\Program Files\AspenTech\Aspen PIMS\Enterprise Configuration\Database.
2 Using SQL Server Management Studio or a text editor, open the
PimsDbCreationScript.sql script. This script is used to create the
database.
3 Replace all instances of %databaseName% with the name of the
database that is being created, e.g. ResultsPIMS.
4 Replace all instances of %databasepath% with the path of where the
database will be created, e.g., “C:\Program Files\Microsoft SQL
Server\MSSQL.1\MSSQL\DATA.” Please also notice that the path does not
contain a final backslash.
5 Replace all instances of %logfilepath% with the path of where the log
file will be created, e.g., “C:\Program Files\Microsoft SQL
Server\MSSQL.1\MSSQL\DATA.” Please also notice that the path does not
contain the final backslash.
6 Replace all instances of %initialdatabasesize% with the initial size for
the database, e.g., “2048KB.”
7 Replace all instances of %initiallogfilesize% with the initial size for the
log file, e.g., “1024KB.”
In summary, these are the items that should have been replaced in the
script, %databaseName%, %databasepath% (without the final
backslash), %logfilepath% (without the final backslash),
%initialdatabasesize%, %initiallogfilesize%.
8 Save the file.
9 Execute the script.

Create the database objects using the provided schema


(i.e. script)
The referenced script creates the necessary database objects or tables.
If you know how to apply an SQL script to an existing blank database, use the
PimsTableCreationScript.sql script to do so, after commenting out the
%databaseName% at the top.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 31
If you do not know how to automatically apply a script, follow the steps
below:
1 In the same directory as the database creation script, for example,
C:\Program Files\AspenTech\Aspen PIMS\Enterprise
Configuration\Database, use SQL Server Management Studio or a text
editor to open PimsTableCreationScript.sql.
2 Replace all instances of %databaseName% with the name of the
database that is being created, e.g., ResultsPIMS.
3 Save the file.
4 Execute the script.
The database scripts should run without error. If there are any errors, make
sure you have sufficient privileges to execute the scripts and create objects.

Create Database User Accounts


Create database login accounts and users and assign them to their
appropriate database roles based on your local IT security policy.
The minimum database privileges for PIMS users to read and write is
db_datawriter and db_datareader on the database

Test SQL Server Setup and User Access from PIMS


Use the following procedure to test SQL Server login credentials and to test
the connection to your results database.
1 Test the login by logging onto SQL Server with SQL Server authentication
mode using SQL Server Management Studio from the same machine on
which SQL Server is installed.
2 Test the connection has been set up correctly by launching PIMS.
3 Go to the General Model Settings dialog box.
4 Click the Output Database tab.
5 Select SQL Server from the Database Type list dropdown.
6 Click the “…” associated with the Connection String field to open the
Data Link Properties dialog box.
7 Complete the SQL Server data connection information using the SQL
database name you created.
8 Click Test Connection to verify connection to the database is successful.

32 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
aspenONE PIMS Platinum Post Installation
Configuration and Procedures

aspenONE PIMS Platinum Server Integration with


aspenONE Suite
Starting with V8.5, Aspen PIMS Platinum Server can be integrated with
aspenONE. This allows for flowsheet searching as well as integration with
other aspenONE products. To enable these features you will need to register
aspenONE PIMS Platinum Server with the aspenONE Server.
Registration can be done using the aspenONE Core Registration tool, which is
installed when aspenONE PIMS Platinum Server is installed. Once an
application is registered, an application user group is generated in the
Administration App in aspenONE, a job is created linked to the application
in the Schedule Manager and the applications icon is displayed on the home
workspace.
Once you have installed aspenONE Platinum Server, complete the following to
register Platinum Server with aspenONE Server:
1 Install and test to be sure all aspenONE server components are installed
and are functioning. Refer to the aspenONE documentation for detailed
instructions. From the installation, you will need the aspenONE Server
broker information to complete the integration with Platinum Server.
2 On the machine where you have installed aspenONE Platinum Server, go
to Start | AspenTech | PIMS Platinum | aspenONE Registration.
The aspenONE PIMS Platinum Registration dialog appears.
3 Under Application Information, verify that the aspenONE PIMS
Platinum Address field contains the fully qualified URL identifying the
aspenONE Platinum server.
4 Complete the aspenONE Broker Server field with the fully qualified URL
and domain information identifying the machine on which you have
installed aspenONE Server.
5 Complete the aspenONE Broker Account and aspenONE Broker
Password information. This is the service bus account information that
was configured when installing aspenONE Server. It corresponds to the
TomCat Manager account username and TomCat Manager account
password. This account information is created during the installation of
the aspenONE Server.
6 Click Register. A communications check is performed. You will receive
validation that communications between the servers has been established.
If this is successful, on the aspenONE home page, you will see an
aspenONE Platinum Server icon. Flowsheet search configuration is
automatically completed for you.
If registration fails, confirm that your aspenONE server broker information
is accurate and try again.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 33
Please refer to the aspenONE installation guide for additional information
related to aspenONE Server.

aspenONE Search without Full aspenONE


Integration
If you wish to enable aspenONE flowsheet search capabilities, without
complete aspenONE integration, please refer to the Schedule Manager
Configuration chapter.

Configuration To Run Cases


To modify defaults and required configuration settings, use the
PIMSCaseRunnerService.exe.config file. This XML formatted file can be
edited using a standard text or XML editor. In addition to this file a backup
file, PIMSCaseRunnerService.exe.default.config, exists that lists all
available settings. You can refer to this file to add additional settings or to
view standard defaults.

Where to find this file:


 Located in the AspenTech installation folder, for example:
\ProgramData\AspenTech\PIMS Case Runner Service

Note: The ProgramData folder is a hidden folder. If not immediately


visible, access the Windows Folder Options dialog box and enable the Show
hidden files, folders and drives option located on the View tab.
Platinum solo is configured to run with default settings. It will run without
additional modifications.
Platinum Server requires modification to the OSType and the
listeningPort keys.

To change settings for Platinum server installation:


1 Use any text editor to open the PIMSCaseRunnerService.exe.config
file. This file contains settings and comments that describe each setting.
2 Change or modify the desired setting by either removing the comment or
modifying the existing setting.
Below are the required changes when running Platinum Server.
Client Server Key Required Setting

OSType Must be server


listeningPort 14035 (default) This value must
match the port number specified
in the port setting on the
Platinum Model Configuration
dialog box.

34 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
Client Server Key Required Setting

serverInactivityTimeout Default is 1 minute. Modify this


(optional) value if you wish the timeout
that PIMS remains active to
serve other users after
completing a run in server mode
to a longer time.

To view a complete list of commands and additional information, refer to the


Platinum Configuration Settings topic found in Platinum online help.

Aspen PIMS Platinum Client Configuration When


Running Cases on Platinum Server– Ole Setting
To support running cases using PIMS Platinum server, you must enable the
following setting in PIMS for all users that have access to the PIMS Platinum
server:
Permit Multiple Ole instances during automation
To enable this setting:
1 Launch PIMS.
2 On the main menu click Tools | Program Options | Execution tab.
3 Select the Permit Multiple Ole instances during automation option.
Failure to set this option prevents the running of cases in Platinum client
server. A message appears when you attempt to run cases asking you to set
this option.

Aspen PIMS Platinum Server – Connecting to a


SQL server
Additional setup is necessary if accessing a SQL server when running Aspen
PIMS Platinum Server. This applies to local as well as server installations.

Note: The procedure described below assumes familiarity with SQL Server
and Administrative functions. It is highly recommended that DB
Administrators perform these steps.
To establish proper connections to an existing SQL database, you must grant
the machine that is running PIMS Platinum Server login access to the SQL
server by doing the following:
1 On the machine running PIMS Platinum, right-click Computer and click
Properties. Machine information displays
2 Note the machine name and the domain name.
3 If you are connecting to SQL using Aspen PIMS Platinum solo, the
connecting user account must be configured as descried below.
If you are connecting to Platinum using a web browser, the connecting
machine account must be configured as described below.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 35
Go to your SQL Server machine and create a new login with the following
information:
Page/Option Value/Setting
General/Login name <domain>\<user account>or
<machine name$>
Server Roles public
User Mapping Select the desired database
Database role membership db_datareader
public

Aspen PIMS Platinum Server Access


Once setup, assignment of roles and features are complete, users can access
Platinum Server using the following address:
http://<serverURL or FullyQualifiedDomainName>
/AspenTech/PIMSPlatinum/Anyhome.html

Aspen PIMS Platinum– Solo Use of Services


PIMS Platinum solo has a service running which is similar to Windows services
running locally. This service listens to a configurable software port and only
services the local user connected to the desktop.

Aspen PIMS Platinum– Using Access as an Output


Database
If you are using Access with PIMS Platinum, there are no additional
configuration steps necessary.
If you are using Access with PIMS Platinum Client Server, you will need to
place database files on the client server machine at or below the following
location:
C:\ProgramData\AspenTech\PIMS Platinum\DataSources

Note: This folder, by default, may be hidden. Unhide this folder by going to
the View tab associated with the Windows Folder Options dialog box.
Be sure that folder security for the account the PIMS Platinum server
application is running IIS under is set appropriately so users can read from
this location. Typically this is NETWORK SERVICE.

36 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
Aspen Olefins Scheduler – Creating the AOS
Database
The Aspen Olefins Scheduler SQL Server database stores all data used by the
Scheduler applications and the Regression Calculator. AspenTech
recommends that a qualified Database Administrator (DBA) create and
configure the Aspen Olefins Scheduler database.

Note: In order for the database to be successfully created, you must have
Remote Connections enabled. Check with your IT department for specific
details related to your organization.

Create the SQL Server database


Complete the following procedure on the computer where SQL Server is
installed.
1 Locate the CreateOlefinsDatabase.bat script. The installer typically
installs the script to C:\Program Files\AspenTech\Aspen
Olefins\Database\Scripts\MSSQL.
2 Copy the entire directory that contains the CreateOlefinsDatabase.bat
script to the computer where SQL Server is installed.
3 Run CreateOlefinsDatabase.bat by double clicking it.
The script creates an empty database named "Olefins" along with all
database tables. Later in this section, after creating a DSN connection,
you will need to update the blank database to obtain the latest database
tables.

Create database users


In SQL, create database login accounts and users and assign them to their
appropriate database roles based on your local IT security policy. To read and
write data to the database, you must grant users, at minimum, the
db_datawriter and db_datareader permissions.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 37
Configure the ODBC Data Source
Configure the Data Source Name (DSN) for the Aspen Olefins Scheduler
database using the MS ODBC Data Source Administrator and test the
connection. Complete this step for each computer where Aspen Olefins
Scheduler is installed.

Before You Start:


 Install the SQL client on the client machine if needed.
 Identify the name of the SQL server on which the Olefins database is
located.

To create a new DSN File:


1 Start the Windows Control Panel.
2 Double-click Administrative Tools, and then Data Sources (ODBC) to
display the ODBC Data Source Administrator dialog box.
3 Select the File DSN tab, and then click Add to display the Create New
Data Source dialog box.
Note: If you are creating a system DSN for use with the DBCopy
program, select the System DSN tab.
4 Select SQL Server from the Name list, and then click the Next.
5 Enter the name you want to assign to the DSN file, and then click the
Next.
6 Click Finish to display the Create a New Data Source to SQL Server
dialog box.
7 Enter a description of the DSN file in the Description field.
8 Click the drop-down arrow beside the Server field, and then select the
appropriate server from the list.
9 Click Next.

To select the authentication method:


1 Select one of the following options:
With Window NT authentication
-or-
With SQL Server authentication
Note: Check with your administrator if you are unsure which option to
select. If you select the With SQL Server authentication option, you
must also provide a Login ID and Password.
2 Click Next.
3 Select the Change to default database to option, and select the Aspen
Olefins Scheduler database. Then click Next.
4 Click Finish to display the ODBC Microsoft SQL Server Setup dialog
box.

38 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
To test the data source:
1 Click Test Data Source. You should receive a message stating that the
test was completed successfully. If you do not receive this message,
contact your database administrator for assistance.
2 Click OK to exit the test and return to the ODBC Microsoft SQL Server
Setup dialog box.
3 Click OK to return to the ODBC Data Source Administrator dialog box,
and then click OK to complete the task.
For more information about configuring the ODBC data source, see Microsoft
Help documentation.

Update Your SQL Database to the Most Current


Tables for This Release
Starting with V8.7, you will need to run DBUpdate.exe on the blank SQL
database you created earlier to obtain the most current tables.
DBUpdate.exe can be found in the following location:
C:\Program Files\AspenTech\Aspen Petroleum Scheduler

Note: Before running DBUpdate, be sure that you have already created a
SQL database and that a DSN connection has been established.
1 Run DBUpdate.exe.
2 For Type, select Olefins Scheduler.
3 For Baseline DB, select ORIONDBGen.mdb, located in your application
installation directory.
4 For Client Model, select the DSN file you created to connect to your SQL
database.
5 Refer to the DBUpdate online help to set any additional settings.
6 Click Update to update the blank Olefins database with the latest tables
required for this release.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 39
Petroleum Scheduler, Olefins Scheduler and
Multi-Blend Optimizer Post Installation
Settings

Excel Trust Center Macro Settings


To ensure simulation/optimization, use of the Excel Multi-Event Editor and
other features that use Excel perform correctly, you will need to verify a
Trust Center option prior to running your Aspen application. If the option
described below is not set, you will receive a Microsoft Visual Basic run-time
error or erratic behavior when the application attempts to access Excel.
1 Launch Excel and access Excel Options.
2 Click Trust Center.
3 On the main Trust Center screen, click Trust Center Options.
4 Click Macro Settings.
5 Locate the Developer Macro Settings section and enable the Trust
access to the VBA project object model.

Note: Depending on your version of Excel, the specific steps to access this
option may vary, but you must have the Trust access to the VBA project
object model option selected to ensure proper application operation.

Adapter Configuration
If you are not using adapters, be sure to set the CONFIG table keyword
USEADAPTER to N. The default is Y, indicating you will be using adapters.
Please refer to the specific application integration user guides for pre-
requisites and specific instructions on how to setup adapters.

Petroleum Scheduler and Multi-Blend


Optimizer Configuration
If you plan to use an SQL Server or Oracle database to store Petroleum
Scheduler or Multi-Blend Optimizer model data, perform the necessary post
installation steps described in the Appendix of the Petroleum Scheduler or
Multi-Blend Optimizer Help file (Orion.chm or AspenMBO.chm).

40 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
Olefins Scheduler User Configuration
You must provide a valid username and password to open and use Aspen
Olefins Scheduler. AspenTech strongly recommends that you change the
default username and password (Aspen/<blank>) following your local IT
security policy. To edit the default user or add additional users, you must edit
the USERS table directly in the Aspen Olefins Scheduler database. For each
new user, you will need to complete the following fields:
 ID
 USERNAME
 PASSWORD
 GROUP_
For more information about the USERS table, see the help topic, "USERS" in
the Aspen Olefins Scheduler Help.

Aspen Report Writer, Aspen Refinery


Report Wizard and Aspen Excel Integration
Utilities Post-Installation Configuration
Aspen Report Writer, Aspen Refinery Report Wizard and Aspen Excel
Integration Utilities are Excel add-ins. After installation, you should see these
utilities either on the main Excel toolbar or under Add-ins. If you do not see
these utilities, you will need to manually add the add-in to the Excel interface.
These steps vary depending on your version of Excel. Please refer to the
Microsoft Excel online help for the correct procedure related to add-ins.

3 Installing the Aspen Petroleum Supply Chain Suite for the First Time 41
Verify Installation
To verify the installation of any Petroleum Supply Chain product:
1 Click Start | All Programs | AspenTech and navigate to the installed
product name.
2 Launch the product. You should see the following after login:

3 Click Register Now to complete the registration process.


4 After completing registration, you should see a product dialog box that
contains the release version number. After logging in, you can also look in
the title bar for the release version number to verify the correct version
has been installed.

42 3 Installing the Aspen Petroleum Supply Chain Suite for the First Time
4 Upgrading or Repairing
Aspen Petroleum Supply
Chain Suite Products

Overview
Upgrading or repairing products associated with the Aspen Petroleum Supply
Chain, is performed from the installation application. The installation program
detects what software has been installed.

Note: If patches are available for the product that you are installing, you may
see a screen that allows you to view those patches before you install. You will
also have an opportunity to see the Updates when you finish the installation.

Please also note that coexistence is not supported for Aspen Manufacturing
and Supply Chain products (including PIMS). Those products do not support
coexistence of multiple versions on any platform (including coexistence with
Aspen Engineering products of a different version). Also, different patches of
the same version cannot coexist.
When you get to the Welcome screen, click Upgrade or repair existing
products. You will be prompted on how to continue.

4 Upgrading or Repairing Aspen Petroleum Supply Chain Suite Products 43


CAUTION: Upgrades on same versions many cause some files to be
overwritten. If in doubt as to whether a proper upgrade or repair will occur,
please perform the appropriate database backups, uninstall and perform a full
install to be sure the most current files have been replaced, registered and
installed. This will insure your application will run and perform as expected.
For Petroleum Scheduler, Olefins Scheduler or Refinery Multi-Blend
Optimizer, if you are upgrading from V7.1, and you are using adapters, you
will need to install Aspen Manufacturing Master Data Manager (mMDM)
and Aspen Enterprise Integration Framework (EIF). By default, these
options are selected for you.

Localized Versions Of PSC Products


If you are using a localization kit for any PSC products and wish to upgrade to
V8.4 or higher, you will first need to uninstall the localization kit.
Current localization kits are version dependent and are not compatible with
V8.4 or higher versions.
Please note that your V8.4 or higher products will not be localized until the
associated localization kits are available.

44 4 Upgrading or Repairing Aspen Petroleum Supply Chain Suite Products


Upgrading Aspen Petroleum Scheduler,
Aspen Multi-Blend Optimizer or Aspen
Olefins Scheduler to the Latest Version
When upgrading to a new version, you should run DBupdate.exe on all
previous databases in order to acquire any changed database schemas. Also,
starting with V8.7, pipeline scheduling is included that directly affects any
events that include pipelines, requiring you to perform an additional upgrade
step.
Please note that if your model contains pipelines, you will be required to
update pipeline information whether or not you use the pipeline scheduling
feature.

To update pipeline information:


1 Insure you have updated to the most current schemas by running
DBUpdate.exe located in your application folder, on all applicable
databases.
2 The Migrate PIPLINE tables on Update option will be available if
pipelines are detected.
3 Select this option and click Update. The Pipeline Configuration
Wizard launches. Follow the steps to update your database.

Upgrading aspenONE PIMS Platinum


To ensure what you are seeing using Platinum is accurate, we suggest you
clear browsing data/cache from your browser after any upgrades.

4 Upgrading or Repairing Aspen Petroleum Supply Chain Suite Products 45


5 Removing the Aspen
Petroleum Supply Chain Suite

Overview
This chapter provides instructions for removing the entire Aspen Petroleum
Supply Chain suite of products or individual products from your computer.

Before You Remove


Before removing any products, close all applications and all subfeature
programs and save any files that you do not want to permanently lose. Pay
particular attention to custom configuration files.

Removing the Aspen Petroleum


Supply Chain Suite of Products
The supported method for uninstalling Aspen software is by clicking Start |
Programs | AspenTech | Uninstall AspenTech Software. From here a
dialog appears listing all installed AspenTech products. Select the products
you wish to uninstall and proceed with any additional instructions as
applicable.

5 Removing the Aspen Petroleum Supply Chain Suite 47


6 Schedule Manager
Configuration

Note: The information contained in this chapter is only applicable if you wish
to run aspenONE Platinum Server without integration with the aspenONE
suite and wish to use flowsheet search capabilities. If you are performing a
full integration with the aspenONE suite, the manual configuration described
in this chapter is not necessary. This configuration is automatically performed
when aspenONE PIMS Platinum Server is integrated with the aspenONE Suite
as described in the installation chapter. Also, if you do not wish to use
aspenONE flowsheet search capabilities, the configuration described in this
chapter is not required. Search is not a requirement for running Platinum and
is considered an optional feature.
aspenONE Schedule Manager is used by System Administrators to manage
the ingestion (collection) of content for aspenONE applications. Specifically, it
can be used by aspenONE Simulations, aspenONE Process Explorer and
aspenONE PIMS Platinum Server. Complete configuration information is
included for all three applications. You need only perform steps specific to
your target application.
This chapter includes the Schedule Manager’s steps for the management of
content by:
 Creating and modifying Jobs and Primary Workflows
 Adding and configuring Tasks
 Modify Schedules for Jobs
Administrators can also use Schedule Manager to perform the following
administrative tasks:
 Change the Administrative User Name and Password
 Delete Jobs
 Change logging levels
 Check server statistics

6 Schedule Manager Configuration 49


Running Schedule Manager for
the First Time
The aspenONE Schedule Manager can be accessed with a web browser.

To run Schedule Manager:


Use the following url:

For aspenONE… Enter…


Simulations http://<aspenONEserver name>:8080/AspenCoreSearch
Where <aspenoneserver name> is the machine where the
aspenONE Enterprise server is installed. In the Quick
Deployment Reference form, this is the server name entered in
row 1.
Process Explorer http://localhost:8080/AspenCoreSearch/
and
PIMS Platinum

Note: You must enter AspenCoreSearch using the exact capitalization used in
the url specification.
The login page opens.
Schedule Manager is initially installed with a default User Name of admin and
a Password of admin. Enter these default credentials.
The Schedule Manager opens and displays the Scheduler Configuration
page and the following information:

Menu Options Description or action…


Home Opens the Home page.
Log Displays diagnostic log messages.
Server Status Opens the Server Statistics page where you can view
information about the server.
Solr Admin Prompts you to login into the Solr administration server.
Use this administration server to troubleshoot issues with
the search index.
Configuration Opens the Server Configuration page where you can
change login credentials and view logs.

Buttons Used to…


Add Job Create a new Job.
Copy Job Copy an existing Job.

50 6 Schedule Manager Configuration


Columns Description or action…
Job Jobs currently defined for your organization.
Action Click:
Start to start the scheduled execution of the Job. If your
schedule is Manual, you must use Start to start the
execution of the Job.
Stop to stop the scheduled execution of the Job.
Schedule Information about the schedules defined for the Jobs.
Next When the next Job execution is scheduled.
Last Message Information about the last action performed.
Warning Number of issues that occurred during the execution of the
Job. See the log file for details.
Errors Errors that data items were missing and the item was not
processed.
Remove Click X to delete the Job from the list.

Changing the Administrative


User Name and Password
After running Schedule Manager the first time, and before using the Schedule
Manager, the system administrator should change the default User Name and
Password to meet the company’s security requirements.

To change the Administrative User Name and Password:


1 Log into the Schedule Manager using the default credentials admin and
admin and select Configuration from the top-level menu.
2 On the General tab, enter a new User Name and Password and click
Save.

Jobs and Workflows


Jobs are used to collect (ingest) data for the search service and provide
content for aspenONE applications. Jobs must include:
 A Primary Workflow
 At least one additional Task
 A Schedule
A Primary Workflow is used to start a Job. In addition, you can add other
Tasks that you want a Job to perform.
To create Jobs, you must:
 Define a Job
 Configure the Primary Workflow for the Job
 Add and configure additional Tasks for the Job

6 Schedule Manager Configuration 51


 Modify the Schedule
The following sections provide information about adding Jobs, Primary
Workflows, and Tasks for aspenONE Simulations, Process Explorer, and PIMS
Platinum.

Creating a Job for aspenONE Simulation


Services
To create a Job:
1 From the Scheduler Configuration page, click Add Job. The Job Name
field and Job list opens.
2 Enter a Job Name and select File Scanner from the Job list.
3 Click Add Job next to the Job list. The new Job appears at the end of the
Job column.
4 Click the white arrow to the left of Primary Workflow. The Primary
Workflow section expands.

To configure a Primary Workflow for a File Scanner Job, enter the following
values:

For… Do the following…


Files/Directories Enter a shared network folder to be scanned and
(required) indexed. For example:
\\NetworkComputer\ModelProjects.
Note: Add the Installation Administrator to the file
share with read access.
Include Patterns Enter a wildcard * pattern to include all files.
(required)
Exclude Patterns Enter a value for files that you want to exclude
(optional) from the scan and indexing.
Subdirs Check if you want the scan to include all
(optional) subdirectories under the directory you specify for
Files/Directories.
Compressed Files Check if you want the scan to check for files within
(optional) a .zip file.
Max file size (MB) Enter a value in megabytes for the maximum size
(optional) of the files you want processed. The default is
100MB.
Deletion Delay Set the Deletion Delay to the number of seconds
(optional) you want the system to wait before it deletes an
item that was not successfully scanned from the
index.
Although this option is not required, you should
use this option if you run your scanning Jobs
frequently.
Document Logging Count Enter a value for an optional Document Logging
(optional) Count. This is not required, but setting a value

52 6 Schedule Manager Configuration


For… Do the following…
reduces the amount of data written to the Job log
file.
Specifying a value configures the frequency that
the number of documents processed is updated.
If it is left blank, the document count is
incremented for every document processed, which
will be logged in the log file (this is only 1 line per
file).
If any number except 1 is configured, the
document count is written to the log file in the
desired increment.
The value 1 is special. If the Document Logging
count is set to 1, the name of the file that was last
processed is logged in the log file instead of the
document count.
Database Name Enter a unique name for the database to be used
(required for incremental to track the documents scanned by this scanner.
scans) The scanner creates and maintains the database.
Note: This option is required for incremental
scanning. Without the database, all files are
scanned again.
Username Enter the name of the user who can access the
(optional) database. Do not include spaces in the name.
Password Enter the password of the user who can access the
(optional) database. Do not include spaces in the name.

3 Click the white arrow next to Primary Workflow to close that section.
4 Click Save next to Job Name to save the Job and Primary Workflow
configuration.

Adding and Configuring Additional Tasks


for aspenONE Simulation Services
An aspenONE Job can include multiple Tasks. If the Job has additional Tasks
other than the Primary Workflow, an expandable white arrow with a blue
background appears to the left of the Tasks label. For aspenONE Simulation
Services, you must configure additional Tasks for:
 Build Aspen Search Publish URI{ XE "Additional tasks:Build Aspen
Search Publish URI" }
 Fetch URI{ XE "Additional tasks:Fetch URI" }

To add and configure these Tasks:


1 From the Scheduler Configuration page, click the + icon to the left of
the Job name to expand the Job.
Note: If you just created a Job, the Job expands automatically.
2 Click Add next to Tasks. The Tasks list opens.

6 Schedule Manager Configuration 53


For… Do the following…

File Scanner Select Build Aspen Search Publish URI


and Fetch URI from the list and click
Select.
The File Scanner workflow uses these Tasks
to scan files.

Note: Use CTRL and click an item to add one or more items or use SHIFT to
select a range of items.
After you click Select, these two Tasks appear in the Tasks list:
 Build Aspen Search Publish URI
 Fetch URI

Notes:
 Make sure that Build Aspen Search Publish URI comes before Fetch
Uri in the list of Tasks.
 You can drag these Tasks to put them in the correct order.
3 Click the white arrow to expand the Build Aspen Search Publish URI
Task section. For a standard deployment, accept the default values for all
the fields.
4 Click the white arrow to expand the Fetch URI Task section.
5 Accept the default value for Source Field Name and enter the User
Name and Password for the installation administration account. For
example, corp\AspenAdmin for Username and Admin765 for
Password.
6 Click the white arrow next to each Task to close the section.
7 Click Save next to Job Name to save the Tasks configuration.

Creating a Job for aspenONE Process


Explorer and aspenONE PIMS Platinum
To create a Job:
1 From the Scheduler Configuration page, click Add Job. The Job Name
field and Job list opens.
2 Enter a Job Name and select Data Source Request from the Job list.
3 Click Add Job next to the Job list. The new Job appears at the end of the
Job column.
4 Click the white arrow to the left of Primary Workflow to expand the
Primary Workflow section.

For… Do the following…


Data Source Enter a url for the data source scans.
URL

54 6 Schedule Manager Configuration


For… Do the following…
For aspenONE PIMS Platinum:
Enter the following data source url for the PIMS Platinum server:
http://localhost/AspenTech/PIMSPlatinum/api/search/refresh
For aspenONE Process Explorer:
Enter the following fully qualified Process Explorer Metadata URL to use
for the scans, where <servername> is the fully qualified name of the
aspenONE Process Explorer server:
For example:
http://Acme.Plant1.com/DispatchService/Metadata/Dispatch.svc
This url includes the following relative HTTP path on the Process
Explorer Server:
/DispatchService/Metadata/Dispatch.svc
This path is set during the installation and AspenTech recommends that
you do not change this path. If you do change the path, you must
update the url.
HTTP Request Select GET for the method to use for the HTTP request.
Type
Post Content Select None. This field is not used for the GET method.
Type
Multiple Leave this field blank. This information is not required for the GET
Delimiter method.
Username Enter the username used to connect to the remote system.
Password Enter the password used to connect to the remote system.
Schedule Enter the url of the machine where Schedule Manager is installed and
Manager URL running.
For aspenONE Process Explorer and aspenONE PIMS Platinum:

Enter the following to verify that the Schedule Manager url correctly
references the machine where the Schedule Manager is running:

http://localhost:8080/AspenCoreSearch/publish

Note: Schedule Manager is installed on the same machine as the


Apache Tomcat server if integrated with aspenONE.
Receiving Job Enter the name of the Job waiting to receive the data coming from the
Name data source you specified for Data Source URL.
5 Click the white arrow next to Primary Workflow to close that section.
6 Click Save next to Job Name to save the Job and Primary Workflow
configuration.

Configuring Additional Tasks for aspenONE


PIMS Platinum and Process Explorer
An aspenONE Job can include multiple Tasks. If the Job has Tasks other than
the Primary Workflow, an expandable white arrow with a blue background
appears to the left of the Tasks label. For aspenONE Process Explorer and
aspenONE PIMS Platinum, you must configure a Process Data Source

6 Schedule Manager Configuration 55


Request Results{ XE "Additional tasks:Process Data Source Request
Results" } Task.

To add the Task:


1 Click Add next to Tasks. The Tasks list opens.
2 Select Process Data Source Request Results from the Tasks list and
click Select to add this Task. The Process Data Source Request
Results Task appears in the Tasks list.
3 Click the white arrow next to this Task to expand the Process Data
Source Request Results Task section.

For… Do the following…


Publish URL Enter a url to publish the items that were
detected as deleted.
Default Item Type Accept the default. ASPEN_FILE. This is the
Item Type to use if Item Type is not specified in
the return data.
Publish Username This is provided automatically if basic
authentication is required. Do not change.
Publish Password This is provided automatically if basic
authentication is required. Do not change.
Deletion Delay (seconds) Set the Deletion Delay to the number of
seconds you want the system to wait before it
deletes an item that was not successfully scanned
from the index.
You should use this option if you run your
scanning Jobs frequently.
DatabaseName Enter the unique name of the database used to
(required for incremental track the items being serviced by this workflow.
scans)
Username Enter the user name used to access the database
(optional) specified in the Database Name field.
Password Enter the password used to access the database
(optional) specified in the Database Name field.

4 Click the white arrow next to the Task to close the Tasks section.
5 Click Save next to Job Name to save the Task configuration.
After adding a Job, Primary Workflow, and Task, you should modify the
Schedule for the Job.

56 6 Schedule Manager Configuration


Modifying a Schedule
When you first create a Job, the default Schedule is Manual. After
configuring the Primary Workflow and adding Tasks, you should modify the
schedule to meet your requirements.

To modify a schedule:
1 From the Scheduler Configuration page, click  next to the Job whose
schedule you want to modify.
2 Click the white arrow to the left of Schedule to expand the Schedule
section.
Enter the values for the schedule.

For… Do the following…


Frequency Select:
 Manual to run the Job manually.
 One Time Only to run the Job once.
 Every and select a value and a unit. For example, if you want the Job
to run every hour, select 1 from the first drop-down list and Hour
from the second drop-down list.
 Enter a custom cron expression. Click the link cron expression for
more information.
Starting Enter the date on which you want the Job to start running.
Date
Starting Select the time when you want the Job to run.
Time

Note: For Jobs with a Manual schedule, you must use Start in the
Action column to start the Job.
3 Click Save next to Job Name to save the Job configuration.

Deleting a Job
From the Scheduler Configuration page, click X in the Remove column
next to the Job you want to delete from the system.

Note: A Job cannot be restored after you delete it.

Viewing Logs for Troubleshooting


To view the log file:
From the Scheduler Configuration page, click Log in the top-level menu.
The Log Viewer opens and displays information about Job scheduling,
Tasks, and system messages.

You can customize the following information to display:

6 Schedule Manager Configuration 57


 Number of log lines to display. You can select 100, 1000, or 10000
lines to display.
 Log type to display.
o Scheduler displays log information about Job scheduling.
o Task displays log information for the individual Tasks and system
messages.
 A specific log file to view. The file name selector provides a list of
available relevant files when more than one log file is currently available.

Changing the Logging Levels


To change logging levels:
1 From the Scheduler Configuration page, click Configuration in the
top-level menu. The Server Configuration page opens.
2 Click the Logging tab. The Server Configuration page expands and
displays information about a Logger or Category.
3 Use the sliders to select a level and to make changes to the running log
configuration of the server. After you make a change, click Save.
4 You can also change the startup running logger configuration by modifying
the logging.xml file located in the appdata directory of the Tomcat
installation.

Note: The necessary specifications to modify the log configuration file are at:
http://wiki.apache.org/logging-log4j/Log4jXmlFormat

Checking the Server Statistics


From the Scheduler Configuration page, click Server Status in the top-
level menu. The Server Statistics page opens and displays details about the
server.
The Server Statistics information might be requested by technical support if
there are problems with the system.

58 6 Schedule Manager Configuration


7 Troubleshooting

This chapter contains:


 Information that may help you if you have problems installing
 Information to handle error messages

Common Problems
The following is a list of considerations to help solve installation problems.
 License file is not installed on the computer.
 Pre-requisite software has not been installed
 No local administrative rights to your computer.
 Cannot read the DVD.
 Windows Registry is corrupted.
 Insufficient rights to servers and/or various folders.
 Network inoperable.
 Incorrect license file for software being installed.
 Hard drive is full.
 Not enough space in the “temp” directory.
 Incorrect operating system.

Error Messages
Registry Settings
Errors associated with registry settings are usually due to insufficient rights
for changing those settings. You must have administrative privileges on the
computer you are installing on in order to change registry settings.

Firewall Settings
Messages that appear during installation related to firewall restrictions should
be directed to your IT department due to individual company policies
regarding application installation and security.

7 Troubleshooting 59

You might also like