Overview (Rule Designer API)

Rule Designer
Package	Description
ilog.rules.brl	Contains classes related to the Business Rule Language Definition Framework (BRLDF).
ilog.rules.brl.bal60	Contains classes related to Business Action Language (BAL).
ilog.rules.brl.bql	Contains classes related to Business Query Language (BQL).
ilog.rules.brl.brldf	Contains classes related to the definition of new business rule languages with the Business Rule Language Definition Framework (BRLDF).
ilog.rules.brl.converter	Contains classes related to the BRL converter, which allows conversion of a rule from one grammar to another, or from one vocabulary to another.
ilog.rules.brl.editor	Contains classes related to editors, that is, BRL mechanisms that allow a user to edit text throw user interface.
ilog.rules.brl.parsing	Contains classes related to the BRL parser.
ilog.rules.brl.parsing.parser.prediction	Contains classes and interfaces related to prediction in the BRL framework.
ilog.rules.brl.semantic	Contains classes for managing the semantics of business rule languages.
ilog.rules.brl.syntaxtree	Contains classes related to the business rule language abstract syntax tree.
ilog.rules.brl.translation	Contains classes related to the IRL translation framework for business rule artifacts.
ilog.rules.brl.translation.codegen	Contains classes related to code generation in the IRL translation framework for business rules.
ilog.rules.brl.ui.value.editor	Contains classes related to UI components for value editors.
ilog.rules.brl.util	Contains utility classes related to the BRL defintion framework.
ilog.rules.brl.value.descriptor	Value descriptors are a BRL mechanism designed to manage literal values in the BRL framework.
ilog.rules.brl.value.editor	Contains classes related to value editors, that is, BRL mechanisms that allow a user to edit literal values.
ilog.rules.brl.value.info	Contains classes related to value info, value providers, and value checkers.
ilog.rules.commonbrm.extractor	Provides the classes for defining extractors in Rule Studio and Rule Team Server.
ilog.rules.commonbrm.model	Provides the common classes for Rule Studio and Rule Team Server models.
ilog.rules.dt	Contains classes related to decision tables and decision trees.
ilog.rules.dt.error	Contains classes related to Error Management in Decision Table and Decision Tree.
ilog.rules.dt.expression	Contains expression implementations.
ilog.rules.dt.model	Contains interfaces defining a decision table or decision tree model and all its structural elements.
ilog.rules.dt.model.common	Contains interfaces defining a decision table or decision tree model and all its structural elements.
ilog.rules.dt.model.event	Provides interfaces and class adapters defining the event system of a decision table model.
ilog.rules.dt.model.expression	Provides interfaces defining the expression model of a decision table or tree model.
ilog.rules.dt.model.helper	Contains companion classes for a DT model.
ilog.rules.dt.model.provider	Contains the interface of a data provider that you use to populate a decision table model.
ilog.rules.dtree.ui	Contains classes related to Decision Tree User Interface.
ilog.rules.dvs.client	Provides the entry point for running test suites and simulations.
ilog.rules.dvs.common.archive	DVS archive manipulation classes.
ilog.rules.dvs.common.descriptors	Classes and interfaces for manipulating scenario formats.
ilog.rules.dvs.common.input	Scenario suite input data types.
ilog.rules.dvs.common.output	Scenario suite output data types.
ilog.rules.dvs.common.output.impl	Implementation classes for scenario suite output data types.
ilog.rules.dvs.core	Contains classes used to customize the scenario provider and KPIs used in testing and simulation.
ilog.rules.dvs.core.impl	Provides default implementations for the interfaces defined in the ilog.rules.dvs.core package.
ilog.rules.dvs.core.scenarioproviders	Scenario provider implementation.
ilog.rules.dvs.excel	Provides the classes and interfaces to use for reading and writing to Excel 2003 scenario files.
ilog.rules.dvs.excel.migration	Provides the classes and interfaces to use to customize migration to Excel 2003 scenario files.
ilog.rules.dvs.rbtesting	Rule based testing classes.
ilog.rules.dvs.rbtesting.asserts	Assert classes and interfaces for rule based testing.
ilog.rules.dvs.rbtesting.rules	Ruleset testing classes and interfaces.
ilog.rules.dvs.rsi	Provides the classes and interfaces for ruleset reflection.
ilog.rules.dvs.rsi.exception	Exceptions related to ruleset reflection.
ilog.rules.dvs.rsi.ofactory	Provides a model for the object factory services.
ilog.rules.dvs.rsi.signature	Provides a model for the ruleset signature services.
ilog.rules.dvs.runner	DVS runner classes.
ilog.rules.dvs.ssp	SSP public classes and interfaces.
ilog.rules.monitor	The package offers tools to monitor thread contentions.
ilog.rules.monitor.jmx	Contains classes to build a monitoring model via JMX.
ilog.rules.monitor.model	Provides a model that represents all contention points detected when a process is monitored.
ilog.rules.monitor.report	Responsible for generating a report from a model instance.
ilog.rules.rf.model	Contains the ruleflow model, the definitions of the enumerated values are used in model attributes.
ilog.rules.rf.model.event	Contains the ruleflow model event-related classes.
ilog.rules.rf.model.io	Contains I/O related classes for ruleflow model.
ilog.rules.shared.bom	Contains dynamic domains interface and classes.
ilog.rules.shared.model	Contains interface and base classes for elements that can have decorations.
ilog.rules.studio.automation	Contains classes that help automate Rule Designer actions.
ilog.rules.studio.dvs.execution	Provides a set of abstract classes that you can extend to create and customize a new Eclipse launcher to execute a DVS archive.
ilog.rules.studio.dvs.ui.execution	Provides an abstract class to implement a customized DVS launcher in the interface.
ilog.rules.studio.dvs.ui.execution.tabgroup	Provides a set of abstract classes that you can extend to create and customize a new Eclipse launcher to execute a DVS archive.
ilog.rules.studio.javascript	Provides classes to manage the life cycle of the Rule Designer command-line tool.
ilog.rules.studio.javascript.dom	Provides the `ilog.rules.studio.eclipsemonkey.dom` extensions, and the factories that support the global variables available in JavaScript.
ilog.rules.studio.model	Contains some base classes for the Rule Designer model.
ilog.rules.studio.model.archive	Provides classes for generating ruleset archives.
ilog.rules.studio.model.base	Provides uncategorized base model classes.
ilog.rules.studio.model.bom	Provides model classes related to the Business Object Model.
ilog.rules.studio.model.brl	Contains model classes for business rule languages in Rule Designer.
ilog.rules.studio.model.builder	Provides classes related to the build operation in Rule Designer.
ilog.rules.studio.model.dt	Contains model classes for decision tables and decision trees.
ilog.rules.studio.model.event	Provides classes of listeners and events for the Rule Designer model.
ilog.rules.studio.model.exception	Provides exceptions thrown by the Rule Designer model.
ilog.rules.studio.model.irl	Contains classes to manage Technical Rules in the Rule Designer model.
ilog.rules.studio.model.query	Contains classes to manage queries in Rule Designer.
ilog.rules.studio.model.query.extractor	Contains classes to manage query extractors in Rule Designer.
ilog.rules.studio.model.query.wrappers	Contains classes related to the Rules Queries API.
ilog.rules.studio.model.resource	Provides classes to manage resources in Rule Designer.
ilog.rules.studio.model.rule	Provides classes for rule artifacts in the model.
ilog.rules.studio.model.ruleflow	Contains the ruleflow model and its tasks, the definitions of the enumerated values are used in model attributes.
ilog.rules.studio.model.search	Provides classes for searches.
ilog.rules.studio.model.search.bom	Provides BOM search capability.
ilog.rules.studio.model.search.rdt	Provides the RDT (model) search functionality.
ilog.rules.studio.model.search.xom	Provides XOM search capability.
ilog.rules.studio.model.services	Provides implementations of services useful when working with the rule model.
ilog.rules.studio.model.xom	Provides model classes related to the Execution Object Model.
ilog.rules.studio.ui.dialogs.wizards.templates	Contains classes related to the Rule Designer template-based wizards.
ilog.rules.studio.ui.propertysheet	Contains classes related to the Rule Designer property sheet.
ilog.rules.studio.vocabulary.bom.editor.term	Contains classes related to the term editor dialog and its redefinition for localization purposes.
ilog.rules.vocabulary.model	Contains classes and interfaces related to the set of terms and phrases attached to the elements of the Business Object Model (BOM) of a rule project.
ilog.rules.vocabulary.model.bom	Contains classes used to implement a vocabulary on top of a Business Object Model (BOM).
ilog.rules.vocabulary.model.bom.io	Contains classes related to the serialization/deserialization of an `IlrBOMVocabulary` object.
ilog.rules.vocabulary.model.event	Contains classes related to event management in the vocabulary.
ilog.rules.vocabulary.model.helper	Contains classes and interfaces related to vocabulary helpers.
ilog.rules.vocabulary.model.io	Contains classes and interfaces related to vocabulary IO.
ilog.rules.vocabulary.verbalization	Contains classes to associate terms and phrases to elements of the business object model.

