ONE Installer - Single-Box Installation

The ONE Installer allows a fast, single-box setup of Automic Automation, which you can use for proof of concepts, testing purposes, and non-production use only.

Important! Do not use the ONE Installer in a production environment.

This page includes the following:

Overview

The ONE Installer sets up an Automation Engine system, loads initial data into the AE database, installs the basic Action Packages and creates a client and a user. It also creates a log file in the root installation folder (for example, C:\Automic\install.log).

The installation provides the following components:

Automation Engine (5xWP/2xCP/1xJWP)
ServiceManager
ServiceManager - Dialog Program (Windows only)
Automic Web Interface
Analytics
Utilities
Tomcat
Package Manager
Local OS Agent
RA Web Service REST Agent, RA Web Service SOAP Agent, RA FTP Agent, and RA JMS Agent
CAPKI, which provides features required for information security services, such as the TLS implementation of the ServiceManager. For more information, see CAPKI - Securing the ServiceManager.

Additional Action packs and Rapid Automation solutions are installed if they are included in the package. The content of a package is determined by CA Automic and may vary between releases.

You can configure ports for communication (CP) and work processes (WP). The ONE Installer opens and start ports for two communication processes (CPs) and five work processes (WPs). All additional processes must be started manually.

The ONE Installer sets up a basic Automation Engine system. For high redundancy or more sophisticated setups, please use the manual installation process. For more information, see Requirements and Installation Types.

Recommendations and Considerations

It is recommended to use a separate VM for the DB or assign a fixed amount of memory to the SQL Server. For more information, please consult the MS SQL Server documentation.
A minimum of 8GB is required on the installation machine.
For ONE Installer setup recommendations, refer to the configuration section in Automic Automation System Requirements and Sizing.
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.
UNIX:
- You must execute the installer with root privileges.
- It is not recommended to execute the installer from network shares with NFS.
The installation sets up the ServiceManager to be started automatically on system boot as a Windows Service or Linux daemon script. All other server 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 ServiceManager log file and look for errors.
  
  The Service Manager log file can be found in the ServiceManager ./temp directory.
As a performance enhancing task you can change Max Perm Size and Heap Size of your Tomcat prepared by the ONE Installer. For more information, see Installing the AE Internal Webservice (Tomcat).

System Requirements

Supported Operating Systems and Databases

Use the compatibility matrix to find the relevant information on supported versions, see Automic Compatibility Matrix

Important! The Automation Engine utility is linked against 12G OCI client. If you are using a different Oracle client version, you must create a SYM LINK for 12G like ln -s libclntsh.so.xx.x libclntsh.so.12.1, where xx.xis your Oracle client version.

For ONE Installer setup recommendations, see Automic Automation System Requirements and Sizing.

Prerequisites

The following prerequisites must be met before starting the ONE Installer:

You can install the database automatically (PostgreSQL) or manually. Prerequisites for a manual database installation are:
- Install the correct 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) or PostgreSQL (PostgreSQL 10.x).
- Download the JDBC driver for the database you are using (Oracle, MS SQL Server, PostgreSQL).
- Create AE databases and users: It's important to remember that you need a new, empty AE database and a new dedicated user with dbowner permissions. For more information, see Preparing the AE Database.
- In the profile configuration of an Oracle DB (SQLNET.ORA), enter ezconnect to the list of values in the NAMES.DIRECTORY_PATH parameter.
The AE connects to the database via TCP/IP. Make sure that your server and client have TCP/IP connection enabled. For an MS SQL Server, use the MS SQL Configuration Manager to configure it.
User name and password of a local user account.
You must have a compatible JRE installed. If you prefer, you can also use a compatible JDK. In this case, it is recommended using AdoptOpen JDK.

Check the Automic Compatibility Matrix to find out which Java versions are supported. For more information, see Compatibility Information

Note: The Event Engine and the Streaming Platform are only installed with JRE or JDK 8. Using a JRE or JDK version higher than 8 disables Rule and Webhook objects and you cannot use them with the Automation Engine.

Installing in Attended Mode

This mode uses the ONE Installer Setup Wizard. Follow the wizard's instructions considering the issues listed here:

Download and unpack the delivered files to a local directory of your choice and start the installer using install.exe for Windows or install.sh for UNIX.

The installer checks if preconditions have been fulfilled and, in case it finds any discrepancies, it attempts to fix them.
Select your Java home directory.

If the version of the JRE or JDK is lower than the Java version supported, the system returns an error message. The same applies if the directory you have selected contains no JRE or JDK installation.
Select if you want to install the database automatically (PostgreSQL) or manually.

