Skip to main content
Version: 11.0

Architecture#

Architecture

Abstract#

ADONIS NP Web ClientWeb browser that is used to access the ADONIS NP web server. ADONIS NP supports the following desktop browsers: Internet Explorer 11, Microsoft Edge, Mozilla Firefox and Google Chrome on Windows and Safari 9 or higher on the Mac. In addition, ADONIS NP supports Safari on the iPad (iOS 8 or higher).
ADONIS NP Web ServerWeb server (platform independent) that is necessary for the communication between ADONIS NP web client and ADONIS NP application server.
ADONIS NP Application ServerThe ADONIS NP application server (requires MS Windows) is responsible for the access to the ADONIS NP database and it contains the functionality of the ADONIS NP web scenario. Starts one or more aworker processes.
ADONIS NP DatabaseDatabase server (platform independent) that manages and stores the ADONIS NP data. ADONIS NP supports Microsoft SQL Server and Oracle.
ADONIS NP Administration ToolkitThe Administration Toolkit is a desktop application used by ADONIS NP administrators for administrative tasks such as creating users or assigning rights.

Installation Options#

Installation Option 1#

ADONIS NP web server and ADONIS NP application server are running on one server (Standard installation).

Installation Option 1

Installation Option 2#

ADONIS NP web server on one server, ADONIS NP application server is running on another server.

Installation Option 2

Installation Option 3 (Load Balancing)#

ADONIS NP web server on one server, ADONIS NP application server is running on another server. Multiple ADONIS NP application servers (running on one or more machines) may be used in large scenarios where workload has to be distributed.

note

Load Balancing is currently only supported at the level of the ADONIS NP application server. Load Balancing is NOT supported at the level of the ADONIS NP web server.

Installation Option 3

Software Requirements#

ADONIS NP Web Client#

BrowserDesktop Browser:
  • Internet Explorer 11 on Windows
  • Microsoft Edge (latest) on Windows
  • Mozilla Firefox (latest) on Windows
  • Google Chrome (latest) on Windows
  • Safari 9 or higher on the Mac
Mobile Browser:
  • Safari on the iPad (iOS 8 or higher; graphical modelling is not supported on the iPad)

Server Component ADONIS NP Web Server#

Operating systems
  • According to the specifications of Apache Tomcat
Java Version
Web Server
  • Apache Tomcat Version 8/9 or comparable Java servlet containers that support the Java Servlet API specification of version 2.5.
  • Other server types are not tested. A specific evaluation can be done on request.
Supported protocols
  • HTTP, HTTPS for communication between web browser and web server

Server Component ADONIS NP Application Server#

Operating systems
(64-Bit)
  • Windows 8.1
  • Windows 10
  • Windows Server 2012
  • Windows Server 2012 R2
  • Windows Server 2016
  • Windows Server 2019
Supported database management systems
  • Microsoft SQL Server ODBC Driver compatible with the SQL Server version used
  • Oracle client compatible with the Oracle server version used
Note: For Oracle at least an Oracle Instant Client 'Basic' is required, the usage of an Oracle Runtime Client is recommended.
Supported protocols
  • Thrift for communication between web server and application server

DB Server (if necessary on another machine)#

Operating systems
  • All supported operating systems of the chosen database system, if they can be accessed from Windows clients with Call Level Interfaces (ORACLE: OCI) or ODBC (Microsoft SQL Server).
Supported database management systemsMicrosoft SQL Server:
  • SQL Server 2012
  • SQL Server 2014
  • SQL Server 2016
  • SQL Server 2017
  • SQL Server 2019
(Enterprise Edition, Standard Edition, Workgroup Edition, Express Edition)
Note: SQL Server Express edition is not recommended for production use.

Oracle Database
  • Oracle 12c Release 1 or 2
  • Oracle 18c
  • Oracle 19c
(Standard Edition One, Standard Edition, Enterprise Edition, Express Edition)
Note: When using an Oracle Database Express Edition, functionality and performance restrictions must be considered in regard to the particular operating scenario.

