XOR Convention Checker

The XOR Convention Checker processes BPMN models and checks XOR gateways on predefined naming conventions and an existing default-path.

• Naming of splitting XOR gateway is incorrect
• Outgoing edges of splitting XOR gateway are not or incorrectly named
• Default path is not specified

Assumptions

• The BPMN-models have to be in the classpath at build time

Configuration

The rule should be configured as follows:

<rule>
	<name>XorConventionChecker</name>
	<state>true</state>
	<settings>
		<setting name="requiredDefault">true</setting>
	</settings>
	<elementConventions>
		<elementConvention>
			<name>convention</name>
			<description>gateway name has to end with an question mark</description>
			<pattern>[A-ZÄÖÜ][a-zäöü]*\\?</pattern>
		</elementConvention>
		<elementConvention>
			<name>convention2</name>
			<description>gateway edge has to be named</description>
			<pattern>[A-ZÄÖÜ][a-zäöü]*</pattern>
		</elementConvention>
	</elementConventions>
</rule>

The setting allows you to configure whether a default path is required. The pattern can be any regular expression and is useful to enforce naming conventions.
“convention” refers to the naming convention of xor gateways themselves.
“convention2” refers to the outgoing edges of a xor gateway.

An element convention consists of:

• a name
• a regular expression for the naming convention (pattern)
• a description to describe the convention (optional)

Error messages:

Naming convention of XOR gate ‘%gatewayName%’ not correct.

The default naming convention requires XOR gateways to end with “?”.

Examples

Correct use of naming convention