Share or Embed Models

This chapter provides an overview of the most important functions for sharing models with other users or embedding models into other applications.

Share Models, Objects and Analyses

You can generate a URL based on models, objects and analyses. This way you can e.g. easily share an analysis with your colleagues via email or add a specific model to your browser's bookmarks.

To generate a URL:

1. Open the model or analysis, or open the Notebook of the object.

2. Click the Share button .

3. Now do one of the following:

   • Share the URL by email. In the Add people box, start typing the username or email address of a user, and then select the one you want when you see it. If the recipient is not a user or has no email address associated, you need to enter the full email address. Add additional recipients as needed. In the Include a message box, you can add a personal message if you want. When you are done, click Share and the message will be sent.

   • Paste the URL wherever you need it. Click Copy to directly copy the URL to the clipboard, or copy the URL manually from the Copy link box.

note

Before ADOIT can send emails, the mail settings must be set correctly in the Administration Toolkit.

Who Can Access These URLs?

If a user uses the Organisation Portal anonymously (= without supplying user credentials) and generates a URL, anyone can access the content. Otherwise, accessing the URL requires a login to ADOIT.

Language and Release Workflows

The generated URL contains the current language as a parameter. When the URL is accessed, the content is opened in the same language the URL was created in.

Example

You are working in English and have generated a URL for a model. The generated URL automatically points to the model in English.

When a release workflow is in use, generated URLs are automatically updated to use the latest released version of an object.

Example

You have generated a URL for an Application Component (internal version number "1.00"). A new version of this Application Component is released. The generated URL will automatically show you the new object (internal version number "2.00") instead of the deleted predecessor version.

Special Case: Generate URL for Application Scenario

When you open a URL for an application scenario, you will skip the ADOIT start page and go directly to the selected scenario. In order to generate such a URL:

• "Design & Document"

  Add "?scenarioID=ait_scenario_1_design_and_document" to the URL at which ADOIT is available.

• "Control & Release"

  Add "?scenarioID=ait_scenario_3_control_and_release" to the URL at which ADOIT is available.

• "Read & Explore"

  Add "?scenarioID=ait_scenario_4_explore_and_contribute" to the URL at which ADOIT is available.

Example

ADOIT is available at the URL http://server:8000/ADOIT16_0. You want to create a URL to directly access the "Design & Document" scenario.

The URL should look like this:

http://server:8000/ADOIT16_0?scenarioID=ait_scenario_1_design_and_document

Embed ADOIT as an iFrame

The HTML element iFrame allows you to embed ADOIT in a website. This may include e.g. a blog or the website of your organisation. Embedding ADOIT in another web application is also possible.

Embed ADOIT in a Website

• Insert the URL at which ADOIT is available into the following HTML code:

  <iframe src="URL" width="800" height="800"/>

• Insert the code into the web page where you want ADOIT to appear. Adjust the width (width) and height (height) to fit the dimensions of your website.

Embed a Specific Model in a Website

• Generate a URL which references the model which you want to embed in your website.

• Insert the model URL into the following HTML code:

  <iframe src="MODEL URL" width="800" height="800"/>

• Insert the code into the web page where you want the model to appear. Adjust the width (width) and height (height) to fit the dimensions of your website.

Additional Options

When embedding ADOIT in a website, you can customize the appearance and behaviour of the iFrame by adding different URL parameters:

• Set language

  To set the language in which ADOIT is displayed, add "&lang=<language code>" to the URL. Depending on the product configuration, possible language codes are e.g. “en” for English or “de” for German. By default, this parameter is already included in a model URL.

Passing Multiple Parameters

Only the first parameter is separated from the URL with a question mark (?). To pass multiple parameters to the same URL, pass all parameters after the first parameter using an ampersand (&).

Enable Embedding ADOIT as an iFrame

In ADOIT, displaying the web client within a frame is not allowed due to security reasons by default. The iFrame will remain blank in this case. To enable embedding ADOIT as an iFrame:

1. Open the folder “<Tomcat installation>/webapps“ and open the file ADOIT16_0.war with a file archiver. Edit the file adoxx_web.properties which can be found inside.

2. Set security.src.frame-ancestors based on the pages which should be allowed to embed ADOIT as an iFrame. The parameter 'self' allows you to embed ADOIT from pages with the same origin as the web server. In addition, one or more URLs of websites may be specified. Separate the parameters with a space. Save the changes afterwards.

Example

If you want to allow embedding ADOIT as an iFrame from the same origin and https://example.com, you can use:

security.src.frame-ancestors = 'self' https://example.com

The Apache Tomcat web server has to be restarted for the configuration changes to become effective.

Access ADOIT via a REST API

ADOIT provides a REST interface. This interface can be used to access data in ADOIT from other applications.

Via the REST API included in ADOIT you can e.g. display a model graphic or other model data from another application.

note

Instructions on how to activate access to the REST API are covered in the chapter REST API in the Administration Manual.

For information on how to use the REST API, please refer to the ADOxx Developer Portal.

If you have questions, please contact your ADOIT consultant.