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.
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 to purchase a commercial key or if you need any other license key assistance.
License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).
Apryse collects some data regarding your usage of the SDK for product improvement.
If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.
You can view our most recent webinar on YouTube or follow installation steps shown below.
To test the solution, you can follow step-by-step help on setting up an Appian Community Cloud instance.
Admin Console from the waffle menu in the top right.Plug-ins in the left-hand navigation under SYSTEM. The Plug-ins page will show a list of installed plug-ins.ADD PLUG-INS under the search text box.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.DEPLOY in the bottom right (this may take a couple of minutes).Appian Designer from the waffle menu in the top right.BUILD mode in the Appian Designer from the left panel. This is the second option from the top.Connected System from the NEW drop-down button to create a new connected system.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.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.CREATE to create the connected system.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.CREATE to add the constant pointing to the connected system.Appian Designer from the waffle menu in the top right.BUILD mode in the Appian Designer from the left panel. This is the second option from the top.NEW drop-down button, select Interface or open an existing page where you want to add WebViewer.DESIGN MODE for a page, search in the component palette text box on the left, or scroll through to find the Apryse Component Plugin.COMPONENT CONFIGURATION panel on the right hand side while the WebViewer component is selected.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).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

Entering the license key via the component property
Did you find this helpful?
Trial setup questions?
Ask experts on DiscordNeed other help?
Contact SupportPricing or product questions?
Contact Sales