Search
Generic filters
Exact matches only
  1. Home
  2. Knowledge Base
  3. Remote Context Service
  4. Remote Context Service KPI Keywords

Remote Context Service KPI Keywords

The Visual KPI Remote Context Service will automatically create a KPI if it finds one of more of the following keywords, or sub-attributes:

AF Attribute Name Data Type Valid Values  Visual KPI Designer Value
KPI Name
Display Order
Description
Group Name
Max, Maximum Any Any Max
Any Any Max Interface
High High High, HighHighHigh, HHH Any Any High High High
High High High Interface
High High , HighHigh, HH Any Any High High
High High Interface
High, H Any Any High
High Interface
Target, Tgt Any Any Target
Target Interface
Actual
Actual Interface
Low, L Any Any Low
Low Interface
Low Low, LowLow, LL Any Any Low Low
Low Low Interface
Low Low Low, LowLowLow, LLL Any Any Low Low Low
Low Low Low Interface
Min, Minimum Any Any
Minimum Interface
Top Text, TopText Any Any
Bottom Text, BottomText Any Any
Alert Silence, AlertSilence Integer 0 (False), 1 (True)  Alert Silence
Integer 0 (False), 1 (True) NA
Integer 0 (False), 1 (True)  Unkown
In Service, InService Integer 0 (False), 1 (True)  Not in Service
Status, KPI Status, KPIStatus Integer 3 (HHH), 2 (HH), 1 (H), 0 (Good), -1 (L), -2 (LL), -3 (LLL)
Actual Trend Type, ActualTrendType String / Enum Interpolated, Step, Symbol, Interpolated + Symbol, Interpolated+Symbol, InterpolatedSymbol, Interpolated Symbol, Step + Symbol, Step+Symbol, StepSymbol, Step Symbol
Target Trend Type, TargetTrendType String / Enum

 

Interpolated, Step, Symbol, Interpolated + Symbol, Interpolated+Symbol, InterpolatedSymbol, Interpolated Symbol, Step + Symbol, Step+Symbol, StepSymbol, Step Symbol
Limit Trend Type, LimitTrendType String / Enum Interpolated, Step, Symbol, Interpolated + Symbol, Interpolated+Symbol, InterpolatedSymbol, Interpolated Symbol, Step + Symbol, Step+Symbol, StepSymbol, Step Symbol
Trend Limits, TrendLimits String / Enum Default, System, False, 0, No, True, 1, Yes
Trend Target, TrendTarget String / Enum Default, System, False, 0, No, True, 1, Yes
Bar Chart Type, BarChartType String / Enum Actual EU, ActualEU, Deviation EU, DeviationEU, Deviation %, Deviation%, Deviation Percent, DeviationPercent
Group Map Position, GroupMapPosition String / Enum 0, Omit, None, 1, 2, 3, 4, 5
KPI Name Click Path, Name Click Path String / Enum Trend, URL
Notification Type, NotificationType String / Enum None, Email, E-Mail
Alt Contact 1, Alternate Contact 1, AltContact1, AlternateContact1 String / Reference Any defined Visual KPI Contact
Alt Contact 2, Alternate Contact 2, AltContact2, AlternateContact2 String / Reference Any defined Visual KPI Contact
Alert Template, AlertTemplate String / Reference Any defined Visual KPI Alert Template

The AF Remote Context Server will automatically add the following fields as attributes to the KPI in Visual KPI if found in AF:

AF Attribute Name Data Type Valid Values  
Trend Start Time, Trend Start Date, Trend Start, TrendStartTime, TrendStartDate, TrendStart String / Date Relative Date (*-n Days) or Actual Date (6/12/2013 1:00:00)
Trend End Time, Trend End Date, Trend End, TrendEndTime, TrendEndDate, TrendEnd String / Date Relative Date (*-n Days) or Actual Date (6/12/2013 1:00:00)
Min Y Axis, MinYAxis, Minimum Y Axis, MinimumYAxis Numeric Any
Max Y Axis, MaxYAxis, Maximum Y Axis, MaximumYAxis Numeric Any
URL String Any URL (starts with www, http:// or https://
URL Descriptor, URLDescriptor, URL Description, URLDescription, URL Name, URLName String Any

* URL and URL Descriptor can be semi-colon (;) delimited lists. It is best if you match these up (i.e. 3 urls and 3 descriptors)

Numeric Format, NumericFormat String Valid .Net Numeric Formatting (##.###)

http://msdn.microsoft.com/en-us/library/0c899ak8.aspx

Geo Label Format, GeoLabelFormat String / Enum Default, System, Actual, Name, Name: Actual, Name:Actual, Name Actual, NameActual
Trend Scale, TrendScale String / Enum Single, Single-Scale, SingleScale, Single Scale, Multi, Multi-Scale, MultiScale, Multi Scale
Trend Y Axis, TrendYAxis String / Enum KPI Min and Max, KPI Min Max, KPIMinMax, Auto-Scale, Auto-Scale, Auto, Multi Scale, Min and Max Y Axis, Min Max Y Axis, MinMaxYAxis
Display Format, DisplayFormat String / Enum None, Number, Number+UOM, Number + UOM, NumberUOM, Number UOM, UOM+Number, UOM + Number, UOMNumber, UOM Number
String Asia, EMEA, North America, South America  Region
String Site 1, Site 2, Site 3, Site 4  Site
String Area 01, Area 02, Area 11, Area 21  Area
String Unit A, Unit B, Unit C Unit

Notes:

  • If the parent attribute has a Unit of Measure (UOM), that UOM will be used as the KPI’s UOM and by default the Display Format of Number + UOM will be set.
  • If the parent attribute has a description, that description will be used as the KPI’s description.

More keywords

Was this article helpful?

Related Articles