wbcore 1.59.9__py2.py3-none-any.whl

wbcore/contrib/workflow/serializers/workflow.py

@@ -0,0 +1,125 @@
+from django.db.models import Model
+from django.utils.translation import gettext as _
+from rest_framework.exceptions import ValidationError
+from rest_framework.reverse import reverse
+
+from wbcore import serializers as wb_serializers
+from wbcore.content_type.serializers import ContentTypeRepresentationSerializer
+from wbcore.contrib.icons import WBIcon
+from wbcore.contrib.workflow.models import Workflow
+from wbcore.contrib.workflow.sites import workflow_site
+from wbcore.enums import RequestType
+from wbcore.metadata.configs import buttons as bt
+
+
+class WorkflowModelSerializer(wb_serializers.ModelSerializer):
+    _model = ContentTypeRepresentationSerializer(source="model", allowed_types=workflow_site.model_content_types)
+    graph = wb_serializers.ImageField(required=False, read_only=True, label=_("Graph"))
+
+    @wb_serializers.register_resource()
+    def steps_inline(self, instance: Workflow, request, user) -> dict[str, str]:
+        if not self.context.get("request"):
+            return {}
+        return {
+            "steps": reverse("wbcore:workflow:step-workflow-list", args=[instance.pk], request=self.context["request"])
+        }
+
+    @wb_serializers.register_resource()
+    def transitions_inline(self, instance: Workflow, request, user) -> dict[str, str]:
+        if not self.context.get("request"):
+            return {}
+        return {
+            "transitions": reverse(
+                "wbcore:workflow:transition-workflow-list", args=[instance.pk], request=self.context["request"]
+            )
+        }
+
+    @wb_serializers.register_resource()
+    def processes_inline(self, instance: Workflow, request, user) -> dict[str, str]:
+        if not self.context.get("request"):
+            return {}
+        return {
+            "processes": reverse(
+                "wbcore:workflow:process-workflow-list", args=[instance.pk], request=self.context["request"]
+            )
+        }
+
+    @wb_serializers.register_resource()
+    def data_inline(self, instance: Workflow, request, user) -> dict[str, str]:
+        if not self.context.get("request"):
+            return {}
+        return {
+            "data": reverse("wbcore:workflow:data-workflow-list", args=[instance.pk], request=self.context["request"])
+        }
+
+    @wb_serializers.register_dynamic_button()
+    def start_workflow_buttons(self, instance: Workflow, request, user):
+        buttons = []
+        for step in instance.get_start_steps_for_workflow():
+            buttons.append(
+                bt.ActionButton(
+                    method=RequestType.PATCH,
+                    identifiers=("workflow:process",),
+                    endpoint=f"{reverse('wbcore:workflow:workflow-start', args=[instance.pk], request=request)}?step_id={step.pk}",
+                    label=_("Start {}").format(step.workflow.name),
+                    icon=WBIcon.START.icon,
+                    description_fields=_("Are you sure you want to start workflow {}?").format(step.workflow.name),
+                    title=_("Start {}").format(step.workflow.name),
+                    action_label=_("Starting {}").format(step.workflow.name),
+                )
+            )
+        return buttons
+
+    def validate(self, data: dict) -> dict:
+        if "status_field" in data:
+            status_field: str | None = data["status_field"]
+        else:
+            status_field: str | None = self.instance.status_field if self.instance else None
+        if "model" in data:
+            model: Model | None = data["model"]
+        else:
+            model: Model | None = self.instance.model if self.instance else None
+        preserve_instance: bool | None = data.get(
+            "preserve_instance", self.instance.preserve_instance if self.instance else None
+        )
+
+        if preserve_instance and not bool(model):
+            raise ValidationError({"preserve_instance": _("Can only preserve the instance when a model is attached.")})
+
+        if model and status_field:
+            if not (model_class := model.model_class()):
+                raise ValidationError({"model": _("Model not found.")})
+            if not hasattr(model_class, status_field):
+                raise ValidationError({"status_field": _("This model does not implement the specified status field.")})
+        return data
+
+    class Meta:
+        dependency_map = {
+            "status_field": ["model"],
+            "preserve_instance": ["model"],
+        }
+        model = Workflow
+        fields = (
+            "id",
+            "name",
+            "single_instance_execution",
+            "model",
+            "_model",
+            "status_field",
+            "_additional_resources",
+            "_buttons",
+            "preserve_instance",
+            "graph",
+        )
+
+
+class WorkflowRepresentationSerializer(wb_serializers.RepresentationSerializer):
+    _detail = wb_serializers.HyperlinkField(reverse_name="wbcore:workflow:workflow-detail")
+
+    class Meta:
+        model = Workflow
+        fields = (
+            "id",
+            "name",
+            "_detail",
+        )