Additional Optional Server Components#

SMTP Server
  • The ADONIS NP web client supports sending of email messages in specified scenarios.
  • To use this functionality an SMTP server is required that can be accessed from the ADONIS NP web server. The address and port are configurable in the Administration Toolkit.
  • SMTP Authentication and Transport Layer Security (TLS) are supported.

ADONIS NP Administration Toolkit#

Operating systems
(64-Bit)
  • Windows 8.1
  • Windows 10
  • Windows Server 2012
  • Windows Server 2012 R2
  • Windows Server 2016
  • Windows Server 2019
Supported database management systems
  • Microsoft SQL Server ODBC Driver compatible with the SQL Server version used
  • Oracle client compatible with the Oracle server version used
Note: For Oracle at least an Oracle Instant Client 'Basic' is required, the usage of an Oracle Runtime Client is recommended.

For the various third-party software packages mentioned in the sections above the hardware and software requirements of the individual vendors have to be considered!

Hardware Requirements#

ADONIS NP Web Client#

RAM
  • Minimum: 1 GB
  • Recommended: 2 GB or higher
Processor
  • Minimum: Intel Pentium D / comparable processor
  • Recommended: Intel Core i7 / comparable processor or higher
Clock speed
  • Minimum: 1 GHz
  • Recommended: 2 GHz or higher
Screen resolution
  • Minimum: 1024 x 768
  • Recommended: 1366 x 768 or higher
Colour depth
  • Minimum: 65.536 colours / 16 Bit
  • Recommended: 16M colours / 32 Bit or higher

Server Component ADONIS NP Web Server#

Hard disk capacity
  • According to the requirements of the used Apache Tomcat version (or comparable environment)
  • Additionally, 250 MB free hard disk capacity for the installation of the web application
RAM
  • A minimum of 2 GB is required by ADONIS NP in use with an Apache Tomcat web server.
  • Recommended: 4 GB or higher
  • Additional system resources according to the environment (size of the database, number of users)
Processor/Clock speed
  • Minimum: 2.5 GHz
  • Recommended: latest generation server processor with 3.5 GHz or higher

Server Component ADONIS NP Application Server#

Hard disk capacity
  • At least 1 GB of disk space for the installation directory
  • Write permissions to the installation directory are necessary.
RAM
  • Minimum: 2 GB for the ADONIS NP application server service
  • Recommended: 4 GB or higher
  • Additional system resources according to the environment (size of the database, number of users)
Processor/Clock speed
  • Minimum: 2.5 GHz
  • Recommended: latest generation server processor with 3.5 GHz or higher

DB Server (if necessary on another machine)#

Hard disk capacity
  • Minimum: According to the specifications of the DBMS manufacturer
  • Recommended: 2 GB per ADONIS NP database instance. This value depends on the size of the stored data and may be higher
RAM
  • Minimum: 500 MB are required for the first ADONIS NP database instance; another 500 MB are required for each additional database instance;
  • Recommended: Depending on the amount of stored data it might be necessary to provide more memory for the database instance.
Processor/Clock speed
  • Minimum: According to the specifications of the DBMS manufacturer
  • Recommended: 2 GHz or higher

ADONIS NP Administration Toolkit#

Hard disk capacity
  • At least 1 GB of disk space for the installation directory
  • Write permissions to the installation directory are necessary.
RAM
  • Minimum: 1 GB
  • Recommended: 2 GB or higher
Processor/Clock speed
  • Minimum: 2.5 GHz
  • Recommended: 3.5 GHz or higher
Screen resolution
  • Minimum: 1024 x 768
  • Recommended: 1366 x 768 or higher
Colour depth
  • Minimum: 65.536 colours / 16 Bit
  • Recommended: 16M colours / 32 Bit or higher

Network Requirements#

