ONE Installer - Single-Box Installation

The ONE Installer allows for a fast, single-box setup of Automic Automation, intended 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 AEdatabase, 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).

Note: 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.

The installation provides the following components:

  • Automation Engine (5xWP/2xCP/1xJWP/1xJCP/1xREST)

  • ServiceManager

  • ServiceManager - Dialog Program (Windows only)

  • Automic Web Interface

  • Analytics

  • Utilities

  • 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/SSL 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.

The ONE Installer by default opens and start ports for two communication processes (CPs), five work processes (WPs), and one Java communication process, one Java work process and one REST process. All additional processes must be started manually. For more information, see Prerequisites for the ONE Installer

Recommendations and Considerations

Take into account the following aspects when using the ONE Installer:

  • It is recommended to use a separate VM for the database or assign a fixed amount of memory to the SQL Server. For more information, please refer to the MS SQL Server documentation.

  • A minimum of 8GB is required on the installation machine.

  • On Windows systems, you require administrative rights to execute the installer. Also, make sure you do not have a Windows service for the ServiceManager registered prior to running the installation.

  • On UNIX systems, 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:AWI 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 log file can be found in the ServiceManager ./temp directory.

Prerequisites for the ONE Installer

Important!

  • Before using the ONE Installer, check the Compatibility Matrix to find the relevant information on supported operating systems, databases, .NET versions and so on. For more information, see Compatibility Information.

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

  • The communication between the Automation Engine and the different components uses TLS/SSL. These components establish a connection with the Java communication process (JCP) and/or the REST process (REST), which use trusted certificates to prove their identity to other communication partners. For more information, see TLS/SSL Considerations for Automic Automation and Securing Connections to the AE (TLS/SSL).

The following Ports must be available:

  • 80 (for Internet Information Services)

  • 2217-2221 (for Communication Process connections)

  • 2270-2279 (for Work Process connections)

  • 8080 (for AWI)

  • 8443-8445 (for Java Communication Processes)

  • 8088 (for REST processes)

  • 8871 (Service Manager)

  • 8090 (Analytics Backend)

  • 5434 (Analytics Datastore)

Additionally, the following is required to use the ONE Installer:

  • You can install the database automatically (PostgreSQL) or manually. For more information on the prerequisites for a manual database installation, see Preparing the AE Database.

  • TLS connections are not supported for PostgreSQL

  • 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 Eclipse Adoptium. Check the 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:

  1. 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.

  2. 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.

  3. Select if you want to install the database automatically (PostgreSQL) or manually.

    The installer checks whether the necessary database drivers are present.

  4. 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.

  5. The ONE Installer checks for unused ports in the system in the port ranges listed in the system requirements and configures them.

  6. 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.

  7. Choose the installation path (default is C:\Automic).

    Important! Do not use spaces when defining paths.

  8. Confirm the license information pertaining to the external software (e.g. Java) to be installed.

  9. 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.

  10. 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.

  11. If you want to use an already existing custom keystore, select the respective checkbox. Otherwise, a keystore is created using a self signed certificate. You can also define a key alias and password as well as a keystore password. If you use an already existing keystore or do not define the keystore parameters, the default values are used. For more information, see .varfile Parameters.

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.

Example of a .varfile after an installation in attended mode

CLIENT=100

DB_SERVER=MSSQL

DB_SERVER_INSTALLATION=AUTO

DEPARTMENT=AUTOMIC

JAVA_HOME=C\:\\Program Files\\Eclipse Adoptium\\jdk-17.0.13+11

LOGIN_USER=myuser

PHRASE_POSTFIX=

PORTS_CP=2217,2218,2219,2220,2221

PORT_ANALYTICS_BACKEND=8090

PORT_ANALYTICS_DATASTORE=6432

PORT_AUTOMATION_AI=8500

PORT_IIS=80

PORT_JCP=8443

PORT_OS_AGENT=2300

PORT_REST=8088

PORT_SERVICE_MANAGER=9071

PORT_TOMCAT_AJP=8009

PORT_TOMCAT_HTTP=8080

