Website settings allow you to control site behaviors that apply universally. For example, you can configure default views for object tabs (Groups, KPIs, Charts and Tables), define units of measure, text, number and size defaults, and define Geo Map behavior.
Use this table to learn about all of the possible site settings that are configurable in Visual KPI Designer. You’ll find Website settings under the Site Settings icon () in the Document Actions panel.
Website Settings
| Site Basics | Description |
|---|---|
| Site Title | Website title displayed in the browser title bar. |
| Default Attribute Grouping | Default setting for attribute grouping of KPIs, Charts and Tables. |
| Site Administrator Contact | Visual KPI site administrator contact (also be used for cache server error notifications). |
| Site Logo Link | Default link action when clicking site logos. |
| Screen Data Update Interval | Controls screen data update interval (in seconds) for Web pages. Set 0 to turn off page data refresh. (Note: This should not be faster than your cache cycle as the cache time determines how often data is refreshed on the server). |
| Default Color Theme | Controls the default color theme (light or dark) for the site. Users can override this setting on each site if allowed. |
| Allow Users to Change Color Theme | Determines whether or not site users can select between Dark and Light themes. |
| Default Client Display Time | Controls the default display time (client time or server time) for all rendered timestamps. Site users can override this setting on each site if allowed. |
| Allow Users to Change Client Display Time | Determines whether or not site users will be able to select between client and server times for all rendered timestamps. |
| Garbage Collection Interval | Controls the interval (in minutes) for a full page refresh. This helps clear memory leaks--unfortunately common and not entirely unavoidable (yet) in Web applications. (Note: User actions will reset the interval. 0 = turn off this refresh). |
| Cache and Alert Server | Description |
| Cache Alert Notification Protocol | Cache server error notification delivery mechanism. |
| Cache Alert Reminder Interval | Controls how often (in minutes) cache server error alerts are sent to the site administrator. |
| Cache Warning Interval | Determines the time (in minutes) that should elapse before displaying a site level cache failure warning (0 = always hide this warning). |
| Cache Status History Duration | Determines the time (in days) a KPI status history should be stored (Forever = keep all history). Note: A large number of Forever settings causes the size of the Visual KPI database to grow. |
| Alert Warning Interval | Determines time (in minutes) that should elapse before displaying a site level alert failure warning (0 = always hide this warning). |
| KPI Status History Storage Duration | Determines time (in days) a KPI status history is stored. |
| Tab Defaults | Description |
| Default Tab | Determines the default tab for each group. 'System' automatically displays the first non-empty tab in this series (Groups, KPIs, Charts, Tables). |
| Default Group View | Determines the default view for Groups on the home page. |
| Default KPI View | Determines the default view for KPIs. |
| Default Chart View | Determines the default view for Charts. |
| Default Table View | Determines the default view for Tables. |
| Column Defaults | Description |
| Default Info Column Display Name | Default name used to display the info column in Groups, KPIs, Charts and Tables. |
| Default KPI Actual Column Display Name | Default name used to display the actual column in KPIs. |
| Default KPI Target Column Display Name | Default name used to display the target column in KPIs. |
| Text, Number and Size Defaults | Description |
| Default Numerical Format | Default numeric format string for KPIs and Info. Leave blank for system defaults. |
| Use KPI Name as Top Text | Determines whether or not the KPI name is used by default as the KPI Map top text if no other top text has been entered. |
| Use KPI Actual as Bottom Text | Determines whether or not the KPI actual value is used by default as the KPI Map bottom text if no other bottom text has been entered. |
| Use KPI Description as Additional Text | Determines whether or not the KPI description is used by default as the KPI Map additional text if no other additional text has been entered. |
| Lookup Text Length | Maximum length of lookup text displayed on chart cursors (0 = No lookup text displayed). |
| Maximum Group Count | Maximum number of Groups displayed. Additional Groups can be shown by clicking 'Show More' (100 max). |
| Maximum Object Count | Maximum number of KPIs, Charts and Tables initially displayed. Additional KPIs, Charts and Tables can be shown by clicking 'Show More' (100 max). |
| Maximum KPI Map Cell Count | Maximum number of KPIs initially displayed as a KPI Map. Additional KPIs can be shown by clicking 'Show More' (500 max). |
| Maximum Group Map Count | Maximum number of Groups initially displayed as a Group Map. Additional Groups can be shown by clicking 'Show More' (200 max). |
| Maximum Pareto Chart Bar Count | Maximum number of bars displayed for dynamic Pareto Charts given a large enough display (5 min and 50 max). |
| Profile Most Recently Used Count | Maximum number of recently used Profiles shown in profile list (3 min and 10 max). |
| Geo Map and Near Me Settings | Description |
| Default Near Me Distance Unit | Default unit of measure for Near Me distance. |
| Default Group Geo Map Label Format | Default format of Group Geo Map labels. |
| Default KPI Geo Map Label Format | Default format of KPI Geo Map labels. |
| Show Geo Map Info Window On Large Screens | Controls whether or not to display the pop-up Geo Map info panels on screens with a horizontal resolution of 768 pixels or more. |
| Show Geo Map Info Window On Small Screens | Controls whether or not to display the pop-up Geo Map info panel on screens with a horizontal resolution of 768 pixels or less. |
| Chart & Table Settings | Description |
| Enable Trend Auto Play | Controls whether or not Trends will dynamically update. |
| Maximum Large Screen Chart Cursors | Controls how many lockable cursors (10 max) are allowed on Charts displayed on screens with a horizontal resolution of 768 pixels or more. |
| Maximum Small Screen Chart Cursors | Controls how many lockable cursors (10 max) are allowed on Charts displayed on screens with a horizontal resolution of 768 pixels or less. |
| Show Calculations in Chart Cursors | Controls whether or calculations (equations) are displayed in Chart cursors. |
| Show Limits on KPI Trends | Controls whether or not to initially display limits on KPI Trends (can toggle ON/OFF). |
| Show Target on KPI Trends | Controls whether or not to initially display target on KPI Trends (can toggle ON/OFF). |
| Show Status Background on KPI Trends | Controls whether or not to initially display status bars on the background of KPI Trends (can toggle ON/OFF--requires KPI Status History Storage Duration > 0). |
| Show Gridlines on Trends | Controls whether or not gridlines are visible on Trends. |
| Show Gridlines on Pareto Charts | Controls whether or not gridlines are visible on Pareto Charts. |
| Show Gridlines on Bar Charts | Controls whether or not gridlines are visible on Bar Charts. |
| Show Gridlines on XY Plots | Controls whether or not gridlines are visible on XY Plots. |
| Scroll Increment | Length of time that timestamp-based Charts and Tables can be scrolled. |
| Scroll Increment Unit | Unit of time that timestamp-based Charts and Tables can be scrolled. |
| Page and Information Visibility Settings | Description |
| Sticky Header | Controls whether or not the page header will scroll as the page is scrolled. |
| Show Legend | Controls whether or not page legends are displayed. |
| Show Site Information | Controls whether or not the site information page is available. |
| Show Group Detail | Controls whether or not Group detail pages are available. |
| Show KPI Detail | Controls whether or not KPI detail pages are available. |
| Show Chart Detail | Controls whether or not Chart detail pages are available. |
| Show Table Detail | Controls whether or not Table detail pages are available. |
| Show Site Rollup Links | Controls whether or not links on Site Rollups are available. |
| Show Group Links | Controls whether or not links on Groups are available. |
| Show KPI Links | Controls whether or not links on KPIs are available. |
| Show Chart Links | Controls whether or not links on Charts are available. |
| Show Table Links | Controls whether or not links on Tables are available. |
| Show Target on KPI Sparkline | Controls whether or not KPI sparklines show Target pen. |
| Show Empty Groups | Controls whether or not Groups with no data are displayed (Note: Empty Groups will always be hidden if Object Level Security is enabled). |
| Show KPI Roll-Ups | Controls whether or not Group KPI Roll-Up bars are displayed. |
| Show Name Tooltip | Controls whether or not an object's name displays a tooltip on mouse-over. |
| Show Unused Fields in Detail Pages | Detail pages will show 'N/A' for all empty or unused fields if this setting is TRUE. |
| Display Alert History on KPI Detail Page | Controls whether or not alert history appears on KPI detail pages. |
| Show KPI Override Indicator | Controls whether or not the KPI override indicator (*) is shown on KPIs with a status override. |
| Recently Changed Time Limit | Controls time (in minutes) the system considers a KPI status change to be 'recent'. |
| Recently Changed "Flash" Duration | Controls time (in seconds) the KPI will 'flash' after screen load for a recently changed KPI. (Off = Never, Max = Until no longer 'recent', or any numeric value). |
| Show Group Description in Rollup Page | Controls whether or not Group descriptions appear in column next to Rollups. |
| Show Child Objects With Groups | Controls whether or not child objects (KPIs, Charts and Tables) are shown on the same page as Groups in List View. |
| Group Map Settings | Description |
| Default Group Map KPI Cell Count | Number of KPI cells displayed on each Group Map (1 minimum and 20 max). |
| Default Group Map Header Priority | Controls Group Map header cell behavior. Sets the header color and icon based on status: 'Recently Changed' = color of most recently changed KPI and icon to overall KPI status. 'Overall' = color of most severe KPI status and icon to most recently changed status. 'Custom Colors' = color to either the custom recently changed or not recently changed colors and no icons. |
| Recently Changed Color | Group Map header color if one or more KPIs in the Group has recently changed (applies only if Custom Colors is selected for Header Priority). |
| Not Recently Changed Color | Group Map header color if no KPIs in the Group have recently changed (applies only if Custom Colors is selected for Header Priority). |
| Group Map Force Fit | Controls whether or not the Group Map will display on a single screen (no scrolling). This can cause large Group Maps to render with very small cells that are difficult to read. If the cell size gets too small text will be removed. |
| Default Group Map Expansion Setting | Controls whether or not the Group Map is expanded or collapsed (header only) by default. |
| Group Map Header Severity | Controls how the system calculates severity of status for use in header colors and icons. (Note: Not In Service always overrides other statuses). |
| KPI Block (Widget) Settings | Description |
| Simplify KPI Blocks with Missing Data | Simplify KPI block widget if a valid sparkline and Bullet Chart cannot be rendered. (TRUE = remove sparkline, Bullet Chart, actions, statistics and contact). |
| Show Sparkline on KPI Blocks | Display a sparkline (trend) on KPI Blocks (Note: Can override setting on each block). |
| Show Bullet Chart on KPI Blocks | Display a Bullet Chart on KPI Blocks (Note: Can override setting on each block). |
| Show Status History Chart on KPI Blocks | Display a Status History Chart on KPI Blocks (Note: Can override setting on each block). |
| Show Statistics on KPI Blocks | Display statistics on KPI Blocks (Note: Can override setting on each block). |
| Show Actions on KPI Blocks | Display actions on KPI Blocks (Note: Can override setting on each block). |
| Show Contact on KPI Blocks | Display KPI contact on KPI Blocks (Note: Can override setting on each block). |
| Time Range and Event Range Settings | Description |
| Show Time Ranges | Controls whether or not the predefined list of time ranges displays on range pickers (Note: The predefined list of ranges must also be configured). |
| Show Event Ranges | Controls whether or not query based event ranges displays on range pickers (Note: Event Range connectstring and query must also be defined). |
| Default Expanded Range Section | Controls which range selection section is expanded by default (Note: This will only apply if both event and time ranges have been configured and set to SHOW). |
| Calculation Settings | Description |
| Calculation Type | Controls how non numeric values in calculations are handled. |
| Numeric Substitution Value | Substitution value for string results in numeric calculations. This is useful when dealing with exception data (e.g. BadValue) returned from data sources used in a calculation. |
| Status Calculation | Used to determine KPI status change calculation behavior. 'Exceeds Only' = Actual is less than < a low limit or greater than > a high limit. 'Meets or Exceeds' (default) = Actual is less than < or equal to = a low limit or greater than > or equal to = a high limit. |
| Watchlist Settings | Description |
| Default Watchlist View | Determines the default view for Watchlist KPIs. |
| Default Watchlist Attribute Grouping | Default setting for attribute grouping of Watchlist KPIs. |
| Security Settings | Description |
| Windows Security All Access Group | Windows Security Group that grants user(s) access to all objects. (Used when Object Level Security is enabled). |
| Visual KPI Admin Group | Windows Security Group that grants user(s) admin rights to objects via the website. (Used for Trend Comments and Profile management). |
| Enable Outbound Requests | Controls whether or not outbound links (e.g. URLs, Fonts, Google APIs) are enabled (Note: Must enable to use Geo Maps). |
Learn more
Visual KPI Designer Site Settings
Sitewide vs Override Settings