Preparing for the Installation

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

This page includes the following:

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.

Note:

The requirements listed on this page are not OS specific and apply to AAI installations on both Windows and UNIX unless stated otherwise.

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.

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.

Important !

For installations on Unix environments, make sure that an X11 Server is installed on the host machine. The AAI upgrader requires a graphical environment. An X Client can be exported to a remote machine (PC or workstation) by setting the DISPLAY environment variable on the host.

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

Note:

The sizing information that the worksheet calculates applies to environments with less than 250,000 jobs. For larger installations, contact Broadcom and a Client Services Consultant can assist with configuring AAI.

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)

    • 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:

      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.

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

AAI Database Requirements

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 following database management systems (DBMS) are supported:

  • SQL Server - version 2012 or later
  • Oracle - version 11 or later
  • PostgreSQL - version 17 or later

Note:

The AAI database needs to be created as case sensitive.

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.

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.

Note:

A full JDK installation is required to run the AAI server. The JRE (Java Runtime Environment) is not sufficient.

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.

Other AAI Prerequisites

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.

  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 its read-only ID has synonyms set up on the AutoSys database so that non-dbo queries do not require dbo.tablename on that database.

    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 the latest version of Python installed where you make the calls and posts from.

See also: