Windows Installation Guide

Overview

This guide covers the steps necessary to perform an enterprise installation of Appian on a supported Windows operating system and configured to run on your application server. These steps assume that your installation will be performed on a single server, however, they are also used in conjunction with the High Availability and Distributed Installations page for multiple server installations.

Before starting the installation process, review the System Requirements to ensure all minimum requirements are met.

There are three main parts to an Appian installation:

  1. Engine & service installation
  2. Environment-specific configuration
  3. Startup & site setup

Engine & services installation involves deploying the Appian installation package. Next, environment-specific configurations are made to Appian's engines and services, the application server, and relational database management system (RDBMS) so they all talk to each other. Finally, administrators perform final start-up and setup procedures to get the installation up and running.

Prerequisites

In order to successfully complete the installation steps below, several prerequisite steps must first be completed:

Refer to the Installation Prerequisites page for more details.

Part 1: Install Appian Engines and Services

The first part of the installation process is to run the Appian installer, which deploys the engines, services, search server, data server, Appian Java EE application, and relevant libraries & files. After running the Appian installer, the temporary product license is placed in the appropriate directory from the prerequisite steps. This allows the administrators to obtain information about the machine necessary to acquire a long-term product license.

Run the Appian Installer

Before and during the installation process, temporarily disable any anti-virus software or search indexing utilities running on the server.

The Appian installer can be downloaded from the Software Downloads record on Community.

The latest hotfix is included as part of the Appian installer. When planning an installation or upgrade, ensure each environment is using the same version of the installer. This can be verified after installation by opening the build.info file located in <APPIAN_HOME>/conf/. The contents of this file should match across all environments.

To install Appian:

  1. Ensure that the <APPIAN_HOME> directory exists prior to executing the installer.
    • Do not use the following characters in the name of your installation directory: & ^ = ( ) <space>
    • Do not install Appian in a directory where another version of Appian is already installed. If you desire to use the same directory names, and are performing these steps as part of an upgrade, rename the older <APPIAN_HOME> directory before installing this one.
  2. Double click on the installer.
    • If you are using Windows 7, right-click the installer and select Run as administrator.
  3. Click Next to step through the installer.
    • The installer automatically puts Appian files in a default location unless you specify another directory.
    • Optional: When you reach the Destination Folder option, click Browse, and then specify the desired location for the <APPIAN_HOME> directory. The installer automatically installs Appian in C:\appian unless you specify another directory.
  4. Click Finish to close the installer.
  5. Set JAVA_HOME and PATH Environment Variables

A Program Compatibility Assistant dialog box may appear after the installer closes. This issue does not affect the Appian installation. If this happens, click This program installed correctly to dismiss the warning.

If you deploy the application suite on a virtual PC or virtual OS image, complete the following steps:

  1. Right-click the APPIAN_HOME directory.
  2. Select Properties.
  3. Select the Security tab.
  4. Verify that the user account that is to be used to start the application has Read & Execute and Write permissions for the folder.

Obtain Your Long-Term Product License

Once the installation is complete, your product license must be obtained and installed. Appian cannot be started without a valid license. The temporary license obtained earlier is only valid for 7 days. It is designed to obtain long-term licenses for your environments, for example, dev, test, and production.

To request a long-term license, follow Requesting and Installing a License. For each environment, obtain long-term product licenses for all of the servers where engines will reside as well as licenses for the data server.

Once you have obtained the long-term license, use the configure script to manage the long-term product licenses in a central repository.

Installation Steps for both will be discussed in the next part of the installation guide.

Part 2: Installation Configurations

The main part of an Appian installation is setting configuration properties necessary for Appian to communicate with an RDBMS and a web server. This section is split into four parts:

  1. Appian Configuration
  2. RDBMS configurations
  3. External configurations
  4. Deployment of configurations

Appian Configuration

Before making any configurations changes, perform the following parts of the configure script:

  1. Running the Script
  2. Create the Configuration Repository
  3. Backing Up Appian
  4. Registering an Environment

