Accéder au contenu principal
Version : 16.0

Settings

The Settings page allows you to customise a wide range of library-specific features. You can provide a basic configuration for components such as release workflows, validation functions, and more. If a component has multiple configurations or templates, you can find and modify them here. The component settings are stored in the ADONIS database and can be migrated between different ADONIS versions to preserve your settings.

The Settings page shows all library-specific component settings in the database. Depending on the ADONIS configuration, different components can be available for configuration.

Manage Component Settings​

Component settings can be imported, exported, deleted, and more.

Adjust Configurations​

Some component settings offer multiple configurations, often serving as templates for charts or publications. For instance, you can add various corporate identity schemes for use in reports, or create multiple dependency modeller templates.

Other component settings feature only one configuration, typically labelled as General. In these instances, you can configure general settings for the component, such as adjusting thresholds for assessing the data actuality of objects, or configuring validation settings. While you can modify these configurations, creating or deleting them is not an option.

To adjust configurations:

  1. Go to the Settings page.

  2. In the catalogue on the left-hand side, find the component setting you wish to adjust, and then select the option you want:

    • To create a new configuration, right-click the component setting, and then click Create.

    • To edit a configuration, select it in the catalogue.

    • To delete a configuration, right-click the configuration, and then click Delete.

Import Component Settings​

Component settings previously exported can be imported and stored in the ADONIS database.

To import component settings:

  1. Go to Settings > More options, and then click Import settings.

  2. Click Browse and select the file you want to import. You can also drag a file from your computer to the Drag and drop files here to upload area.

  3. Select the component settings you want to import. Alternatively, you can select Import all settings at the top to import all component settings at once.

  4. Click Import. When prompted to continue, click Yes. The data is imported.

When the import is complete, a success message appears. Close the message to complete the process.

Remarque

Behaviour if a configuration (e.g. "General") already exists in the database:

  • If a configuration already exists in the target library, it is overwritten with the contents of the import file.

  • Configurations that do not already exist in the target library are added.

  • Configurations that exist in the target library, but not in the import file, are not changed.

Configurations for modules are an exception. The information from both sources is combined:

  • If a module exists both in the source library and the target library, it is overwritten with the contents of the import file.

  • Modules that exist in the target library, but not in the import file, are not changed.

Export Component Settings​

Component settings can be exported from the database and saved into an AXS file in the file system. This is useful to e.g. migrate chart templates which you have created to another ADONIS version.

To export system roles:

  1. Go to Settings > More options, and then click Export settings.

  2. Select the component settings you want to export. Alternatively, you can select Export all settings at the top to export all component settings at once.

  3. Click Export. The data is exported.

Bar​

Bar charts in ADONIS visually represent objects of a specific class as bars, with an attribute dictating the length of the bars.

Templates for bar charts need to be configured in ADONIS. The ADONIS Administration only provides limited settings for these templates.

Open and Edit Bar Chart Template

  • Go to Settings > Bar, and select the template you want.

  • For every language ADONIS supports, you can edit the name of the template as well as the description which characterises the template.

Box-in-Box​

Box-in-box charts in ADONIS visualise hierarchies and relations between objects. They resemble a family tree. In a box-in-box chart with e. g. three layers the top layer represents the grandparents. The second layer contains the children of the grandparents, who are siblings. The third layer contains the grandchildren. The grandchildren are siblings only if they share the same parent.

Templates for box-in-box charts need to be configured in ADONIS. The ADONIS Administration only provides limited settings for these templates.

Open and Edit Box-in-Box Chart Template

  • Go to Settings > Box-in-Box, and select the template you want.

  • For every language ADONIS supports, you can edit the name of the template as well as the description which characterises the template.

Bubble​

Bubble charts in ADONIS display objects of a specific class as bubbles on an area defined by two axes (x-axis and y-axis), with attributes dictating the position of the bubbles on the x-axis and y-axis, and optionally the bubble size.

Templates for bubble charts need to be configured in ADONIS. The ADONIS Administration only provides limited settings for these templates.

Open and Edit Bubble Chart Template

  • Go to Settings > Bubble, and select the template you want.

  • For every language ADONIS supports, you can edit the name of the template as well as the description which characterises the template.

ClamAV Virus Scanner​

By integrating the ClamAV virus scanner into ADONIS, files being uploaded to the ADONIS database (documents, media files, files attached to comments, etc.) or downloaded to your device may be checked for virus infections.

Remarque

For detailed instructions on how to integrate ClamAV into ADONIS, please refer to the chapter Enable Virus Scan for File Uploads in the Installation Manual.

Comments​

Comments allow ADONIS users to leave feedback and suggestions that can help improve models and objects. Users receive email notifications if they are responsible for an object or model and someone leaves a comment on it. As an ADONIS administrator, you can define which relations indicating responsibility should trigger email notifications.

Open Comments Settings

To open the settings for comments:

  • Go to Settings > Comments > General.

Notifications Configuration

The following settings are available:

  • Models

    Select which relations should be considered for sending email notifications when new comments are created on models.

  • Objects

    Select which relations should be considered for sending email notifications when new comments are created on objects.

Content​

In this area you manage configuration options for the following general settings:

Change History​

Changes to repository objects can be tracked in the change history. ADONIS users can access the change history through the Notebook of an object.

Open Change History Settings

To open the change history settings:

  • Go to Settings > Content > Change history.

Configure Change History

The following settings are available:

  • Activate change history

    Select or clear this option to turn the change history on or off. All other options in this area will be inactive unless you select this option.

  • Maximum entries in the change history

    Select the maximum number of entries in the change history.

  • Allow change history access

    Select or clear this option to enable or disable access to the change history in ADONIS. If this option is selected, you can specify which columns of the change history are shown.

  • Show all entries regardless of metamodel rights

    By default, the complete change history of a repository object is hidden if a user has no access to one or more object attributes due to metamodel rights. Select this option to always show the complete change history, regardless of metamodel rights restrictions.

Document Management​

Using the Document Management settings, you can configure an object type which allows ADONIS users to upload documents into the database in order to use them in models. By default, the imported files are maintained as objects of the type Document in the Object Catalogue.

When a repository is exported for backup and migration purposes, the documents are exported as well.

Open Document Management Settings

To open the Document Management settings:

  • Go to Settings > Content > Document management.

Configure Document Management

The following settings are available:

  • Activate Document Management

    Select or clear this option to turn uploading documents on or off. All other options in this area will be inactive unless you select this option.

  • Class for Document Management

    Select a class for the document management from the drop-down list.

  • Attribute for Document Management

    Select an attribute for the document management from the drop-down list.

  • Max file size (MB)

    Select the allowed maximum size for documents in the database (up to 50 MB).

  • Allowed file types (space-separated extensions)

    Select the allowed file types for documents in the database. Separate the file extensions with a blank.

    Allowed file types include: doc, docx, ppt, pptx, xls, xlsx, csv, txt, pdf, rtf, png, jpg, gif, jpeg, bmp, zip, rar, 7z, axr, xml, bpmn

    All other file types are blocked by default. To allow additional file types to be added to this list, you need to customize a configuration file.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Media Management​

Using the Media Management settings, you can configure how ADONIS users are allowed to upload images to the database in order to use them in models. The images are referenced in the attributes of certain objects (Notes and Cross-References) and displayed in place of these objects in the graphical editor.

When a repository is exported for backup or migration purposes, the images are exported as well.

Open Media Management Settings

To open the Media Management settings:

  • Go to Settings > Content > Media management.

Configure Media Management

The following settings are available:

  • Activate Media Management

    Select or clear this option to turn uploading images on or off. All other options in this area will be inactive unless you select this option.

  • Attribute for Media Management

    Select an attribute for the media management from the drop-down list.

  • Editable for repository objects

    This option only becomes relevant in specific customising scenarios. Enabling this option and adding the attribute for the media management to the Notebook of a repository class enables you to set a global value for the media management attribute across all model contexts.

  • Max file size (MB)

    Select the allowed maximum size for images in the database.

  • Allowed file types (space-separated extensions)

    Select the allowed file types for images in the database. Separate the file extensions with a blank.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Object Owners​

In ADONIS a user can be assigned ownership of a repository object (e.g. Applications, Processes etc.). In order to do so, the user has to be assigned as Responsible Person (object attribute in the Notebook chapter "Organisation").

Remarque

Alternatively, you can select a different relation to define ownership.

The object owner is responsible for the content of the object.

Open Object Owners Settings

To open the object owners settings:

  • Go to Settings > Content > Object owners.

Configure Object Owners

The following settings are available:

  • Set the user automatically as object responsible after creation of objects

    Select whether a user who creates an object is automatically assigned as its owner.

  • Relation class that should be used to define an ownership

    Select a relation class as default ownership relation from a drop-down list of all ownership relations in use in the current library. This relation is then used e.g. to create ownership between an object and a user when the user creates a new object and the first option is enabled.

    [OOO]

    When you select a relation class with the suffix [OOO], the object owner will get granted write access to the object. What type of access they had previously usually has no effect. Only metamodel rights take precedence over permissions set by an [OOO] relation.

    After the assignment, ADONIS Administrators can adjust the rights of object owners as they see fit. When the reference to the user is deleted, rights to the object are inherited as set in a superior hierarchy level (group).

  • Show responsible user in search results

    Select this option if you want a column with the object owner to be displayed by default when search results in ADONIS contain repository objects.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Corporate Identity​

The corporate identity scheme (CI scheme) of an organisation can be embedded in various publications in ADONIS (for example when printing models to PDF and creating reports).

Create one CI scheme or multiple schemes as needed. Enter your organisation's information, including the name and postal address, for each scheme. You can also upload a logo and a banner image as part of the configuration.

Add and Configure CI scheme

To create a CI scheme:

  1. Go to the Settings page.

  2. Right-click Corporate identity, and then click Create.

  3. In the Configuration name box, enter a name for your CI scheme, and then click OK.

Once created, you can start working on the CI scheme right away. The following settings are available:

  • Corporate identity settings

    The CI scheme's name, provided during creation, is displayed here. Adjust it as necessary.

  • Company details

    Enter the organisation's name, postal address, and other data in the respective fields.

  • Use as standard

    Choose whether this CI scheme will be set as the default when creating publications. This setting can be overridden by individual users of ADONIS according to their preferences.

  • Corporate logo

    Upload a logo that will appear in publications.

  • Banner image

    Upload a banner image that will appear near the top of the "Design & Document" start page.

  • Banner URL

    Specify a URL to which users will be redirected upon clicking the banner.

Sizing Images

Images should follow these guidelines:

TypeWidth & HeightFile SizeFormat
BannerRecommended 2000 x 1000 pixels (see below table for more information).Less than 5MBJPEG, PNG, BMP, GIF or SVG
LogoMinimum 260 x 260 pixels. Aspect ratio approximately 1:1 for best results.Less than 5MBJPEG, PNG, BMP or GIF

Banner images are cropped automatically due to varying screen sizes. This occurs mostly on wide screens, where the top and bottom are cropped. Therefore, keep the most important part of the image (e.g. logo and text) in the centre. The recommended, safe content area is approximately 2000 x 150 pixels.

Banner Image - Safe Content Area

Create Models/Objects​

Provide guidance to ADONIS users when they create new models and objects. You can define a set of model and object types that will be placed in the Recommendations pane of the New page.

Open Settings for the Recommendations Pane

To open the settings for the Recommendations pane:

  • Go to Settings > Create Models/Objects > General.

Recommended Model/Object Types

The following settings are available:

  • Add Elements

    Click Add to add new model and object types to display in the Recommendations pane. They will be added at the bottom of the list, in the order you selected them.

  • Change Order of Elements

    You can change the order in which recommended elements are visualised in the Recommendations pane. Use the drag handle () to drag an element to a new position. Or, to the right of the element, click More, and then click Move up or Move down.

  • Remove Element

    To the right of the element, click More, and then click Remove.

Remarque

If no recommended elements have been configured, the Recommendations pane is not shown.

Data Actuality​

Keeping your data up-to-date is crucial, and that's why we've made it easy for users to confirm the data actuality of objects in ADONIS.

You can customise the data actuality assessment by selecting the attribute on which it should be based. Additionally, you can set thresholds that will trigger a 'yellow' or 'red' flag if an object's data actuality has not been confirmed.

Open Data Actuality Settings

To open the data actuality settings:

  • Go to Settings > Data Actuality > General.

General settings

The following settings are available:

  • Attribute for Data Actuality

    Select the attribute on which the data actuality assessment should be based.

Global threshold

Here you can set global thresholds for assessment of data actuality. These settings apply to all object types if no class-specific values have been defined.

  • Number of days after which an object is marked 'yellow'

    Select after how many days an object is marked as 'yellow' if its actuality was not confirmed by the user responsible for this application.

  • Number of days after which object is marked 'red'

    Select after how many days an object is marked as 'red' if its actuality was not confirmed by the user responsible for this application.

Class-specific thresholds

Here you can override the global thresholds by setting individual thresholds on specific classes.

  • Select after how many days objects of a specific type are marked as 'yellow' or 'red' if their actuality was not confirmed.

Dependency Modeller​

The dependency modeller is a graphical means to discover and analyse dependencies between architectural objects across several architectural layers. For example, it can show which architecture objects have a direct or indirect influence on business-critical processes.

The objects and their references are visualised dynamically in a model with multiple swimlanes. Normally, ADONIS users create the structure of this model with the dependency modeller as they go. However, when using a template, the structure is created automatically.

A template defines an entire hierarchy of object types and dependency relations. The hierarchy is based on a start modelling class and several other classes connected with relation classes. For each modelling class a layer is built, which is represented as a swimlane in the dependency modeller. The layer can be hidden, i.e. made invisible in the dependency modeller. The configuration also stores the colour selected for each layer.

Add and Configure Template​

To create a dependency modeller template:

  1. Go to the Settings page.

  2. Right-click Dependency Modeller, and then click Create.

  3. In the Configuration name box, enter a name for your template, and then click OK.

Once you have created the dependency modeller template, you can start working on the configuration right away. Follow these three steps:

  1. Overview

  2. Layers

  3. Relations

These steps are discussed in more detail in the following sections.

Overview​

The first page of the dependency modeller template allows you to define a name and description while also providing a summary of the template.

  • Template Name

    The template's name, provided during creation, is displayed here. Adjust it as necessary.

  • Description

    Optionally, enter a description of the template in any language that ADONIS supports.

  • Summary

    Once you have selected layers and relations for the template, a summary will appear here. To view relations for a layer, on the right side of the layer, click More.

After you have completed these settings, select page 2 from the navigation menu at the top to advance to the next page of the template.

Layers​

The second page of the dependency modeller template allows you to choose a start layer and add additional layers that will be represented as swimlanes in the dependency modeller.

  • Start Layer

    First, you need to define the start layer. From the Choose start layer list, select the object type upon which the entire hierarchy of layers and relations should be based. When starting the dependency modeller in ADONIS, one or more objects of this type must be selected so that this template can be used.

  • Select Layers

    To create a hierarchical structure, you need to add additional layers to the template. Click + Add layer and select an object type.

Change Order

You can rearrange the order of the layers:

  • Drag the layer to a new position. Or, select a layer, and then click Move to the top, Move up, Move down or Move to the bottom.

Adjust Layers

Layers can be renamed, deleted, hidden, and more.

  • To rename a layer, on the right side of the layer, click More, and then click Rename.

  • To remove a layer, on the right side of the layer, click More, and then click Delete.

  • To hide a layer, to the right of the layer, click Hide . This button is a toggle. Click it again to show the layer again.

  • To change the background colour of a layer, on the right side of the layer, click Change background colour and choose a colour.

Remarque

The start layer cannot be deleted or hidden.

After you have completed these settings, select page 3 from the navigation menu at the top to advance to the final page of the template.

Relations​

