AspenCFV12 Inst
AspenCFV12 Inst
AspenCFV12 Inst
Aspen Collaborative Forecasting, Aspen Demand Manager, Aspen SCM, Software License Manager, Aspen Refinery
Scheduler, Aspen Orion, Aspen PIMS, Aspen Retail Fleet Planner & Scheduler (Retail), Aspen Retail, Aspen Supply
Chain Operations Scheduler (SC Ops Scheduler), Aspen Framework, Aspen SLM tools, Aspen Role-Based
Visualization, Aspen Event Management, Aspen Integration Infrastructure, Aspen Information Management, Aspen
Batch, Aspen Production Management, Aspen Advanced Process Control, Aspen SCM Applications, AspenTech,
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 manual 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.
1 Introduction .........................................................................................................5
About this Installation Guide .............................................................................. 5
Audience ............................................................................................... 5
Related Documentation ..................................................................................... 5
aspenONE Overview ......................................................................................... 6
aspenONE Media .............................................................................................. 6
Licensing ......................................................................................................... 7
SLM License Server ................................................................................ 8
Localization ..................................................................................................... 8
Accessing aspenONE Documentation .................................................................. 8
Installing Aspen Collaborative Forecasting for the First Time .................................. 9
Installation Welcome Page..................................................................... 11
License Terms and Conditions ................................................................ 13
Aspen Collaborative Forecasting Overview ......................................................... 13
Create Overrides .................................................................................. 13
Integrate with DM ................................................................................ 14
Collaborative Forecasting Components .............................................................. 14
System Requirements ..................................................................................... 14
Granular Downloads ....................................................................................... 14
Technical Support .......................................................................................... 15
2 Prerequisites ......................................................................................................17
6 Installing Java....................................................................................................41
Overview....................................................................................................... 41
Installing Java ..................................................................................... 41
1 Introduction iii
7 Installing and Configuring Apache Tomcat .........................................................43
Overview....................................................................................................... 43
Installing Apache Tomcat ...................................................................... 43
Configuring Environment Variables in Windows for the System .................. 43
Installing Tomcat as a service ................................................................ 44
13 Firewall ............................................................................................................75
Overview....................................................................................................... 75
16 Best Practices...................................................................................................91
iv Contents
1 Introduction
Note: This document does not include the installation of AspenTech industry
features.
Audience
This installation guide is intended for anyone who needs to install CF,
including system administrators, application developers, and end users.
Related Documentation
In addition to this guide, AspenTech provides the following documentation for
Aspen CF:
Aspen Collaborative Forecasting (CF) V12 Release Notes
Aspen Collaborative Forecasting (CF) V12 Implementation Guide
Aspen Collaborative Forecasting (CF) V12 Help
Note: You must disable the Compatibility view in Internet Explorer before
using Collaborative Forecasting. Refer to Microsoft documentation for further
information.
1 Introduction 5
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.
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.
6 1 Introduction
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:
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
agreement, use this media. Software installed from the aspenONE
Token media requires run-time token-based license keys.
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.
1 Introduction 7
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.
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:
8 1 Introduction
Installation Guides and Release Notes can be found by clicking the
corresponding link on the Welcome page of the aspenONE Installer.
Logging onto the AspenTech Customer Support site, clicking Support in
the upper right-hand side and then clicking Product Documentation.
Downloading all the available documentation (other than Help files) from
the AspenTech Customer Support website via the zip file of the aspenONE
Documentation.
For Aspen Plus, Aspen HYSYS, Aspen Exchanger Design and Rating, Aspen
Economic Evaluation, Aspen DMC3 Builder, and Aspen Fidelis Reliability only,
you can access additional documents by:
Clicking the Aspen Knowledge icon on the Resources ribbon. (All products
except Economic Evaluation.)
Entering a search string within the Search Aspen Knowledge search box –
available in the upper-right corner of the application. (All products except
Economic Evaluation.)
Clicking Aspen Knowledge from the Help menu (Economic Evaluation
only).
Note: Before you begin installation, you will want to review the What’s New
document and Release notes and print copies of the Installation Guides for
products that will be installed. Those documents are included under each
product suite folder.
Getting Started
1. You can begin your software installation by clicking on the media
download or inserting the aspenONE USB into the USB drive. The
AutoPlay dialog box is displayed.
2. Select Run aspenONE Install Browser.
3. User Account Control confirmation
Before you see the Welcome page, you may see the following:
1 Introduction 9
You must click Yes to continue.
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 successfully. 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.
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 displays. The screen you see varies
depending on how you are accessing the Aspen Collaborative Forecasting
installation.
10 1 Introduction
The following links are available:
Patents – Allows you to download a document with a list of recent
patents.
Need Help? – Connects to the AspenTech Support Web site, where
you can find knowledge base articles, tips, and solutions to known
problems.
Getting Started – Links to brochure containing information about
prerequisites, installing and upgrading the software, documentation
and translated versions.
What’s New? – Links to a description of new features.
4. Click INSTALL NOW.
1 Introduction 11
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.
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.
Repair – Repair existing installation errors.
Prepare Deployments (For IT Personnel/Deployment Groups) –
Create install scripts and copy media to automate software deployment.
Notes:
Be sure that the SLM license server or standalone license is available prior
to installation. SLM tools are automatically install when installing
aspenONE products.
5. Click Install aspenONE Products.
12 1 Introduction
License Terms and Conditions
Aspen Collaborative
Forecasting Overview
Aspen Collaborative Forecasting (CF) is a web-based application that allows
multiple users to collaborate on the forecast. With CF, you can:
Create overrides
Integrate with Aspen Demand Manager™ (DM)
Create Overrides
The Create Overrides feature allows you to enter overrides to data at all
levels of aggregation permitted by your security role. Override options
include:
Viewing override history, which includes overrides entered by other users
Adding comments
Converting to the desired unit of measure to make overrides
Specifying a time fence for overrides
1 Introduction 13
Working offline in Microsoft® Excel
Integrate with DM
You can integrate CF with Aspen Demand Manager (DM) to take advantage of
the collaborative environment.
Collaborative Forecasting
Components
The major components of the Aspen Collaborative Forecasting product are:
CF Web Application – You install this component on the same machine
where you installed the Tomcat server. The CF Web Application is the
online software module that provides CF’s graphical user interface.
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
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*
14 1 Introduction
*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.
V12 Manufacturing & Supply Chain (MSC): In the case of the MSC media,
users can download the entire suite or one of the items listed under the MSC
group:
V12 Batch APC
Aspen Supply Chain Management
Aspen Planning, Scheduling and Blending, Supply & Distribution
Aspen Manufacturing Execution Systems & Advanced Process Control
Aspen Unified
V12 Aspen GDOT Online
V12 Aspen GDOT Offline & Unified GDOT Builder
Aspen Informatica PowerCenter 10.4
Aspen Cim-IO & Process Data
V12 Asset Performance Management (APM): In the case of the APM
media, there is no downloadable suite. Users can download the products
listed below the APM group:
Aspen Asset Analytics
Aspen Fidelis
Aspen ProMV
Aspen Mtell
Aspen Mtell for Oil Well Optimization
Aspen Asset Performance Management Insights
Aspen Enterprise Insights On-Premise Stack
V12 Aspen Internet of Things (AIoT): In the case of the AIoT media,
there is no downloadable suite. Users can download the products listed below
the AIoT group:
Aspen Cloud Connect
Aspen Edge Connect
Software License Manager (SLM): In the case of the SLM media, the only
granular download is ALDA:
aspenONE License Deployment Assistant (ALDA)
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.
1 Introduction 15
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.
16 1 Introduction
2 Prerequisites
2 Prerequisites 17
18 2 Prerequisites
3 Installing Aspen
Collaborative Forecasting
This chapter explains how to install the current version of Aspen Collaborative
Forecasting™ (CF).
Installation Overview
The Aspen CF installation process consists of the following major steps:
1 Do one of the following:
o Install the Oracle database.
Or
o Install the SQL Server database.
2 Install Java.
3 Install and configure Apache Tomcat.
4 Install Collaborative Forecasting.
5 Configuring Database(s).
6 Configure the Windows Firewall.
Notes:
You must perform these steps in the order listed above.
You install either the Oracle database or the SQL Server database. You do
not install both.
AspenTech recommends that you use the default installation path when
installing these features. If you modify where some of these features are
installed, you may experience installation errors.
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
Overview
If you are an existing customer using the CF V11.X application, please
continue to Chapter 11: Upgrading Collaborative Forecasting Database
Objects.
Perform the following steps to install and configure Oracle 19c (19.3.0.0.0)
with ASM (Automatic Storage Management):
Create your Oracle databases.
Click Finish.
5 To test the connection, verify that you can connect to the database from a
remote computer.
Overview
If you are an existing customer using the CF V11.X application, please
continue to Chapter 11: Upgrading Collaborative Forecasting Database
Objects.
Use the following steps to install your SQL Server Database:
Set up your databases.
Specify SQL Server settings.
Configure SQL Server to allow remote connections.
SQL Server will notify you that the changes won’t take effect until you
restart the service.
6 Click OK.
The service will be restarted later in this procedure.
12 Click Inbound Rules in the left pane, then click New Rule in the right
pane.
o Click Finish.
14 To test the connection, verify that you are able to connect to the database
from a remote computer.
Overview
Begin the Collaborative Forecasting installation process by installing Java JRE
11.0.4 (64-bit) (release date 07.17.2019) or the latest x64 version.
Installing Java
Use the following steps to install Java.
To install Java:
You can use either JRE from Oracle or OpenJava JRE or JDK. To install,
please follow the instructions from the corresponding provider.
Important: It is critical that a 64-bit version is installed.
6 Installing Java 41
42 6 Installing Java
7 Installing and Configuring
Apache Tomcat
Overview
Next, you install and configure an Apache Tomcat server, using the following
steps:
Install Apache Tomcat.
Configure Apache Tomcat.
Configure Environment Variables in Windows environment for the system
(i.e. not for the user).
Install Tomcat as a service.
If necessary, install and configure Oracle 19c(19.3.0.0.0) with ASM.
2 Click Next.
Note: The following instructions will use the following convention to refer
to the full pathname of this directory: [Tomcat installation path]
9 Run [Tomcat installation path]\bin\tomcat9w.exe file to open the
properties of Tomcat8 service.
10 Verify that its Startup type is set to Automatic.
12 Open Java tab and add the following three lines under Java Options:
-Djava.security.auth.login.config=[Tomcat installation
path]\conf\jaas.config
-da:com.aspentech.cdm...
-dsa
Note: Enter each line as a separate line.
13 Set Initial memory pool as 1024 MB.
14 Change Maximum memory pool to the value recommended by Aspen
Services.
15 Click OK.
16 Copy the following files to [Tomcat installation path]\lib:
o Ojdbc10.jar (Needed only when using an Oracle database. Found in
the corresponding distribution provided by Oracle.)
Overview
Next, you install the Collaborative Forecasting application.
AspenTech Installer
Click on Setup.exe application. The User Account Control window appears.
Click Yes.
Note: You have the option of installing aspenONE products on your machine
by initiating click or double clicking Install aspenONE products icon.
Notes:
Once the installation of any AspenTech product to the default folder has
been completed, this folder cannot be changed, and the Change Current
Destination Folder dialog box will no longer display.
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. 32-bit products will be installed in the “\Program Files (x86)”
folder, and 64-bit products will be installed in the “\Program Files” folder.
If the Aspen SCM Applications are not being installed under the default
folders, you may need to change the path setting of library cases specified
in the SCM table $TCASES.
AspenTech recommends that you install SCM and any cases on the same
computer. Having them on separate computers can adversely affect SCM’s
performance.
3 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.
4 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.
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.
Installation Complete
Note: Click Reboot Now to reboot your system if Reboot Now is enabled.
Before using the software, follow all instructions in the After You Install
section, below, and complete all subsequent steps in the installation process.
Notes:
Create the operational and stage databases on the same server.
9 Configuring Database(s) 67
If necessary, unzip Aspen CF V<X>.zip/db/SQLServer/CONFIG.zip
and verify that its contents are easily accessible.
To configure the operational and stage database users:
1 Configure all parameters specified in defines.sql.
The defines.sql file is configured to specify defaults. Review all user
names and modify entries as needed. Verify that all entries are filled.
Note: Do not alter user passwords. By default, all users are created with
specified user names and passwords, as listed in the defines.sql file.
2 Execute init.bat.
Note: The config.zip file is available in the following directory in which the
CF application was installed: C:\Program Files\AspenTech\AspenCF
If you do not see the config.zip file, unzip the Aspen CF V<X>.zip file and
extract the contents into the same CF installation folder. Note that the
physical drive varies, based on implementation.
If you do not see the cdm.zip file, then please unzip the Aspen CF V<X>.zip
file and extract the contents into the same CF installation folder. Note that the
physical drive varies, based on implementation.
68 9 Configuring Database(s)
10 Adding and Configuring
New Instances of Demand
Manager to an Existing SQL
Server
Overview
If you are an existing customer upgrading to the CF V12.0.0 application, and
you want to create new instances of CDM on an existing SQL server, you
must install Collaborative Forecasting database objects for both operational
and stage databases.
10 Adding and Configuring New Instances of Demand Manager to an Existing SQL Server 69
If you do not see the CDM.zip file, then please unzip the Aspen CF
V<X>.zip file and extract the contents into the same CF installation folder.
Note that the physical drive varies based on implementation.
If you are installing a new instance of Collaborative Demand Manager,
continue to the Upgrading Collaborative Forecasting Database Objects
chapter.
70 10 Adding and Configuring New Instances of Demand Manager to an Existing SQL Server
11 Installing Collaborative
Forecasting Database
Objects
Overview
Next, install collaborative forecasting database objects for both operational
and stage databases.
If you do not see the CDM.zip file, then please unzip the Aspen CF
V<X>.zip file and extract the contents into the same CF installation folder.
Note that the physical drive varies based on implementation.
Overview
To access the server from a remote browser, modify the Windows Firewall on
the machine on which Tomcat was installed with a new inbound rule.
13 Firewall 75
5 Specify Port as the rule type you want to create, then click Next.
76 13 Firewall
6 For Specific Local Ports, enter 8080, then click Next.
13 Firewall 77
7 Specify one of the following as the action to take when a condition
matches the conditions the rule specifies, then click Next:
o Allow the connection
Or
o Allow the connection if it is secure
78 13 Firewall
8 Specify when the rule applies, then click Next.
13 Firewall 79
80 13 Firewall
14 DM Publication by Flat File
All XML files work for table column mapping to data file field. You cannot
modify these files.
o LOAD.ctl: The control file for Oracle SQL Loader. You cannot modify
this file.
o Log.log: The log file for Oracle SQL Loader. You can modify or delete
this file.
o SQLLoader.cmd: The command file for Oracle SQL Loader. You
cannot modify this file.
Oracle SQL Loader generates xxx.bad extend files. You can modify or
delete this file.
If you are using an MS SQL Server database, you should share the dm
folder for all users. If you are using an Oracle database, you should not
share the dm folder for all users.
2 DM configuration for ODBC connections:
The table SQLCFCNF contains all ODBC configurations of SQL Server. The
table ORLCFCNF contains all configurations for Oracle.
Uninstalling Aspen
Collaborative Forecasting
(64bit) Using the Microsoft
Windows 2019/2016/2012 R2
Start Button
You can find Uninstall AspenTech Software under the AspenTech group icon
after clicking the Windows 2019/2016/Windows 2012 R2 Server Start button.
Alternately, you can choose Programs and Features from the Control
Panel, select Aspen Collaborative Forecasting (64bit) and perform the
Uninstall operation.
Uninstall AspenTech Software application in Windows 2019/2016/2012 R2 x64
Standard or Data Center Edition Search Window button and double-click as
shown below.
16 Best Practices 91