Search
Generic filters
Exact matches only

Visual KPI Website Settings Reference

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 BasicsDescription
Site TitleWebsite title displayed in the browser title bar.
Default Attribute GroupingDefault setting for attribute grouping of KPIs, Charts and Tables.
Site Administrator ContactVisual KPI site administrator contact (also be used for cache server error notifications).
Site Logo LinkDefault link action when clicking site logos.
Screen Data Update IntervalControls 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 ThemeControls 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 ThemeDetermines whether or not site users can select between Dark and Light themes.
Default Client Display TimeControls 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 TimeDetermines whether or not site users will be able to select between client and server times for all rendered timestamps.
Garbage Collection IntervalControls 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 ServerDescription
Cache Alert Notification ProtocolCache server error notification delivery mechanism.
Cache Alert Reminder IntervalControls how often (in minutes) cache server error alerts are sent to the site administrator.
Cache Warning IntervalDetermines the time (in minutes) that should elapse before displaying a site level cache failure warning (0 = always hide this warning).
Cache Status History DurationDetermines 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 IntervalDetermines time (in minutes) that should elapse before displaying a site level alert failure warning (0 = always hide this warning).
KPI Status History Storage DurationDetermines time (in days) a KPI status history is stored.
Tab DefaultsDescription
Default TabDetermines the default tab for each group. 'System' automatically displays the first non-empty tab in this series (Groups, KPIs, Charts, Tables).
Default Group ViewDetermines the default view for Groups on the home page.
Default KPI ViewDetermines the default view for KPIs.
Default Chart ViewDetermines the default view for Charts.
Default Table ViewDetermines the default view for Tables.
Column DefaultsDescription
Default Info Column Display NameDefault name used to display the info column in Groups, KPIs, Charts and Tables.
Default KPI Actual Column Display NameDefault name used to display the actual column in KPIs.
Default KPI Target Column Display NameDefault name used to display the target column in KPIs.
Text, Number and Size DefaultsDescription
Default Numerical FormatDefault numeric format string for KPIs and Info. Leave blank for system defaults.
Use KPI Name as Top TextDetermines 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 TextDetermines 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 TextDetermines 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 LengthMaximum length of lookup text displayed on chart cursors (0 = No lookup text displayed).
Maximum Group CountMaximum number of Groups displayed. Additional Groups can be shown by clicking 'Show More' (100 max).
Maximum Object CountMaximum 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 CountMaximum number of KPIs initially displayed as a KPI Map. Additional KPIs can be shown by clicking 'Show More' (500 max).
Maximum Group Map CountMaximum number of Groups initially displayed as a Group Map. Additional Groups can be shown by clicking 'Show More' (200 max).
Maximum Pareto Chart Bar CountMaximum number of bars displayed for dynamic Pareto Charts given a large enough display (5 min and 50 max).
Profile Most Recently Used CountMaximum number of recently used Profiles shown in profile list (3 min and 10 max).
Geo Map and Near Me SettingsDescription
Default Near Me Distance UnitDefault unit of measure for Near Me distance.
Default Group Geo Map Label FormatDefault format of Group Geo Map labels.
Default KPI Geo Map Label FormatDefault format of KPI Geo Map labels.
Show Geo Map Info Window On Large ScreensControls 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 ScreensControls 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 SettingsDescription
Enable Trend Auto PlayControls whether or not Trends will dynamically update.
Maximum Large Screen Chart CursorsControls 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 CursorsControls 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 CursorsControls whether or calculations (equations) are displayed in Chart cursors.
Show Limits on KPI TrendsControls whether or not to initially display limits on KPI Trends (can toggle ON/OFF).
Show Target on KPI TrendsControls whether or not to initially display target on KPI Trends (can toggle ON/OFF).
Show Status Background on KPI TrendsControls 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 TrendsControls whether or not gridlines are visible on Trends.
Show Gridlines on Pareto ChartsControls whether or not gridlines are visible on Pareto Charts.
Show Gridlines on Bar ChartsControls whether or not gridlines are visible on Bar Charts.
Show Gridlines on XY PlotsControls whether or not gridlines are visible on XY Plots.
Scroll IncrementLength of time that timestamp-based Charts and Tables can be scrolled.
Scroll Increment UnitUnit of time that timestamp-based Charts and Tables can be scrolled.
Page and Information Visibility SettingsDescription
Sticky HeaderControls whether or not the page header will scroll as the page is scrolled.
Show LegendControls whether or not page legends are displayed.
Show Site InformationControls whether or not the site information page is available.
Show Group DetailControls whether or not Group detail pages are available.
Show KPI DetailControls whether or not KPI detail pages are available.
Show Chart DetailControls whether or not Chart detail pages are available.
Show Table DetailControls whether or not Table detail pages are available.
Show Site Rollup LinksControls whether or not links on Site Rollups are available.
Show Group LinksControls whether or not links on Groups are available.
Show KPI LinksControls whether or not links on KPIs are available.
Show Chart LinksControls whether or not links on Charts are available.
Show Table LinksControls whether or not links on Tables are available.
Show Target on KPI SparklineControls whether or not KPI sparklines show Target pen.
Show Empty GroupsControls 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-UpsControls whether or not Group KPI Roll-Up bars are displayed.
Show Name TooltipControls whether or not an object's name displays a tooltip on mouse-over.
Show Unused Fields in Detail PagesDetail pages will show 'N/A' for all empty or unused fields if this setting is TRUE.
Display Alert History on KPI Detail PageControls whether or not alert history appears on KPI detail pages.
Show KPI Override IndicatorControls whether or not the KPI override indicator (*) is shown on KPIs with a status override.
Recently Changed Time LimitControls time (in minutes) the system considers a KPI status change to be 'recent'.
Recently Changed "Flash" DurationControls 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 PageControls whether or not Group descriptions appear in column next to Rollups.
Show Child Objects With GroupsControls whether or not child objects (KPIs, Charts and Tables) are shown on the same page as Groups in List View.
Group Map SettingsDescription
Default Group Map KPI Cell CountNumber of KPI cells displayed on each Group Map (1 minimum and 20 max).
Default Group Map Header PriorityControls 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 ColorGroup 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 ColorGroup 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 FitControls 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 SettingControls whether or not the Group Map is expanded or collapsed (header only) by default.
Group Map Header SeverityControls 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) SettingsDescription
Simplify KPI Blocks with Missing DataSimplify 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 BlocksDisplay a sparkline (trend) on KPI Blocks (Note: Can override setting on each block).
Show Bullet Chart on KPI BlocksDisplay a Bullet Chart on KPI Blocks (Note: Can override setting on each block).
Show Status History Chart on KPI BlocksDisplay a Status History Chart on KPI Blocks (Note: Can override setting on each block).
Show Statistics on KPI BlocksDisplay statistics on KPI Blocks (Note: Can override setting on each block).
Show Actions on KPI BlocksDisplay actions on KPI Blocks (Note: Can override setting on each block).
Show Contact on KPI BlocksDisplay KPI contact on KPI Blocks (Note: Can override setting on each block).
Time Range and Event Range SettingsDescription
Show Time RangesControls 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 RangesControls whether or not query based event ranges displays on range pickers (Note: Event Range connectstring and query must also be defined).
Default Expanded Range SectionControls 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 SettingsDescription
Calculation TypeControls how non numeric values in calculations are handled.
Numeric Substitution ValueSubstitution 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 CalculationUsed 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 SettingsDescription
Default Watchlist ViewDetermines the default view for Watchlist KPIs.
Default Watchlist Attribute GroupingDefault setting for attribute grouping of Watchlist KPIs.
Security SettingsDescription
Windows Security All Access GroupWindows Security Group that grants user(s) access to all objects. (Used when Object Level Security is enabled).
Visual KPI Admin GroupWindows Security Group that grants user(s) admin rights to objects via the website. (Used for Trend Comments and Profile management).
Enable Outbound RequestsControls 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

Was this article helpful?

Related Articles