Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
The  Confluence add-on is available for both Confluence v3.x and v4.
Section
Column
Section
Column

The  Confluence add-on is available for both Confluence v3.x and v4.x. See  add-on installation for details.

Warning

Confluence v4.x has a new macro browser feature. It is very important to know that the add-on macros DO NOT work when added via the new Confluence v4.x macro browser.

Thus do NOT try to add macros via the Confluence Insert > Other Macro menu or by typing '{' and choosing either Open Macro Browser or typing the name of a macro. See accessing the Confluence Macro Browser for more details of what NOT to do.

You must add the form/workflow, submissions and task macros to your page using the Add menu options that the add-on adds to the Confluence Add menu. This is discussed in the sections below.

However, if you are using versions 4.3 - 5.1, you CAN use the macro browser to add them. Refer to this documentation for the details.

Column
width240px

On This Page:

Table of Contents
maxLevel1
 

...

Add a form to a Confluence page by selecting the Form menu item. This menu item is available only when the Confluence add-on is correctly installed and configured and you are logged in to Confluence as a user with the appropriate permissions (you must be able to Edit the Confluence page and, if you configured a Form Designer group in the add-on configuration, you must belong to that group).

The Add Menu in Confluence 4.x is shown in the image below:

 Image Removed

The Add Menu in Confluence v5.1 has changed. Click on the Tools Menu then select Add Form from the menu choices.

Image Removed

The Add Form page will be displayed. Here you can either:

  • Create a new form. Enter a name and click Add. This will launch the Form Designer where you can drag and drop controls, change labels etc. When you click Finish in the Form Designer the form will be added to your Confluence page.
  • Choose a form template. Templates are published by the administrative user and serve as starting points for your own forms. See Templates in the  documentation. Choose a template and click Add. It will be copied to your user account and the form will immediately get added to the Confluence page.
  • Choose an existing form. This will show the forms that you have previously created. Select one and click Add; the form will immediately be added to the Confluence page.

Image Removed

Edit a Form

...

Column

Image Removed

Editing a Form

...

.

The Add Menu in Confluence 4.x is shown in the image below:

 Image Added

The Add Menu in Confluence v5.1 has changed. Click on the Tools Menu then select Add Form from the menu choices.

Image Added

The Add Form page will be displayed. Here you can either:

  • Create a new form. Enter a name and click Add. This will launch the Form Designer where you can drag and drop controls, change labels etc. When you click Finish in the Form Designer the form will be added to your Confluence page.
  • Choose a form template. Templates are published by the administrative user and serve as starting points for your own forms. See Templates in the  documentation. Choose a template and click Add. It will be copied to your user account and the form will immediately get added to the Confluence page.
  • Choose an existing form. This will show the forms that you have previously created. Select one and click Add; the form will immediately be added to the Confluence page.

Image Added

Edit a Form
Section
Column

Image Added

Editing a Form

Column

You can edit any form after adding it to a Confluence page by clicking the Edit Form link at the top of the form. This link is only visible if you have permission to edit the form in question. Clicking this link will launch the Form Designer. Make your changes and click Finish in the Designer. The updated form will now be displayed in Confluence.

Warning

It is very important to understand that if the same flow is added to multiple Confluence pages, then edits to the flow on one Confluence page will effect that flow on all Confluence pages

Delete a Form

You can delete any form from a Confluence page by clicking the Delete icon at the right end of the toolbar at the top of the form. This

...

icon is only visible if you have permission to

...

delete the form in question.

...

Warning

It is very important to understand that if the same flow is added to multiple Confluence pages, then edits to the flow on one Confluence page will effect that flow on all Confluence pages

Delete a Form

You can delete any form from a Confluence page by clicking the Delete icon at the right end of the toolbar at the top of the form. This icon is only visible if you have permission to delete the form in question.

Designing Forms

The Live Forms Designer is the heart of ' simple, quick, no-coding required form creation. The Forms Designer enables you to add controls quickly to your form, customize their appearance and layout, and add rules that affect the behaviour of the form.

Please refer to the Getting Started Guide and the Designing Forms chapter for detailed instructions on Form Designer usage.

Using and Submitting Form

Where does the form data go when the user clicks the Submit button? Please refer to Document Action Wizards in the  documentation.

What does the user see when they click the Submit button? Please refer to Form Action Wizards in the  documentation.

Some wizards (Create/Update Confluence Page Wizard and the Merge to Confluence Page Wizard) are only applicable to and visible from Confluence. These are wizards to Create/Update Confluence pages and to Merge form data into a Confluence page.

Styling Forms

 can be styled to blend in nicely to the look and feel you choose for your web pages. The form's base layouts/styles depend on the selections for your form. To change the layout/style, select one from the dropdowns of your form's Style Properties . By default  provides four layouts and four styles. You can customize styles for font name, background color, etc. from the  Style tab. In addition, each control on your form can be customized via its own Control Style Properties. Here you can style such things as  width, background color, label size and color, bold, italic, etc. 

Multiple macros on a Confluence page

You should not add multiple forms, flows, submissions or task lists to a single Confluence page. Each form, flow, submission and task macro must be on its own page. If you do, you may experience one or more issues such as:

  1. The forms may not automatically resize to the proper size initially. The workaround is to manually set the initial height/width of the form in the Form Designer so that it initially renders correctly. You can find instructions for doing so at Form Style Properties. You only need to manually set the initial height of the form. Subsequent resizing will be performed automatically.
  2. If the designer deletes one of the forms from the page all of the forms will be deleted.
  3. If the forms are a mix of public and private visibility you will get access denied.
  4. If a form and a submission are on the same page you may also experience permission denied to view the submission even when the user does have permission.

Using Roles (Confluence Groups)

Info

Roles must be manually created in the ' server corresponding to the Confluence groups that you actually want to use in your forms or workflows. This is a one-time setup that will have to be performed by an administrator.

 uses roles for a variety of reasons including digital signatures on forms and workflows. When used with Confluence, the add-on will automatically map Confluence Groups to  roles. However, in order to use these roles in the Form or Flow Designer, your administrator will have to create the roles in Confluence as a one-time setup task.

Assume that you have groups in Confluence called 'employee' and 'manager'. To create these roles in :

  1. Login to  as the administrative user for the tenant that was created in Confluence.
  2. Click the Manage link at the top right of the page.
  3. On the page that is displayed, click the 'Manage Roles' link.
  4. Click the Image Removed icon and in the form that is displayed,  type in the desired role. Make sure that the role names match exactly (including case).

Form Submissions

Viewing Form Submissions

Form submissions can be viewed directly in your Confluence page.

Designing Forms

The Live Forms Designer is the heart of ' simple, quick, no-coding required form creation. The Forms Designer enables you to add controls quickly to your form, customize their appearance and layout, and add rules that affect the behaviour of the form.

Please refer to the Getting Started Guide and the Designing Forms chapter for detailed instructions on Form Designer usage.

Using and Submitting Form

Where does the form data go when the user clicks the Submit button? Please refer to Document Action Wizards in the  documentation.

What does the user see when they click the Submit button? Please refer to Form Action Wizards in the  documentation.

Some wizards (Create/Update Confluence Page Wizard and the Merge to Confluence Page Wizard) are only applicable to and visible from Confluence. These are wizards to Create/Update Confluence pages and to Merge form data into a Confluence page.

Styling Forms

 can be styled to blend in nicely to the look and feel you choose for your web pages. The form's base layouts/styles depend on the selections for your form. To change the layout/style, select one from the dropdowns of your form's Style Properties . By default  provides four layouts and four styles. You can customize styles for font name, background color, etc. from the  Style tab. In addition, each control on your form can be customized via its own Control Style Properties. Here you can style such things as  width, background color, label size and color, bold, italic, etc. 

Multiple macros on a Confluence page

You should not add multiple forms, flows, submissions or task lists to a single Confluence page. Each form, flow, submission and task macro must be on its own page. If you do, you may experience one or more issues such as:

  1. The forms may not automatically resize to the proper size initially. The workaround is to manually set the initial height/width of the form in the Form Designer so that it initially renders correctly. You can find instructions for doing so at Form Style Properties. You only need to manually set the initial height of the form. Subsequent resizing will be performed automatically.
  2. If the designer deletes one of the forms from the page all of the forms will be deleted.
  3. If the forms are a mix of public and private visibility you will get access denied.
  4. If a form and a submission are on the same page you may also experience permission denied to view the submission even when the user does have permission.

Using Roles (Confluence Groups)

Info

Roles must be manually created in the ' server corresponding to the Confluence groups that you actually want to use in your forms or workflows. This is a one-time setup that will have to be performed by an administrator.

 uses roles for a variety of reasons including digital signatures on forms and workflows. When used with Confluence, the add-on will automatically map Confluence Groups to  roles. However, in order to use these roles in the Form or Flow Designer, your administrator will have to create the roles in Confluence as a one-time setup task.

Assume that you have groups in Confluence called 'employee' and 'manager'. To create these roles in :

  1. Login to  as the administrative user for the tenant that was created in Confluence.
  2. Click the Manage link at the top right of the page.
  3. On the page that is displayed, click the 'Manage Roles' link.
  4. Click the Image Added icon and in the form that is displayed,  type in the desired role. Make sure that the role names match exactly (including case).

Form Submissions

Viewing Form Submissions

Form submissions can be viewed directly in your Confluence page. By default, the designer who created the form/flow can view/edit submissions. If you want  non-designer users to have the ability to view/edit submissions, verify the following:

  • These Confluence users must belong to the groups assigned in the Form Designer Group and Form Editors Group fields on your plug-in configuration. 
  • Those users are assigned the view/edit permission in the Access Control list for the form/flow.    

Adding Submissions to a Confluence Page

To add Submission to any page, select the Submissions menu item. This menu item is available only when the Confluence add-on is correctly installed and configured and you are logged in to Confluence as a user with the appropriate permissions. Refer to Viewing Submissions in Excel for information about time data exported to an Excel worksheet.

The Add Menu in Confluence 4.x is shown in the image below:

The Add Menu in Confluence v5.1 has changed. Click on the Tools Menu then select Add Submissions from the menu choices.

The Add Submissions page displays. Select a form or flow from the dropdown and click "Add". The submissions view will be added to your Confluence page. Submissions are displayed in a table view. Double click on any submissions to view all of the data. Please refer to Viewing Form Submissions in the  documentation for a full description of all the features.

...

Downloading Form Submissions to Excel

Click the Excel icon above the graph to view the submission results in Excel. The spreadsheet reflects the specific date range indicated by the two date controls; this date range will be listed in your spreadsheet.

...