Skip to content

Commit

Permalink
update README: no commercial support is provided at the moment
Browse files Browse the repository at this point in the history
  • Loading branch information
kgebert authored and agebert committed May 12, 2017
1 parent 2a339a4 commit 508959d
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
bpmn
================
====
This module executes BPMN 2.0 processes.

BPMN execution is deemed to be a good way to describe process oriented business logic. This is especially true if we have to describe the orchestration and collaboration of service- and UI-interactions. Many of these interactions are asynchronous and event driven making Node.js an ideal candidate for implementing a BPMN engine.

To draw the BPMN file to be executed each BPMN 2.0 compliant tool can be used.

We are working on a simple browser based BPMN 2.0 editor also utilizing Node.js as backend.
You may learn more about our efforts and other Node.js packages on [http://e2ebridge.com](http://e2ebridge.com).

The e2e-transaction-logger package can be used optionally. The generated transaction log files enable the [E2E Dashboards](http://docu.e2ebridge.com/E2E+Dashboards) to provide graphical views of your processes.
You may learn more about our efforts and other Node.js packages on [http://e2ebridge.com](http://e2ebridge.com).

Installation
------------
Expand All @@ -30,6 +27,8 @@ Remarks

Process can be managed or unmanaged. Unmanaged processes are not stored in any way, the developer is responsible of storing the returned process objects to be able to use them later. Process manager allow to create multiple processes and store them during their execution. The managers have functions to retrieve existing processes by id, filter by property or state. Managers will also persist the managed processes if persistency options are set.

This is a very rough work in progress and we're not providing any official support.

Basic Example
=============

Expand Down Expand Up @@ -637,7 +636,7 @@ Supported Elements
- **End events**: all kind of end events are mapped to the none end event. Any further specialization is then done in the implementation of the handler.
- **Gateways**: Parallel- and exclusive gateways are supported.
- **Task, User Task, Manual Task, Receive Task**: These tasks call an event handler when the task starts and then wait until `taskDone(taskName, data)` is invoked on the process.
- Service Task, Script Task, Business Rule Task, Send Task (Wait Tasks): These tasks call an event handler when the task starts and proceed immediately after the the handler finishes.
- **Service Task, Script Task, Business Rule Task, Send Task (Wait Tasks)**: These tasks call an event handler when the task starts and proceed immediately after the the handler finishes.
- **Throw Intermediate Events**: the handler is triggered when the intermediate event is reached. All types of intermediate events are treated the same.
- **Catch Intermediate Events**: the handler is triggered if the event is catched and not when it is reached. For example, if we have an intermediate catch message event, the handler is triggered when the message arrives. If we have an intermediate catch timer event, the handler is triggered when the timout occurs. However, in both cases, no handler is triggered when the intermediate event is reached.
- **Call Activity**: an external sub-process is called. The sub-process must not be a collaboration and must have exactly one start event.
Expand All @@ -647,16 +646,16 @@ Limitations
-----------
- **Start events**: all kind of start events are mapped to the none start event. Any further specialization is then done in the implementation of the handler.
- **End events**: all kind of end events are mapped to the none end event. Any further specialization is then done in the implementation of the handler.
- **Gateway**s: only parallel- and exclusive gateways are supported yet.
- Data objects: are ignored by the engine
- **Gateways**: only parallel- and exclusive gateways are supported yet.
- **Data objects**: are ignored by the engine


Licensing
---------

(The MIT License)

Copyright (c) 2014 [E2E Technologies Ltd](http://www.e2ebridge.com)
Copyright (c) 2014-2017 [Scheer E2E AG](http://www.e2ebridge.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -676,14 +675,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

by [E2E Technologies Ltd](http://www.e2ebridge.com)


Questions, comments, thoughts?
------------------------------
This is a very rough work in progress.

Feel free to contact me at [email protected] with questions or comments about this project.

by [Scheer E2E AG](http://www.e2ebridge.com)


1 comment on commit 508959d

@adebisi-fa
Copy link

@adebisi-fa adebisi-fa commented on 508959d Dec 11, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @kgebert,

Thank you (and your team) for the awesome work you've done with this project!

It's sad, though, that a project with this much prospect, will be left for so long, without any update (at least, pull request review and merge).

Will you not mind, please, if this project is cloned and re-released to the npm repository under a new name, so it can iterate faster, and ultimately enable the community to officially support it for itself?

Thanks once again for your hard work on this!

We love bpmn; it really rocks!

-- Foluso, (on behalf of the Community)

Please sign in to comment.