CARIS Bathy DataBASE Server : Support Files : CARIS Environment : Environment Settings
 

Environment Settings

CARIS applications and associated modules use an environment that is independent of Registry Editor. All files, folder paths and other settings are managed from a set of environment.xml files. The following table describes types of environment files.

File

Description

System Environment File

This file contains settings that are used by CARIS applications. The file is located in

C:\Program Files\CARIS\<application>\<version>\system\
environment.xml

Do not modify this file, it is always overwritten when more up-to-date versions of CARIS are installed. Any changes are lost.

Module Environment File

This file contains settings that are relevant to a specific module. Each module has its own environment.xml file. The file is located in

C:\Program Files\CARIS\<application>\<version>\modules\
<Module>\support\environment.xml
.

Do not modify this file, it is always overwritten when more up-to-date versions of CARIS are installed. Any changes are lost.

Custom Environment File

This file stores customized system or module settings. The file provides organization-wide default settings that apply to all users on a system

The file overrides identical definitions in the System Environment File or the Module Environment File. The file is located in

C:\ProgramData\CARIS\Caris\<version>\System\environment.xml

No custom environment file is installed by default. This file is optional.

User-Specific Environment File

This file stores custom settings for a single user. Changes in the Options dialog box are applied to this file. The file overrides identical definitions in the System Environment File, Module Environment File or Custom Environment File. The file is located in

C:\Users\<user>\AppData\Roaming\CARIS\<application>\
<version>\environment.xml

This file can be modified through the Options dialog box (see Setting up a CARIS Environment.

Setting up a CARIS Environment

Custom files and modified settings can be applied to the CARIS application and its associated modules through the Options dialog box. Changes are then written to the User-Specific environment.xml file. Changes can also, if needed, be copied to the Custom environment.xml file so changes can be applied to all users on a single computer.

When a change is made to a default setting, the change is highlighted in the Options dialog box. See below.

In this example, the datum file has been changed from the default location in the CARIS System directory to a custom file in another location.

The User-Specific environment.xml file is updated and the change immediately applied to the application.

<Datums>D:\My Coordinate System\datum.dat</Datums>

Custom files and settings for modules are also recorded in the User-Specific environment.xml file. For example, the htftypes.xml file that is contained in the BASE Editor module is set a different folder than the default.

<uslXHTFLookup>D:\My Custom Files\htftypes.xml</uslXHTFLookup>

To return modified settings to the default settings in the System and Module environment.xml files:

Select a modified setting in the Options dialog box, right-click and choose Reset from the pop-up menu.

Click Reset All in the Options dialog box. The User-Specific Environment file is deleted and all settings are returned to the same state as at installation.