Search
Generic filters
Exact matches only

Advanced Site Settings Reference

We’ve grouped some cool configuration options under Advanced site settings that allow you to add Interfaces, create your own custom attributes, configure Nav Bar Links, Site Rollups, and even add a language to your Visual KPI interface.

Site settings affect your entire site, so some of the things you configure will either become available in Visual KPI Designer as you create KPIs and other objects, or they’ll show up on your Visual KPI site. You’ll find¬† Advanced settings under the Site Settings icon () in the Document Actions panel.

Interfaces

AttributeDescription
Interface NameThe name of the Table that appears in Interface drop-down menus (visible in Designer worksheets).
Reference CountThe number of times this Interface is used (read-only).
URLThe server URL used to invoke the Interface methods (these URLs do not need to be accessed outside the server).
Authentication MethodUsed to allow or deny Interface rights when writing data to the source (may not apply to all Interfaces).
DomainThe domain used for authentication.
User NameThe account user name required for authentication.
PasswordThe account password required for authentication.
Allow WritesUsed to allow or deny the Interface permission to write data to the source. May not apply to all Interfaces.
Write GroupThe Active Directory or local group that a user must belong to in order to write data to the source.
Down Sample Trend DataAllows for intelligent Trend data downsampling to preserve the Trend's shape. Some data sources (e.g. relational DBs) may return thousands of values, effectively overwhelming the display.
Error DisplayControls where the error is displayed.
Batch SizeControls how many values are retrieved in one call to the Interface. A smaller number may help with parallelism and can be adjusted for a slow-running Interface.
EnabledControls whether or not data is retrieved via this Interface. If disabled, no data will be returned and an 'Interface Disabled' message will appear in all references.
Interface IDRead-only system level identifier.

Attributes

AttributeDescription
Attribute NameThe name of the Attribute as it appears to site users. Attribute names can also be referenced in selection queries.
Display OrderThe numeric value that overrides the default alphanumeric order of Attributes. Attributes with blank fields will be sorted alphanumerically and displayed below Attributes with numbers.
Reference CountThe number of times this Attribute is used (read-only).
DescriptionThe description of the Attribute, for use by Designer admins only and will not appear to site users.
Default ValuesA semicolon delimited list of default Attribute values used to populate Designer drop-down menus. Additional attribute values will be appended to the list as they are defined.
Attribute IDRead-only system level identifier.

Languages

Add your own language to Visual KPI.

AttributeDescription
NameThe name of the Nav Bak Link as it appears to site users.
Display OrderThe numeric value that overrides the default alphanumeric order of Nav Bar Links. Nav Bar Links with blank fields will be sorted alphanumerically and displayed below Nav Bar Links with numbers.
DescriptionThe description of the Nav Bar Link as it appears to site users in a tooltip. User longer descriptions in conjunction with shorter name to accommodate screen space.
URLThe navigation link (URL) the user is redirected to once the Nav Bar Link is clicked.
ShowBoolean value to set the visibility of the Nav Bar Link to site users. Setting this to FALSE will suppress the display of the Nav Bar Link to site users.
Nav Bar Link IDRead-only system level identifier.

Site Rollups

AttributeDescription
Site RollupThe name of the Site Rollup as it appears to site users.
Display OrderThe numeric value that overrides the default alphanumeric order of Site Rollups. Site Rollups with blank fields will be sorted alphanumerically and displayed below Site Rollups with numbers.
DescriptionThe description of the The description of the Site Rollup as it appears to site users in a tooltip. User longer descriptions in conjunction with shorter name to accommodate screen space.
WebService URLURL for the WebService of the target Visual KPI instance. This will be used by the Designer to edit the instance. The URL must be fully qualified and end with 'kpiws.asmx'.
AuthenticationThe IIS authentication method used (if any) to secure the target Visual KPI instance.
UsernameThe account username required to access the target Visual KPI instance. This will only be used on sites with IIS authentication enabled.
PasswordThe account password required to access the target Visual KPI instance. This will only be used on sites with IIS authentication enabled.
Destination URLThe destination, or landing page, of the target Visual KPI instance. This is where the user will be directed when user clicks on the Site Rollup Name. If left blank, the Home page will be used.
ShowBoolean (True/False) or equivalent (Non-zero = True, 0 = False) used to set visibility of the Site Rollup. A setting of FALSE will suppress the display of the Site Rollup to site users. Pair with an Interface for a dynamic value.
Show InterfaceThe Interface used to retrieve the 'In Show' value. If left blank, the Show field is treated as a constant.
LatitudeThe geo location latitude value used for display on a Geo Map. Pair with an Interface to display a dynamic location.
Latitude InterfaceThe Interface used to retrieve data based on the contents of the Latitude field. If left blank, the Latitude field is treated as a constant value.
LongitudeThe geo location longitude value used for display as a Geo Map. Pair with an Interface to display a dynamic location.
Longitude InterfaceThe Interface used to retrieve data based on the contents of the Longitude field. If left blank, the Longitude field is treated as a constant value.
Geo Label FormatOverrides what is the displayed for the Site Rollup on a Geo Map.
InfoAdditional relevant information (can be hyperlinked).
Info InterfaceThe description of the The description of the Site Rollup as it appears to site users in a tooltip. User longer descriptions in conjunction with shorter name to accommodate screen space.
Info Numeric FormatThe numeric formatting code (.NET) used to modify how numbers are displayed.
Info UOMUnit of measure for the Info value (if the value is numeric).
Info Display FormatThe display position of the UoM (e.g. $100, 42.5kg).
Info URLURL link for the INfo field (creates a hyperlink in the Info field).
Info DescriptionIf the Info field is a hyperlinked value, this will be the tool tip or mouse-over text for the link. If only a URL is used, this will be the text displayed in Info.
LinksList of associated Links or URLs (semicolon separated, limit 10, for the object).
Link DescriptionsList of associated Link or URL descriptions (semicolon separated, limit 10) for the object. These are used to shorten and give better meaning to links (e.g. instead of www.xyz.com?x=5$type=2, the user could see SOPs or Shift Report).
Calculation TypeOverride for how non-numeric values in calculations are handled. This is useful when dealing with exceptional data (e.g. BadValue) returned from calculations-derived data sources.
Access Group ListList of Active Directory or local groups (semicolon separated) defining access rights to the object. Only applies if Object Level Security is enabled and the site is secure.
Site Rollup IDRead-only system level identifier.

Learn more

Visual KPI Designer Site Settings
Sitewide vs Override Settings

 

Was this article helpful?

Related Articles