wbcore/contrib/workflow/sites.py

@@ -0,0 +1,43 @@
+from dataclasses import dataclass, field
+from typing import Callable
+
+from django.utils.functional import cached_property
+from django.utils.module_loading import autodiscover_modules, import_string
+
+
+class CachedDict(dict):
+    def __init__(self):
+        super().__init__()
+        self._cache = {}
+
+    def __getitem__(self, key):
+        if key in self._cache:
+            return self._cache[key]
+        value = super().get(key)
+        self._cache[key] = import_string(value)
+        return self._cache[key]
+
+
+@dataclass
+class WorkflowSite:
+    registered_assignees_methods: dict[str, Callable] = field(default_factory=dict)
+    registered_assignees_names: dict[str, str] = field(default_factory=dict)
+    registered_model_classes_serializer_map: CachedDict = field(default_factory=CachedDict)
+
+    @cached_property
+    def assignees_choices(self) -> tuple[str, str]:
+        autodiscover_modules("workflows")  # we have to do that because the filter choices loads at runtime
+        return tuple(self.registered_assignees_names.items())
+
+    @cached_property
+    def assignees_methods(self) -> tuple[str, Callable]:
+        return tuple(self.registered_assignees_methods.items())
+
+    @cached_property
+    def model_content_types(self):
+        return [
+            (model._meta.app_label, model.__name__) for model in self.registered_model_classes_serializer_map.keys()
+        ]
+
+
+workflow_site = WorkflowSite()

wbcore/contrib/workflow/static/workflow/markdown/documentation/assignedprocessstep.md

@@ -0,0 +1,33 @@
+# Assigned Process Steps
+
+A list of all active process steps that are assigned to the current user. A process step is the running instance of a step with all its relevant information. When a workflow is started a process step is created for every step that gets executed. Therefore, all fields are read-only.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Step:
+The step that is currently being executed.
+
+### Attached Model:
+The model the workflow is attached to (e.g. Activity). Used to display buttons in the model instances to steer the workflow, set a status field or evaluate conditions.
+
+### Workflow:
+The workflow that is currently being executed.
+
+### Started:
+Date and time at which this step was started.
+
+### Finished:
+Date and time at which this step was finished.
+
+### Group:
+The group that this process step is assigned to.
+
+### Permission:
+The permission that is needed to be able to view this item.
+
+### Status:
+The status that was set on the attached model when this step was executed.
+
+## Search Field:
+Typing in the search field allows to filter the process steps by workflow or step name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/condition.md

@@ -0,0 +1,24 @@
+# Conditions
+
+Conditions are always attached to a transition with a transition only being able to be triggered if **all** its conditions are satisfied. This provides the ability to conditionally turn on and off any transition by creating conditions. Conditions currently need an attached instance that can be evaluated which will look like this: `Attribute Name`      `(Negate) Operator`      `Expected Value`
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Transition:
+The transition this condition is attached to.
+
+### Attribute Name:
+The name of the attribute on the attached instance. Its value will be evaluated against the condition.
+
+### Operator:
+The operator can be any of the following: `<`, `>`, `<=`, `>=`, `=`.
+
+### Negate Operator:
+Indicates if the operator should be negated. Will effectively reverse the result of the condition.
+
+### Expected Value:
+The expected value of the attribute that will satisfy the condition.
+
+## Search Field:
+Typing in the search field allows to filter the conditions by attribute name or expected value.

wbcore/contrib/workflow/static/workflow/markdown/documentation/decisionstep.md

@@ -0,0 +1,30 @@
+# Decision Steps
+
+A decision step automatically activates the first transition that satisfies all of its conditions. Only really makes sense in conjunction with conditions that disable every transition but one.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the step.
+
+### Workflow:
+The workflow this step belongs to.
+
+### Status:
+The status that will be set in the attached instance's status field upon transitioning to this step. Only applicable if attached model is set.
+
+### Code:
+A number representation of this step. Must be unique per workflow.
+
+### Permission:
+Defines which permission is needed to be able to view this step being executed.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Transition:
+Displays every step that the specified transition is a part of.
+
+## Search Field:
+Typing in the search field allows to filter the steps by name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/emailstep.md

