Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Warning
titleFeature 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.


Section


Column


Note

Make sure that you have read and understood the section Using frevvoresolve macro.

Tip

View the video Create/Update Confluence Pages for more information, if you are using Confluence v4.0 - 4.2. The way of adding and parsing templates has changed in v4.3 and v5.1. Refer to this documentation for information about templates in these versions.



Column
width240px

On This Page:

Table of Contents
maxLevel4
 



Confluence Page Hierarchy

Using Live Forms 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.

...

Warning

The macro syntax is different if you are using the add frevvo add-on for Confluence v3.x versus the add 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:

...

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.

...

  • Save the Confluence Template.
  • On the Client Information Page, click on the Edit button.
  • Click the Image Removed Edit Form/workflow Properties wizard Settings in the designer Guided Designer Navigation toolbar.
    Image Added
  • Click on Form Action and select the Create/Update Confluence page form action.

    Image RemovedImage Added

  • Type a name for the results page in the Results Page field and the name of the Client Information template in the Template field. Make sure that you enter the Template name exactly including spaces. For the Result Page, we are using a template {ClientName}. This is a field in the form. For example, if the field in the form contained Toyota, the generated result page in Confluence will be named Toyota. The Parent and Display pages are optional. Use control templates from your form by selecting them from the dropdowns. Click the to see the control list.
    Image RemovedImage Added

  • Click Submit to save the changes and exit the Form Properties wizard.Click Submit Image AddedSave and Close to save the changes to the Client Information Form and exit the designer.
  • Enter data into the Client Information form and click Submit.
  • The result page displays a table with the entered client information displayed in the first row of the table.
  • Access the Client Information Page again. Enter information for a different client.
  • The result page displays a table with the Client information from both submissions in the first and second row of the table.

...

  • The form is submitted with the new values
  • The user with the edit lock logs out of the frevvo server. Note that a logout of Confluence does not trigger a corresponding logout of frevvo.
  • The user with the edit lock's session expires to the form server

...

Warning

Make sure that you have read and understood the section on using /wiki/spaces/frevvo100/pages/1062994254 that generates 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 /wiki/spaces/frevvo100/pages/1062994254 that frevvo generates carefully before you edit your forms.

When you edit a form/workflow for which form action is setup as create/update, the message shown in the image 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."

Image RemovedImage Added

Moving Pages created by

...

frevvo/Confluence to a new space

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.

...