Skip to main content

Opening documents

ARender accepts documents through URL parameters on the main viewer page. This page covers all the ways to open documents in the viewer.

For a quick hands-on introduction, see the quickstart guide for your viewer.

Opening a document by URL​

Pass a url parameter pointing to an HTTP-accessible document:

https://your-arender-host/?url=https://example.com/contract.pdf
info

The rendition service has a safeguard that only authorizes whitelisted domain/host URLs. By default, no domain is authorized. See the broker environment variable DSB_AUTHORIZED_URLS.

Opening a document by pre-generated ID​

Pass a uuid parameter containing a previously generated DocumentId:

https://your-arender-host/?uuid=b64_dXJsPWh0dHA6Ly9leGFtcGxlLmNvbS9zYW1wbGUucGRm

This is the typical pattern when an external system (a connector, an ECM plugin, or a backend call) has already loaded the document and registered it with the Document Service Broker. The viewer looks up the existing DocumentAccessor from the cache rather than fetching the document again.

Multi-document opening​

There are two modes for displaying multiple documents simultaneously.

Pre-built DocumentContainer​

A connector or backend code can programmatically create a DocumentContainer, populate its children with DocumentReference objects, and register it with the document service. The viewer then receives a single uuid pointing to the container.

In both cases, child documents have hierarchical DocumentId values derived from the container's root ID.

Multiple URL parameters​

Not supported yet.

Opening a document at runtime​

To open or change a document after the page has loaded, use the JavaScript API instead of URL parameters:

window.ARender.openDocumentByUrl('https://example.com/contract.pdf');

This is the typical pattern when the document to display depends on a user action (clicking a row in a table, selecting a file, etc.). Calls made before the viewer finishes mounting are queued automatically — no need to wait for any event.

You can also open a document by its pre-generated ARender ID:

window.ARender.openDocument('b64_dXJsPWh0dHA6Ly9leGFtcGxlLmNvbS9zYW1wbGUucGRm');

See Web Component → JavaScript API for the full API reference.

Last updated on