Prerequisites for ADITO Designer
Overview
ADITO Designer is ADITO’s modular development environment based on NetBeans. You use it to implement customer-specific customizations for ADITO.
Customizations are implemented with JDito, an ADITO-specific scripting language based on JavaScript. JDito runs on Rhino and is extended with ADITO modules and system methods.
ADITO projects are copied into a local project structure managed by ADITO Designer. You transfer changes to the system database using the deploy mechanism.
Local Project Storage
By default, ADITO projects are stored in the following directory on Windows:
C:\Users\<username>\Documents\AditoProjects
Installation and Working Directory
Installation Package
ADITO Designer is provided as a ZIP archive. You can extract it to any directory, for example under a program files folder.
A separate installation guide exists for installing the Designer, configuring GitLab access, and loading a cloud system. This information is referenced in the PDF but not included in its content.
Working Directory for Caches and Tools
ADITO Designer requires a writable working directory for caches, configuration data (including stored passwords/keyrings), plugins, and automatically downloaded libraries such as NodeJS and TypeScript. The default location is:
C:\Users\<username>\AppData\Roaming\.aditodesigner\
You can change this path in ADITOdesigner.conf located in the config folder.
Resetting a Broken Local State
If ADITO Designer enters a faulty state, you can close the application, delete the .aditodesigner directory, and start the Designer again. The application will then start in its original delivery state.
Working with Cloud Systems
ADITO Cloud systems are customized via a tunnel-based connection configured in ADITO Designer. After the SSH tunnel is established, the development process is almost the same as with local systems. This approach avoids the need for a local ADITO system installation and a local ADITO SQL database.
Proxy Environments
To use ADITO Designer behind a proxy, you need an HTTP or HTTPS proxy. A SOCKSv5 proxy can be used optionally. If authentication is required, the proxy must support Basic authentication with identical credentials; other authentication methods are currently not supported.
Typically, no proxy configuration is required in ADITO Designer if the proxy is configured correctly on the customer system. In that case, the Designer setting can remain on “Use default proxy settings”.
npm-install does not support proxy usage by default and must be configured accordingly.
Required Network Access
ADITO Designer requires outbound internet access for the components and workflows described in this section.
SSH Tunnel to ADITO Cloud System
ADITO Designer establishes an SSH connection to the central ADITO Cloud gateway using TCP port 22. The gateway forwards the traffic to the selected cloud system. The target server address is provided to ADITO Designer through the tunnelconfig.xml that belongs to the cloud system and is downloaded automatically when you load the cloud system.
Additional Required Endpoints
The following table provides a concise overview of all external endpoints that may be required when working with the ADITO Designer.
| Purpose | Endpoint | Ports | Mandatory |
|---|---|---|---|
| ADITO Designer Plugins | aditopluginsonline.adito.de | 443 (HTTPS) | Yes |
| Node.js Distribution | nodejs.org | 443 (HTTPS) | Yes |
| Git Repositories | gitlab.adito.de | 443 (HTTPS), 22 (SSH) | Conditional |
| NPM Public Registry | registry.npmjs.com | 443 (HTTPS) | Conditional |
| (Legacy) Artifact Repository | nexus.adito.cloud | 443 (HTTPS) | Conditional |
| Cloud Services | ssp.adito.cloud | 443 (HTTPS) | Optional |
| YAML Schema Repository | releases.adito.cloud | 443 (HTTPS) | Not required (experimental) |
ADITO Designer Plugin Repository
| Aspect | Description |
|---|---|
| Endpoint | https://aditopluginsonline.adito.de/ |
| Purpose | Provides plugins required for correct functionality and stability of ADITO Designer. |
| Data Types | Text and binary plugin artifacts, mainly *.nbm, *.jar, and *.xml. |
| Time of Access | During ADITO Designer startup and periodically at runtime. |
| Impact if Blocked | Reduced functionality and stability; development may still be possible. |
| Requirement | Mandatory |
Blocking this endpoint can lead to unsupported and unstable ADITO Designer installations.
Node.js Distribution Server
| Aspect | Description |
|---|---|
| Endpoint | https://nodejs.org/dist/ |
| Purpose | Provides Node.js binaries required for modularization and javascript features. |
| Time of Access | Typically during ADITO Designer startup. |
| Impact if Blocked | Development is not (really) possible because of the unavailability of extended javascript features |
| Requirement | Mandatory |
Blocking this endpoint will lead to incomplete modularization functionality and unavailable javascript features (like autocompletion).
ADITO Git Repositories
| Aspect | Description |
|---|---|
| Endpoint | https://gitlab.adito.de/ |
| Purpose | Hosts source code repositories and related build artifacts. |
| Connectivity | HTTPS (443) and optionally SSH (22), depending on repository configuration. |
| Time of Access | During normal development workflows such as pull, push, or build execution. |
| Impact if Blocked | Development is not possible if the project is hosted on ADITO GitLab. |
| Requirement | Conditional |
NPM Public Registry
| Aspect | Description |
|---|---|
| Endpoint | https://registry.npmjs.org/ |
| Purpose | Provides public NPM packages used by ADITO and project-specific modularization features. |
| Data Types | JavaScript packages and metadata retrieved via HTTPS. |
| Time of Access | During runtime when build or install actions such as npm install are executed. |
| Impact if Blocked | Development is not possible when modularization features or external NPM libraries are used. |
| Requirement | Conditional |
This endpoint is required for most new projects, as they typically rely on modularization features and external NPM dependencies.
Legacy NPM Artifact Repository
| Aspect | Description |
|---|---|
| Endpoint | https://nexus.adito.cloud/repository/xrm/ |
| Purpose | Hosts legacy ADITO artifacts required by older projects. |
| Time of Access | During runtime when build actions such as npm install are executed. |
| Impact if Blocked | Development is not possible if required artifacts are stored here. |
| Requirement | Conditional |
ADITO Cloud Services
| Aspect | Description |
|---|---|
| Endpoint | https://ssp.adito.cloud/ |
| Purpose | Enables cloud-related features such as logging and diagnostics. |
| Time of Access | At any time during ADITO Designer runtime. |
| Impact if Blocked | Reduced usability; core development remains possible. |
| Requirement | Optional |
YAML Schema Repository (Experimental)
| Aspect | Description |
|---|---|
| Endpoint | https://releases.adito.cloud/ |
| Purpose | Provides JSON Schemas used for YAML-based configuration and validation. |
| Data Types | JSON Schema definitions retrieved via HTTPS. |
| Time of Access | During ADITO Designer runtime when experimental YAML features are enabled. |
| Impact if Blocked | No impact for current production usage. |
| Requirement | Not required |
Optional: Automatic Translation of Language Keys
The supported providers include DeepL (https://www.deepl.com/de/translator), the Google Cloud Translation API (REST), and Yandex Translate (https://translate.yandex.com/).