The input data to be executed by a scenario's ruleset and the resulting output data can be defined in and reported to an Excel workbook. Excel's tabular structure can be harnessed to define multiple input datasets in a single workbook. You can also define whether the data is to be used in a BOM or a XOM ruleset execution.

The structure of an input/output data workbook consists of multiple spreadsheets that declare the datasets and all data objects, and a configuration sheet that provides necessary parameters to process the data.

An input/output data workbook always includes the following two sheets:

Additional sheets are necessary when further objects are declared in the dataset:

Note that classical JDK classes (for example, Date, GregorianCalendar, and StringBuffer) are processed in-line and do not need to be declared in a separate sheet. The class type is declared in the second row of each class sheet, under the class name. It should not normally be changed, but if it is, a corresponding change is necessary in the rsm_config sheet.

The Input Data Sets Sheet

The Input Data Sets sheet declares the datasets defined in the workbook. When the workbook is imported into the Rule Scenario Manager Console, the datasets are displayed in the Input Dataset Selector list and become available for selection in scenario definitions.

A simple sheet might look like the following:

The first column declares the names of the individual datasets. Each data object defined by the ruleset signature is then stated in the subsequent columns, each of which must be defined in its own sheet in the workbook. The first row declares the class key, as declared in the rsm_config sheet, and the second row declares the parameter name in the ruleset signature.

The rsm_config Sheet

The rsm_config sheet contains internal data that configures the data in the workbook. When a new Excel workbook template is created in the Console, default rsm_config data is provided, which is normally sufficient for successful execution. Therefore, this sheet should not normally be edited.

A typical rsm_config sheet might look like the following:

The parameters that can be set in rsm_config are:

A pair of {inout} and {paramType} parameters is required for each dataset named in the Input Data Sets sheet. The default dataset name in a blank template is inputSet.

The Data Objects Sheet

A data objects sheet is required for each class included in the input data definition. A typical sheet might look like the following:

The first column declares the object name, as declared in the Input Data Sets sheet. The subsequent columns describe the object's attributes. The attribute names are given in the first row, and their types in the second row.

Two different formats of attributes are possible:

See Also