The third page of the dependency modeller template allows you to add the relations that connect the layers in the template.

  • Relations Between Layers

    Define the dependency relations between layers. Choose a layer, click More, and then Add relations, and then select the target layer and a relation. For outgoing relations, you can also use the blue circles to the right of the layers: Click on the circle for the source layer, and then click on the circle for the target layer and select a relation.

Relation not processed

When you add a relation, you must select a layer that is already part of the processing flow. Suppose you have already created a template with two layers: A (= the start layer) and B. To connect the layers, select A and create a relation to B. Whether incoming or outgoing does not matter. Now, B will also be part of the processing flow and can be selected to create further relations. However, if you select B instead and create a relation to A, the relation will not be processed .

Additional Options

The following additional options are available:

  • To show the order in which the layers of the configuration are processed, click Show relation processing order. This button is a toggle. Click it again to hide the order again.

  • To view relations for a layer, on the right side of the layer, click More and then Relations overview.

    • In the Relations overview, all incoming and outgoing relations of a layer are listed.

    • Click Delete to remove a relation.

After you have completed these settings, click Save. The new template is now available in ADONIS.

Excel Import​

ADONIS provides a configurable Excel interface for quick data acquisition. Via the Excel interface, you can import repository objects with their attributes and relations from an Excel file (XLS or XLSX format). For this process, the structure of the Excel file is described in an XML configuration file.

Create Configuration​

An XML configuration file contains the mapping of objects from the Excel file to the ADONIS metamodel:

Example of an Excel File with Objects and Their Attributes

  • The Excel file can contain any number of sheets

  • Each sheet contains only objects of one type (1)

    Example - XML configuration file

    A configuration for a sheet could look like this:

    <sheet name="Applications" class_name="C_APPLICATION" id="2" data_row="4">

    <sheet name> is the name of the sheet in Excel. <class_name> is the language independent name of the object type. <id> is the number of the column which uniquely identifies an object. <data_row> is the first row containing an object.

  • Each row in the sheet contains one object (2)

  • Each column holds an attribute or a relation to another object (3)

    Example - XML configuration file

    A configuration for an attribute could look like this:

    <attribute name="A_DESCRIPTION" type="simple" context="en" column="5"/>

    <attribute name> is the language independent name of the attribute. <type> is the attribute type. <context> defines the language of the objects that are imported. <column> is the column number.

  • A unique identifier (name, ID etc.) is needed for each object

  • The following attribute types can be imported: simple, date, enum, treeenumlist, enum_list, bool, relation and file_pointer

If you are using the ADONIS BPMS Application Library, one or more sample configurations will already be provided for you in the ADONIS Administration. For every configuration, a suitable Excel file is included.

Remarque

The details of how to create an Excel import configuration are not covered here. If you want to create your own configurations, please refer to the "Excel Interface Manual" on the ADONIS installation medium in the folder "02 Application Server\BOC\ADONIS 16.0\books\english".

To successfully create a configuration, you need to head over to the Properties page. The language independent name of object types and attributes can be found there, and you need those for the configuration.

Import Configuration​

In order to use a specific configuration in ADONIS you have to import the XML configuration file first:

  1. Go to the Settings page.

  2. Right-click Excel import, and then click Create.

  3. In the Configuration name box, enter a name for your configuration, and then click OK.

  4. Click Import and upload the XML configuration file. The content of the configuration file will be displayed in the Setup box.

  5. Click Save.

The configuration is saved. You can now import objects from any Excel file that corresponds to the configuration in ADONIS.

Import Excel File Template​

For each configuration you can import a suitable Excel file as a template.

  1. Go to Settings > Excel Import.

  2. Select the configuration for which you want to import a template.

  3. Click Import Excel Template and upload the Excel file. The template's name will be displayed in the Template box.

  4. Click OK.

The configuration is saved. The template is now available for download in the Excel import dialogue in ADONIS. Users can download the template, capture objects in it, and then import the objects.

Gantt​

Gantt charts in ADONIS show objects of a specific class as bars on a timeline, with attributes dictating the start and end dates.

Templates for Gantt charts need to be configured in ADONIS. The ADONIS Administration only provides limited settings for these templates.

Open and Edit Gantt Chart Template

  • Go to Settings > Gantt, and select the template you want.

  • For every language ADONIS supports, you can edit the name of the template as well as the description which characterises the template.

HTML Publishing​

By default, the search page will be displayed as the start page of an HTML publication, including embedded corporate identity elements. You can configure a custom start page instead. To do so, upload a single HTML page.

The uploaded file must contain all images, scripts, style information etc. inline, or download it from a place in the web. To include images inline within the HTML page, they have to be embedded base64-encoded.

Open HTML Publishing Settings

To open the HTML publishing settings:

  • Go to Settings > HTML Publishing > General.

General

The following settings are available:

  • Disable custom start page

    Choose whether to show the uploaded file in HTML publications. This option is useful if you want to temporarily disable a custom start page.

  • Custom start page - file name

    Click Browse and upload the HTML page that you want to use.

  • Custom start page - file content

    The content of the uploaded HTML file is displayed here.

Integration - Configuration​

The Integration Framework is a generic ADONIS extension that can be used to create and configure adapters connecting to any kind of third party tool that exposes an HTTP interface which allows fetching of data.

In this area you manage general configuration options for the Integration Framework.

Remarque

A detailed description of this functionality is beyond the scope of this manual. If you have questions, please contact your ADONIS consultant.

Integration - Data Connectors: ADOIT​

ADONIS offers synchronisation of objects between ADONIS and ADOIT.

In typical scenarios, certain objects (such as   Application Components in ADOIT or   Processes and   Roles in ADONIS ) are only maintained in one of the two products. By synchronising these objects, they are made available in the respective other product:

  •   Application Components will be imported as   Applications in ADONIS

  •   Processes and   Roles will be imported as   Business Processes and   Business Actors in ADOIT

A REST API is used for the communication between the products.

Remarque

The availability of this feature depends on the licence.

Configuration

The configuration is carried out via the Integration Framework. If you are using a ADONIS 16.0, you can synchronise objects with the following ADOIT versions:

  • ADOIT 15.1.16 or higher | ADOIT 16.0.12 or higher | ADOIT 17 or higher

Instructions on how to set up the synchronisation are covered in the following sections here in the Administration Help.

Synchronisation

Synchronisation can be triggered manually in ADONIS (in the Connect Center). It is also possible to configure the synchronisation to run automatically on a scheduled basis.

Compatible Application Libraries​

The synchronisation of objects between compatible ADONIS and ADOIT is supported without further customising effort if the default libraries delivered with the product are used:

On the ADONIS side:

  • the ADONIS BPMS Application Library

On the ADOIT side:

  • the ArchiMate Application Library

Please contact your BOC consultant for further assistance if other application libraries are in use. This includes default libraries with changes in the metamodel, or other specific libraries.

Setting Up Synchronisation via the Integration Framework​

To synchronise objects between ADONIS and ADOIT via the Integration Framework, you have to define settings in BOTH products.

First, enable access to the REST API on the ADOIT side so that ADONIS can retrieve data from there:

Next, create a technical user on the ADONIS side:

Then you can configure the data connector that will be used to connect to ADOIT on the ADONIS side:

Synchronisation is now set up. Depending on the Application Library and the product configuration, you may need to configure additional settings:

Once you have completed the setup process, it's time to provide the right people access to the synchronisation features in ADONIS:

These steps are explained in the following sections.

Remarque

The procedure described here ONLY applies to importing EA elements from ADOIT into ADONIS. If you want to import BPM elements from ADONIS into ADOIT, set up the synchronisation as described in the ADOIT Administration Help.

Info

The Apache Tomcat web servers and the application servers of BOTH products have to be restarted if these settings are changed. Otherwise the changes will not become effective.

Activate Access to the REST API in ADOIT ​

First, you need to enable access to the REST API in ADOIT (as described in the ADOIT Help). Synchronisation via the Integration Framework requires you to configure one of the following authentication methods:

  • Basic Authentication

  • OAuth 2.0 Authentication using the Client Credentials Flow

  • Token Based Authentication

Remarque

The Integration Framework does not support OAuth 2.0 authentication using the Authorization Code Flow and JWT authentication.

The user in whose context requests should be executed does NOT need access rights to the component "Administration Toolkit".

You need to activate at least the following REST scenarios for the authentication method you have chosen:

  • Repository read APIs

  • Repository write APIs

  • Metamodel read APIs

Create Technical User ​

Configuring a data connector for the Integration Framework requires a technical user. If you set up a periodic synchronisation, it will be performed in the context of this technical user.

To create the technical user in the ADONIS Administration:

  1. Go to the Users page and click New User.

  2. Enter the following data:

    • Name: "Technical_ManagementOfficeIntegration" (and a password of your choice)

    • Trusted Login: Yes

    • User groups: This user belongs to the default group.

    • System roles: If release workflows are licensed, map the technical user to the “Administrator” roles (Document Release Workflow and Model Release Workflow).

    • Repository: Only (!) assign the repository to the user into which the EA elements from ADOIT should be imported.

Remarque

Trusted Login can only be enabled after the user has been created. Complete the user creation by clicking Create, then edit the user once more to enable Trusted Login.

Configure Data Connector for the Integration Framework in ADONIS ​

Now, you need to configure the data connector that will be used to connect to ADOIT in ADONIS (in the Connect Center).

Prerequisites

Before you proceed, you need to assign three modules to your user in the ADONIS Administration. These modules are required to access and modify the data connector configuration:

  1. Go to Settings > System settings > Modules.

  2. Assign the following modules to one of your system roles:

    • Connector for ADONIS and ADOIT

    • Module: Connect Admin

Configure Data Connector

To configure the data connector in ADONIS:

  1. On the toolbar at the top of the screen, click Setup   .

  2. In the left pane, under Connectors, select the configuration " ADOIT", and then click Open configuration dialog .

  3. Edit the settings on the General Configuration, Technical Settings, Data Synchronization and Constants tabs.

  4. Click OK when you have completed the settings.

General Configuration​

Edit the following settings on this tab:

  • Name: The name of the configuration. Usually, the default value does not need to be changed.

  • ID: The unique identifier of the configuration. Usually, the default value does not need to be changed.

  • Description: (Optional) A description of the configuration.

  • Enabled: Select this check box to enable the data connector.

  • Connector type: Must be set to BOC Group.

Technical Settings​

Edit the following settings on this tab:

  • URL: Enter the URL where ADOIT is available.
Example

You are configuring ADONIS. ADOIT 16.0 is the other product. You are running the ADOIT web application on a machine with the IP 10.2.100.62. The URL should look like this:

"http://10.2.100.68:8000/ADOIT16_0"

  • Authentication Type: Select the authentication method you have configured in ADOIT for access to the REST API:

    • Basic: For basic authentication. In addition, the following parameters need to be adjusted:

      • Username: Enter the name of the user in whose context REST API requests should be sent in ADOIT.

      • Password (encrypted): Enter the password of the user in whose context REST API requests should be sent in ADOIT. The password must be encrypted with an encryption tool which can be found in the directory "03 Web Application\02 Tools\02 Password Encryption Tool" in the installation package.

    • ADO: For token based authentication. In addition, the following parameters need to be adjusted:

      • Key: Enter the Key (for authentication by target system) that you defined in the ADOIT Administration on the Tokens tab, e.g. “boc.rest.key.mfb.ManagementOfficeIntegration”.

      • Secret: Enter the Secret (for authentication by target system) that you defined in the ADOIT Administration on the Tokens tab. Copy the 512 characters long key directly from the ADOIT Administration. Both values must match exactly.

    • OAuth 2.0: For OAuth 2.0 authentication. In addition, the following parameters need to be adjusted:

      • Grant Type: Must be set to Client Credentials.

      • Client ID: Enter the ID of the client system that you specified in the ADOIT Administration in the Client Data form.

      • Client Secret (encrypted): Enter the Secret to use for client authentication that you specified in the ADOIT Administration in the Client Data form. The password must be encrypted with an encryption tool which can be found in the directory "03 Web Application\02 Tools\02 Password Encryption Tool" in the installation package.

      • Client Authentication: Must be set to Send client Credentials as Basic Authentication header.

      • Token URL: Enter the Redirect URI that you specified in the ADOIT Administration in the Client Data form.

      • Scope: Enter the name of the Scope that you specified in the ADOIT Administration on the OAuth 2.0 tab.

  • Technical User: Add the technical user you created, i.e. “Technical_ManagementOfficeIntegration” (see Create Technical User). If you enable periodic synchronisation, it will be performed in the context of this user.

  • Periodic synchronisation: (Optional) Here you can set up periodic synchronisation of objects between ADONIS and ADOIT via the Integration Framework. During periodic synchronisation, EA elements are imported from ADOIT into ADONIS. Adapt the following parameters:

    • Synchronise periodically: Select this check box to activate periodic synchronisation.

    • Daily/CRON Expression: If periodic synchronisation is enabled, you can define the point in time at which the objects are synchronised here. You can choose when to do this in one of two ways:

      • Daily: In the Synchronisation Time box, define the point in time at which the objects are synchronised daily.

      • CRON Expression: Use a CRON expression to specify how often objects should be synchronised.

Data Synchronisation​

Edit the following settings on this tab:

  • lang: Specification of the language in which the data is transmitted, e.g. "de" for German and "en" for English. Available languages depend on the on the Application Library and the licence.
Remarque

Objects can only be transmitted in one language.

Constants​

Edit the following settings on this tab:

  • adoitRepositoryID: The ID of the repository in ADOIT that holds the objects that should be imported into ADONIS.

  • importFolderPath: The name of the object group in ADONIS that contains the imported objects. This group will be created automatically if it does not already exist.

  • obsoleteFolderID: The ID of the object group in ADONIS that contains objects that could not be deleted.

Deletion Handling

In general, imported objects are deleted during synchronisation if they have been removed from ADOIT in the meantime.

However, if relations have been added to the imported objects in ADONIS, or they are being used in models in ADONIS, they are not deleted. They will be moved to the "Obsolete objects" folder instead. An exception to this rule is the relation Responsible person. Although a relation of this type was added in ADONIS, imported objects will be deleted anyway.

  • pageSize: The number of objects that are imported from ADOIT at once.
Remarque

This parameter may be used to avoid performance and out-of-memory problems. For example, set the value to "100" so that 3,000 objects are transferred in 30 blocks of 100 objects each.

Import System Role and Assign Users ​

Are you using the default libraries delivered with the product? Then import the Management Office Integration system role in the ADONIS Administration now and assign all users to it, excluding technical users and those designated to perform the synchronisation. This will prevent your users from changing imported objects which should be maintained in ADOIT.

Import System Role​

To import the Management Office Integration system role in the ADONIS Administration:

  1. Go to System Roles > More options, and then click Import system roles.

  2. Click Browse and select the system roles file. The respective file <date> - <library name> - MOI Role.axr can be found in the folder “04 Sample Data/Roles“ in the installation package. You can also drag the file from your computer to the Drag and drop files here to upload area. Then, click Next.

  3. Select the system role Management Office Integration. Then, click Next.

  4. Make sure that the option Including metamodel rights is activated. Do not change the other settings. Then, click Import. The system role is imported.

When the import is complete, a success message appears. Close the message to complete the process.

Assign Users to System Role​

To assign users to the Management Office Integration system role in the ADONIS Administration:

  1. Go to the System Roles page.

  2. In the System roles catalogue on the left side, select the Management Office Integration system role.

  3. Click Add members and add user groups or individual users from the user catalogue. Then, click Add.

  4. Click Save.

The users are assigned.

Attention

Do NOT assign the following users to the system role Management Office Integration:

  • Technical users or their user groups (= default group)

  • Users tasked with performing the synchronisation or their user groups

Effects of the System Role​

The Management Office Integration system role has the following effects:

  • users are not allowed to create Applications, and only have read access to their attributes

Set up Access to the Synchronisation of Objects for Users ​