The ADONIS NP web server, the ADONIS NP application server and the DB server must be located in the same LAN (local area network). The IP address of the ADONIS NP web server and that of the ADONIS NP application server must be in the same network segment.

The bandwidth requirements between the individual components are listed below:

ADONIS NP Web Client – ADONIS NP Web Server
  • Minimum: 2 Mbit
  • Recommended: 10 Mbit
ADONIS NP Web Server – ADONIS NP Application Server
  • Minimum: 10 Mbit
  • Recommended: 100 Mbit
  • LAN-like latency
ADONIS NP Application Server – DB Server
  • Minimum: 100 Mbit
  • Recommended: 1 Gbit
  • LAN-like latency
ADONIS NP Administration Toolkit – DB Server
  • Minimum: 2 Mbit
  • Recommended: 10 Mbit
  • LAN-like latency

Authentication Mechanisms of the ADONIS NP Web Client#

This section describes the different authentication mechanisms of the ADONIS NP web client. The authentication mechanisms can be used separately or in combination. Depending on the used authentication mechanisms, further installation-specific configuration steps may be necessary. Please consult your ADONIS NP consultant for further information.

Authentication Mechanisms#

Standard ADONIS NP users
  • ADONIS NP users are created in the Administration Toolkit.
  • Login to the ADONIS NP web client requires input of username and password. These credentials are used to authenticate the user against the available data in the ADONIS NP database.
  • The assignment of user attributes, rights and system roles is controlled via the User Management component in the Administration Toolkit.
LDAP Authentication
  • Users can either be imported from a directory service or mapped to ADONIS NP users.
  • Login to the ADONIS NP web client requires input of username and password. The provided credentials will be used to authenticate the user against the configured directory service.
  • A precondition for this scenario is that the connection of ADONIS NP to the directory service in use (e.g. Active Directory) is established on the Admin Page.
  • The assignment of user attributes, rights and system roles may be controlled via the User Management component in the Administration Toolkit or synchronised with an external directory service.
  • Specific configuration steps are necessary when setting up the ADONIS NP web client for this authentication mechanism. Please consult your ADONIS NP consultant for further information about this authentication mechanism.
IDM Authentication
  • Users can either be imported from an external user management system or mapped to ADONIS NP users.
  • Login to the ADONIS NP web client via single sign-on is possible using an Identity Management System (IDM)
  • A precondition for this scenario is the connection of ADONIS NP to an authentication server in the target environment which provides means for authentication with an external user management system (e.g. Microsoft Internet Information Services connected to an Active Directory).
  • The assignment of user attributes, rights and system roles may be controlled via the User Management component in the Administration Toolkit or synchronised with an external user management system.
  • Specific configuration steps are necessary when setting up the ADONIS NP web client for this authentication mechanism. Please consult your ADONIS NP consultant for further information about this authentication mechanism.
SAML Authentication
  • Users can either be imported from an external user management system or mapped to ADONIS NP users.
  • The external user management system must provide an Identity Provider (IdP) for SAML 2.0 (e.g. Active Directory Federation Services [AD FS] or Shibboleth).
  • To log on to the ADONIS NP web client, the user is redirected to the IdP. Depending on the configuration of the IdP, the authentication is carried out via single sign-on or by entering access data (username and password, certificates, etc.).
  • No server-to-server communication is necessary for this authentication mechanism, since all data is transmitted via the browser.
  • The assignment of user attributes, rights and system roles may be controlled via the User Management component in the Administration Toolkit or synchronised with an external user management system.
  • Specific configuration steps are necessary when setting up the ADONIS NP web client for this authentication mechanism. Please consult your ADONIS NP consultant for further information about this authentication mechanism.

LDAP Support (Web Client)#

  • LDAP/LDAPS support for the providers AD (Active Directory) and eDirectory and comparable LDAP providers.
  • Other LDAP providers are not tested. A specific evaluation can be done on request.

Feature Overview#

This table contains a summary of the features of the different authentication mechanisms.

