Automic LTT Automic Workload Automation CNet) Installation Guide WoT) La ole) nL Pat Automic Software Gmb]ii }Copyright. Copyright ‘Automic® and the Automic logo® are trademarks owned by Automic Software GmbH (Automic). All such trademarks can be used by permission only and are subject to the written license terms. This software/computer program is proprietary and confidential to Automic Software and is only available for ‘access and use under approved written license terms. This software/computer program is further protected by copyright laws, intemational treaties and other domestic and intemational laws and any unauthorized access or use gives rise to civil and criminal penalties. Unauthorized copying or other reproduction of any form (in whole or in part), disassembly, decompilation, reverse engineering, modification, and development of any derivative works are al strictly prohibited, and any party or person engaging in such will be prosecuted by Automic Software. No liability is accepted for any changes, mistakes, printing or production errors. Reproduction in whole or inpart without permission is prohitited. © Copyright Automic Software GmbH. All rights reserved Other names may be trademarks of their respective holders.Contents {ii Contents 4 About Automic Workload Automation 1 1.1 Automie Workload Automation Decumentation 12.0 1 1.2 Guides & References -lcons Used 1.3 Safety and Disclaimer of Warranty . 2 AWA Product Overview 2.1 Concept of Automic Workload Automation (AWA) 2.2 About Automic Workload Automation (AWA) 2.3 Release Highlights .... 2.4 Benefits of Autornic Workload Automation eo oan ek eon 2.5 Automic Workload Automation Architecture 2.6 AWA Use Case Videos 1 2 AWA System Requirements and Sizing 2 3 Installing the Automation Engine 19 3.1 New Installation ... 3.1.1 ONE Installer - Single-Box Installation 19 3.1.2 Planning the Installation ... Introduction Eo General Information . Dos & Don'ts in Automation Engine 37 Test and Production System .. Automation Engine and NAT 39 New Installation Procedure 39 3.1.3 Installation Procedure at Setting Up the Database a DB2 a MS SQL Server ... Integrating an Altemative MS SQL Server Schema 45 ORACLE 48 51 Installation Scenarios . Utilities 87 Installing Utilities (UNIX) 57iv [Contents Installing Utilities (Windows). Loading the AE Database Installing the Automation Engine Installing the Automation Engine for UNIX 63 Installing the Automation Engine for Windows Distributed Server Environment Instaling the JWP n Setting up Single Sign-On 76 Instaling the Online Documentation Installing the Agents Installing the Agent for BS2000 . Installing the Agent for Databases Installing the Agent for Database Jobs and Events . Installing the Agent for Database Variables a1 Installing the Agent for Java EE/JMX . Setting Up the Agent for Java EE/JMX 95 Usage with Application Server Setting Up the Agent for Java EE/JMX (Oracle WebLogic) 96 Setting Up the Agent for Java EE/JMX (IBM WebSphere) with RMI Connector 98 Setting Up the Agent for Java EE/JMX (IBM WebSphere) with SOAP Connector 99 Setting Up the Agent for Java EE/JMX (JBoss) 401 Setting up the Agent for Java EEIJMX (Oracle Containers for Java EE) 102 Setting up the Agent for Java EE/JMX (SAP NetWeaver). 2403; Setting Up the Agent for Java EE/JMX (Tomcat) 108 Web Configuration interface for the Java EE/JMX Agent 108 Installing the Agent for NSK 111 Installing the Agent for 0S/400 114 Installing the Agent for PeopleSoft 116 Installing the Agent for People Soft (UNIX) - Basics 116 Installing the Agent for People Soft (UNIX) - Details 118 Installing the Agent for People Soft (Windows) - Basies 124 Installing the Agent for People Soft (Windows) - Details 127 ‘Automation Engine Interface . 133 Creating Java Classes 136Contents |v Installing the Agent for People Soft - Basics .. Installing the Agent for People Soft - Details 140 ‘Automation Engine Interface . Setting Up the Agent for Rapid Automation 149 Installing the Agent for SAP .. 181 Preparing Installation - Check List 181 Installing the Agent for SAP - Basics 183 Installing the Agent for SAP - Details 184 Installing the Agent for Siebel (Windows) 187 Installing the Agent for UNIX 158 Installing the Agent for VMS 162 Installing the Agent for Windows 166 Installing the Agent for 2/OS 168 Installing the ServiceManager 176 Installing the ServiceManager (UNIX) . Installing the ServiceManager (Windows) 17 Installing the CallAPIs . Installing the CallAPI for BS2000 180 Installing the CallAPI for Java 181 Installing the CallAPI for NSK 181 Installing the CallAPI for z/OS 182 Installing the CallAPI for OS/400 182 Installing the CallAPI for SAP... 182 Installing the CallAPI for UNIX 188 Installing the CallAPI for VMS 187 Installing the CallAPI for VSE Installing the CallAPI for Windows .. Connect for WebSphere MQ (Windows) 191 CallAP| for WebSphere MQ (Windows) 192 Installing the AE. ResourceAdapter (IBM WebSphere) 193 Installation 196 Installing the AE Internal Webservice (Glassfish) 196 Installing the AE Intemal Webservice (IBM WAS CE) . 97 Installing the AE Internal Webservice (JBoss) 198vi | Contents Installing the Intemal Webservice (SAP Netweaver) ... Installing the AE Internal Webservice (Tomcat) Configuration Webinterface forthe Internal Web Service... 201 E-mail Connection 202 Cluster . ee 208 ‘Automation Engine and Clusters 203 ‘An Automation Engine System ina Windows Cluster 204 3.1.4 After Installation 206 Creating AE Clients and Users 206 Configuring your AE System 208 3.2 Hotfix Installation 3.2.1 Installing Hotfixes 3.2.2 Shutting Down and Storing Automation Engine ... 3.2.3 Utilities Installing Utilities (UNIX) ... Installing Utilities (Windows) 212 3.2.4 Changing the Database .. 3.2.5 Installing the Automation Engines 215 Installing the Automation Engine for UNIX 215 Installing the Automation Engine for Windows 216 3.2.6 Installing the Online Documentation 216 3.27 Installing the Agents 219 Installing the Agent for 8S2000 . eae 220 Installing the Agent for Databases 221 Installing the Agent for Java EE/JMX 226 Stand-alone 228 Setting Up the Agent for Java EE/JMX ... ooo 228 Usage with Application Server 227 Setting Up the Agent for Java EE/JMX (Oracle WebLogic) 27 Setting Up the Agent for Java EE/JMX (IBM WebSphere) with RMI Connector 228 Setting Up the Agent for Jave EE/JMX (IBM WebSphere) with SOAP Connector .......229 Setting Up the Agent for Java EE/JMX (JBoss) 231 Setting Up the Agent for Java EE/JMX (Oracle Containers for Java EE) ... eeesee 282 Setting Up the Agent for Java EE/JMX (SAP NetWeaver) 233Contents | vii Setting Up the Agent for Java EE/JMX (Tomeat).. ees 288 Installing the Agent for NSK 236 Installing the Agent for 0$/400 .. 238 Installing the Agent for PeopleSoft 2441 Installing the Agent for People Soft (UNIX) ... 244 Installing the Agent for People Soft (Windows) 242 Setting Up the Agent for Rapid Automation 283 Installing the Agent for SAP 248 Installing the Agent for Siebel (Windows) 248 Installing the Agent for UNIX 249 Installing the Agent for VMS ... Installing the Agent for Windows 252 Installing the Agent forz/OS 3.28 Installing the ServiceManager 256 Installing the ServiceManager (UNIX) .. Installing the ServiceManager (Windows) 287 3.2.8 Comparing Messages .. 3.3 Upgrade Installation 3.3.1 Zero Downtime Upgrade 258 ZDU - Distributed Installation 258 Upgrade Process 260 FAQ - Zero Downtime Upgrade 276 Wateh the Video .. 2278 3.3.2 Upgrading an AE System from Version 11.2 to Version 12 279 3.3.3 Upgrading an AE System from Version 11.1 to Version 12 294 3.3.4 Upgrading an AE System from Version 10to Version 12, 3 3.3.5 Upgrading an AE System from Version 9to Version 12 ...... 3.4 Centralized Agent Upgrade 3.4.1 Centralized Agent Upgrade Process 361 3.5 Changing the Database 372 3.5.1 About Changing the Database 372 3.5.2 Unloading the Database 373 3.5.3 Setting Up the Database .. 3.5.4 Loading the Database 374 .373vil Contents 4 Installing AWL 4.1 Installing AWI - Installation Overview 4.2 Preparing the Installation .. 4.2.4 Installing and Preparing the Application Server 4.2.2 Defining an Administrator forthe Initial AW! Login . 4.3 Installing AW! 378 4.3.1 Deploying the AWI WAR File 378 4.3.2 Configuring the Connections to AE Systems (Required) 4.3.3 Starting the AW! AWI Load Balanced, High Availability and Proxied Configurations .... 380 382 4.3.4 AWI Performance Optimizing 362 383 384 4.3.5 Secure AWI Access using SSL. 4.4 Defining User Rights for AW... 4.4.1 AWI User Privileges: Overview 4.4.2 AWI User Authorizations: Overview 4.4.3 Authorizing Users tothe AWI 4.5 Configuring AWI Login and User Authentication ... 4.8 Logging in AWI 4.7 Customizing the AWI User Interface 308 4.8 Setting Up Dashboards 309 4.8.1 Dashboards inthe AW! 399 4.8.2 Setting Up Home Dashboards for Users 401 4.8.3 Setting Up the Dashboards Perspective 4.8.4 Managing User Rights for AWI Dashboards 403 4.8.5 Other Setup Considerations for Dashboard Widgets 406 4.9 Upgrading to AW! 407 4.10 AWI Configuration Files . tt 4.10.1 uedconfig.xml att 4.10.2 configuration properties 414 4.10.3 logback xml aig 4.10.4 colors. properties 421 4.10.5 Customizing the AW! Configuration Path Azz 4.11 Troubleshooting Problems on AWI Clients. 423 4.12 Preparing Log Files for Error Reporting 426Contents |ix 5 Installation and Configuration of LDAP Sync 5.1 About LDAP Syne 5.2 Installation of LDAP Sync ... 5.3 Configuration of LDAP Syne 42g 5.4 Configuration of Client Settings 6 Installing Package Manager 6.1 About Package Manager 6.2 About Automic Packages 6.3 Installing and Configuring Package Manager 7 Installing Plugin Manager 7.1 About Plugin Manager 7.2 Installing and Configuring the Plugin 442 7.3 Updating the Plugin 7.4 Uninstalling the Plugin 7.5 Installing and Upgrading Packs ... 7.6 Removing Packs 8 Installing Action Builder .. 8.1 About Action Builder 8.2 Installing and Configuring the Plugin 448 8.3 Uninstalling the Plugin 449 9 Installing Analytics (ANOP) 450 9.1 About Analytios 450 9.2 New Installation and Configuration .. 9.2.1 ONE Installer - Single-Box Installation 451 9.2.2 Manual Instaliation of Analytics 467 Installing the Analytics Datastore Steps to Install the Analytics Datastore on Windows Steps to Install the Analytics Datastore on Linux Installing the Analytics Backend 470 Installing the Analytics AWI Plug-in 473 Automation Engine Set-up ama 9.3 Securing the Backend ATA 9.4 Updating the Analytics Installation . 476 10 Installing Process Analytics amlx| Contents 11 Installing the Proxy Third-Party Licenses asChapter 1 About Automic Workload Automation | 1 1 About Automic Workload Automation Automic congratt ttes you on using Automie Workload Automation. Covered Version This guide relates to Automic Workload Automation version 12.0.3. Vendor Information Automic Software GmbH, Am Europlatz 5, 1120 Vienna, Austria, www.automic.com See also About Automic Software, Community and Support. Content of this Section This chapter provides a guideline on the document's revision, scope, purpose and target group and on how touse the document. Your Next Steps Your next step will be one of the following: + Use the ONE Installer- Single-Box Installation for a fast single-box setup for demonstrations testing, or feature previews on-site + Install the Automic Workload Automation: + Install the Automation Engine referring to the New Installation Procedure. + Install the Automic Web Interface, referring to: 1.1 Automic Workload Automation Documentation 12.0 Scope & Purpose ‘This guide contains instructions on hovr to install Automic Workload Automation 12.0. Usage ‘The document structure supports the instructional mode, To improve access to relevant information, this guide provides the following structure and features: + Table of Contents + System Overview + Plot ofthe document + Search for keywords within and print atopic from electronic media To ensure accessibility and timeliness this Installation Guide has to be2. Chapter 1 About Automic Workload Automation + regarded as part ofthe product, + kept with the system to guarantee quick access, + passed onto subsequent administrators of the product, and + accurately updated with possible further documentation updates, Target Group This Installation Guide is intended for users or administrators who want to install and automate their ‘workload using AVA. These personnel have received Training Services on Automic Workload Automation at the required level either through Automic or through an authorized partner. In order to take full advantage of all of Automic Workload Automation's features, look at our trainings: available at: Automic Training&Services Administrators find relevant instructions in the Automic Workload Automation Administration Guide, 1.2 Guides & References - Icons Used This topic describes the available guides for Automic Workload Automation and the icons used in this documentation. Automic Workload Automation Guides ‘The following guides and reference documents are available for Automic Workload Automation: User Guide Detailed descriptions about using Automic Workload Automation ‘Administration Guide Information about administering Automic Workload Automation. Installation Guide Guidelines for planning, installing and updating Automic Workload Automation. Integration Guide Guidelines for integrating Automic Workload Automation with other systems. Release Notes Release notes of the individual Automic Workload Automation versions. Obtaining Guides You-can view and download the most up-to-date version of your guide on docs. automic.com, Icons ‘Waming, indicates possible problems, Critical warning (system crash, DB inconsistency) Provides useful information (such as notes and related concepts). Steps that can only be performed by administrators, we DOOF Indicates a step. For example, an installation step.Chapter 1 About Automic Workload Automation | 3 [Indicates peculiarities that are based on specifications of the authorization system (such as privileges and rights). Tips for easier handling or better performance. 1.3 Safety and Disclaimer of Warranty ‘Automic Workload Automation is designed to manipulate IT systems and its components. Therefore al Quides include wamings, recommendations and precautions that must be observed. Itis within the sole responsibilty of any user or administrator of the Automic Workload Automation system and its components to protect and ensure affected service levels and avoid harm or damage to any system involved, even without any waming in the documentation. Ay Be aware that deploying releases to target systems may lead to major disruptions of services, \werkflows or applications within the production system, Automie accepts no liability for losses arising from the use of AWA or from any changes, mistakes, printing or production errors.4 Chapter 2 AWA Product Overview 2 AWA Product Overview This chapter provides a brief architectural overview. 2.1 Concept of Automic Workload Automation (AWA) AWAis a solution that centrally manages the execution of all your business processes across mainframe, cloud or hybrid environments. AWA gives you the agility, visibility and scalability needed to respond to the constantly changing technology landscape. With AWA you will be able to: + Increase workload processing efficiency + Have endeto-end workflow visibility and control across platforms, technologies, applications and existing automation tools + Eliminate up to 90% of manual errors + Enable more users to create workflows by eliminating scripting and decreasing the specific, knowledge required to automate applications + Ensure compliance with a centralized aucit trail of your processes, errors and remediation Main features of AWA + Centralized management of your business process automation + Scalable, clustered architecture ensures reliability and unlimited capacity. + Provides continuous operations, managing software updates so there is no need for maintenance ‘windows and no downtime forthe service. + Out-of-the-box muititenaney enables you to easily expand a system with additional development or test system orcreate a new instance. + Suppor for mainframe, distributed, virtual and cloud environments + Support for dynamic, event-driven automation 2.2 About Automic Workload Automation (AWA) Automic Workload Automation (AWA), part of the ONE Automation, lets you deliver continuous operations with your business applicetion processing. Workload automation is more complex and more important than ever. The solution is with continuous operations: ‘Automic Workload Automation gives you the agility, visibility and scalability needed to respond to the constantly changing technology landscape. This next-generation enterprise automation product centrally manages the execution ofall your business processes across mainframe, cloud or hybrid environments in away it never stops — even when doing an upgrade to the next version FeaturesChapter2 AWA Product Overview | 5 + Scalable, clustered architecture ensures reliability and unlimited capacity. + It provides continuous operations, managing software updates in a way that there is noneed fora maintenance window and ne downtime for the service. + Out-of-the-box muiti-tenancy enables you to easily expand a system with additional development or test system orcreate anew instance. + Suppor for mainframe, distributed, virtual and cloud environments. + Represents the broadest suite of certified application integrations and workflow templates. + Intuitive web interface that can be customized for monitoring, administration, development and self- service + Dashboard, fitered view of all workflow activities, for highly granular monitoring + Integrated file transfer ensures timely, accurate and secure information transfer. + Forecasting capabilities based on historical data or hypothetical scenarios, + Comprehensive auditing of all automated processing and user activity D ourwWebhelp displays a video here. Call our online documentation to watch the video here! https://wwws youtube. comwatch?v=tFai-2LPPIs, 2.3 Release Highlights This AWA release contains major changes, technical and user facing. Watch our video on AWA and Automic continuous operations: D ourwebhelp displays a video here You can watch the video calling this URL: https://www.youtube.comwatch?v=tFai-2LPPIs. Enhancements in Automic Workload Automation 12.0: + New Automic Web Interface The Automic Web Interface has been revamped to provide an easy-to-use Graphical User Interface that boosts user experience. It includes virtually all functions available in previous versions plus a number of new features and enhancements. Its highly improved performance allows many thousands of agents to connect simultaneously Intuitive dashboards and windows with inne help guide users in their daly work. Flexible, role- based perspectives free users’ workspaces from unnecessary content. + Service Level Management functionality ‘The new SLM functionality makes it possible to depict all the parties involved ina Service Level Agreement via Service Level Objective (SLO) objects. SLM monitors whether the oriteria stipulated in the agreement are met or not, allows to define which actions should be taken in either case and provides timely information on the outcomes. Read all about it here + Service Level Management in AWA - Use Case + Service Level Objective Object (SLO) + Monitoring Services + Improved Zero Downtime Upgrades6 | Chapter 2 AWA Product Overview The wizard introduced with version 11.2 has been improved so that now Work Processes (WP) of different versions can work in parallel towards the same database. The old WP's continue completing old and currently running tasks until they are all worked off while the new WPs carry out all new tasks. + Centralized Agent Upgrade Process As of this version agents can be upgraded smoothly in a controlled and automated process: + Central agent upgrade from the Automation Engine + Single or multiple agent upgrade at the same time + Selectable target version for the upgrade (newer or older version) + All upgrade steps available through the Automic Web Interface + Noneed to login to the agent server + Continuous operation is ensured by the Automation Engine + New keys forthe Java Work Process (JWP)in the UC_SYSTEM_SETTINGS system variable + JWP_KEYSTORE_PATH ‘The JWP uses the default path of the JRW keystore file. Now, this key canbe used to seta path of your choice. Any network path defined by UNC or local paths are possible. + JWP_KEYSTORE_LOGIN An altemative password for accessing the keystore file can be used if you reference a Login ‘object in this key and modify the object accordingly. + With this version, Automic launches Analytics, a new solution for collecting and compiling large ‘amounts of historical data about your Automation Engine (AE) system for analysis and reporting. Find details in About Analytics. + Workflow Completion Acceleration Workflows ina system with the highest amount of already finished tasks are accelerated to ensure eariest possible completion + New key inthe UC_CLIENT_SETTINGS variable WF_COMPLETION_ACCELERATION ensures that active workflows are completed according to their amount of finished tasks. + Recursive passing on of priority from parent to children workflows either via seriot elements ‘or using the new checkbox on the UI + New builtin Validation Checks for Z/OS Agents New integrated tests are carried out before submitting jobs to the JES in cases where they would not run anyway, Whether an agent performs these checks or not is defined ini INI fie + Duplicate job check + Scheduling environment check «+ Initiator check To know more see Special Options for Job Handling Improvement and S390 JOBS. + Automic. Web. Interface. SAP. Forms SAP Forms are available with the Automic. Web interface. SAP. Forms plug-in that you can download from Automic’s Download Center (click here: Automic Download Center (downloads automic.com) ). With SAP Job objects you can execute @ number of SAP functions directly from within the ‘Automation Engine. For this purpose, Automic delivers Forms, that is, predefined sets of ‘commands that depict those functions. Via the user interface you build scriots for SAP jobs without having to worry about their exact format. Read all about it here + SAP Jobs + SAP Forms + SAP Jobs - Child ProcessesChapter2 AWA Product Overview |7 Find an SAP use case here: Creating and Executing an SAP ABAP Job from within the Automation Engine Extended message range in the reports and activation logs of PeopleSoft agents So far, the message numbers in report and activation logs of PeopleSoft agents consisted of seven number digits, for example U1234567, As of version 12.0.1 they contain 8 digits, for example 12345678, Please, remember adapting the search pattems accordingly, in case you are scanning the message numbers. New PeopleSoft agent available as of SP1 (version 12.0.1). Built on a different technology as in previous versions. this Java-based agent provides more functionality than the old C-based one: + Anew command (PS_MARK_DELETE)is available that marks jobs or processes in PeopleSoft as deleted. This allows you to clean up the PeopleSoft process list from within the Automation Engine + Child processes of PeopleSoft jobs are now available as child tasks in the Process Monitoring perspective. Read more at PS Jobs and Child Task. + Remote start of PeopleSoft jobs. If job fails in the PeopleSoft system, its status is indicated inthe lst of tasks in the Process Monitoring perspective. From this list you can now restart it without leaving the Automation Engine. To know more see Monitoring and Restarting Extemal Tasks + When defining a PeopleSoft job, you can enter a seript to be processed for each ofits child tasks. This script is then executed as soon as the child task ends. Find details in Child Post- Process Page. + The Remote Task Managerhas been enhanced to allow you to keep track of processes that have not been started by the Automation Engine via a PeopleSoft job. Read about it here Remote Task Manager Object (JOBQ). + Output files created by PeopleSoft processes can now be transferred to the Automation Engine database, via the Automic Web Interface you can then download them, For more information see Transferring PeopleSoft Output Files to the Automation Engine. + The Automic Web interface provides now Forms, an ackitional, intuitive way to build scripts for PeopleSoft jobs using a grachical interface that provides ready-to-use commands, Lea more about it here: PeopleSoft Forms. @ Touse the PeopleSoft Forms, the corresponding Automic Web Interface Plug in must be installed, For details see AW! Plugin Installation. Please take the following into account: + The installation procedure of the new PeopleSoft agent is slighty different. For details see Installing the Agent for People Soft - Basics. «+ The existing, old PeopleSoft IN| file can be reused with the new agent, see People Soft Agent ‘Searching for tasks within large, complex workflows is easy with the Search field in the toolbar of both the Workflow Ecitor and the Werkflow Monitor. Find details in Searching for Tasks in the Workflow Monitor. A new configuration parameter allows you to define that tasks in a workflow display their names. before their titles, thus improving visibility When writing structured documentation for your objects, you can now use special characters and spaces. Likewise, using special characters and spaces is also possible in the key and scope of variables. The Client column was missing from the list of Agents in client 0. This has been repaired now. Likewise, the Net Area column was missing from thelist of Agents. Itis available now.8 | Chapter 2 AWA Product Overview The Move option was not available for SERV objects in the previous AWI version. As of now, you can also move these objects using this function + The function name Verify Connection to Service Manager used in the previous version was, misleading, since it deletes the Service Manager entries if no connection could be made. It has been renamed now to Update Service Manager Link Inthe previous version, when logging into Client 0 eciting users of other clients was not possible. This problem has been solved now. + Last but not least, the performance of the Workfiow Monitor has been greatly improved. With this version, the time it takes to open tasks has been drastically reduced See also: Automic Workload Automation Release Notes 2.4 Benefits of Automic Workload Automation The Automic Workload Automation is meant to make automating business processes easy, efficient and scalable to the highest degree. ‘The benefits of enterprise workload automation—cloud, on-premise or hybri + End-to-end workflow visibility and control across platforms, technologies, applications and existing automation tools + Eliminate up to 90% of manual errors + Increase workload processing efficiency + Enable more users to create workflows by eliminating scripting and decreasing the specific, knowledge required to automate applications + Ensure compliance with a centralized auait trail of your processes, errors and remediation 2.5 Automic Workload Automation Architecture Automic Workload Automation consists of s overview of their depender eral separate modules and components. Here you find an 1s and basic interaction. General ‘The core of an AWA system is the Automation Engine. An Automation Engine system is a combination of the following modules: + The Automation Engine itself on a server. + The database (Oracle or MS SQL Server), on the same ora different host of your choice. + The agents that communicate via the communication processes (CPs) and work processes (WPs) with the AE. + The main browser-based interface, the Automic Web Interface. + Inorderto set up a single-box installation for quick demonstrations: The ONE Installer In addition AWA as a bundle also contains products that enhance or support the setup you choose with various features: + Process Analytics: Analyze processed, active and scheduled tasks, + Analytics: Use to collect and compile large amounts of historical data about your Automation Engine (AE) system for analysis and reporting,Chapter2 AWA Product Overview | 9 + Package Manager: A commandline too! to retrieve, install or update packages on top of the ONE, Automation. + Plugin Manager: An extension to the AW/ that can be used to install, upgrade and remove Packs in order to extend the functionality of the AWA system, + Action Builder: An extension to the AWI which allows users to create new Actions (sets of objects) for common operations to be used in workflows + LDAP Sync: SSL-supported user permission and credential's management suoport by integrating Active Directory. + Proxy: A small but efficient application to connect separate installations and systems by centrally configured ports, securely Process Assembly Process Monitoring ‘Administration ‘Automation Engine Server AWA Components Automic Web Atomic Web Interface Interface (AW!) ‘Automation ‘Automation Engine Server (AE Server) Engine (AE) ‘Automation Engine Database (AE Database) ‘Automation Engine Agents (AE Agents, Agents) AWA HTML Documentation Documentation PDF Documentation Analytics (ANOP) Action Builder Plugin Manager Package Manager Package updater for ONE Automation Process Process Analytics Admin Analytics Process Analytics Studio Proxy Service program ‘Automation Engine Command Line Utilities AE Desktop Client AE Database Unix/Linux Agents Windows Agents VMWare Agent Webservices Agent Release Notes Administration Guide Installation Guide Migration Guide Integration Guide User Guide Developer Guide Administration Guide Installation Guide Administration Guide Installation Guide ‘Administration Guide Installation Guide ‘Command line tool Administration Guide Installation Guide ‘Command line program to load the data (ETL process) Graphical interface10 | Chapter2 AWA Product Overview LDAP Sync LDAP synchronization with MS Active Command line tool Directory for the Automation Engine ‘Schematic representation of an AWA system: Windows 8 Agent [UKOS Agere Communication Ports ‘The following ports have to be opened for Automic communication. Agent(s) ‘Automation Engine 2217-2219 Agents) Agentis) edChapter 2 AWA Product Overview [11 WebBrowser Automic Wel Interface/Apache 8080 (HTTP) Tomcat £8005 (Shutdown) 8009 (AJP Connector) Automation Email SMTP Server 25 (SMTP) For email notifications and Engine approvals Automation Service Manager asrt Toallow stop/start of agents Engine from console 2.6 AWA Use Case Videos These videos provide a short introduction to the most common use cases of AWA Automic Youtube Channel DP Ourwebhelp displays videos here. Find and watch them on the Automic Youtube channel: https: /twww. youtube.com/channel/UC_xnT4TA2sAzmmudbhZX+0 Automic Academy Videos You can find additional videos by Automic Academy to lear more about individual AWA functions online: https://www. youtube. com/channel/UCp7F6-ZnUzx te_-EJeT1pAg12 Chapter 2 AWA System Requirements and Sizing 2 AWA System Requirements and Sizing The first step in preparing to install or upgrade your Automic Workload Automation system is making sure that you have the necessary infrastructure ready and required components and versions installed. Automic Compatibility Matrix In ofderto install and run your intended system or update an existing one successfully you have to check requirements and prerequisites. Documentation, release notes, and other information is often updated after software is released. The table below shows where to find the most recent information for Automic software releases. Bug fixes, known issues, and workarounds Automic Download Center HTMLS documentation and .paf files for documentation andrelease -Automic Hosted notes Documentation ‘Compatibility for Automic software components, versions, andsub- Atomic Compatibility Matrix ‘components, Please check all Automic components and prerequisites for vendor, version or setup information Details on necessary preparations and prerequisites you find on the pages New Installation or Uparade Installation Sizing of Automic Workload Automation Systems Sizing an AWA system is no easy task, as a number of aspects have to be considered. To help you make your decisions, below you find a table for different workload options and a second table containing the most important considerations a5 Q&A, ‘The first table is meant to help you to make a quick rough estimate for your system setup. It shows. conservative results to be on the safe side. Ay Database systems and database storage have always to be fail safe and redundant. This section does rot deal with that question Automation Engine 512 2x B8Cors 32GB 178 Coes GB Database 4 512 8Cores 32GB 178 Cores GB Utilities 1x 1Core na 20GB 1x 1Core nia 20 cBAgent Service Manager Service Manager Dialog Automic Web Interface User interface Analytics Backend and Datastore Number of Concurrent users Agents Object definitions. Total Executions per day we DWP* JWP* oP, nx <10 <20 1Core 1Core 1Core Cores 1Core Cores <1000 -< 350000 2x4 2x3 2x4 2x2 Chapter 2 AWA System Requirements and Sizing | 13 na 2068 na na na wa 8B 2068 8GB 5GB 16GB 512 GB nx 2Cores na 20 GB nx 1Core nia nla 1x 1Core na na 1x 4Cors 16GB 20 GB nx 1Core 8GB 5GB 1x 16 64. 178 Cores 128GB <50 <100 <50000 <700000 2x8 2x15 2x5 2x2 Automation Engine Database Utilities Agent Service Manager Service Manager Dialog Automic Web Interface User interface Analytics Backend and Datastore Number of 1x 1Core nx 4 nx 1Core 1x 1Core Cores nx 1Core 1x 32 Cores 64GB 2TB na 20 1x GB na 20 nx GB na Wa nx na na 1x 3268 20 1x GB 8GB © 5GB nx 25668 27B 1x 16 96GB 17B Cores 16 96GB 278 Cores 1Core n/a 2068 4 na 2068 Cores 1Core nla na 1Core nla na 8 3268 20GB Cores 1Core 86GB 5GB 32 (256+ 4B Cores GB14 | Chapter2 AWA System Requirements and Sizing Concurrent users <200 > 200 Agents < 1000 > 1000 Object definitions < 100.000 > 100.000 Total Executions perday = 1500000 > 1.500 000 we 2x16 4x16 DwP* 2x45 4x45 Jwe* 2x10 4x10 cp 2x2 4x4 @ The numbers of JWP and DWP ensure stable response times up to the maximum amount of concurrent users. You can adjust the number of processes according to the expected amount of users, Automic Web Interface ‘AWI allows you to make Automation Engine accessible to more users. To guarantee quick response times inthe web interface, the Automation Engine has to handle lots of requests. Most requests are handled by DWPs, and some by JWPs. Automic recommends using separate DWPs so that web interface requests do not interfere with job processing A Web interface requests also generate a significant amount of database I/O, so make sure your system is not I/O bound when making it available to many concurrent users, Analytics @ For medium configurations and bigger installations, setting up a regular backup and truncate forthe Analytics datastore is recommended in order to provide a stable chart performance (e.g. back up and truncate to only keep the last 3-12 months in the Analytics database) Setup Recommendations + The Ul pluginis abways added to the host(s) where AW is installed. + Datastore and backend should be installed on a dedicated host together (one host for backend and datastore) + The backend must be accessible via http(s) from the AVVI hosts and must be able to connect to the datastore and to all required databases (AE, ARA), Adjustments - Questions and Answers After you have got a rough estimation of what to expect, there are some additional aspects to be taken into consideration, which may affect the sizing. Below you finda lst of possible questions and the appropriate answers conceming system sizing for different scenarios.Is the expected load distributed over the day evenly or do you expect high peaks? Is excellent performance important even in periods of peak load? Is the expected load constant or do you expect ‘growth? How long do you need to hold data (statistics, job reports, revision reports) in the database? Doyou expect many huge 0b reports to be stored in the database (e.g, more then 100,000 lines}? Do you planto use ILM? Doyou pianto use Oracle as database system? What hardware to you plan touse for the AE system? Doyoupianto run the Ab/database on virtual nodes? Is logging and traceability ‘over longer period important for you? Is afail safe system important for you? Performance during failure situation (e.g. one node fails): Are the remaining node(s) able to handle the load? Chapter 2 AWA System Requirements and Sizing | 15 Normal: Even: Reduce resources High Peaks: Add resources (cores, WPs) No: - ‘Yes: Add resources (cores, WPs) Constant: - Growth: Consider next sizing level > 12 month: Add more database storage <3 month: Reduce database storage No:~ ‘Yes: Add more database storage Yes: Plan how to deal with switched out data No: Run the AE DB Reorg utility as near as, possible to the database and add storage for ‘output data (if generated) ‘Yes: Add resources on the database node(s) (faster CPUs, fasternetwork, etc. ) Linux/Windows on intel x64: - Others: Add resources Yes: Make sure that computing power is. ‘guaranteed for your systems and other Virtual Machines do not detract from the computing powerlbandwiath. Y:- N: Reduce local disk storage on AE No:~ Yes: Make sure your systems are equipped with redundant components (power supply, network, etc.) and that you have an "always- on’ database environment Example: A twornode system has to be oversized by 100% to be able to handle the load on the remaining node! Consider not only cores and memory, but also the amount of CPs, WPs, DWPs, JWPs, DB- Service agents, ete. If fail safe is crucial for you, consider to run on more than two nodes!16 | Chapter 2 AWA System Requirements and Sizing Do you expect high usage of some agents? Doyou pian to run many ‘agents on a single node (e.g. SAP, WebService...) Do you have many users, who are constantly monitoring activities and workflows? Doyou expect huge workflows (> 1000 tasks er workfow)? Doyou expect huge xml importslexports? Doyou expect to have users in different locations (long distance)? Doyou expect a high load ata particular location? Does load balancing make sense? You are experiencing slow response times Job processing slowed down via database I/O by heavy web interface usage No:- ‘Yes: Add resources to those nodes. Take care that resources used by your jobs are available. No:- Yes; Add approximately 1 GB per Java-based agent to those nodes. (An average used java agent will need between 512-1024 MB, but in some cases this may be more.) No:- ‘Yes: Add more resources to dialog work processes and AWI (run more DWPs and take ccare that cores and memory are available for this additional load). No:~ ‘Yes: Add memory to AB/AWI (expect 1-2 GB per DWP) No: - Yes: Add memory to AE/AWI (expect 1-2GB. per DWP) No:- ‘Yes: Run multiple AWI instances at every location (e.g. on every continent, where users are located), No:- ‘Yes: Run one strong server with plenty of RAM (See high end configuration) In general, the AW needs litle CPU, just plenty of RAM. Load balancing for performance does not make sense. Most load balancers do not support websockets, which the AW uses and which reduce our resource usage per session and improves Ul responsiveness. If you want to use aload balancer for high availability, please talk to our ‘Support Team to work out a good setup for you. Ifthe CPU on the servlet container running AWlis low and you are sure that your database can handle the increased I/O, try increasing the amount of DWPs and JWPs. Intimes of heavy web interface usage, you can temporarily reduce the number of DWPs in order to take load off the backend while working on improving database I/O.Chapter 2 AWA System Requirements and Sizing | 17 What is the requireddisk To estimate the disk space required in the space? datastore you can calculate with about 16B for 1,000,000 executions in the Automation Engine Dol needtoback upthe The Analytics datastore was created to store datastore? large amounts of data. If you have a medium or bigger installation it might stil be useful to remove data older than approx. 1 yearfrom the Analytics datastore. It is recommended to ‘setup the provided backup actions (ANALYTICS ACTION PACK) General Database Rules This is valid forall DB vendors - the log files must/should be placed on the fastest available disks (=SSDs). ORACLE: REDO LOG FILE DESTINATION ‘SQLSERVER: TRANSACTION LOG and TEMPDB files DB2; LOG files LOG and DATA files must always be on separate DISKS /LUNS Transaction Times Transaction times indicate the overall system performance, To evaluate your system, you can tun on a minimal trace on a WP in the Administration pers pective (set trace flag 16 (minimal) to 1). Run the trace for 2 minutes during a typical load situation. Collect the trace files and evaluate them. ‘Along with several other information you get the average transaction time calculation over all transaction. ‘This may look like tis Time Trace cnt SR Avg. Time SR Sum SR %SR/Trace “all 2117293 @,0159 —-274,3200 —1306,29 MQ @ — @,0000 0,000 0,00 MQHEM e Na n/a w/a sum 274,3200 1306,29 ‘The above illustration shows that the average transaction time of more than 17,000 transaction was 0,0159 seconds. Compare your value with the recomimenditions in the table below’ >0.2sec Critical > 0.05 sec Tobe improved > 0.02sec OK <0.02sec Perfect18 | Chapter 2 AWA System Requirements and Sizing Troubleshooting 1 Local system is too slow CPU is too siow 1 Increase CPU speed = Increase CPU count (Other apps consume too much CPU Run the Automation Engine exclusively on your nodes. power on yournade The system is under memory = Add memory pressure = Reduce memory consumption The virus scanner slows down I/Os Avoid running the virus scanner on your production node, 2. Database is too slow Connection to the database is too = Increase network speed/capacity slow = Reduce the distance to the database Database transactions are too slow Mirror or similar issues: Reduce the distance to mirror or use other (faster) fal safe features. Check CPU speed/usage/count Check memory size/usage Check storage speed/capacity/usage of other apps Check database maintenance (index reorganization, etc.) Check query optimizer (settings, statistics, etc.) Consult your database vendor for improvementsChapter 3 Installing the Automation Engine | 19 3 Installing the Automation Engine 3.1 New Installation 3.1.1 ONE Installer - Single-Box Installation 19 3.1.2 Planning the Installation 35 3.1.3 Installation Procedure .. 3.1.4 After Installation 3.1.1 ONE Installer - Single-Box Installation The ONE Installer allows a fast single-box setup for demonstrations, testing, or feature previews on-site. Prerequisites are kept to a minimum (for example a database and user, a local login and free local ports are required). The installer is available for Automic Workload Automation (AWA), Automic Release Automation (ARA) and (Automic Service Orchestration) ASO. BP The following contains an overview of the steps the ONE Installer ill pass and the necessary user interactions for a few individual steps. A, Updating from previous AE or versions is not supported. As of v12the ONE Installer will install the Automic Web Interface exclusively. The former Ul will not be part of the installation anymore. @ Autornic recommends using a separate VM for the DB or assigning a fixed amount of memory to the SQL Server. ONE Installer in Action - Video ‘The installation using ONE Installer is a breeze. Watch our video to get an impression of the fast and easy installation process: D Ourwebhelp cisplays a video here. To watch the video online, vist this URL: https:/youtu.be/set3ngzDzQ Requirements Operating Systems Windows: Windows Server 2012, 2012R2 Linux: Redhat Enterprise Linux 6 ‘SuSE Linux Enterprise Server 1120| Chapter 3 installing the Automation Engine Database Microsoft SQL Server 2012, 2014 Oracle 11.2, 12¢ ‘SQL Native Client 2016 is supported Ports The following ports and port ranges need to be free respectively 2217-2221 (for CP connections) 2270-2278 (for WP connections) 8005, 8009, 8080 (for Tomeat connections used by the AW!) 8871 (ServiceManager) For ONE Installer setup recommendations, referto the small configuration section in AWA System Requirements and Sizing, You have to prepare the following before starting the ONE Installer: + Store the Automie license file on your machine and point the installer to it 2s soon as its requested. + Install the database driver for the database that you will use on the same host that the installer will be executed on + Oracle: Oracle Database Client + MS SQL: SQL Server Native Client 11 + Download the JDBC river for the database you are using (Oracle, MS SQL Server) + Create AE databases and users: Youneed anew, empty AE database and a new, dedicated user with dbowner permissions, + Inthe profile configuration of an Oracle DB (SQLNET.ORA) in the parameter NAMES DIRECTORY PATH enterezconnect to the list of values. + The AE connects to the database via TCP/IP, so you need to make sure that your server and client have TCPIIP connection enabled. For an MS SQL Server, use the MS SQL Configuration Manager tocenfigure this. + User name and password of alocal user account + When using Windows Server 2016, make sure the following features are installed + NetFx3 + NetFx3ServerFeatures To install them, enter the following in the command line: Important Notes § On Windows + Make sure you do not have a Windows service for the ServiceManager registered prior to running the installation. + You require administrative rights to execute the installer. On UNIX: + You must execute the installer with root privileges + Executing the installer from network shares with NFS is not recommended. The Automation Engine utility is linked against 11 OCI client. Ifyou are using acifferent Oracle client version, you must create a SYM LINK for 11G like In -s libcintsh.so.xx.x libeintsh.s0.11.1, vihere vec.xis your Oracle client version.Chapter 3 installing the Automation Engine | 21 Installed Packages and Components: General Information ‘Additional Action packs and/or RA solutions will be installed, if present and a valid license contained in the license file. The contents of packages is determined by Automic and may vary between releases, ‘The installation will set up an AE system with additional client and user account besides the system client During the attended mode and the CLI mode installation you will be asked to enter the necessary information You will be able to configure the ports for communication processes and work processes (CPs and WPS). Please take into account that the installer will open the ports for and start 2 CPs and 5 WPs. Youhave to start additional processes manually ‘The ONE Installer creates a log file in the root installation folder (e.g., C:\Automictinstall.log). ‘The ONE Installer installation provides the following: + Automation Engine (SWP/2xCP/1xJWP) + ServiceManager (all processes will be managed through the ServiceManager) + ServiceManager dialog (Windows only) + Automic Web Interface + Analytics + Utilities + Oracle Java + Tomeat + Package Manager + Local OS Agent + RA Web Service REST, RA Web Service SOAP, FTP, JMS (will be installed, if present) Post-installation Task (Optional) As a performance enhancing task you can change Max Perm Size and Heap Size of your Tomcat prepared by the ONE Installer as described in Installing and Preparing the Application Server. Available Installation Modes + Attended installation using the ONE Installer installation wizard, + Unattended installation using a file containing the required information. + Command line interface installation Attended Mode: 1. Unzip the delivered files to a local directory of your choice and start the installer using instal1.exe /instal1.sh @ The installer will automatically instal all components you downloaded and unpacked, depending con the packages present 2. Afterstarting the installer, the second screen will display the installation overview.22| Chapter 3 installing the Automation Engine Installation overview This installer wi guide you through the installation for a default Automation Engr (AE) Inducing OS Agent, Utlies, Service Manager (ialog) and the Automic Web Interface ready to login on this machine. ‘You wil need the flowing to complete tis installation: Access to a database and uter credential forthe db-owner Autome leans fle using the instalation you wil be ether asked to provide thisinformation or they are partof preraquste cracks the netaler dss inthe background to ensure metalation can be completed successful ‘The instalaton is meant to be used for proof of concent, testng purposes and non-production use orly. More information on Automic products andthe instalation process can be fourd at htt: /!docs.automc.com, 3. The ONE Installer checks, ifthe precontitions are fulfilled @ On the left hand side of the pane you see a short list ofthe installation steps If the ONE Installer finds discrepancies, it wll attempt to fix the preconditionsChapter 3 installing the Automation Engine |23 4, Youwill be asked to define the database you chose to install (MS SQL or Oracle) 5. The installer will then check whether the necessary database drivers are present. 6. You will be asked to point the installer to the JDBC driver of your database. @ Use the provided download link, if you need to download the latest version.24 | Chapter 3 installing the Automation Engine {JDBC Driver Selection Please select the ar fle contaning the 308C-Orves for your databace. Use the most recent veroon ofthe driver. ec sere lion NEL Oetanieca Youmay obtain the latest 208C driver from your database vendor's donnload site at Mizosofe Point to JDBC {example for Microsoft, if MS SOL has been s cted as database before), 7. Port Configuration The ONE Installer will present you with a default list of ports for CPs, WPs and the base components mentioned above It checks for unused ports in the system inthe port ranges listed in the table above and will then configure those. © The dialog dis played below will only be shown in case no suitable ports are found. e ONE Installer will check every entry you make as soon as a field looses focus and you enter F The ONE Installer will check every entry you mak field | fe dy values into the next one. Only ifall checks succeed will the installation proceedChapter 3 installing the Automation Engine | 25 choose port configuration =y ‘Atleast one standard port was ocamped, Which ports shoud be used? 4 Port anges: (SPors) (2217,2218,2219,2200,2201 \we (10 Ports) [2270,2271,2272,2273,2274,227S, 2276 2277,2278,2273 | €) Single Ports 05 Agent (2300 Anaiytcs Backend 6050 Service Manager [8671 Analytics Data Store 5454 Tomeat-HrTe [2090 Tomeat - Shutdown [8005 Tomcat-aP [2009 Enter the database connection values for the AE database. @ You can test the connection using the button provided. ONE Installer wil test the connection ‘automatically 2s soon as you click 'Next26 | Chapter 3 installing the Automation Engine ‘choose Automation Engine Database =v Pease enter the databace connection propertes. Be aware that an SQL user is equied. Integrated authentcton i not supported, ? @ simle 9. Decide in which directory the files should be installed. The default is C:\Automic, but you can change that to any local path ¥ Spaces in paths are not allowed, so take care to define a path without spaces,Chapter 3 installing the Automation Engine | 27 Choose Install Directory Where would you Bee to instal?28 | Chapter 3 installing the Automation Engine 10. Point to the path of your license file you got from Automic. Choose License Where your hense fle located? 11. Youwill be asked to confirm the license information pertaining to the external software (e.g. Oracle Java) that will be installed.Chapter 3 Installing the Automation Engine | 29 Please read the folowing License Agreement. You must accept the terms of ths ‘2greement before contrung with te instalation, ‘Orade Java willbe instaled. Yau have to accept the Orade Binary Code LLcense Agreement order to proceed. Subsequently you wl fd the ‘nobces of ted party software used by the inetaler. \Orace Binary Code License Agreement forthe Java SE Platform Products land JavaFX [ORACLE AMERICA, INC. (ORACLE), FOR AND ON BEHALF OF ITSELF AND ITS SUBSIDIARIES AND AFFILIATES UNDER COMMON CONTROL, IS WILLING TO LICENSE THE SOFTWARE TO YOU ONLY UPON THE [CONDITION THAT YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS [BINARY CODE LICENSE AGREEMENT AND SUPPLEMENTAL LICENSE TERMS (COLLECTIVELY “AGREEWENT?, PLEASE READ THE AGREEMENT. (CAREFULLY. BY SELECTING THE "ACCEPT LICENSE AGREEMENT" (OR THE [EQUIVALENT) BUTTON AND/OR BY USING THE SOFTWARE YOU [ACANOWLEDGE THAT YOU HAVE READ THE TERNS AND AGREE TO THEM, + © Taccept the agreement do not accept the agreement 12. Enter the client data for the first client the ONE Installer will create. Choose a client number between 000% and 9999 (0000 is reserved forthe system client), a user name, the department and a password30 | Chapter 3 installing the Automation Engine User information ‘Automic is mult-trancy software, Th instaler will create a dent fer you to work with. The information provided on his panels used to create your log credentials. You can change the provided efault values. You wil need the information tologn after the rrstalaton 18. Enter the credentials which the agent should use to execute jobs on the machine on which the ONE Installers running and the Automation Engine will be installed. A, Take care to enter the correct user credentials, as the information will nt be checked in this step.Chapter 3 installing the Automation Engine | 31 ‘Agent Login information Pease provide a user which is used by the Agent to execute jobs on thie machine. peers . Username: [abes Pasonord: evee 14, The instalation will start and a progress bar and information about the installation progress will be visible. After successful installation, the AW! login page opens in your defauit Internet browser. Log in with the user credentials that you specified during the installation. Unattended Mode In order to use the installer in unattended mode, you can start the installation and use a configuration file with the extension .varfile. Call it by using the following arguments in the directory you extracted the files to: (On Windows: = Ontinux: Important Notes ‘You can choose any name for the. varfile, Defining an installation directory path is optional ¥ Special characters have to be escaped out, as shown below. The parameters have tobe entered and used as shown in the example. § The port configuration in unattended mode works with unused ports in the system only. Ifthe ports cannot be configured in the above mentioned range, the ONE Installer will abort the installation with an error message in the install log.32 Chapter 3 installing the Automation Engine LY Inspite of ports you specify in the .varfle, the ONE Installer may choose different ones during the installation process. Check the installation og fle for the actually used ports. Example .varfile \\12.1.0\\dbh The .varfile Parameters: DB_INPUT_ Define if simple or advanced database connection values should be used MODE for AWA. Allowed values: SIMPLE or ADVANCED DB_SERVER Type of the database serverto use. 0: Microsoft SQL-Server 4: Oracle DB_HOST Name or adress of the database server that the new AE installation should use. DB_PORT IP port that is used to connect to the AE database. DB_DATABASE —_Name of the database (MSSQL) or SID/Service-Name (Oracle) that the AE installation should use. DBL This setting is only used for installations that use an Oracle database (DB_ CODESETSinteger Server= 1). 0: UTF-8 1: 1S0-8850-15Chapter 3 installing the Automation Engine | 33 DB_USER DB_PASSWORD DB_ODEC DB_JDBC JDBC_DRIVER_ JAR UCENSE FILE CLIENT USERNAME DEPARTMENT PASSWORD LOGIN_USER LOGIN_ PASSWORD PORTS_CP PORTS_WP. PORT_OS_ AGENT PORT_SERVICE_ MANAGER Name of the database user in the AE database, Password of the database user in the AE database. Used when DB_INPUT_MODE = ADVANCED Connection string for ODBC connection of CP, WP and Utilities Example: ODBCVAR=NNINIORO , DSN=MY_TNS_NAME; UID=MY_USER; PWD=MY_ Pil; SP=NLS_LANGUAGE=AMERICAN, NLS_ (MERICA , CODESET=WESMSWINL252 , NLS_LENGTH_ Used when DB_INPUT_MODE = ADVANCED Connection string for JDBC connection of JWP Example: jdbc: sqlserver: //MY_HOST:MY_PORT; databaseName=MY_ DATABASE; user=MY_USER; password=MY_Pw Location of a JDBC driver file that should be used to connect to the AE (and Automic Release Automation) database. This fle has to match the choice in DB_SERVER and the installed database and Java versions. Location of the Automic license file that should be used by the newly installed system Client number of the AE client that is created by the installer. User name of the AE user that is created by the installer. (Use AE allowed characters.) Department of the AE user that is created by the installer. (Use AE allowed characters.) Password of the AE user that is created by the installer. User name fora Login object that will be used by the OS agent. This should match a user account on your local system. Password for the user account specified in LOGIN_USER. Group of ports that will be used by the CP processes. Exactly 5 ports have tobe provided. Defauit value: 2217,2218,2219,2220,2221 Group of ports that will be used by the WP processes. Exactly 10 ports have to be provided. Default values: 2270,2271,2272,2273,2274,2275,2276 2277, 2278,2278 Port forthe Windows~/Linux agent. The agents use this port for fle transfers and to communicate with UCUMELD Default vaiue: 2300 Port for the Service Manager. This port is used by the ServiceManager Dialog to communicate with the ServiceManager. Default value: 887134| Chapter 3 Installing the Automation Engine PORT_TOMCAT_ Tomcatwill serve the AW installation on this port. amr Default valve: 8080 PORT_TOMCAT_ Port that is used to send a shutdown command to Tomeat SHUTDOWN Default value: 8005 PORT_TOMCAT_ Tomcat AJP port aa Default value: 8009 PORT_IS The Microsoft Intemet Information Services will be extencled with a new site definition that uses this port. This site is then used by the AWI to communicate with ARA. Default value: 80 PORT_ Analytics Backend. ANALYTICS_ BACKEND PORT Defauit value: 8090 PORT_ Port that is used by the PostgreSQL installation that is installed with ANALYTICS_ Analytics. POR ORE Detautt value: 5434 Command Line Mode The installation steps will be the same as in GUI mode. You will have to enter the required information cor confirm actions, using the displayed commands or options. 1. Inorderto start the installer, in Windows (or Linux) open a command line window in the directory you unpacked the files to and then use the following commands: Windows: «: Linux: « ane 2. Ashort installation overview will be displayed. The installer then will check if preconditions have been fulfilled and attempt to fix them, if discrepancies exist Define the database that you installed (MS SQL or Oracle). Point the installer to the JDBC driver of your database. Enter the connection values for the database. Choose the installation path, Default is C:\Automic, but you can define a path of your choice. ¥ spaces in paths are not allowed so take care that the installation path does not contain spaces. Point the installer to your license file you received from Automic. 9. Confirm the license information pertaining to the external software (Oracle Java) that will be installed 10. Enter the client data for the first client the ONE Installer will create. Choose a client number between 000% and 9999 (0000 is reserved forthe system client), a user name, the department and 3 password 11. Enter the agent's credentials to execute jobs on the machine on which the ONE Installer is running and the Automation Engine will be installed. A. Take care to enter the correct user credentials, as the information will not be checked in this step.Chapter 3 Installing the Automation Engine | 35 12. The installation will start, and after successful installation, the AVI login page opens in your default Intemet browser. Login with the user credentials that you specified during the installation # The system that has been installedis a basic Automation Engine system, For high redundancy or more sophisticated setups please continue with the additional pages of the installation chapter. Comments Ay The installation sets up the ServiceManager to be started automatically on system boot as a Windows Service or Linux daemon script All other Automic processes are then automatically started by the ServiceManager. It is possible that not all processes can be started at boot time. Example: ‘Tomcat cannot start because another process has already reserved the required port 8080, which results in the AWI not being available. In order to check that all processes could be started, do one of the following + Start the ServiceManager dialog and check if any processes are displayed in red + Open the Service Manager log file and look for errors, ‘The Service Manager log file can be found in the ServiceManager ./temp directory Ay The Analytics datastore is based on PostgreSQlL for which the setup requires superuser access. The CONE Installer automatically installs and configures PostgreSQL with the following defaults and executes the included setup psql and generate_api_key.psq: + superuser: postgres + password: postares + port 5434 3.1.2 Planning the Installation Introduction Welcome to the AE installation Guide. The following chapter explains the installation and operation principles of your AE system, Different environments will require use of different components, each with its ov installation procedure. ‘The main installation areas are: 1. Installing the components, 2. Creating Clients and Users 3. Configuring the AE system 4. Creating an Authorization System Each of the above areas includes its own set of steps. Individual documents or chapters provide descriptions of each set of procedures, while also making it easy to maintain a clear overview of each portion of the process. Ay Proper use of the Automation Engine requires at least two AE systems to be installed. Read the guidelines regarding a test and production system before you begin the installation.36 | Chapter 3 installing the Automation Engine Ax Donot use directory names for the Automation Engine and the Agents that include blanks. For further details, see http:!/support2. microsoft. com/kb/102739/en General Information Information about the computers in the Automation Engine environment and their file structure are included below. Computers in the Automation Engine Environment ‘The following computers are required to install Automation Engine: + DB computer: The computer where the database is installed + Server computer: The computer where the Automation Engine Server processes are installed + Admin computer: The computer used by an administrator, Database administration must also be installed on this computer (such as utilities, including the SQL Server Management Studio (SSMS) and ISQL_w for MS SQL Servers), + User computer(s): Computers where Automation Engine users work + Host(s): The controlled and monitored computers where Automation Engineagents are installed. Itis not necessary to have an individual computer for every purpose. Depending on your environment, the ‘following combinations are possible and useful: ‘Server computer (recommended) Server computer = Admin computer In the installation instructions, the terms explained above are used to describe the various computers, ‘whether they refer to one computer serving several purposes or several computers each serving one particular purpose. A. Autoric strongly recommends installing the individual components (such as Automation Engine, Userintertace, utlties, and particular agents) in separate directories, in order to avoid conflicting library files Communication Ports ‘The following ports have to be opened for Automic communication. Agent(s) ‘Automation Engine 2217-2219 Agent(s) Agent(s) 2300 WebBrowser Automic Web Interface/Apache 8080 (HTTP) Tomeat 8005 (Shutdown) 8009 (AJP Connector) Automation Email SMTP Server 25 (SMTP) For email notifications and Engine approvals Automation Service Manager e871 Toallow stop/start of agents Engine from consoleChapter 3 installing the Automation Engine | 37 File Structure ‘The file structure shown below is created by default if you use the folders that are suggested in the Windows setup programs: Each sub-folder contains a BIN folder in which the program files are stored. Automic recommends creating a similar structure ff you use other operating systems. In UNIX, the BIN folderis created when the TAR files are unpacked. ‘The installation documents use "AE" as the system name, the description for the database connection, and the name of the installation directory. This is our recommendation for reasons of clarity. If other names are used, keep this in mind and adjust them accordingly in each processing step. See also: Notes for Configuration-File Adjustments. @ Files that are downloaded from the Automie Download Center can be write-protected. Change their file attributes to make them writable. ‘The programs stored in the directory IMAGE: \Toolsino_supp are diagnosis and test programs, and should be processed upon request of the Automic Support team. Dos & Don'ts in Automation Engine ‘Automie strongly recommends keeping the following in mind in order to make best use of your AE system. ¥ Dos + RunanAE system for production plus atest system. + Use an authorization system, encryption and authentication in order to ensure secure processing. + Regularly maintain the AE database using the available utlities and database processes. + Use AE's object orientation in order to keep your processing steps well structured + Store Calenciar objects centrally in orderto make them accessible for all tasks. + Use Include objects in scripts wherever applicable. + Check rettum codes for potential errors in all processing steps. @ Donits + Donot directly modify AE database contents without using AE programs. + Donot implement modifications and extensions without prior planning, + Donot use newly created or modified jobs, workflows ete. in your production system without checking the test system beforehand, + Donot assign object names without an adequate naming structure, + Donot select non-cescriptive names for objects, agents, script variables ete. + Dornot divert AE functions from their intended use. + Donot activate traces without being assisted by the Autornie Support team, Test and Production System Guidelines for using AE General An AE system is an environment which can be handled and monitored with AE. This includes components Such as the Automation Engine and agents, their computers, apolications and processing which can be38 | Chapter 3 Installing the Automation Engine defined via objects. We strongly recommend working with three AE systems. The first system serves to plan and create the objects which represent your processes (development system). A second AE system should be used to test all processes. The third one is used to execute your daily business processes (production system). ‘There is a clear philosophy behind this three-system environment. You business processes are extremely important. Simply changing or adding workflows or system settings might put them at risk. Thus, they must be tested in a separate system environment before they can be used for productive operation Three-System Environment In the production system, you can use a separate client for the development system. ‘Test and production system must be physically separated in any case, This ensures that new procedures. can be tested without putting your business processes at risk Partition means: + Two AE systems + Each AE system has its own Automation Engines, agents, etc. + Both systems use different computers. + Both are equipped with the same hardware and software (OS, database, third-party software etc.) + Optimally, the AE systems run in different networks. + The same authorizations and AE settings (variables, INI files etc.) apply for both systems, + The test system has the same objects as the production system. @ The test system should be as far as possible identical to the production system. ‘These settings ensure that newly created jobs are tested under productive conditions. The impact of modifications can be optimally tested in a test system, Updates to new Automation Engine versions, operating systems and databases can be carefully planned and tested with the most obvious advantage still being that your production system is not put at risk. Imerovements and modifications are only transferred to the production environment after extensive testing. Maintaining Your AE Systems Regularly check compliance with the above rules and maintain the AE database on a regular basis using AE's utlties and the relevant database-specific tools Objects can easily be transferred between the different AE systems using the Transport Case. As opposed to imports, the Transport Case has been designed to transport numerous objects to an AE system. Extensive tests in the test system are always recommended before objects are transferred to the production system. Analyze the log files of all AE systems. This is also possible in an automated form using a job that fitters particular keywords (such as "error") with the script element PREP_PROCESS FILE Upgrading an AE System