Free cookie consent management tool by TermsFeed

Deploy Appian for Windows

On This Page
Appian for Windows requires additional licensing and must be purchased separately.

Appian for Windows is a desktop application that allows users to complete offline-enabled tasks and actions on Windows devices.

This page explains how Administrators can install, upgrade, rebrand, and uninstall the Appian for Windows app using msiexec commands. These commands work whether you're installing on a single machine from PowerShell or Command Prompt, or deploying to many machines via an app distribution tool like Microsoft Intune.

Prerequisites for installing Appian for Windows

Installing the Appian for Windows app requires the following:

Download the installer and branding files

The Appian for Windows .msi installer and branding.json files are available in MyAppian. You must download them before installing or upgrading the Appian for Windows app.

To download the .msi and branding.json files:

  1. Go to MyAppian > Support.
  2. Go to the Downloads tab.
  3. Click Platform > Appian for Windows.

  4. In the table, click the Appian for Windows version you want to install.

    Note:  The Appian for Windows version must be the same version or newer than your Appian environment version.

  5. In the Downloads box, click the Appian for Windows file to open the Download File page.
  6. Click the Appian for Windows file to download the file.
  7. Click FINISH to go back to the Appian for Windows version details page.
  8. In the Downloads box, under Add-ons, click the branding.json file to open the Download File page.
  9. Click the branding.json file to download it.
  10. Save the files to a known location on the target machine or a network share.

Prepare the branding file

The branding file is a .json file that controls how the Appian for Windows app appears to end users, including the app name, icon, and the Appian environment it connects to.

To prepare the branding file:

  1. Download the branding.json file from MyAppian.
  2. Open the file in a text editor.

  3. Update the fields with your organization's values:

    Field Type Description
    applicationName String The name displayed in places like the title bar, Alt+Tab switcher, and About dialog.
    shortcutName String The name used for the Start Menu and desktop shortcut.
    folderPath String The Start Menu folder path for the shortcut.
    iconBase64 String The app icon as a base64-encoded .png, .jpg, or .ico file.

    To base64-encode the file, use a command-line tool or online converter.
    environmentUrl String The URL of the Appian environment the app connects to. For example: https://mycompany.appiancloud.com.

    Include this field to restrict users to the specified environment. Omit this field to allow users to switch between environments.
  4. Save the file.

Example branding file:

1
2
3
4
5
6
7
8

