Annual Documentation Survey

Do you have 4 minutes to help us improve our documentation? Please take our annual survey!

Skip to end of metadata
Go to start of metadata

Introduction

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:

  • The front-end, where you design your form questions.
  • The back-end where your results are stored. 

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

  • Navigate to the more options menu next to the Create Button on the Confluence. 
  • Next navigate and select the to the Forms for Confluence option. 
  • Once you've selected the Forms for Confluence option, you'll be given the option to create one of a number of different templates. 
  • Forms for Confluence's templates give you pre-configured examples of what your forms can look like, either select one of the options available or select the Empty From option to get started. 
  • Next, add your Page/form name and add a Form ID, the Form ID will be used to identify your results on the back-end. 
  • When you select create, both the form front-end and the back-end will get created.


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

  • If you selected the Empty Form, you'll notice that you have a single macro on your page, the form macro, the purpose of this macro is to send all of your responses to your back-end results Form ID. 
    • You'll need to add new macros corresponding to the questions you want to ask inside of this macro. 
  • If you selected one of the templates, you'd notice that the form macro is present on the page with a number of other macros dependent on the type of template you selected. 
    • You'll be able to customise, add, or remove these macros to suit the needs of your 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.

Save and test your form

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.

Introduction


 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. 

  • Due to the sensitivity of form results and impact of configuration options, you will need to have Space or Confluence Admin level permission to create or customise form configurations.
  • If you don't have these permissions and want to use Forms for Confluence to set up a form on an existing page, please contact your space admin or a Confluence admin.

To add a new form configuration

As a Space Admin

  • Navigate to the Forms for Confluence tab in the Space Tools menu, here you'll see all form configurations in the space. 
  • Navigate and select the add new form configuration option below all of the configuration results. 
  • Add a new Form ID name and configure the options relevant to your new form (to find out more about these options please look at the documentation).
  • Once you save this configuration, you'll be able to use it for your new form.

As a Confluence Admin

  • Navigate to the Forms for Confluence tab in the Confluence administration menu, here you'll see all form configurations across Confluence spaces. 
  • Navigate and select the add new form configuration option below all of the configuration results. 
  • Add a new Form ID name and configure the options relevant to your new form (to find out more about these options please look at the documentation).
  • As a Confluence admin, you'll be able to set up where the form responses go, options include: 
    • Confluence DB
    • Email Server/Relay
    • Jira
  • Once you save this configuration, you or your Confluence users will be able to use it for your new form.



Once you've configured the form/Form ID the next step is linking it to a new form on your existing page

  • On your existing page, in edit mode, add the form macro. 
  • Double click on the form macro to open the options. 
  • Once there, add your recently created form ID name. 
  • Click on save.

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.



Introduction

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. 

  • If you're a normal confluence user, you can set up a Response Table on a Confluence page. 
  • If you're a Confluence or Space Admin, you have the option to:
    • View individual responses.
    • Export all responses in CSV, XML or JSON format.
    • Visualise your responses with space statistics.

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

  • Add the Forms-Response table macro to the page.
  • Once you've added the macro, you'll need to link it to the back-end of your form, the Form ID. 
    • Type in your Form ID in the box provided.
  • Select the relevant Form ID and save it.
  • Once you save your page, your form responses will display inside of the table. 
    • If you're setting this up for a form that doesn't have any responses the response table macro will display a pop-up warning that no results have been found.


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: 

  • If you're a space admin, navigate to the Forms for Confluence tab in the Space Tools menu.

     OR

  • If you're a Confluence admin, navigate to the Forms for Confluence tab in the Confluence administration menu. 

Shared Steps

  • From the Form Configuration menu, navigate to your relevant form configuration and select the drop down next to the cog icon () in the actions column.
  • From the drop-down menu select the view responses option.  
  • Once you've selected this option, you'll be able to view all of your form responses.

Viewing Statistics

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: 

  • If you're a space admin, navigate to the Forms for Confluence tab in the Space Tools menu.

     OR

  • If you're a Confluence admin, navigate to the Forms for Confluence tab in the Confluence administration menu. 

Shared Steps

  • From the Form Configuration menu, navigate to your relevant form configuration and select the drop down next to the cog icon () in the actions column.
  • From the drop-down menu select the view statistics option.  
  • Once you've selected this option, you'll be able to view all possible responses that can be visualised.
    • Note some responses can't be visualised, such as text fields. If your results have responses that aren't visualised, we'd recommend exporting these results.

Exporting Results

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: 

  • If you're a space admin, navigate to the Forms for Confluence tab in the Space Tools menu.

     OR

  • If you're a Confluence admin, navigate to the Forms for Confluence tab in the Confluence administration menu. 

Shared Steps

  • From the Form Configuration menu, navigate to your relevant form configuration and select the drop down next to the cog icon () in the actions column.
  • From the drop-down menu select the export option.  
  • Once you've selected this option, you'll be able to export all of the results in your survey in the format of your choosing.

Introduction

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.

Form Responses

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. 

Learn More

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.

Learn More


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.

Learn More


To enable this functionality, you'll need a license of ScriptRunner for Confluence.

  • No labels