Annual Documentation Survey
Welcome to Forms for Confluence, in this guide you'll find out how to create a form, survey or poll on a new Confluence page.
If you've not used Forms for Confluence before, it's important to know that like most form solutions Forms for Confluence has two parts:
In this section we'll be going through how you set up the front-end of your form, to learn more about how to set up the back-end of your form please take a look at the guide to setting up a form on an existing page.
To create your first form, follow these steps
The form wizard configures the back-end for you and defaults to submitting form results to the Confluence data base, if you have space admin level permission, you'll be able to configure this.
At this step you would have set up your first form
Forms for Confluence offers you the ability to create a wide array of different forms, surveys, and polls; including qualitative and quantitative surveys.
To start, here are a sample of some of the +20 macros that are available with Forms for Confluence:
To learn more about the kind of macros that Forms for Confluence offers or are confused which macro aligns with the type of question you're asking, take a look at our documentation.
Once you've selected the macros that line up with the questions that you want to ask, save the form.
Your form will now be ready for users to respond to.
We always recommend testing your form before you send it out, but at this stage your form is now ready to be shared with your respondents.
To find out how to access your results, take a look at the guide on interpreting your results.
All your forms are listed on one page
Forms for Confluence allows you to keep track of all of your forms on one page, once you've created your first form a new page will be added to your space, named Forms for Confluence.
On this page you'll also be able to create new forms, this create option will take you to the form wizard and will create a new form as a child page of your Forms for Confluence Page.
If you're new to Forms for Confluence, we suggest starting with Creating a Form on a New Page.
Forms for Confluence gives you the flexibility to add forms to existing Confluence pages, enabling you to gather feedback on important work without navigating away to another page or app.
To do this, you'll need to set up your Form Configuration (Form ID) before you set up your Form, this will allow you to map your new questions to your existing page.
As a Space Admin
As a Confluence Admin
Once you've configured the form/Form ID the next step is linking it to a new form on your existing page
Once you've done this, your form will be linked to your form ID and you can add your questions to the form.
To find out how to set up questions on your form using macros, please take a look at the Matching macros with questions section in the Creating a Form on a New Page Guide.
Once you've set your form up and sent it out to your respondents, you'll want to interpret the results.
Forms for Confluence offers a number of different options to view your responses based on your level of Confluence permission.
Viewing results in a table
Forms for Confluence's response table macro allows you to display your form results either the same page as your form or on a different page.
To add a Response Table to a page, you'll need to do the following
If you want to restrict who can see your results you can use Confluence's built-in page permissions to restrict who can view or edit the page.
View individual Responses
Forms for Confluence allows you to view each form response individually, providing granularity for when you need it.
To view individual responses, you'll need to do the following:
Forms for Confluence provides a straightforward way to view your form responses by providing a bar graph visualisation.
To visualise your responses, you'll need to do the following:
Forms for Confluence allows you to export your results in CSV, XML or JSON format so that you can collate your form responses, import them into your BI tool or automate other systems based on the results.
To export your responses, you'll need to do the following:
One of the most powerful abilities of Forms for Confluence is the ability to automate activities based on form responses. In this guide we'll look at three different examples of how you can automate your form responses, however as Forms for Confluence offers you the ability to export your form results into JSON, XML, and CSV, you could create your own automations that meet your business needs. To find out more about the different export options, take a look at our guide on interpreting results.
Automating form results requires you to have Confluence admin permissions and isn't available to space admins and general Confluence users. If you're not a Confluence admin and want to automate your form results, please contact your Confluence admin.
Forms for Confluence allows you to determine where your form responses are sent, one option is to send your responses to an email address.
If you're a team that needs to keep on top of your form responses, then sending them to a dedicated email address is one way to ensure that no responses are missed.
This is also useful way of enabling teams or users that don't have Confluence space admin to view form results.
To learn more about how to configure your form responses to arrive in your mailbox, take a look at our documentation.
Creating Jira Tickets
If you're a team that needs to gather feedback in Confluence and then take action on them by tracking them in Jira, this automation is for you.
Forms for Confluence allows you to send your form responses directly to Jira by making them consumable by ScriptRunner for Jira.
You can map questions in Forms for Confluence to Jira fields and issue types, for example you could add a form to a documentation project that your teams have been working on, allowing for your testers or proof-readers to add a bug directly from your Confluence documentation.
To learn more about how to configure your form responses to create Jira tickets, take a look at our documentation.
To enable this functionality, you'll need a license of ScriptRunner for Jira.
Post results to a Confluence page using ScriptRunner
Forms for Confluence together with ScriptRunner for Confluence allows you to post your results onto a Confluence page.
This automation allows you to share your results with a specific team or group of people more easily or could be used to allow you to add a set of predefined variables to a new page.
For example, you could use a form to create a page in a specific space, that uses a specific template, labels or other set options that enable your instance to scale more easily.
To learn more about how to configure your form responses to create Confluence pages, take a look at our documentation.
To enable this functionality, you'll need a license of ScriptRunner for Confluence.