Demo.Dashboard.SalesMetrics
class Demo.Dashboard.SalesMetrics extends Ens.BusinessMetric
This is a sample of a a Business Metric class; It defines a set of Business Metric properties (aka Key Performance Indicators) and provides the code to periodically calculate their values. These metrics can then be displayed within an Ensemble Dashboard.Property Inventory
Method Inventory
Properties
property Backlog as Ens.DataType.Metric (RANGELOWER = 0, RANGEUPPER = 10, UNITS = "Days");
Recent backlog for current product
Property methods: BacklogDisplayToLogical(), BacklogGet(), BacklogIsValid(), BacklogLink(), BacklogLogicalToDisplay(), BacklogNormalize(), BacklogPoints(), BacklogRangeLower(), BacklogRangeUpper(), BacklogSet(), BacklogThresholdLower(), BacklogThresholdUpper(), BacklogUnits()
property News as Ens.DataType.Metric;
This reports some random news displayed in order to display it
within a tickertape feed.
Property methods: NewsDisplayToLogical(), NewsGet(), NewsIsValid(), NewsLink(), NewsLogicalToDisplay(), NewsNormalize(), NewsPoints(), NewsRangeLower(), NewsRangeUpper(), NewsSet(), NewsThresholdLower(), NewsThresholdUpper(), NewsUnits()
property Sales as Ens.DataType.Metric (AUTOHISTORY = 10, RANGELOWER = 0, RANGEUPPER = 100, UNITS = "Dollars") [ MultiDimensional ];
This reports recent sales (in dollars) for a given product
Property methods: SalesDisplayToLogical(), SalesGet(), SalesIsValid(), SalesLink(), SalesLogicalToDisplay(), SalesNormalize(), SalesPoints(), SalesRangeLower(), SalesRangeUpper(), SalesSet(), SalesThresholdLower(), SalesThresholdUpper(), SalesUnits()
property TotalSales as Ens.DataType.Metric (RANGELOWER = 0, RANGEUPPER = 10000, UNITS = "Dollars");
This reports total sales since start of the demo.
Property methods: TotalSalesDisplayToLogical(), TotalSalesGet(), TotalSalesIsValid(), TotalSalesLink(), TotalSalesLogicalToDisplay(), TotalSalesNormalize(), TotalSalesPoints(), TotalSalesRangeLower(), TotalSalesRangeUpper(), TotalSalesSet(), TotalSalesThresholdLower(), TotalSalesThresholdUpper(), TotalSalesUnits()
property TotalUnits as Ens.DataType.Metric (RANGELOWER = 0, RANGEUPPER = 10000, UNITS = "Units");
This reports total units sold since start of the demo.
Property methods: TotalUnitsDisplayToLogical(), TotalUnitsGet(), TotalUnitsIsValid(), TotalUnitsLink(), TotalUnitsLogicalToDisplay(), TotalUnitsNormalize(), TotalUnitsPoints(), TotalUnitsRangeLower(), TotalUnitsRangeUpper(), TotalUnitsSet(), TotalUnitsThresholdLower(), TotalUnitsThresholdUpper(), TotalUnitsUnits()
property Units as Ens.DataType.Metric (AUTOHISTORY = 10, RANGELOWER = 0, RANGEUPPER = 100, UNITS = "Units") [ MultiDimensional ];
This reports recent sales (in units sold) for a given product
Property methods: UnitsDisplayToLogical(), UnitsGet(), UnitsIsValid(), UnitsLink(), UnitsLogicalToDisplay(), UnitsNormalize(), UnitsPoints(), UnitsRangeLower(), UnitsRangeUpper(), UnitsSet(), UnitsThresholdLower(), UnitsThresholdUpper(), UnitsUnits()
Methods
method OnCalculateMetrics() as %Status
This method is called periodically, for each instance (product in this case)
in order to update the various metric values.
This method returns a list of instances for this Business Metric;
in this case, every instance represents a specific product
Inherited Members
Inherited Properties
- %AlertStartTime
- %ConfigName
- %ConfigQueueName
- %LastActionTime
- %LastHandledTime
- %LastReportedError
- %OutsideCreated
- %PreserveSession
- %ProcessInputCalled
- %QuitTask
- %RequestHeader
- %SessionId
- %SuperSession
- %SuperSessionCreatedBeforeSession
- %WaitForNextCallInterval
- %WarnedLatest
- %isShadow
- %rangeLower
- %rangeUpper
- %thresholdLower
- %thresholdUpper
- Adapter
- AlertGracePeriod
- AlertGroups
- AlertOnError
- ArchiveIO
- BusinessPartner
- GenerateSuperSessionID
- IOLogEntry
- InactivityTimeout
- ThrottleDelay
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnClose()
- %OnDashboardAction()
- %OnGetActionList()
- %OnNew()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %SuperSessionSet()
- %ValidateObject()
- AdapterName()
- AssignOneSetting()
- CalculateMetricsOnDemand()
- CloseIOLogEntry()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- ForceSessionId()
- GenerateSuperSession()
- GetDeferredResponseToken()
- GetMetric()
- GetProductionSettingValue()
- GetProductionSettings()
- GetPropertyConnections()
- GetSettings()
- GetShadowInstance()
- NewIOLogEntry()
- OnError()
- OnGenerateSuperSession()
- OnGetConnections()
- OnInit()
- OnKeepalive()
- OnMonitor()
- OnProcessInput()
- OnProductionStart()
- OnProductionStop()
- OnStart()
- OnStop()
- OnTearDown()
- PopulateSuperSession()
- QueueName()
- SaveIOLogEntry()
- SendAlert()
- SendDeferredResponse()
- SendRequestAsync()
- SendRequestSync()
- SetMetric()