This documentation is for frevvo v10.1. Not for you? Earlier documentation is available too.
Workflows in Confluence
Feature Retirement: frevvo for Confluence
Atlassian is dropping support for Confluence Server in 2024 and encouraging customers to migrate to Confluence Cloud. The frevvo plug-in is not compatible with Confluence Cloud. Existing frevvo for Confluence licenses will be supported, but frevvo for Confluence will not be available for new customers.
Please see the frevvo for Confluence page for details about this announcement and recommendations.
Creating multi-user workflows in Confluence
Using frevvo for Confluence, you can automate this entire workflow so that it is completely electronic in Confluence.
Consider a Vacation Request workflow. An employee wants to request vacation and fills out the appropriate portion of a paper form. The form is then handed over to a manager who must approve the vacation request, sign the form, notify the employee and file the paper form and/or notify HR.
The steps are as shown in the figure above:
- An employee goes to a Confluence page that contains the workflow.
- Since the employee does not belong to the 'manager' Confluence group, he will only see the relevant portion of the form.
- The employee fills it in and clicks a Continue button.
- frevvo puts the task on the manager's task list, [optionally] notifies the manager by email and displays a confirmation message to the employee.
- When the manager logs in, she visits a Confluence page that contains her task list.
- The employee's vacation request will be displayed in the task list.
- The manager performs the task. Since she belongs to the 'manager' Confluence group, she will see the manager-specific portions of the form. The employee-specific portions are automatically pre-filled.
- She approves/rejects the vacation request, digitally signs the form and clicks Finish.
- The employee is notified by email, and [optionally] a PDF image of the form is sent to the internal document management system or to Google Apps or saved in frevvo' submissions repository.
Now, let's go through the process of building this workflow in Confluence.
Setup roles in frevvo
View the multi-user workflows video to see details of creating these roles.
Assume that you have groups in Confluence called 'employee' and 'manager'. To create these roles in frevvo:
- Login to frevvo as the administrative user for the tenant that was created in Confluence.
- Click the Manage link at the top right of the page.
- On the page that is displayed, click the 'Manage Roles' link.
- Click the icon and in the form that is displayed type in the desired role. Make sure that the role names match exactly (including case).
Create the Vacation Request workflow
Read the documentation on adding workflows to Confluence pages.
Read the general frevvo documentation on designing workflows for a detailed discussion of frevvo workflows and their features.
Here are some steps to follow to create the Vacation Request workflow:
- Add a Confluence Page (say, Vacation Request Flow) and Add a workflow to it.
- Use the Workflow Design Wizard to create two steps:
- Vacation Request - Create New Form - No Assignment
- Manager Approval - Approval Step - Assign to Role - Select the role 'manager'.
Customize Workflow Step Properties
- Click the Vacation Request Step. On the Settings tab, set the Continue Label to 'Send to Manager'
- Click the Manager Approval step, then the Assignment tab. Notice that the assignment was already set for you and some default text was added to the Task Notification email Subject and Message fields. Customize the Email Message to include a link to the Task List page in Confluence.
- Click the Messages tab.
Set the Task Info for the second step to 'Vacation Request for {FirstName} {LastName}'.
- Set the Pending Msg for the second step to 'Your request has been forwarded to your manager.'
Edit the Vacation Request form
Read the general frevvo documentation on designing forms for a detailed discussion of forms and their features.
Here are some steps to follow to create the Vacation Request form:
- Go to Forms editing mode in the Guided Designer Navigation bar of your workflow.
- Notice that the Workflow Design Wizard added several controls for you. You can edit them, remove them, and drag/drop new controls on the form as desired.
- In the Figure below, we have
- Relabeled the My Items section for the employee to 'Request.'
- Added a date control 'Start Date' and a Number control 'Number of Days'
- Deleted the wet signature control and enabled digital signatures for this Section by clicking on the Section header and then on the Security Tab in the properties pane to the left. In the Security Tab, Text/Signature image is selected, and the Must Sign box is checked.
Send an Email when the Workflow is Submitted
Next you can configure a Doc Action email to send when the workflow is completed.
- Go to Settings editing mode in the Guided Designer navigation toolbar.
- Click on the Document Actions tab and select Send Email.
- In the wizard, for the To address select the Email control to generate a template. When the workflow is completed, frevvo will send an email to the address that was entered in the Email control in the form.
- Customize the Subject and Message for the email as desired.
- Select the documents that you want to attach to the email. Minimally, select PDF from the 'Send Snapshot' drop down. Other options are described below:
- Send the data as a PDF attachment or other image type using the Send Snapshot dropdown. The image type options are PDF, PNG or JPG. Select the blank option from the dropdown to exclude this attachment in the email.
- Attach an XML data document using the Data checkbox.
- Attachments uploaded to your form/workflow are included if the Attachments checkbox is checked.
If you have Pixel Perfect mapped PDFs (ex: W-4, I-9 etc…) associated with your forms/workflows, choose the action you want to take from the Send Gen Forms control :
•Check All to send all the Pixel Perfect PDFs. This is the default value.•Check None to send none of the PDFs•Check Select to display a list of all the PDFs associated with your form/workflow. Click the ones you want to be part of the submission. Hold down the Shift key then click the files in the list to select all PDFs or hold the control key and click specific PDFs.
- Save the workflow.
Create the Task List page
View the multi-user workflows video for more information if you are using Confluence v4.0 - v4.2. In Confluence v5.1, the Add Form, Add Flow, Add Submissions, and Add Task functions are located on the Tools Menu.
Read the documentation on adding tasks to Confluence pages.
Read the general frevvo documentation on designing workflows for a detailed discussion on using the task list
To create the Task List page,
- Add a Confluence page (say, Task List) and Add Tasks to it.
Use the workflow
View the multi-user workflows video to see an example workflow being used.
To use the Vacation request workflow:
- Login to Confluence as an employee.
- Navigate to the 'Vacation Request Flow' Confluence page, to which you added the workflow.
- You cannot see the Manager Approval section since you do not belong to the 'manager' Confluence group.
- After signing the request, the 'Send to Manager' button will be enabled. Click the button to send the request to a manager. You can also send the request to a specific person rather than any user in the group manager
- Login to Confluence as a manager.
- Navigate to the 'Task List' Confluence page, to which you added the task list above.
- Click the icon to perform this task.
- The form will be displayed in its original Confluence page.
- Fill in the Manager Approval section.
- You must sign the section before the workflow can be completed.
- Notice that you cannot edit the employee's request data because of the digital signature. You can override this in the workflow designer and allow the manager to remove the signature and edit the section.
- Once completed, the Finish button will be enabled. Finish the workflow to send an email to the employee.