Guidelines for upgrading to a new Automation Engine version.
Below you find the necessary steps for upgrading your system to the latest version.
To help you follow the individual steps of an upgrade process of your AE system meticulously, this topic is divided into several steps.
Our consultants are experts in upgrading AE systems. Contact Automic, our experts will be pleased to assist you whenever it is necessary.
In order to print the whole contents of the collapsed pages below, use the button Expand all/Collapse all in the menu bar above.
To ensure that your upgrading process is successful Automic recommends that you strictly follow the steps that are described in this guide. Never upgrade a productive AE system without having it tested extensively in a separate environment. For details about installing hotfixes, see the related topic hotfix installation. |
It is very important that you follow a structured procedure when you upgrade an AE system, because it guarantees that processing can be continued as soon as possible. When changing the version of the Automation Engine, the utility AE DB Load processes and monitors all the required steps for changing the databaseA database is an organized collection of data including relevant data structures.. This is necessary, because it also modifies data that cannot be changed with SQL. All steps that the utility processes during the upgrading process are logged in the file uc_upd.txt. The file chngdb.sql also informs about the database-relevant statements that were set. These statements must be processed by the utility. Refer to the Release Notes of the relevant Automation Engine version for changing the database and preparing the necessary steps. The upgrading process comprises of several stages:
Each stage consists of many small steps. Your AE system is not upgraded all at once but step by step. The old components are not overwritten and the new files are installed in separate directories. Only the AE database is directly upgraded with the utility AE DB Load. This method has two main advantages:
First upgrade your test system. Possible problems can so be recognized and solved before they occur in your production system. Test the individual upgrading steps, thereby setting up a plan for upgrading your production system. The AE system is not available while the database is upgraded. After each step of the upgrade installation, it is essential to monitor the new components for some time. Only continue the upgrading procedure when they have proven to run stably. Note that the upgrading process Automic recommends enables production to be continued in the old Automation Engine version at any time. The only requirements are a parallel installation of the components and the provision of a second database instance. Use the message-comparing program if you require a list of all changed messages. Our consultants are experts in upgrading AE systems. Contact Automic, our experts will be pleased to assist you whenever it is necessary. |
Done |
Condition |
---|---|
|
Carefully read the Release Notes of the relevant Automation Engine version. They include information that must be taken into account during the upgrading process. |
|
The most important requirement is a test system. Comprehensive tests in a separate system are necessary before the new Automation Engine version is used in your production system. The test system helps you to get used to the necessary steps for upgrading your production system and even to optimize them. |
|
Has your database been maintained on a regular basis? Automic recommends starting a reorganization run with AE utilities and database means before you upgrade the database. The smaller the database, the quicker the upgrading process. Note that it will still take some time to upgrade the AE database and that you will need sufficient disk space for having tables duplicated. |
|
Authorizations for the affected computers, databases, ERP systems etc. are required during the various upgrade phases. Ensure that the responsible administrators are available during the particular work steps. |
|
You can request assistance from consultants, developers or even 24x7 support when you upgrade your system. Our experts are trained in providing excellent support when action is taken in critical and sensitive areas of your AE system. Contact your Account Manager or the |
|
Ensure that you have the phone number and e-mail address of Technical Support and your login data for the Download Center. |
1. Check Incompatibilities between Version 11.1 and 11.2
The table below lists new features that might lead to compatibility issues or should be taken care of when upgrading - it does not list all new features of this AE version. Description of the table columns:
|
Topic |
Changed behavior |
Possible incompatibilities |
Actions/Countermeasures |
---|---|---|---|
General DB change Information and the checking instructions apply to all versions, between your existing installation and the latest you want to upgrade to, respectively. |
The DB scheme/structure has been changed. |
Custom SQL queries on AE DB do not work anymore. |
|
Release Packaging |
The Release Packaging (zip files, folder structure and its content) have been changed. The following files and folders have been removed:
|
Possibly automated installation routines using release images will not work. |
If there are scripts relying on the old package structure, you have to adapt the paths. |
CP/WP routing |
FORMS request routing to RA agents has been changed. |
When you edit RA connection objects, a corresponding RA agent has to be active in the same client to retrieve data. |
Assign an RA agent for relevant clients. |
Third party monitoring via External Monitoring Interface |
The new state-of-the-art JMX interface EMI (External Monitoring Interface) has been introduced. The existing SNMP interface is still available, but the third party integration with BMC Patrol, HP OpenView, and Tivoli has been de-supported. |
There is no incompatibility, but the integration with BMC Patrol, HP OpenView, and Tivoli is not available anymore. |
Integrate third party monitoring systems via the new EMI instead. |
Doubled MQ tables |
MQ tables have been doubled and renamed. |
MQ tables might not be considered when you use DB Reorg and existing scripts might fail due to changed table names. |
Adapt DB Reorg scripts. |
Proxy INI file extensions |
Parameters and the format of some parameter values have been changed in the INI file due to functionality improvements. |
You will not be able to reuse INI files of Proxy versions prior to v2 without adaptions. |
Adapt INI file parameters according to the Proxy user documentation. |
Done |
System |
Work steps |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
||||||||||||||||
|
|
|
||||||||||||||||
|
|
Prepare the Upgrading Process of Core Components
|
||||||||||||||||
|
|
Notes:
|
||||||||||||||||
Upgrade the Enterprise Control Center Upgrading from ECC 2.1 or 11.1 to 11.2 Upgrading an existing ECC installation to a new release upgrades the ECC framework and all its plug‑ins at the same time. Use the same steps to install hot fix packages between releases. Overview To upgrade from Enterprise Control Center 2.1.x or 11.0 to 11.2 .x.x involves the following steps: No data migration is needed. 1. Stopping the Apache Tomcat Service
2. Backing Up Current Configurations These steps are optional. You can make a safety copy of your entire ECC installation, or just the configuration files. Although, you can use very little of the previous configurations in the new version, you might find it helpful to have a copy for later reference when you configure the upgrade.
Upgrade the Apache Tomcat web applicationA web application is an application that is accessible over a network (Internet or intranet) and is typically coded in a programming language like Java or JavaScript, combined with a markup language like HTML. Web applications are provided on web servers and web browsers are used as GUI on client computers. server where you have ECC currently installed to the latest version that complies with the new release.
4. Restarting the Apache Tomcat Service
5. Deploying the New ECC WAR File Deploy the new version of the ECC on Tomcat.
Do not delete the WAR file! If you do, Tomcat will also remove the corresponding subfolder,which also undeploys the ECC!
6. Configuring the New ECC Version
See the section Troubleshooting Browser Problems on ECC Clients for tips about how to ensure that users see all parts of the ECC user interface correctly.
|
||||||||||||||||||
|
|
These scripts are provided in the directories IMAGE:DB\GENERAL\<version> and IMAGE:DB\<database type>\<version>. The files uc_upd.txt and chngdb.sql are especially important. |
||||||||||||||||
|
|
|
3. Upgrade the core components
Done |
System |
Work steps |
||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Example for Windows: Utility in C:\AUTOMIC\UTILITY\BIN Database files in C:\AUTOMIC\UTILITY\DB |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
Upgrade Framework Integration (optional)
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
Upgrade UserInterfaces (if they have not yet been upgraded) If you didn't upgrade during the preparation process, do so now. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Upgrade the Enterprise Control Center (if it has not yet been upgraded) If you didn't upgrade during the preparation process, do so now. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
Configure and start the Java Work Process (JWP)
GeneralThe JWP is a component of the Automation Engine which is required for the following functions:
Files ProvidedThe JWP is provided in the same directory as all the other Automation Engine files.
The directory /configuration/ is created automatically when the JWP is first started and contains the OSGI bundle's cache. InstallationUnpack the filesIn Windows, the JWP files are automatically copied from the SETUP.EXE program to the BIN directory. In UNIX, the files are located in the respective TAR archive. Copy the provided "plugin" and "lib" directories into the BIN directory of the Automation Engine. The subsequent installation steps depend on the database type used. MS SQL Server
Download Microsoft JDBC Driver 4.0 for SQL servers. After downloading, copy the file "sqljdbc4.jar" into the lib directory of the Automation Engine.
Now check whether the MS SQL server instance used allows access via TCP/IP. Open the SQL Server Configuration Manager and select Protocols for MSSQLSERVER under SQL Server Network Configuration. The item "TCP/IP" must be set to "Enabled" in the right-hand section.
The default port of the MS SQL server port is 1433. If you are not sure of the port of your MS SQL server instance, you can find this out from its log file. The message "Server is listening on [ 'any'<ipv4> port number]" should be found in the current log file, which contains the port.
The JWP uses the same configuration file (ucsrv.ini) as the other work processes of the Automation Engine system. The database connection must be modified in the configuration file for the JWP. There are 2 different options for this: 1) DSN-less ODBC Connection Please note that with this option, the same database connection string that is also used by all the other WPs in the Automation Engine system must be changed in the configuration file. When installing a JWP for an existing system, all WPs must be subsequently restarted. A connection string is required in the [ODBC] section of the configuration file, the syntax of which does not require DSN. The server and database name must be specified directly in this case. SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,Driver={SQL Server Native Client VERSION};Server=tcp:SRVNAME,PORT;Database=DBNAME;Uid=DBUSER;Pwd=DBPWD
Example: [ODBC] The entry should be on one line (no break).
2) Separate connection string for the JWP With this option, a separate database connection string for the JWP is defined in the [JDBC] section. Example: [JDBC] The name and password of the database user are used by the [ODBC] item. The advantage of this method is that the connection string of the other WPs ([ODBC] section) does not need to be changed or restarted. Oracle
Copy the JDBC driver "ojdbc6.jar" from the Oracle database client installation to the "lib" folder of the JWP.
There are 2 options: 1) Connection via OCI Modification of the INI file "ucsrv.ini" is not necessary in this option. However, the JWP requires access to the Oracle database libraries in the same way as a WP. In UNIX, the environment variables LD_LIBRARY_PATH or SHLIB_PATH must therefore be selected accordingly, depending on the platform. More information on installing the JDBC driver can be found in the JDBC installation instructions from Oracle.
2) Direct connection to the database You can connect directly to the database using the Oracle JDBC Thin driver. The [JDBC] section in the ucsrv.ini file must be configured accordingly. Example: [JDBC] The name and password of the database user can be found in the [ODBC] item. DB2
Copy the file "db2jcc4.jar" (JDBC driver) into the "lib" directory of the JWP. This file is part of the DB2 client and is located in the sub-directory "SQLLIB/java".
Modification of the ucsrv.ini file is not necessary. However, if required, the database connect string can be defined in the [JDBC] section of the INI file. Example: [JDBC] The user name and password for database access can be found in the [ODBC] item. Add certificates for SSLIn order to use SSL, the certificate(s) of the LDAP server must be available to the Java Work Process. Two options are available to add the certificates:
Another option to install the certificate is the command line parameter -installcert of the Java Work Process. java -jar ucsrvjp.jar -installcert <host>:<sslport>
If a certificate is missing, the message "unable to find valid certification path to requested target" is printed and the missing certificate is downloaded and stored in the cacerts file. Start the JWPUse this kind of command to start the JWP via the command line: java -Xmx512M -jar ucsrvjp.jar -IC:\temp\ucsrv.ini The file "ucsrvjp.jar" is provided in the same directory as the other Automation Engine files. It is used exclusively to start the JWP. The JWP can also be started via ServiceManager. java -Xmx512M -jar ucsrvjp.jar -svc%port% -IC:\temp\ucsrv.ini The -svc parameter should be omitted when starting directly via the command line. The parameter -I to specify the INI file is optional. If the parameter is missing, the JWP attempts to find the file "ucsrv.ini" in the current working directory (= directory in which the file "ucsrvjp.jar" is located). |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
Start the Automation Engine and clients
|
||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
|
4. Upgrade all other components
Done |
System |
Work steps |
---|---|---|
|
|
|
|
|
Install the remaining components
|
|
|
|