Guidelines for upgrading to a new Automation EngineDiese Komponente steuert ein Automation Engine-System. Besteht aus verschiedenen Serverprozessen. 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 page 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.
Preliminary Information
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 LoadDas Dienstprogramm DB Load lädt Daten zu unterschiedlichsten Zwecken in die Automation Engine-Datenbank. processes and monitors all the required steps for changing the database. 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 NotesRelease Notes informieren Sie über Highlights, neue Funktionen, Verbesserungen und über Korrekturen unserer Versionen und Freigaben aus der Automic-Produktfamilie. 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 installationnull, 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. |
The Installation Steps
1. Check Incompatibilities between Version 11.2 and 12
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. |
|
Java Workprocess (JWP) |
Installation of JWP(s) is mandatory for several functions in Automation Engine and AWIAutomic-Produkt: Übersichtliche und einfach zu bedienende Weboberfläche, mit welcher der Zugriff auf verschiedene Funktionalitäten der Automation Engine möglich ist.. |
|
Install JWP(s) |
UserInterfaceVeralteter Begriff. Ersetzt durch: Automic Web Interface |
The UserInterface has been replaced by the Automic Web Interface. The new features for v12 have been implemented for the AWI exclusively. |
|
|
The Service Level Management via the Service Level Objective objects (SLOs) is a new function as of v12. The monitoring has been implemented by checks via CPs and JWPs. |
|
|
|
As of v12 the ZDU is available in the AWI. Take care not to conduct the ZDU steps using UI and AWI alternately. Perform the ZDU either via AWI or UI exclusively. |
|
|
|
Change of script function behavior:
|
In connection with the new feature Centralized Agent UpgradeDas Cenralized Agent Upgrade erlaubt das zentrale Upgrade von allen installierten und durch das CAU unterstützten Agenten auf neue Versionen mithilfe des Automic Web Interface (AWI). (CAU) the behavior of these script functions has been changed. They do not abort anymore, if an agent is not available but stay in "Waiting for host" instead. |
|
|
All ServiceManager actions require a password. |
The password defined in the ServiceManager settings is now required for all possible actions in the ServiceManager. |
You will be prompted for a password when:
|
Enter the correct password when prompted. |
RA Solutions |
In general RA solutions have to be upgraded to newer versions that support AWI. So far the following RA solutions support AWI and will be available for v12:
All other RA solution do not support AWI and therefore cannot be edited in AWI. |
Objects of other RA solutions cannot be edited in AWI. |
Contact Automic: support@automic.com |
Webservice agent changes |
The new version of the WebService agent (4.0.0) was split into separate RA solutions for SOAP and REST. All three agents (WebService 3, WebService REST 4, and WebService SOAP 4) can run in parallel. The RA solutions of version 4 do not replace the one of version 3.
|
Existing objects of version 3 are not automatically migrated to objects of version 4. |
To migrate existing objects from version 3 to 4 do the following :
|
DB Load and upgrade on SQL-Server |
If the parameter in the SQL database READ_COMMITED_SNAPSHOT = FALSE then:
Therefore in such cases the Zero Downtime Upgrade (ZDU) is not available.
|
|
Set READ_COMMITTED_SNAPSHOT = TRUE |
2. 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. |
ProxyEigenes Produkt von Automic, das als zusätzliches Dienstprogramm mit der Automation Engine verwendet werden kann.Dienst der Zusammenfassung und Umleitung von CP-Verbindungen. 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. |
3. Check Incompatibilities between Version 10 and 11.1
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 |
---|---|---|---|
Message numbers (For detailed information on individual possible impact see also the topic Message number changes) |
Message numbers are now eight digits long, instead of seven. Old format: Unnnnnn |
Filtering on Unnnnnn numbers won't work with
|
|
Text variable values
|
|
|
Check queries on tables with changed fields (VARCHAR -> CLOB) e.g. search for "OVW_Value1": SELECT OH_Name FROM OH WHERE OH_Idnr IN (SELECT OVD_OH_Idnr FROM OVD WHERE OVD_SQL like '%OVW_Value1%' OR OVD_SQLOra like '%OVW_Value1%' OR OVD_SQLDB2 like '%OVW_Value1%') |
ScriptEigener Objekttyp in der Automation Engine function GET_OH_IDNR |
The second parameter client was removed from this Automic script function due to security reasons. |
Objects using this script function with the specified parameter client will abort. |
Check all script tabs for this function and remove the parameter / correct the function call. |
LoginAnmeldedaten für Zielsysteme. Auch ein eigener Objekttyp in der Automation Engine. Objects for File Events on Windows, Unix, zOS |
A new privilege has been introduced for user objects |
New privilege is checked and used per default after AE version upgrade. |
|
zOS: Replacing Job line in JCL |
The value of attribute MVS_JOBTYPE has been deprecated. |
Currently no incompatibility, the old value is still compatible. |
No checks/adaptions needed |
XML Variables (VARA.XML) |
|
|
No checks/adaptions needed, part of the AE DB installation |
FAULT_OTHER tasks |
Deactivation behavior of tasks with status FAULT_OTHER has been changed. |
|
Check deactivation options accordingly. (If needed, they can be set to archive the behavior of previous AE version) |
Script function GET_ATT_SUBSTR(call_text) |
In previous AE versions, at least a blank was returned. As of version 11, no value in case of missing call text is returned. |
Error occurs on empty call text. |
|
RA agents |
Shared third party libraries were removed from the RA agent core. |
You have to obtain all needed shared third party libraries and ensure that they are installed properly. |
Download Oracle JDBC driver and copy it to the lib directory of the RA core. This is only required for an RA agent that needs an Oracle DB connection (via JDBC) - e.g. RA Banner, RA Oracle EBS, RA JDE or RA Oracle Retail. |
GET_VAR (Upgrade from versions between v9 SP4 and v10) | GET_VAR does not resolve recursively anymore. |
From version v9 SP4 to v10 SP4, GET_VAR resolves recursively. This means, if a value contains an "&", the script processor tries to resolve this. This has been changed. The variable &value# will contain therefore: With version v10 SP4 HF1 the behavior was configurable (key RESOLVE_GET_VAR in UC_SYSTEM_SETTINGS). In v11 the configuration option was removed. As a conclusion all variable values, that should be resolved recursively, must use the Script function RESOLVE_VAR. |
Potentially all scripts that use GET_VAR and a variable value that contains "&" characters, are affected. To determine affected VariableSpeichert oder ermittelt Werte dynamisch zur Laufzeit. Auch ein eigener Objekttyp in der Automation Engine. objects, you may use this SQL query: select oh_client, oh_name from oh where oh_idnr in The Script function RESOLVE_VAR may be used to recursively resolve a static Variable object. |
Done |
System |
Work steps |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
||||||||||
|
|
|
||||||||||
|
|
Prepare the Upgrading Process of Core Components
|
||||||||||
Upgrade the Automic Web Interface Upgrading ECC to AWI 12 Upgrading an existing ECCVeralteter Begriff. Ersetzt durch: AWI installation to the new release upgrades the AWI framework and all its plug‑ins at the same time. Use the same steps to install hot fix packages between releases. Overview Upgrading from ECC to AWI 12 .x.x involves the following steps: No data migration is needed.
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 application server where you have ECC currently installed to the latest version that complies with the new release.
Deploy the new version of the AWI on Tomcat. (missing or bad snippet)
See the section Tips for Internet Browsers on AWI Clients for tips about how to ensure that users see all parts of the AWI 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. |
||||||||||
|
|
|
5. 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 the Automic Web Interface (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)
General As of v12 several important functions in the Automation Engine and thus AWA depend on the JWP being installed and running. Files Provided The 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. Installation Unpack the files In 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. Java Cryptography Extension (JCE)
The JCE Unlimited Strength Jurisdiction Policy has to be installed on the machines where:
Download at Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy The Readme file contains the installation instructions. If there are multiple Java installations on the same computer, setting up a policy file for all installations is recommended. 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, therefore you should not define any user and password in JDBC string because it can only be stored as cleartext. 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, therefore you should not define any user and password in JDBC string because it can only be stored as cleartext. 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, therefore you should not define any user and password in JDBC string because it can only be stored as cleartext.
Add certificates for SSL In order to use SSL, the certificate(s) of the LDAP server must be available to the Java Work Process. The JWP uses the default keystore file "cacerts" in the lib/security directory of the JRE. Keystore file configuration options Using an alternative keystore file: If you want the JWP(s) to use an alternative keystore file, you have to define the file name and path to a centrally stored file in the key JWP_KEYSTORE_PATH, in the UC_SYSTEM_SETTINGS variable. In case the defined path is not accessible or invalid, a log message will be written to the default log location and the JWP will use the default keystore file. Creating an individual keystore file using the JWP: If you want to use an individual keystore file, you can create it using the following command: java -jar ucsrvjp.jar -installcert host:port keystorePath In case the defined path in keystorePath does not exist, the JWP creates a new keystore file in that location. You can then define a password for that keystore file. Using an alternative password for keystore file access: The default password used by the JWP is the default password of the JRE keystore. If you want the JWP to use a different password, you have to define a Login object containing that password by following these steps:
Adding the certificates
java -jar ucsrvjp.jar -installcert <host>:<sslport>
java -jar ucsrvjp.jar -installcert <host>:<sslport> <keystorePath> When the parameter "keystorePath" is valid but the file doesn't exist, JWP creates a new keystore file in the same location. 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 JWP Use 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
|
|||||||||||||||||||||||||||||||||
|
|
|
6. Upgrade all Other Components
Done |
System |
Work steps |
---|---|---|
|
|
|
|
|
Install the remaining components
|
|
|
|