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:
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.
In order to successfully complete the installation steps below, several prerequisite steps must first be completed:
See Installation Prerequisites for more details.
The first part of the installation process is to run the Appian installer, which deploys the engines, services, search server, data service, 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.
The Appian installer can be downloaded from the Downloads tab on MyAppian.
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:
<APPIAN_HOME>directory exists prior to executing the installer.
& ^ = ( ) <space>
<APPIAN_HOME>directory before installing this one.
<APPIAN_HOME>directory. The installer automatically installs Appian in
C:\appianunless you specify another directory.
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:
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 service.
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.
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:
Before making any configurations changes, perform the following parts of the configure script:
Once you've registered an environment, the
<REPO_HOME> directory will populate subdirectories 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
k4.licfile. For example, use
k3.lic.devfor a license going to a dev environment. The Appian engines use the
k3.licwhile the data service uses the
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.
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.
There are two steps unique to creating a data source in Appian:
<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
These steps occur outside the configure script repository and Appian installation directory.
Once all of the necessary configurations are made, it's time to deploy the configure script's repository. Deployment consists of two steps: verification and deployment. The configure script has these steps built in.
Configurations can successfully be verified by reviewing the files in the
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.
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.
Follow the instructions on Starting and Stopping Appian to properly start Appian.
To sign in to Appian:
Administratorand temporary password
Administrator account cannot access the Administration Console, so a separate account is required to complete the following steps.
Review and make changes to the default settings in the Admin Console.
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.
For additional troubleshooting resources, refer to the Appian Knowledge Base on Community.
To uninstall Appian, delete the APPIAN_HOME directory.
Windows Installation Guide