Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

 

...

Section
Column

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

Warning

Confluence v4.x has a new macro browser feature. It is very important to know that the plugin 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 plugin add-on adds to the Confluence Add menu. This is discussed in the sections belowin 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 plugin 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 plugin add-on configuration, you must belong to that group).

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

 

Adding a Form to a Confluence Page

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 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 See Templates in the  documentationthe  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

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.

...

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

Some wizards are (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.

...

 can be styled to blend in nicely to the look and feel you choose for your web pages. The form's base style depends on which  Theme you have selected for your form. To change the theme, select a theme from your form's Style Properties Theme dropdown. By default  provides two different themes: Clear Nouveau and Professional Nouveau Blue. You can also override style for font, color, width, etc.. in the form's 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 margin, padding, font color, background color, bold, italic, etc.

If required, you can also add your own Custom Themes.

Info

If you add multiple forms to the same Confluence web page, they must all use the same Theme.

 Themes.

Multiple macros on a Confluence page

...

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  uses roles for a variety of reasons including digital signatures on forms and workflows. When used with Confluence, the plugin 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.

...

Form submissions can be viewed directly in your Confluence page. To add Submission to any page, select the Submissions menu item. This menu item is available only when the Confluence plugin 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.

Image Removed
Adding a Form to a Confluence page

Image Removed

The Add Submissions Page

 The .

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 Submissions from the menu choices.

Image Added

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.

Image Added

Warning

Only the form designer has the permissions to view the submissions. If you want other users to view submissions use the Create/Update or Merge to Page features. This security restriction may be relaxed in a future release

...


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.

...

Adding a flow to a Confluence page is exactly like adding a form. Click the Confluence Add button and select the Flow menu itemthe Flow menu item for Confluence v4.0 - 4.2. To add a flow to a page in Confluence v5.1, click on the Tools Menu and select Add Flow from the menu choices.
This menu item is available only when the Confluence plugin 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 plugin add-on configuration, you must belong to that group).

...

Section
Column

Editing a Flow
Column

You can edit any flow after adding it to a Confluence page by clicking the Edit Flow link at the top of the flow. This link is only visible if you have permission to edit the flow in question. Clicking this link will launch the Flow Designer. Make your changes and click Finish in the Designer. The updated flow 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 Flow

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

...

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

Some Wizards are  (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.

...

Please refer to the general task list documentation for details on using the task list.

Note

The Quick View feature is not available in the frevvo Confluence plugincan be configured in the designer but the icon will not display when the Task List is added to a Confluence page. This may be enabled in a future release.

 

Usage Scenarios

The menu items you see and the actions you can perform depend upon the logged in Confluence user's permissions. Some scenarios are outlined below.

...

Login to Confluence as a user in the Form Designers group. If you did not select a group, login to Confluence as a user. See Configuring the pluginadd-on

Adding Forms

  1. Create a new page (say, Test Form) in Confluence by clicking the Add Page button for Confluence v4.0 - 4.2. To add a page in Confluence v5.1, click Create Child Page on the Space sidebar.
  2. Add a Form as described above.
  3. If you create a new form, you'll be taken to the Form Designer, where you can drag/drop controls, set properties etc. to design your form. Otherwise, the existing form will be added to your Confluence page.

...

  1. Create a new page (say, Test Flow) in Confluence by clicking the Add Page button  for Confluence v4.0 - 4.2. To add a page in Confluence v5.1, click Create Child Page on the Space sidebar..
  2. Add a Flow as described above.
  3. If you create a new flow, you'll be taken to the Flow Designer, where you can drag/drop forms, set properties etc. to design your flow. Otherwise, the existing flow will be added to your Confluence page.

...

  1. Create a new page (say, Test Submissions) in Confluence by clicking the Add Page button for Confluence v4.0 - 4.2. To add a page in Confluence v5.1, click Create Child Page on the Space sidebar..
  2. Add Submissions as described above.
  3. The list of submissions is visible on the page.

...

  1. Create a new page (say, Test Tasks) in Confluence by clicking the Add Page buttonAdd Page button for Confluence v4.0 - 4.2. To add a page in Confluence v5.1, click Create Child Page on the Space sidebar..
  2.  Add Tasks as described above.
  3. Your task list is displayed on the page.

...

Login to Confluence as a different user in the Form Designers group. If you did not select a group, login to Confluence as a different user.  See Configuring the pluginadd-on.

Using a Form

  1. Navigate to the Test Form page.
  2. You can use the form and submit it but you cannot edit it.

...

  1. On any Confluence page, where you have permission to Edit the page, you will see the Add Form, Add Flow, Add Submissions and Add Tasks links under the Add Menu for Confluence v4.0 - 4.2. They are located on the Tools Menu in Confluence v5.1.

Login as a non-Designer user 

Login to Confluence as a user who is not in the Form Designers group.  See Configuring the pluginadd-on.

Using a Form

  1. Navigate to the Test Form page.
  2. You can use the form and submit it but you cannot edit it.

...

  1. On any Confluence page, where you have permission to Edit the page, you may see only the Add Tasks link under the Add Menu . Users for Confluence v4.0 - 4.2.  They are located on the Tools Menu in Confluence v5.1. Users who do not belong to the Form Designers group cannot design forms. If you see the menu items and click on the wrong ones, you will get an error message.

...