Once you've registered an environment, the <REPO_HOME> directory will populate sub-directories with a copy of all the core configuration files. Make any desired changes within these repository directories.

The remaining menu options of the configure script are either optional or will be performed later in this installation guide.

Once the configure script has been initialized, the remaining Appian configurations need to be finalized. Changes will be made in the <REPO_HOME> directory.

  • Configure Site URL - Sets up the environment's server, port, and domain. Configured in custom.properties.
  • Generate a Unique Security Token for the Appian Engines - Appian restricts communication with the engine servers using a security token. Generating a unique security token for each environment offers an extra layer of protection for your installation.
  • Generate a Unique Security Token for the Data Server - Appian restricts communication with the data server using a security token. Generating a unique security token for each environment offers an extra layer of protection for your installation.
  • Raise the Cap on Maximum Engine Size - This raises the amount of memory that a single execution engine will use.
  • Place the K Licenses in their folder - Deploy the licenses to the appropriate directory in the repository. Append the environment suffix to the end of the k3.lic and k4.lic file. For example, use k3.lic.dev for a license going to a dev environment. The Appian engines use the k3.lic while the data server uses the k4.lic.

Optional Configurations

Optional configurations are performed at the discretion of the System Administrator based on the needs of a particular environment. See the Optional Configurations section of the Post-Install Configurations page for specific guidance.

RDBMS Configurations

A supported relational database is required for the Appian data source, which is used exclusively for storing data relating to the Appian installation as a whole.

Whichever relational database is used, a JDBC Driver is required and should have been downloaded as part of the prerequisite steps above.

Connecting to an RDBMS

There are two steps unique to creating a data source in Appian:

  1. Install the driver - This driver is deployed in the <REPO_HOME>/tomcat/apache-tomcat/lib/ directory.
  2. Provide data source connection information - Using the <REPO_HOME>/conf/tomcatResources.xml.<ENVIRONMENT> file provided by the configure script, RDBMS properties need to be configured. Define the JNDI name, as well as the server, port, and database name. The JNDI name in the tomcatResources.xml.<ENVIRONMENT> should match the name referenced in custom.properties.

External Configurations

These steps occur outside the configure script repository and Appian installation directory.

Deployment

Once all of the necessary configurations are made, it's time to deploy the configure script's repository. Deployment consists of 2 steps: verification and deployment. The configure script has these steps built in.

To properly deploy Appian using the configure script, follow the instruction in the validating configurations and deploying configurations sections of the configure script page.

Configurations can successfully be verified by reviewing the files in the <APPIAN_HOME> directory.

Part 3: Startup and Setup

Once all of the configurations are deployed, it's time to start Appian and verify the installation was successful. Before starting Appian and signing into it, a system administrator user account will need to be generated. Additionally, the service manager requires a password to run its scripts.

Configure the Initial System Administrator Account

This account will allow you to access the Administration Console and create other Appian users. Follow the Create First System Administrator User section of the post-install configurations page.

Generate a Password for the Service Manager

Use the password script to generate a service manager password. This password is used on any of the service manager scripts as a way to protect against anyone without proper access from running administrative scripts.

Start Appian

Follow the instructions on Starting and Stopping Appian to properly start Appian.

Sign in to Appian

  1. In a browser, navigate to https://<host-name>/suite/design.
  2. Log in with the username and temporary password you configured in the configure initial system administrator account section above.
  3. Change the system administrator's password when prompted.

Verify System Settings

Review and make changes to the default settings in the Admin Console.

Setup Business Data Sources

The business data source creates a connection between Appian application objects and your business data. Setting up your business data source is handled through the Admin Console. Multiple business data sources can be configured for a single environment.

Troubleshooting

For additional troubleshooting resources, refer to the Appian Knowledge Base on Community.

Uninstalling Appian

To uninstall Appian, delete the APPIAN_HOME directory.

FEEDBACK