ruleBased.properties File

Edit online

This file specifies the actual rules on which the Rule Based reports are generated, different parameters for the rules as well as the source files on which the Rule Based analysis will run.

Here are some specific syntax elements of the RuleBased.properties file:

  • <number>: is a positive integer.
  • <identifier>: alphanumeric text with no spaces.
  • <path>: absolute path to a file on disk.
  • <class>: qualified class name for a rule.
  • <text>: any string of characters on one line. Line continuation (single backslash at the end of line) can be used for multiple lines. A syntax comment is introduced hereby. It is not part of the file format.
  • {key}: the value of the key as found in the file.
Rules can be parametrized, inputs being one of the optional parameters which can be set. Input values can be a list of data from the database based on a query. Rule characteristics:

  • id - unique number to identify an input; it is used to create all subsequent keys for current input.

  • key - unique key used for substitution in query rules.

  • name – input name.

  • query - query to obtain a list of values from the repository which will act as parameters.

  • firstColumnType - declare the type for the first column of the query. The default value is numeric. Accepted, string.

Parameter values can be simple values (numbers or text) and are also optional. Parameter characteristics:

  • id - unique number to identify a parameter; it is used to create all subsequent keys for current parameter.

  • key - unique key used for substitution in query rules.

  • name – parameter name.

  • pattern - if parameter is a simple value, pattern can be used to validate the data the user entered.

  • length - if parameter is a simple text value, length can be used to verify the max length of the data.

  • value.lessThan - for numeric simple values it can be used for validation.

  • value.greaterThan - for numeric simple values it can be used for validation.

  • prefix - text to prefix the user chosen data (transforms the parameter as text).

  • suffix - text to be appended to the user chosen data (transforms the parameter as text).

Rules can be organized in groups according to specific criteria. Rule group characteristics:

  • id - uniquely identifies a group; it is used to create all subsequent keys for current group.

  • name - name to display for the group.

  • parent - a {group.id} value of another group that contains this group.

  • description - additional information on the group displayed in the application.

Rules are the basis of the Rule Based analysis action. Rule characteristics include:

  • id -unique number that identifies a rule; it is used to create all keys for current rule.

  • name – the name that is visible for the user. This will appear in the report.

  • sourceBased - classifies the rule. The report will be generated in *.PDF format if sourceBased is set to true. If sourceBased is set to false, the report will be generated in *.CSV format. The default value is true.

  • weight – a number used to calculate the weight of a certain rule, appears in the report summary. The default value is 1.

  • query and selectiveQuery - paths to query files.

  • class - qualified class name for a rule implementation.

  • groups - list of group ids that will show the rule.

  • description - long text that describes the rule to the end-user.

  • params - list of parameter keys that are required by this rule.

  • inputs - list of input keys that are required by this rule.