Manual:Extension/Workflows/Workflow Editor

Simple workflows can be created directly in the wiki using a workflow editor.

The workflow editor

At least the following two steps are required here:

1. Adding the workflow activities in the Workflow Editor
2. Setting up the Workflow Trigger
   

​After setting up a manual workflow trigger, users can start the workflow on any page.

Example: Obtaining a signature on a page

Let's look at a simple workflow:

After completing a page (e.g., meeting minutes), the signature of the department head John Doe is required.

required workflow steps

Create workflow

We need a workflow definition with two workflow activities:

1. User feeback (request signature): John Doe receives a feedback task. A feedback task adds a banner to the page. To complete the task, John Doe provides his feedback (for example: "noted").
   

   Workflow Banner
2. Edit wiki page (add signature): After completing the feedback task, the workflow automatically adds John Doe's wiki signature to the page.
   

   Inserted signature

To do this, we create a page with the extension .bpmn:

1. Click on the wiki's New button and enter the page name, e.g. Signature.bpmn.
   

   Create page using the "New" button
2. Click Done.
3. Open the page in edit mode. The diagram already shows the start activity.
4. Add the activity User feedback.
   

   activity "User feedback"
   1. Open the dialog box for the activity (via double-click) and enter the name of the activity (e.g., "request signature"),
   2. Add the user name and an instruction (e.g., "Sign this page")
      

      dialog box for activity "User feedback"
   3. Click on Save.
   4. Connect the StartEvent with the activity User feedback.
5. Add the activity Edit wiki page and connect it to the previous activity.
   

   Activity "Edit wiki page"
   1. Open the dialog box for the activity (via double-click) and enter the name of the activity (e.g. "add signature" or "sign page"),
   2. Specify the page on which the signature should be added. Normally this is the page on which the workflow is triggered. To do this, use the Magic word {{FULLPAGENAME}} as a placeholder.
   3. Specify the user name for the signature. (Note: In the next example we will see how the user name can be entered via a form when triggering the workflow, but in this example we will enter the name directly in the workflow for simplicity, since the same person always signs.)
   4. Enter four tildes as Content. This will automatically create the specified user's signature in the wiki.
   5. Mark the change (i.e. the insertion of the signature on the page) as a minor revision (Minor revision) if you do not want it to trigger a notification or display as the last change on overview pages in the wiki.
   6. Select Append as Edit mode. This will insert the signature at the end of the page.
      

      Dialog window for activity "Edit wiki page"
   7. Click on Save.
   8. Connect the activity User feedback with the activity Edit wiki page.
6. Add an EndEvent and connect it to the previous activity.
   

   EndEvent
7. Save the page.

The workflow should now look like this:

Finished workflow

The workflow can now be used in the wiki.

The next step is to activate the workflow in the wiki.

Create workflow trigger

So that the workflow can now be used on a page, we still need to create a trigger:

1. Click on Global Actions > Workflow Triggers.
2. Click on Add new trigger.
3. Select Manual as the type.
   

   Create a manual workflow trigger
4. Set up the workflow trigger:
   1. Enter the name as you want it to appear in the workflow menu on the page.
   2. Enter a short description as you want it to appear in the workflow menu on the page (optional).
   3. Select the workflow Signature as the workflow to start.
   4. Specify as a condition in which namespaces the workflow should be available (optional). If no condition is specified, the workflow is automatically available in all content namespaces.
      

      Trigger setup

Apply workflow

The workflow goes through the following steps:

1. Start workflow: Users with editing rights in the wiki can now start the workflow to request a signature from J. Doe. To do this, the workflow is triggered, for example, on a protocol page using the corresponding menu item.
   

   Select workflow
   A start dialog appears. Since there is no form for entering data here, the dialog can be closed with Start.
   

   Start the workflow
   The assigned user J. Doe receives an email and a task appears in his user menu in the wiki.
2. Execute workflow task: J. Doe checks the page and executes his assigned feedback task using the blue banner. It is possible that the banner does not display the name, but the name of a system message assigned to the workflow. You can create this in the wiki.
   

   Workflow Banner
3. Signature is added to the page: The wiki signature is automatically appended to the end of the page content.
   

   Inserted signature

---

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