By assigning two modules in the ADONIS Administration, you can provide the right people access to the synchronisation features in ADONIS:

  1. Go to Settings > System settings > Modules.

  2. Assign the following module to system roles you want to allow access to:

    • Connector for ADONIS and ADOIT

Done! All users with the relevant system roles can now import objects from ADOIT in ADONIS.

Attention

Users with access to these web modules are tasked with performing the synchronisation and must NOT be assigned the restrictive system role "Management Office Integration" (see Import System Role and Assign Users), as otherwise they will not be able to perform the synchronisation correctly.

Matrix​

Matrix charts in ADONIS display connections (matrix cells) between objects of the x-axis and objects of the y-axis. A connection can be

  • a relation between x-axis object and y-axis object or

  • an object which is connected with the x-axis and y-axis objects by relations.

Templates for Matrix charts need to be configured in ADONIS. The ADONIS Administration only provides limited settings for these templates.

Open and Edit Matrix Chart Template

  • Go to Settings > Matrix, and select the template you want.

  • For every language ADONIS supports, you can edit the name of the template as well as the description which characterises the template.

Model Release Workflow​

ADONIS provides a model release workflow management system which allows to formalise model release and versioning. During the release process contributors carry out different tasks depending on their system roles.

Remarque

The availability of the model release workflow depends on the licence.

Set up Access to Model Release Workflow​

You can use the default configuration of the model release workflow or a user-defined configuration.

Default Configuration​

To use the default configuration, add users to the following system roles depending on their task in the release process. These are sub roles of the system role "Model Release Workflow":

  • Modellers create and submit models to review. They can also create new versions of models which have already been released in order to adapt them.

  • Reviewers perform methodical reviews [system role reviewer (methodical)] and business reviews [system role reviewer (business)] of the submitted models.

  • Administrators can execute all transitions. They are responsible for the maintenance of the release process. Only Administrators can manually archive models (when a new version of a model is released, the previous version is archived automatically).

Afterwards the model release workflow is ready for use.

User-Defined Configuration​

To use a user-defined configuration, the following steps are necessary:

  1. Configure the model release workflow. Add new system roles (e.g. A, B, C, …) on the Configure Roles page.

  2. Add users to the appropriate system roles depending on their task in the release process.

Afterwards the model release workflow is ready for use.

Remarque

Please refer to the section Manage System Role Members for details on how to assign system roles to users.

Configure Model Release Workflow​

To configure the model release workflow:

  • Go to Settings > Model Release Workflow > General.

The model release workflow configuration wizard has 5 pages:

  1. Configure Mapping

  2. Configure States

  3. Configure Roles

  4. Configure Rights

  5. Configure Transitions

These pages are discussed in more detail in the following sections.

Configure Mapping​

The first page of the model release workflow configuration wizard allows you to select model types, model references and attributes.

Attention

Do not use metamodel rights to restrict access to attributes configured here, as these attributes are required for the model release workflow to work.

You can view and edit the following data:

Main Configuration

  • In the Configuration name area, edit the language-specific names of the model release workflow for all languages ADONIS supports. These names are visible on the user interface, e.g. in the state filter.

Model Type Selection

  • Select the model types that should be available for use in the model release workflow.
Remarque

When you configure a specific transition, you can specify for which model types that transition is enabled. However, you can only select from the model types made available here.

Version Configuration

  • Define the minor version format and the major version format which is assigned to models during versioning.

Prolongation Configuration

  • To turn the prolongation functionality on or off, select or clear the Active check box.

  • In the Daily validity check at (hh) box, type or select the hour of the day (in 24-hour time format) when the validity of all versioned models is automatically checked on the ADONIS application server. The default setting is each night at 1:00 AM local time.

Version History Functionality

  • To turn the Version history functionality on or off, select or clear the Active check box.

  • Select the Maximum entries in the version history. When this sum is reached, the oldest entries are removed from the table.

Process Responsible Functionality

  • To turn the Process responsible functionality on or off, select or clear the Active check box.

  • Select the Process owner, the Process manager, the Methodical reviewer and the Process analyst/designer attributes. These attributes represent the stakeholders who are responsible for a process.

  • The attributes Additional responsible 1, 2 and 3 allow you to define up to three additional attributes representing process representatives.

Remarque

If process responsible functionality is activated, you can define various conditions, checks and actions which are otherwise not available. You may e.g. specify that only models with a Process owner defined in their Notebooks can transition to a new state.

After you have completed these settings, select page 2 from the navigation menu at the top to advance to the next page of the model release workflow configuration wizard.

Configure States​

The second page of the model release workflow configuration wizard shows all states in the workflow, along with their details. You can edit and create new states.

The following options are available:

  • Edit State

    To the right of the state, click More, and then click Edit. Now you can configure the state.

  • Delete State

    To the right of the state, click More, and then click Delete.

  • Add State

    Click Add new state. Now you can configure the state.

  • Change Order of States

    Use the icon with three horizontal lines to the left of a state to drag it to a new position.

Remarque

You can edit some status details inline directly on the Configure States page, namely Type, Icon, and Colour.

Edit or Add Transition State​

When you add or edit a state on the Configure States page, a form will appear. You can view and edit the following data:

Language Independent Name

  • A language-independent name that uniquely identifies the state is applied automatically based on the enumeration values of the State attribute.

Language-Specific Names

  • Edit the language-specific names for all languages ADONIS supports. These names are visible on the user interface.

Icon

  • Edit the state icon directly in the text box. If ADONIS is installed, you can find a full list of icons by adding /fonts/awesome/icon-index.html to the URL of ADONIS, e.g. http://localhost:8000/ADONIS16_0/fonts/awesome/icon-index.html. The keyword "axw-fa " (space after axw-fa) has to be added as a prefix to the icon name.

Colour

  • Edit the colour of the state icon and the colour of the state in pie charts. Click the colour circle and choose a colour, or enter a specific Hex colour value manually.

Type

  • Select the predefined state type that corresponds to this state. State types include logic for the interplay with the process release workflow, validation checks etc. Each state type bundles certain release workflow behaviours.

    • "Draft": Select if the state represents draft versions of models. In models with a state of the state type "Draft" it is ensured that the contained versioned objects are automatically present in the latest released version or draft version. Contained objects are updated when there is a new draft version or when there is a new released version.

      Example

      When you create a new draft version of a Process, the new object replaces the original object in all Process Landscapes that are in the state "Draft".

    • "Review": Select if the state represents models that are currently being reviewed. In models with a state of the state type "Review" it is ensured that the contained versioned objects are automatically present in the latest released version.

    • "Released": Select if the state represents released models (released, valid etc.). In models with a state of the state type "Released" it is ensured that the contained versioned objects are automatically present in the latest released version.

    • "Archived": Select if the state applies to archived models. The state of the contained versioned objects does not change in models with a state of the state type "Archived". Archived objects remain archived and are not replaced by new released versions.

State as Model Group

  • Select Represent state as model group to have models cycle through folders with the name of the current state during versioning. All other options in this area are inactive unless you select this check box.

  • From the Use model group of the referenced state list, you can reference another state. Models in the current state will now appear in the model group of the referenced state.

  • Click Custom group name to specify a custom name for the model group. Enter a language-specific name for every language ADONIS supports.

Example "Represent state as model group"

Models in the states "Under methodical review" and "Under business review" should appear in the same custom model group ("Under review"). To do this, follow these steps:

State "Under methodical review"

  • Activate the option Represent state as model group.

  • The Custom group name is "Under review".

    "Under business review"

  • Activate the option Represent state as model group.

  • From the Use model group of the referenced state list, select the state "Under methodical review".

After you have completed these settings, select page 3 from the navigation menu at the top to advance to the next page of the model release workflow configuration wizard.

Configure Roles​

The third page of the model release workflow configuration wizard shows all system roles specific to the release workflow (= RWF roles or release workflow roles). You can edit and create new roles.

Remarque

Add the users to the appropriate system roles depending on their tasks in the release process.

The following options are available:

  • Edit Role

    To the right of the role, click More, and then click Edit. Now you can configure the role.

  • Delete Role

    To the right of the role, click More, and then click Delete.

  • Add Role

    Click Add new role. Now you can configure the role.

  • Allowed to Create New Models

    Select Allowed to create new models so that users with a specific role can create models of those model types for which the model release workflow is enabled. Note that this setting only applies to model types that are part of the release workflow and has no effect on other model types.

Edit or Add Role​

When you add or edit a role on the Configure Roles page, a form will appear. You can view and edit the following data:

Language Independent Name

  • Enter a language-independent name that uniquely identifies the system role.

Language-Specific Names

  • Edit the language-specific names for all languages ADONIS supports. These names are visible on the user interface

After you have completed these settings, select page 4 from the navigation menu at the top to advance to the next page of the model release workflow configuration wizard.

Configure Rights​

The fourth page of the model release workflow configuration wizard allows you to set access rights to models in the model release workflow depending on system role and state.

Access Rights for Models

  • Select access rights to models in each state from the corresponding drop-down lists.

You can define access rights for every release workflow role and for users without a release workflow role ("All others").

Remarque

Users without a release workflow role should not have write access to release workflow models, because they can use it to override the mechanisms of the release workflow.

The following types of access are available:

  • Read

    The user can access this element but is not allowed to make changes.

  • Write

    The user may use, modify, save, and delete the element as they want.

  • Read Models with Translation Option

    The user may not modify the model in structure and size, but they may translate existing attribute values into other content languages.

  • No Access

    This element is not available for the user (it is invisible for them in the various lists and catalogues).

  • Default Rights (Inherited)

    Permissions for models as set at the level of user groups or directly at the user level apply. See Rights for details.

After you have completed these settings, select page 5 from the navigation menu at the top to advance to the next page of the model release workflow configuration wizard.

Configure Transitions​

The fifth page of the model release workflow configuration wizard lists all transitions in the workflow. For every transition, the source state of the model before the transition and the target state of the model after the transition is shown. You can edit and create new transitions.

The following options are available:

  • Edit Transition

    To the right of the transition, click More, and then click Edit. Now you can configure the transition.

  • Delete Transition

    To the right of the transition, click More, and then click Delete.

  • Add Transition

    Click Add new transition. Now you can configure the transition.

  • Change Order of Transitions

    Use the icon with three horizontal lines to the left of a transition to drag it to a new position.

Edit or Add Transition​

When you edit an existing transition or add a new transition, a dialogue window containing the following tabs opens:

These tabs are discussed in more detail in the following sections.

General Settings​

The General Settings tab contains the following settings:

  • Edit the language independent name and the language-specific names of the transition directly in the respective text fields.

  • Select whether ADONIS should create a menu item for the transition on the user interface.

  • When you execute a transition in ADONIS, the state icon of the target state is displayed in menus and in the "Control & Release" dashboard. To replace the state icon with another icon, edit the Icon (overrides the target state icon) directly in the respective text field. If ADONIS is installed, you can find a full list of icons by adding /fonts/awesome/icon-index.html to the URL of ADONIS, e.g. http://localhost:8000/ADONIS16_0/fonts/awesome/icon-index.html. The keyword "axw-fa " (space after axw-fa) has to be added as a prefix to the icon name.

Configure States

  • Configure the states of the transition:

    • Select source state and target state lets you select one or more source states and a target state.

    • Initial transition means that the status of a model which has no source state changes to the initial model release workflow status (e. g. "Draft") when this transition is carried out.

    • Transition is valid in each state means that this transition can be carried out regardless of the source state of the target model.

Remarque

When a transition is configured to be an initial transition, notifications are disabled.

Remarque

When a transition is configured to be valid in each state, all actions are disabled and reset except:

  • History settings

  • Show success message for transition

System Transition

  • For certain scenarios it is necessary that transitions correspond to a certain type. Each system transition brings some logic with it. At the moment, ADONIS supports the following types of system transitions:

    • No entry: This setting is disabled. The transition is not a system transition.

    • Reminder: When the validity of the model should be rechecked, reminders are sent to the responsible user(s).

      Remarque

      When a transition is configured as a Reminder system transition, the Reminder tab will be enabled, allowing you to further configure the reminder details.

    • Accept: When the "Valid from" date has been reached, the state of the model changes to "Valid".

    • Invalidate: When the "Valid until" date has been reached, the state of the model changes to "Invalid".

    • Vote: Activate this setting if the transition represents a vote.

      Remarque

      When a transition is configured as a Vote system transition, the Voting tab will be enabled, allowing you to further configure the voting process.

    • Prolongate: Activate this setting if the transition represents a prolongation action (= extend validity period).

      Remarque

      When a transition is configured as a Prolongate system transition, you can define various actions which are otherwise not available.

The system transitions Reminder, Accept and Invalidate are executed automatically without user interaction. Each night at 1:00 AM local time the ADONIS application server checks whether models meet the specified conditions. If yes, the system transition is executed.

Conditions​

The Conditions tab contains the following settings:

RWF Roles Which Are Allowed to Execute this Transition

  • Define the system roles which are allowed to execute this transition.
Remarque

You can only select from the system roles configured for the release workflow on the Configure Roles page.

Model Type Selection

  • Define for which model types this transition is enabled.
Remarque

You can only select from the model types made available for the model release workflow in the Model Type Selection area on the Configure Mapping page.

Process Responsibles Who Are Allowed to Execute the Transition

  • In this area you can specify that only process responsibles can execute this transition. The user must also have the appropriate system role.
Remarque

You can combine multiple conditions. The transition can only be executed if all conditions are met (logical AND operator).

Checks​

The Checks tab contains the following settings:

  • Select the Do not execute any check action check box to skip all checks, or clear it so you can define various checks to be carried out before the transition is executed.

  • Select the Do not allow empty models check box to require the model to contain at least one object before the transition can be executed, or clear it to allow transitions with empty models.

Process Responsible

  • In this area you can specify that only models with a process responsible defined in their Notebooks can transition to the target state. You can further specify whether a process responsible has to be user based (a referenced User object), role based (a referenced Role object) or can be both.

  • If Warn if assigned roles are available for reader assignment is activated, ADONIS displays a warning when the transition is executed, and the following condition is fulfilled: A Role object that is used in the model release workflow as a process responsible is Available for reader assignment (object attribute in the Notebook chapter "General information"). The user cannot execute the transition.

Incoming References

  • If Do not allow incoming references is activated, a dialogue will appear when the transition is executed and the model contains incoming references. The transition cannot be executed by the user.

  • If Inform if incoming references exist is activated, a dialogue will appear when the transition is executed and the model contains incoming references. The transition can be executed regardless by the user or aborted.

Outgoing References

  • If Warn if subordinated models are not released is activated, a warning appears when the transition is executed, and the following condition is fulfilled: The model contains at least one Subprocess that references a Business Process Diagram which is not released. The transition can be executed regardless by the user or aborted.

  • Select Include referenced models so that referenced models will also transition to the target state. This is e.g. the case when a model is referenced in a Business Process Diagram as a subprocess.

    If this option is activated, you have to select a strategy for handling referenced models in case of conflict. Include all or none means that transition will only be executed if all referenced models have the correct state for the transition. Include with best effort means any referenced models that cannot be transitioned will be skipped and the transition will be allowed for the rest of the models. User decides lets the user decide between the following options: Do not include referenced models, Include all or none or Include with best effort.

  • If Do not allow if validity period is invalid is activated, the transition cannot be executed if the end of the validity period is in the past.

  • If Do not allow if there is no access to the target model group is activated, the transition can only be executed if the user has write access to the group where the model will appear after the transition.

  • If show success message for checks is activated, a message box will appear when all checks have been performed successfully.

Checks

  • In the Checks area, you can configure which checks are carried out when models are submitted to review. In addition, you can define the behaviour when the check shows that the models are not valid: either the transition may not be executed at all (Block transition), or merely a notification appears (Confirm transition).

Actions​

The Actions tab contains the following settings:

  • Select the Do not execute any execute action check box to skip all actions, or clear it so you can define various actions to be carried out after the transition is executed.

  • You can define whether the minor version or major version of the model are increased after the transition is executed.