The installer checks whether the necessary database drivers are present.
If a manual installation has been selected, point the installer to the JDBC driver of your database.

If you need to download the latest version, use the download link provided.
The ONE Installer checks for unused ports in the system in the port ranges listed in the system requirements and configures them.
Enter the connection values for the database using either the Simple or Advanced mode.

Regardless of the mode being used, it is possible to test the connection using the Test connection button. Otherwise, the ONE Installer tests the connection automatically upon clicking Next.
- When using the Simple mode, the connection string is generated automatically using the database connection information (such as Host, Port).
- Using the Advanced mode allows you to set the connection string manually. Optionally, you can also set a separate JDBC connection string for the JWP.
Choose the installation path (default is C:\Automic).

Important! Do not use spaces when defining paths.
Confirm the license information pertaining to the external software (e.g. Java) to be installed.
Enter the client data for the first client the ONE Installer creates. Select a client number between 0001 and 9999 (0000 is reserved for the system client), a user name, the department, and a password.
Enter the credentials which the agent should use to execute jobs on the machine on which the ONE Installer runs and the Automation Engine will be installed.

Important! Ensure that you enter the correct user credentials, as this information is not verified in this step.

After successful installation, the AWI login page opens in your default Internet browser. Log in with the user credentials that you specified during the installation.

Installing in Unattended Mode

To use the ONE Installer in unattended mode, start the installation and use a configuration file with the extension .varfile. Call it by using the following argument in the directory to which you extracted the files:

Windows: install.exe –q –varfile <path-to-varfile> -dir <path-to-installation-directory>

UNIX: install.sh –q –varfile <path-to-varfile> -dir <path-to-installation-directory>

Notes:

You can choose any name for the .varfile.
Defining an installation directory path is optional.
The port configuration in unattended mode works with unused ports in the system only. If the ports cannot be configured in the above mentioned range, the ONE Installer aborts the installation and writes an error message in the installation log file.
To verify that your ports have been specified correctly in the .varfile, check the installation log file for the actual used ports.
If your Java home directory contains a JRE or JDK version lower than the Java version supported, the system logs an error message. The same applies if the directory you have selected contains no JRE or JDK installation.

Example

CLIENT=100
DB_INPUT_MODE=SIMPLE
DB_CODESET$Integer=0
DB_DATABASE=AE_DB
DB_HOST=mydbhostname
DB_PASSWORD=mydbpassowrd
DB_PORT=1521
DB_SERVER=1
DB_USER=mydbusername
DEPARTMENT=DEV
JDBC_DRIVER_JAR=C\:\\app\\oracle12c\\product\\12.1.0\\dbhome_1\\jdbc\\lib\\ojdbc7.jar
LOGIN_PASSWORD=Nexus01@adm
LOGIN_USER=Administrator
PASSWORD=123
USERNAME=AUT
PORTS_CP=2217,2218,2219,2220,2221
PORTS_WP=2270,2271,2272,2273,2274,2275,2276,2277,2278,2279
PORT_OS_AGENT=2300
PORT_SERVICE_MANAGER=8871
PORT_TOMCAT_HTTP=8080
PORT_TOMCAT_SHUTDOWN=8005
PORT_TOMCAT_AJP_PORT=8009
PORT_IIS=80
PORT_ANALYTICS_BACKEND_PORT=8090
PORT_ANALYTICS_DATASTORE_PORT=5434

PORT_RULE_ENGINE=6124

PORT_RULE_ENGINE_WEB=8081

PORT_STREAMING_PLATFORM=9092

PORT_STREAMING_PLATFORM_COORDINATOR=2181

Parameters

DB_INPUT_MODE

Description: Define if simple or advanced database connection values should be used for Automic Automation

Allowed values: SIMPLE or ADVANCED
DB_SERVER_INSTALLATION

Allowed values:
- AUTO: the database server is installed automatically (PostgreSQL)
- MANUAL: the database server must be installed manually
DB_SERVER

Description: Type of the database server to use

Note: Only used if DB_SERVER_INSTALLATION is set to MANUAL.

Allowed values:
- 0 : MS SQL Server
- 1 : Oracle
- 2: PostgreSQL
DB_HOST

Description: Name or address of the database server that the new AE installation should use
DB_PORT

Description: IP port that is used to connect to the AE database
DB_DATABASE

Description: Name of the database (MS SQL) or SID/Service-Name (Oracle) that the AE installation should use
DB_CODESET$Integer

Description: This setting is only used for installations that use an Oracle database (DB_Server = 1)

Allowed values:
- 0: UTF-8
- 1: ISO-8859-15
DB_USER

Description: Name of the database user in the AE database
DB_PASSWORD

