Menu | Tools > Options |
Options control the appearance of the interface, the behaviour of some commands, and the system environment.
Available options and categories will vary depending on the current Teledyne CARIS application.
For CARIS Onboard, the options settings control various aspects of each of the applications installed with the Onboard suite. For example, the options in the Units category control the units that are used in Process Designer when creating process models for Control Centre.
The Service category, which is specific to Onboard, contains the Onboard Service Port Number option. This option is used to select the port number that will be used to connect to Control Centre when the Launch Onboard Control Centre command is selected in Onboard Viewer. The default port number is 8080, but can be changed if this port is already in use by another service. Changing this value will display a prompt to restart the Onboard service. If you choose not to restart the service at that time, it must be restarted manually in Windows Services.
Restarting the Onboard service while data is being processed in Control Centre will immediately stop all jobs and cause them to fail. It is not recommended to restart the service while jobs are running. |
Options settings are saved in the environment.xml file found in
C:\ProgramData\CARIS\Onboard\2.1\System.
Interface
Options are set using the Options dialog box.
Element | Description |
Search/filter | 1. Type a value and click the magnifying glass or press <Enter>. The category list changes to display only categories that contain an option with the search term in the name. 2. Click a category. Only options that contain the search term are displayed. To clear the filter: 1. Delete the search term and press <Enter>. All categories and options are displayed. |
Categories | The options are divided into categories which are listed here. The categories will vary based on the active modules. |
Options | The options in the selected category are displayed. |
Information | The description and possible settings of a selected option are displayed. |
Reset All | Reset all options to their default settings. |
You can set the option values in different ways:
Value type | Description |
Numeric | Type a number or use the up and down arrows. |
True/False | Click the check box to alternate between true and false. |
Browse (...) | Click to display a dialog box. |
Colour | Click the down arrow to select a colour from a palette. |
List | Click the down arrow and select a value from a list. |
Slider | Drag the slider to increase or decrease values such and length, width and speed. |
Underlined links | Click to change a file name and path. |
Procedure
1. Select the Options command.
The Options dialog box is displayed.
2. Set any necessary options.
3. Click OK.