PORT_TOMCAT_SHUTDOWN=8005

SKIP_OPTIONAL_ACTIONPACKS$Boolean=true

TLS_KEY_ALIAS=

TLS_USING_CUSTOM_KEYSTORE$Boolean=false

UC_SYSTEM_SETTINGS=key1\=value;key2\=value

USERNAME=myusername

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 of a .varfile after an installation in unattended mode

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=mydepartment

JAVA_HOME=C\:\\java\\java-11-openjdk

JDBC_DRIVER_JAR=C\:\\app\\oracle12c\\product\\12.1.0\\dbhome_1\\jdbc\\lib\\ojdbc7.jar

LOGIN_PASSWORD=yetanotherpassword

LOGIN_USER=myloginuser

PASSWORD=yetanotherpassword

USERNAME=myusername

PORTS_CP=2217,2218,2219,2220,2221

PORTS_WP=2270,2271,2272,2273,2274,2275,2276,2277,2278,2279

PORT_JCP=8443

PORT_REST=8088

PORT_OS_AGENT=2300

PORT_SERVICE_MANAGER=8871

PORT_TOMCAT_HTTP=8080

PORT_IIS=80

PORT_ANALYTICS_BACKEND_PORT=8090

PORT_ANALYTICS_DATASTORE_PORT=5434

PORT_RULE_ENGINE=6123

PORT_RULE_ENGINE_WEB=8081

PORT_STREAMING_PLATFORM=9092

PORT_STREAMING_PLATFORM_COORDINATOR=2181

TLS_USING_CUSTOM_KEYSTORE$Boolean=true

TLS_KEYSTORE=keypair.p12

TLS_KEYSTORE_PASSWORD=yetanotherpassword

TLS_KEY_PASSWORD=yetanotherpassword

TLS_KEY_ALIAS=1

UC_SYSTEM_SETTINGS=key1\=value;key2\=value

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.

  1. 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.

  2. 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.

  3. Define the database that you installed.

  4. Enter the path to the JDBC driver of your database.

  5. Enter the connection values for the database.

  6. Choose the installation path (default is C:\Automic).

    Important! Do not use spaces when defining paths.

  7. Confirm the license information pertaining to the external software (Java) that will be installed.

  8. 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.

  9. 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.

  10. If you want to use an already existing custom keystore, select the respective checkbox. Otherwise, a keystore is created using a self signed certificate. You can also define a key alias and password as well as a keystore password. If you use an already existing keystore or do not define the keystore parameters, the default values are used. For more information, see .varfile Parameters.

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.

.varfile Parameters

The following parameters are available:

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

    • MSSQL : MS SQL Server

    • ORACLE : Oracle

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

  • JAVA_HOME

    Description: Point to the location of your Java installation directory

    Example

    Unix:

    JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64

    Windows:

    JAVA_HOME=C\:\\java\\java-11-openjdk

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

    Description: Port that will be used by the Java communication process

    1 ports must be provided.

    Allowed values: 8443-8445

    Default value: 8443

  • PORT_REST

    Description: Port that will be used by the REST process

    Default value: 8088

  • 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_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_STREAMING_PLATFORM

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

    Default value: 9092

  • PORT_STREAMING_PLATFORM_COORDINATOR

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

    Default value: 2181

  • TLS_KEY_ALIAS

    Description: Alias used for the key

    Default value: jetty

  • TLS_KEY_PASSWORD

    Description: Password for the key

    Default value: changeit

  • TLS_KEYSTORE

    Description: Path to the keystore

  • TLS_KEYSTORE_PASSWORD

    Description: Password for the keystore

    Default value: changeit

  • TLS_USING_CUSTOM_KEYSTORE

    Description: Indicates if a custom keystore is being used or if a self signed certificate is used

    Format:TLS_USING_CUSTOM_KEYSTORE$Boolean=

    Default value: false

  • UC_SYSTEM_SETTINGS

    Description: Allows you to change system wide settings after the installation, see UC_SYSTEM_SETTINGS - Systemwide Settings.

    Default value:key1=value;key2=value

See also: