Preparing for the Installation

As an administrator, there is a series of preparatory steps you must take before installing your system.

System Requirements

The first step in preparing to install or upgrade your AAI system is making sure that you have the necessary infrastructure ready and required components and versions installed.

{SUZANNE: When working on Overview — Installation, review the Preparation topic and get input from a few more people about the sequence of requirement. Also take a look at Martin's resources on his AAI Portal. Can we bringsome of that in to the doc? Or can we at least link to some of it???}

Consideration When Using the Install Wizard

Before you install AAI, you decide whether you will allow AAI to automatically size your AAI database based on the information you provide during installation, or if you will work with support staff to complete a pre-installation survey that will determine the sizing requirements for the AAI database. In either case, you have to gather information from your scheduler environment. {Suzanne: Work on this with Becky after she has a chance to check what sizing is currently suggested by the Install Wizard (the installation wizard.) Explain better why this is here. Does everyone use the installation wizard? Do we have steps for installation without it? Why the either case??? }

OS Requirements

You can install AAI on a Windows or UNIX Operating System. VMware environments are supported as long as the OS loaded on the VMware image is one of the Operating Systems supported.

Use the compatibility matrix (compatibility matrix) to find the relevant information on supported versions, setup, or prerequisites. Check all Automation Analytics & Intelligence components and prerequisites for vendor, version or setup information. For more information, see Compatibility Information.

Sizing the Environment

A sizing worksheet is provided to help you determine the appropriate sizing for the servers that you need to run an AAI environment for your scheduler loads. After you enter the values for the schedulers that you want to connect to AAI and other input about your environment, the sizing worksheet returns a summary of the following values to provide you with guidance for capacity planning:

• Memory
• CPU Cores
• Disk Space
• Database Sizing

{Authors: This is good for us to know (from Steve Szetella in a chat thread from April 7, 2025): First, our analytics are memory and CPU intensive. AAI caches a large amount of data so we can quickly make wide-ranging predictions taking many things into account (machines, virtual resources, historical performance, job dependencies and more). Second, we are actively working on horizontal scaling of the memory footprint by introducing hazelcast. This will allow for many small servers rather than one very large server, which generally should help customers. This will take a while, but work is well underway. I would not commit to a specific timeline, but it is looking something like end-of-year / first quarter FY26.~???}

To open and use the sizing worksheet to determine server sizing requirements

In the yellow shaded fields on the worksheet, enter the values for your environment. Then use the calculated results that appear in the remaining fields to guide you when planning for required servers and capacities.

1. Open the Sizing Worksheet.

2. In the first section, provide values to determine the overall job and execution load that you want to connect to AAI in the related yellow-shaded fields in column C in the worksheet.

   Scheduler instances and execution load

   • Total number of jobs in all the scheduler instances that you want to connect to AAI. depending on the scheduler types, depending on the scheduler types:

     • The total number of jobs in all instances of AutoSys, Automic, Control-M, CA7, ESP, and Tidal, (but not IWS) schedulers (line 3)

     • The total number of jobs in all IWS scheduler instances (line 4)

   • Percentage of job count growth per year (for example, 5%) for all schedulers

   • Total number of scheduler instances that you want to connect to this AAI server

   • Total number of job runs per day in all connected scheduler instances

   • Percentage of job run growth per year (for example, 10%)

   • Number of days of History retention

   • The last items in lines 10 and 11 apply only to a very large installation in which the execution memory footprint quickly becomes very big. In the worksheet they are both set to the AAI default value of 48 hours.

     • Hours of completed job runs in memory (server parameter recentRunsDuration: default 48 hours)

     • Hours of forecasted job runs in memory (server parameter forecastPeriod: default 48 hours)

     Important!

     Do not change these without consulting with Broadcom Support or a Client Services Consultant. The default value of 48 hours, which gives you many of the operational benefits that AAI offers. Only in special circumstances might Broadcom staff might advise reducing these values.

     Furthermore, if you want to change this behavior, after installation, you have to change the values of the related server parameters in the AAI Configuration Tool. For information, see Configuration Tool - Params Tab

3. Provide additional input required to determine server sizing in the related, yellow-shaded fields in column C.

   • AAI Platform Server

     • Amount of memory necessary to run the operating system and other required software (GB) (line 14)

     • Recommended: To plan for a buffer for the AAI server needs, add the minimum storage and usage values in lines 15–18)

   • AAI Connector Server (calculate separately for each scheduler type: Automic, Control-M, ESP, IWS)

     • Amount of memory necessary to run the operating system and other required software (GB) (line 21)

     • Note that lines 22-25 are populated with the minimum values that are recommended to be reserved as a buffer for your connector needs.

     Important!

     You need to calculate and note these values for each Automic, Control-M, ESP, IWS scheduler that you want to integrate with AAI. These use their own, specialized connectors, and you need to consider their storage and server needs separately.

     Note:

     In most cases, you can run all connectors for all your scheduler types on the same server. When you are unsure, consult with Broadcom Support or a Client Services Consultant. For more information, see {Suzanne: Add link to the related graphic when it's ready and added to the doc..~???}.  { Reviewer: I thought we tell them to instal the Automic connector near teh Automatoin Engine? Am I wrong? What are our recommendations for the other integrations??? — Suzanne}. { Suzanne: Check the connector topics and get links for the reviewers as needed before sending to review.??? }

4. Use the resulting values that apply to your environment as input when planning your server provisioning.

AAI Database Requirements

 {Suzanne: A minor thing, but if you're going through the whole installation/upgrade topics, it might be nice to choose an order that the DBMSs are mentioned and do that consistently throughout all topics. Oracle. SQL Server, PostgreSQL? }

The AAI database is the application database. This is where the AAI system configuration settings, user information, business view hierarchies, historical run data, and copies of the job definitions from the scheduler instances are stored.

The DBMS supported are the following:

• SQL Server - 2012 or later
• Oracle - Version 11 or later

Based on the sizing requirements for your AAI database, make sure you set up the AAI database partition and that you are ready to run the SQL generated from the AAI installation process. This SQL is then used to create the AAI database. {Suzanne: Double check with Steve whether this applies to all 3 DB types???}

Java Requirements

Make sure that Java JDK 1.8.x is installed on the AAI application server and configure the JAVA_HOME environment variable accordingly.

For more information, see Compatibility Information.

Application Server - JBoss

AAI uses JBoss as its application server. The correct version of JBoss comes with the AAI installation package and it is automatically installed with AAI, so you do not need to do anything to ensure that AAI has the right JBoss installed.

Downloading the Product or Solution

Make sure you have downloaded the relevant product bundle or solution. For more information on how to download the relevant component(s), see Downloads. {Suzanne: This reference is not adequate for users. This topic here is telling them what they need to install AAI presumably for the first time. We should tell them exactly what they should download rather than let them find their own way...or not. Also see the notes I put in the placeholder topic for proposed revisions in Downloads - NEW ~???}

Other AAI Prerequisites

 {Suzanne: Review this list. The items are very different in the effort required, and the type of thing. Collecting information is different from installation a component/application. Some are necessary, some depend on what you intend to set up. Also, why is this a numbered list? Is this a sequence of steps? Is it a hierarchy of importance? And, it would be good to add, if it's not already included, a topic/section with what you need to specify in the Config Tool at whatever stages of the installation/implementation. If I get a Config topic/section, find a way to start to collect all those notes about what needs to be enabled for which features, maybe use snippets for the configuration info and have that in the topic as well as in notes with the features. IT migth be a good time to introduce the Admin Note. }

After meeting the system requirements described above, also make sure you cover the following additional prerequisites and preparatory steps :

1. Keep the hostname, port, database name, user id, and password for the AAI database at hand. You will need this information during the installation process.

2. Make sure that an Oracle, SQL Server, PostgreSQL database is available on the host where the AAI database is installed and that you have administrator access to the database.

   Note:

   It is not recommended that the Oracle, SQL Server, or PostgreSQL runs on the same server that runs the integrated solution instance. {Suzanne: For Step 2 and this note, are these talking about the DB that's going to be the AAI DB? If so, make this clear? Doesn't it have to be a dedicated DB, or only a partition. Find out and make this clear. Is it just any Oracle etc., or is it the one you have prepared and earmarked for the AAI DB?

3. If you want to set up an SNMP host for email notifications from AAI , have the SNMP hostname, port, and community ready. For information, see Configuration Tool - Other Tab.

4. For Linux only: Make sure that you have the xvfb (X virtual framebuffer) server installed on your Linux server. This is required by the Webswing server that the AAI Configuration Tool runs on. If this is not installed, the installation stops and an error message is issued.

   Note:

   The message also contains the following remediation steps:

   1. Run the appropriate command:

      • On Redhat/derivatives: yum install xorg-x11-server-Xvfb

      • On Ubuntu/derivatives: apt-get install xvfb

   2. Re-run the installer/upgrader.

5. For AutoSys only: Make sure to prepare and ensure the following:

   1. Create a read-only ID for the AutoSys database(s) that AAI will use to query AutoSys.

      For Oracle, ensure that the read-only ID has synonyms on all the tables on the AutoSys database. This is to ensure that non-dbo queries do not require dbo.tablename on that database.

      First we need to create a read-only user ID in the AutoSys database which AAI uses to connect to the scheduler. Your DB team creates synonyms on all tables to ensure that non-dbo queries do not require dbo.tablename on the user ID. The AAI read-only ID is not the owner of those tables and so it cannot issue queries on them.

      A non-unique index is required on the event_time_gmt column in either the event or proc_event table on every AutoSys database that will be accessed by AAI.

      The AutoSys client must be installed on the AAI host. Unlike many other integrations, AutoSys requires no framework or TLS setup. Encryption and authentication are provided natively by the database itself. xxxxx

   2. Create a non-clustered, non-unique index on the event_time_gmt column in the event or proc_event table on every AutoSys database that will be accessed by AAI.

   3. Determine the format of your AutoSys archive files (for example, MM.DD.YY).

6. For Airflow, Automic Automation, Control-M, ESP and IWS: Make sure that both the integrated workload automation platform and its corresponding connector are set up and running. For information, see the related topic under Workload Automation / Scheduler Integration through Connectors.

7. If you want to use the Command Line Interface (CLI) for direct maintenance of the AAI database for manual, bulk, or scripted updates or calls, you must have Python installed where you make the calls and posts from. It must be the latest version or at least the version listed in the compatibility matrix for this version of AAI > AAI Server.

See also:

• Installing AAI on Windows (GUI)

• Installing AAI on UNIX (GUI)

• Installing AAI in Quiet Mode (Headless Installer - UNIX and Windows)

• Additional AAI Installation Tasks