Installing AAI on UNIX (GUI)

Once all pre-installation requirements have been met, you can start with the AAI installation on Unix. For more information, see Preparing for the Installation.

Important!

This page guides you through the AAI installation using the setup wizard GUI (headful installation). However, you can also install AAI in quiet mode using the headless installer. For more information, see Installing AAI in Quiet Mode (Headless Installer - UNIX and Windows).

This page includes the following:

Getting the Installation Package

The Automic Automation Intelligence setup Wizard will guide you through the installation.

  1. Go to https://downloads.automic.com/ and log in with your Broadcom account.

  2. Download the relevant AAI product or solution. For more information, see Downloads.

    The package includes the Installer and Upgrade .zip files for both, Windows and UNIX.

  3. Unzip the relevant deliverable which contains the four installation files:

    • INSTALLER_README.txt

    • LicenseAgreement.txt

    • install.properties

    • A setup file for the corresponding OS:

      • Windows: jaws-ue-windows-installer-<version number>-setup.exe

      • UNIX: jaws-ue-unix-installer-<version number>-setup.sh

Installing AAI Using the Setup Wizard

Before installing AAI you must make some decisions about how to size your environment. You can allow AAI to automatically size your AAI database based on the information you provide during installation. Alternatively, can 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.

Once the siting requirements are met, follow these steps:

  1. To start the wizard, open a command line and run jaws-ue-unix-installer-<version number>-setup.sh.

    For this installation mode you do not need any of the other files in the package. However, you can use the install.properties file to customize the wizard. For more information about the properties and values in this file, see Installing AAI on UNIX (GUI).

  2. From the Welcome Window click Next to continue.

  3. Software License Agreement: Accept the Automic Automation Intelligence Software License Agreement before continuing. Select the I accept the agreement button, then click Next to continue.

  4. Destination Directory: Select the folder where you want to install AAI , then click Next.

  5. Insufficient Disk Space Warning: A minimum of 2GB is recommended for the installation of the Reporting Server.

  6. Select Symlinks Directory: When installing on the Linux/Unix platforms, it is possible to create symbolic links for the server invoker. Specify the directory where you would like to place the links. If you do not wish to create symbolic links, deactivate the Create symlinks checkbox.

  7. Server Identity: ID that uniquely identifies the server. This field is mandatory.

    Default value: AAI

    Maximum length: 8 characters

    The server description is also mandatory. Maximum length: 255 characters

  8. Database: DBMS and database location for your database.

    The database will not be installed at this time, but the installer will configure the Server to connect to it, and will generate SQL scripts for creating the database that you or your DBA will run after the installer completes.

    When you use an Oracle database, you can use Kerberos authentication using either a keytab file or cache credentials. However, you cannot configure it while installing AAI with the wizard. You can configure it using the Configuration Tool UI or the Configuration Tool CLI, see Using Kerberos Authentication with Oracle Database.

  9. Database Devices: Database/device settings that are used to generate SQL scripts.

    Enter the username and password for the database. This information is required to connect to the database.

    Note:

    For SQL Server using Kerberos login, the User will need to be the Kerberos Principal (example: user@mycompany.com). The Password will be the path to the user's keytab file.

  10. Database Sizing and Maintenance: To set reasonable initial sizes for the database, the installer needs an estimate of the size of the scheduler environment it will be running against.

    For example, an initial size of about 500 MB purges old data from the database. This prevents the database from growing without limit. Keeping the database small has the added benefit of maintaining the responsiveness of the database.

    Database Maintenance is controlled by two parameters you can edit here. These parameters can also be specified in the Configuration Tool after installation. For further information, see Configuration Tool - Maintenance Tab.

    • Job run retention days

      The number of days of job run history to be kept in the database.

    • Jobstream run retention days

      The number of days of jobstream run history to be kept in the database. This number cannot be larger than the Job run retention days.

    Note:

    The queries ran/calculations performed during the pre-installation gave you the information you need to enter here. For further information, see Pre-Installation Checklist for the Reporting Server.

  11. Periodic Tasks:AAI must perform certain periodic tasks to keep itself in sync with the scheduler and provide the latest information on running jobs.

    Note:

    Schedule these tasks for when it makes sense to within your environment (for example, after daily database backups).

    • Latest Events

      The latest events are pulled from the scheduler frequently. This is a very lightweight, read-only request that should have little impact on the scheduler.

    • Job Definitions (AutoSys)

      Job definitions are retrieved from AutoSys much less often because they do not change very often, and this request is somewhat more expensive for the AutoSys database.

      If necessary, this task can be scheduled more frequently, or the definitions can be downloaded using the client when needed.

      After the job definitions are downloaded, all jobstreams within are updated to reflect any changes to job definitions, and all forecasts are regenerated based on the new job definitions. These tasks can be processing intensive so consideration should be given when setting the frequency for this process.

    • Job Run Averages

      Job run averages are recomputed on the database regularly with the latest information to make predictions. This task does not have any impact on the scheduler.

    These settings are stored in the database.

  12. Activate Your Product

    AAI uses telemetry to send product usage and system configuration information to Broadcom. Specify whether the installation or upgrade is related to a new or additional planned usage under a Portfolio License Agreement (PLA) with Broadcom by selecting Yes or No.

    • Send telemetry data

      Whether you want to send the telemetry data to Broadcom or not

    • Company Domain

      Domain name of your company. It is the last part of your company's email address.

    • Enterprise Site ID

      Your company's unique login site ID that is listed on the Broadcom Support portal.

    Internal Identifier

    (Optional) Specifies your department's non-personally identifiable information (non-PII) identifier that you use for your company's tracking needs.

    Specify whether you want to use a proxy to send the telemetry data to Broadcom.

    Note:

    If you enable proxy, you must specify the URI in the ProxyURI parameter.

    • Proxy URI

      URI to access the proxy server.

    • Username

      (Optional) Specifies the user name that is required for proxy authentication.

    • Password

      (Optional) Specifies the AES encrypted password that is associated with the proxy URI user name.

  13. Additional Configuration

    SNMP settings are only required if you want to send alerts via SNMP.

    • SMTP Host

      DNS name of the Email server. This is a required field if email alerts are desired.

    • SMTP Port

      Port your email server has open for connections (usually 25). This is a required field if email alerts are desired.

    • SMTP User

      An email user name. This is required if your email server requires a user and password in order to send email.

    • SMTP Password

      Enter the user's password if your email server requires it.

    • Mail Sender

      Email address used to send emails from AAI. Some SMTP servers may require that this is the same as the "SMTP User" above, but others may not. Some may not require this parameter at all, but it is recommended that a distinct and recognizable email address be used that can be recognized and possibly filtered by the recipient.

    • Use STARTTLS

      Activate this box if your email server is configured to use STARTTLS in order to use an encryption in its email protocol. Encrypted email is recommended and most modern email servers will support this. Check with your Email Administrator to find out if your server supports this.

    Note:

    SNMP settings and other configuration values can be specified in the Configuration Tool after installation. For further information, see Configuration Tool - Other Tab.

  14. Information Window: At this point, all configuration information has been collected so that the actual installation of the server can begin once you click Next.

  15. Installing: During this step, the files are unpacked, configuration files are written, and custom SQL scripts are generated.

  16. Setup Information Window: The installer has finished unpacking files and configuring itself for your environment. Click Next to complete the server installation.

  17. Setup Complete Window: The installation is complete. Click Finish to close window. The installer is ready to exit.

    Recommendation: Read the INSTALLER_README.txt file after the Server installation is complete. Deactivate the checkbox if you do not want to read this file. You can access it at any time as it is stored in the install directory.

  18. Remaining Steps

    1. Create Database

      Create the database using the SQL scripts generated during the installation process.

    2. Start the Server

      Run the start-up script provided with the product to start the server.

    3. Launch the Client

      Run the application client from any Web Browser that has access to the Application Server. For further information, see Logging In to AAI.