Standard ADONIS NP UsersLDAP AuthenticationIDM AuthenticationSAML Authentication
Login with username and passwordYesYesYes (depending on the IDM solution)Yes (depending on the SAML IdP)
SSONoNoYes (depending on the IDM solution)Yes (depending on the SAML IdP)
On login, synchronize attributes, role and group assignment (with external user management system)NoYesYesYes
Periodically, synchronize attributes, role and group assignment (with external user management system)NoYesYes (with LDAP coupling)Yes (with LDAP coupling)
Create users automaticallyNoYesYesYes

Server Hardware Recommendations#

Based on example scenarios, this section describes which hardware requirements the servers in the ADONIS NP web scenario must meet. If your scenario is different from the presented options, please consult your ADONIS NP consultant at BOC.

note

The following requirements are for ADONIS NP only.

1. Standard Scenario#

Description
  • This scenario includes a model repository of 1,000 models with a medium average model size (up to 40 objects and relations per model).
  • There are a maximum of 5 concurrent ADONIS NP users.
  • Load balancing is not required in a scenario of this size.
Number of CPU cores (virtual)
  • ADONIS NP web server: 2 CPU cores
  • ADONIS NP application server: 3 CPU cores
RAM
  • ADONIS NP web server: 3 GB total
  • ADONIS NP application server: 4 GB total
Hard disk capacity
  • ADONIS NP web server: 1 GB total
  • ADONIS NP application server: 3 GB total
  • DB server: 2 GB total

2. Load Balancing Scenario#

Description
  • This scenario includes a model repository of 1,000 models with a medium average model size (up to 40 objects and relations per model).
  • There are a maximum of 20 concurrent ADONIS NP users.
  • Load Balancing is currently only supported at the level of the ADONIS NP application server. Load Balancing is NOT supported at the level of the ADONIS NP web server.
Number of CPU cores (virtual)
  • ADONIS NP web server: 3 CPU cores
  • ADONIS NP application server: 4 CPU cores
RAM
  • ADONIS NP web server: 4 GB total
  • ADONIS NP application server: 5 GB total
Hard disk capacity
  • ADONIS NP web server: 1 GB total
  • ADONIS NP application server: 4 GB total
  • DB server: 2 GB total

Required Permissions#

Server-Component ADONIS NP Web Server#

Required permissionsThe user running the Apache Tomcat web server service needs:
  • Write permissions to the temporary directory (%TEMP%)
  • Write permissions to the ADONIS NP web application directory within "<Tomcat installation>/webapps" and all its subdirectories
  • Write permissions to the directory in which the log files are configured to be written. By default, the logging output is written to the folder "<Tomcat installation>/logs"
  • Read permissions to the Apache Tomcat installation directory

Server-Component ADONIS NP Application Server#

Required permissionsThe user running the ADONIS NP application server service needs:
  • Write permissions to the temporary directory (%TEMP%)
  • Write permissions to the directory in which the log files are configured to be written. By default, the logging output is written to the folder "<ADONIS NP installation>/logs"
  • Read and execute permissions to the ADONIS NP application server installation directory

ADONIS NP Administrations-Toolkit#

Required permissionsA user running the ADONIS NP Administration Toolkit needs:
  • Write permissions to the temporary directory (%TEMP%)
  • Read and execute permissions to the ADONIS NP installation directory

Required permissions – Citrix-Server#

A Windows user requires the access permissions stated below in order to run ADONIS NP. In a standard Windows environment these permissions are usually given, but in a Citrix environment it may be necessary to explicitly set these permissions.

Citrix Server#

Required permissions
  • Execution permission in the ADONIS NP installation directory
  • Execution and write permissions to the target directory of each export (AXL, XML, AXS, HTML, PDF, etc.)
  • Execution and write permissions to the temporary PDF output directory
  • Execution and write permissions to the temporary directory (%TEMP%)
  • Execution permissions to the application data directory (%APPDATA%)
  • Write permissions to the temporary directory of the user profile from the command line