Description: Password of the database user in the AE database
DB_ODBC

Description: Connection string for ODBC connection of CP, WP and Utilities

Note: Used when DB_INPUT_MODE is set to ADVANCED.

Example

ODBCVAR=NNJNIORO,DSN=MY_TNS_NAME;UID=MY_USER;PWD=MY_PW;SP=NLS_LANGUAGE=AMERICAN,NLS_TERRITORY=AMERICA,CODESET=WE8MSWIN1252,NLS_LENGTH_SEMANTICS=CHAR
DB_JDBC

Description: Connection string for JDBC connection of JWP

Note: Used when DB_INPUT_MODE is set to ADVANCED.

Example

jdbc:sqlserver://MY_HOST:MY_PORT;databaseName=MY_DATABASE;user=MY_USER;password=MY_PW
JDBC_DRIVER_JAR

Description: Location of a JDBC driver file that should be used to connect to the AE database.
This file has to match the choice in DB_SERVER and the database and Java versions installed.
CLIENT

Description: Client number of the AE client that is created by the installer
USERNAME

Description: User name of the AE user that is created by the installer

Note: Use AE allowed characters.
DEPARTMENT

Description: Department of the AE user that is created by the installer

Note: Use AE allowed characters.
PASSWORD

Description: Password of the AE user that is created by the installer
LOGIN_USER

Description: User name for a Login object that will be used by the OS agent

This should match a user account on your local system.
LOGIN_PASSWORD

Description: Password for the user account specified in LOGIN_USER
PORTS_CP

Description: Group of ports that will be used by the CP processes

Exactly 5 ports have to be provided.

Default values: 2217,2218,2219,2220,2221
PORTS_WP

Description: 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,2279
PORT_OS_AGENT

Description: Port for the Windows-/Linux agent

The agents use this port for file transfers and to communicate with UCUMELD.

Default value: 2300
PORT_SERVICE_MANAGER

Description: Port for the Service Manager

This port is used by the ServiceManager Dialog to communicate with the ServiceManager.

Default value: 8871
PORT_TOMCAT_HTTP

Description: Tomcat port to serve the AWI installation

Default value: 8080
PORT_TOMCAT_SHUTDOWN

Description: Port that is used to send a shutdown command to Tomcat

Default value: 8005
PORT_TOMCAT_AJP_PORT

Description: Tomcat AJP port

Default value: 8009
POR_IIS

Description: The Microsoft Internet Information Services will be extended with a new site definition that uses this port

This site is then used by the AWI to communicate with CDA.

Default value: 80
PORT_ANALYTICS_BACKEND_PORT

Description: Analytics Backend

Default value: 8090
PORT_ANALYTICS_DATASTORE_PORT

Description: Port that is used by the PostgreSQL installation that is installed with Analytics

Default value: 5434
PORT_RULE_ENGINE

Description: Port that is used by the Rule Engine installation that is installed with the ONE Installer

Default value: 6124
PORT_RULE_ENGINE_WEB

Description: Port that is used by the Web interface of the Rule Engine installation that is installed with the ONE Installer

Default value: 8081
PORT_STREAMING_PLATFORM

Description: Port that is used by the Streaming Platform installed with Telemetry and the Rule Engine

Default value: 9092
PORT_STREAMING_PLATFORM_COORDINATOR

Description: Port that is used by the Steaming Platform coordination service

Default value: 2181

Installing in Command Line Mode

The installation steps are the same as attended mode. You have to enter the required information or confirm actions using the displayed commands or options.

Open a command line window in the directory you unpacked the files to and then use the command start /wait install.exe -c for Windows or install.sh -c for UNIX.

The installer checks if preconditions have been fulfilled and, in case it finds any discrepancies, it attempts to fix them.
Define the Java home directory.

If the version of the JRE or JDK is lower than the Java version supported, the system returns an error message. The same applies if the directory you have selected contains no JRE or JDK installation.
Define the database that you installed.
Enter the path to the JDBC driver of your database.
Enter the connection values for the database.
Choose the installation path (default is C:\Automic).

Important! Do not use spaces when defining paths.
Confirm the license information pertaining to the external software (Java) that will be installed.
Enter the client data for the first client the ONE Installer creates. Select a client number between 0001 and 9999 (0000 is reserved for the system client), a user name, the department, and a password.
Enter the agent's credentials to execute jobs on the machine on which the ONE Installer runs and the Automation Engine will be installed.

Note: Make sure you are using the correct user credentials, as the information is not checked in this step.

After the installation is completed, the AWI login page opens in your default Internet browser. Login with the user credentials that you specified during the installation.