How is your experience with the OutSystems Community?
adobe-pdf-embed-api
Reactive icon

Adobe PDF Embed API

Stable version 1.1.4 (Compatible with OutSystems 11)
Uploaded
 on 9 Nov (13 hours ago)
 by 
3.7
 (3 ratings)
adobe-pdf-embed-api

Adobe PDF Embed API

Compatible with:
Created on OutSystems 11

Version 1.1.4

Stable
Current
See documentation
Uploaded on 12:33 (43 minutes ago) by 
Compatible with:
Version 11
↳11.12.0 or higher
Database:
All
Release notes:

Adobe PDF Embed API – Release Notes

Version Summary

This major update introduces significant performance optimizations, a Promise-based SDK loader, advanced PDF viewer customization options, interactive form filling, and a new interactive Demo module (AdobePDFEmbedAPI_Demo), 


What’s New

  • ViewMode Static Entity & DefaultViewMode Parameter:
    • Control initial zoom and page layout:
      • FIT_WIDTH (Default) – Scales page width to fill container; optimal for document readability.
      • FIT_PAGE – Fits whole page within container height.
      • TWO_COLUMN – Side-by-side spread layout.
      • TWO_COLUMN_FIT_PAGE – 2-column view fitted to page height.
  • Toolbar & Navigation Controls:
    • ShowFullScreen: Enables a full-screen expansion toggle in the viewer toolbar (especially valuable when embedded inside cards or dashboards in SIZED_CONTAINER mode).
    • ShowZoomControl: Toggle zoom in, zoom out, and reset zoom buttons.
    • ShowThumbnails & ShowBookmarks: Independently toggle thumbnail and outline panels inside the left sidebar (FULL_WINDOW and IN_LINE modes).
  • Interactive AcroForms Support (EnableFormFilling):
    • Allows end-users to interact with and fill out PDF form fields directly in the embedded viewer (FULL_WINDOW mode).
  • Fast Web Streaming for URLs (EnableLinearization on ViewPDFByLocation):
    • Enables HTTP byte-range streaming for linearized (web-optimized) PDFs in ViewPDFByLocation, rendering Page 1 immediately before the full file finishes downloading.
    • ViewPDFBinary automatically sets enableLinearization: false to prevent Adobe ValidationService errors with in-memory binary payloads.
  • Persistent Session & Annotation Support (DocumentId):
    • Optional unique document identifier passed to the Adobe SDK to persist comments, annotations, and search states across user sessions.
  • Configurable Adobe SDK CDN (AdobeScriptURL Site Property):
    • Added a configurable AdobeScriptURL site property (defaulting to Adobe’s official CDN https://acrobatservices.adobe.com/view-sdk/viewer.js), enabling enterprise environments with strict CSP or sovereign cloud policies to self-host or proxy the Adobe View SDK.
  • Enhanced Service Studio Documentation & Defaults:
    • Standardized EmbedMode default values to Entities.EmbedMode.SizedContainer and added detailed parameter descriptions across both blocks specifying mode compatibility (FULL_WINDOW, SIZED_CONTAINER, IN_LINE, LIGHT_BOX).

Performance & Reliability Improvements

  • Promise-Gated SDK Loader (Resolved AdobeDC is not defined Race Condition):
    • Refactored AddAdobeScript to use a singleton global Promise (window._adobeSdkPromise) synchronized with adobe_dc_view_sdk.ready. Multiple viewer blocks on the same screen now safely await the single script load without race conditions or duplicate <script> tags.
  • SPA Re-Initialization & Unmount Safety (OnParametersChanged / OnDestroy):
    • Added an OnDestroy lifecycle guard (isCancelled) so unmounted blocks never attempt to initialize the viewer if a user navigates away while the SDK is still downloading.
    • Explicitly clears the viewer container DOM (container.innerHTML = '') before re-rendering on parameter changes, preventing stacked iframes.
    • Detaches LightboxTrigger and SDK event listeners on destroy to prevent memory leaks.
  • Zero Server Round-Trips on Parameter Changes:
    • Refactored OnParametersChanged to re-initialize purely on the client once configuration is fetched. Dynamic document switching and UI toggles now apply instantaneously.
  • Responsive Container Styling (.adobe-pdf-embed-container):
    • Added built-in block stylesheet rules (width: 100%; height: 100%; min-height: 500px; flex: 1 1 auto; position: relative;) so viewer containers never collapse to 0px height inside flex or grid layouts.
  • Improved Error Handling:
    • Replaced the generic NotRegistered exception with a dedicated ConfigurationException. Missing AdobeClientID values now raise clear, actionable error feedback instead of redirecting users to a login screen.

Compatibility & Migration

  • 100% Backwards Compatible: All new parameters are optional with sensible default values. Existing applications consuming ViewPDFByLocation or ViewPDFBinary can upgrade seamlessly.
Application Objects:
Adobe PDF Embed API has 2 AOs.

Version 1.1.3

Under Development
See documentation
Uploaded on 13 October 2025 by 
Compatible with:
Version 11
↳11.12.0 or higher
Database:
All
Release notes:

Updated to align with the latest Adobe Embed API Modern Viewer

Deprecated/Removed Features

  • Left hand panel (showLeftPane) is deprecated in full window embed mode. Page thumbnails and bookmarks have moved to the right panel in modern viewer
  • Docking and undocking the bottom page control toolbar (DockPageControls) is removed in the modern viewer


New Features:

  • Show Zoom Control
  • Show Thumbnails
  • ShowBookmarks
  • ShowFuillScreen
  • ShowFullScreenViewButton
  • DefaultViewMode
  • EnableLinearization
  • EnableFormFilling



Application Objects:
Adobe PDF Embed API has 2 AOs.

Version 1.1.2

Stable
See documentation
Uploaded on 08 February 2023 by 
Compatible with:
Version 11
↳11.12.0 or higher
Database:
All
Release notes:

Updated to the modern PDF viewer Javascript Library.

The following configuration is deprecated

  • Left hand panel (showLeftHandPanel) 
  • The bottom page control toolbar (showPageControls)
  • Docking and undocking the bottom page control toolbar (dockPageControls)
Application Objects:
Adobe PDF Embed API has 1 AOs.