History Settings

  • Specify whether the user needs to create a comment when they execute the transition. This comment is stored in the Version history of the model (attribute in the Notebook chapter "Lifecycle"):

    • No history entry means that no entry in the version history will be created.

    • Optional comment by user means that the transition will be executed regardless of whether the user enters a comment or not.

    • Mandatory comment by user means that transition will only be executed if the user enters a comment.

    • Create history entry automatically means that a comment is created and stored automatically in the version history of the model. Define the content of the history entry via a support dialogue by clicking the History settings... button.

Remarque

The history settings only have an impact when the Version history functionality has been turned on and configured on the Configure Mapping page. Otherwise, comments cannot be stored in the Version history of the model.

Assign Process Responsible

  • To automatically assign the user who executes this transition as a process responsible, select the Assign current user as process responsible check box, and then select the appropriate attribute.

    Example

    When the default configuration of the model release workflow is in use, the current user is automatically assigned as the “Process analyst/designer” when they create a process (Initial Transition).

Remarque

The setting Assign Process Responsible is only available when a transition is configured as an initial transition on the General Settings tab.

Select Referenced Transitions (e.g. for Archiving Models in the Background)

  • Select referenced transitions for the model or its predecessor model. This is useful to e.g. archive the predecessor version of the model in the background.

New Version

  • Select whether a new version of the model is created. This copy of the original model can e.g. be adapted and released later with an increased version number.

Validity Dates and Prolongation

  • Select the Set validity dates check box to set the validity period when the transition is executed:

    • The model is valid immediately ("Valid from" date).

    • Select the Override existing validity start date with current date check box to explicitly set a released model valid when this transition is executed. This allows your users to change the state of a model that is otherwise stuck in the "Released" state waiting for a scheduled "Valid from" date to arrive. By default, this option is only activated for the special transition Set valid.

    • Select the Set validity date to the end of the month check box to specify that the validity period always ends on the last day of a month.

    • By default, a model remains valid for 12 months after release ("Valid until" date). You can adapt this setting in the Duration of validity period (months) box.

    • The "Resubmission date" (model attribute in the Notebook chapter Lifecycle) indicates to the responsible user(s) when the validity of the model should be rechecked. In the Resubmission date (months before validity end date) box, select how many months before the end of the validity period this date is reached.

    The validity period does not affect the model release workflow as long as the prolongation scenario is not active. For example, no automatic reminders are sent before a model becomes invalid etc.

  • Select the Prolongate check box to prolongate the validity when the transition is executed:

    • The validity period is increased by 12 months by default ("Valid until" date). You can adapt this setting in the Duration of validity period (months) box.
Remarque

The last two options in this area, Prolongate and Duration of validity period (months), are only available when a transition has been configured as a Prolongate system transition on the General Settings tab.

  • Select whether incoming references from the predecessor model are transferred to the new version of the model.

  • Select whether to break outgoing relations of the target model. This function is important e.g. when archiving models. Taking the perspective of another model you can ensure that it will contain no incoming references from an archived model.

  • If Reset validation ToDos is activated, all ToDos are reverted to incomplete when the transition is executed.

  • If show success message for transition is activated, a message box will appear when all actions have been performed successfully.

Notifications​

Remarque

The Notifications tab is NOT available when a transition is configured as an initial transition on the General Settings tab.

The Notifications tab contains the following settings:

Send Tasks

  • Define whether ADONIS automatically sends out tasks after the transition. Tasks can be sent to notify the process responsibles and RWF roles which are responsible for executing the next transition in the release process.

Send Emails

  • Define whether ADONIS automatically sends out emails after the transition (To, CC or BCC). Select one or more of the following options:

    • Send emails to notify the process responsibles.

      Remarque

      Process responsibles may be user based (a referenced User object) or role based (a referenced Role object). If the responsibility is defined via a Role, emails are sent to all users with that Role.

    • Send emails to notify the RWF roles which are responsible for executing the next transition in the release process.

    • Define that emails are sent ad hoc and thus allow the user in ADONIS to select the recipients themselves.

    • Send emails to a predefined user list which you can prepare via a support dialogue by clicking the Add button.

    • Send emails to specific recipients. Enter the email addresses of the recipients in the Send to, Include as CC and Include as BCC boxes. Separate multiple entries with a semicolon.

Remarque

For detailed information about how recipients influence the email notifications, see Impact of Recipients on Email Notifications for Release Workflows.

Send Emails Configuration

  • You can define the content of the email via a support dialogue by clicking the Email text... and Email subject... buttons. Otherwise a preconfigured email is sent.

  • Use plain text or HTML code with inline CSS.

  • You can use the following placeholders that will be replaced by actual data when the email is sent out:

    • %VERSIONHISTORY%: The attribute Version history.

    • %MODELNAME%: The name of the model.

    • %STATE%: The state of the model.

    • %URL%: The URL for opening the model.

    • %SENDER%: The name of the user who executed the transition.

    • %NAME%: The first name of the email recipient.

    • %LASTNAME%: The last name of the email recipient.

    • %VALID_FROM%: The attribute Valid from.

    • %VALID_UNTIL%: The attribute Valid until.

    • %RESUBMISSION_DATE%: The attribute Resubmission date.

Remarque

Before it is possible to send email notifications, the Email settings and the Base URL have to be configured correctly.

Remarque

Tasks and emails can only be sent to process responsibles automatically if the process responsible functionality has been activated on the Configure Mapping page.

Remarque

ADONIS will not send out tasks or emails to members of the system role Administrator. This is to avoid spamming these users. Administrators do not have a predefined area of responsibility in the release process. They are responsible for the maintenance of the release process.

Reminder​

Remarque

The Reminder tab is ONLY available when a transition has been configured as a Reminder system transition on the General Settings tab.

The Reminder tab contains the following settings:

  • Select the Send Reminder check box to send a reminder to the responsible user(s) when the validity of the model should be rechecked:

    • In the Reference date box, select whether the reminder shall be sent "On Resubmission", before the "Valid until" date, after the "Valid until" date or after the "State change".

    • In the Months/Days area, choose how many Months or Days before/after the Reference date the reminder is sent. For example, if "After State change" is selected as the Reference date and 7 days as the interval, the reminder will be sent 7 days after the model has changed state. This option is not available when the reminder is sent "On Resubmission".

    • From the Interval list, select the interval in which reminders are sent.

    • In the Occurrence box, choose how many reminders are sent.

Voting​

Remarque

The Voting tab is ONLY available when a transition has been configured as a Vote system transition on the General Settings tab.

The Voting tab contains the following settings:

  • Select the Active check box to initiate a voting process on the model before the transition is executed. All other options in the Voting area are inactive unless you select this check box.

  • From the Responsible which represents voters list, select who the responsible persons are that may vote. All Users or Roles which are referenced in the Notebook of the model in the selected relation can cast their votes.

    Info

    Only one role owner can vote per Role.

  • Click the Define voting question button to define which text is displayed when voters are asked to vote on a model. Enter a text for every language ADONIS supports. Otherwise ADONIS displays a preconfigured text.

  • To specify that users need to create a comment when they vote with Yes or No, select the Active mandatory comment if user voted with check box, and then select the appropriate check boxes. This comment is stored in the version history of the model (attribute in the Notebook chapter "Lifecycle").

  • In the Define follow up transitions area, select the transitions after the vote.

    • From the Transition in case of negative voting result list, select the transition if the vote fails.

    • From the Transition in case of positive voting result list, select the transition if the vote succeeds.

    • For both of these options, select the Start automatically check box so that the follow up transition is automatically executed after the vote.

      Remarque

      If you deactivate Start automatically, the follow up transition has to be executed manually. In this case, both follow up transitions (...negative voting result and ...positive voting result) will be available.

  • In the Transition available while voting is in progress area, select which transitions may be executed to abort the voting process. These transitions must have the same source state as the voting transition.

  • In the Voting strategy area, you can define when the voting process ends:

    • All votes are received means that all voters need to vote.

    • Threshold is reached means that a minimum percentage of positive votes must be received. The vote also ends when too many voters have voted negative and the vote can no longer be successful. You can specify the minimum percentage in the Threshold (minimum percentage of positive votes) (%) box below.

  • In the Threshold (minimum percentage of positive votes) (%) box, specify the minimum percentage of positive votes needed to make the vote successful. If the option Threshold is reached is selected, the vote will end as soon as the threshold is passed.

Configure Voting​

Voting processes may be used in sophisticated release workflow scenarios. Typically, a group of people decide whether a model will be released. When the default configuration of the model release workflow is in use, this feature is disabled.

In ADONIS, a voting process is represented by a transition. After the vote ends, different follow up transitions may be executed depending on whether the voting result was positive or negative (e.g. Reject or Release). You can configure multiple voting processes within the model release workflow.

Info

Only one voting process may be configured per target state.

Configuration Variants

Depending on the release workflow configuration in use, different steps are necessary to configure voting. The following variants are possible:

Activate Voting for Release​

Are you using the default configuration of the model release workflow? In this case, you can activate a preconfigured voting process on models before they are released. In order to do so:

  1. Open the Configure Transitions page.

  2. Open the transition Vote for release for editing.

  3. Switch to the Actions tab.

  4. In the Voting area, select the Active check box, and then click Save.

  5. Click Save.

The voting process is activated and ready for use. All Users or Roles which are referenced in the Notebook of the model as Process managers can cast their votes.

Info

Only one role owner can vote per Role.

Once all votes are received, voting ends. The Process owner can then execute the follow up transition manually (either Reject or Release based on the result).

Configure Voting for any Particular Transition​

The following steps are necessary to configure voting for any particular transition:

  1. Map model relation that will represent voters

  2. Create transition - general settings

  3. Create transition - conditions

  4. Create transition - actions

Map Relation that Will Represent Voters​

In order to map the relation that will represent voters:

  1. Open the Configure Mapping page.

  2. In the Process responsible functionality area, select the Active check box.

  3. Make sure that the relation which represents voters is defined here. You can either use the Process owner, Process manager or Process analyst/designer attribute or define an additional attribute.

Create Transition — General Settings​

In order to create a transition representing the voting process and to configure general settings:

  1. Open the Configure Transitions page.

  2. Click the Add new transition button.

  3. In the Language independent name box, type a name for the transition. This language-independent name uniquely identifies the transition.

  4. In the language specific text boxes, type a name for every language ADONIS supports. These names are visible on the user interface.

  5. Select the Create menu item check box.

  6. In the Configure states area, change both the source state and the target state to the state in which the voting process is started.

    Example

    You want to configure a voting process on released models before they are archived. Change the source state and target state to Released.

  7. In the System transition area, select Vote from the list.

Create Transition — Conditions​

In order to configure conditions for the voting process:

  1. Switch to the Conditions tab.

  2. In the RWF roles which are allowed to execute this transition area, define the system roles which are allowed to execute this transition. Voters must have at least one of these system roles.

  3. In the Model type selection area, define for which model types this transition is enabled.

  4. In the Process responsibles who are allowed to execute the transition area, select the Active check box, and then select the relation which represents voters.

Create Transition — Actions​

In order to configure actions for the voting process:

  1. Switch to the Actions tab.

  2. In the Voting area, select the Active check box.

  3. From the Responsible which represents voters list, select the relation which represents voters. All Users or Roles which are referenced in the Notebook of the model in the selected relation can cast their votes.

    Info

    Only one role owner can vote per Role.

  4. From the Transition in case of negative voting result list, select which transition may be executed if the vote fails.

    Example

    You want to configure a voting process on released models before they are archived. Change the Transition in case of negative voting result to No transition selected (= model remains in the state Released).

  5. From the Transition in case of positive voting result list, select which transition may be executed if the vote succeeds, and then click OK

    Example

    You want to configure a voting process on released models before they are archived. Change the Transition in case of positive voting result to Archive.

  6. Click Save, and then click Save.

The voting process is activated and ready for use.

Remarque

Other settings are optional (you can use the default configuration). For example, you may specify that the follow up transition is started automatically when the vote ends etc.

Configure Assignment of Specific Methodical Reviewers​

By default, all users with the system role "Reviewer (methodical)" may perform methodical reviews on all models. The Methodical Reviewer attribute enables a better reviewer responsibility assignment. It allows assigning specific methodical reviewers to models if the model release workflow configuration is adapted accordingly.

The following steps are necessary to configure assignment of specific methodical reviewers:

  1. Adapt Transition "Submit to Methodical Review"

  2. Adapt Transition "Submit to Business Review"

  3. Final steps

Remarque

The procedure described here is only valid if the default configuration of the model release workflow is in use. If you are using another configuration, the required steps depend on the design of the release workflow transitions.

Adapt Transition "Submit to Methodical Review"​

In order to adapt the transition "Submit to methodical review":

  1. Open the Configure Transitions page.

  2. Open the transition Submit to methodical review for editing.

  3. Switch to the Checks tab.

  4. In the Process responsible area, select the Methodical reviewer check box , and then click Both.

  5. Switch to the Notifications tab.

  6. In the Send tasks area, do the following:

    • Select the Send tasks to process responsible check box, and then select the Methodical reviewer check box.

    • Clear the Send tasks to RWF roles check box.

  7. In the Send emails area, do the following:

    • Select the Send emails to process responsible check box, and then select the Methodical reviewer check box.

    • Clear the Send emails to RWF roles check box.

  8. Click Save.

Adapt Transition "Submit to Business Review"​

In order to adapt the transition "Submit to business review":

  1. Still on the Configure Transitions page, open the transition Submit to business review for editing.

  2. Switch to the Conditions tab.

  3. In the Process responsibles who are allowed to execute the transition area, select the Active check box , and then select the Methodical reviewer check box.

  4. Click Save, and then click Save.

Final Steps​

Perform the following final steps:

  • Restart the ADONIS application server.

The assignment of specific methodical reviewers is activated and ready for use.

Configure Prolongation​

When the prolongation mechanism is in use, a modeller can set a date from which a model will be valid after it is released. By default a model is valid for one year after it is released. Before the model becomes invalid, a reminder is sent to the responsible user(s). The reviewer can then prolongate the model. If the reviewer requests changes, the modeller may create a new draft version in order to adapt the model. Alternatively, the model may be archived.

Remarque

When the prolongation mechanism is activated, each night at 1:00 AM local time validity of all versioned models is automatically checked on the ADONIS application server. This validity check has two effects:

  • When the "Valid from" date has been reached, the state of versioned models changes to "Valid".

  • When the "Valid until" date has been reached, the state of versioned models changes to "Invalid".

Configuration Variants

Depending on the release workflow configuration in use, different steps are necessary to use the prolongation mechanism. The following variants are possible:

Default Configuration of the Model Release Workflow​

In order to use the prolongation mechanism when the default configuration of the model release workflow is in use:

  1. Import the extended release workflow configuration that includes the prolongation mechanism configuration (Import component settings). The respective file ADONIS 16.0 - RWF Standard config (incl. prolongation mechanism).axs can be found in the folder “04 Sample Data\Component Settings“ in the installation package. Overwrite the existing configuration with the content of the import file.

  2. Restart the ADONIS application server.

The prolongation mechanism is activated and ready for use.

Adapted Default Configuration of the Model Release Workflow​

Are you using a default configuration which has been adapted (additional states or system roles etc.)? The following steps are necessary in order to use the prolongation mechanism:

  1. Activate prolongation mechanism

  2. Adapt source states of existing transitions

  3. Adapt transition "Release"

  4. Adapt transition "Set valid"

  5. Final steps

Activate Prolongation Mechanism​

In order to activate the prolongation mechanism:

  1. Open the Configure Mapping page.

  2. In the Prolongation Configuration area, select the Active check box.

The other settings in this area are optional (you can use the default configuration).

Adapt Source States of Existing Transitions​

In order to adapt the source states of the existing transitions:

  1. Open the Configure Transitions page, and then open the transition New draft version for editing.

  2. In the General settings tab, remove the source state Released, and then click Save.

  3. Repeat steps 1 - 2 for the transitions Archive and Archive model (system).

