flowable-cmmn-moddle

flowable-cmmn-moddle

Flowable moddle extensions for CMMN 1.1. This package provides Flowable-specific extensions for cmmn-moddle, enabling support for Flowable's custom CMMN elements and attributes in cmmn-js based applications.

Installation

npm install flowable-cmmn-moddle

Usage

With cmmn-js

import CmmnModeler from 'cmmn-js/lib/Modeler';
import flowableDescriptor from 'flowable-cmmn-moddle/resources/flowable';

const modeler = new CmmnModeler({
  container: '#canvas',
  moddleExtensions: {
    flowable: flowableDescriptor
  }
});

With cmmn-js Properties Panel

import CmmnModeler from 'cmmn-js/lib/Modeler';
import propertiesPanelModule from 'cmmn-js-properties-panel-flowable';
import propertiesProviderModule from 'cmmn-js-properties-panel-flowable/lib/provider/flowable';
import flowableDescriptor from 'flowable-cmmn-moddle/resources/flowable';

const modeler = new CmmnModeler({
  container: '#canvas',
  propertiesPanel: {
    parent: '#properties-panel'
  },
  additionalModules: [
    propertiesPanelModule,
    propertiesProviderModule
  ],
  moddleExtensions: {
    flowable: flowableDescriptor
  }
});

Supported Flowable Extensions

This package extends the CMMN 1.1 meta-model with Flowable-specific elements and attributes:

Case Elements

• flowable:historyTimeToLive - Set history time to live for cases
• flowable:initiatorVariableName - Define initiator variable name
• flowable:candidateStarterGroups - Set candidate starter groups

Human Tasks

• flowable:assignee - Task assignee
• flowable:candidateUsers - Candidate users
• flowable:candidateGroups - Candidate groups
• flowable:dueDate - Task due date
• flowable:followUpDate - Task follow-up date
• flowable:priority - Task priority
• flowable:formKey - Associated form key
• flowable:formFieldValidation - Form field validation

Process Tasks

• flowable:processBinding - Process binding type
• flowable:processVersion - Process version
• flowable:processTenantId - Process tenant ID
• flowable:fallbackToDefaultTenant - Fallback to default tenant
• flowable:sameDeployment - Use same deployment

Case Tasks

• flowable:caseBinding - Case binding type
• flowable:caseVersion - Case version
• flowable:caseTenantId - Case tenant ID

Decision Tasks

• flowable:decisionBinding - Decision binding type
• flowable:decisionVersion - Decision version
• flowable:decisionTenantId - Decision tenant ID
• flowable:mapDecisionResult - Result mapping
• flowable:resultVariable - Result variable

Listeners

• flowable:caseExecutionListener - Case execution listeners
• flowable:taskListener - Task listeners
• flowable:variableListener - Variable listeners

Variable Mapping

• flowable:in - Input variable mapping
• flowable:out - Output variable mapping

Repetition Rules

• flowable:repeatOnStandardEvent - Repeat on standard event
• flowable:counterVariable - Counter variable
• flowable:maxInstanceCount - Maximum instance count

Milestones

• flowable:milestoneVariable - Milestone variable

CMMN XML Namespace

This extension uses the namespace http://flowable.org/cmmn with the prefix flowable:.

Example CMMN XML with Flowable extensions:

<?xml version="1.0" encoding="UTF-8"?>
<definitions xmlns="http://www.omg.org/spec/CMMN/20151109/MODEL"
             xmlns:flowable="http://flowable.org/cmmn"
             targetNamespace="http://flowable.org/cmmn">
  <case id="myCase" flowable:initiatorVariableName="initiator">
    <casePlanModel id="casePlanModel" flowable:formKey="startForm">
      <planItem id="humanTaskPlan" definitionRef="humanTask"/>
      <humanTask id="humanTask" 
                 flowable:assignee="${initiator}"
                 flowable:candidateGroups="managers"
                 flowable:formKey="taskForm"/>
    </casePlanModel>
  </case>
</definitions>

Development

Prerequisites

• Node.js 16+
• npm or yarn

Setup

git clone https://github.com/jylups/flowable-cmmn-moddle.git
cd flowable-cmmn-moddle
npm install

Running Tests

npm test

Linting

npm run lint

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

• Fork the repository
• Create your feature branch (git checkout -b feature/AmazingFeature)
• Commit your changes (git commit -m 'Add some AmazingFeature')
• Push to the branch (git push origin feature/AmazingFeature)
• Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Related Projects

• cmmn-js - CMMN 1.1 modeling for the web
• cmmn-moddle - CMMN 1.1 meta-model
• Flowable - Open source business process engine

Acknowledgments

• Based on camunda-cmmn-moddle
• Built on top of the excellent bpmn.io toolkit