Some test text!

Search
Hamburger Icon

Appian / Guides / Get Started

Install Apryse WebViewer in Appian

Welcome to the Apryse installation guide for the WebViewer Component in Appian. This guide will help you install a free trial of WebViewer into Appian. It will show you how to install the WebViewer Component Plugin and Connected System Plugin in Appian. When your evaluation is done, you can purchase a license key to remove the watermark from all documents and deploy to a production environment.

Your free trial includes unlimited trial usage and support from solution engineers.

No trial license key required.
The trial of Apryse SDK requires a trial key. A commercial license key is required for use in a production environment. Please fill out our licensing form if you do not have a valid license key.
Keep your license keys confidential.
License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Get Started

You can view our most recent webinar on YouTube or follow installation steps shown below.

Prerequisites

  • Appian Community Edition or other Appian environment
  • Access to Admin Center to install Plugins from Appian AppMarket

For step-by-step help on setting up an Appian Community Cloud instance to test the solution, you can follow the steps outlined here.

Installation Steps

Deploy Components to your Appian Environment

  1. Log in to your Appian environment where you want to evaluate WebViewer
  2. Select the waffle menu on the top right and navigate to Admin Console
  3. In the left-hand navigation, under SYSTEM select Plug-ins
  4. The Plug-ins page will show a list of installed plug-ins. Click on ADD PLUG-INS under the search text box.
  5. Search for Apryse. You should see (2) search results, one for Component Plugin and the other for Connected Systems Plugin. You will need to install ** both ** plugins for the solution to work.
  6. To install a plugin, click on its name. Then click on DEPLOY at the bottom right (this may take a couple of minutes).

Connected System Plugin (CSP) Setup

  1. Navigate to Appian Designer from the waffle menu on the top right.
  2. Select your Appian App or create a new one
  3. Switch over to BUILD mode in Appian Designer
  4. From the NEW drop-down button, select Connected System. Search in the text box or scroll to find the Apryse Connected System and select it.
  5. In the Upload Document as a User required field, enter your user as a text string (f.e. user@email.com).
  6. In the File Download Chunk Size required field, specify a chunk size as a number (f.e. 10000). This will allow for loading files larger than your Appian allotted memory heap size, by chunking files into multiple parts and combining chunks when saving or loading files.
  7. From the NEW drop-down button, select Constant - Name your constant, select Connected System from the Type drop-down, and pass your CSP to the Value textbox, then click on CREATE.

Component Plugin (CP) Setup

  1. Navigate to Appian Designer from the waffle menu on the top right.
  2. Select your Appian App where you have created your CSP reference / constant.
  3. Switch over to BUILD mode in Appian Designer
  4. From the NEW drop-down button, select Interface or choose an existing one where you want to add WebViewer. Open the Interface.
  5. While in DESIGN MODE, go to the PALETTE on the left hand side. Search in the text box or scroll to find the Apryse Component Plugin and drag and drop it onto the page.
  6. While in DESIGN MODE, go to the COMPONENT CONFIGURATION on the right hand side. Scroll down and pass your Constant created in Step 7 of CSP Setup to the Document Access Connected System parameter (you will be able to type to search for your constant name, then select it).

Get the answers you need: Chat with us