Managing settings

The following options can be accessed from the context menu of the objects in the Settings dialog. These can only be performed in the Admin Mode, except for the creation of CollectionEntries (see chapter "Manage projects").

[Role:Admin] in the caption of the Settings dialog means that administrator privileges exist.

Create entries

Create... Category

In the left tree view of the Settings dialog you can create a new category via the context menu of a category.

Create... Setting

In the left tree view of the Settings dialog you can create a new setting via the context menu of a category.

Create... Collection

A Collection is a folder that contains one or more CollectionEntries. A Collection is created in the left tree view of the Settings dialog via the context menu of a category.

Create... Collection entry

CollectionEntries are created via the context menu of Collections. CollectionEntries are simple values such as Buffers which can be created by every user.

If new Settings or Collections are added, the settings file to be used for saving the Setting or Collection can be selected from the respective dialog. The first file listed with write access in the MetaSettings.xml file is selected by default.

For further information on how to manage Settings files, please refer to chapter " Hierarchy of the Settings Files".

The DefaultSettings.xml is a read-only file. If existing Collections or CollectionEntriesare either modified or if settings are applied to included files, we recommend performing an Override first (see chapter below).

Override

This option allows Collections or settings, which are contained in a read-only file, to be edited. In this case, the value and the storage location will change. A copy of the Collections or the setting is created in the specified settings file.

This option is only available in the standard view of the Settings dialog.

Procedure

1. Mark the entry, which should be duplicated.

2. Select the option Override from the context menu or use the key combination Ctrl + O.

3. Select the settings file, where the copy should be created from the corresponding dialog. The first file, which is specified in the MetaSettings.xml file and has write access, is selected by default.

4. Changes to the entries are now saved to the specified file. The file specified here is used for the setting as long as the Override is not deleted.

   The value of settings, which have been overwritten, can be reset by using the option Delete Override.

Delete entries

All entries, which are not contained in a read-only settings file, can be deleted.

Entries are deleted via the context menu options Delete or Delete all. Alternatively, the Del key can be used. Categories are deleted automatically if they have no entries. CollectionEntries can also be deleted by standard users.

All CollectionEntries , which are part of a Collection, can be deleted via the context menu entry Delete all CollectionEntries. Alternatively, the key combination Shift + Del can be used.

Delete override

Settings that override another setting can be deleted via the context menu entry Delete Overrideor by using the key combination Ctrl + Del. The hierarchy of the settings is described in detail in chapter " Hierarchy of the Settings Files".

Modify Definition

Extensions can be specified for settings, which are not contained in a read-only settings file. For this purpose, the option Modify Definition can be selected from the context menu. Alternatively, the key combination Ctrl + M can be used. The following extensions are available:

Extensions - Options

Extension	Description
String	Defines the value of the setting as a string (default).
Choice	Defines the value of a setting as a ComboBox. Existing entries can be edited.
Color	Defines the value of a setting as a color dialog box.
Date	Defines the value of a setting as a date input box.
File	Defines the value of a setting as a file select dialog.
MultiFile	Defines the value of a setting as a file select dialog in which multiple files can be selected.
Directory	Defines the value of a setting as a directory select dialog.
MultiDirectory	Defines the value of a setting as a directory select dialog for one or more directories.
MultiFileMultiDirectory	Defines the value of a setting as a directory select dialog for one or more files or directories.

References to environment variables

To be able to access environment variables in the settings, the references must be specified as follows:

Environment variable	As reference
%TRICENTIS_ALLUSERS_APPDATA%	@{Environment.AllUsersAppData}
%APPDATA%\Tricentis	@{Environment.AppData}
%TRICENTIS_PROJECTS%\ToscaCommander	@{Environment.ProjectDir}
%APPDATA%\Tricentis\Tosca TestSuite\7.0.0\logs	@{Environment.LogDir}

Copy Path to Clipboard

Either the path or the selected value of a setting will be displayed in the status bar of the Settings dialog, depending on whether the focus is on the details or the tree view. As a result, the following options can be selected from the context menu of the status bar in order to copy values to the Windows® clipboard: Copy to Clipboard and Copy Path to Clipboard.

The option Copy Path to Clipboard can also be selected from the details or tree view. Alternatively, the key combination Ctrl + C can be used.