Share or Embed Models

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

Generate URL

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

To generate a URL:

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

2. Click the Share button , and then click Share link.

3. Now do one of the following:

   • Paste the URL wherever you need it. Depending on your browser, the URL is either copied directly to the clipboard or you have to copy it manually.

   • Share the URL by email. Click the Share button to open the default mail client with a predefined subject and message body.

note

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

The generated URL contains the current language as a parameter. When the URL is called, 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 a model or object.

Example

You have generated a URL for a Process Landscape (version number "1.00"). A new version of this Process Landscape is released. The generated URL will automatically show you the new model (version number "2.00") instead of the archived predecessor version.

Special Case: Generate URL for Application Scenario

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

• "Design & Document"

  Add "?scenarioID=anp_scenario_1_design_and_document" to the URL at which ADONIS is available.

• "Control & Release"

  Add "?scenarioID=anp_scenario_3_control_and_release" to the URL at which ADONIS is available.

• "Read & Explore"

  Add "?scenarioID=anp_scenario_2_read_and_explore" to the URL at which ADONIS is available.

Example

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

The URL should look like this:

http://server:8000/ADONIS12_0?scenarioID=anp_scenario_1_design_and_document

Special Case: Enable Accessibility Mode for Organisation Portal

Accessibility mode allows users with impairments to use the Organisation Portal more effectively. When this mode is enabled, the textual view is set as the default model editor. All model types without a textual view configuration will be opened in the tabular editor.

In order to generate a URL that opens the Organisation Portal in accessibility mode:

• Add "&accessibility=true" to the user-specific URL at which the Organisation Portal is available.

Example

The user-specific URL http://server:8000/ADONIS12_0?reader=Reader can be used to skip the login and go directly to the Organisation Portal. You want to modify this URL so that accessibility mode is enabled.

The URL should look like this:

http://server:8000/ADONIS12_0?reader=Reader&accessibility=true

Embed ADONIS as an iFrame

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

Embed ADONIS in a Website

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

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

• Insert the code into the web page where you want ADONIS 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 ADONIS 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 ADONIS 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 ADONIS as an iFrame

In ADONIS, 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 ADONIS as an iFrame:

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

2. Set the value of the parameter security.allowframedisplay to “true”. Save the changes afterwards.

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

Access ADONIS via a REST API

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

Via the REST API included in ADONIS 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 ADONIS consultant.