Adapt Transition "Release"​

In order to adapt the transition "Release":

  1. Still on the Configure Transitions page, open the transition Release for editing.

  2. Switch to the Actions tab.

  3. In the Transition of model list, change the transition from No transition selected to set valid at validity start point. The target state of the model will automatically change from Released to Valid when the "Valid from" date is reached.

  4. In the Transition of predecessor model list, change the transition from Archive model (system) to No transition selected.

  5. Clear the Transfer references from predecessor model check box, and then click Save.

Adapt Transition "Set Valid"​

In order to adapt the transition "Set valid":

  1. Still on the Configure Transitions page, open the transition Set valid for editing.

  2. In the General settings tab, select the Create menu item check box.

  3. Click Save, and then click Save.

Final Steps​

Perform the following final steps:

  • Restart the ADONIS application server.

The prolongation mechanism is activated and ready for use.

Specific Configuration of the Model Release Workflow​

If you are using a specific configuration, the required steps to activate the prolongation mechanism depend on the design of the release workflow transitions.

Remarque

A complete description of all configuration possibilities goes beyond the scope of this manual. Please contact your ADONIS consultant. They will help you get a new release workflow configuration that includes the prolongation mechanism.

Configure User Rights for the Model Release Workflow​

In this section rights settings for two typical scenarios when using the model release workflow are summarised.

Remarque

All descriptions in this section refer to the default configuration of the model release workflow. If you are using a different configuration, adjust the rights settings analogously to the settings described here.

Global Rights Settings​

One set of permissions is applied across the organisation (and its business units). This scenario often applies to smaller and/or centrally managed organisations.

Scenario Description

  • Only Modellers can create new models or new versions of released models.
Remarque

This only applies to model types configured for use in the model release workflow. The use of other model types is not restricted.

  • Modellers have write access to models in the state Draft across all business units.

  • Models which are not in the state Draft are read-only for all users with a release workflow role.

  • Reviewers can review submitted models across all business units.

  • Readers have read access to models across all business units. In the Organisation Portal, Readers only have access to released models.

Procedure for Setting the Necessary Rights

  • The individual business units are represented by model groups.

  • Add users to the appropriate system roles depending on their task in the release process. Readers do not a have a release workflow role.

  • Add users to the following user groups:

    • Assign Modellers to a user group that provides write access to all model groups that contain models in the state Draft. This is necessary for the Modellers to create new working versions.

    • Assign Readers to a user group that only provides read access to all model groups.

Business Unit-Based Rights Settings​

Different sets of permissions are assigned depending on the user's area of responsibility and business unit within the organisation. This scenario applies to larger and/or decentrally managed organisations.

Scenario Description

  • Only Modellers can create new models or new versions of released models.
Remarque

This applies to the subset of model types configured for use in the model release workflow. The use of other model types is not restricted.

  • Modellers have write access to models in the state Draft in their business unit only. They do not have write access to models in other business units.
Example

Modeller A can create models in "BU1". He only has read access to models in "BU2" and no access to models in "BU3".

  • Models which are not in the state Draft are read-only for all users.

  • Reviewers can review submitted models across all business units.

  • Readers have read access to models across all business units. In the Organisation Portal, Readers only have access to released models.

  • Some Readers (or groups of readers) may not be allowed to see all released models, but only of certain business units.

Procedure for Setting the Necessary Rights

  • The individual business units are represented by model groups.

  • Add users to the appropriate system roles depending on their task in the release process. Readers do not a have a release workflow role.

  • Add users to the following user groups:

    • Assign Modellers to a user group that provides write access to all model groups that contain models of their business unit in the state Draft. This is necessary for the Modellers to create new working versions.

    • Assign Readers to a user group that only provides read access to all model groups. If necessary, restrict the rights further and do not grant access to specific model groups.

Organisation Portal​

Remarque

Starting with ADONIS 15.0, the Organisation Portal is no longer available to new customers. Existing customers with licences that include the Organisation Portal may continue to use it.

The Organisation Portal allows employees of your organisation easy and intuitive access to the models in the ADONIS database. Personalized dashboards and other complex functions are not included in the Organisation Portal. Access to the Organisation Portal does not require a user account.

Remarque

The Organisation Portal is read-only. Users have no write access to repository content (including all models and objects and their relations).

Set Up Access to the Organisation Portal​

In order to set up access to the Organisation Portal you need to prepare at least one user account with the appropriate system role. The following steps are necessary to set up the default configuration:

  1. Create the following top level user group:

    • Reader

  2. Edit the access rights of the user group "Reader" for the following groups at the top level just below the root groups:

    • Read access to the model group "Models"

    • Read access to the object group "Objects"

  3. Create the following user account and add it to the newly created user group:

    • User name: Reader, and a password of your choice. Activate Trusted Login and assign the current standard repository to the user.

  4. Assign the following preconfigured system role to the newly created user group:

    • Organisation Portal

  5. By default, the system role 'Organisation Portal' has access to the following modules only:

    • BPMS Organisation Portal
Remarque

The above settings represent the minimum configuration. You can assign additional modules to the system role "Organisation Portal". Bear in mind though that if a user has access to more functionality via additional modules, the complexity of the Organisation Portal as a whole increases.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Configure Organisation Portal​

To configure the Organisation Portal:

  • Go to Settings > Organisation Portal > General.

The Organisation Portal configuration wizard has 2 pages:

  1. General Settings

  2. Configure Start Model

These pages are discussed in more detail in the following sections.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

General Settings​

The first page of the Organisation Portal configuration wizard allows you to grant or deny anonymous access to the Organisation Portal and select which model states should be visible.

Access Configuration

The following settings are available:

  • Allow anonymous access

    Choose whether to enable anonymous access to the Organisation Portal, allowing users entry without having to provide credentials. Deactivating this option is useful in case of publicly accessible deployments when allowing access to the Organisation Portal without authentication is not desirable.

Deactivating this option has the following effects:

  • Only authenticated users with the system role 'Organisation Portal' may log in to the Organisation Portal.

  • The link to access the Organisation Portal on the ADONIS login page is not displayed.

  • Access to the Organisation Portal via user-specific URLs is disabled.

  • The menu entry Organisation Portal from the dropdown menu for scenario selection in ADONIS is disabled.

  • The Organisation Portal configuration options Access via the link on the web client login page, Default user for anonymous access and Activate user-specific URL become inactive.

  • Access via the link on the web client login page

    Select whether a link is displayed on the ADONIS login page that allows users to enter the Organisation Portal. The Standard user (see below) is utilized in this case.

  • Default user for anonymous access

    Select which user account is utilized when users enter the Organisation Portal via the link on the ADONIS login page.

State Filter Configuration

The model state filter lets you control the visibility of models in the Organisation Portal. You can select which model states should be visible and for which model types the filter should be applied.

  • Choose model types to which the state filter should be applied

    Select the model types for which the filter should be applied. Model types which are not selected will be visible regardless of state.

  • Select states to be shown

    Select the model states which should be visible if the model state filter is applied.

Configure Start Model​

The second page of the Organisation Portal configuration wizard allows you to configure user-specific and repository-specific entry points to the Organisation Portal, as well as establish a start model for each of these entry points.

Users​

This tab lists all user accounts with the system role "Organisation Portal".

You can configure different users (different settings for the Organisation Portal and different user rights). This allows you to provide multiple entry points to the Organisation Portal and to restrict access to the available repository content for employees of your organisation.

Remarque

Trusted Login is a prerequisite for user accounts which are used to access the Organisation Portal anonymously.

  • Name

    The first column contains the name of the user account.

  • User-specific URL

    This column contains the URL that allows users to enter the Organisation Portal anonymously, without having to provide credentials. Access rights to the models in the database are based on the user account that is used and on the settings for the Organisation Portal.

    The URL is composed of the Base URL and the suffix ?reader=<user account>, e.g. http://server:8000/ADONIS16_0?reader=Reader2.

    Click Copy to copy the URL to the clipboard, and then paste the URL where you need it.

  • Selected repository

    If a start model has been selected for this user-specific URL, the repository that contains the start model will be displayed here.

  • Start model

    Here you can specify a start model that will appear on the Organisation Portal start page. Click Configure start model, and then choose a repository and the start model you want. If a start model has been selected for this user-specific URL already, it will be displayed here.

Remarque

There is a special fallback handling when you import Organisation Portal component settings from ADONIS 14.1 or lower. The start model for the Default user for anonymous access (see above) will also be displayed on the "Read & Explore" scenario start page as long as no specific "Read & Explore" start model has been defined (see Read & Explore Scenario).

  • Activate user-specific URL

    Select whether anonymous access to the Organisation Portal with this user is possible. This option is useful if you want to temporarily disable an entry point to the Organisation Portal instead of permanently removing it.

    When you deactivate this option, the user-specific URL to access the Organisation Portal with this user is disabled. Additionally, in case of the Standard User (see below), the link to access the Organisation Portal on the ADONIS login page is not displayed and the menu entry Organisation Portal from the dropdown menu for scenario selection in ADONIS is disabled.

Repositories​

This tab lists all repositories. You can define a fallback configuration for each of these repositories. These fallback configurations are used when the option Activate repository fallback is activated.

  • Activate repository fallback

    Select this check box to enable a fallback mechanism for authenticated users with the system role 'Organisation Portal' that do NOT have a user-specific Organisation Portal configuration. When such users log on to ADONIS, a fallback configuration is used. This is useful in case of deployments where large numbers of users with the system role 'Organisation Portal' are automatically created but configuring them individually is not feasible.

  • Start model

    Here you can specify a start model that will appear on the Organisation Portal start page. Click Configure start model, and then choose the start model you want. If a start model has been selected for this fallback configuration already, it will be displayed here.

  • Active

    Select whether access to the Organisation Portal with this fallback configuration is possible. This option is useful if you want to temporarily disable an entry point to the Organisation Portal instead of permanently removing it.

Absence of Start Model and Impact of Model Release Workflow​

Explore the implications of not configuring a start model for the Organisation Portal and understand the influence of the model release workflow on start models. Read on for the details.

No Start Model Configured

When no start model has been configured for the Organisation Portal, the following applies:

  • In the Organisation Portal, the appearance of the start page changes. The "Home" section with the start model is not displayed. Instead, the "Processes" section will appear as the start page.

Start Model and Model Release Workflow

When the model release workflow is in use, the start model for the Organisation Portal is automatically updated to use the latest released version of a model.

Example

You have defined a Process Landscape (version number "1.00") as your start model. A new version of this Process Landscape is released. The new model (version number "2.00") will be displayed as a start model instead of the archived predecessor version.

Configure IP Restrictions for the Organisation Portal​

If you want to limit which IPs can access the Organisation Portal, you need to adapt the Security settings in the ADONIS Administration:

  • Go to Home > More options, and then click General Settings.

  • Click Security settings. Edit the settings and save the changes afterwards.

The following parameter needs to be modified:

  • orgportal_ip_restrictions

    This parameter is optional. You can restrict the IP addresses that are allowed to access the Organisation Portal (see section How to Use IP Constraints for more information). Wrap each rule in quotes.

Example

Deny all IP addresses starting with 192., deny the IP address 193.168.0.1, allow all other IP addresses:

"deny 192.*","deny 193.168.0.1","allow all"

Allow all IP addresses starting with 178. except 178.6.6.6, deny all other IP addresses:

"deny 178.6.6.6","allow 178.*"

Process Analysis & Optimisation​

Here you can define default values for simulation parameters and general settings for process analysis (process simulation and process stepper).

Open Process Analysis & Optimisation Settings

To open the process analysis & optimisation settings:

  • Go to Settings > Process analysis & optimisation > General.

Configure Process Analysis & Optimisation

The following settings are available:

  • Working days per year

    Specify the number of working days per year that are used to estimate required resources and aggregate time values. The default is 220 days.

  • Working hours per day

    Specify the number of working hours per day that are used to estimate required resources and aggregate time values. Enter the desired values into the fields Hours and Minutes. The default is 8 hours.

  • Advanced (different business hours and working hours)

    Select this option if you want the advanced options (see below) to be expanded by default in ADONIS.

Advanced Options

The simulation parameters in this area are necessary if the business hours of your company and the individual working hours are different.

  • Working days per year (employee)

    Specify the average number of days in a year in which an employee is performing work. The default is 220 days.

  • Working hours per day (employee)

    Specify the average number of hours per day in which an employee is performing work. Enter the desired values into the fields Hours (employee) and Minutes (employee). The default is 8 hours.

  • Business days per year (company)

    Specify the number of days in a year in which business is conducted and processes are executed. The default is 365 days.

  • Business hours per day (company)

    Specify the number of hours per day in which business is conducted and processes are executed. Enter the desired values into the fields Hours (company) and Minutes (company). The default is 24 hours.

  • Do not allow users to change default settings when running simulation

    Select this check box to disallow users from changing the working days and hours when running a simulation. When you clear this check box, users can adapt these parameters as they wish.

Remarque

The availability of the process simulation feature depends on the licence.

Property Filter​

Property filters control the visibility of properties (= attributes and relations) in the following areas:

  • Tabular Editor

  • Notebooks

  • Reports

  • Model Comparison

You can define different property filters for different system roles and scenarios.

Open Property Filter Settings

To open the property filter settings:

  • Go to Settings > Property Filter > General.

Add and Configure Property Filter​

To add a new property filter:

  1. Click the Add filter button.

  2. In the Language independent name box, type a name for the property filter. This language-independent name uniquely identifies the filter.

  3. In the Display name area, type a name for every language ADONIS supports. These names are visible on the user interface.

  4. In the Order area, select the order of the entries when a user selects a property filter in ADONIS.

  5. In the System role assignment area, select the system roles to which you want to assign this filter.

  6. In the Scenario assignment area, select the scenarios to which you want to assign this filter.

  7. On the Model types, Classes and Relation classes tabs, select the properties which should be visible when a property filter is active. You can also deactivate entire Notebook chapters or even all properties in a specific Notebook at once.

  8. Click Add filter, and then click Save. The new property filter is added and the component settings are saved.

Optionally you can also:

  • Select an existing configuration as a template for your new property filter. On the General page, in the Property filters area, find the filter you want to use. To the right of the property filter, click More, and then click Copy.
System Role Assignment and Scenario Assignment - Filter Visibility

You can combine system role assignments and scenario assignments. A property filter is only visible if all conditions are met (logical AND operator).

Edit or Delete Property Filter​

You can edit property filters to fine-tune them, and delete property filters you no longer need:

  • On the General page, in the Property filters area, find the filter you want. To the right of the property filter, click More, and then click Edit filter or Delete.

Settings per Scenario​

In this section, you can configure which property filter should be enabled by default in ADONIS. You have the option to set the default filter for all scenarios ("Global") and to define different default filters for specific scenarios as needed.

Global

On the "Global" tab, you can define the default filter for all scenarios. The following settings are available:

  • Default filter

    Select which property filter should be enabled by default. If a user does not have access to the selected filter, the first filter on the list is activated, then the second filter and so on.

  • Enable 'Show All' Filter

    Select this option box to make the Show all filter available to all users. When the Show all filter is active, all properties are visible.

  • Enable 'Hide empty attributes' filter in notebooks in 'read mode'

    Select this option to make the Hide Empty Attributes filter available to all users. When the Hide Empty Attributes filter is active, no empty properties are visible in Notebooks in read mode.

Scenario-Specific Filter Settings

On the tabs for individual scenarios such as "Read & Explore" or "Design & Document", you can define scenario-specific filter settings. The following settings are available:

  • Use default settings

    Clear this option to enable scenario-specific filter settings.

  • Default filter

    Select which property filter should be enabled by default in this scenario.

Remarque

When a filter is defined as default for a scenario, switching to this scenario will always set this default filter, no matter which filter was active before.

  • Enable 'Show All' Filter

    Select this option to make the Show all filter available to all users in this scenario.

