Instance

Instance objects are used to synchronize with installed Visual KPI instances to enable profile and dashboard configuration from DataStudio. Instance objects are created below the KPI Server object in the Server Model.

Use Cases

  • Synchronization with installed Visual KPI instances from DataStudio.

Quick Configuration

  1. Right-click on the KPI Server object, select Admin  New  Instance.

  2. Enter an object name in the Create Instance wizard, then click Create.

For more information on how to configure a Instance in DataStudio, please visit our section on How to Create a KPI Server and Instance.

Object Properties

Common

Object Name

The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description

This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

KPI ID

The KPI ID which gets assigned by VisualKPI.

Attachments

File attachments stored in MongoDB file store.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String

A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name

A custom property name which can be used programmatically.

Property Value

The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name

A custom table name which can be used programmatically.

Table Data

Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.