About Configuration Files
Your template-based product's configuration file contains information that your template-based product reads during startup to correctly initialize the session. Your template-based product looks for the following configuration files when it starts up: shared, site (if it exists), and private configuration files, in that order.
The private configuration file contains personal settings that are then merged with the general settings defined in the shared or site configuration file. Together, the settings define your work environment. The shared and private configuration files are required, while the site configuration file is optional. You use the site configuration file only if you want to set up a custom version that all users can access.
To personalize the settings in the configuration files, you edit the configuration file using a text editor. You can, however, use the menus to set up the databases without having to directly edit the configuration files.
Learn about managing databases.
Each of the configuration files is explained in the next topics:
About Private Configuration Files
As an expert or standard user, you have your own private configuration file with a default name of .acar.cfg. Your template-based product accesses this file at the beginning of every session. The private configuration file is found at $HOME/.acar.cfg, where $HOME is the location of your home directory.
Note: | The private configuration file is not located in the installation directory. Never change the acar.cfg file located in the installation. |
Note: | Existing .acar.cfg files from older Adams versions (prior to v2024.1) undergo a one-time conversion process to a new format. This new format is not understood by previous (v2023.1 and prior) Adams versions, so launching older Adams versions will not display the previous settings. Adding old-style entries to the end of the new-style .acar.cfg file is possible. For example, these lines can be added to the very end of a new-style .acar.cfg file for users who switch between older & newer versions of Adams: ! Set usermode for previous Adams versions: ENVIRONMENT MDI_ACAR_USERMODE expert |
If you have more than one private configuration file, you can choose the file you want to use for a given session.
■Use the Registry Editor to choose the file you want to use. The registry setting name for your private configuration file is
privateCfg. Learn about
Adams Registry Editor.
You should set up your private configuration file so it contains information specific to the work you are performing. For example, you can set up your own tables in databases in which to store project data. You can also override many of the default settings provided in the shared and site configuration files.
As an alternative to changing the privateCfg setting in the Registry Editor, you could simply change the value of the $HOME environment variable, and create a new .acar.cfg file there. For example, if you have two projects, with configuration files located here:
/drive/user/username/project_1/.acar.cfg
/drive/user/username/project_2/.acar.cfg
Then when working on Project 1, set the environment variable HOME = /drive/user/username/project_1 before launching your template-based product. When working on Project 2, set HOME = /drive/user/username/project_2.
When you set up your private configuration file using the Adams Registry editor, the location specified for privateCfg is saved in a file $HOME/.msca/msca_x.reg. Where x represents the Adams version number; for example, C:/.msca/msca_2024_1.reg for Adams 2024.1. This enables you to specify a different location when you use a different version of Adams. For example; if a new location is specified for the privateCfg when using Adams 2024.1; this setting is stored in the file $HOME/.msca/msca_2024_1.reg and each subsequent usage of Adams 2024.1 will use the privateCfg file specified in this registry file.
About the Site Configuration File
If you create a site configuration file, you call it <your_product_name>.cfg, and place it in the template-based product site repository. You can have only one site configuration file for a site installation of your template-based product. The site configuration file provides settings common to users at a particular site. See
Organizing Custom Code to learn about the location of the site repository.
For example, your company may have engineers working across a network, each wanting to access some common information, such as files and variables. You could set up the site configuration file so that when they run the site version, each engineer's session is configured to access the common information.
We recommend that only the site manager changes the site configuration file. You should make any personal modifications using private configuration files.
About the Shared Configuration File
The shared configuration file is called <your_product_name>.cfg, and is generally found in the installation directory. See your system administrator for location details.
Only one shared configuration file exists for an installation of your template-based product. The shared configuration file contains predefined information common to all users.
We recommend that no one changes the shared configuration file. You should make any personal modifications using
private configuration files, and any common changes for multiple users in
site configuration files.
About Plugin Configuration Files
Many plugins that work with the
Template Builder have their own shared and site configuration files.
Your template-based product follows the same logic for processing the plugin configuration files as it does for any other configuration file.
Format of Configuration Files
A configuration file is divided into the blocks listed below. An example of the blocks in a configuration file are shown in figure
Configuration File Blocks. In the example, ! indicates comments.
■Environment Variables - The first block in a configuration file sets up the environment of your template-based product. For example, it identifies the type of user associated with the configuration file. It also sets the mode in which your template-based product starts, Standard Interface or Template Builder, and any other environment settings.
■Databases - The second block defines the databases in which users store files, the order in which your template-based product searches databases, and the database to which files are written by default.
■Table Directories - The third block defines the list of personal table directories. For example, you could create a table in which to store examples.
■Property Files - The fourth block contains a listing of default property files. When a dialog box requires a property file, it automatically knows to load the desired files if you enter property files in the property file block. You usually define property files in the shared configuration file. If you enter values in your private configuration file, your template-based product overrides the shared files with your personal property files.
■Test Rigs - The fifth block defines the default test rig for a given assembly class. When a dialog box requires a test rig, it automatically knows to load the desired test rigs. You usually define test rigs in the shared configuration file.
Configuration File Blocks
!-------------------------------------------------------------------!
!*************** Adams X Configuration File *************** !
!-------------------------------------------------------------------!
!-------------------------------------------------------------------!
! - List of personal environment variables
!-------------------------------------------------------------------!
ENVIRONMENT MDI_ACAR_USERMODE expert
!-------------------------------------------------------------------!
! - List of personal database directories
! Database name Path of Database
!-------------------------------------------------------------------!
DATABASE private /usr/private.cdb
DATABASE staff /staff/private.cdb
DEFAULT_WRITE_DB private
!
!-------------------------------------------------------------------!
! - List of personal tables directories
! Type class Name of table Extension
!-------------------------------------------------------------------!
! Example table entry:
!TABLE list2+ example.tbl exa
!
!-------------------------------------------------------------------!
! - List of personal default property files
! Type class Default property file
!-------------------------------------------------------------------!
! Example property file entry:
!PROPFILE assembly <private>/assembly.tbl/myfile.dpr
!
! Example test rig entry:
!TESTRIG four_post .__MY_FOURPOST