Note:

You can also configure the AAI Server to use HTTPS using TLS. For more information, see Configuring the AAI Server for TLS Authentication.

Installing with -dir, -p, and Other Switches

You can use two switches when installing AAI with the setup wizard (headful):

  • -dir

    This switch lets you define the directory in which to install AAI.

    Example

    With this switch, the setup wizard shows a text field for the destination directory that contains the directory path given in the command line. That is, if the command included -dir /Users/Bob/AAI, the text field shows /Users/Bob/AAI.

  • -p or --properties

    This switch lets you define the location of the install.properties file from which to retrieve installation property values.

Note:

Headful installations accept some switches that are unavailable in quiet mode. Use the following command to open a window with a list of available switches for the setup wizard installation type:

./jaws-ue-unix-installer-<version number>-setup.sh -h

Customizing the Wizard Using the install.properties File

You can modify the values that populate the text fields of installation properties in the wizard using the install.properties file.

Example

The text field of the destination directory contains a default path when you run the wizard on a Linux environment: /opt/Automic_Automation_Intelligence.

However, if you run the wizard in a directory that includes an install.properties file, it will read the file and populate text fields with the values given in the file. If the install.properties file specifies that destinationDirectory = /opt/myAAI, then the wizard will populate the text field for the destination directory with /opt/myAAI.

For more information about the properties and values in the install.properties file, see Configuring the install.properties File.

See also: