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 NameData TypeValid Values Visual KPI Designer Value
KPI Name
Display Order
Description
Group Name
Max, MaximumAnyAnyMax
AnyAnyMax Interface
High High High, HighHighHigh, HHHAnyAnyHigh High High
High High High Interface
High High , HighHigh, HHAnyAnyHigh High
High High Interface
High, HAnyAnyHigh
High Interface
Target, TgtAnyAnyTarget
Target Interface
Actual
Actual Interface
Low, LAnyAnyLow
Low Interface
Low Low, LowLow, LLAnyAnyLow Low
Low Low Interface
Low Low Low, LowLowLow, LLLAnyAnyLow Low Low
Low Low Low Interface
Min, MinimumAnyAny
Minimum Interface
Top Text, TopTextAnyAny
Bottom Text, BottomTextAnyAny
Alert Silence, AlertSilenceInteger0 (False), 1 (True) Alert Silence
Integer0 (False), 1 (True)NA
Integer0 (False), 1 (True) Unkown
In Service, InServiceInteger0 (False), 1 (True) Not in Service
Status, KPI Status, KPIStatusInteger3 (HHH), 2 (HH), 1 (H), 0 (Good), -1 (L), -2 (LL), -3 (LLL)
Actual Trend Type, ActualTrendTypeString / EnumInterpolated, Step, Symbol, Interpolated + Symbol, Interpolated+Symbol, InterpolatedSymbol, Interpolated Symbol, Step + Symbol, Step+Symbol, StepSymbol, Step Symbol
Target Trend Type, TargetTrendTypeString / Enum

 

Interpolated, Step, Symbol, Interpolated + Symbol, Interpolated+Symbol, InterpolatedSymbol, Interpolated Symbol, Step + Symbol, Step+Symbol, StepSymbol, Step Symbol
Limit Trend Type, LimitTrendTypeString / EnumInterpolated, Step, Symbol, Interpolated + Symbol, Interpolated+Symbol, InterpolatedSymbol, Interpolated Symbol, Step + Symbol, Step+Symbol, StepSymbol, Step Symbol
Trend Limits, TrendLimitsString / EnumDefault, System, False, 0, No, True, 1, Yes
Trend Target, TrendTargetString / EnumDefault, System, False, 0, No, True, 1, Yes
Bar Chart Type, BarChartTypeString / EnumActual EU, ActualEU, Deviation EU, DeviationEU, Deviation %, Deviation%, Deviation Percent, DeviationPercent
Group Map Position, GroupMapPositionString / Enum0, Omit, None, 1, 2, 3, 4, 5
KPI Name Click Path, Name Click PathString / EnumTrend, URL
Notification Type, NotificationTypeString / EnumNone, Email, E-Mail
Alt Contact 1, Alternate Contact 1, AltContact1, AlternateContact1String / ReferenceAny defined Visual KPI Contact
Alt Contact 2, Alternate Contact 2, AltContact2, AlternateContact2String / ReferenceAny defined Visual KPI Contact
Alert Template, AlertTemplateString / ReferenceAny 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 NameData TypeValid Values 
Trend Start Time, Trend Start Date, Trend Start, TrendStartTime, TrendStartDate, TrendStartString / DateRelative Date (*-n Days) or Actual Date (6/12/2013 1:00:00)
Trend End Time, Trend End Date, Trend End, TrendEndTime, TrendEndDate, TrendEndString / DateRelative Date (*-n Days) or Actual Date (6/12/2013 1:00:00)
Min Y Axis, MinYAxis, Minimum Y Axis, MinimumYAxisNumericAny
Max Y Axis, MaxYAxis, Maximum Y Axis, MaximumYAxisNumericAny
URLStringAny URL (starts with www, http:// or https://
URL Descriptor, URLDescriptor, URL Description, URLDescription, URL Name, URLNameStringAny

* 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, NumericFormatStringValid .Net Numeric Formatting (##.###)

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

Geo Label Format, GeoLabelFormatString / EnumDefault, System, Actual, Name, Name: Actual, Name:Actual, Name Actual, NameActual
Trend Scale, TrendScaleString / EnumSingle, Single-Scale, SingleScale, Single Scale, Multi, Multi-Scale, MultiScale, Multi Scale
Trend Y Axis, TrendYAxisString / EnumKPI 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, DisplayFormatString / EnumNone, Number, Number+UOM, Number + UOM, NumberUOM, Number UOM, UOM+Number, UOM + Number, UOMNumber, UOM Number
StringAsia, EMEA, North America, South America Region
StringSite 1, Site 2, Site 3, Site 4 Site
StringArea 01, Area 02, Area 11, Area 21 Area
StringUnit A, Unit B, Unit CUnit

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