Plug-in (Component)Free

Apryse WebViewer Component Plug-in

by Apryse Software Inc

Description

Overview

Apryse WebViewer for Appian is renowned document technology that powers mission-critical applications for private companies, large enterprises, and governments alike.

> Made Better – Document Processing Tools Bring a fully customizable suite of the highest quality document tools to your Appian instance and easily integrate any common and uncommon document capabilities to work on PDF, MS Office, Images, HTML, CAD, BIM, DICOM, and many more.

> Out-of-the-box or Fully Customizable User Interface Adjust the user experience to align with your Appian requirements and configure styling and available functionalities comfortably in Appian Designer - or take full control of the user experience and customize details by directly changing the UI’s source code.

> Secure Client-Side Processing Eliminate security loopholes: Not only can your users complete document tasks within Appian, with client-side processing the data also never leaves the Appian instance.

> Conveniently Open & Save Documents from and to Appian Get WebViewer Connected System to open documents from Appian: https://community.appian.com/b/appmarket/posts/apryse-webviewer-connected-system

> Pricing:

The Plug-in offers unlimited WebViewer features for free in demo mode, limited only by watermarking processed documents until a license is obtained

Apryse's licensing model scales appropriately with the depth of licensed functionality and your anticipated scope of distribution.

Before deploying to production, please contact us to obtain a license: https://apryse.com/form/contact-sales?utm_medium=partner&utm_source=appian

> Support:

Reach Apryse’s Solution Engineers for technical questions or to report issues: https://apryse.com/form/trial-support?utm_medium=partner&utm_source=appian

Deep dive blog on configuration options https://apryse.com/blog/appian/view-and-edit-pdf-and-word-documents-with-appian

Features

Key Features & Functionality

> View & Search on PDF, DOCX, XLSX, PPTX, Images, and more Multiple viewing options, reflow mode, and unlimited zoom allow you to view even the most complex or large documents with high-speed and reliability.

> Annotate, comment, review & approvals Collaborate on PDF, MS Office, and other formats using any of 35+ different annotation tools, such as highlights, stamps and notes. Export annotations via XFDF, and all PDF annotation types.

> PDF In-line Text Editing Edit & reflow PDF text and images, resize or change the position of text and images. Apply different styles like bolding, italicizing or underlining.

> PDF Page Manipulation & Document Assembly Insert pages and content, append, split, remove, crop, reorder, rotate, export, edit, and more – manually or programmatically.

> Redaction Safely and permanently remove sensitive content from PDFs. Redact regions and text manually in the Viewer - or programmatically via search & redact, including RegEx search to detect and remove personally identifiable information (PII).

> Digital Signatures Sign PDFs using standard (and custom) Digital Signatures. Extract information for validation. Support multiple signatures and XFDF.

> PDF Form Filling & Extraction Support interactive form filling, FDF, and embedded JavaScript - or programmatically create, pre-fill, sign, extract, and flatten PDF forms.

> Document Comparison Compare two documents side by side and highlight differences. Compare changes in semantic categories, such as headers, paragraphs, numbers, and generate a differences summary document for easy review.

> Learn more about WebViewer: Product Page: https://apryse.com/plugins/appian?utm_medium=partner&utm_source=appian

Feature Chart: https://apryse.com/feature-chart?utm_medium=partner&utm_source=appian

Appian Documentation, FAQ, Guides: https://docs.apryse.com/documentation/appian/

Release notes

Changelog

  • Fixed bug where custom data was not available.
Version history (45)

6.0.3

Changelog

  • Updated WebViewer to 11.12. Please refer to the full changelog on our site.

6.0.2

Changelog

  • Updated WebViewer from 11.7 to 11.9.
  • Fixed error when using modular header items.

6.0.0

Changelog

  • WebViewer now uses the new modular UI, where you can design the UI however you like with the new 'modularUIComponents' property. If you prefer the previous UI, please use the 'useLegacyUI' option to enable it.
  • Deprecated old properties on the component. Please find a list below:
  • serviceAPIKey
  • customCSSPath
  • newSavedDocumentId
  • enableDocumentAlteredEvent
  • mentionsAPIURL
  • appianProcessButtons
  • Updated WebViewer to 11.7.1.
  • Added 'useCaseSensitiveSearch' option to toggle case sensitivity when searching with 'searchTerm'.
  • Added 'useCaseSensitiveRedaction' option to toggle case sensitivity when searching with 'redactionTerm'.
  • Added a bit of delay before setting the initial zoom level.

5.10.1

Changelog

  • Updated WebViewer to 11.5.

5.10.0

