The information in the Rule Info is used in the following ways:

• To validate the Rule for Workflow Execution.
• To provide data to display in the Workflow Orchestration Modeller and Rule Library.

The Rule Info includes the following properties:

• `name`

   - this is the Rule name. Make sure your Rule Names are descriptive and specific to the intended logic and behavior of the rule.

• `description`

   - this is a parameterized string used to describe the behavior of the Rule, as well as indicate what and how the Rule Parameters are used.

• `accepts`

   - this is a list of 

  `@EventInfo`

   Annotations (see below) to describe the 

  `entityType`

  s for which this Rule will work on.

• `produces`

   - this uses an 

  `@EventInfo`

   Annotation (see below) to describe the Event that the rule outputs.

• `exceptions`

   - this is a list of 

  `RuleExecutionException`

   classes that this rule might throw. Make sure you read up on Exception Management for more info.

The description Property and the Modeller

The 

`description`

`@Param<Type>`

The syntax here is important. Wrap parameter names in curly braces 

`{`

`}`

1@RuleInfo(
2        name = "ExampleRule"
3        , description = "This is the description of the Example Rule using parameter {ParamString1}"
4)
5@ParamString(name = "ParamString1", description = "Parameter String 1", defaultValue = "PS1")
6public class ExampleRule implements Rule {
7
8    // ...
9}

1@RuleInfo(
2        name = "ExampleRule"
3        , description = "This is the description of the Example Rule using parameter {" + MyRuleConstants.PARAM_STRING_1_NAME + "}"
4)
5@ParamString(name = MyRuleConstants.PARAM_STRING_1_NAME, description = "Parameter String 1", defaultValue = "PS1")
6public class ExampleRule implements Rule {
7
8    // ...
9}

This will render a form field for use within the Modeller:

The @EventInfo Annotation

The 

`@EventInfo`

`accepts`

`produces`

The Event Info includes the following properties:

• `eventName`

   - the Name of the Event produced by this Rule.

• `entityType`

   - the Entity Type of the Events accepted by this Rule, or the Entity Type of the Event produced by this Rule.

• `entitySubType`

   - the Sub Type of the Entity of the Event produced by this Rule.

• `status`

   - the Status of the Entity of the Event produced by this Rule.

`produces`

1    produces = {
2        @EventInfo(eventName = "{eventName}"
3        , entityType = EventInfoVariables.EVENT_TYPE
4        , entitySubtype = EventInfoVariables.EVENT_SUBTYPE
5        , status = EventInfoVariables.EVENT_STATUS
6    )