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 ADOIT database and can be migrated between different ADOIT versions to preserve your settings.
The Settings page shows all library-specific component settings in the database. Depending on the ADOIT 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:
Go to the Settings page.
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 ADOIT database.
To import component settings:
Go to Settings > More options, and then click Import settings.
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.
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.
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.
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 ADOIT version.
To export system roles:
Go to Settings > More options, and then click Export settings.
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.
Click Export. The data is exported.
Bar
Bar charts in ADOIT 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 ADOIT. The ADOIT 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 ADOIT 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 ADOIT 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 ADOIT. The ADOIT 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 ADOIT supports, you can edit the name of the template as well as the description which characterises the template.
Bubble
Bubble charts in ADOIT 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 ADOIT. The ADOIT 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 ADOIT 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 ADOIT, files being uploaded to the ADOIT database (documents, media files, etc.) or downloaded to your device may be checked for virus infections.
For detailed instructions on how to integrate ClamAV into ADOIT, please refer to the chapter Enable Virus Scan for File Uploads in the Installation Manual.
Comments
Comments allow ADOIT 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 ADOIT 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. ADOIT 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 ADOIT. 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 ADOIT 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 Representation 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.
The ADOIT 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 ADOIT 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 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.
The ADOIT application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.
Object Owners
In ADOIT a user can be assigned ownership of a repository object. In order to do so, the user has to be assigned as Responsible business actor (object attribute in the Notebook chapter "Organisation").
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, ADOIT 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 ADOIT contain repository objects.
The ADOIT 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 ADOIT (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:
Go to the Settings page.
Right-click Corporate identity, and then click Create.
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 ADOIT 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:
| Type | Width & Height | File Size | Format |
|---|---|---|---|
| Banner | Recommended 2000 x 1000 pixels (see below table for more information). | Less than 5MB | JPEG, PNG, BMP, GIF or SVG |
| Logo | Minimum 260 x 260 pixels. Aspect ratio approximately 1:1 for best results. | Less than 5MB | JPEG, 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.
Create Models/Objects
Provide guidance to ADOIT 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.
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 ADOIT.
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. At the same time, the user receives an alert.
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. At the same time, the user receives an alert.
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, ADOIT 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:
Go to the Settings page.
Right-click Dependency Modeller, and then click Create.
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:
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 ADOIT 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 ADOIT, 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.
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 processedWhen 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 ADOIT.
Enterprise Architecture Management
If you are using the ArchiMate Application Library, you can configure special functionality related to architecture elements.
Open Enterprise Architecture Management Settings
To open the Enterprise Architecture Management settings:
- Go to Settings > Enterprise Architecture Management > General.
General Settings Related to Enterprise Architecture Management
The following settings are available:
Grant the owner write access to the object group containing the architecture element
In ADOIT a user can be assigned ownership of a repository object (see Object Owners). Define whether they will be granted write access to the object group containing the repository object, even if they usually only have read access. When the user is removed, the rights to the object group are set back to inherited.
Excel Import
ADOIT 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 ADOIT metamodel:
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 ArchiMate Application Library, one or more sample configurations will already be provided for you in the ADOIT Administration. For every configuration, a suitable Excel file is included.
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 ADOIT installation medium in the folder "02 Application Server\BOC\ADOIT 17.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 ADOIT you have to import the XML configuration file first:
Go to the Settings page.
Right-click Excel import, and then click Create.
In the Configuration name box, enter a name for your configuration, and then click OK.
Click Import and upload the XML configuration file. The content of the configuration file will be displayed in the Setup box.
Click Save.
The configuration is saved. You can now import objects from any Excel file that corresponds to the configuration in ADOIT.
Import Excel File Template
For each configuration you can import a suitable Excel file as a template.
Go to Settings > Excel Import.
Select the configuration for which you want to import a template.
Click Import Excel Template and upload the Excel file. The template's name will be displayed in the Template box.
Click OK.
The configuration is saved. The template is now available for download in the Excel import dialogue in ADOIT. Users can download the template, capture objects in it, and then import the objects.
Gantt
Gantt charts in ADOIT 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 ADOIT. The ADOIT 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 ADOIT 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 ADOIT 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.
A detailed description of this functionality is beyond the scope of this manual. If you have questions, please contact your ADOIT consultant.
Integration - Data Connectors: ADONIS
ADOIT offers synchronisation of objects between ADOIT and ADONIS.
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.
The availability of this feature depends on the licence.
Configuration
The configuration is carried out via the Integration Framework. If you are using ADOIT 17.0, you can synchronise objects with the following ADONIS versions:
- ADONIS 14.1.17 or higher | ADONIS 15.0.12 or higher | ADONIS 16 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 ADOIT (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 ADOIT and ADONIS 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 ADOIT and ADONIS via the Integration Framework, you have to define settings in BOTH products.
First, enable access to the REST API on the ADONIS side so that ADOIT can retrieve data from there:
Next, create a technical user on the ADOIT side:
Then you can configure the data connector that will be used to connect to ADONIS on the ADOIT 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 ADOIT:
These steps are explained in the following sections.
The procedure described here ONLY applies to importing BPM elements from ADONIS into ADOIT. If you want to import EA elements from ADOIT into ADONIS, set up the synchronisation as described in the ADONIS Administration Help.
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 ADONIS 
First, you need to enable access to the REST API in ADONIS (as described in the ADONIS 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
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 ADOIT Administration:
Go to the Users page and click New User.
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 (EA Workflow).
Repository: Only (!) assign the repository to the user into which the BPM elements from ADONIS should be imported.
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 ADOIT
Now, you need to configure the data connector that will be used to connect to ADONIS in ADOIT (in the Connect Center).
Prerequisites
Before you proceed, you need to assign three modules to your user in the ADOIT Administration. These modules are required to access and modify the data connector configuration:
Go to Settings > System settings > Modules.
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 ADOIT:
On the toolbar at the top of the screen, click Setup
, and then click Connect
Center.In the left pane, under Connectors, select the configuration " ADONIS", and then click Open configuration dialog
.Edit the settings on the General Configuration, Technical Settings, Data Synchronization and Constants tabs.
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 ADONIS is available.
Example
You are configuring ADOIT. ADONIS 15.0 is the other product. You are running the ADONIS web application on a machine with the IP 10.2.100.62. The URL should look like this:
"http://10.2.100.68:8000/ADONIS15_0"
Authentication Type: Select the authentication method you have configured in ADONIS 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 ADONIS.
Password (encrypted): Enter the password of the user in whose context REST API requests should be sent in ADONIS. 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 ADONIS 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 ADONIS Administration on the Tokens tab. Copy the 512 characters long key directly from the ADONIS 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 ADONIS Administration in the Client Data form.
Client Secret (encrypted): Enter the Secret to use for client authentication that you specified in the ADONIS 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 ADONIS Administration in the Client Data form.
Scope: Enter the name of the Scope that you specified in the ADONIS 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 ADOIT and ADONIS via the Integration Framework. During periodic synchronisation, BPM elements are imported from ADONIS into ADOIT. 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.
Objects can only be transmitted in one language.
Constants
Edit the following settings on this tab:
anpRepositoryID: The ID of the repository in ADONIS that holds the objects that should be imported into ADOIT.
importFolderPath: The name of the object group in ADOIT 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 ADOIT that contains objects that could not be deleted.
In general, imported objects are deleted during synchronisation if they have been removed from ADONIS in the meantime.
However, if relations have been added to the imported objects in ADOIT, or they are being used in models in ADOIT, they are not deleted. They will be moved to the "Obsolete objects" folder instead.An exception to this rule are the RACI relations Responsible, Accountable, Consulted and Informed business actors. Although relations of this type were added in ADOIT, imported objects will be deleted anyway.
- pageSize: The number of objects that are imported from ADONIS at once.
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 ADOIT 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 ADONIS.
Import System Role
To import the Management Office Integration system role in the ADOIT Administration:
Go to System Roles > More options, and then click Import system roles.
Click Browse and select the system roles file. The respective file
<date> - <library name> - MOI Role.axrcan be found in the folder “04 Sample Data/Roles“ in the installation package (in the subfolder "archimate" or "standard", depending on your Application Library). You can also drag the file from your computer to the Drag and drop files here to upload area. Then, click Next.Select the system role Management Office Integration. Then, click Next.
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 ADOIT Administration:
Go to the System Roles page.
In the System roles catalogue on the left side, select the Management Office Integration system role.
Click Add members and add user groups or individual users from the user catalogue. Then, click Add.
Click Save.
The users are assigned.
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:
ArchiMate Application Library:
- users are not allowed to create Business Processes and Business Actors, and only have read access to their attributes
Special Case: Import EA Workflow Configuration for MOI
Import the EA Workflow configuration for MOI in the ADOIT Administration now if the following conditions apply:
you want to import Processes and Roles from ADONIS into ADOIT
you are using the default libraries delivered with the product
the default configuration of the EA Workflow is enabled in ADOIT
This enables Processes and Roles to be imported from ADONIS to ADOIT. In the EA Workflow configuration for MOI, the release workflow for the corresponding classes is deactivated:
ArchiMate Application Library:
- EA Workflow deactivated for Business Processes and Business Actors
Are you using a default configuration of the EA Workflow which has been adapted (additional states or system roles etc.) or another specific configuration? Please contact your BOC consultant. They will help you get a new EA Workflow configuration.
To import the release workflow configuration for MOI in the ADOIT Administration:
Go to Settings > More options, and then click Import settings.
Click Browse and select the configuration file. The respective file
RWF … config for MOI.axscan be found in the folder “04 Sample Data/Component Settings/MOI“ in the installation package. Click Import. You can also drag the file from your computer to the Drag and drop files here to upload area.Select the EA Workflow setting. Then, 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.
Set up Access to the Synchronisation of Objects for Users
By assigning two modules in the ADOIT Administration, you can provide the right people access to the synchronisation features in ADOIT:
Go to Settings > System settings > Modules.
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 ADONIS in ADOIT.
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 ADOIT 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 ADOIT. The ADOIT 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 ADOIT supports, you can edit the name of the template as well as the description which characterises the template.
Model Time Filter
In the graphical editor, users can enable the model time filter to filter objects within the currently opened model based on their validity period. You can configure which object types the filter should apply to.
Open Model Time Filter Settings
To open the model time filter settings:
- Go to Settings > Model Time Filter > Model Time Filter.
Configure Model Time Filter
You can adjust the following settings:
Classes that are filtered
Select the object types to which the model time filter should be applied.
Organisation Portal
The Organisation Portal allows employees of your organisation easy and intuitive access to the models in the ADOIT 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.
The Organisation Portal is read-only. Users have no write access to repository content (including all models and objects and their relations).
The availability of the Organisation Portal depends on the licence.
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:
Create the following top level user group:
- Reader
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"
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.
Assign the following preconfigured system role to the newly created user group:
- Organisation Portal
By default, the system role 'Organisation Portal' has access to the following modules only:
- Standard Organisation Portal
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.
The ADOIT 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:
These pages are discussed in more detail in the following sections.
The ADOIT 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.
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 ADOIT 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 ADOIT 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 ADOIT 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 ADOIT login page.
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.
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/ADOIT17_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.
Additionally, in case of the Default user for anonymous access (see above), the start model configured here will also be displayed on the "Read & Explore" scenario start page (ArchiMate Application Library only).
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 ADOIT login page is not displayed and the menu entry Organisation Portal from the dropdown menu for scenario selection in ADOIT 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 ADOIT, 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
Explore the implications of not configuring a start model for the Organisation Portal. 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 "Architecture Diagrams" section will appear as the start page.
In the "Read & Explore" scenario, the "Home" section will still be the start page. Only the Recently opened, Favourites and My Objects lists are shown on the start page.
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 ADOIT Administration:
Go to Authentication > More options, and then click Security Settings.
Switch to the Org Portal IP Restrictions tab.
Adapt the following setting:
Org Portal IP Restrictions
This setting is optional. You can restrict the IP addresses that are allowed to access the Organisation Portal (see Configure IP Restrictions for more information).
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:
Click the Add filter button.
In the Language independent name box, type a name for the property filter. This language-independent name uniquely identifies the filter.
In the Display name area, type a name for every language ADOIT supports. These names are visible on the user interface.
In the Order area, select the order of the entries when a user selects a property filter in ADOIT.
In the System role assignment area, select the system roles to which you want to assign this filter.
In the Scenario assignment area, select the scenarios to which you want to assign this filter.
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.
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.
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 ADOIT. 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.
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.
Radar
Radar charts in ADOIT visualise objects of a specific class in a circular chart divided into segments and rings, with attributes dictating the position of the objects in the chart.
Templates for radar charts need to be configured in web clientADOIT. The ADOIT Administration only provides limited settings for these templates.
Open and Edit Matrix Chart Template
Go to Settings > Radar, and select the template you want.
For every language ADOIT supports, you can edit the name of the template as well as the description which characterises the template.
REST API
ADOIT 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 ADOIT for data.
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:
Create Technical User (OAuth 2.0 using the Client Credentials Flow and token based authentication only)
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.
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.
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 ADOIT Administration:
Go to the Users page and click New User.
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.
Next, go to the Groups and roles tab:
- Under User groups, click Select user groups and assign the user to the Default group.
Next, go to the Repository tab:
- Click Select repository and only (!) assign the repository to the user which holds the data to be queried.
Click Create to complete the user creation process.
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 ADOIT Administration
If you want to use user write APIs, you must assign access rights to the ADOIT Administration to the user in whose context requests should be executed.
This can either be the technical user (for OAuth 2.0 authentication using the Client Credentials Flow and token based authentication) or any ADOIT user (for basic authentication, OAuth 2.0 authentication using the Authorization Code Flow and JWT authentication).
To assign access rights to the ADOIT Administration:
Go to the Rights page.
In the Users / Groups catalogue on the left, select the user to whom you want to grant access rights to the ADOIT Administration.
Go to the Components tab.
In the workspace, find the "Administration Toolkit" component.
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 ADOIT in the ADOIT Administration. To edit the System settings:
Go to Settings > System settings > System.
In the Base URL field, enter the URL where ADOIT can be reached from other machines.
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).
Click Save.
Base URL Example
You are configuring ADOIT 17.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/ADOIT17_0"
Configure General Settings
Now the general settings for the REST API settings have to be adapted in the ADOIT Administration:
- Go to Settings > Standard RESTful Services > General.
These settings apply to all authentication methods:
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 ADOIT.
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 ADOIT).
Configure Settings for Basic Authentication
To configure basic authentication for the REST API in the ADOIT Administration:
Go to Settings > Standard RESTful Services > General.
Edit the settings on the Basic Auth tab.
The following settings are available:
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.
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 ADOIT
For security reasons, basic authentication is turned off by default in ADOIT. If you want to use the REST API with basic authentication, you need to adapt the Security settings in the ADOIT Administration:
Go to Authentication > More options, and then click Security Settings.
Switch to the REST tab.
Adapt the following settings:
Basicauth IP Restrictions
Specify the IP addresses that shall be allowed to send requests with basic authentication to the REST API (see Configure IP Restrictions for more information).
Basicauth Roles
This setting is optional. Select system roles that a user must have at least one of in order to use the ADOIT REST API with basic authentication. If no system role is selected, all system roles will allow access to the API.
No restart is required when modifying these settings.
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 ADOIT).
Configure Settings for OAuth 2.0
To configure OAuth 2.0 authentication for the REST API in the ADOIT Administration:
Go to Settings > Standard RESTful Services > General.
Edit the settings on the OAuth 2.0 tab.
The following settings are available:
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.
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. ADOIT 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
ADOIT 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. Here's how the configuration works:
An IP constraint consists of a comma separated list of rules.
A rule consists of a keyword ('allow' or 'deny') followed by a white space, and an IP address or address with wild card * (e.g. 192.168.*). The keyword "all" can be used to match all addresses.
If rules are present, but no match is made, the default setting is "deny".
If no rules are present, the default setting is "allow".
The first matching rule decides. E.g. when you formulate a constraint like "allow 192.*, deny 192.168.0.1", the 'deny' rule would have no effect, as that address matches the 'allow' rule already.
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 ADOIT
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 ADOIT Administration:
- Go to Authentication > OAuth 2.0.
The necessary settings are described below.
Enable OAuth 2.0 Authentication for ADOIT
For security reasons, OAuth 2.0 authentication is turned off by default in ADOIT. To enable OAuth 2.0 authentication:
- Select Enabled.
Add and Configure Client
Next, you will need to add a new client:
- Click Create to add a new client. The Client box appears.
Adapt the following parameters:
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.
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: Upload a logo to represent the client application. 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.
Back on the OAuth 2.0 page, click Save. Now you can call the REST API with OAuth 2.0 authentication.
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 ADOIT).
Configure Settings for JWT Authentication
To configure JWT authentication for the REST API in the ADOIT Administration:
Go to Settings > Standard RESTful Services > General.
Edit the settings on the JWT tab.
The following settings are available:
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.
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 ADOIT
To configure the ADOIT REST API to accept a JSON Web Token (JWT) from an Identity Provider (IdP) for authentication, you need to adjust settings in the ADOIT Administration:
- Go to Authentication > JWT.
The necessary settings are described below.
Enable JWT Authentication for ADOIT
For security reasons, JWT authentication is turned off by default in ADOIT. To enable JWT authentication:
- Select Enabled.
Create JWT Configuration
Next, you will need to add a new JWT configuration and edit the properties to match your token:
- Click Create to add a new configuration. The Create JWT configuration box appears.
Adapt the following parameters:
Name
Represents the identifier of this configuration.
Claim validation
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).
Signature validation
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.
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.
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.
User mapping claim
A claim that needs to be contained in the payload of the token. This claim identifies the user you wish to authenticate. The value of this claim must match the user name of a user in ADOIT (must have Trusted Login).
Back on the JWT page, click Save. 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 ADOIT Administration:
Go to Settings > Standard RESTful Services > General.
Edit the settings on the Tokens tab.
The following settings are available:
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
ADOIT 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.
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
ADOIT 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 ADOIT 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 ADOIT 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. ADOIT 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.
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 ADOIT:
Active Features
The settings for active features impact the fundamental behaviour of ADOIT.
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 ADOIT.
Allow creation of new objects
Select this option to allow creating new objects in ADOIT 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 ADOIT via the catalogue.
Allow creation of object groups
Select this option to allow creating new object groups in ADOIT via the catalogue.
Allow moving elements in the catalogue
Select this option to allow ADOIT 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 ADOIT via the catalogue or via relations controls.
Allow models of same type and with same name
Select this option to allow ADOIT 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 ADOIT 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 ADOIT.
Show objects in the catalogue
Select this option to show objects in the catalogue of ADOIT.
Enable collaboration component
Select this option to allow using the collaboration component in ADOIT.
Enable dependency analyser component
Select this option to allow using the dependency modeller component in ADOIT. Additional configuration steps may be needed.
Enable favourites component
Select this option to allow using favourites in ADOIT.
Enable translation component
Select this option to allow using the translation component in ADOIT.
Enable file upload to DMS
Select this option to allow importing external files into the database in ADOIT.
Enable graphical model comparison
Select this option to allow using the graphical model comparison in ADOIT.
Enable change password
Select this option to allow changing the password in ADOIT.
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 ADOIT 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 ADOIT.
Activate highlighting for relations
Select this option to highlight the relation with the highest priority when creating relations in ADOIT. When you clear this option, no relation is highlighted.
The ADOIT application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.
Email
ADOIT 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.
Before it is possible to send email notifications, the Base URL has to be configured correctly.
The ADOIT 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 ADOIT send emails?
ADOIT sends emails in the following situations:
When someone shares a model, an object etc. directly from ADOIT with colleagues.
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.
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 ADOIT administrator, you can configure a variety of full-text search settings for ADOIT.
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 ADOIT (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 ADOIT, 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 ownerFor 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.
The ADOIT 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 ADOIT. This tool makes the differences between two models visible, showing deleted and new objects and connectors, as well as changes in attributes.
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.
The ADOIT 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 ADOIT and other settings. Most of these settings can be overridden by individual users of ADOIT 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 ADOIT draw right-angled connectors
automatically. Clear this
option to make ADOIT draw straight connectors
instead.Show bridges if connectors cross
Make ADOIT 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).
The ArchiMate Application Library does not contain any aggregations.
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 ADOIT users to change the modelling direction for a specific model in the graphical editor. The objects on the drawing area are automatically rearranged.
When using the Hover Modelling Assistant in ADOIT, the modelling direction determines where the next object is placed:
Horizontal: To the right of the selected object
Vertical: Below the selected object
The ADOIT 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 ADOIT. 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.
The ADOIT 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 ADOIT. 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.
The ADOIT 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 ADOIT.
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.
If you are using the ArchiMate Application Library, the default page layout for printing models to PDF is defined directly in the metamodel and this setting is not evaluated. This setting is however still evaluated as a default setting for creating reports.
ADOIT 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.
For more information about PDF/A, please visit https://www.pdfa.org/pdfa-faq/. PDF/A documents generated in ADOIT 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 ADOIT administrator to define technical settings controlling the base functionality of ADOIT.
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 ADOIT can be reached from other machines: "http://<SERVER_NAME>:<TOMCAT_PORT>/ADOIT17_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 ADOIT) 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 ADOIT, 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 userRemove technical users if they are no longer needed.
The ADOIT application server has to be restarted if these settings are changed. Otherwise the changes will not become effective.
Time Filter
The time filter allows users to globally filter objects in ADOIT based on their validity period. You can configure for which system roles the filter should be activated by default.
Open Time Filter Settings
To open the time filter settings:
- Go to Settings > Time Filter > General.
Configure Time Filter
The following settings are available:
System Roles
Select the system roles for which the time filter is activated by default.
When users with these system roles log in to the web client, the time filter is set to the current date. Only objects which are currently valid will be visible.
Users can then set the time filter to a different date or disable it completely. When they log in the next time, the time filter will be enabled again.
When a user has multiple system roles, the time filter will be active if this setting is enabled for at least one system role.
Validation
The validation functions in ADOIT allow ADOIT users to check whether models and objects comply to the modelling guidelines. If the modelling guidelines are violated, ADOIT shows corresponding notifications.
ADOIT provides the following types of checks:
Error,
Warning and
InformationThese are programmatic checks that ensure syntactic correctness and proper usage of elements in modelling. Only ADOIT product developers and customisers can create new checks of these types. However, as an ADOIT 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.
ToDoThese checks serve as reminders for users to manually review and confirm certain conditions. ADOIT 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:
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 ADOIT supports, you can edit the name of the check as well as the text and the hint that are displayed in the notification.
Modifying the type is limited to predefined checks provided with ADOIT. 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.
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 ADOIT 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.
After you have completed these settings, click Save. The validation settings are saved in the database and immediately available in ADOIT.
Workspaces
In this area, you can manage the following workspace settings:
Application Investment Planning
Customise the surveys for assessing application fitness levels within Application Investment Planning workspaces.
Choose the default object group for newly created workspaces.
Application Investment Planning
Customise the surveys for assessing application fitness levels within Application Investment Planning workspaces. You can create, modify, or remove questions and answers, adjust their placement, and more.
Open Survey Questions
To open the survey questions:
- Go to Settings > Workspaces > Application Investment Planning > Survey.
Configure Survey Questions
Select either the Business Fitness or Technical Fitness tab, depending on which survey you want to adjust. Then take a look at the questions and answers.
The following options are available:
Add Question
Click Add Question to add a new question to the survey. Enter the question you want to ask (at least current language and primary language are required). Optionally, provide an info text explaining the question as well. New questions will be added at the bottom of the list, in the order you created them. Be aware that you cannot save as long as there are questions with no answers created yet.
View Answers
Expand a question to reveal and modify its answers.
Add Answers to Questions
Every question requires two to four answer choices. Click Add Answer to add a new answer to a question. Enter the answer (at least current language and primary language are required). Optionally, provide an info text explaining the answer as well. Then, in the Score column, select the score if this answer is selected in the survey:
For questions with four possible answers, the score is 1-4.
For questions with three possible answers, the score is 1-3.
For questions with two possible answers, the score is either 1 or 4.
Edit Question or Answer
To the right of the question or answer, click
More, and then click Edit
Text.Delete Question or Answer
To the right of the question or answer, click
More, and then click Delete
Question/Answer.Change Order
Use the drag handle (
) to drag a
question or answer to a new position.
Settings
Choose the default object group for newly created workspaces.
Open and Configure Workspace Settings
Go to Settings > Workspaces > Settings > General.
Under Object group folders, select the object group where new workspaces will be automatically placed.