Read & Explore Scenario​

The Read & Explore scenario is a read-only scenario in ADONIS where users can view processes and working instructions. You can configure various settings for this scenario. For example, you can choose whether the widgets and dashboards display data based on Roles or Organisational Units. You can also select the default model editor and choose which start model should appear on the Read & Explore scenario start page.

Open Read & Explore Scenario Settings

To open the Read & Explore scenario settings:

  1. Go to Settings > Read & Explore Scenario > General.

General Settings

The following settings are available:

  • My Processes Based on

    Select what data to display in the widgets and dashboards of the "Read & Explore" scenario. The processes categorised as "My processes" can be derived either from the assignment of Users to Roles or to Organisational Units.

  • Activate Assignment of Roles by Readers

    This option is only available if My Processes based on is set to Roles. in ADONIS, in the "Read & Explore" scenario, at the top of the My BPM dashboard, the Roles which are associated with the field of responsibility of the current user are displayed ("My Roles"). Select the check box to allow users to add Roles from other areas of responsibility. The selection of Roles determines what data will be loaded in the widgets of the “Read & Explore” scenario.

    Remarque

    The Roles which are relevant for the "Read & Explore" scenario are Role objects referenced in the Notebook of the User object. They should not be confused with system roles.

  • Set Textual View as Default Editor

    Select this option to make the textual view the default editor in the "Read & Explore" scenario. All model types with a textual view configuration will be opened in the textual view by default. When you clear this option, the graphical editor will be the default editor for all model types.

  • Activate State Filter (Show only Released Models and Objects)

    Select this check box to only show models and objects in the state "Released" in the "Read & Explore" scenario. Model and object types without a state set by a release workflow are not affected.

  • Allow Users to Configure Start Model

    Select this check box so that users can set their own start models for the "Read & Explore" start page. For this option to work, Enable start model (see below) must also be activated for the repository.

Select Start Model per Repository

Here you can specify a start model that will appear on the "Read & Explore" scenario start page. You can define a configuration for each repository.

The following settings are available:

  • + Select Repository

    Choose the repository for which a start model should be set up.

  • Enable start model

    Select whether a start model will be displayed.

  • + Select Model

    If Enable start model is activated, you can select the start model here.

Recommender Service​

The Recommender Service is designed to enhance the ADONIS experience by suggesting models that may complement each other. This functionality is accessible within the Read & Explore scenario, specifically in the graphical editor, making it easier for users to discover relevant models and get inspired by the work of their colleagues in the organisation.

Open Recommender Service Settings

To open the Recommender Service settings:

  1. Go to Settings > Recommender Service > General.

Configure Recommender Service

The following settings are available:

  • Enable recommender service per repository

    Select the repositories for which the Recommender Service should be enabled.

Privacy and Data Usage Statement for ADONIS Recommender Service

The Recommender Service for ADONIS is a microservice deployed within the AWS Cloud (eu-central-1) and is designed to help users navigate through the models within their own ADONIS repository. It does so by learning from previous user behaviour and recommending models to visit next, based on previously visited models.

After activating the service, ADONIS collects anonymous data about which models in your repository have been opened and in what order. Such data is kept until newer data is uploaded to the service (typically within two weeks). To provide the service, the following strictly anonymous data is used:

  • UUID of the ADONIS repository

  • in what order specific models were opened

  • UUID of opened models

  • information on which models were opened in a user session

This data is not linked to specific users and and is solely used within your repository. Users in your repository will not receive recommendations based on the behaviour of users in other repositories or vice versa.

Furthermore, during the use of the Recommender Service, the following incoming data is logged:

  • UUID of the ADONIS repository for which the recommendation is generated

  • UUIDs of the previously opened models (up to 5)

  • order of the previously opened models

BOC reserves the right to discontinue or pause the Recommender Service at any time.

REST API​

ADONIS offers a generic, extensible REST API that allows authenticated access to exposed functionality. The REST API can be used to e.g. send GET requests to query ADONIS for data.

Remarque

The availability of this feature depends on the licence. Access to the application programming interface (API) is limited to 500 requests per hour.

Activate Access to the REST API

Instructions on how to activate access to the REST API are covered here in the Administration Help.

You must first perform the following steps:

Then you can configure the authentication method you want to use to communicate with the REST API:

These steps are explained in the following sections.

Remarque

Need help deciding on a suitable authentication method? Check out Choosing an Authentication Method for a short overview of each method.

Use the REST API

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

Create Technical User​

Do you want to use OAuth 2.0 authentication using the Client Credentials Flow for authenticating requests to the REST API, or token based authentication using the Client Credentials Flow? If yes, you need to create a technical user now.

Remarque

A technical user is NOT necessary for basic authentication, OAuth 2.0 authentication using the Authorization Code Flow and JWT authentication.

To create the technical user in the ADONIS Administration:

  1. Go to the Users page and click New User.

  2. Begin by filling out the account details on the General tab:

    • Enter a name for the technical user, e.g. "Technical_StandardRESTfulServices".

    • Enter and confirm a password of your choice.

  3. Next, go to the Groups and roles tab:

    • Under User groups, click Select user groups and assign the user to the Default group.

  4. Next, go to the Repository tab:

    • Click Select repository and only (!) assign the repository to the user which holds the data to be queried.

  5. Click Create to complete the user creation process.

  6. Once user creation is complete, you can enable trusted login for the user:

    • Hover over the user, click More, and then select Edit.

    • On the General tab, under Trusted login, select Enabled.

Assign Access Rights to the ADONIS Administration​

If you want to use user write APIs, you must assign access rights to the ADONIS Administration to the user in whose context requests should be executed.

Remarque

This can either be the technical user (for OAuth 2.0 authentication using the Client Credentials Flow and token based authentication) or any ADONIS user (for basic authentication, OAuth 2.0 authentication using the Authorization Code Flow and JWT authentication).

To assign access rights to the ADONIS Administration:

Assign Access Rights to the ADONIS Administration

  1. Go to the Rights page.

  2. In the Users / Groups catalogue on the left, select the user to whom you want to grant access rights to the ADONIS Administration.

  3. Go to the Components tab.

  4. In the workspace, find the "Administration Toolkit" component.

  5. In the Access column, click Change Permissions, and then choose Access.

Edit System Settings​

Now you have to define a few technical settings controlling the base functionality of ADONIS in the ADONIS Administration. To edit the System settings:

  1. Go to Settings > System settings > System.

  2. In the Base URL field, enter the URL where ADONIS can be reached from other machines.

  3. Do you want to use OAuth 2.0 authentication using the Client Credentials Flow or token based authentication? If yes, click Select users and select the technical user you created, e.g. "Technical_StandardRESTfulServices" (see Create Technical User).

  4. Click Save.

Base URL Example

You are configuring ADONIS 16.0. The IP address of the Tomcat server is 10.2.100.68 and the port is 8000. The URL should look like this

"http://10.2.100.68:8000/ADONIS16_0"

Configure General Settings​

Now the general settings for the REST API settings have to be adapted in the ADONIS Administration:

  • Go to Settings > Standard RESTful Services > General.

These settings apply to all authentication methods:

REST API - General Settings

  • Enable Standard RESTful Services globally

    Select this option to enable the REST API. All other settings in this area are inactive unless you select this option.

  • Cache Path

    This parameter is optional. Enter the absolute path to the directory in which cache files must be stored. The user under which the Apache Tomcat web server service is running must have write access to this directory. If the directory does not exist, it will be created by ADONIS.

Remarque

Advantages of using the Cache Path parameter:

Model images and model image maps are generated only once and then cached. Every time the model image or image map is requested, a check is performed if the model has changed. If there are no changes, the information is loaded from the file system. Otherwise, the cache is updated first. As a result, responses to these types of requests are faster and use fewer server resources.

For search jobs the advantage is that created queries are saved in cache files and can be reused after a server restart. Without the cache path, queries are saved only in memory and are lost during restart.

  • Enable Validator

    This parameter is optional. Select this option to turn on syntax and semantic validation of XML and JSON responses. Enabling this parameter may slow down the execution of requests and cause high memory consumption and CPU usage on the web server.

  • Enable HATEOAS links

    This parameter is enabled by default. When you clear this option, responses to requests will not include HATEOAS links that help you find related resources.

Configure Basic Authentication​

You need to enable basic authentication in the Standard RESTful Services settings (see Configure Settings for Basic Authentication) and in the Security settings (see Enable Basic Authentication for ADONIS).

Configure Settings for Basic Authentication​

To configure basic authentication for the REST API in the ADONIS Administration:

  1. Go to Settings > Standard RESTful Services > General.

  2. Edit the settings on the Basic Auth tab.

The following settings are available:

REST API - Basic Auth

  • Enable Basic Authentication

    Select this option to enable basic authentication. All other settings in this tab are inactive unless you select this option.

  • Repository scenarios | Users scenarios | Metamodel scenarios

    In this area, you can enable specific REST scenarios. If a scenario is not enabled, all requests to its endpoints will return a 403 FORBIDDEN status. HATEOAS links that help you find related resources are also affected. For example, the response to a request to get user information may contain a HATEOAS link to delete the user. If the user write APIs scenario is disabled, a request to this link will return the status code 403 FORBIDDEN.

Remarque

To find out which endpoints are assigned to the REST scenarios, see the API Reference in the ADOxx Developer Portal where they are grouped according to the scenarios.

Enable Basic Authentication for ADONIS​

For security reasons, basic authentication is turned off by default in ADONIS. If you want to use the REST API with basic authentication, you need to adapt the Security settings in the ADONIS Administration:

  • Go to Home > More options, and then click General Settings.

  • Click Security settings. Edit the settings and save the changes afterwards.

The following parameters need to be modified:

  • basicauth_ip_restrictions

    Specify the IP addresses that shall be allowed to send requests with basic authentication to the REST API (see section How to Use IP Constraints for more information). Wrap each rule in quotes.

Example

Deny all IP addresses starting with 192., deny the IP address 193.168.0.1, allow all other IP addresses:

"deny 192.*","deny 193.168.0.1","allow all"

Allow all IP addresses starting with 178. except 178.6.6.6, deny all other IP addresses:

"deny 178.6.6.6","allow 178.*"

  • basicauth_roles

    This parameter is optional. Specify a comma-separated list of system roles that a user must have at least one of in order to use the REST API with basic authentication. Enter the unique names of the system roles. Example: ["Common", "Reviewer"].

Remarque

To find out the unique name of a system role:

  • in the ADONIS Administration, go to the System Roles page.

  • Select the system role you want, and then check the Unique name box.

No restart is required when modifying these parameters.

Configure OAuth 2.0 Authentication​

You need to enable OAuth 2.0 authentication in the Standard RESTful Services settings (see Configure Settings for OAuth 2.0) and in the OAuth 2.0 settings (see Enable OAuth 2.0 for ADONIS).

Configure Settings for OAuth 2.0​

To configure OAuth 2.0 authentication for the REST API in the ADONIS Administration:

  1. Go to Settings > Standard RESTful Services > General.

  2. Edit the settings on the OAuth 2.0 tab.

The following settings are available:

REST API - OAuth2

  • Enable OAuth 2.0

    Select this option to enable OAuth 2.0 authentication. All other settings in this tab are inactive unless you select this option.

  • Repository scenarios | Users scenarios | Metamodel scenarios

    In this area, you can enable specific REST scenarios. If a scenario is not enabled, all requests to its endpoints will return a 403 FORBIDDEN status. HATEOAS links that help you find related resources are also affected. For example, the response to a request to get user information may contain a HATEOAS link to delete the user. If the user write APIs scenario is disabled, a request to this link will return the status code 403 FORBIDDEN.

Remarque

To find out which endpoints are assigned to the REST scenarios, see the API Reference in the ADOxx Developer Portal where they are grouped according to the scenarios.

Scopes (Client Credentials Flow)

OAuth 2.0 offers multiple flows. ADONIS supports the Authorization Code Flow and the Client Credentials Flow.

Do you want to use the Client Credentials Flow? If yes, you need to define at least one scope:

  • Add Scope

    To add a new scope, click Add scopes.

  • Edit or Delete Scope

    To the right of the scope, click More, and then click Edit or Delete.

A scope consists of the following parts:

  • name

  • IP constraints

  • technical user

Remarque

ADONIS RESTful services support multiple scopes. At least one scope is required.

When would you want to use multiple scopes? You can execute requests with access rights of different technical users or from different IP ranges. During execution, you can choose which of the predefined scopes should be used.

Let's take a detailed look at the settings:

  • Name

    This parameter represents the name of the scope. Enter a descriptive name, e.g. "REST_READ".

  • IP constraints

    This parameter is optional. You can restrict the IP addresses that shall be able to access a scope by passing an IP constraint pattern (see section How to Use IP Constraints for more information).

Example

Deny all IP addresses starting with 192., deny the IP address 193.168.0.1, allow all other IP addresses:

deny 192.*,deny 193.168.0.1,allow all

Allow all IP addresses starting with 178. except 178.6.6.6, deny all other IP addresses:

deny 178.6.6.6,allow 178.*

  • Technical user

    Select the technical user you created, e.g. "Technical_StandardRESTfulServices" (see Create Technical User).

Enable OAuth 2.0 for ADONIS​

If you want to use the REST API with OAuth 2.0, you need to enable OAuth 2.0 and configure a client in the ADONIS Administration:

  1. Go to Home > More options, and then click OAuth 2.0.

  2. Select OAuth 2.0 enabled to enable OAuth 2.0.

  3. Click Upload Logos to upload a logo to represent the client application.

  4. Click Add to add a new client.

  5. Complete the Client Data form that appears. You can enter and edit the following data:

    • Type: Select the client type. Confidential clients are e.g. centralized, server based applications, which are capable of securely storing client secrets. Public clients are e.g. purely client based applications and native apps which are not capable of securely storing client secrets.

    • ID: The ID of the client system. Must be unique among the clients, should be kept simple as special characters need to be URL encoded.

    • Name: The name of the client application. Will be shown on the user interface.

    • Redirect URI: The URL of a redirect endpoint inside the client application which will be called by the authorization server when issuing an authorization code.

    Remarque

    The Redirect URI is unnecessary when using the Client Credentials Flow, however the Client Data form requires this field to be filled (mandatory for Authorization Code Flow).

    • Logo: Select a logo to represent the client application (must be uploaded first on the OAuth 2.0 page). Will be shown on the user interface.

    • Access Token Validity (Seconds): The time in seconds how long an access token is valid until it expires. Default: 1800s = 30 minutes.

    • Refresh Token Validity (Seconds): The time in seconds how long a refresh token is valid until it expires. Default: 1209600s = 14 days.

    • Secret: The secret to use for client authentication. You can click Generate to generate a new secret or manually specify one.

  6. Back on the OAuth 2.0 page, click Save changes to save all changes made on this page.

Configure JWT Authentication​

You need to enable JWT authentication in the Standard RESTful Services settings (see Configure Settings for JWT Authentication) and in the JWT (REST) settings (see Enable JWT Authentication for ADONIS).

Configure Settings for JWT Authentication​

To configure JWT authentication for the REST API in the ADONIS Administration:

  1. Go to Settings > Standard RESTful Services > General.

  2. Edit the settings on the JWT tab.

The following settings are available:

REST API - JWT

  • Enable JWT

    Select this option to enable JWT authentication. All other settings in this tab are inactive unless you select this option.

  • Repository scenarios | Users scenarios | Metamodel scenarios

    In this area, you can enable specific REST scenarios. If a scenario is not enabled, all requests to its endpoints will return a 403 FORBIDDEN status. HATEOAS links that help you find related resources are also affected. For example, the response to a request to get user information may contain a HATEOAS link to delete the user. If the user write APIs scenario is disabled, a request to this link will return the status code 403 FORBIDDEN.

Remarque

To find out which endpoints are assigned to the REST scenarios, see the API Reference in the ADOxx Developer Portal where they are grouped according to the scenarios.

