Live Forms Latest - This documentation is for Live Forms 9.0. Not for you? Earlier documentation is available too.

Skip to end of metadata
Go to start of metadata

The Live Forms Confluence add-on is available for both Confluence v3, v4 and v5.1. See Live Forms add-on installation for details. The Live Forms macro syntax depends on your version of Confluence.

It is very important to know that the Live Forms add-on macros DO NOT work when added via the Confluence v4.0 - 4.2 macro browser. See Live Forms add-on usage for details. However, if you are using versions 4.3 or 5.1, you CAN use the macro browser to add them. See below for more information.

On This Page:

Live Forms macros

frevvoform macro

Add Live Forms and flows to your Confluence page via the Add menu options that the Live Forms add-on incorporates into the Confluence's Add menu. The Add > Form and Add > Flow menu items described in detail in Using the add-on automatically add the frevvoform macro to your page with the correct form identification.

In Confluence v3.x the macro looks like this:

In Confluence v4.x - 5.1, the macro looks like this:

DO NOT use the new Confluence v4.x macro browser to add a frevvoform macro to your page. See Live Forms Confluence add-on usage for details. However, you CAN use the macro browser to add the frevvoform macro to your form if you are using Confluence versions 4.3 -5.1.

You can customize the appearance of the form or flow by editing the parameters to the macro as described below:

ParameterValuesDefaultMeaning
 center  true or falsefalseCenters the form on the page. This property applies only when container=true.
containertrue or falsetrueGenerates a border around the form if true. If set to false, the frame will not be seen and hence the Edit and remove buttons will go away too.
_dataLive Forms generated valuegeneratedUsed to initialize the form. You can add parameters here but do not remove the existing ones auto-added by the Live Forms add-on. See the documentation for more information.
formtypeidLive Forms generated value The internal ID of the form/flow. Do not modify. Not visible in Confluence v4.x.
formtypeurlLive Forms generated value The internal URL of the form/flow. Do not modify. Not visible in Confluence v4.x.
heightnumeric The initial height of the form. Used when you disable auto-resizing.
locale3 letters The desired locale (e.g. ger, dan, ara etc.). The form will be rendered in the specified language. See the multi language support documentation for more information.
resizetrue, false, vert or horz Automatically resizes the form. vert enables vertical resizing only and horz enables horizontal resizing only. Auto-resizing can add a URI fragment to the browser URL. If you need to use URI fragments, you must disable auto resizing
scrollingno, yes, or autoautoIf no, scrollbars will never appear, if yes, scrollbars will always be present, if auto, they will be present if required. This property is redundant when resize is true. Auto-resizing will always ensure that the frame is big enough so that scrollbars never appear.
widthnumeric The initial width of the form. Used when you disable auto resizing.

Turning off auto resizing

Auto-resizing is extremely convenient since the form will automatically resize to take up as much horizontal and vertical space as it needs. This can be very useful for forms that have collapsible sections, multiple Tabs, repeat controls etc. and where user actions can alter the vertical space. However, in cross-domain environments where Confluence and Live Forms are running in different containers or on different machines, auto-resizing requires adding a URI fragment to the browser URL. The fragment looks something like: #632:234:form-1304106048646 where the numbers can be different. This can affect URLs that you may be using that already contain URI fragments since the Live Forms URI fragment will overwrite your URI fragment.

To fix this, you will have to disable auto-resizing. This means that if the form does not fit in its alloted area, scroll bars will automatically appear. To turn off resizing, set the parameter resize=false and specify an initial height and width using the height and width parameters e.g.....resize=false|height=250|width=632|... The form will be rendered with the specified height and width and will never resize. Live Forms will not alter the browser's URL either. 

frevvoresolve macro

We assume that you are familiar with designing Live Forms. Specifically, forms differentiate between the label of a control and the name of a control. The control name (without spaces) is used in the macros below.

