Page tree
Skip to end of metadata
Go to start of metadata

Overview

This page presents steps for installing Attivio Platform on a Windows host using the GUI installer wizard. For console or silent installation, see the Command-Line Installation page.

View incoming links.

 

Windows Full Installation Steps

Follow these steps to install Attivio Platform on a Windows host which does not already have Attivio Platform 5.6.2 or a later release installed:

Use a ZIP archive program or Windows' built-in ZIP support to decompress the installation package ZIP archive that you downloaded from the Download Attivio Software page.

Next, double-click the decompressed Attivio Platform installer executable to begin the installation process. The install4j Wizard dialog box appears.

Windows 10

When installing Attivio Platform on Windows 10, right-click the installer executable and select the Run as administrator context-menu entry instead of double-clicking. The installer must be run as an Administrator in order for installation to complete successfully.

The Welcome to the Attivio Platform Setup Wizard screen appears. Click the Next button to continue installation.

If the screen shows the message "A previous installation has been detected. Do you wish to update that installation?", it indicates that an existing installation of Attivio Platform 5.6.2 or later is present on the host and that the installer will perform an in-place upgrade rather than creating a complete new installation. Go to the Welcome to the Attivio Platform Setup Wizard step in the Windows In-Place Upgrade Steps section, below, and continue from there to complete the upgrade.

The Patent Notice screen appears. Click the Next button to continue installation.

The License Agreement screen appears. Read the agreement, then select the I accept the agreement radio button and click the Next button to continue installation.

If Attivio Platform 5.6.1 is installed on the host, the Attivio 5.6.1 Detected Screen appears. If you wish to back up any elements of the existing installation directory tree, do so, then click the Next button to continue installation.

The Attivio Platform License screen appears. Type the path and filename of your attivio.license file into the attivio.license file field, or click the Browse… button and navigate to find the file. Once the file's path and filename has been specified, click the Next button to continue installation.

Attivio requires a valid license file. To obtain a license file, refer to the Installing AIE page.

The JRE Selection screen appears. If you wish to use the OpenJDK 11.0.3 Java Runtime Environment (JRE) bundled with the installer, click the Next button to continue installation.


If you prefer to provide your own Java SE 11 JRE, select the User-defined JRE radio button, then click the Browse… button and navigate to select the JAVA_HOME directory for your desired JRE. The installer will display a warning dialogue box if the location entered is not a valid JRE JAVA_HOME directory. Once the directory is specified, click the Next button to continue installation.

Changing the JRE After Installation

After installation, you can still change the JRE used for Attivio processes by following the steps outlined on the Updating Attivio JREs page.

The Select Installation Type screen appears. If you wish to install the Attivio Platform core product plus the default set of external modules, click the Next button to continue installation. If you wish to omit the default external modules and install only the Attivio Platform core product, select the Core radio button and then click the Next button to continue installation.


Most of the Attivio documentation assumes that you have selected the Full option, with the core platform and external modules. Some options mentioned in the documentation may be unavailable if you select the Core option and omit the external modules.

The Select Destination Directory screen appears. If you wish to install Attivio Platform to the recommended C:\attivio\platform destination directory, click the Next button to continue installation. If you wish to specify a different installation directory path, type that path into the field or click the Browse… button and navigate to select the desired directory, then click the Next button to continue installation.

Do Not Install to Program Files Directory

On some versions of Windows, installing Attivio Platform under the C:\Program Files directory causes file permission issues which may block required functionality. Install to C:\attivio or a similar non-Program Files path to avoid this problem.

The Select Start Menu Folder screen appears. If you want Attivio Platform to create a Start Menu folder with shortcuts, leave the Create a Start Menu folder checkbox enabled (its default setting), specify a folder name or accept the default Attivio Platform name, and click the Next button to continue installation. If you do not want Attivio Platform to create a Start Menu folder, uncheck the Create a Start Menu folder checkbox and then click the Next button to continue installation.

The Agent Service Installation screen appears. If you wish to run the Attivio Platform Agent as a Windows service, leave the Install Attivio Platform Agent Service checkbox enabled (its default setting), modify the default Port and Data directory field values if desired, then click the Next button to continue installation. If you do not wish to run the Agent as a Windows service, uncheck the Install Attivio Platform Agent Service checkbox, then click the Next button to continue installation.

The installer extracts files. Depending on your choices, it may also install external modules, create a Start Menu folder, or install the Attivio Platform Agent as a Windows service.

If you do not have administrator privileges, Attivio will be unable to install the Attivio Platform Agent as a service.

If you don't have privileges to run programs as system services, Attivio will display a warning message indicating that the Attivio Platform Agent service could not be started:

In either of these cases, you will need to start the Agent manually before starting the Attivio Command-Line Interface (CLI).

The Completing the Attivio Platform Setup Wizard screen appears. Click the Finish button to exit the installer.


* = This step only occurs when installing on a host which has Attivio Platform 5.6.1 installed.

Windows In-Place Upgrade Steps