Changelog

  • Updated WebViewer to 11.4.
  • Added support for loading the spreadsheet editor.
  • Added support for live changes when using document generation.
  • Added property to change the delay of debounced events. Please note this affects all debounced events.
  • Added property to set initial ribbon group.
  • Added property to set initial tool mode.
  • Added property to set the initial Office Editor mode. Poissble values are "edit", "review", "preview, and "viewOnly".
  • Added event that triggers when tracked changes are updated. You will get the previous, current, and delta of the changes.
  • Removed validation messages for errors. The only one left should be for the connected systems.

5.10.0

Changelog

  • Updated WebViewer to 11.4.
  • Added support for loading the spreadsheet editor.
  • Added support for live changes when using document generation.
  • Added property to change the delay of debounced events. Please note this affects all debounced events.
  • Added property to set initial ribbon group.
  • Added property to set initial tool mode.
  • Added property to set the initial Office Editor mode. Poissble values are "edit", "review", "preview, and "viewOnly".
  • Added event that triggers when tracked changes are updated. You will get the previous, current, and delta of the changes.
  • Removed validation messages for errors. The only one left should be for the connected systems.

5.9.1

Changelog

  • Fixed issue where onSaveDocument did not trigger with SaveAs.

5.9.0

Changelog

  • Updated WebViewer from 11.2 to 11.3. Read the full change log here: https://docs.apryse.com/web/guides/changelog.
  • Added new enabledEventsMap property to enable events in the component. This is in light of events triggering Appian to submit requests to the server. Old properties to toggle certain events will be deprecated in a future major update.
  • Changed some events to be debounced as they can be invoked multiple times:
    onRotationUpdated
    onPageNumberUpdated
    onTextSelected
    onZoomUpdated
  • Added checks to ensure component validation messages also don't fire unless necessary, as they seem to send requests as well.

5.8.0

Changelog

  • Updated WebViewer from 11.1 to 11.2. Read the full change log here: https://docs.apryse.com/web/guides/changelog.
  • Added new events from document viewer and annotation manager to allow for handling these events from Appian as opposed to a config file

Below is a list:

  • onDocumentLoaded: Triggered when a document finishes loading in the viewer.
  • onAnnotationsLoaded: Fired after annotations are fully loaded and rendered on the document.
  • onCompareAnnotationsLoaded: Occurs when annotations from a comparison operation are loaded and displayed.
  • onDocumentUnloaded: Triggered when a document is unloaded or removed from the viewer.
  • onPageComplete: Signals that a page has been fully rendered.
  • onPagesUpdated: Triggered when the document’s page structure or content changes (e.g., pages added or reordered).
  • onRotationUpdated: Fired when the temporary rotation of a page is changed in the viewer.
  • onPageNumberUpdated: Triggered when the currently visible page number is updated.
  • onTextSelected: Occurs when text is selected by the user within the document.
  • onAnnotationSelected: Fired when an annotation is selected by the user.
  • onAnnotationDeselected: Triggered when an annotation is deselected by the user.
  • onFieldChanged: Occurs when a field (e.g., a form field) is modified by the user.
  • onToolModeUpdated: Fired when the active tool mode (e.g., annotation tool, selection tool) is updated.
  • onZoomUpdated: Triggered when the zoom level is changed in the viewer.
  • onSearchResultsChanged: Fired when the search results within the document are updated (e.g., new search term or results displayed).
  • Added spinner when saving to Appian
  • Added initialZoomLevel property that sets the zoom level on each document load
  • Added removeSaveAsFormatOptions property to remove certain formats from the save as modal. Use "pdf", "office", and "image"
  • Added support for loading with data URLs. This may be slower with larger files.

5.7.0

Changelog

  • Updated WebViewer to version 11.1.1. You can read the full changelog here: https://docs.apryse.com/web/guides/changelog
  • Updated component to use new UI APIs
  • Added WCAG compliance to the UI
  • Added option to use modular UI. The UI will remain as legacy until the next major version. Modular UI component properties are not available through properties yet. Please use the config file for now.

5.6.3

Changelog

  • Updated WebViewer to nightly stable build 20241028
  • Fixed issue where form field calculations don't work for specific files
  • Updated UI dependency

5.6.2

Changelog

  • Updated WebViewer to 10.12. You can read the full changelog for WebViewer here: https://docs.apryse.com/documentation/web/changelog/.
  • Added a query string to the main component file to avoid caching.

5.6.1

Changelog

  • Changed path of WebViewer lib files to include version. This is to avoid caching issues.
  • Added viewport scaling tag to HTML.
  • Fixed parameter type for the new enableDocumentAlteredEvent.

5.6.0