{
  "applicationName": "My App",
  "folderPath": "My App",
  "shortcutName": "My App",
  "iconBase64": "AAABAAEAIAkAAAEAIADMBAAAFgAAACgAAAAgAAAAEgAAAAEAIAAAAAAAgAQAAAAAAAAAAAAAAAAAAAAA
AABVEAhwUw0FiF4cFRhdGxQAXRsTAF4cFRZTDASHVA4GbHc/OQVcGhIzVxIKl1QPB8NWEAmtWhYPUnhBOwNiIhsYUw0FilEKAlESAAAAVRAIXVMNBX9kJR4LXRwUKlIMBJFWEQk5UQoCSFEKApZRCgKWUQoCl1EKApdRCgKYUQoCUVcSCoJSDAT4WRUNVFILAwBUDgYAWxgQTVIMBPpWEQqCXBoSPVMNBdtTDATtUw4GxVMMBN9TDATuWBQMXWQkHSlTDQXuUQkBimYoIQ9UDgbLUgwE81sYETdeHBVHUgwE+lYRCWNRCgJ9UQoC/1MNBedTDATcUwwE3VMMBN5TDAR2XBkSMFMMBedVEAmgnHNvAv///wBXEgqWUgwE8VwaE0NUDga1UwwE7FoXD0xsMSoIXRoTLFMNBdVTDQXPYiEaQVMNBe1RCQGIWhcPQlIMBPNSCwP/VxIKfV8eFkhSDAT6VhEJY1EKAn1TDQX9YSEZWVsZERRbGREYWxkRGFwaEg52PTcFVQ8HqFMNBeBeHRUfXh0VGFMNBdhUDwe4Xx0WNlIMBO1VEAirgU9JBHM6MwAAAAAAXx8XV14dFYNmJyBEUw0F7VELA4tWEQmLVA4G5VYRCsNUDgbEXx0WWlIMBPlWEQljUQoCfVMMBf1kJB1mbTApJ2suJyprLicmay4nB1ELAwBYFA1YUgwE91gUDFpaFw9OUgwE+VgUDGhaFw81UgsD91YSCpIfAAAAu5+cAAAAAAD///8AXh0VAGMjHCtTDQXtUw0FoVQOBtBVDwenWhcPXlMNBepcGRKKUgwE91YRCWNRCgJ9UQoC/1UPCO5WEQnnVhEJ6FYRCc5WEQkmXx0WAF8eFxpTDQXZVRAIq1YRCaBTDATmXRoTJV8eFyZTDQXrVQ8Ir3lBOwVvNC4AlmtmAGAgGS1gHxg9ZCUeNVMNBepUDgbVUwwE8lcSCl9gHhceUw0F3VgUDdFTDAT5VhEJY1EKAn1SDAT+XRsTgVwaEk1cGhJRXBoSR1waEg1vNC4AAAAAAFYRCZBTDQX0Uw0F8lQPB6V4QjwDbjMsCVUQCLFSDATvWBQMVG0yKw1cGREzVA4G01UQCMljIxw+Uw0F6VEKAv9TDQXgXx4XJKyLhwJVEAinUgwE/1ILA/9WEQpjUQoCfVMNBf1hIBlcXBoSGVwaEh1cGhIdYB8YDgAAAABWEQkAWhcPQVILBPNSCwP7WBQMVVILAwBQCQEAWxgQN1MNBdVSDATxVA8HzlMMBeZTDATtWBUNXmQlHipTDQXqUQoC/1UPB6d5QjwEUgsEAFgTDGNSCwP+UQoC/1YRCmNRCgJ9UQoC/1IMBOxSDATkUgwE5FIMBONXEwtlAAAAAGAgGABgHxgOVhIKdlYSCn5eHRUWXRwUAHM5MwAAAAAAXRsTLVcSC41XEwu6VxMLo1oWD0t0OjMDZiggF1cTC39VEAiMWRUNQU8HAABbGBAAXRsUH1YRCYNVEAiLWhcQNVUQCENVEAiMVRAIi1UQCIxVEAiMVRAIi1oXDz4YACAAGAAAAAgAAAAAGAAAgD4AAIAYAADAAAAAwwAIAMOAGAA=",
  "environmentUrl": "https://myenv.appiancloud.com"
}

Appian for Windows installer reference

Installer options and properties

The following are the relevant options and properties for deploying Appian for Windows. Combine them to build msiexec commands for installing, upgrading, rebranding, or uninstalling the app. For all available msiexec options, see Microsoft's msiexec reference.

Install options

Install options come immediately after msiexec and must be followed by the path to the .msi file.

Option Description
/i <PATH_TO_MSI_FILE> Install or upgrade. Must include the path to the .msi installation file.
/x <PATH_TO_MSI_FILE> Uninstall. Must include the path to the .msi file for the currently installed version, or the product GUI (ProductCode).
/fvomus <PATH_TO_MSI_FILE> Repair. Reinstalls missing files and re-registers components without a full reinstall. Used for rebranding.

Behavior options

Behavior options can come in any order after the .msi file path.

Option Description
/qn Silent mode—suppresses all installer UI. Required for app distribution tools. If omitted on a manual install, the installer displays a progress dialog.
/l*v <LOGFILE> Verbose logging. Writes detailed installer output to the specified file. Use for troubleshooting.

Installer properties

Unlike the install and behavior options, which are built into Windows, the following properties are specific to the Appian for Windows installer. They can come in any order after the .msi file path.

Property Description
BRANDINGJSON=<PATH_TO_BRANDING_FILE> Applies custom branding during install, upgrade, or rebrand. Must include the path to the branding.json file.
PRESERVEUSERDATA=1 Skips cleanup of user data, branding configuration, and encryption key during uninstall.

