...
...
Although the ConfiForms app offers 19 different Confluence macros to ease form construction, it requires only 2 macros to define a simple form |
...
...
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"
|
...
...
- "ConfiForms Registration Control" macro both configures how the form should be displayed and enables the display. This macro
|
...
...
...
...
- in the page, or formatted using the layout defined.
|
...
...
- can have multiple "ConfiForms Registration Control" macros associated with it.
|
...
...
- the form on different pages in different ways.
- Data stored by the form
|
...
- can be used on different pages (using
|
...
...
- . This allows you to control which fields
|
...
...
- they are displayed. Fields can be configured by placing "ConfiForms Field" 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 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 |
...
...
...
. | Macro | Action | Concepts/usage | ConfiForms Form Definition (aka | |
...
...
| its behaviour. | | ConfiForms Field Definition | Define |
|
...
| Use inside the ConfiForms Form macro to define form fields, |
|
...
...
| behaviour, restrictions and permissions. | | ConfiForms Field Definition Rules | Define |
|
...
...
| 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 |
|
...
...
| rendered as a modal dialog. | | ConfiForms Edit Controls | Define View |
|
...
...
| behaviour for the ConfiForms ListView and |
|
...
...
...
...
| , 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 |
|
...
...
| 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 |
|
...
...
| 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 |
|
...
...
...
| 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
You will Here are the steps to create a simple form with one text field of type text and it will have a ; it's registration control is configured to show it the form as a dialog.
For those who does not like to read there is a screencast below!We move through the steps in the screencast below.
- Start with creating the a page in Confluence.
- While in the editor type "{" (without quotes, press ctl + shift + A (together) and start typing form in the search field.
- Choose ConfiForms Form macro from the resulting list suggested: ConfiForms Form macro. This is you the main container for the form . It which defines the form's properties and rules. There are a lot to choose fromseveral options for configuration, but use the defaults for our this simple case the defaults are OK.
- Click "Insert" and the macro get's inserted to will be inserted on the page.
- Go to to the body of the ConfiForms Form macro body and add there 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). To find Remember, to insert the ConfiForms Field Definition macro Definition macro quickly, while inside the ConfiForms Form macro the ConfiForms Form macro body type "{" (again, without quotes) and start typing defini - it Confluence will auto- suggest you the ConfiForms Field Definition, and by selecting that suggestion, you can add the macro.
- Define the field as 'text' (the default) for this example. ConfiForms provides 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 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 ConfiForms and the Field Definition macro(s) define the form's fields.
- The form is basically ready. But ; but there is no "submit" registration button"!
- For enabling form registrations use To enable form submission, use the ConfiForms Registration Control macro. This macro tells controls how the form should will be rendered. It could can use the default (card) layout and render it the form as a dialog or as an item embedded to on the page. But you You can also have you own customise a layout for the form : this is done by customizing ConfiForms by customising the Registration Control macro body and placing there ConfiForms Field macro(s) within it. For this example, we choose to have a choosen the default layout and which will render the form as a pop-up dialog.
Here is a screencast
| HTML |
|---|
<iframe width="700" height="400" src="https://www.youtube.com/embed/IOUW5K7gdvo" frameborder="0" allowfullscreen></iframe> |
...
For more tutorials click here
...