@@ -0,0 +1,45 @@
+# Email Steps
+
+An email step automatically sends out an email to a list of contacts before transitioning to the next step.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the step.
+
+### To:
+A list of receiving email adresses. Please make sure there are no duplicates in all email lists.
+
+### Subject:
+The subject of the email.
+
+### Template:
+The email template that will be used for creating the email.
+
+### CC:
+A list of email adresses that will receive a copy of the email.
+
+### BCC:
+A list of email adresses that will receive a blind copy of the email.
+
+### Workflow:
+The workflow this step belongs to.
+
+### Status:
+The status that will be set in the attached instance's status field upon transitioning to this step. Only applicable if attached model is set.
+
+### Code:
+A number representation of this step. Must be unique per workflow.
+
+### Permission:
+Defines which permission is needed to be able to view this step being executed.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Transition:
+Displays every step that the specified transition is a part of.
+
+## Search Field:
+Typing in the search field allows to filter the steps by name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/finishstep.md

@@ -0,0 +1,33 @@
+# Finish Steps
+
+A finish step is always the last step in a workflow.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the step.
+
+### Workflow:
+The workflow this step belongs to.
+
+### Write Preserved Instance:
+If "Preserve Instance" was selected in the related workflow this field provides the option of writing the previously saved data onto the attached instance to preserve its state throughout the workflow.
+
+### Status:
+The status that will be set in the attached instance's status field upon transitioning to this step. Only applicable if attached model is set.
+
+### Code:
+A number representation of this step. Must be unique per workflow.
+
+### Permission:
+Defines which permission is needed to be able to view this step being executed.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Transition:
+Displays every step that the specified transition is a part of.
+
+## Search Field:
+Typing in the search field allows to filter the steps by name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/joinstep.md

@@ -0,0 +1,33 @@
+# Join Steps
+
+A join step joins multiple steps into one. Waits until all incoming transitions are done by default. If _Wait For All_ is False the first incoming transition cancels all other active incoming transitions. The step of choice for merging different workflow trees back into one.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the step.
+
+### Workflow:
+The workflow this step belongs to.
+
+### Wait For All:
+Indicates wether the step will wait for all incoming transitions to be finished until triggering the next transition. If False, the step will instead cancel all other active incoming transitions as soon as it is reached before triggering the next transition.
+
+### Status:
+The status that will be set in the attached instance's status field upon transitioning to this step. Only applicable if attached model is set.
+
+### Code:
+A number representation of this step. Must be unique per workflow.
+
+### Permission:
+Defines which permission is needed to be able to view this step being executed.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Transition:
+Displays every step that the specified transition is a part of.
+
+## Search Field:
+Typing in the search field allows to filter the steps by name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/process.md

@@ -0,0 +1,33 @@
+# Processes
+
+Whenever a workflow is started, this creates a process with all relevant information from the workflow. Therefore, all fields are read-only.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Workflow:
+The executed workflow.
+
+### UUID:
+Unique identifier for this process.
+
+### Started:
+Date and time at which the workflow was started.
+
+### Finished:
+Date and time at which the workflow was finished.
+
+### Attached Model:
+The model the workflow is attached to (e.g. Activity). Used to display buttons in the model instances to steer the workflow, set a status field or evaluate conditions.
+
+## Legend:
+Click on a state in the legend to filter the list.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### States:
+Filter processes by a specific state they're in, smiliarly to what clicking on the legend does.
+
+## Search Field:
+Typing in the search field allows to filter the processes by workflow name or attached model.

wbcore/contrib/workflow/static/workflow/markdown/documentation/processstep.md

@@ -0,0 +1,51 @@
+# Process Steps
+
+A process step is the running instance of a step with all its relevant information. When a workflow is started a process step is created for every step that gets executed. Therefore, all fields are read-only.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### UUID:
+Unique identifier for this process step.
+
+### Step:
+The step that is currently being executed.
+
+### Process:
+The process that this process step belongs to.
+
+### Workflow:
+The workflow that is currently being executed.
+
+### Started:
+Date and time at which this step was started.
+
+### Finished:
+Date and time at which this step was finished.
+
+### Error Message:
+The error message in case this step failed.
+
+### Assignee:
+The person that this process step is assigned to.
+
+### Group:
+The group that this process step is assigned to.
+
+### Permission:
+The permission that is needed to be able to view this item.
+
+### Status:
+The status that was set on the attached model when this step was executed.
+
+## Legend:
+Click on a state in the legend to filter the list.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### States:
+Filter processes by a specific state they're in, smiliarly to what clicking on the legend does.
+
+## Search Field:
+Typing in the search field allows to filter the by workflow or step name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/scriptstep.md

