| Table of Contents |
|---|
CONFIG SETTINGS POPUP GUI
When the user chooses View/Set All Configuration Settings, the CONFIGURATION SETTINGS GUI similar to the one from the NetBom Tool shown to the right will be launched.
This GUI provides the user access to view and set all the CSETS that are currently defined for the Tool that launched it.
Top of Configuration Settings GUI
Across the Top of the GUI are buttons to allow the user to
Save All Config Settings
Report All Config Settings.
A Function is also provided to Search for CSETS matching a user entered query... See Using Search For Settings below for more information on how to use this
The Config Settings Grid
The CSETs are arranged by Categories or Tags, and there is a Tab for each Category.
Several CSETS can be accessed in more than one Category. The Tool itself assigns the CSETS into categories and this may change with each new release of a tool.
The Tab for each CSET Category contains a row for each available CSET.
Matching CSET Report
FileName/Directory Item
If the CSET is a placeholder for a file or directory, it will be displayed with the CSET NAME, an entry containing the filename or directory, a Browse... button to allow the user to use the operating system to choose the file/directory location and if its a filename, there may also be an edit button which will allow the user to open that file in the configured Text Editor
Enable/Disable Items
If the CSET is a boolean type operator (on/off), it will be displayed with a Label and a check button
MultiSelect
If the CSET can be used to select one of multiple items, it will be displayed with a Label and an Entry with a Pulldown allowing the user to select from the available options
Search For Config Settings
Each CadEnhance tool provides a powerful search function to let users find a CSET by name, value or category. From there they can inspect and/or modify its current value, and also see the source of it's current value.
Accessing the CSET Search Tool
The Main UI provides a Search for Config Setting Button which pops up the Search Controls. The same search can also be accessed using the Config->Search for Configuration Settings Menu item.
CSET Search Operation
Main Search Entry (Search for setting containing…)
Multiple match Strings can be entered separated by commas in the main Search Entry
In the example shown below, the user entered power,sig_name in the Search for setting containing... entry and then pressed the Search Button (or hit enter)
The Tool searched all of its CSETS to see if their NAME contains either "power" or "sig_name" and then listed the matching CSETS below the search control entries.
Modifying Search Critera
With Prefixes Like #,TAB=,Source=,VAL= and !Default the user can change the search criteria used for each individual match string.
#Category/Tag
Each CSET in the tool is assigned a list of Categories or Tags that they apply to. The user can use these Tags to search for all the CSETS that are used to control specific functions for the tool. Originally the Tags were referred to as TABS because the CSETs in the View/Set All Configuration Settings were split into a TAB for each function like shown in the NetBom UI image above
The User may enter a TAG Match using the #[matchString] or TAB=[matchString], the tool will search for all CSETs whose category/tag matches the matchString
VAL=PREFIX
With the VAL=MatchString, the tool will search for any CSET whose VALUE contains the matchString.
SOURCE=PREFIX
With the SOURCE=[SITE|LOCAL] the tool will search for any CSET whose VALUE was contained in the SITE or LOCAL Configuration File
!DEFAULT
If the user enters !DEFAULT as a pattern, the tool will search for any CSET whose VALUE is not equal to the internally stored DEFAULT value. This provides a good way to look for all values that have been changed by the user.
The latest Category/Tag Pulldown provides the user a shortcut to browse and select any of the available CSET Tags.
Mix and Match Search Types
Each of the multiple search_strings can be entered with a different prefix…For example
#Admin,Val=158,LIMIT
The result will display all the CSETS assigned to the ADMIN category, and CSET whose VALUE contains '158' and any CSET whose NAME contains 'LIMIT'
Configuration Settings HTML Report
With each release of the CadEnhance Tools, there is a good chance that a new set of Configuration Settings (CSETS) have been added or removed. Rather than maintain the documentation of these CSETS in this central document site, we added a function so that each Tool can creates the documentation for its latest CSET information on the fly. The tool will always have the best view of its own CSETS.
CSET Documentation Report
When the user selects the Report Configuration Settings item from the Config Menu or the Help Menu, The tool will create an html report of all the know Configuration Settings, and then open a web-browser to display the report.
The Report All Config Settings Button in the CONFIGURATION SETTINGS GUI will also produce the same report.
A sample report from PartBuilder v23.6.1 is shown here
Tool Version and TimeStamp
The Tool Version and Build TimeStamp will be displayed as the top Header
Filter Elements
The Filter Function provides a powerful way to search through all the CSETS.
Column Select
The first Entry provides a Browse Function allowing the user to select the search column which can be set to:
Any Column (Searches for the entered string in all columns
CSET (The Name of the CSET)
Source (Where the selected CSET Value )
Value
Description
More Info
Search Type
The user can set this entry to search for the selected column(s) Containing, or Not Containing the set of match_strings
Pattern Entry
Here the user enters the comma separated Match Strings
CSET Report Rows
A Table
There is a row present for each CSET that matches the CSET filter. For each CSET there is a column for the Source of the CSET Value, the Name of the CSET, the Value of the CSET, the Description of its function (which is stored in the code) and a column with More Information, which includes the default value for the CSET and the File Name that the setting came from if is a SITE or LOCAL value.
The Name, Value and Description are self-explanatory.
The Source of the Value will be displayed as one of three options.
SITE
This means that the Value came from the SITE settings Configuration File which is documented at the top of the report
LOCAL
This means the Value came from the LOCAL Configuration File which is documented at the top of the report
DEFAULT
This means that the Value is equal to the default value of the CSET which is internally maintained by the tool
ENV_VAR
This value was pulled from a system or user Environment Variable, The Value of these CSETS may be temporarily changed locally, but there is no mechanism to save the changes to the actual Environment Variable.
Sorting by Column
The Rows in the table can be sorted by any of the Column Values, the user can double click in the selected Header column to sort. A Vertical Arrow pointing up or down appears in the column selected for the sort
Expanding large cells
Browser Shortcut Keys
It can be helpful to know that most browsers support a
Ctrl <shift> '+' shortcut to zoom in to a page
Ctrl '-' shortcut key to zoom out.
The table above was captured after using the zoom-out shortcut a few times.