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 plugin offers 12 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 (ctl + shift + A in a Confluence page).
Getting started
Here are a couple key concepts for understanding ConfiForms:
- Forms are defined through two macros: "ConfiForms Form" 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.
These are the basic concepts you need to begin creating ConfiForms. When you have mastered these basics, there are many more useful features to expolore. The ConfiForms plugin supports many scenarios and has been carefully integrated with other systems in Confluence, providing many customization options.
Here the basic concepts and key terms needed to define a simple form. Explore our tutorials to learn more.
| Macro | Action | Concepts/usage |
| ConfiForms Form | Define | Define the form and its rules. |
| ConfiForms Field Definition | Define | Use inside the ConfiForms Form macro to define form fields, their types and behavior, restrictions and permissions. |
| ConfiForms Field Definition | 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 behavior. 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 behavior for the ConfiForms ListView and TableView. To enable editing of stored form data, place this macro inside the ConfiForms ListView or TableView macros. |
| ConfiForms TableView | View | Use this macro to visualize 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 visualize 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 visualize 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 Field | View | Macro to define a field to show within ConfiForms TableView or ConfiForms ListView macros |
| ConfiForms IFTTT | Define | Macro to define the integration rules for ConfiForms. Send email notifications when a record is created, changed or modified. Send notifications to other systems via HTTP, or just create new pages from defined templates with data from your forms |
| ConfiForms TableView Merger | View | Macro to aggregate and merge datasets from different ConfiForms forms (or just from one form). Calculate averages, totals, other math operations on your data. The output of this macro is fully compatible with Chart macro and could be used together to create beautiful charts |
| CSS Rules for ConfiForms Fields | View | Helper macro to support applying of conditional CSS for ConfiForms Fields based on their values |
Simple form
You will create a simple form with one field of type text and it will have a registration control configured to show it as dialog.
For those who does not like to read there is a screencast below!
- Start with creating the page in Confluence.
- While in the editor type "{" (without quotes) and start typing form.
- Choose from the list suggested: ConfiForms Form macro. This is you main container for the form. It defines form properties and rules. There are a lot to choose from, but for our simple case the defaults are OK.
- Click "Insert" and the macro get's inserted to the page
- Go to ConfiForms Form macro body and add there ConfiForms Field Definition macro (you can add many, but we are creating a form with just one field). To find ConfiForms Field Definition macro quickly, while inside the ConfiForms Form macro body type "{" (again, without quotes) and start typing defini - it will auto-suggest you the ConfiForms Field Definition
- We use default 'text' type and will have just one field of type text. There are more than 30 field types available for you to choose from!
- Remember, ConfiForms Form and ConfiForms Field Definition macros are always together. ConfiForms Form macro defines the rules and properties of the form and ConfiForms Field Definition macro(s) define form fields
- The form is basically ready. But there is no "registration button"!
- For enabling form registrations use ConfiForms Registration Control macro. This macro tells how the form should be rendered. It could use the default (card) layout and render it as dialog or as embedded to the page. But you can also have you own layout for the form: this is done by customizing ConfiForms Registration Control macro body and placing there ConfiForms Field macro(s). For this example we choose to have a default layout and will render the form as a pop-up dialog.
Here is a screencast
Overview
Content Tools