If you install Attivio Platform 5.6.2 or later on a Windows host which already has Attivio Platform 5.6.2 or later installed, the installer performs an in-place upgrade, replacing the existing installation with the new one while preserving critical settings files and external modules.

Follow these steps when performing an in-place upgrade:

    Use a ZIP archive program or Windows' built-in ZIP support to decompress the installation package ZIP archive that you downloaded from the Download Attivio Software page.

    Double-click the Attivio Platform installer executable that you downloaded from the Download Attivio Software page to begin the installation process. The install4j Wizard dialog box appears.

    Windows 10

    When installing Attivio Platform on Windows 10, right-click the installer executable and select the Run as administrator context-menu entry instead of double-clicking. The installer must be run as an Administrator in order for installation to complete successfully.

    The Welcome to the Attivio Platform Setup Wizard screen appears. If you wish to upgrade the existing Attivio Platform installation, click the Next button to continue installation. If you wish to install the new Attivio Platform version alongside the existing installation, select the No, install into a different directory radio button and then click the Next button to continue installation. This will perform a new full installation instead of an in-place upgrade; go to the Patent Notice step in the full installation steps above and continue from there to complete the installation.

    If you selected Yes, update the existing installation (the default option), the Backup directory screen appears. If you wish to back up your existing Attivio Platform installation, leave the Enable Backup checkbox selected (its default state) and type a backup directory location into the Backup location field or click the Browse… button and navigate to the desired directory path, then click the Next button to continue installation. If you do not wish to back up the existing installation, uncheck the Enable Backup checkbox, then click the Next button to continue installation.

    The JRE Selection screen appears. If you wish to use the OpenJDK 11.0.3 Java Runtime Environment (JRE) bundled with the installer, click the Next button to continue installation.

    If you prefer to provide your own Java SE 11 JRE, select the User-defined JRE radio button, then click the Browse… button and navigate to select the JAVA_HOME directory for your desired JRE. The installer will display a warning dialogue box if the location entered is not a valid JRE JAVA_HOME directory. Once the directory is specified, click the Next button to continue installation.

    Changing the JRE After Installation

    After installation, you can still change the JRE used for Attivio processes by following the steps outlined on the Updating Attivio JREs page.

    The Select Installation Type screen appears. If you wish to install the Attivio Platform core product plus the default set of external modules, click the Next button to continue installation. If you wish to omit the default external modules and install only the Attivio Platform core product, select the Core radio button and then click the Next button to continue installation.


    Most of the Attivio documentation assumes that you have selected the Full option, with the core platform and external modules. Some options mentioned in the documentation may be unavailable if you select the Core option and omit the external modules.

    The installer extracts files and migrates add-on modules and critical settings files from the existing installation to the new installation. Depending on your choices, it may also back up your existing installation or install external modules.

    If you do not have administrator privileges, Attivio will be unable to install the Attivio Platform Agent as a service.

    If you don't have privileges to run programs as system services, Attivio will display a warning message indicating that the Attivio Platform Agent service could not be started:

    In either of these cases, you will need to start the Agent manually before starting the Attivio Command-Line Interface (CLI).

    The Completing the Attivio Platform Setup Wizard screen appears. Click the Finish button to exit the installer.

    * = This step only occurs if you choose to update the existing installation.

    Windows Restore Steps

    Follow these steps to restore an Attivio Platform installation from the backup created by an in-place upgrade:

    1. Stop all running Attivio processes, including the Attivio CLI and the Attivio Platform Agent, to ensure that no installation files are in use.
    2. In an elevated (run as administrator) Command Prompt window, change directory to the backup directory, <BACKUP_DIR>\attivio-platform-5.6.<VERSION>-<DATE>_<TIME>

      In the directory path above, <BACKUP_DIR> is the location specified for the backup during the in-place upgrade, <VERSION> is the Attivio Platform 5.6 minor version ("3" for 5.6.3, etc.), and <DATE> and <TIME> are the date and time at which the backup was created.

      Example: If you backed up an Attivio Platform 5.6.2 installation to the C:\backups directory, your backup directory path might be C:\backups\attivio-platform-5.6.2-20190911_170531.

    3. In the Command Prompt window, display the contents of the backup directory's README.txt file:

      type README.txt
    4. In the Command Prompt window, execute the restore.cmd command from the README.txt file, which typically looks like this:

      restore.cmd C:\attivio\platform
    5. Type Yes and press Enter when prompted by the restore program.
    6. Allow the restore program to run to completion. Your previous Attivio Platform installation should now be restored to its original path.

    Windows Uninstallation Steps

    You must have administrator privileges to uninstall Attivio Platform. If uninstalling from the command line, use the Run as administrator option to launch an elevated Command Prompt window.

    1. Navigate (in Windows Explorer) or change directory (in elevated Command Prompt window) to the Attivio Platform installation directory.
    2. Double-click the uninstall.exe executable (in Windows Explorer) or type uninstall.exe and press Enter (in the elevated Command Prompt window).
    3. Allow the uninstaller program to run to completion.

    • No labels