Classic Rule Engine
Package	Description
ilog.rules.archive	Contains the classes needed to build a ruleset archive and extract its contents, without any interpretation of the contents.
ilog.rules.bom	Contains the interfaces that are used for representing BOMs and XOMs.
ilog.rules.bom.annotations	Contains annotations you can use to decorate Java classes in order to modify how they are imported into a BOM.
ilog.rules.bom.dynamic	Contains an implementation of the object model.
ilog.rules.bom.mutable	Defines the object model mutable API.
ilog.rules.bom.serializer	Contains the `IlrSerializer` interface which can read and write an object model.
ilog.rules.bom.util	Contains miscellaneous utility classes.
ilog.rules.debug	Provides the `IlrLocalTracerToolFactory` class, which allows you to create a local trace.
ilog.rules.engine	Provides the core classes of the IBM Decision Server classic rule engine.
ilog.rules.factory	Contains the Factory API, which provides reflection for IBM Decision Server rules.
ilog.rules.factory.translation	Contains the Translation API, which supports the creation and modification of translations between rules based on a business model and rules based on an execution model.
ilog.rules.tools	Provides command-line tools.
ilog.rules.util	Provides utilities for handling classes.
ilog.rules.util.engine	Provides engine configuration and optimization constants.
ilog.rules.util.prefs	Allows applications to retrieve preferences and localized messages.
ilog.rules.util.resources	Provides the configuration properties for the rule engine.