Enable JWT Authentication for ADONIS​

To configure the ADONIS REST API to accept a JSON Web Token (JWT) from an Identity Provider (IdP) for authentication, you need to adjust settings in the ADONIS Administration:

  1. Go to Home > More options, and then click JWT (REST).

The necessary settings are described below.

Enable JWT Authentication for ADONIS

For security reasons, basic authentication is turned off by default in ADONIS. To enable JWT authentication:

  • Select JWT active.

Create JWT Configuration

Next, you will need to add a new JWT configuration and edit the properties to match your token:

  • Click Add to add a new configuration. The JWT Data box appears.

Adapt the following parameters in the JWT Data box and save the changes afterwards:

  • object "claims validation" (properties: iss, aud)

    A set of claims that need to be contained in the payload of the token. The "iss" (issuer) claim identifies the JWT issuer (required). The "aud" (audience) claim identifies the intended recipient of the token (optional).

  • name

    name represents the identifier of this configuration.

  • object "signature_validation" (properties: ECDSA_public_key etc.)

    A set of parameters that can be used for JWT signature validation. Which of these parameters is required depends on the algorithm used to generate the signature in the header of the token. At least one parameter needs to be configured.

  • HMAC_shared_secret: Base64 encoded shared secret. Used in HS256, HS384 and HS512 signing algorithms.

  • RSA_public_key: Base64 encoded public key. Used in RS256, RS384, RS512, PS256, PS384 and PS512 signing algorithms.

  • ECDSA_public_key: Base64 encoded public key. Used in ES256, ES384 and ES512 signing algorithms.

  • JWKS_uri: URL of the authorization server's JWK set, it contains the signing key(s) the client should use to validate signatures from the authorization server.

  • OIDC_uri: URL of the OpenID Connect metadata provider as it is specified in OpenID Connect Discovery 1.0.

  • object "user_mapping" (property: claim)

    A claim that needs to be contained in the payload of the token. The "claim" claim identifies the user you wish to authenticate. The value of this claim must match the user name of a user in ADONIS (must have Trusted Login).

Back on the JWT (REST) page, click Save changes to save all changes made on this page. Now you can call the REST API with JWT authentication. Add your JWT to the authorization header, formatted as Bearer.

Configure Token Based Authentication​

To configure token based authentication for the REST API in the ADONIS Administration:

  1. Go to Settings > Standard RESTful Services > General.

  2. Edit the settings on the Tokens tab.

The following settings are available:

REST API - Tokens

Define REST Security Context

You need to define at least one REST security context for token based authentication:

  • Add Context

    To add a new security context, click Add context.

  • Edit or Delete Context

    To the right of the security context, click More, and then click Editor Delete.

A security context consists of the following parts:

  • key

  • secret

  • technical user

  • REST scenarios

Remarque

ADONIS RESTful services support multiple security contexts. At least one security context is required.

When would you want to use multiple security contexts? For example, you can configure one security context that allows for modification of users, and another one with access to the repository. You can execute requests with access rights of different technical users. During execution, you can choose which of the predefined security contexts should be used.

Let's take a detailed look at the settings:

  • Key (for authentication by target system)

    This parameter represents the name of the key which is used for communication with the web application using authenticated REST APIs. Enter a descriptive name, e.g. "boc.rest.key.mfb.StandardRESTfulServices".

  • Secret (for authentication by target system)

    This parameter represents the secret value of the key which is used for communication with the web application using authenticated REST APIs. Click Generate secret to generate the value of the key.

  • Technical user

    Select the technical user you created, i.e. "Technical_StandardRESTfulServices" (see Create Technical User).

  • Repository scenarios | Users scenarios | Metamodel scenarios

    In this area, you can enable specific REST scenarios. If a scenario is not enabled, all requests to its endpoints will return a 403 FORBIDDEN status. HATEOAS links that help you find related resources are also affected. For example, the response to a request to get user information may contain a HATEOAS link to delete the user. If the user write APIs scenario is disabled, a request to this link will return the status code 403 FORBIDDEN.

Remarque

To find out which endpoints are assigned to the REST scenarios, see the API Reference in the ADOxx Developer Portal where they are grouped according to the scenarios.

Choosing an Authentication Method​

ADONIS offers a range of authentication methods to secure communication with its REST API. Your choice of authentication method may depend on various factors, including security requirements, existing infrastructure, and the capabilities of your client applications. This section offers a short overview of each method to assist you in choosing the most suitable authentication approach.

Basic Authentication​

Basic authentication is the most simple method for authentication. It involves sending a username and password with each request. These credentials are Base64-encoded and sent in the HTTP authorization header.

A technical user is NOT necessary for basic authentication. Requests may be executed in the context of any standard product user.

While straightforward, it is crucial to ensure secure transmission. As the credentials are only encoded and not encrypted, it is highly recommended to use basic authentication only in conjunction with HTTPS, i.e. the Tomcat server on which the ADONIS web application is deployed needs to be configured to use SSL/TLS to encrypt the communication between the client and the web server.

When to Use Basic Authentication

Basic authentication proves to be a suitable choice for testing purposes and for client applications that require a simple authentication method and need to authenticate users swiftly and effortlessly. It serves well for client applications where a user needs to log in before access to specific resources is possible.

OAuth 2.0 Authentication​

OAuth 2.0 authentication offers a flexible and secure authorization framework, allowing access to the REST API on behalf of a user without requiring the user's password. Instead, each request is accompanied by an access token to confirm the identity of the user and ensure the validity of the request. The actual authentication of the user is delegated to an external identity provider (IdP).

Two primary flows can be configured:

  • Authorization Code Flow: Suitable for scenarios where user consent is required. A technical user is NOT necessary. Requests may be executed in the context of any standard product user.

  • Client Credentials Flow: Ideal for machine-to-machine (M2M) communication without user involvement. A technical user needs to be created. Requests are executed in the context of this technical user.

When to Use OAuth 2.0 Authentication

OAuth 2.0 authentication is commonly used in scenarios where third-party applications need limited access to ADONIS on behalf of a user. Proving a secure and standardized way for applications to obtain access with the user's consent, it allows for granular control over the level of access granted.

JWT Authentication​

JWT authentication enables the use of an external identity provider (IdP) for user authentication. Once the user has acquired a JSON Web Token (JWT) from the IdP, they can include it in requests in the HTTP authorization header as a bearer token. ADONIS will validate the JWT to determine whether the client has the necessary permissions to access the resource.

A technical user is NOT necessary for JWT authentication. Requests may be executed in the context of any standard product user.

Compact, self-contained, and supporting digital signatures for added security, JWTs can include additional information (claims) beyond authentication.

When to Use JWT Authentication

JWT authentication is considered a flexible, secure, and scalable approach. If security is a top priority and additional features like statelessness and additional claims are needed, JWT authentication may be the best choice for your client application.

Token Based Authentication​

Token based authentication is a BOC Group proprietary authentication method which allows access to the REST API on behalf of a user by providing a token instead of a username and password. It involves sending a security hash which is constructed using a public identifier of the client, a secret key of the client, a GUID, a timestamp of the request and the parameters sent with the request. This prevents unauthorized usage of the API as well as repeated transmission and other abuse of requests.

A technical user needs to be created for token based authentication. Requests are executed in the context of this technical user.

Info

This authentication method is available for Java client applications only.

When to Use Token Based Authentication

The BOC Group is charting a course to mark this authentication method as deprecated in the future. As a result, we encourage users to explore alternative authentication methods for a sustainable and future-proof approach.

System Settings​

In this area you manage the following configuration options for ADONIS:

Active Features​

The settings for active features impact the fundamental behaviour of ADONIS.

Open Settings for Active Features

To open the settings for active features:

  • Go to Settings > System settings > Active features.

Configure Settings for Active Features

The following settings are available:

  • Allow renaming of catalogue elements

    Select this option to allow renaming of catalogue elements displayed in ADONIS.

  • Allow creation of new objects

    Select this option to allow creating new objects in ADONIS via the catalogue or via relations controls.

  • Hide model types when creating new objects

    Select this option to display all object types in a flat list when creating an object in the Explorer. When you clear this option, object types are grouped by model type.

  • Allow creation of model groups

    Select this option to allow creating new model groups in ADONIS via the catalogue.

  • Allow creation of object groups

    Select this option to allow creating new object groups in ADONIS via the catalogue.

  • Allow moving elements in the catalogue

    Select this option to allow ADONIS users to move elements (models, objects, groups) to other parent folders using drag and drop.

  • Allow deletion of models and objects

    Select this option to allow deleting models and objects in ADONIS via the catalogue or via relations controls.

  • Allow models of same type and with same name

    Select this option to allow ADONIS users to create multiple models of the same type with the same name.

  • Allow repository objects of same class and with same name

    Select this option to allow ADONIS users to create multiple repository objects of the same type with the same name.

  • Show models in the catalogue

    Select this option to show models in the catalogue of ADONIS.

  • Show objects in the catalogue

    Select this option to show objects in the catalogue of ADONIS.

  • Enable collaboration component

    Select this option to allow using the collaboration component in ADONIS.

  • Enable dependency analyser component

    Select this option to allow using the dependency modeller component in ADONIS. Additional configuration steps may be needed.

  • Enable favourites component

    Select this option to allow using favourites in ADONIS.

  • Enable translation component

    Select this option to allow using the translation component in ADONIS.

  • Enable file upload to DMS

    Select this option to allow importing external files into the database in ADONIS.

  • Enable graphical model comparison

    Select this option to allow using the graphical model comparison in ADONIS.

  • Enable change password

    Select this option to allow changing the password in ADONIS.

  • Enable recently opened models

    Select this option to display recently opened models in the Quick Access component in the Explorer. When you clear this option, models are not displayed in Quick Access.

  • Enable recently opened objects

    Select this option to display recently opened objects in the Quick Access component in the Explorer. When you clear this option, objects are not displayed in Quick Access.

  • Search automatically activated

    Select this option to activate the setting Search automatically in ADONIS by default, i.e. the search results are automatically adjusted whenever the user edits a search filter.

  • Deactivate "Save As"

    Select this option to disallow creating copies of models in ADONIS.

  • Activate highlighting for relations

    Select this option to highlight the relation with the highest priority when creating relations in ADONIS. When you clear this option, no relation is highlighted.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Email​

ADONIS includes a mail component, which can be used to send messages automatically on several events. Before it is possible to use this component, it has to be configured correctly.

Open Settings for the Email Service

To open the settings for the email service:

  • Go to Settings > System settings > Email.

Settings for the Email Service

The following settings are available:

  • Activate email service

    Select this option to activate the email service. When the web server is started, it will regularly poll the application server for new emails.

  • IP address or name of the email server

    Enter the IP address or the host name of the client where the email server is installed.

  • Port of the email server

    Enter the port number which is used to access the email server. Normally this is port 25.

  • System sender address

    Enter the email address which should be used as sender address for system notifications (e.g. users receive a notification when their attention is required for a step in a release workflow, and the sender address is the system address entered in this field).

  • System replyTo

    Enter the email address to which replies for system notifications should be sent (if replies should not be sent to the system sender address).

  • Encryption

    Select an encryption option if the email server requires it. The following settings are available:

    None: No encryption is used.

    StartTLS (optional): Use StartTLS to upgrade to a secure connection. If the email server does not support StartTLS, an unencrypted connection is used.

    StartTLS (required): Use StartTLS to upgrade to a secure connection. If the email server does not support StartTLS, the operation will fail (= emails are not sent).

    SSL/TLS: Use SSL or TLS to encrypt communication. If the email server does not support SSL/TLS, the operation will fail (= emails are not sent).

  • Email server requires authentication

    Select this option if the email server requires authentication. Normally this is the case.

  • Username

    If the email server requires authentication, the username of the email server user has to be entered here.

  • Password

    If the email server requires authentication, the password of the email server user has to be entered here.

  • Interval in seconds for processing emails

    This setting defines the interval that is used by the web server to poll the application server for new emails. A value of 300 means that the web server will wait for 300 seconds (= 5 minutes) between requests for new emails.

  • Maximum number of failed send attempts (0=unlimited)

    Specifies the number of send attempts after which emails that fail to send (e.g. because the email address does not exist anymore) are skipped.

Remarque

Before it is possible to send email notifications, the Base URL has to be configured correctly.

Info

The ADONIS web application running on the web server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

When does ADONIS send emails?

ADONIS sends emails in the following situations:

  • When someone shares a model, an object etc. directly from ADONIS with colleagues.

  • As part of comments. Example: When someone is directly mentioned with @ in a comment, or if they are part of the discussion and someone else writes a new answer.

  • As part of release workflows. Example: After a transition, the person who is responsible for carrying out the next transition in the release process receives an email.

  • When a user resets their password with the self-service password reset.

Remarque

For details on how to configure the self-service password reset please refer to section Configure Self-Service Password Reset.

Full-Text Search​

As an ADONIS administrator, you can configure a variety of full-text search settings for ADONIS.

Open Full-Text Search Settings

To open the full-text search settings:

  • Go to Settings > System settings > Full-text search.

Global Attributes

When using the general search function in ADONIS (Search & Analysis), certain attributes are considered to find matching objects or models. By default, these are the attributes Name, Description, First name and Last name.

The settings in this area allow you to define additional attributes of the types Short String, ADOstring and Long String to consider.

  • Select attributes that should always be part of the search results

    Select the attributes that should always be considered when using the general search function.

    The search result table displays a separate column for each of these attributes. Found search terms are highlighted in yellow in the search result.

Search in Explorer

By default, only the Name is considered to find matching objects or models:

  • when using the search function in the Explorer

  • while managing relations in the Notebook, when using the search field

The settings in this area allow you to define additional aspects to consider.

  • Apply global attributes for the search in explorer

    Select this option so that the attributes selected in the Global Attributes area above are additionally considered when using the search function in the Explorer or in the Notebook.

  • Use name visualisation pattern for the search in Explorer

    During the customising process of ADONIS, a name pattern may be defined by a BOC Solution Engineer for a model type or class. The name pattern determines which components make up the visualised name on the user interface.

    Select this option so that relations that are part of the defined name pattern are considered when using the search function in the Explorer or in the Notebook.

Example: Use name visualisation pattern for the search in Explorer

Suppose your organisation uses the following customised name visualisation pattern for models:

  • {NAME} [{RC_OWNER}] - Name and relation Process owner

    For example, if "Carol Process" is set as the Process owner of the "Create new customer" model, the visualised name on the user interface for the model will look like this:

  • Create new customer [carol]

    Now, the option Use name visualisation pattern for the search in Explorer is selected. From this point forward, any models with "Carol Process" set as the Process owner will be found when searching in the Explorer with the phrase "carol". This also includes the Create new customer [carol] model mentioned above.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Model Comparison​

Choose the properties to be evaluated during model comparison in ADONIS. This tool makes the differences between two models visible, showing deleted and new objects and connectors, as well as changes in attributes. For example, this can be useful for identifying the differences between two versions of a process.

Open and Configure Model Comparison Settings

  • Go to Settings > System settings > Model comparison.

  • On the Model types, Classes and Relation classes tabs, select the attributes which should be visible when a property filter is active. You can also deactivate entire Notebook chapters or even all attributes in a specific Notebook at once.

    On the Model types, Classes and Relation classes tabs, select the properties to consider when comparing models. You can also use the search box to quickly find a specific property.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Modelling​

Configure settings for automatic saving, visualisation options for ADONIS and other settings. Most of these settings can be overridden by individual users of ADONIS according to their preferences.

Open Modelling Settings

To open the modelling settings:

  • Go to Settings > System settings > Modelling.

General Settings

The following settings are available:

  • Autosave

    Enable automatic saving of changes in models and objects. Determine the number of changes before the next autosave.

Modelling

