# Environment Variables

Important

The environment variables mentioned below are defined per user session. Different user sessions may have different environment variable values (e.g. in environments with multiple databases).
The variables will be set during the start of the ZeeBORN application.

# %ZeeBORNClient%

%ZeeBORNClient% is an Windows environment variable defined during the setup. This variable points to the local client directory where all client files of the system are installed.

Those Windows environment variables can be used within batch files or for other purposes where the info about directories used by the system is required.

# Example

You can start the Cleanup tool from the command line (or PowerShell) by entering

%ZeeBORNClient%\bin\cleanup

# %ZeeBORNData%

This environment variable is used by ADS-based versions of the software only.

%ZeeBORNData% is an Windows environment variable defined during the setup. This variable points to the remote data directory (usually on a server) where all central data files of the system are installed.

Those Windows environment variables can be used within batch files or for other purposes where the info about directories used by the system is required.

The following folder structure is used on the server:

Folder	Description
%ZeeBORNData%\DB	Central place for all database files. There are several sub-folders in this folder that contain the data of individual ships. The IMO number of each ship is used as the folder name.
%ZeeBORNData%\Install	This folder contains all files for installing the software on additional network clients.
%ZeeBORNData%\Logs	This folder contains system logs that can be used by the support team for identifying potential causes of reported errors or problems.
%ZeeBORNData%\Replication Files	This is the standard folder where all created and imported replication files will be stored. It's recommended to run the Cleaner tool frequently for removing older replication files that are no longer needed.
%ZeeBORNData%\Reports	This folder contains report templates for all print reports provided within the system.
%ZeeBORNData%\res	This folder is used for optional layout resources that allow a detailed customization of system features.

# %ZeeBORNServer%

%ZeeBORNServer% describes the server name and port of the database server. The value is formatted like

[server]:[port]

# %ZeeBORNShared%

For MariaDB-based versions of the ZeeBORN software a shared network folder can be defined.

It's highly recommended to define a shared folder. Otherwise log files and replication files will be stored on the client PC of the user.

This folder will be used for

storing replication files
storing log files

If no central configuration of the shared folder exists, the local folder %USERPROFILE%\Documents\ZeeBORN will be used instead.