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.
Basic concepts
ConfiForms plugin contains 12 macros. To define a simple form you will need only 2, and to show it - you will need 1 more macro to employ.
There are couple of concepts to learn to help you to bootstrap your ConfiForms skills
- Forms are defined using "ConfiForms Form" and "ConfiForms Field Definition" macros
- Once defined the form could be used anywhere in Confluence
- To show the form, and configure how the form should be shown, you will need to use "ConfiForms Registration Control" macro. This macro tells how the defined form should be shown: as dialog, embedded to the page or using the layout defined.
- One form could have multiple "ConfiForms Registration Control" macros associated with it. It means you can show your defined form on different pages in different ways.
- Data stored by the form could be used on different pages (using *View macros), you control which fields should be shown and how (this is configured using "ConfiForms Field" macros placed inside *View macros).
These are the basic concepts to learn about ConfiForms. When you have learnt the basics there is a lot more to learn, as ConfiForms plugin supports many scenarios, has integration points to other systems and many customization options.
Scroll down to see, how easy it is to define a simple form. See tutorials to learn more
| ConfiForms Form | Define | Main macro to define the form and it's rules |
| ConfiForms Field Definition | Define | Macro to use inside the ConfiForms Form macro to define form fields, their types and behavior, restrictions and permissions |
| ConfiForms Field Definition | Define | Macro to use when you need to define conditional fields and relations between fields (ConfiForms Field Definitions) |
| ConfiForms Registration Control | Define View | Macro to define form's registration behavior. Each form should have at least one 'Registration Control'. It can be placed inside the ConfiForms form or outside. Form could have any number of registration controls. You can configure your form to be embedded on Confluence page or to be rendered as a modal dialog |
| ConfiForms Edit Controls | Define View | Macro defines Edit controls behavior for ConfiForms ListView and ConfiForms TableView. When you want enable editing of your data stored then place this macro inside ConfiForms ListView or ConfiForms TableView macros |
| ConfiForms TableView | View | Macro to visualize your stored data as table, with instant search, filtering and data sorting/ordering. Add 'ConfiForms Field' macros inside to define what should be shown |
| ConfiForms ListView | View | Macro to visualize your stored data in WYSIWYG view (also supports filtering and data sorting/ordering). Add 'ConfiForms Field' macros inside to define what should be shown |
| ConfiForms CardView | View | Macro to visualize your stored data as 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