hooopo / petri_flow

Petri Net Workflow Engine for Ruby.

Petri Flow

Workflow engine for Rails.

Features

• Full petri net features support (seq, parallel, iterative, timed, automitic etc.)
• Both approval workflow and business workflow.
• Simple web admin for workflow definition and case management.
• Build-in simple dynamic form.
• Replaceable dynamic form.
• Support sub workflow.
• Graph screen for workflow definition.
• Graph screen for case and token migration.
• Powerful guard expression.
• MySQL and Postgres Support.
• Powerful assignment management.
• Flexible integration of organizational structure system(role, group, position or department etc.)

Docs

• Petri-Nets and Workflows
• Workflow Conceptual Guide
• Workflow Concepts Reference
• Petri Flow ERD
• Developer Doc

Screenshots

iterative routing

parallel_routing

guard

case state graph

Installation

Add this line to your application's Gemfile:

gem 'petri_flow', require: 'wf'

And then execute:

$ bundle

Install graphviz

brew install graphviz

Migration:

bundle exec rake wf:install:migrations
bundle exec rails db:create
bundle exec rails db:migrate
bundle exec rails db:seed

Usage

Add wf_config:

# config/initializers/wf_config.rb
Wf.user_class = "::User"
Wf.org_classes = { group: "::Group" }

Set parties:

For normal org model, for example group or role etc.

module Wf
  class Group < ApplicationRecord
    has_many :users 
    include Wf::ActsAsParty
    acts_as_party(user: false, party_name: :name)
  end
end

For user model:

module Wf
  class User < ApplicationRecord
    belongs_to :group, optional: true
    include Wf::ActsAsParty
    acts_as_party(user: true, party_name: :name)
  end
end

then

bundle exec rails 

visit:

http://localhost:3000/wf

Testing

• RAILS_ENV=test rake app:db:migrate && RAILS_ENV=test rake app:db:test:prepare && bundle exec rake test

Contributing

Contribution directions go here.

License

The gem is available as open source under the terms of the MIT License.

petri_flow's Issues

Test Case

add more test.

Developer Doc

add more developer doc.

Sub Workflow

transition can trigger a new workflow instance.

Soundness Checking

• add simple check: #6
• more complex check

Dynamic assignment for next transition

Allows the assignee of one transition to specify the assignee for the next transition.

Multiple Instance seq mode

Workflow definition graph editor

Assignment for current task & next task via callback

Assignment for current task & next task via callback

Typo

Expected:<%= link_to 'Add Guards', new_arc_guard_path(arc), class: 'btn btn-sm btn-outline-primary mr-2' %>
Actual:<%= link_to 'Add Gruards', new_arc_guard_path(arc), class: 'btn btn-sm btn-outline-primary mr-2' %>

Expected: <h5 class="card-header">Dynamic Form</h5>
Actual: <h5 class="card-header">Dynimac Form</h5>

Expected: bundle exec rails server
Actual: bundle exec rails

Multi Instance Workflow for Voting