V4 Confluence Installation
Contents |
Introduction/Assumptions
frevvo provides a plugin that you can install into Confluence and use forms and workflows in Confluence. You can either use frevvo's SaaS service (strongly recommended at least for evaluation) or install an in-house frevvo server.
Using frevvo's SaaS service
You can now connect your Confluence server to frevvo's SaaS service. No frevvo installation is necessary. This is the simplest way to evaluate Live Forms for Confluence and we strongly recommend it for evaluation. A free 30-day trial is available. Contact us for pricing and to setup a monthly subscription to the SaaS service.
We recommend viewing a short video for more information.- Click here to signup for a SaaS frevvo Confluence account. Complete the form and activate the account by clicking on the link in the activation email that is sent to you. The tenant ID, admin user name and admin user password will be used later for plugin configuration.
- Click, Installing and Configuring the plugin to complete the installation.
Using an In-house frevvo server
We strongly recommend the Installation Video.- Download and install the frevvo server. Instructions for your platform can be found on the Installation Instructions page.
- Setup your In-house frevvo server for Confluence. You must now create a tenant specifically for Confluence. Details can be found in the Installation Video
- Click, Installing and Configuring the plugin to complete the installation.
Installing and Configuring the Confluence plugin
Install the plugin
Using UPM: We strongly recommend using Universal Plugin Manager (UPM). Please follow Atlassian's instructions for adding a plugin. Search for the frevvo plugin in UPM, select it and click Install. The plugin will be installed automatically.
Manual Installation: If you cannot use UPM, download V4.1.3 (Build 14589). Then, follow Atlassian's instructions for installing a plugin into Confluence. Remember to first uninstall any previous version.
Configure the plugin
You must first configure the plugin before you can use it. The image below shows the potential configurations available for the frevvo-Confluence plugin. 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 frevvo forms server is running. The plugin (installed in Confluence) must be able to access the frevvo server. For example, the URL for frevvo's SaaS service is: http://cf.frevvo.com OR https://cf.frevvo.com if you want to use SSL. The URL to your in-house installation might be: http://frevvo.mycompany.com:8082/.
User Name
Enter the tenant admin user for the tenant you created. Remember that you must enter it using the syntax userid@tenant, e.g. admin@mycompany.com
Password
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 v4.1.4
You can specify a Confluence group here. If specified, users belonging to this group can edit forms and flows belonging to any other user. If this is left blank, edit access is restricted to the original designer/owner of the form/flow.
Confluence Server URL
Confluence Server External URL
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 some configurations, the externally visible URL to the frevvo 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 plugin (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 frevvo 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.
Enable Debugging
If checked, the plugin will print debugging information to Confluence pages. In addition, for forms and flows, you can also specify a parameter to the {frevvoform} 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 frevvo form.
Click the Save Configuration button. If all goes well, the message "Plugin configuration updated" should be displayed. You may now logout of the Confluence admin account.
Administration
The plugin 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 Web Proxy Support for Confluence for further information.
