This is an old revision of the document!

WebViewer Export

The Onyx 3D WebViewer allows to create a web based representation of the dataset for viewing in web browsers, including on mobile devices. The WebViewer can be integrated into websites or web portals of service providers, but does not itself provide any functions that go beyond mere presentation. See also entry Web-based communication.

Usage

Export a web based 3D dataset in the fullscreen view of the respective finding using the object list context menu entry "Web Export". It is also available through the context menu entry of the thumbnail in tab 3D. Enter a name under which the link is stored in Onyx and fill out the following dialog:

Entry	Description	Standard
Show Visible Objects Only	If checked, no invisible objects are exported to reduce the file size.	on
Animation (source)	Include the animation which can be generated when saving the finding from the modules V.T.O. 3D, Aligner 3D or Sim 3D	on
Comment	Display the comment of the finding as static text in the webviewer	off
Object List	Show an Onyx-like list for modifying objects	off
Colors	Use individualized colors in the webviewer	off
Password	Always choose a new password for data protection (or leave empty for random password)
Embed Password into Link	on: The password is written as part of the link (lower security), off: The password must be communicated separately and must be entered on starting the viewer (higher security)	off
Patient Data	Select the data to display on the information popup	all off
Link	Result which can be given to the user or can be embedded into a patient-specific web page
Password	Only displayed then not included in the link

Configuration

The upload has to be configured in System Options on tab Upload Data > 3D-Web-Viewer before it becomes available as menu item.

Entry	Description	Example
Host	Your provider for the FTP-webspace	123.456.789.012
Connection Security	Upload protocol	FTPS
User Name	The user name für the FTP access	onyxUser
User Password	The password for the FTP access	••••
htaccess	Add a file for access-control (CORS) to the server	yes
Host Directory	The data directory relative to the host	`public_html/OnyxWebviewerUploads`
Viewer Homepage	Your individualized page with embedded Webviewer (see example below)	`www.image-instruments.de/webviewer/index.html`
Data Address	The address of the host directory as visible from outside	`???.de/OnyxWebviewerUploads/`

Take care of the valid sequence of protocols in both the iframe-embedding in the viewer homepage and in the configuration above (http >= https in Viewer Homepage > iFrame > Data-Address)
Notice that the of the Host Directory might be different from the address from outside (Data Address)
The minimal page for an individualized viewer looks like this:
Please note that the way of embedding has changed due to a new security feature (or bug) in the safari browser:

<html xmlns="http://www.w3.org/1999/xhtml">
<head> <title>My 3D Viewer</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
  <script> 
    function addIFrame() { // New dynamic frame insertion via script
      var iframe = document.createElement('iframe');
      iframe.setAttribute('name', 'OnyxCephWebGL');
      iframe.setAttribute('style', 'position:fixed; top:0px; left:0px; bottom:0px; right:0px; width:100%; height:100%; border:none; margin:0; padding:0; overflow:hidden; z-index:1;');
      iframe.setAttribute('src', '//onyx.orthorobot.com/webviewer/main.html'+window.location.search); // change this to any "?mlink=abc.iiwgl&p=xxx&..." link from OnyxCeph
      document.body.appendChild(iframe);
    }
  </script>
</head>
<body onload="addIFrame()">
  <img src="MyLogo.png" style="position:absolute;top:0;left:0;z-index:2">
  <!-- the iframe is inserted here -->
</body>
</html>

Troubleshooting

The upload does not work:

Check the upload-settings and verify that you can connect wwith your settings using an auxilliary tool like TotalCommander or FileZilla

The viewer page stays empty with the message "Downloading":

Check the data address in the configuration: can you access the iiwgl file linked in the URL after the mlink=? If not use an FTP tool to see where your data is uploaded to and how you can access those files over http or https. Possibly, the file type must be declared explicitly as "allowed to download" in the server configuration.
Open the development tools in your browser using F12 and look for any red error message in the console:
- If the error contains something about "CORS", it is not loading because of a security mechanism which must be configured correctly at the server.
- If the error complains about http and https: verify your configuration: a viewer at https cannot access data using http

Links

	WebView Upload Settings
	WebViewer Controls
	WebViewer Examples

[OnyxCeph³™ Wiki]

Table of Contents

WebViewer Export

Usage

Configuration

Troubleshooting

Links