The following settings are available:

  • Draw new connectors automatically in a rectangular manner

    Make ADONIS draw right-angled connectors automatically. Clear this option to make ADONIS draw straight connectors instead.

  • Show bridges if connectors cross

    Make ADONIS draw bridges if connectors cross.

  • Show cross-hair when modelling

    Show a crosshair when modelling.

  • Only move contained objects if Shift key is pressed

    Resizable objects and aggregations can act as container objects for other objects. When you drag such a container around the drawing area, objects placed inside are moved along if you press and hold the <Shift> key at the same time.

    Clear this option if you want contained objects to move along at all times (without simultaneously pressing the <Shift> key).

Remarque

If you are using the ADONIS BPMS Application Library, the following object types are aggregations: Block, Group, System Boundary and the eponymous Aggregation.

  • Display page breaks & page numbers

    Page breaks divide models into separate pages when you print. They are displayed as dashed lines in the graphical editor. Select whether page breaks and page numbers are visible, if a user has write access or read-only access to a model.

  • Activate web worker rendering

    Web worker rendering means that model graphics are rendered in a separate process, which is more performant. When web worker rendering is disabled, the model is rendered in the same process as the rest of the client-side application, and graphics on the drawing area will load more slowly. Clear this option only if requested by a BOC employee.

  • Shrink model area only to the defined width and height of the model type

    In the graphical editor, the model size automatically adapts to the model content. This means that the model area will expand or shrink as necessary to accommodate all objects.

    Clear this option if you want the model area to expand as needed, but only shrink to the default dimensions specified for the model type in the metamodel, rather than the smallest possible size that still accommodates all objects.

Modelling Direction

The modelling direction can be set to horizontal (modelling is done from left to right) or vertical (modelling is done from top to bottom). You can define the modelling direction for each model type.

Select the Changeable option to allow ADONIS users to change the modelling direction for a specific model in the graphical editor. The objects on the drawing area are automatically rearranged.

Remarque

When using the Hover Modelling Assistant in ADONIS, the modelling direction determines where the next object is placed:

  • Horizontal: To the right of the selected object

  • Vertical: Below the selected object

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Modules​

You can assign modules (plug-ins) to system roles to grant permissions for specific functionalities in ADONIS. This allows you to define different scenarios for different user groups or users.

Open Modules Settings

To open the modules settings:

  • Go to Settings > System settings > Modules.

View and Assign Modules

The modules settings present all modules that can be assigned to users in a table format. The following columns are displayed:

  • Name and description: Displays the name and, if available, a description of the module.

  • System roles: Identifies the system roles that have been granted access to the module.

  • Requires: Contains links to any other modules necessary for the proper functioning of the module.

  • Used By: Contains links to any other modules that use or depend on the module.

The following options are available:

  • Assign Modules

    In the System roles column, select the system roles that should be granted access to the module. To grant access to all users, select the option Available for all users. If certain system roles are unavailable for selection, make sure that they have access to all required system roles.

  • Filter by System Roles

    Click All roles, and then select the option you want. You can view modules Available for all users or only those available for specific system roles.

  • Search

    In the Seach box, type the text you want to search for. All table rows containing the search string in the Name and description, Requires, or Used By columns will be displayed.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Error Message: Configured System Roles Could Not Be Found

The following situation can arise when importing component settings: In the import file, modules are assigned to system roles that do not exist in your database. Such system roles will be highlighted in red in the settings for modules. You can either recreate the missing system roles and make the assignment work again. Or you can remove the assignment (clear check box) and save the settings, and the system roles that do not exist in your database are removed from the configuration.

Object Mouseovers​

Select the properties you want to display in object tooltips in ADONIS. These tooltips provide contextual information when a user opens a read-only model in the graphical editor or in the Organisation Portal and hovers over an object.

Open and Configure Object Mouseovers Settings

  • Go to Settings > System settings > Object mouseovers.

  • Select the properties to display in object tooltips. You can also use the search box to quickly find a specific property.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Printing and Reporting​

The printing and reporting settings allow configuring settings for printing models to PDF, creating PDF and RTF reports, and generating images in ADONIS.

Open Printing and Reporting Settings

To open the printing and reporting settings:

  • Go to Settings > System settings > Printing and reporting.

General Settings

The following settings are available:

  • Default Page Layout

    Select a default page layout for printing models to PDF and creating PDF and RTF reports. Page layouts determine the appearance of the header and footer.

Remarque

If you are using the ADONIS BPMS Application Library, the default page layout for printing models to PDF is defined directly in the metamodel for all model types and this setting is not evaluated. This setting is however still evaluated as a default setting for creating reports.

ADONIS users can choose their own preferred page layout for printing models to PDF and creating reports (under > Preferences > Printing).

  • PDF Version

    Select a PDF version for printing models to PDF and creating PDF reports. PDF is the default format for quality printing. PDF/A is used for archiving and long-term preservation of electronic documents. The availability of PDF versions depends on the configuration of the print templates.

Remarque

For more information about PDF/A, please visit https://www.pdfa.org/pdfa-faq/. PDF/A documents generated in ADONIS are PDF/a-1b compliant.

  • Image Format for Printing Models to PDF

    Set the image format for contained images when printing models to PDF. You can choose between PNG (lossless, bigger size pixel-based image format), JPEG (lossy, smaller size pixel-based image format), and SVG (vector-based image format).

  • Image Format for Image Generation

    Set the image format for generating images (= exporting models in the graphical editor as graphic files). You can choose between PNG (lossless, bigger size pixel-based image format), JPEG (lossy, smaller size pixel-based image format), and SVG (vector-based image format).

  • Page Limit for Printing Models

    Set the maximum number of pages that can be selected in the preview window when printing models to PDF.

Print Templates

The following settings are available:

  • Default Print Template

    Set a default print template for printing models to PDF.

  • Print Templates Available in Print Dialogue

    Define which print templates can be used when printing models to PDF. Depending on the Application Library, various reports and the print template Standard are available. Reports which are not intended for use as a print template are not displayed.

Paper Size Settings

Define which paper sizes can be used when printing models to PDF:

  • Add Paper Size

    To add a new paper size, click Add paper size. Then define the format name and the width and height in millimetres (e.g. Letter, 216, 279).

  • Edit or Delete Paper Size

    To the right of the paper size, click More, and then click Edit or Delete.

System​

The system settings allow an ADONIS administrator to define technical settings controlling the base functionality of ADONIS.

Open System Settings

To open the system settings:

  • Go to Settings > System settings > System.

General Settings

The following settings are available:

  • Base URL

    Enter the URL where ADONIS can be reached from other machines: "http://<SERVER_NAME>:<TOMCAT_PORT>/ADONIS16_0/".

    <SERVER_NAME> is the name of the server machine, <TOMCAT_PORT> is the HTTP/1.1 Connector Port defined during setup at which Apache Tomcat (and therefore ADONIS) is accessible. The default value is “8000”.

  • Session timeout (minutes)

    Specify the number of minutes that a session can remain idle before the server terminates it automatically. The default is 20 minutes.

  • AJAX timeout for requests from web client to web server (seconds)

    Enter the timeout for the requests from the web client (= browser) to the web server in seconds.

Technical Users

In this area, you can view and manage technical users. Technical users are used by various components of ADONIS, for example for the synchronisation of objects with other BOC Management Office products.

The following settings are available:

  • Select users

    Choose the technical users you want from a list featuring all users with the trusted login option enabled.

  • Remove user

    Remove technical users if they are no longer needed.

Info

The ADONIS application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.

Textual View​

The textual view provides a step-by-step guide through a process, allowing users to quickly understand the flow of activities and decisions. It presents models in tabular form, listing objects in rows according to their order in the process, with essential details displayed in the columns.

The availability of the textual view for specific model types depends on the Application Library and product configuration. In the ADONIS BPMS Application Library, this feature is available for Business Process Diagrams by default. ADONIS administrators can create additional textual view configurations for other model types in the ADONIS Administration.

Configure Textual View​

To edit the textual view settings:

  • Go to Settings > Textual view > General.

The textual view configuration wizard has 3 pages:

  1. Select model type

  2. Select object types

  3. Select properties

These pages are discussed in more detail in the following sections.

Select Model Type​

The first page of the textual view configuration wizard displays all model types that already have a configuration. Here, you can either modify an existing configuration or create a new one. The following settings are available:

  • Add Model Type

    Click Add model type to select a model type for further editing. Now you can add a configuration for this model type.

  • Add Configuration

    Click Configure to start creating a new configuration for a model type. You will automatically advance to page 2 of the configuration wizard where you can select the object types which should be displayed in the textual view. If a configuration already exists for a model type, the Configure button is replaced by a check mark .

  • Active

    Select whether the textual view configuration for a specific model type is enabled or disabled. This option is useful if you want to temporarily disable a configuration instead of permanently removing it.

  • Edit Configuration

    To the right of the model type, click More, and then click Configure to edit an existing configuration. You will automatically advance to page 2 of the configuration wizard where you can select the object types which should be displayed in the textual view.

  • Delete Configuration

    To the right of the model type, click More, and then click Delete.

After you have completed these settings, select page 2 from the navigation menu at the top to advance to the next page of the textual view wizard.

Select Object Types​

The second page of the textual view configuration wizard allows you to select the object types which should be displayed in the textual view. The following settings are available:

  • Model Types

    The model type you've selected to configure is listed here. Adjust it if necessary.

  • Objects

    Select the check boxes next to the object types you want to display in the textual view.

    For each object type, you can choose a name attribute and a description attribute to appear in the Name and Description column in the textual view. Additionally, you can select a reference to follow i.e. that in the textual view the link to the Notebook of the object is replaced by a link to the referenced object/model as selected here.

  • Enable bridging

    Select this option to display links to subsequent objects in the textual view even when intermediate objects between source object and target object(s) are not shown.

Example: Non-exclusive Gateway

By default, the object type Non-exclusive Gateway is not displayed in the textual view. If Enable bridging is activated, the task that connects to the gateway will point directly to follow-up tasks connected out of the gateway. If bridging is not active, then no links will be displayed.

  • Order attribute

    Select the attribute which is used to order the objects in the model and thus also in the textual view.

  • Connector relation

    Select the relation which is used to connect subsequent objects in a model. By means of this connector relation, links are displayed in the textual view (icon ), which can be used to navigate to the next object(s).

  • Name attribute

    Optional: Select the name attribute of the connector relation. This attribute appears in the textual view to the left of the link to the next object.

After you have completed these settings, select page 3 from the navigation menu at the top to advance to the next page of the textual view wizard.

Select Properties​

The third page of the textual view configuration wizard lists all properties that are set to appear in the textual view. Here, you can add or remove properties, and change their position. The following settings are available:

  • Add Properties

    Click Add properties to add new object properties to display in the textual view. They will be added at the bottom of the list, in the order you selected them.

  • Change Order of Properties

    Use the drag handle () to drag a property to a new position.

  • Shown by Default

    Select this option to ensure a property is visible by default in the textual view. Clearing this option hides the corresponding column by default, although it can still be made visible as needed.

  • Used by

    Check here to see which object types selected for the textual view use a property.

  • Remove Property

    To the right of the property, click More, and then click Remove.

After you have completed these settings, click Save. The textual view settings are saved in the database and immediately available in ADONIS.

Validation​

The validation functions in ADONIS allow ADONIS users to check whether models and objects comply to the modelling guidelines. If the modelling guidelines are violated, ADONIS shows corresponding notifications.

ADONIS provides the following types of checks:

  • Error, Warning and Information

    These are programmatic checks that ensure syntactic correctness and proper usage of elements in modelling. Only ADONIS product developers and customisers can create new checks of these types. However, as an ADONIS administrator, you can edit these checks. For example, you can modify the text displayed if a check fails or change the category to which a check belongs.

  • ToDo

    These checks serve as reminders for users to manually review and confirm certain conditions. ADONIS administrators can create new ToDos from scratch and configure them without any restrictions.

Configure Validation​

To edit the validation settings:

  • Go to Settings > Validation > General.

The validation configuration wizard has 2 pages:

  1. Configure checks

  2. Configure categories

These pages are discussed in more detail in the following sections.

Configure Checks​

The first page of the validation configuration wizard presents its content in a table structure containing all checks simultaneously.

  • Within the editor, checks are sorted alphabetically.

  • The first table column lists the type of the check (ToDo, Information, Warning, Error).

  • The second table column contains the name of the check.

  • The third table column lists the text displayed in the notification.

  • The fourth table column lists the categories to which a check belongs.

The following options are available:

  • Add ToDo

    Click New ToDo. Now you can configure the check.

  • Delete Check

    To the right of the check, click More, and then click Delete.

  • Edit Check

    To the right of the check, click More, and then click Edit, Assign to category or Assign model/object types. Now you can configure the check.

Edit or Add Check​

When you add a new ToDo or edit any check on the Configure checks page, a dialogue with three tabs appears. You can view and edit the following data:

Settings

  • The check's type is listed at the top. Adjust it if necessary.

  • Next, you can define the content that is displayed if the check is not successful. For every language ADONIS supports, you can edit the name of the check as well as the text and the hint that are displayed in the notification.

Remarque

Modifying the type is limited to predefined checks provided with ADONIS. The type of user-created ToDos is fixed and cannot be altered.

Categories

  • Select the categories to which a check belongs. You can also use the search box to quickly find a specific category.

Model/Object Types

  • Select the model and object types that will be checked.
Remarque

For a detailed list of all checks, see Validation Checks Overview.

Reset Values

On any tab, you can select Reset values to restore the default settings for a check.

After you have completed these settings, select page 2 from the navigation menu at the top to advance to the next page of the validation configuration wizard.

Configure Categories​

The second page of the validation configuration wizard presents its content in a table structure containing all categories simultaneously.

  • Every row represents a different category.

  • The first table column contains the name of the category.

  • The second table column contains the names of the system roles which are allowed to run checks of this category.

The following options are available:

  • Add Category

    Click New category. Now you can configure the category.

  • Delete Category

    To the right of the category, click More, and then click Delete.

  • Edit Category

    To the right of the category, click More, and then click Edit. Now you can configure the category.

  • Reset Values

    To the right of the category, click More, and then click Reset to restore the default settings for a category.

  • Assign Checks

    To the right of the category, click More, and then click Assign checks. Now you can select the checks which should belong to this category.

Edit or Add Category​

When you add or edit a category on the Configure categories page, a dialogue will appear. You can view and edit the following data:

  • Name

    For every language ADONIS supports, you can edit the name of the category.

  • Assign System Roles

    Select the system roles which are allowed to run checks of this category.

  • Extension Module

    Lists the extension module which contains the logic for running checks of this category.

Attention

Users who execute release workflow transitions need access to the "Release Workflow" category checks. Assign system roles to these users which are allowed to run these checks. These checks are required for the release workflow to work.

Remarque

For information on which categories are available, see Available Check Categories in the ADONIS BPMS Application Library.

After you have completed these settings, click Save. The validation settings are saved in the database and immediately available in ADONIS.

Available Check Categories in the ADONIS BPMS Application Library​

The following check categories are available if you are using the ADONIS BPMS Application Library:

  • BPM Best Practice

    BPM Best Practice checks ensure the readability, clarity and comprehensibility of models.

  • BPMN Syntax

    BPMN syntax checks assess the model with regard to its syntactic conformity with the BPMN standard and the syntactic rules defined therein.

  • Layout

    Layout checks are used to ensure a uniform appearance.

  • Methodical

    Methodical checks ensure compliance with the methodological guidelines and the integrity of the model portfolio.

  • Process Architecture

    Process architecture checks assess whether the process is anchored in the process architecture.

  • Process Release Confirmation

    This is a checklist of points that should be fulfilled at the latest when the process is released.

  • Process Structure

    These checks ensure that the process meets the required level of detail.

  • Relation Rules

    These checks ensure that relations follow modelling rules.

  • Release Workflow

    Checks within the framework of the model release workflow, which ensure a minimum level of information for release workflow participants and process readers.

Remarque

For a detailed list of all checks in the various check categories, see Validation Checks Overview.