Decision Engine
Package	Description
com.ibm.rules.engine.load	Utilities for loading an engine.
com.ibm.rules.engine.observer	Observer engine API.
com.ibm.rules.engine.ruledef.runtime	Rule engine runtime API.
com.ibm.rules.engine.ruleflow.runtime	Provides the entry point for running ruleflow engine.
com.ibm.rules.engine.runtime	Engine runtime API.
com.ibm.rules.engine.service	Engine service API.
com.ibm.rules.engine.util	Utility classes including filters, properties and exceptions.

XML Binding
Package	Description
ilog.rules.xml	Provides the base classes and interfaces involved in the XML binding process.
ilog.rules.xml.binding	Provides the default implementation of the XML binding interface.
ilog.rules.xml.model	Contains the XML model class that provides information for the whole schema.
ilog.rules.xml.types	Contains the Java classes representing the XSD simple data types.
ilog.rules.xml.util	Contains a number of utility interfaces that are useful for parameterizing the XML binding mapping.

The APIs listed in this documentation are the only supported APIs - any API (class, interface, method, constructor or member) in a package not explicitly listed in this documentation is subject to change or removal without prior deprecation in any subsequent release (including technical releases), and its use in customer code is not supported.

Business rules are an expression of business policy in a form that is comprehensible to business users and executable by a rule engine. From a business perspective, a business rule is a precise statement that describes, constrains, or controls some aspect of your business. From the IT perspective, business rules are a package of executable business policy statements that can be called from an application.