Changelog

  • Updated WebViewer to version 10.11.1. Notably, the tracked changes for Office Documents are now here! Full changelog here: https://docs.apryse.com/documentation/web/changelog/v10-11-1/
  • Added onDocumentAltered event for when the document is altered in any way. This will trigger on annotation changed, field changed, or when pages are updated.
  • Fixed bug where documents would reload despite it being the same document.
  • Fixed bug where a user could not change documents in Office Editor mode (workaround). A formal fix is in the works.

5.5.1

Changelog

  • Added workarounds for Office Editor not loading documents correctly and the editor typing twice.

5.5.0

Changelog

  • Updated WebViewer to version 10.10.1 nightly stable 20240620. Full changelog here: https://docs.apryse.com/documentation/web/changelog/v10-10-1/
  • Added option to preflatten a document before it is loaded. Saving the document will overwrite the original as it is treated as the same document as the original
  • Added more messages in the event of an error. There is a chance messages may not fully appear in the UI. The browser console is still more reliable.
  • Fixed issue where language was not being set in Office Editor

5.4.6

Changelog

  • Only a version number change to resolve update issue.

5.4.5

Changelog

  • Updated WebViewer to 20240524 nightly stable.
  • Added option to hide WebViewer. This allows WebViewer to be hidden initially and shown later, or processing something in the background.
  • Moved config file event trigger earlier to allow updates to values before viewer events.
  • Fixed issue where annotation toolbar is visible in Office editor mode.
  • Fixed issue where "Save As" back to Appian didn't work in Office editor.

5.4.4

Changelog

  • Updated WebViewer to 10.9 (nightly stable 20240506)

5.4.3

Changelog

  • Updated WebViewer to nightly stable 20240418
  • Added option to search and redact through a property (takes string/regex).
  • Added option to toggle console clearing for debugging purposes.
  • Fixed issue with Office Editor unable to load office files immediately.
  • Fixed issue WebViewer might spawn additional workers.

5.4.2

Changelog

  • Updated WebViewer to nightly stable 20240402. Contains fixes to loading documents and a pop-up menu not opening when using multi-tab.
  • Fixed issue where extracting a page with Save & Replace will change the underlying document ID.
  • Fixed issue where searchTerm doesn't search when a new value is received.
  • Removed creating highlight annotations when using searchTerm. Please use the config and the searchResultsChanged event to create annotations manually.

5.4.1

Fixed issue where an error will come up when extracting pages affecting the original document.

5.4.0

Updated WebViewer to 10.8 Added appianManager object to config file window. This can be used to trigger updates and interact with the connected systems. Fixed issue where annotation hotkeys are enabled when annotations are disabled. Fixed issue where an old removed API was used and referenced when extracting pages.

5.3.1

Updated WebViewer to 10.7.2. See the full change log here: https://docs.apryse.com/documentation/web/changelog/. Copy and pasting in the Office editor should be fixed. Fixed issue where opening a local file with Office editing enabled doesn't do into the office editor.

5.3.0

  • Updated WebViewer to 10.6 nightly stable.
  • Added property to enable read-only mode.
  • Added workaround to allow text and choice widgets to commit their values to fields immediately.
  • Fixed issue where field value changes were not getting saved through XFDF commands. Forms created through form creation mode will not work with the XFDF commands.

5.2.0

  • Updated WebViewer to 10.6
  • Added documentLoaded event.
  • Added timer for triggering events with refreshVariable.
  • Added support for getting the license securely from the connected systems. This takes priority.
  • Fixed issue where imported annotations were not re-rendered.

Checkout the new realtime collaboration sample with Appian!

5.1.0

  • Updated WebViewer to 10.5.1.
  • Added better tracking and saving of multitab documents.
  • Added option to provide annotation command list.
  • Added onSaveDocument event that triggers when the document is saved.
  • Added onAnnotationsChanged event that triggers when annotations are changed.
  • Added onMentionsChanged event that triggers when mentions are changed.
  • Deprecated signature request options in favor of using input and event parameters. Please use the new parameters instead:

-- currentSignatureWorkflow: An object that has the current signature workflow info { documentId: 1252, initiator: "Bob", createdBy: "Bob", xfdfDocumentIds: { Bob: 1279, }, } -- onStartSignatureWorkflow: An event triggered when the workflow for a document is started for the first time. You get the same object above. -- onSelectAssignee: An event triggered when an assignee is assigned a field.

  • The following properties will be deprecated in 6.0: customCSSPath, newSavedDocumentId, and mentionsAPIURL.
  • Fixed issue where WV would reload too often from parameter changes.
  • Fixed issue where annotations would get disabled after saving.
  • Fixed issue where certain events would trigger with old values.

5.1.0

WebViewer Updates

  • Updated WebViewer to 10.5.