Installer commands

Use the following msiexec commands to install, upgrade, rebrand, or uninstall Appian for Windows.

Example of a full command with the file paths included: msiexec /fvomus C:\Installer.msi BRANDINGJSON=C:\branding.json

Install app with branding

Install the Appian for Windows app and apply custom branding from the branding.json file. The installer creates a Start Menu shortcut with your custom name and icon.

1

msiexec /i <PATH_TO_MSI_FILE> BRANDINGJSON=<PATH_TO_BRANDING_FILE>

Install app without branding

Install the Appian for Windows app with default Appian branding and create a Start Menu shortcut. You can also double-click the .msi file to install without branding.

1

msiexec /i <PATH_TO_MSI_FILE>

Upgrade app

Upgrade an Appian for Windows app to a new version. Branding, user data, and the encryption key are preserved.

1

msiexec /i <PATH_TO_NEW_MSI_FILE>

Note:  Downgrades aren't supported. To install an older version, uninstall the current version first.

Upgrade and rebrand app

Upgrade the Appian for Windows app and overwrite the existing branding with the new file. User data and the encryption key are preserved automatically.

1

msiexec /i <PATH_TO_NEW_MSI_FILE> BRANDINGJSON=<PATH_TO_NEW_BRANDING_FILE>

Rebrand app without upgrading

Update branding on an existing Appian for Windows app without changing the app version. Use this command to change the app, shortcut, or folder name, or the icon or environment URL.

1

msiexec /fvomus <PATH_TO_MSI_FILE> BRANDINGJSON=<PATH_TO_NEW_BRANDING_FILE>

Note:  Removing branding isn't supported. To revert to default branding, uninstall and reinstall without a branding.json file.

Uninstall app

Remove all Appian for Windows application files, branding configuration, user data, encryption key, and Start Menu shortcuts.

You can also uninstall from Settings > Apps > Installed apps on the Windows device.

1

msiexec /x <PATH_TO_MSI_FILE>

Uninstall app and preserve user data

Remove Appian for Windows application files and Start Menu shortcuts, but preserves branding configuration, user data, and the encryption key. Use this command when you plan to reinstall the app, or you get an error that the app couldn't be uninstalled .

1

msiexec /x <PATH_TO_MSI_FILE> PRESERVEUSERDATA=1

Troubleshoot installation

Add /l*v <LOGFILE> to any msiexec command to capture verbose logs for troubleshooting. For example, msiexec /i C:\Installer.msi BRANDINGJSON=C:\branding.json /l*v install.log

1

msiexec /i <PATH_TO_MSI_FILE> /l*v <LOGFILE>

Appian for Windows data directories

Appian for Windows stores data in three directories:

Directory Location Purpose
Application files C:\Program Files\Appian\AppianDesktop\ Stores application binaries. Completely replaced during upgrades.
Branding configuration C:\ProgramData\Appian\AppianDesktop\ Stores the branding configuration file and custom icon. Persists across upgrades. Shared by all users on the machine.
User data C:\Users\[Username]\AppData\Local\AppianDesktop\ Stores offline forms, attachments, cache, and logs. Each Windows user has a separate directory. Persists across upgrades.

Appian for Windows also stores an encryption key in Windows Credential Manager under the name Appian. The encryption key protects the local offline database and persists across upgrades.

Sign in and switch environments

Sign in to Appian for Windows

After installation, end users must sign in to the Appian for Windows app.

To sign in:

  1. Open the app from the Start Menu.
  2. If the environment URL wasn't configured in the branding file, enter the URL for the Appian environment.
  3. Enter Appian credentials.

Once signed in, the app syncs offline-enabled forms and data to the Windows device.

Switch environments in Appian for Windows

If the environmentUrl field isn't configured in branding.json, you can switch environments in the Appian for Windows app from the title bar.

  1. Go to the user menu, and click Sign Out.
  2. In the title bar, click the menu icon , and click Switch Environment.

Feedback