The APIs documented here provide the means to automate and extend business rules-driven applications.

Rule Designer

The Rule Designer API, also known as Rules Development Tooling (RDT), allows Eclipse developers to create, edit, and customize rule artifacts inside the Eclipse platform.

Because RDT is intended to be a first class citizen in the Eclipse platform, it makes use of many of the platform extension points and frameworks. A prerequisite of using the Rule Designer API is to understand the concepts of plug-ins, extension points, workspace resources, and to have a basic knowledge of the Eclipse Modeling Framework (EMF). EMF is the standard framework used in Eclipse to define advanced models such as the Business Rules Model.

You can use RDT to:

Manage rule artifacts. For example:
- configure rule projects
- create business rules
- define rule applications
- change properties
- navigate the rule model
Generate ruleset archives from the platform
Create and add new generators for Java projects from rule applications
Add new callbacks and extensions to customize Rule Designer

You can use this API in:

Eclipse plug-ins. The plug-ins should be deployed and launched accordingly to Eclipse Plug-In Development Environment (PDE) guidelines. An Eclipse workbench UI is needed to run these plug-ins.
Headless external programs. These programs run in the Eclipse platform infrastructure and can be automated. The Eclipse UI is not visible.

Using embedded data models and web components to author rules outside of Rule Designer

APIs and schemas are also provided to support writing rules in external applications. In such cases, the data model can be in the embedding application. Before you can write rules in an external application you must:

Define a vocabulary from an external source or asset, for example you could extract the terms used in a COBOL program. The vocx.xsd schema and a read/write API is provided for this purpose:
- IlrBOMVocabularyXMLReader
- IlrBOMVocabularyXMLWriter
Create a set of global variables to help authors use the vocabulary and write rules in the Business Action Language (BAL). Use IlrBRLVariableProvider to declare your variables.
Provide a rule authoring environment for BAL by integrating a web-based editor, for example the Web Syntactic Editor and decision table components, into your web application. For more information, see the Web Components API.

You can then write structured business rules that represent the application logic in BAL, instantiate a BAL parser, and import these rules into Rule Designer to implement an executable rule application.

To track the rule artifacts in Rule Designer, you can use an extension model to add a dedicated rule property to store the ID. Use the following API to manage the vocabulary:

Managing both the terminology life cycle and keeping it up-to-date with your rules poses the major problem with authoring rules outside of Rule Designer. See Reviewing a rule project to manage rule project items and run queries and reports on them using the features provided in Rule Designer. The following choices are available:

Accept that your rules and your terminology become desynchronized, and fix the errors when they occur.
Refactor the rules systematically when your terminology changes.
Prohibit modification/deletion of any terminology element that is used by a rule.
Deprecate terms and phrases and put in place a build system to report deprecated element usage. Use the getVocabularyElements method to collect all vocabulary elements used in your BAL rules.

Decision Validation Services

Decision Validation Services provides business rule testing and simulation solutions to developers and business users.

You use the DVS API to:

Run an existing scenario suite (a test suite or simulation).
Create key performance indicators (KPIs) to display the business outcomes of simulations.
Customize the scenario providers, which determine how input data is provided to the test & simulation engine for execution.
Read and write test and simulation data using Excel formats.

The main packages and classes for this group are:

Package Name	Description	Main classes
ilog.rules.dvs.client	Provides the entry point for running test suites and simulations.	IlrSSPServiceFactory
ilog.rules.dvs.core	Contains classes used to customize the scenario provider and KPIs used in testing and simulation.	IlrKPI IlrScenarioProvider
ilog.rules.dvs.excel	Provides the classes and intefaces to read and write test and simulation data using the default Excel formats.	IlrExcel2003ScenarioSuiteReaderFactory IlrExcel2003ScenarioSuiteWorkbookFactory IlrExcel2003ScenarioSuiteWriterFactory
Core classes in non-core packages.		IlrKPIResult IlrScenarioSuiteResourcesRenderer IlrScenarioSuiteKPIRenderer IlrScenarioTestResult IlrSSPService