frevvo provides an add-on that you can install into Confluence to create sophisticated forms and workflows integrated with Confluence. The add-on requires installation of an in-house frevvo server.
If you are using Confluence server v5.6.x, however, you must use Live Forms server v6.1.1+
Refer to the Confluence Add on Release Notes for complete compatibility information.
On This Page:
Using an In-house Live Forms server
- Download and install the frevvo server. Instructions for a Windows platform can be found on the Installation Instructions page. Click here for information on other platforms.
- Setup your In-house frevvo server for Confluence. You must now create a tenant specifically for Confluence.
- See Installing and Configuring the add-on to complete the installation.
- If you change the value of the session timeout in the Confluence tenant created in frevvo and the server is restarted, forms/flows in Confluence become inaccessible until the tenant is edited or the server is restarted once again.
- If you create a user in Confluence, with the role of frevvo.designer, and then try to login to the Confluence tenant on the frevvo server with this id, an "Invalid username/password" error will display. A password reset on the frevvo server will have to be performed to reset the random password generated when the user was created in Confluence.
Installing and Configuring the Confluence add-on
Install the add-on
We strongly recommend using Universal add-on Manager (UPM). Please follow the Atlassian instructions for adding an add-on. Search for the frevvo Live Forms and Workflows for Confluence add-on in UPM, select it and click Install. The add-on will be installed automatically.
If you cannot use UPM, you can download the frevvo add-on from the Atlassian Marketplace. There are serveral frevvo add-on versions available for Confluence. The add-on version required depends on your Confluence server version number. See the frevvo add-on compatibility matrix for details.
- Click here to download the correct version of the add-on for your version of frevvo.
Then, follow Atlassian instructions for installing the add-on into Confluence. Remember to first uninstall any previous version.
Configure the add-on
You must first configure the add-on before you can use it. The image below shows the potential configurations available for the frevvo Confluence add-on. The image is large so that the text is readable. In most cases, you will not need to specify these configuration parameters and can leave them blank. Click Configure.
Forms Server URL
This is the scheme, host & port on which the forms server is running. The add-on (installed in Confluence) must be able to access the frevvo server. For example, the URL to your in-house installation might be: http://frevvo.mycompany.com:8082/.
Enter the tenant admin user for the tenant you created. Remember that you must enter it using the syntax userid@tenant, e.g. firstname.lastname@example.org
Type in the above admin user's password.
Form Designers Group
You can specify a Confluence group here. If specified, only users belonging to this group can design and add forms, flows or submissions to Confluence pages. If this is left blank, all Confluence users will be able to add forms, flows or submissions to Confluence pages.
Form Users Group
You can specify a Confluence group here. If specified, only users belonging to this group can add the Task List to Confluence pages. If this is left blank, all Confluence users will be able to add the Task List to Confluence pages. Note that all users can still access public forms on public Confluence pages.
Form Editors Group
This feature is available in Live Forms v4.1.4 and higher. You can specify a Confluence group here. If specified, users belonging to this group can edit forms and flows already added to existing Confluence pages belonging to any other user. If this is set to No Group, edit access is restricted to the original designer/owner of the form/flow. Users belonging to this group can also view/delete submissions for forms and flows belonging to any other user. Note that the editor also needs to have "designer" privileges for this. This group does not give users permission to create new Confluence pages and add existing forms/flows created by another designer. The only forms you will see in the add existing form dropdown are the forms created by you.
Another way to give users the ability to edit forms and flows belonging to other users is to:
- Add those users to the in the relevant form/flow Access Control List. The frevvo.Designer role is only required for these users if a group is specified in the Forms Designer Group field on the Confluence plugin configuration screen. Users to be given this permission must be members of this group.
Confluence Server URL
This is reserved for future use.
Confluence Server External URL
In most cases, you do not need to configure this.
In some configurations, the URL used by a browser outside the firewall to access Confluence may be rewritten before it is internally passed on to Confluence. If that's the case, Confluence URLs generated by frevvo to perform any redirection will be wrong since they will reflect the rewritten internal URL. You can specify the externally visible URL to Confluence here. If not specified, this will be inferred from the HTTP Request received by Confluence.
Forms Server External URL
In most cases, you do not need to configure this.
In some configurations, the externally visible URL to the forms server may be different from the above URL, i.e. the URL that a browser outside the firewall uses to access frevvo could be different from the URL that the add-on (inside the firewall) uses to access frevvo. If that's the case, enter the externally visible URL in this configuration parameter. Your users must be able to access the frevvo server from their browsers via this URL. When the form, workflow or task list is rendered in the browser, this URL will be used to access frevvo. This URL defaults to the above Forms Server URL if not specified.
Frevvo supports confluence over SSL. If Confluence is running over ssl, you must configure the Form Server External URL in the Confluence add-on to your frevvo Server url. This URL will help to render forms/flows on Confluence pages properly. You also need to configure the 'Confluence Server Url' in the tenant you have set up specifically for Confluence. In the frevvo Server, edit the tenant and set the 'Confluence Server Url' to your HTTPS Confluence site. See Manage Tenants for more information. With both of these settings configured, you should be able to access/create forms on Confluence pages.
If checked, the add-on will print debugging information to Confluence pages. In addition, for forms and flows, you can also specify a parameter to the form macro that is generated in Confluence pages: _norender:true. If this parameter is present, the macro will simply print debugging information but will not actually render the form.
Click the Save Configuration button. If all goes well, the message "add-on configuration updated" should be displayed. You may now logout of the Confluence admin account.
The add-on makes HTTP requests to the frevvo server, which may be remote in order to process your form. If you find that the frevvo macros do not work, ask your network administrator if Confluence needs to access the Internet through a web proxy.
Please refer to Configure Web Proxy Support for Confluence for further information.
Login to Form Server
There are occasions where you may want to login directly to the Live Forms server rather than via Confluence. Here are a few points to understand:
- All Confluence users who create forms and workflows automatically have their user account created on the Live Forms server. In order to login directly to the form server, you must first login as the frevvo admin and then use the login as that user feature available to the admin user to next login to the specific user account.
- All forms and flows are created under Application 1 in the Live Forms user account of the same username as the username of the Confluence user who first created the form or flow.
If you get this error adding a flow to a Confluence page you can solve this with a simple browser setting.
Go to IE Tools -> Internet options -> Security tab -> select custom level -> disable XSS Filter