Dashboard Settings
- Last UpdatedJul 22, 2025
- 10 minute read
Using the Settings panel you can change some of the ways the AIM Dashboard looks and behaves. You must be logged on with the ManageSettings Right to see the Settings menu.
Note: Changes to Site settings are seen by all users; but changes to Role settings are seen only by users who are assigned to a specific role. For more information, see Roles.
To change settings for a Role:
-
Open the AIM Dashboard, select Settings (
), Settings.
-
On the Roles tab, select the Role that you want to change the settings for.
-
Change the settings (see the following table).
-
Select Save.
The screen refreshes, and the new settings take affect.
Following are the fields and the corresponding descriptions for a Role:
Role Settings - Browse
|
Parameter |
Description |
|---|---|
|
Breakdown Nodes |
|
|
Delete |
Manage the top-level categories in the Browse panel. |
|
Apply |
|
|
Edit |
|
|
Create |
|
|
Breakdown Node Configuration |
|
|
Node ID |
The ID of the Breakdown Node. |
|
Label |
The label displayed in the Browse panel. |
|
Tooltip |
The tooltip displayed in the Browse panel. |
|
Expansion Type |
The type of expansion used for child nodes. |
|
Show Items of Type |
The Class of object to show in the breakdown node. |
|
Associations from Root |
How the child classes must be associated to the root object. |
|
Item Node Expansion |
|
|
Default |
Used to over-ride the default expansion defined in Settings, Browse, Default Breakdown, for this breakdown node. |
|
Type Based |
Used to over-ride the default expansion defined above, for this breakdown node, for a specific type of association. |
|
Default Breakdown |
|
|
Default Associations |
The default expansion defined for all breakdown nodes. |
|
General |
|
|
Show expansion by type hierarchy if the list length is greater than |
Select to display browse results in groups if the total number of items is more than the number entered in the box. Note: This settings will take effect, only when an item (not a type) is being expanded. If the number of 'children' to be displayed is greater than the number specified, then the 'children' are organized by their type hierarchy and this is displayed. |
|
Max list items per page |
The size of the group for browse results. |
|
Node Label |
|
|
Type node label |
Supported tokens: @ID and @NAME. For example: @ID-@NAME |
|
Root Items |
|
|
Root item type |
The type of object to show at the root of the Browse panel. |
|
Show all the items of this type |
Show the type selected above. |
|
Show item … as the root |
Limit the root nodes to those matching the string entered in this box. % can be used to match multiple characters. |
|
Type-Based Associations |
|
|
Items of Type |
Select the type of object. |
|
Association Types |
Select the Association type. |
Role Settings - General
|
Parameter |
Description |
|---|---|
|
Data Visibility |
|
|
Show only the latest revision of documents |
Select to show the relevant types of data, in the Search and Browse panels, for example. |
|
Make all types visible in Browse |
|
|
Show Hidden types |
|
|
Show Hidden attributes |
|
|
Show items of Unknown type |
|
|
Context Access Control |
Defines which items can be seen based on its contexts and the user's role. |
|
Default Views |
|
|
Type |
The type of an item that is selected. |
|
View |
The style of view that should be shown for selected items of the type. |
|
Export |
|
|
Warning export size |
The threshold for the number of objects in an export that triggers a warning message. |
|
Maximum export size |
The maximum number of objects that can be exported. If this value is changed be careful to not exceed the combined performance of the system, the hardware and the network latency. |
|
Global Navigation |
|
|
Show the Browse link |
Select to show the relevant buttons on the Global Navigation Bar. |
|
Show the Search link |
|
|
Show the Sets link |
|
|
Show the Query Forms link |
|
|
Show the Export link |
|
|
Show the Reports link |
|
|
Start-up |
Select the Global Navigation Panel to be opened and docked on the application start-up |
|
Messages |
|
|
Output licence expiry messages to the default event log |
Whether licence expiry messages should be written to the default event log. |
|
Query Forms |
|
|
Form View |
Select the default results view for Query Forms. |
|
Table View |
|
|
Search |
|
|
Max list items per page |
The maximum number of search results that will be displayed per page. |
|
Tooltips |
|
|
ISO15926 |
Select to use ISO15926 compliant tooltips. |
Role Settings - Labels
|
Parameter |
Description |
|---|---|
|
Attributes |
|
|
Attribute Label |
Supported tokens: @ID, @NAME. For example: @ID-@NAME |
|
Items |
|
|
Item Label |
Supported tokens: @ID, @NAME, @DESCRIPTION, @TYPEID, @TYPENAME, @SCHEME and @REVISION. To add characters that are only shown if the token is not blank, precede the token and the characters with a caret (^) character. For example: @ID^ - @NAME^{@REVISION} |
|
Sets Panel Label |
Supported tokens: @ID, @NAME, @DESCRIPTION, @TYPEID, @TYPENAME, @SCHEME and @REVISION. To add characters that are only shown if the token is not blank, precede the token and the characters with a caret (^) character. For example: @ID^ - @NAME^{@REVISION} This setting is only used for Sets. If the value is blank, then the value for Item Label will be used. |
|
Type Scheme |
Select the labelling scheme. |
|
Types |
|
|
Type Label |
Supported tokens: @ID and @NAME. For example: @ID-@NAME |
Note: The value for the @NAME token is taken from the Descriptive Name of the object. The value for the @DESCRIPTION token is taken from the Desc attribute present in the object's attribute.
To change Site settings:
-
Open the AIM Dashboard, select Settings (
), Settings.
-
Select the Site tab.
-
Change the settings (see the following table).
-
Select Save.
-
The screen refreshes, and the new settings take affect.
Following are the fields and the corresponding descriptions for a Site:
Site Settings - Document Viewers
|
Parameter |
Description |
|---|---|
|
Colours |
|
|
SVG highlight colour |
The default SVG highlight colour. |
|
SVG selection colour |
The default SVG selection colour. |
|
Graphical Picking |
|
|
Regular Expression |
A regular expression to specify which item is selected when an object is selected in the Document View. The default regular expression for Graphical Picking is "[^ ]+$", which uses the string of characters to the right of the right-most space for matching with an ID in the database. |
|
Selection |
|
|
Document Type |
The type of Document for which this applies. The type of document the user is looking at when they want this behaviour to happen. For example, SSRS REPORT. |
|
Selected Item Type |
The type of item that has been selected within the Document Viewer. For example, FUNCTIONAL ARTIFACT. Note: Document Type and Selected Item Type apply to all sub-classes. For example, FUNCTIONAL ARTIFACT would include EQUIPMENT and PUMP. |
|
Action |
The action to perform either Open or Select: Open – Opens a tab for the selected item. Select – Opens a content card for the selected item in the current tab. |
Site Settings - General
|
Parameter |
Description |
|---|---|
|
Agreement Text |
|
|
Enable Agreement Text |
Select if you want users to have to "Agree" to a message before being able to access the AIM Dashboard. |
|
Agreement Title |
The title of the agreement message. |
|
Agreement Text |
The text of the agreement message. |
|
Associations |
|
|
Name |
Name of the Association type. |
|
Source to Target |
The alias for Source to Target Association. |
|
Target to Source |
The alias for Target to Source Association. Note: The newly added aliases in the Settings are displayed in place of associations throughout the application. The following are the places where the Associations are shown in the AIM Dashboard: Settings: Default Associations Type-Based Associations Advanced Search > Related items dropdown. Query Forms > Related items dropdown. Export definition > Related items dropdown. Related items that are present in Summary view, Tag content card and Document content card |
|
Auto-naming |
|
|
Prefixes for Set IDs |
The prefix applied to a Set ID when a new Set is created and Auto-generate ID is selected. |
|
Size of Number Padding |
The number of digits used in a Set ID when a new Set is created and Auto-generate ID is selected. For example, the default value of "5" would start numbering with "00001". |
|
Data Visibility |
|
|
Limit attributes shown on a Dataset to the Meta Data Template |
Applies to attribute lists in the Query Form Designer and the Export Definition Designer. A value of false will show all attributes regardless of the Dataset chosen. |
|
Export |
|
|
Server Export Folder |
A UNC folder for example, \\myServer\Export Location. Note: The location entered must be a valid UNC path. The account used as the identity of the Job Server (typically Local System) will need write access to the output location. |
|
Home Page |
|
|
Home Page Tab Header |
The label for the tab in the browser. |
|
Home Page |
The path and filename of an HTML page to use on the Dashboard tab. |
|
Icon States |
|
|
State |
The name of the state of the icon. This must be a sub-type of "STATE / STATUS / DOMAIN" and will be used to incidentally classify an object |
|
Icon Style |
The icon style to be used. The name of the icon file is generated from the type of the object and the icon style of the object’s status. The format of the icon file is <classname>_<icon style>.gif. For example, an object of type PUMP with an icon style of Approved looks for an icon file with the name pump_approved.gif. The default folder for these icons is: <installation_path>/App/src/img/ClassDriven. |
|
Tooltip |
An additional line of text to be added to the existing tooltip for an object. |
|
Rank |
An object can potentially be incidentally classified with more than one type, but an object can only be represented by one icon. So the icon chosen is based on the highest ranked applicable icon state. This rank can be increased by dragging the icon state to a higher position in the list. |
|
Log out |
|
|
Enable Logout Button |
Whether a logout link is shown in the Settings pulldown. |
|
Enable user Timeout |
Whether a period of inactivity will log users out. The timeout is based on the IIS session timeout period. |
|
Performance |
|
|
Disable Alternate Essential Classification |
Searches will not check for alternate essential classifications. |
|
Disable Class Counts |
Browse hierarchies will not give counts for the number of items below a class node. |
|
Disable Incidental Classification |
Searches will not check for incidental classifications. |
|
Disable LIKE for search |
Searches will use the 'CONTAINS' operator. |
|
Enable Improved Player Performance |
In the Player, tools may disappear after an activity. In Standard mode, the status colour may not change. Some items may be culled when interacting with the slider. |
|
Player |
|
|
Max list items for Player |
The maximum number of tags allowed for activity associations. If this value is changed be careful to not exceed the combined performance of the system, the hardware and the network latency. |
|
Player Enabled |
Select to enable AIM Player. |
|
Search |
|
|
Automatically append wildcards to search text |
If you have not entered any wildcards manually, then select to automatically append a wildcard to the end of the search text. If you have started to enter wildcards manually, then no wildcards are automatically appended. |
|
Default Scope |
The default scope of a search can be set to: ID – search ID values only Name – search Name values only ID and Name – search both ID and Name values |
|
Allow aliases to affect search results |
When this setting is enabled, search results include IDs with aliases that match the search string. When this setting is disabled, only the default ID of objects are searched and not their aliases. |
|
Set Creation |
|
|
Default Context |
The context that new Sets will be created in. |
|
Tab Behaviour |
|
|
In Memory Tab Types |
When saving the open tabs, the MIME types that will be included. |
|
In Memory Tab Limit |
The maximum number of tabs that will be cached in memory. The tabs that may be cached are limited by the MIME types listed in the In Memory Tab Types setting. After the number of cached tabs reaches this limit, if you open any new tabs that can be cached, the oldest cached tab is no longer cached. For example, if In Memory Tab Limit is set to 2 and you open a third tab, then the first tab is removed from the cache and only the two most recent tabs (that is, second and third) are saved to the cache. When you select the first tab, it will need to be reloaded from the web server. |
|
Theme |
|
|
Name of CSS file |
The path and filename of an CSS file to over-ride the default CSS and provide, for example, a different colour on the Global Navigation Bar. |
|
Visual Reports |
|
|
Max list items for Visual Report |
If the search criteria used in a saved search finds more results than this limit then a warning message appears. If this happens, consider changing this setting; but be careful to not exceed the combined performance of the system, the hardware and the network latency. |
Site Settings - Print
|
Parameter |
Description |
|---|---|
|
Banner Text |
|
|
Top - Left |
Location of banner text when printing Note: Banner Text and Watermark will NOT be applied to documents under the following print operations: 1. Printing from the Accusoft PrizmDoc Viewer 2. Printing a 3D model 3. Printing from the Report Viewer 4. A query form printer-friendly view |
|
Top - Centre |
|
|
Top - Right |
|
|
Bottom - Left |
|
|
Bottom - Center |
|
|
Bottom - Right |
|
|
Colours |
|
|
SVG Colours |
Natural is the default value. This enables printing to take place with the original unchanged foreground and background colours from the SVG file. Black on White forces the printouts to use a black foreground on a white background. Colour on Black does not change foreground colours, but forces the printouts to use a black background. Colour on White does not change foreground colours, but forces the printouts to use a white background. |
|
Limits |
|
|
Max allowed printable pages |
Maximum number of pages that can be printed at one time. |
|
Watermark |
|
|
Default Watermark |
Text for the watermark when printing. This value is overridden by the attribute-base watermark where applicable. Note: Due to limitations in Accusoft's PrizmDoc Viewer: Any watermarks that are set will appear not only on the output of the print but also in the Document Viewer when viewing documents in PrizmDoc. Watermarks do not appear on DGN or DWG files. |
|
Attribute-based Watermark |
When an attribute is selected, the value of this attribute on the Document to be printed will be used instead of the Default Watermark. |