Home

Getting Started

• User guide for getting started with nFlow can be found here.
• Frequently Asked Questions can be found in FAQ.
• Details on how to configure your nFlow can be found here.
• JavaDocs are available here.

Versioning

nFlow uses Semantic Versioning Specification (SemVer). First nFlow production deployments have been done and the latest released major version is 1.

CHANGELOG.md contains the version history.

Recommendations

• Do not make backward incompatible changes to existing workflow definitions. Instead, create a new workflow definition if the structure of the workflow would change.

REST API

nFlow REST API supports currently following operations:

• GET /v1/workflow-definition
• Get definition of a workflow: all possible states, transitions between states, and other setting related to the workflow.
• GET /v1/workflow-instance
• Query list of workflow instances with different query criterias
• GET /v1/workflow-instance/{id}
• Fetch full state and history of single workflow instance
• PUT /v1/workflow-instance
• Create a new workflow instance that will be processed as soon as there are free WorkflowExecutors.
• PUT /v1/workflow-instance/{id}
• Update existing workflow instance. This is typically used in manual step via some UI.

nFlow REST API is described in more detail via Swagger documentation system. Swagger documentation is included automatically in nflow-jetty.

Mailing list

Public mailing list for nFlow users is [email protected]. Archives are available at https://groups.google.com/forum/#!forum/nflow-users.

Licence

nFlow is licenced under European Union Public Licence v1.1.