The frevvoresolve macros can be used in Confluence templates to create or edit Confluence pages using the form submission data.

The macro syntax is different if you are using the Live Forms add-on for Confluence v3.x versus the Live Forms add-on for Confluence v4 and Confluence 5.

Here is an example template using the frevvoresolve macros in Confluence v3.x:

Here is the same example template using the frevvoresolve macro syntax required for Confluence v4.0 - 4.2:

DO NOT use the new Confluence v4.x macro browser to add a frevvoresolve macro to your page. See Live Forms Confluence add-on usage for details.

Each frevvoresolve macro has a form field embedded in it by name. When the form is submitted, the content of the template will be resolved using the form data to generate the result Confluence page. In the example above there are three macros with form fields ClientName, FirstName and LastName. If the form was submitted with the value "Ford" in the Client Name field, the result Confluence page will contain the line.

First Name, Last Name etc. will also be resolved in a similar manner.

Here is a more complex example using the frevvoresolve macros in Confluence v4.0 to v4.2. This example also makes use of the three special frevvoresolve macro contents described below:

The frevvoresolve macro syntax in Confluence v4.3 and 5.1 no longer requires Wiki markup. You can add the frevvoresolve macro via the macro browser. This video demonstrates how to create a template using the macro browser to add the frevvoresolve macros. You can find step by step instructions to create this template here.

The frevvoresolve macro has a new parameter (tablerow) that can be used when you add a frevvoresolve macro to a table. The default value of this parameter is false. If you set this parameter to true. each repeating control will go into a new row. See below for more details.

Macros and New Lines

The frevvoresolve macro will exactly resolve its content including new line characters. Be careful, especially when you are trying to merge submission data into an existing Confluence page. For example, if you want to generate a new table row for each form submission, you must make sure to put a new line in the content of the frevvoresolve macro as shown below.

The example below uses Confluence v3.x frevvoresolve macro syntax. See frevvoresolve macro above for Confluence v4.x macro syntax.

|| First Name || Last Name || Email || Phone ||
{frevvoresolve}| <FirstName> | <LastName> | <Email> | <Phone> |
{frevvoresolve}

The examples below show macros that display the attachments and form/flow PDF snapshots on separate lines if you are using Confluence v4.0 - v4.2.

The special frevvoresolve macro body <form.edit.link> in Confluence v3.x and [form.edit.link] in Confluence versions v4.x and v5.1 will automatically generate a link that can be used to Edit the generated Confluence page using the original form. When the link is clicked by a user, the original form will be displayed initialized with the data from the most recent submission. The user can make edits as desired subject to the validation and other constraints imposed by the form and click Submit. The new values will be used to update the Confluence page.

In Confluence v5.1, you can use the macro browser to add a frevvoresolve macro to your template. Adding [form.edit.link] to the frevvoresolve macro will put the link to the submission data on your results page. If you want to make the link clickable, you can add html to the frevvoresolve macro in your template as shown in the example below: 

It will look like this on the Confluence page:

It is important to note that a form/flow submission can be edited by any Confluence user using the Edit link from template. For Example, a Flow created with 2 activities A1 (employee) -> A2(manager), submitted by an employee, can be edited by any other employee by clicking the  "Edit" link generated through template. The flow data can be edited and the flow submitted again. This is as designed. 

The Save/Load Feature cannot be used together with this Edit link. You cannot edit a form using this link, save the partially edited form and continue later.

Attachments

The special frevvoresolve macro body <form.attachments.links> in Confluence v3.x and [form.attachments.links] in Confluence v4.x and v5.1 will automatically generate links that can be used to view any attachments submitted with the form or workflow. When the link is clicked by the user, the attachment will be displayed or downloaded depending on its content type.

DO NOT use the new Confluence v4.x macro browser to add a frevvoattachment macro to your page. See Live Forms Confluence add-on usage for details.

