Document toolboxDocument toolbox

External Content - URL Template

Introduction

Object Classes marked as External Content can be opened in HyperDoc Viewer by using iFrame.

Any URL can be loaded based on template. Template can be really simple (single fieled value) or more complex, with multiple values.

Simple template: {my_url}

Object class must contain "my_url" field that will be used to load external resource.

More advanced examples are described below.

 Note: there is no authentication between HyperDoc and external service at that point. 

HyperDoc is not aware about the loaded content, cannot manipulate it in any way or be responsible for the content loaded. 

Example URL

Lets consider that our service is using such URLs:

https://websharecloud.com/? v=pv &t=p:default, c:panoramaview, m:t &pv=pv1 &pv1=u:02da8ae5-69d1-4062-bdb5-dc49de0a147a ,p:1.620, t:-0.079 &p=bim-hubs-uk https://websharecloud.com/? v=pv &t=p:default, c:panoramaview, m:t &pv=pv1 &pv1=u:c7950283-db36-4cba-9cd9-20c66eb9320b ,p:3.694, t:0.084 &p=castle-solitude https://websharecloud.com/? v=pv &t=p:default, c:panoramaview, m:t &pv=pv1 &pv1=u:97b31517-617f-4e00-b678-f220e3da72b3 ,p:6.060, t:0.051 &p=ch-kapellbrcke-luzern-20140605-df https://websharecloud.com/? v=pv &t=p:default, c:panoramaview, m:t &pv=pv1 &pv1=u:feb51ba1-5637-4772-9708-4fbf3eae2f98 ,p:2.930, t:-0.147 &p=apartment-finished

Based on several examples, we can see, that there is a GUID field and a project name that are important for us.

We can create the following template in that case:

https://websharecloud.com/?v=pv&t=p:default,c:panoramaview,m:t&pv=pv1&pv1=u:{scene_guid},p:0,t:0&p={faro_project}

Our object must have required fields "scene_guid" and "faro_project"

Class Definition

Sample class definition for serving external URL.

Simple URL where full field content will be used without further additions:

 

Advanced URL template that will use multiple fields and additional text from template itself:

 

Another example, a URL that gives the possibility to enter "base url" and parameters:

Loading External Content

The content is loaded automatically by HyperDoc Viewer. In case of this example, its a Faro WebShare Viewer with specific scene.