> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/appian/get-started/install.md). # Install Apryse WebViewer in Appian Learn how to install the WebViewer Component in Appian with this comprehensive guide. Install the free trial, remove watermarks, and deploy to a production environment. Get started now! Appian WebView 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. {% hint style="info" %} **License Key Required** The trial of Apryse SDK requires a trial license key, which is provided in the box titled "License Key". A commercial license key is required for use in a production environment. Please [contact sales](https://apryse.com/form/contact-sales) to purchase a commercial key or if you need any other license key assistance. {% endhint %} {% hint style="warning" %} **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). {% endhint %} ## Get Started You can view our most recent webinar on YouTube or follow installation steps shown below. {% embed url="" %} ## Prerequisites * Appian Community Edition or other Appian environment * Access to Admin Center to install Plugins from Appian AppMarket To test the solution, you can follow step-by-step help on [setting up an Appian Community Cloud instance](https://community.appian.com/p/community-edition-guide). ## Installation Steps ### Deploy Components to your Appian Environment 1. Log in to your Appian environment where you want to evaluate WebViewer. 2. Navigate to `Admin Console` from the waffle menu in the top right. 3. Click `Plug-ins` in the left-hand navigation under `SYSTEM`. The Plug-ins page will show a list of installed plug-ins. 4. Click `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. To install a plugin, click on its name. 6. Click on `DEPLOY` in the bottom right (this may take a couple of minutes). ### Connected System Plugin (CSP) Setup 1. Navigate to `Appian Designer` from the waffle menu in the top right. 2. Select your Appian App or create a new one. 3. Click on `BUILD` mode in the Appian Designer from the left panel. This is the second option from the top. 4. Click `Connected System` from the `NEW` drop-down button to create a new connected system. 5. Search in the text box or scroll to find the Apryse Connected System and select it. 6. Enter your desired Appian username as a text string (ex. `user@email.com`) in the `Upload Document as a User` required field. This is the user that will be used to interact with documents. Please ensure they have the correct permissions to do so. 7. Optionally specify a chunk size as a number (defaults to 32768016 bytes) in the `File Download Chunk Size` required field. 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. 8. Click on `CREATE` to create the connected system. 9. Click `Constant` from the `NEW` drop-down button to add a constant for the Connected System Plugin (CSP). Name your constant, select `Connected System` from the `Type` drop-down, and pass your Connected System Plugin (CSP) to the `Value` textbox. 10. Click on `CREATE` to add the constant pointing to the connected system. ### Component Plugin (CP) Setup 1. Navigate to `Appian Designer` from the waffle menu in the top right. 2. Select your Appian App where you have added your Connected System Plugin (CSP) and constant. 3. Click on `BUILD` mode in the Appian Designer from the left panel. This is the second option from the top. 4. From the `NEW` drop-down button, select `Interface` or open an existing page where you want to add WebViewer. 5. While in `DESIGN MODE` for a page, search in the component palette text box on the left, or scroll through to find the Apryse Component Plugin. 6. Drag and drop the Component Plugin (CP) on to the page at your desired location. 7. Scroll down While in the `COMPONENT CONFIGURATION` panel on the right hand side while the WebViewer component is selected. 8. Provide your connected system `Constant` created in Step 10 of Connected System Plugin (CSP) to the `Document Access Connected System` parameter (you will be able to type to search for your constant name, then select it). ### Input Your License Key The WebViewer license key can be inputted two ways: the connected systems or directly in the component. Both work the same way, and it depends on how you want to control access to the license. For example, setting it directly in the component property could allow designers of an interface to see the key or even output from a constant. You could then opt to set it in the connected systems instead, and prevent other users from access its properties.
Setting the key in the connected systems

Setting the key in the connected systems

Entering the license key via the component property

Entering the license key via the component property

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.apryse.com/appian/get-started/install.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.