In Confluence v5.1, you can use the macro browser to add a frevvoresolve macro to your template. Adding [form.attachments.links] to the frevvoresolve macro in your template will put the attachment name in clickable links that allow the user to view them. Here is an example of a template using the form.attachments.links frevvoresolve macro body. Do not use an href tag with form.attachments.links as this will display confusing results on the Confluence page. Note the last letter of the words attachment and link is an "s" in the macro body name.

 

It will look like this on the Confluence page:

PDF Snapshot

The special frevvoresolve macro body <form.snapshot.link> in Confluence v3.x and [form.snapshot.link] in Confluence v4.xand v5.1 will automatically generate a link that can be used to view the PDF snapshot for a form or workflow. You must check the Save PDF checkbox in the Form/Flow Designer. When the link is clicked by the user, the PDF will be displayed or downloaded depending on your browser. 

In Confluence v5.1, you can use the macro browser to add a frevvoresolve macro to your template. Adding [form.snapshot.link] to the frevvoresolve macro in your template will put a clickable link to the form pdf on the Confluence page. Here is an example of a template using the form.snapshot.link frevvoresolve macro body. Do not use an href tag with form.snapshot.link as this will display confusing results on the Confluence page.

It will look like this on the Confluence page:

Repeating Controls

Forms and workflows can have repeating data. For example, a person may have multiple nick names. Let's say you have a control on the form labeled Nick Name (as a reminder, Live Forms will automatically generate a name for this control without spaces NickName, (which you may edit) and a macro in your template.

Here is an example template using the frevvoresolve macros in Confluence v3.x:

Here is the same example template using the frevvoresolve macro syntax required for Confluence v4.0 - 4.2:

If you submit the form with two nick names (Liz and Beth for example), the resulting Confluence page will contain the lines.

Repeating controls will generate one line per repeat item.

In Confluence versions 4.3.2 - 5.1, html syntax for tabular data display has changed in the case of 'repeats'. When you add a frevvoresolve macro in a table row, the macro now has a new parameter (tablerow). The default value for this parameter is false. If you leave the parameter set to false and merge the data to a Confluence page, the data will  accumulate in same cell. Here is an example of a Webinar Registration Results Page that uses a merge template that contains a table with frevvoresolve macros left at the default value. 


You must set this parameter to true for ALL frevvoresolve macros in your table if you want each repeating control to go into a new row. To set the parameter to true, click on the frevvoresolve macro in the table of your template, click edit, select true from the dropdown and click "Save".

 

Here is the Template for the Webinar Registration Form shown above with the frevvoresolve macros for the four fields set to true.

This merge template produces a Webinar Registration Results Page that looks like this:

When you merge to page, there will be an empty looking thin row generated at the bottom. This row cannot be removed at this time.

frevvotasks macro

You can access your pending workflow tasks and any saved forms directly from your Confluence page via the frevvotasks macro. See using the task list for details.

DO NOT use the new Confluence v4.x macro browser to add a frevvotasks macro to your page. See Live Forms Confluence add-on usage for details. However, you can add the frevvotasks macro via the macro browser if you are using Confluence versions 4.3 - 5.1.

frevvosubs macro

Form submissions can be viewed directly in your Confluence page via the frevvosubs macro. See viewing form submissions for details.

DO NOT use the new Confluence v4.x macro browser to add a frevvosubs macro to your page. See Live Forms Confluence add-on usage for details. However, you can add the frevvosubs macro via the macro browser if you are using Confluence versions 4.3 - 5.1.

frevvoattachments macro

Do not use this macro. Use the frevvoresolve macro with the form.attachments.link macro body.

Create/Update Confluence Pages

Please click here for detailed instructions on creating/updating Confluence pages via Live Forms and workflows.

Merge into existing Confluence Page

Please click here for detailed instructions for merging form/flow submissions into an existing Confluence page.

Workflows in Confluence

Please click here for detailed instructions for using workflows in Confluence.

  • No labels