@@ -0,0 +1,33 @@
+# Script Steps
+
+A script step automatically runs a provided python script before transitioning to the next step.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the step.
+
+### Workflow:
+The workflow this step belongs to.
+
+### Script:
+The script that will be executed by this step. Should be valid python and implement the function "run" that has exactly one argument called "process_step". To make changes on the attached instance, call `process_step.process.instance`.
+
+### Status:
+The status that will be set in the attached instance's status field upon transitioning to this step. Only applicable if attached model is set.
+
+### Code:
+A number representation of this step. Must be unique per workflow.
+
+### Permission:
+Defines which permission is needed to be able to view this step being executed.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Transition:
+Displays every step that the specified transition is a part of.
+
+## Search Field:
+Typing in the search field allows to filter the steps by name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/splitstep.md

@@ -0,0 +1,30 @@
+# Split Steps
+
+A split step activates all transitions that meet all of their conditions making it the step of choice for splitting a workflow into sub-trees that run simultaneously.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the step.
+
+### Workflow:
+The workflow this step belongs to.
+
+### Status:
+The status that will be set in the attached instance's status field upon transitioning to this step. Only applicable if attached model is set.
+
+### Code:
+A number representation of this step. Must be unique per workflow.
+
+### Permission:
+Defines which permission is needed to be able to view this step being executed.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Transition:
+Displays every step that the specified transition is a part of.
+
+## Search Field:
+Typing in the search field allows to filter the steps by name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/startstep.md

@@ -0,0 +1,27 @@
+# Start Steps
+
+A start step is always the first step in a workflow.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the step.
+
+### Workflow:
+The workflow this step belongs to.
+
+### Status:
+The status that will be set in the attached instance's status field upon transitioning to this step. Only applicable if attached model is set.
+
+### Code:
+A number representation of this step. Must be unique per workflow.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Transition:
+Displays every step that the specified transition is a part of.
+
+## Search Field:
+Typing in the search field allows to filter the steps by name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/transition.md

@@ -0,0 +1,27 @@
+# Transitions
+
+A transition connects two steps in a workflow.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the transition.
+
+### From:
+The originating step.
+
+### To:
+The target step.
+
+### Icon:
+The icon that will grace the transition buttons for user steps.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Condition:
+Displays the transition a selected condition is attached to.
+
+## Search Field:
+Typing in the search field allows to filter the transitions by name.

wbcore/contrib/workflow/static/workflow/markdown/documentation/userstep.md

@@ -0,0 +1,42 @@
+# User Steps
+
+A user step needs an assigned user or user group to manually pick the next transition.
+
+## Columns:
+Each column title has three lines on the right if you hover over it. Click on them to show options for that column. The second tab of the options menu will allow you to filter the column, the third to completely hide entire columns. Click on anywhere else on the column to order it, cycling between ascending, descending and no ordering. Hold shift while clicking to order multiple columns with individual weights.
+
+### Name:
+The name of the step.
+
+### Workflow:
+The workflow this step belongs to.
+
+### Status:
+The status that will be set in the attached instance's status field upon transitioning to this step. Only applicable if attached model is set.
+
+### Code:
+A number representation of this step. Must be unique per workflow.
+
+### Permission:
+Defines which permission is needed to be able to view this step being executed.
+
+### Assignee:
+A selected assignee needs to choose the next transition.
+
+### Group:
+From a selected group anyone can progress the workflow by choosing the next transition. Exclusive with assignee field.
+
+### Assignee Method:
+Automatically chooses a the step's assignee possibly picking from the provided group depending on the method's implementation. Exclusive with assignee field.
+
+### Notify User:
+If True, sends a notification to all assigned users to remind them that they need to pick the next transition.
+
+## Filters:
+Filters are accessed by clicking on the symbol in the top left corner of the window.
+
+### Associated Transition:
+Displays every step that the specified transition is a part of.
+
+## Search Field:
+Typing in the search field allows to filter the steps by name, assignee or group.