Page tree

This is the documentation for ConfiForms Server/Data Center app

However, this might also work for ConfiForms cloud and in most cases it does. But please see this page to understand the differences between server and cloud versions of the ConfiForms app.

Although the ConfiForms app offers 19 different Confluence macros to ease form construction, it requires only 2 macros to define a simple form, and just 1 to display it anywhere in your Confluence installation. The ConfiForms macros can be quickly reviewed by Inserting a new macro (press shift + { and begin typing ConfiForms to select the "ConfiForms Form (Definition)" macro quickly, or press ctl + shift + A in Edit mode in a Confluence page). 

Getting started
Here are a couple key concepts for understanding ConfiForms:

  • Forms are defined using 2 macros: "ConfiForms Form (Definition)" and "ConfiForms Field Definition"
  • The "ConfiForms Registration Control" macro both configures how the form should be displayed and enables the display. This macro enables displaying the form as a dialog, embedded in the page, or formatted using the layout defined. 
  • A form can have multiple "ConfiForms Registration Control" macros associated with it. This means you can show the form on different pages in different ways.
  • Data stored by the form can be used on different pages (using the View macros).  This allows you to control which fields are shown and how they are displayed. Fields can be configured by placing "ConfiForms Field" macros inside View macros. See Multiple ways to show your form data in Confluence with ConfiForms

These are the basic concepts you need to begin creating ConfiForms. When you have mastered these basics, there are many more useful features to explore. The ConfiForms plugin supports many scenarios and has been carefully integrated with other systems in Confluence, providing many customisation options. 

Here are the basic concepts and key terms needed to define a simple form. Explore our tutorials to learn more.


ConfiForms Form Definition

(aka ConfiForms Form)

Define Define the form and its behaviour.
ConfiForms Field Definition Define Use inside the ConfiForms Form macro to define form fields, types and behaviour, restrictions and permissions.
ConfiForms Field Definition Rules Define Use to define conditional fields and relations among fields (that is, ConfiForms Field Definitions).
ConfiForms Registration Control Define View Use to define a form's registration behaviour. Each form should have at least one 'Registration Control'. This control can be placed inside the ConfiForms form or elsewhere on the page, and a form can have any number of registration controls.  Forms can be embedded on Confluence pages or rendered as a modal dialog.
ConfiForms Edit Controls Define View This macro defines Edit behaviour for the ConfiForms ListView and TableView. To enable editing of stored form data, place this macro inside the ConfiForms *View macros (ListView, TableView, CalendarView or CardView).
ConfiForms Entry Viewer View This macro adds a nice control to view your stored entity in a nice popup dialog. Add it to your ConfiForms *View macros (ListView, TableView, CalendarView or CardView).
ConfiForms TableView View Use this macro to visualise stored data as a table, with instant search, filtering, and data sorting/ordering. Add 'ConfiForms Field' macros inside TableView to define which fields should be shown.
ConfiForms ListView View This macro allows you to visualise stored form data in WYSIWYG view (also supports filtering and data sorting/ordering). Add 'ConfiForms Field' macros inside define which fields should be shown.
ConfiForms CardView View Use this macro to visualise stored form data as a vertical table (card) with instant search, filtering and data sorting/ordering. Add 'ConfiForms Field' macros inside to define what should be shown
ConfiForms CalendarView View Macro renders a Calendar view for your stored data
ConfiForms ValueView View Macro shows the value for the field you specify from the form you specify
ConfiForms PlainView View Macro to show ConfiForms values without any CSS style, as-is. Fields to be referenced using [entry.FIELD_NAME] notation
ConfiForms CleanView View This macro is very similar to ListView macro, but with a limited subset of features, expects rich content in it's body. In contrast to ListView it generates a much cleaner HTML, which is easier to use in you want to create your own user macros wrapping ConfiForms macros.
ConfiForms Field View This macro defines a field for display within the ConfiForms TableView, CardView, CalendarView or ListView macros.
ConfiForms IFTTT Integration Rules Define Use this macro to define the integration rules for ConfiForms.  For example, this macro can enable the form to send email notifications when a record is created, changed, or submitted. Notifications can be sent to other systems via HTTP, or they can create new pages using predefined templates with data entered on your forms.
ConfiForms TableView Merger View This macro aggregates and merges datasets from different ConfiForms forms (or just from selected fields in one form).  You can calculate averages, totals, or perform other math operations on form data. The output of this macro is fully compatible with the Chart macro and these can be used together to create beautiful charts.
CSS Rules for ConfiForms Fields View This helper macro supports applying conditional CSS rules for ConfiForms fields based on their values.
ConfiForms IFMatches Helper View Helper macro which enables you to show blocks of data based on the values in ConfiForms record. You can specify the filter either by using built-in ConfiForms filter or using the Velocity IF statement
ConfiForms Form Filter Control View Helps you to build dynamic filters over the stored data in the form

Simple form

Here are the steps to create a simple form with one text field; it's registration control is configured to show the form as a dialog.

We move through the steps in the screencast below.

  1. Start with creating a page in Confluence.
  2. While in the editor, press ctl + shift + A  (together) and start typing form in the search field. 
  3. Choose ConfiForms Form macro from the resulting list. This is the main container for the form which defines the form's properties and rules. There are several options for configuration, but use the defaults for this simple case.
  4. Click "Insert" and the macro will be inserted on the page.
  5. Go to the body of the ConfiForms Form macro and insert a ConfiForms Field Definition macro in the same way as you inserted the container itself (you can add many, but we are creating a form with just one field).  Remember, to insert the ConfiForms Field Definition macro quickly, while inside the ConfiForms Form macro body type "{" (without quotes) and start typing defini - Confluence will suggest ConfiForms Field Definition, and by selecting that suggestion, you can add the macro.
  6. Define the field as 'text' (the default) for this example.  ConfiForms provides more than 30 field types for your forms.  Remember, too, that the ConfiForms Form  and ConfiForms Field Definition macros are always together: the ConfiForms Form  macro defines the rules and properties of the form and the Field Definition macro(s) define the form's fields.
  7. The form is basically ready; but there is no "submit" button!
  8. To enable form submission, use the ConfiForms Registration Control  macro. This macro controls how the form will be rendered. It can use the default (card) layout and render the form as a dialog or as an item embedded on the page.  You can also customise a layout for the form by customising the Registration Control  macro body and placing ConfiForms Field  macro(s) within it. For this example, we have choosen the default layout which will render the form as a pop-up dialog.

Here is a screencast

Quick tutorial on how to use ConfiForms TableView and ConfiForms Field to show the data in a table format

Simple way to showing your ConfiForms data with TableView macro in Confluence

For more tutorials click here