Manual:Extension/Workflows/Activity/GroupFeedback: Difference between revisions

Latest revision as of 16:04, 19 June 2024

Description

This activity allows users from the group specified in the assigned_group (or assigned_users) property to provide feedback on the workflow. The feedback can be a comment, a rating, or both. The activity can be configured to require a minimum number of users to provide feedback before the workflow can continue. The actual number of required users is controlled by threshold properties.


Short profile
Name	GroupFeedback
Async
BPMN type	`bpmn:task`
BPMN Extension Element "wf:type"	`group_feedback`

Properties

Name of property	Description	Type
`assigned_group`	Name of a wiki group	string
`assigned_users`	Individual user	string
`instructions`	Instructions provided to the assigned users	string
`comment`	Comment saved with this task	string
`due_date`	Task duration	date
`threshold_unit`	Number of users or percentage of assigned users	string
`threshold_value`	absolute number or percentage	integer

Example

<bpmn:task id="GroupFeedback" name="Group feedback">
	<bpmn:extensionElements>
		<wf:type>group_feedback</wf:type>
	</bpmn:extensionElements>
		<!-- Can be substituted for `assigned_users` to defined a fixed set of assigned users, instead of a group -->
		<bpmn:property name="assigned_group">sysop</bpmn:property>

		<bpmn:property name="instructions"></bpmn:property>
		<bpmn:property name="comment"/>
		<bpmn:property name="users_feedbacks"/>
		<bpmn:property name="due_date">20221201101010</bpmn:property>
		<bpmn:property name="threshold_unit">user</bpmn:property>
		<bpmn:property name="threshold_value">2</bpmn:property>
  ...

</bpmn:task>

To submit feedback about this documentation, visit our community forum.

@@ Line 1: / Line 1: @@
 ==<span class="mw-headline">Description</span>==
-The UserFeedback activity sends a task to a user to provide feedback on the page where the workflow was initiated. It is possible to have multiple Feedback activities running on a page.
+This activity allows users from the group specified in the <code>assigned_group</code> (or <code>assigned_users</code>) property to provide feedback on the workflow. The feedback can be a comment, a rating, or both. The activity can be configured to require a minimum number of users to provide feedback before the workflow can continue. The actual number of required users is controlled by threshold properties.
 {| class="wikitable"
 |+
@@ Line 6: / Line 6: @@
 |-
 | style="" |Name
-| style="" |UserFeedback
+| style="" |GroupFeedback
 |-
 | style="" |Async
-| style="" |Yes
+| style="" |
 |-
 | style="" |BPMN type
-| style="" |<code>bpmn:userTask</code>
+| style="" |<code>bpmn:task</code>
 |-
 |BPMN Extension Element "wf:type"
-|<code>user_feedback</code>
+|<code>group_feedback</code>
 |}
@@ Line 25: / Line 25: @@
 ! style="background-color:rgb(234, 236, 240);text-align:center;" class="" |'''Type'''
 |-
-| style="" |<code>assigned_user</code>
+| style="" |<code>assigned_group</code>
-| style="" |The comment to be saved with the approval
+| style="" |Name of a wiki group
 | style="" |string
+|-
+|<code>assigned_users</code>
+|Individual user
+|string
 |-
 |<code>instructions</code>
-|User who approved the page
+|Instructions provided to the assigned users
 |string
 |-
 |<code>comment</code>
-|Comment provided to the assigned user
+|Comment saved with this task
 |string
 |-
@@ Line 40: / Line 44: @@
 |Task duration
 |date
+|-
+|<code>threshold_unit</code>
+|Number of users or percentage of assigned users
+|string
+|-
+|<code>threshold_value</code>
+|absolute number or percentage
+|integer
 |}
+== Example ==
+<syntaxhighlight lang="text">
+<bpmn:task id="GroupFeedback" name="Group feedback">
+	<bpmn:extensionElements>
+		<wf:type>group_feedback</wf:type>
+	</bpmn:extensionElements>
+		<!-- Can be substituted for `assigned_users` to defined a fixed set of assigned users, instead of a group -->
+		<bpmn:property name="assigned_group">sysop</bpmn:property>
+		<bpmn:property name="instructions"></bpmn:property>
+		<bpmn:property name="comment"/>
+		<bpmn:property name="users_feedbacks"/>
+		<bpmn:property name="due_date">20221201101010</bpmn:property>
+		<bpmn:property name="threshold_unit">user</bpmn:property>
+		<bpmn:property name="threshold_value">2</bpmn:property>
+  ...
+</bpmn:task>
+</syntaxhighlight>