menu

Flow

class viewflow.base.Flow

Base class for flow definition:

class MyFlow(Flow):
    start = flow.StartFunction().Next(this.end)
    end = flow.End()
Parameters
  • process_class – Defines model class for Process

  • task_class – Defines model class for Task

  • management_form_class – Defines form class for task state tracking over GET requests

  • lock_impl – Locking implementation for flow

  • instance – the singleton instance”

management_form_class

alias of viewflow.forms.ActivationDataForm

process_class

alias of viewflow.models.Process

task_class

alias of viewflow.models.Task

property urls

Build URL patterns list for all flow nodes:

urlpatterns = [
    re_path(r'^admin/', include('admin.site.urls')),
    MyFlow.instance.urls,
]
class viewflow.base.FlowMeta(app_label, flow_class, nodes)

Flow meta options.

property flow_label

Unique flow label.

property manage_permission_name

Name of the permission to administer flow instances.

node(name, no_obsolete=False)

Get node by name.

nodes()

Iterator over all flow nodes.

property view_permission_name

Name of the permission to view flow instances.