Professional Documents
Culture Documents
AspenAtOMSV12 Inst
AspenAtOMSV12 Inst
Installation Guide
Version Number: V12
October 2020
Copyright (c) 2020 by Aspen Technology, Inc. All rights reserved.
Aspen Tank and Operations ManagerTM, Aspen Tank and Operations Manager BrowserTM , and Aspen Operations
Reconciliation and AccountingTM, 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.
2 Overview ..............................................................................................................3
aspenONE Overview ......................................................................................... 3
aspenONE Media .............................................................................................. 4
Licensing ......................................................................................................... 4
SLM License Server ................................................................................ 5
Localization ..................................................................................................... 6
Accessing aspenONE Documentation .................................................................. 6
Aspen Manufacturing Suite Overview .................................................................. 7
Tank and Operations Manager Features and Subfeatures Overview ........................ 7
Installation Overview ........................................................................................ 9
System Requirements ....................................................................................... 9
Pre-Installation Checklist ................................................................................... 9
Checking Installation Account Privileges .................................................. 10
Contents iii
Upgrading the Tank and Operations Manager Database ....................................... 42
Upgrading a database from a previous version ......................................... 42
7 Aspen Tank and Operations Manager Server Post Install Configuration .............51
Configure Aspen Operations Reconciliation and Accounting ODBC Source .............. 51
MSSQL Specific ODBC configuration ........................................................ 53
Oracle specific ODBC configuration ......................................................... 56
Configure Tank and Operations Manager Workstation ......................................... 58
Configure AtOMS and AORA ADSA Sources for AtOMS Browser ............................ 65
To create an ADSA source to AtOMS and AORA: ....................................... 65
Configure Real-Time ADSA Source.................................................................... 74
Configure Tank and Operations Manager Monitors .............................................. 80
Tank and Operations Manager Movement Monitor Service ......................... 80
Tank and Operations Manager Tank Monitor Service ................................. 84
Restarting Tank and Operations Manager Monitors ................................... 88
8 Aspen Tank and Operations Manager Viewer Post Install Configuration ............91
Configure Tank and Operations Manager Viewer ................................................. 91
Tank and Operations Manager Viewer Web ........................................................ 94
Grant User Trust and Permission to Run the XBAP .................................... 94
Configure mMDM for Aspen Tank and Operations Manager XBAP Database
Support .............................................................................................. 96
Access Aspen Tank and Operations Manager XBAP from IE ........................ 98
Permission Errors Troubleshooting .......................................................... 99
9 Aspen Tank and Operations Manager Importer Post Install Configuration .......101
Configure Aspen Tank and Operations Manager Importer .................................. 101
10 Aspen Tank and Operations Manager Tank Calculator Post Install Configuration105
Configure Aspen Tank and Operations Manager Tank Calculator ......................... 105
iv Contents
12 Aspen Tank and Operations Manager Client Post Install Configuration ..........119
Configure Aspen Operations Reconciliation and Accounting ODBC Source ............ 119
MSSQL Specific ODBC configuration ...................................................... 121
Oracle specific ODBC configuration ....................................................... 124
Configure Tank and Operations Manager Config for Client ................................. 126
Update Firewall Settings in the Server Machine ................................................ 132
17 Troubleshooting .............................................................................................147
AspenTech Support ...................................................................................... 147
Operations Accounting Interface Troubleshooting ............................................. 147
“Warning: No Aspen Operations Reconciliation and Accounting Connect server
specified.” ......................................................................................... 147
“Could not connect to Aspen Operations Reconciliation and Accounting Model
xxxxxx.” ........................................................................................... 148
18 Prerequisites ..................................................................................................151
Creating an Oracle Database ......................................................................... 151
Oracle Client Installation ..................................................................... 152
Server Installation .............................................................................. 155
Database Configuration ....................................................................... 160
Installation Check .............................................................................. 161
Contents v
Appendix A – Configuration Files ........................................................................163
AspenTech.MSC.Settings.xml File ................................................................... 163
Example of AspenTech.MSC.Settings.xml File ........................................ 163
vi Contents
Contents vii
1 Introduction
Overview
Aspen Tank and Operations Manager, formerly known as AtOMS, is included
in the Aspen Manufacturing suite of products. The instructions in this guide
focus solely on installing Aspen Tank and Operations Manager as a single part
of an integrated solution. The instructions do not address the installation
instructions for the entire suite or industry solution.
Note: For information about Aspen Industry Solutions, see the aspenONE
Deployment Guide document.
Related Documentation
A number of documents have been produced to assist users to learn and use
Aspen Tank and Operations Manager applications. The documentation set
consists of the following:
Manuals
o Aspen Tank and Operations Manager Release Notes
o Aspen Tank and Operations Manager Integration User Guide
o Aspen Operations Reconciliation and Accounting Installation Guide
o Aspen Operations Reconciliation and Accounting Integration User
Guide
1 Introduction 1
o Aspen Data Source Architecture Installation Guide
o Aspen Framework Server Installation Guide
o Aspen InfoPlus.21 Product Family Installation Guide
o Aspen InfoPlus.21 Product Family Configuration Guide
o Aspen Local Security Installation Guide
Help Files
o Aspen Tank and Operations Manager Help
o Aspen Tank and Operations Manager Browser Help
o Aspen Tank and Operations Manager – Admin Tool Help
o Aspen Operations Accounting Connect Help
Technical Support
AspenTech customers with a valid license and software maintenance
agreement can register to access the online AspenTech Support Center at:
https://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.
2 1 Introduction
2 Overview
This chapter provides an overview of the Aspen Tank and Operations Manager
software including the installation requirements and process. It includes the
following:
aspenONE Overview
Aspen Manufacturing Suite Overview
Aspen Tank and Operations Manager Features and Subfeatures Overview
System Requirements
Pre-Installation Checklist
aspenONE Overview
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. AspenTech
customers are better able to increase capacity, improve margins, reduce
costs, and become more energy efficient.
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.
Predictive and prescriptive analytic products in the aspenONE Asset
Performance Management 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.
2 Overview 3
aspenONE Media
Unless you have specifically requested a USB drive, you will receive
instructions on how to download the aspenONE media.
Download the media that you are entitled to and extract the zip file(s) using a
zip extractor such as WinZip/7-Zip. You may choose from the following:
Aspen Engineering – includes all Aspen Engineering products, Aspen
PIMS and Aspen Administration and Licensing components.
Aspen Manufacturing and Supply Chain – includes all Aspen
Manufacturing products, Aspen Petroleum Supply Chain products,
aspenONE Supply Chain Management products, GDOT, and aspenONE
Infrastructure products as well as Aspen Administration and Licensing
components.
aspenONE Asset Performance Management – includes all APM
products.
aspenONE Software License Manager includes all Aspen
Administration components (Aspen SLM, Aspen SLM tools, and ALC Auto
Upload Tool).
Note: The product Release Notes and Installation Guides are included in the
Documentation sub-folders under each family of products. There is a link to
the Getting Started Guide on the Install Browser.
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.
Aspen License Deployment Assistant (ALDA): ALDA is a utility that will
update a license server with the necessary licenses needed for a new
release without having to send a new license key for applicable suites and
qualified customers. For qualified customers, ALDA is available on the
electronic software download site.
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 the products for which you are licensed is sent
separately from the software shipment.
You will have access to one or more of the following:
o aspenONE Token Media – 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
4 2 Overview
agreement, use this media. Software installed from the aspenONE
Token media requires run-time token-based license keys.
o aspenONE Standard Media – 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 media
labeled Standard. Software installed from the aspenONE Standard
media requires older license keys that have been in use since the
aspenONE 2004 release.
Notes:
If you do not have the updated token-based license file, please contact
AspenTech Customer Support.
We have seen issues extracting large zip files on earlier versions of
Windows. If you do not have access to an extractor, you may use the zip
extractor utility on the Download Center.
If you have an MSC perpetual license purchased prior to 2011 and are
entitled to Informatica upgrades, you can download the Informatica
software from the Download Center.
Some products previously available on CD-ROM or DVD are not included.
If you do not find a product, please contact AspenTech Support at
https://support.aspentech.com.
2 Overview 5
Localization
The V12 release media includes all localized products that are available when
V12 is released. The Knowledge Base article #000093657 contains a
spreadsheet that identifies which products are localized and how to access the
localization.
Accessing aspenONE
Documentation
There are several ways to access Product Help files and context-sensitive Help
(these are available depending on the type of application):
Clicking the Help button.
Pressing F1 while in the application.
Accessing the application’s Help menu.
Clicking a Help icon. For example:
6 2 Overview
Aspen Manufacturing Suite
Overview
AMS applications deliver production dispatching, production execution,
historical data management, advanced control, inferential modeling, process
analysis and monitoring, production tracking, and quality management
services for manufacturing environments.
2 Overview 7
Feature Subfeature Description Notes
8 2 Overview
Feature Subfeature Description Notes
server computer.
Aspen Web Server An aspenONE application. It Aspen recommends
is available from within the that you install to the
aspenONE MES web server. server computer.
Installation Overview
Aspen Tank and Operations Manager can be implemented as a stand-alone
application or as part of the refinery automation suite of products that may
include planning (Aspen PIMS), scheduling (Aspen Petroleum Scheduler),
real-time acquisition (Aspen InfoPlus.21), material balance and reconciliation
(Aspen Operations Reconciliation and Accounting), and LIMS systems.
System Requirements
For the most up-to-date hardware and software requirements that must be
met in order to install AspenTech products, refer to the following website:
https://www.aspentech.com/platform-support/
Important: You must have administrator privileges to carry out a Tank and
Operations Manager installation.
Pre-Installation Checklist
Before installing Aspen Tank and Operations Manager, refer to the following
checklist to ensure a smooth installation.
2 Overview 9
Obtain name/IP address of the Aspen Software License
Manager (SLM) server.
Confirm that the Aspen Software License Manager
service is installed and running. For more information
about the Aspen Software License Manager, refer to the
Aspen Software License Manager (SLM) Installation and
Reference Guide.
If you have an aspenONE license, verify that Aspen
Framework (AFW) or Aspen Local Security is installed
and running. For more information, refer to the Aspen
Framework Server Installation Guide.
10 2 Overview
3 Installing Aspen Tank and
Operations Manager
Purpose
This chapter explains how to install the current version of the AMS products.
This installation assumes that you do not currently have Aspen Tank and
Operations Manager installed on your computer.
Overview
The AspenTech Installer can guide you through the installation of a single
product as well the installation of a group of products that are integrated to
provide industry solutions. This manual describes the installation of Tank and
Operations Manager within the AspenTech AMS family of products.
Server Install
Using the Server Install, it is possible to install either the Tank and
Operations Manager Server components and/or the Tank and Operations
Manager Client components.
Standard Install
Using the Standard Install, it is possible to install only the Tank and
Operations Manager Client components.
Install remaining
Tank and
Operations Manager
clients
Note: Some intermediate steps have been omitted for simplicity, such as the
installation and configuration of other related products such as the database
repository, the Aspen Framework, and InfoPlus.21. These will be explained in
detail later.
Granular Downloads
aspenONE V12 includes the ability to download some individual
products/product families that can be used independently of a full
suite. These sub-components are referred to as granular downloads. The
granular downloads are used to provide smaller downloads in situations where
customers only need a specific product/product family. If more than one
granular download is needed, it is recommended that the entire suite is
downloaded because it may take less time overall as opposed to downloading
two or more sub-components.
V12 Engineering (ENG): In the case of the ENG media, users can download
the entire suite or one of the items listed under the ENG group:
Aspen Economic Evaluation
Aspen Exchanger Design and Rating with Aspen Properties, Aspen
Simulation Workbook and Aspen Version Comparison Assistant
Aspen Simulation Workbook
Aspen Multi-Case Analysis
Aspen Cim-IO & Process Data*
*The Cim-IO & Process Data software is from the Manufacturing & Supply
Chain suite and is useful for customers deploying a 3rd party historian and is
included for convenience. Note: The Aspen Cim-IO & Process Data software is
not a part of the overall Engineering suite download, and only available as a
separate download.
Note: Before you begin installation, you will want to review the Release
Notes and print copies of the Installation Guides for products that will be
installed. Those documents are included under each suite’s folder on the
media in your package.
Note: If patches are available for the product that you are installing, a screen
may appear that lets you view the patches before you install. You will also
have an opportunity to view the updates after you finish the installation
process.
The AspenTech Suite selection screen appears. The screen you see varies
depending on how you are accessing the Aspen Tank and Operations Manager
installation.
Notes:
Be sure that the SLM license server or standalone license is available prior
to installation. SLM tools are automatically installed when installing
aspenONE products.
Click Install aspenONE Products.
Select I accept the terms of the agreement and click Next to continue.
Note: You can add Aspen Plant Operations Family features later by starting
the installation process again, choosing Install aspenONE Products and
selecting the features available on this product selection screen.
File Location
Notes:
Prerequisite Validation
2 All options will be checked by default - unselect any that you do not want
installed automatically and then click Install.
When Install is selected, PowerShell windows will appear that perform
the install and/or configuration for the specified prerequisites. When the
install and/or configuration steps are done, you will see the Install
Prerequisites window again.
3 Click “x” to close the window and return to the installation process.
An option is available to specify buckets. If you use buckets, you can specify
them during the install or later using the SLM Configuration Wizard. Also,
when Resolve server name is checked, the fully qualified server name is
used in the registry. If you use aliases, you can uncheck this setting.
Note: Specify your Aspen Framework Security server name, or you can
specify the server name in the Security Server URL row in AFW Tools later.
Important: The Product Selection dialog box displays the space required
to install the products you have selected. If there is not enough space on the
destination disk to install all the products you have selected, a warning
message appears. You can choose to install anyway, and the installation
program installs as many of the products that you selected as possible.
After you have installed the Aspen Tank and Operations Manager (Tank and
Operations Manager) software, it is recommended that you perform the
following configuration steps.
This chapter describes the tasks you can perform from the Aspen Database
Wizard utility such as the creation or upgrade of an Aspen Tank and
Operations Manager database.
Oracle Connection
o In the Data Source: box, enter an existing server name with which to
connect to the Oracle database.
o Select the Use Windows NT Integrated Security option if you want
to use NT operating system authentication to access the Tank and
Operations Manager database.
Note: To access an Oracle database using Windows NT integrated
security, you must install additional Oracle software for NTS
authentication on the Oracle client and database. For more information,
see http://www.oracle.com.
Or
o Select the Use a specific user name and password option to use
database authentication to access the Tank and Operations Manager
database. If you choose this option, enter the User name and
Password of the relational database user (i.e., system administrator or
database administrator) and check the Allow saving password
option.
Notes:
Connection Tab for SQL Server on Data Links Properties dialog box
8 Click Close at the Creating the database dialog box indicating that the
Tank and Operations Manager database was successfully completed.
3 Confirm that the Tank and Operations Manager tables and objects have
been created in the same instance where Aspen Operations Reconciliation
and Accounting resides. Use the respective MSSQL or Oracle Enterprise
manager tool to verify this. For example, the SQL Server Enterprise
Manager will show the Tank and Operations Manager tables in the Aspen
Operations Reconciliation and Accounting.
Database Wizard
1 After the post-install restart of the Tank and Operations Manager server,
open the Aspen Database Wizard (Start | Programs | AspenTech |
Common Utilities | Aspen Database Wizard). Click Next on the Aspen
Database Wizard dialog box.
4 Read the Connect to the database message box to determine the type
of database provider and database server you want to use to upgrade
your Tank and Operations Manager database. Click Next.
Note: To create a new Tank and Operations Manager database, see the
“Creating a New Tank and Operations Manager Database” subsection in
this chapter for details on choosing the Create the
database/tablespace, users and database and Create database
objects in an existing database options.
5 Go to the “Creating a New Tank and Operations Manager Database”
subsection in “Creating or Upgrading an Aspen Tank and Operations
Manager Database.” The upgrade dialog boxes from this point are the
same as the first-time installation dialog boxes.
The Aspen Framework (AFW) or Aspen Local Security (ALS) provides the
framework for Aspen Tank and Operations Manager security. Both AFW and
ALS use the AFW Security Manager to configure Aspen Tank and Operations
Manager security. For ALS, the AFW Framework Security Manager is located
on the computer where ALS is installed. For Aspen Framework Security, the
AFW Framework Security Manager is located on the Framework server.
4 Browse to locate the directory where Tank and Operations Manager was
installed. Then select the following XML files under the Scripts folder, for
import:
o Aspen Oil Movement Shipping Admin.xml
o Aspen Oil Movement Shipping.xml
5 Verify that the information on the summary is correct and then click Test
Data Source to reconfirm that the information entered connects to the
desired database. If successful, then click OK to exit out of the
configuration.
3 Click the Server tab to specify and define the contents of OLE DB UDL file
that will be used to obtain connect information to your Tank and
Operations Manager database. If the text box File is empty, click the
browser button to select the path and file name of the UDL file. The Data
Link Properties dialog box appears. We recommend selecting the path to
the folder where Tank and Operations Manager was installed and
AtOMS.udl as the filename, but any path or name will work. After the
filename has been selected and shows in the textbox, click Properties to
bring up the Data Link Properties dialog box, which is used to configure
the Tank and Operations Manager Data Source.
4 Click the Provider tab and select the native OLE DB provider specific to
your database and then click Next. The following dialog box depends on
the Provider selected.
5 For Microsoft OLE DB Provider for SQL Server: in the Select or enter
a server name field, enter the name of the server where your Tank and
Operations Manager database is located, and choose the authentication
method to access your database in the section Enter information to log
6 For Oracle Provider for OLE DB, the following dialog box is brought up.
Enter in Data Source the name of the local TNS service that connects to
7 Click OK to leave the Data Link Properties box and return to the Aspen
Tank and Operations Manager dialog box. At this point you could click
Accept to save the configuration made until this point, as seen in the
following figure.
9 Click the Debugging tab; in here you will define whether diagnostic
messages should be output from the Client application and their level of
detail.
10 Select the Debug Level from the list proposed and then click Accept to
save your choice.
11 Click Exit to terminate the Tank and Operations Manager Configuration
application.
AtOMS Configuration allows you to provide the Aspen Tank and Operations
Manager applications with the necessary information to access both the
Aspen Operations Reconciliation and Accounting data and the Aspen Tank
and Operations Manager database.
3. Enter the required fields.
Reconciliation Basis field:
o Temperature: Standard conditions for temperature to define the
standard reference conditions to express the volumes of gases and
liquids. Used to calculate the tank gauge. You can use 15°C, 20°C, or
60F.
o Operating unit of measure: Defines whether Aspen Tank and
Operations Manager uses Volume or Mass for movements.
Fraction Gauge – Use Fractional Gauge to measure the tank inventory.
Inventory fractional gauge readings are entered for Inventory Fractional
Gauge instruments. The reading is entered as a gauge height in feet,
inches, and fractional inches. The reading is used to calculate the gross
volume of material in a tank from a strapping table.
o Normalize Fractions: Use normalize fractions in the system.
o Scale precision: When using Fractional Gauges, enter the scale in
fractions of an inch used. If using Decimal gauges, select None.
Timeline: A timeline of the restore operations performed on the
database.
Advanced Options:
o Disable Stop Gauge: If you check Disable Stop Gauge, the Stop
Gauge Source field is disabled in the Movement Detail View. If you
uncheck Disable Stop Gauge, the Stop Gauge Source is enabled in
the Movement Detail View.
2 Click the Configuration tab and click Public Data Source. The Aspen
Public Data Source dialog box appears.
Note: AtOMS only allows to configure one public data source in ADSA. If
there are multiple entries in ADSA, AtOMS Browser will not provide
specific data source while making request, so AtOMS Browser may not
work properly.
4 Click Add…, the Add Service dialog box appears.
11 Click the Configuration tab and click Public Data Source. The Aspen
Public Data Source dialog box appears.
If we were using PI as the real-time data, then the ADSA services configured
in our ADSA source entry would look like this:
2 Click the Configuration tab and then click Public Data Source. The
Aspen Public Data Source dialog box appears.
3 Select the data source which is named as machine name, and then click
Edit….
5 Select the required services and click OK, the Service Properties dialog
box appears, where the Service refers to the service you select to add.
Configure each service in the Service Properties dialog box and then
click OK.
The following services should be added and configured, each service
should be added and configured one by one:
Note: If you have the IP.21 server installed on the same machine, these
services will be added automatically.
o Aspen DA for IP.21
6 Click OK to close the ADSA Properties dialog box. And then launch the
Aspen Operations Accounting Connect by clicking Connect (AORA) from
the Start menu.
7 Click AtOMS | Service Monitor, and in the RTDB Server: field, enter
the public data source name added in ADSA.
Configuration Steps
1 Use the shortcut created in Start | All Programs | AspenTech | Aspen
Manufacturing Suite | Aspen Tank and Operations Manager |
Monitors | Configure Movement Monitor. The dialog box titled Aspen
Tank and Operations Manager Movement Monitor will be shown:
Click Get Stat to obtain the latest movement monitoring status information.
OK status indicates that the connections to the application server and real
time database server are successful.
Refer to the Aspen Operations Accounting Connect Help for more details
about the Movement Monitor window.
Configuration Steps
1 Use the shortcut created in Start | All Programs | AspenTech | Aspen
Manufacturing Suite | Aspen Tank and Operations Manager |
Monitors | Configure Tank Monitor. The dialog box titled Aspen Tank
and Operations Manager Tank Monitor will be shown:
Click Get Stat to obtain the latest tank monitoring status information. OK
status indicates that the connections to the application server and real time
database server are successful.
Refer to the Aspen Operations Accounting Connect Help for more details
about the Tank Monitor window.
If you have configured it before, then this warning dialog will not appear
any more in future. You can skip step 2 and go to step 3 directly.
2 Press OK. The following configuration dialog appears to allow you to
configure relative information:
Note: Aspen Tank and Operations Manager Viewer Web (XBAP) only supports
Microsoft SQL server in V12.
You have to configure XBAP before using XBAP. The whole configuration
procedure includes the following two steps:
Grant User Trust and Permission to Run the XBAP
Configure mMDM for Aspen Tank and Operations Manager XBAP
Database Support
100 8 Aspen Tank and Operations Manager Viewer Post Install Configuration
9 Aspen Tank and Operations
Manager Importer Post
Install Configuration
Perform the following configuration steps to finish configuration for Tank and
Operations Manager Importer after the aspenONE, EIF and ODM installation
and creation of the Tank and Operations Manager database.
9 Aspen Tank and Operations Manager Importer Post Install Configuration 101
Operations Accounting
o Server – the server with which to connect to the Aspen Operations
Accounting database.
o Database – the database on the selected server.
o Integrated Security – check box to enable Windows authentication.
o User – the user name with the permission to access the database.
o Password – the password specific with the user name.
Tank Ops. Manager
o Server – the server with which to connect to the Aspen Tank and
Operations Manager.
o Database – the database on the selected server.
o Integrated Security – check box to enable Windows authentication.
o User – the user name with the permission to access the database.
o Password – the password specific with the user name.
ODM Domain – The domain name used to retrieve mappings between
alias names and canonical IDs in the ODM database.
Interface Name – The application name for the user in audit table.
Message Topic – The topic in the Windows Service Access.
Interface Id – A numeric value representing this application. It is used in
different tables as an identity of this application.
Volume Attribute Id – If measurement type is mass and this setting is
enabled, it will create a movement attribute based on the setting value. If
the value is invalid, no movement attribute is created.
Mass Attribute Id – If measurement type is volume and this setting is
enabled, it will create a movement attribute based on the setting value. If
the value is invalid, no movement attribute is created.
Vessel Attribute Id – This is a default movement attribute to be created
regardless measurement type if this setting is enabled. If the setting value
is invalid, no movement attribute is created.
102 9 Aspen Tank and Operations Manager Importer Post Install Configuration
Epsilon Precision – A threshold value to determine if a coming value
should be ignored or not. Only a value greater than the setting value will
be accepted.
Tank Area Overriding – The area of the source tank is assigned as the
area of the movement if this flag is true. Otherwise, the area of the
destination tank is used as the area of the movement.
Note: Tank Area Overriding applies to tank-to-tank movements only.
Ignore Gas Movements – Movements of gases are ignored when this
check box is selected.
Persist Batch Id – The batch ID is saved when this check box is
selected.
Ignore Non-Tank Movements – The movement is ignored if no tanks
are involved if this check box is selected.
Delete Pending Movements – The pending movements are deleted if
this check box is selected. Otherwise they are updated.
Notes: The fields with asterisk (*) must be configured. Others are
optional.
9 Aspen Tank and Operations Manager Importer Post Install Configuration 103
104 9 Aspen Tank and Operations Manager Importer Post Install Configuration
10 Aspen Tank and
Operations Manager Tank
Calculator Post Install
Configuration
Perform the following configuration steps to finish configuration for Tank and
Operations Manager Tank Calculator after the installation and configuration of
Aspen Tank and Operations Manager and Aspen Operations Reconciliation and
Accounting.
10 Aspen Tank and Operations Manager Tank Calculator Post Install Configuration 105
o ConnectionString is the Aspen Operations Reconciliation and
Accounting connection information in the form of “DSNname,
username, password,”.
o LOG_LEVEL is the diagnostic message debug level. 255 is the
common value for most messages, zero means no messages.
o LOG_FILE is the path and name of the log file containing diagnostic
messages.
2. Open MS Internet Explorer, Click Tools on the Menu bar. From the
Tools drop-down list, select Compatibility View settings. Add Model
Server website to Compatibility View.
106 10 Aspen Tank and Operations Manager Tank Calculator Post Install Configuration
3. MS Internet Explorer, click Tools on the Menu bar. From the Tools
drop-down list, select Internet options. Under Security tab, select
Local Intranet. Click Sites to open Local intranet window, and add
http://<servername> to the zone.
10 Aspen Tank and Operations Manager Tank Calculator Post Install Configuration 107
4. From MS Internet Explorer, click Tools on the Menu bar. From the
Tools drop-down list, select Internet options. Under Security tab,
select Trusted sites. Click Sites to open Trusted sites window, and add
http://<servername> to the zone.
108 10 Aspen Tank and Operations Manager Tank Calculator Post Install Configuration
5. Open the Aspen Tank and Operations Manager Tank Calculator Web client
page http://<AtOMSWebServer>/TankCalculator. Aspen Tank
Calculator opens.
10 Aspen Tank and Operations Manager Tank Calculator Post Install Configuration 109
110 10 Aspen Tank and Operations Manager Tank Calculator Post Install Configuration
11 Operations Accounting
Interface Post Install
Configuration
Note: If your site does not use Aspen Operations Reconciliation and
Accounting for daily data reconciliation, you can skip this section.
The Operations Accounting Interface is an optional Tank and Operations
Manager feature that reads tank and movement transactions from the Tank
and Operations Manager database to be used by the Aspen Operations
Reconciliation and Accounting (Operations Accounting) application. Those
readings are written on Operations Accounting’s import tables to be imported
to Operations Accounting’s data tables using the standard Operations
Accounting’s Connect utility which usually must be executed manually by the
Operations Accounting engineer. However, Operations Accounting Interface
can, if properly configured, execute automatically and remotely to Aspen
Operations Reconciliation and Accounting Connect.
The Operations Accounting Interface software is installed from the aspenONE
media whenever the Tank and Operations Manager sub-feature Interfaces is
selected during a standard or server installation of Tank and Operations
Manager.
The Operations Accounting Interface connects to both databases Aspen
Operations Reconciliation and Accounting and Tank and Operations Manager
and therefore it is ODBC and OLEDB compliant respectively.
This section will help you to decide how to adjust parameters inside the
Operations Accounting Interface to properly run this application.
Important:
The Operations Accounting model should be installed and a reference to
the Operations Accounting Connect application has to be made. If not
done before, go the Operations Accounting directory (normally
C:\Program Files\AspenTech\Advisor) and open (double-click)
IIAutoHist.exe. You may close this application immediately.
For the Operations Accounting Interface to function properly, you need to
launch Operations Accounting Interface Preferences page once and update
the settings.
Preferences Form
The Preferences dialog form allows you configure several Operations
Accounting Interface options.
2 Click on any of the blocks next to Grid, Font, or Error to bring up their
respective color palette from which you can either select a new color, from
the colors already available, or define your own custom colors.
Preventing Double
Compensation in Operations
Accounting Interface
When Operations Accounting Interface is configured to transfer integrator
volumes to Operations Accounting as explained in the Preferences form
earlier in this chapter, it needs to prevent double compensation on net
volumes transferred. In order to do so, Operations Accounting Interface
would need for you to supply:
The base temperature used in Operations Accounting volume
compensation
The units of measurement for %BSW in Operations Accounting
The units of measurement for density of liquids in Operations Accounting
Please locate the Property Config section in the
AspenTech.MSC.Settings.xml configuration file and enter all the parameters
indicated. See Appendix A for detailed information about the settings file
and the parameters defined within.
Note:
If a more current value exists, the data are not propagated. For
Movements and Cutoffs, Tank and Operations Manager uses the Event
Time for the comparison. For example, if an operator closes a movement
with an end time of 11:00, and then manually updates values, while the
tank current conditions are updated at 11:15, the data are not propagated
from the movement to the tank. Because the update time 11:15 of the
tank current conditions is more current than the Movement event time
11:00.
The instrument values are not propagated backwards in time. For example,
after the activation of a movement, the changes you make to the tank
current conditions are not propagated to the movement. And after the
tank cutoff, the changes you make to the tank current conditions are not
propagated to the tank cutoff.
Tank Current to Cut-Off Propagation ALWAYS occurs and does not require
a setting in AspenTech.MSC.Settings.xml file.
See Appendix A for detailed information about the settings file and the
parameters defined within.
The steps to properly configure an Aspen Tank and Operations Client after the
installation are:
1. Configure Aspen Operations Reconciliation and Accounting ODBC source
2. Configure Aspen Tank and Operations Manager Config
3. Update firewall settings in the Server Machine
1 Log on with the user account used to install Tank and Operations Manager
Client.
2 Invoke the Data Sources (ODBC) tool. Click Start | Settings | Control
Panel | Administrative Tools and click the ODBC Data Sources (32-
bit). The following screen will appear:
12 Aspen Tank and Operations Manager Client Post Install Configuration 119
3 Click Add. The Create New Data Source window displays all the ODBC
drivers available in your computer. Select the native driver for your
database. A native driver is a driver provided by the database
manufacturer. E.g.: Oracle for an Oracle database instead of the
Microsoft ODBC for Oracle. Click Finish to bring up the database
specific dialog box.
120 12 Aspen Tank and Operations Manager Client Post Install Configuration
Create New Data Source for Oracle
12 Aspen Tank and Operations Manager Client Post Install Configuration 121
122 12 Aspen Tank and Operations Manager Client Post Install Configuration
3 Select the Aspen Operations Reconciliation and Accounting database from
the Change the default database to drop-down menu.
5 Verify that the information on the summary is correct and then click Test
Data Source to reconfirm that the information entered connects to the
desired database. If successful, then click OK to exit out of the
configuration.
12 Aspen Tank and Operations Manager Client Post Install Configuration 123
Oracle specific ODBC configuration
1 For Oracle, a dialog box similar to the following will be shown. Enter the
corresponding data in the fields Data Source Name, Description, TNS
Service Name (database server name: port number/database sid or
database server IP address:port number/database sid), and User ID.
Note that the Source Name must be unique. For example:
124 12 Aspen Tank and Operations Manager Client Post Install Configuration
2 Click Test Connection to verify that the database connection with the
configuration entered is successful. You will be prompted to enter the
password of the User ID specified.
12 Aspen Tank and Operations Manager Client Post Install Configuration 125
Configure Tank and Operations
Manager Config for Client
This step primarily provides the Tank and Operations Manager applications
with the necessary information to access both the Aspen Operations
Reconciliation and Accounting data and the Tank and Operations Manager
database.
Start the Tank and Operations Manager Configuration Tool, see Chapter 7
Configure Aspen Tank and Operations Manager Config for specific
descriptions for each parameter:
Here, we directly use default values.
1 Click the Server tab to specify and define the contents of OLE DB UDL file
that will be used to obtain connect information to your Tank and
Operations Manager database. If the text box File is empty, click the
browser button to select the path and file name of the UDL file. The Data
Link Properties dialog box appears. We recommend selecting the path to
126 12 Aspen Tank and Operations Manager Client Post Install Configuration
the folder where Tank and Operations Manager was installed and
AtOMS.udl as the filename, but any path or name will work. After the
filename has been selected and shows in the textbox, click Properties to
bring up the Data Link Properties dialog box, which is used to configure
the Tank and Operations Manager Data Source.
3 Click the Provider tab and select the native OLE DB provider specific to
your database and then click Next. The following dialog box depends on
the Provider selected.
12 Aspen Tank and Operations Manager Client Post Install Configuration 127
Data Link Properties dialog box for Oracle
4 For Microsoft OLE DB Provider for SQL Server: in the Select or enter
a server name field, enter the name of the server where your Tank and
Operations Manager database is located, and choose the authentication
method to access your database in the section Enter information to log
on to the server. If you use a specific user name and password, please
do NOT specify a blank password. Also make sure that the Allow saving
password is selected. Select your Tank and Operations Manager
database from the list in Select the database on the server. Click Test
Connection to make sure that the information provided allows a
successful connection to the specified database.
128 12 Aspen Tank and Operations Manager Client Post Install Configuration
5 For Oracle Provider for OLE DB, the following dialog box is brought up.
Enter in Data Source the name of the local TNS service that connects to
your Tank and Operations Manager (and Aspen Operations Reconciliation
and Accounting) database. Specify the User name and Password used
to log on to the Tank and Operations Manager database. Click Test
Connection to confirm that the provided information allows a successful
connection to the specified database.
12 Aspen Tank and Operations Manager Client Post Install Configuration 129
6 Click OK to leave the Data Link Properties box and return to the Aspen
Tank and Operations Manager dialog box. At this point you could click
Accept to save the configuration made until this point, as seen in the
following figure.
130 12 Aspen Tank and Operations Manager Client Post Install Configuration
7 Click the Tools tab; in here, specify the path and file name of the Tank
and Operations Manager Administrator and Configuration tools so these
can be invoked from within other applications. Click the respective browse
buttons to point to where the utilities are located. You can click Accept
again afterwards.
8 Click the Debugging tab; in here you will define whether diagnostic
messages should be output from the Client application and their level of
detail.
9 Select the Debug Level from the list proposed and then click Accept to
save your choice.
10 Click Exit to terminate the Tank and Operations Manager Configuration
application.
12 Aspen Tank and Operations Manager Client Post Install Configuration 131
Update Firewall Settings in the
Server Machine
This step finalizes the Aspen Tank and Operations Manager Client Post Install
Configuration. When the client and server are located at different machines,
the client machine is not able to access the server machine database. This
step enables the connection.
5 Specify the path and file name. Click the Browse… button to point to the
AtOMSMonitor.exe file location, and then click Next.
132 12 Aspen Tank and Operations Manager Client Post Install Configuration
6 Choose Allow the connection for the Action, and click Next.
7 Check all the Boxes (Domain, Private, Public) to ensure the server
machine enables the connection.
12 Aspen Tank and Operations Manager Client Post Install Configuration 133
8 Finally, enter the name for the rule and click Finish.
9 The same steps above to create the create the new inbound rule for
AtOMSTankMonitor.exe.
134 12 Aspen Tank and Operations Manager Client Post Install Configuration
13 Populate Aspen Tank and
Operations Manager
Database
This section provides general information for populating an Aspen Tank and
Operations Manager database version 2006 or later. Emphasis is made in the
interdependency between Tank and Operations Manager and Aspen
Operations Reconciliation and Accounting, essential for the normal and correct
operation of Tank and Operations Manager.
Overview
Some basic information about your site must be inserted in the Tank and
Operations Manager database, such as tanks, lineups, field instruments, etc.,
some of which must be obtained from the Aspen Operations Reconciliation
and Accounting (Operations Accounting) database and some must be
obtained from the real-time database (RTDB).
After the Tank and Operations Manager database is initialized, Tank and
Operations Manager will use the Operations Accounting calculation engine to
perform volume and tank related calculations.
Important: Even if Operations Accounting is not used at the plant for data
reconciliation, Tank and Operations Manager still needs these functions from
Operations Accounting.
Tank and Operations Manager accesses current values from the RTDB
instruments defined in the Node Instrument table to perform tank and
movement monitoring functions.
Populating Methods
Therefore, populating the Tank and Operations Manager database will consist
in propagating some of the Operations Accounting and RTDB entities into
Tank and Operations Manager Tables, among others:
Tanks
Node Instruments
This chapter provides general information and procedures for upgrading Tank
and Operations Manager.
Overview
Aspen Tank and Operations Manager can be upgraded in the following ways:
Upgrade to V12 from V11, V10, V9, V8.8, V8.7, V8.5, V8.0, V7.2 or V7.3
by clicking on the V12 media download or inserting a V12 USB drive and
selecting Upgrade or Repair Existing Products.
Upgrade from versions V7.1 and earlier by removing your old version of
Aspen Tank and Operations Manager and reinstalling V12, as described in
Chapter 3.
Caution:
If you have previously installed more than one Aspen Manufacturing Suite
product on the same computer, you must upgrade all previously installed
products at the same time. If you are also installing an additional Aspen
Manufacturing Suite product, you may install it at the same time as you
perform the upgrades.
Aspen Infoplus.21 32bits is not compatible with Aspen AtOMS V12 in the
same machine. If you want to install Aspen Infoplus.21 and Aspen AtOMS in
the same machine, it is recommended to back up your data, uninstall Aspen
Infoplus.21 32bits, and install Aspen Infoplus.21 64bits. For details about
Aspen Infoplus.21 upgrade, please refer to Aspen Infoplus.21 documents.
Note: aspenONE Shared Components can hold all the installed features
shared by more than one product group.
Notes:
If Aspen Operations Reconciliation and Accounting is installed on the same
machine, before reinstalling you need to also uninstall Aspen Operations
Reconciliation and Accounting using the same method.
If there are any other Aspen products installed, upgrade those products
before reinstalling Aspen Tank and Operations Manager. Please refer to
the individual Aspen product Installation Guides for specific upgrade
instructions.
5 Click on the V12 aspenONE product media download or insert a V12
aspenONE product USB drive and follow the instructions in Chapter 3 for
Installing Tank and Operations Manager.
Note: AspenTech recommends you choose Custom Install, since there
are predefined dependencies between bundles or products such that any
bundle or product selected may cause other bundles or products to be
automatically selected as well.
Overview
Use the instructions in this section to repair corrupt data or missing elements
in your AspenTech applications.
This chapter explains the steps for removing Aspen Tank and Operations
Manager and lists some recommendations concerning the removal of Aspen
Tank and Operations Manager software.
This chapter provides information about problems that might arise during the
installation process or after you try to run the Aspen Tank and Operations
Manager software. It also lists typical error messages and explains how to
correct them.
AspenTech Support
AspenTech customers with a valid license and software maintenance
agreement can register to access the Online Technical Support Center at
http://support.aspentech.com.
Registered users can also subscribe to AspenTech Technical Support e-
bulletins. These e-bulletins proactively advise customers of important
technical issues, product updates and service pack announcements. For
support by phone and e-mail, refer to Chapter 1, “Introduction.”
Operations Accounting
Interface Troubleshooting
“Warning: No Aspen Operations
Reconciliation and Accounting Connect
server specified.”
An attempt to execute the Aspen Operations Reconciliation and Accounting
Connect utility failed and causes an error dialog box to display explaining the
severity and consequences.
The Operations Accounting Interface utility attempted to create an object to
execute the Aspen Operations Reconciliation and Accounting Connect utility
(IIAutoHist.exe) via DCOM and failed. There are two possible reasons and
solutions for this problem:
The remote server name where Aspen Operations Reconciliation
and Accounting is installed has not been specified.
17 Troubleshooting 147
If Aspen Operations Reconciliation and Accounting was installed in a
separate computer then you must specify the name of that server in the
preferences menu as indicated by the error dialog box and attempt the
opening of the model again.
Note: You must manually startup and close the Aspen Operations
Reconciliation and Accounting Connect utility (IIAutoHist.exe) on the
remote computer at least once so its DCOM automation interface is
initialized and enabled for other external programs like Operations
Accounting Interface.
Aspen Operations Reconciliation and Accounting Connect has not
run at least a first time.
Regardless of whether Aspen Operations Reconciliation and Accounting is
installed in the local computer or a remote one, you must manually start
up and close at least once the Aspen Operations Reconciliation and
Accounting Connect utility (IIAutoHist.exe). This is necessary because the
recycle operation initializes and enables the DCOM automation interface
that is required for other external programs like Operations Accounting
Interface to operate the Aspen Operations Reconciliation and Accounting
Connect.
148 17 Troubleshooting
Note: The first time, it is recommended that you enter both the user
name and the password of the Aspen Operations Reconciliation and
Accounting account. By default, the program uses superuser as the User
Name and an arbitrary Password to make the connection fail the first
time.
Aspen Operations Reconciliation and Accounting account
credentials are incorrect.
The first time, you must type in both the user name and the password of
the superuser account. The program uses by default superuser as the
User Name and an arbitrary Password to make the connection fail the
first time.
17 Troubleshooting 149
150 17 Troubleshooting
18 Prerequisites
This chapter expands on any prerequisites so that you can work with the
Aspen Tank and Operations Manager software successfully. It describes the
following:
How to create an Oracle database
What are the compulsory steps if you are running Tank and Operations
Manager on Windows Server
ATOMSDB =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = w2012-
afo03.qae.aspentech.com)(PORT = 1521))
)
(CONNECT_DATA =
(SERVICE_NAME = atomsdb)
)
)
18 Prerequisites 151
In this example, the host word corresponds exactly to the name of the host
PC (w2012-afo03 in this example), and the default service definition
corresponds to the DB name (SERVICE_NAME = atomsdb).
This process creates a large structure where you can locate your schemas and
within them, your tables and dataset.
There are two options available:
Client installation which installs all required basic client software
Server installation which installs the database plus all basic client software
152 18 Prerequisites
4. In the third screen (Select Installation Type), regarding the Oracle
client, choose the Runtime option and click Next to continue.
5. In the fourth screen (Specify Home Details), specify a base location for
storing all Oracle software and configuration-related files, and either
choose the default Software Location name (OraHome1) and path or
change the location: for example, E drive, in which case you must specify
another name, such as OraHome9. Click Next.
18 Prerequisites 153
6. In the fifth screen is a progress screen. Click Next to continue.
7. In the sixth screen, a Summary of all the settings for the client
installation is displayed. Click Install to complete the installation, or
Previous if you want to change any of the previous settings.
154 18 Prerequisites
8. If you have clicked Install an Install progress screen is displayed and
you can cancel the installation process at any time; click Next otherwise.
Note: There are the minimum steps required to allow the client machine to
run the Tank and Operations Manager software accessing the Oracle server
database.
Server Installation
1 Start the Oracle Universal Installer program.
18 Prerequisites 155
Follow the instructions given on the screens that appear.
2 In the first screen which appears (Welcome screen), click Next.
3 In the second screen (File Locations), either choose the default
destination name and path (OraHome92 and C:\oracle\ora92) or change
the location: for example E drive, in which case you must specify another
name, such as OraHome9 (see example below). Click Next.
156 18 Prerequisites
6 In the fifth screen (Installation Types), choose the Personal Edition
option that will enable you to install both Server and Client on the same
machine so that the latter can act as server and client. Click Next to
continue.
18 Prerequisites 157
9 In the eighth screen (Database Identification), specify the Global
Database name and the SID. Click Next to continue.
158 18 Prerequisites
11 In the tenth screen (Database Character Set), specify a character set.
As Tank and Operations Manager supports several languages, choose the
Use Unicode option. Click Next.
18 Prerequisites 159
Database Configuration
1 After all the main elements are installed, the Database Configuration
Assistant will automatically run, completing the database creation. Or
you can run Database Configuration Assistant to create the database
at any time.
2 Click Password Management, and specify a password for the SYS and
SYSTEM accounts available in the new database, then click OK.
160 18 Prerequisites
If the installation process has been successful, the End of Installation
screen will be displayed. At that point you can click Close as the process
is complete.
Installation Check
To make sure that the installation has been successful, you can check that
both SYS and SYSTEM accounts are properly connected to the Host client
defined as “atoms_ora” (not case sensitive).
Follow these steps:
1 Start the SQL application by running SQL Plus.
The following screen is displayed:
18 Prerequisites 161
2 Check the connection from SYSTEM, by entering the user name and
password required together with the Host string atoms_ora.
3 Repeat the operation to check the connection from SYSTEM.
4 After you have clicked OK, the following window appears showing that the
connection has been successful.
162 18 Prerequisites
Appendix A – Configuration
Files
AspenTech.MSC.Settings.xml
File
This file is located in the Documents and Settings\All Users\Application
Data\AspenTech directory. It contains configuration settings that tailor the
behavior of Aspen Tank and Operations Manager.
Note: This file should not need to be changed manually as the Operations
Accounting Interface tool provides the Preference menu option to generate
it. In the event that the desired settings are not appearing in this file when
using the GUI tool, this file can then be modified to correct the problem(s) for
future executions of this utility.
Example of AspenTech.MSC.Settings.xml
File
Section or Property Name Description
[Tank Options]
SendTK=1 Send Tank Gauges option:
0 = Do not send
1 = Send
Levels=True Send Level or Volume
measurements to Aspen Operations
Reconciliation and Accounting
option:
True = Send Levels only to Aspen
Operations Reconciliation and
Accounting
False = Send Volumes only to
Aspen Operations Reconciliation
and Accounting.
AllowBadProp=0 Send property data with bad