New features

  • Added better tracking and saving of multitab documents.
  • Added option to provide annotation command list.
  • Added onSaveDocument event that triggers when the document is saved.
  • Added onAnnotationsChanged event that triggers when annotations are changed.
  • Added onMentionsChanged event that triggers when mentions are changed.
  • Deprecated signature request options in favor of using input and event parameters.

Please use the new parameters instead:

  • currentSignatureWorkflow: An object that has the current signature workflow info

{ documentId: 1252, initiator: "Bob", createdBy: "Bob", xfdfDocumentIds: { Bob: 1279, }, }

  • onStartSignatureWorkflow: An event triggered when the workflow for a document is started for the first time. You get the same object above.
  • onSelectAssignee: An event triggered when an assignee is assigned a field.

Deprecations The following properties will be deprecated in WebViewer 6.0.0: customCSSPath, newSavedDocumentId, and mentionsAPIURL.

Bug fixes

  • Fixed issue where WV would reload too often from parameter changes.
  • Fixed issue where annotations would get disabled after saving.
  • Fixed issue where certain events would trigger with old values.

5.0.3

  • Updated WebViewer to 10.4: https://docs.apryse.com/documentation/web/changelog/v10-4-0/
  • Added support for PDF Portfolios
  • Added snipping tool
  • Added option to use a custom CSS file on Appian via a file ID
  • Added customData property to pass custom values from Appian expressions to the config file

5.0.2

Fixed issue where events were bound to an old set of Appian values. Fixed issue where some event handlers still use a deprecated function.

5.0.1

  • Updated WebViewer to 10.3
  • Added option to disable the Appian Menu and place the items back into the header.
  • Added data elements to disable items in the Appian Menu
  • Added some more Appian parameters for the config file to use via custom data
  • Optimize some data conversion
  • Fixed issue with infinite load when loading documents for semantic compare

5.0.0

-Updated WebViewer to 10.2.3. -Updated loading and saving to work with updated connected systems 3.0. Fetching and saving will be a bit more optimized, oldest compatible Appian version is now 23.2

Please use the connected systems over loading files with the Service API Key. If you plan to use the Service API Key, please limit it's access to just that API. This option will be disabled in a future update.

4.3.0

  • Added ability to add buttons to the Appian menu to call Appian Web APIs
  • Added Appian API Key to loadDocument call when loading documents through Web APIs
  • Added custom data for the config file
  • Added a new newAppianValues event that can be listened for in config files. It will contain the Appian object and component parameters
  • Added image SaveAs support
  • Fixed bug where using Save on an image would save as a PDF instead of the original type. It will now save with the original type

4.2.0

  • Added ability to run custom JavaScript code by providing a config file hosted on Appian (https://docs.apryse.com/documentation/web/guides/config-files/)
  • Added Sample Package to showcase how to use a custom config file. The config file that is in the sample showcases code to automatically open the notes panel and add a red rectangle when a document gets loaded
  • Fixed issue where dragging thumbnails would fail due to a missing API.

4.1.0

  • Added ability to encrypt signatures
  • Added Appian saving menu / UI clean up
  • Added option to enforce SaveAs filename to be changed
  • Updated WebViewer to v10.0.1: https://docs.apryse.com/documentation/web/changelog/v10-0-1/

4.0.0

  • Updated WebViewer to v10.0.0 (https://docs.apryse.com/documentation/web/changelog)
  • Added PDF Content Editing
  • Added DOCX / Microsoft Word Editing (beta)
  • Added Signature Workflow Sample Application Package

3.1.1

  • Fixed issues saving an open document due to a wrong ID parameter
  • Fixed issues with filename on the SaveAs modal
  • Fixed issues where modals would stay open after the document changes
  • Updated branding

3.1.0

  • Updated listing to represent new brand Apryse (formerly known as PDFTron)
  • Added ability to watermark a document
  • Added ability to add filename conventions / make filenames read-only to enforce naming conventions

3.0.0

Added a new parameter enableSemanticCompareMode which starts comparison mode when two documents are passed via appianDocId or URL

2.1.0

Added a new parameter searchTerm - this string represents a search term that automatically starts on document load.

2.0.0

Updated screenshots for the component Updated WebViewer to version 8.8 Uploaded older compatible version

1.0.4

  • Resolved the issue where the workers were loaded twice
  • Now the WebViewer component should load twice as fast

1.0.3

  • Added a new default action for Extract selected pages button to remove pages selected from existing document and save as a new document

1.0.2

  • Added support for viewing, annotating and manipulating MS Office files client-side without reliance on any third-party servers.
  • Added a new variable that allows loading and saving the XFDF string that contains annotations.
  • Added a new button to UI that allows updating the XFDF string.

1.0.0

Updating the description.

Resources

  • Apryse Webviewer for Appian Datasheet.pdf

    Other

    Download