Key Performance Indicator Java Definition

ILOG JRules User Guide > Testing Rules with Rule Scenario Manager > Reference > Rule Scenario Manager XML and Java Artifacts > Key Performance Indicator Java Definition

Key Performance Indicator Java Definition

PREVIOUS NEXT

Rule Scenario Manager provides sample key performance indicators to indicate how to design them for your scenario suites and simulations. The basics-javabinding sample includes two simulation KPIs and two scenario suite KPIs, found in <InstallDir>/scenariomanager/samples/basics-javabinding/src/myPackage.

A KPI is called to obtain a result from a simulation or scenario suite. Three basic interfaces are found in the package ilog.rules.ras.core.kpi:

IlrSimulationKpi - the interface implemented to create a simulation KPI.
IlrScenarioSuiteKpi - the interface implemented to create a scenario suite KPI.
IlrBaseKpiObject - a base class used to create your own KPI result.

Examples

A KPI Object

In the basics-javabinding sample, the class myPackage.userDefined.MyKpiResultObject is an example implementation of the KpiResultObject class that works with the myPackage.MyFirst*Kpi classes.

In the basics-javabinding sample, the class myPackage.userDefined.MyBestCoverageKpiObject is an example implementation of the KpiResultObject class that works with the myPackage.MyBestCoverageKpi class.

In the basics-javabinding sample, the class myPackage.userDefined.MyCoverageKpiObject is an example implementation of the KpiResultObject class that works with the myPackage.MyCoverageKpi class.

A Scenario Suite KPI

In the basics-javabinding sample, the class myPackage.MyFirstKpi is a simple example that calculates the sum of the execution durations of the member scenarios.

In the basics-javabinding sample, the class myPackage.MyCoverageKpi calculates the rules coverage percentage (the number of rules fired over the total number of rules).

A Simulation KPI

In the basics-javabinding sample, the class myPackage.MyFirstSimulationKpi is a simple example that calculates the sum of the execution durations of the member scenario suites.

In the basics-javabinding sample, the class myPackage.MyBestCoverageKpi calculates the best rules coverage percentage from the member scenario suites. This class works with the myPackage.MyCoverageKpi class.