frevvo Latest - This documentation is for frevvo v10.1. Not for you? Earlier documentation is available too.
Using frevvo for Confluence, you can create forms/workflows that store the form data in a Confluence page. The Confluence page can also be updated (edited) using the same form/workflow. Consider the page hierarchy in the Figure above. We are creating an internal Client Management application with a Confluence page for each client. In the example, above we have a page for Ford, GM and Toyota. Each page stores information about the client such as Address, Phone Number, Contact Information etc. The goal is to be able to create these pages in a structured manner using a form or workflow and edit these pages using the same form/workflow rather than allow free-form editing of the Confluence page by users.
The steps are as shown in the Figure above.
We assume that you are familiar with Confluence templates. If not, please first read the Confluence documentation and familiarize yourself with Confluence templates.
Create a standard Confluence template and embed frevvoresolve macros in it.
The macro syntax is different if you are using the frevvo add-on for Confluence v3.x versus the frevvo add-on for Confluence v4.x
Here is an example template using the frevvoresolve macros in Confluence v3.x for our Client Information example:
Here is the same example template using the frevvoresolve macro in Confluence v4.0 - v4.2
Here is a more complex example template using the frevvoresolve macro in Confluence v4.0 - v4.2 for an Expense Report example:
The template syntax changed once again in Confluence v4.3 and v5.x. Here is a video showing how to create a template by adding frevvo macros to the template using the Confluence macro browser. The steps to create a template differ slightly from the video if you are using Confluence v4.3. Refer to the Confluence Documentation for this information. The method to add the frevvo macros using the macro browser is the same in v4.3 and v5.x.
Here are the steps to follow to create the Client Information template shown in the video using Confluence version 5.1:
If you make changes to a template, existing result pages will not reflect the changes. This is as-designed. Merge to page only uses the template the first time. In subsequent merges, the macros from the result page are used and not the template. A new version of the template requires a new result page to reflect the updates to the template.
The "Save" property on the Form Properties Settings tab must be checked for Create/Update to work.
Fill out the form and Submit it. The result page is shown below.
Time and Date/Time controls are displayed in UTC when used on a result page in Confluence. See the image below:
The Confluence pages created from your form submissions can also be updated (edited) using the same form/workflow. In order to update a Confluence page you must have the special frevvoresolve edit link in the page template. See the sample templates in the documentation above as they demonstrate the use of the form.edit.link macro body.
The edit link is resolved to a hyperlink when the Confluence page is created.
When you click on the hyperlink it will open the original form used to create this page. The data values from the page will be used to initialize the form. In other words the form will not load blank but rather will load with all the data as displayed in the Confluence page. Once the data is reloaded in your form or workflow the user can edit the form fields and resubmit the form. This will update the Confluence page with the new values.
When a Confluence user clicks the edit link, the submission becomes locked. It will unlock when one of the following occur:
If another user attempts to simultaneously edit the same Confluence, they will see an error message "Error Access Denied. Task locked by user:<username>". If you are using templates with frevvo edit links it is good practice to set the session timeout to some shorter time then the default 8 hours. See setting the default session timeout.
The following restrictions exist:
Make sure that you have read and understood the section on using XML Documents that frevvo generates.
Once your form is in use, your users have submitted the form a few times and Confluence pages have been created from those submissions, you must be careful when making edits to the form. If you make incompatible changes to the form - essentially, if you change the structure of the form in such a way that it is incompatible with the original structure - your users may not be able to Edit their existing Confluence pages using the form. That's because the Edit Confluence page functionality relies on initializing the form with the XML document generated by frevvo. Please read the above-mentioned Section on XML Documents that frevvo generates carefully before you edit your forms.
When you edit a form/workflow for which form action is setup as create/update, a warning message will display as a warning in the designer: "Warning: This form is configured to create/update Confluence pages. Changing the structure of the form could cause existing page edits to fail. Please see the documentation for more information."
Let's say you had a form in a Confluence space called Space1. When the form is submitted, result pages were created as a result of the form action for the form. The result pages were child pages of the form page and displayed information entered in the form. Also on the page was an edit link to each form so that a user could go back and edit the information if something changed. You move the form and it's child pages to Confluence Space 2. In the second space, you click the edit button on one of the result pages, edit the information and then click the finish button. The following error displays:
When you move a form page and the child pages associated with it to a new space, frevvo will search for the Parent page in the new space. In this case, the parent page did not get moved to the new space. frevvo will not find it in the space where the form is now (new) and an error is displayed. One of the following approaches should prevent the error from happening:
1. Move the form and it's parent page (this will automatically move all the child pages) to the new space. frevvo will find the Parent page in the new space and create/update will work correctly.
2. Create the parent page manually in the new space with the same name as the old space before moving the child pages. Move the child pages under this parent page.