ConfiForms
...
- Data Forms & Workflows app for Atlassian Confluence
The ConfiForms app uses Confluence's page permissions to control form useConfiForms plugin uses Confluence page permissions to restrict usage of forms. Users with 'edit' permissions on permission for a page have administrative rights for the form(s) defined on this that page. By restricting 'edit' rights to the page you will remove administrative rights for users., the administrator controls administrative rights to its form(s). See more on Confluence page permissions and ConfiForms
Each record registered stored with ConfiForms has it's an owner. This means that a user who owns the record can fully control it (if edit/delete is enabled by the adminadministrator). Admin users of a form can register configure ConfiForms records to be owned by themselves, but and also for by other users. Admin A form's administrative users can control all records saved with given ConfiForms form.
Each record in ConfiForms has an associated metadata.
by the form.
A form can define additional users as form administrators or form superusers (even if they don't have edit permissions on the page).
Each record in ConfiForms has the following associated metadata (aka metadata fields):
Panel |
---|
|
...
|
...
|
...
|
...
|
...
All these metadata fields (additionally to your own defined ConfiForms fields (definitions)) could be referenced using the "ConfiForms Field macro" in
- ConfiForms TableView macro
- ConfiForms ListView macro
- ConfiForms CardView macro
Quick hints
- Each form has a name and belongs to page. To reference a ConfiForms Form you have to know it's name and Confluence page where it is configured
- To define the form you need: ConfiForms Form and ConfiForms Field Definition macros
- To enable registrations and show the form you will need: ConfiForms Registration Control macro
- To show the form with own layout you will need ConfiForms Registration Control macro and use this macro body as a container for your form designs, place ConfiForms Field macros there referencing your form fields (ConfiForms Field Definitions)
- To send email from ConfiForms you will need an IFTTT macro placed inside your ConfiForms Form macro
- To show saved data use ConfiForms TableView, ConfiForms ListView or ConfiForms CardView macros
- To customize the output, use CSS Rules for ConfiForms Fields macro
- To configure dependent fields and relations between fields, use ConfiForms Field Definition Rules macro
- To aggregate and merge the data from different ConfiForms Forms use ConfiForms TableView Merger macro
|
Info |
---|
ownedBy and createdBy are now User objects and you can access all user object properties! See here: Accessing field values and properties |
Info | ||||||
---|---|---|---|---|---|---|
Looking for
But please look at the Differences between ConfiForms server/data center and ConfiForms cloud for more details on compatibility between cloud and server/dc versions of ConfiForms |
All these metadata fields, in addition to the form's defined fields (definitions), can be referenced using the "ConfiForms Field macro" in these ConfiForms macros:
- TableView macro
- ListView macro
- CardView macro
- CalendarView macro
- PlainView macro - when you need just values from ConfiForms and want to construct you tables/HTML widgets yourself (to be used in conjunction with HTML macro, for example; and using [entry.FIELD_NAME] notation to reference field values )
- CleanView - similar to ListView, with less capabilities but with a lot cleaner HTML generated. Useful for designing own macros (with user macros) and mising it with HTML and other macros. Supports macros insides it's body
- ValueView macro - is self contained and shows the field value directly (no need to use "ConfiForms Field macro")
Also there is a "IFMatches" macro which can be used inside CalendarView and ListView to enable showing/hiding blocks of content based on the ConfiForms field values
Info |
---|
Take a look at this page which demonstrates how the data can be shown: Multiple ways to show your form data in Confluence with ConfiForms |
Our Backlog
ConfiForms (FormView) Registrations Control | ||||||
---|---|---|---|---|---|---|
| ||||||
Quick tips
- Each form has a name and belongs to a page. Use the form's name and the Confluence page where the form is configured to reference a ConfiForms Form
- To define the form, use the ConfiForms Form and Field Definition macros
- To enable registrations and display the form, use the ConfiForms Registration Control macro
- To display the form with its own layout , use the ConfiForms Registration Control macro body as a container for the form's design, placing ConfiForms Field macros in the container that define the form's fields
- To enable data edits use ConfiForms Edit Controls with ConfiForms TableView, ListView, CalendarView or CardView macros
- To add convenient viewer to your data use ConfiForms Entity Viewer with ConfiForms TableView, ListView, CalendarView or CardView macro
- To send email from ConfiForm, use an IFTTT macro placed inside the ConfiForms Form macro
- To display saved data, use the ConfiForms TableView, ListView, CalendarView, CardView or ValueView macro
- To customize the output , use the CSS rules for ConfiForms Fields macro
- To configure dependent fields and relations between fields, use the ConfiForms Field Definition Rules macro
- To aggregate and merge the data from different ConfiForms Forms, use the ConfiForms TableView Merger macro
Take a look also at conceptual view over all macros from ConfiForms app - ConfiForms app detailed view over the plugin macros
Excerpt Include | ||||
---|---|---|---|---|
|
Macro documentation
ConfiForms Form (Definition)confiform | The main macro to define the entry form and its rules
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms Field Definitionconfiform-field-definition | The macro to use inside the ConfiForms Form macro to define the form's fields, their types, and behaviour.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms Registration Controlconfiform-entry-register | This macro defines how the form is displayed (as a pop-up dialog or embedded in the page) and the form's behaviour when submitted. Multiple 'Registration Controls' that use the same form (form definition) can be placed on one or multiple pages. When the macro has a body defined, the fields in the body will be used as inputs for the form layout. To enable WYSIWYG mode, make sure that "ConfiForm Field" macros are in the body of the "ConfiForms Registration Control" macro. ConfiForm Field macros and text can be styled as needed. If the "ConfiForms Registration Control" macro is not defined (empty), a default layout will be used (either as a table or a card with key-value fields).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms Edit Controlsconfiform-entry-edit | This macro defines the behaviour of the Edit control for ConfiForms ListView and TableView.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms TableViewconfiform-table | The macro to display stored data as a table, with instant search, filtering, and data sorting/ordering.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms ListViewconfiform-list | This macro displays your stored data in WYSIWYG view (it also supports filtering and data sorting/ordering).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms CleanViewconfiform-clean | This macro is very similar to ConfiForms ListView, but renders a more lightweight and cleaner output, allowing you to have better control over the rendered output (it also supports filtering and data sorting/ordering).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms PlainViewconfiform-plain | This macro displays your stored data in plain view (it also supports filtering and data sorting/ordering).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms CardViewconfiform-card | This macro displays your stored data as a vertical table (or card) with instant search, filtering, and data sorting/ordering.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms CalendarViewconfiform-calendar | This macro displays your stored data in a calendar view.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms ValueViewconfiform-value | This macro displays your stored data in a simple field view
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms Form Fieldconfiform-field | This macro defines a field to be displayed within the ConfiForms TableView, ListView, or CardView macros
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms IFTTT Integration Rulesconfiform-ifttt | This macro defines the integration rules for ConfiForms forms and is to be placed inside ConfiForms Form macro body. The macro body is used as the message body, task content, javascript snippet, page content, or request content, depending on the action type selected. The macro body completely supports referencing records, including the record owner as [owner], the record modifier as [modifier], and any record field as [entry.FIELD_NAME]. The body can include complex types; see "Subject for email / title for page / url for request" below for details. You can also reference existing Confluence templates to be used when IFTTT is used to create Confluence pages. To reference a template you will nee to add the following:
The template is looked up by the name, and first in Confluence space templates and then in global templates. If found the content is added to IFTTT macro body and used as a page template
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms TableView Mergerconfiform-table-merger | This ConfiForms helper macro merges TableView results. This macro takes RICH TEXT as an input to define which fields (ConfiForms Field macros) to display and which tables to merge (in the ConfiForms TableView macros). It supports expressions which can be used when aggregating the data. Learn more in TableView Merger examples.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms Field Definition Rulesconfiform-field-definition-rules | This macro configures how ConfiForms Field Definitions are related. It supports creating complex relationships between form fields, based on selections, values entered, and so on. To be used inside the ConfiForms Form macro to define rules for Field Definitions.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CSS Rules for ConfiForms Fieldsconfiform-field-css | The macro to use to display fields based on their values. To be used inside the ConfiForms TableView, ListView, CalendarView, CleanView or CardView macros.
|
Macro documentation
ConfiForms Form
confiform
Main macro to define the entry form and it's rules
ConfiForms Form name | formName | Name of the form you are creating. Must be unique within the page and alphanumeric. Allowed symbols are [a-z] |
---|---|---|
Registration form title | registrationFormTitle | Title for your form to be shown on registration dialog |
Label for Save button shown on registration form | saveButtonLabel | Text to show for 'Save' button on registration dialog |
Enable full audit | enableAudit | If set, enables full audit. Tracks all the changes made and enables change history. Form admin users are able to see the log as a part of Admin UI |
Lock form | locked | Flag to be used when ConfiForm must be locked for new registrations. Admin users will still be able to manage form's data |
Message to show when the form is locked | lockedMessage | When the form is locked a message with given text will be shown to users |
Enforce one entry per user | uniqueByUser | ConfiForms will ensure one record per user (ownedBy) is saved |
Shows only own records to non-admin users | showOnlyOwnRecords | If parameter is set then only records own by the user will be visible to this user. Admin users will still see all the records. |
Form is read-only after registration | readonlyAfterRegistration | Set's the form to be readonly after user have registered. Form will be readonly only for the user registered. Users who have not yet registered will still be able to register. |
Message to show when a form is read-only and user has already been registered | readonlyAfterRegistrationMessage | When the flag 'Form is read-only after registration' is set and the user has registered the message will be shown with the text specified |
Track maximum capacity (records number) | maxCapacity | ConfiForms will allow only given number of registrations |
Message to show when maximum capacity is reached | maxCapacityMessage | When the flag 'Track maximum capacity (records number)' is set and the maximum has been reached the following message will be shown to the user with the given text |
Allow data export | export | If you want to enable data export for non-admin users (You will still need to set "Enable export" parameter on the TableView macro) |
Enable form's ''Print'' button | printEnabled | If set, then the form has a print button enabled |
Show editable fields in Print view | printEditable | If un-checked the fields in print view will be shown as read-only labels. When checked the form fields will be shown as editable fields |
Additional usernames (or user groups) that should be treated as form administrators | additionalFormAdmins | Comma separated list of usernames / usergroups that should be treated as form admins. Useful, when you want to lock down the form configuration but enable full control over the form's data to certain users |
ConfiForms Field Definition
confiform-field-definition
Macro to use inside the ConfiForms Form macro to define form fields, their types and behavior
Type of the field. Defines how the field is entered (datepickers for dates, dropdowns, etc). See exact definitions for more details.
Type | Compatibility | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Text | 4.3+ | simple text input field | ||||||||||||||||||||||||||||||||||||||||||||
Autolink | 4.3+ | You can create automatic links to resources based on a defined pattern. Very useful when used together with IFTTT macro to create pages. You can reference record owner as [owner]; record modifier, as [modifier]; any record field as [entry.FIELD_NAME] (except entry.id , which is not available when a record is about to be created) | ||||||||||||||||||||||||||||||||||||||||||||
Autonumber | 4.3+ | Field value is an auto incremented numeric value which will be assigned automatically to each record. You can control how the number is shown: by using mask (prefix) and initial number. See Text masks and masked input | ||||||||||||||||||||||||||||||||||||||||||||
Autopage | 4.3+ | Track the source of the record. Page where record was added will be automatically tracked | ||||||||||||||||||||||||||||||||||||||||||||
Calculated | 4.3+ | Enables you to set values for the field based on the expression.You can reference record owner as [owner]; record modifier, as [modifier]; any record field as [entry.FIELD_NAME]. Important: value is calculated only when an entry is created. See "Formula" type field if you need a calculable field which is recalculated on each edit. See Supported math operators and functions | ||||||||||||||||||||||||||||||||||||||||||||
Checkbox | 4.3+ | checkbox type of field | ||||||||||||||||||||||||||||||||||||||||||||
Checkbox group | 4.3+ | group of checkbox type inputs | ||||||||||||||||||||||||||||||||||||||||||||
Date | 5.0+ | Datepicker control, stores data in the format specified in Confluence general settings for DateFormat | ||||||||||||||||||||||||||||||||||||||||||||
Datetime | 5.0+ | Datepicker with time control, stores data in the format specified in Confluence general settings for DateTimeFormat | ||||||||||||||||||||||||||||||||||||||||||||
Drawing canvas | 4.3+ | for capturing simple drawings from users (good for 'wet signatures' for example) | ||||||||||||||||||||||||||||||||||||||||||||
Dropdown | 4.3+ | a dropdown (or combobox) field to use for capturing user input | ||||||||||||||||||||||||||||||||||||||||||||
Dynamic Dropdown | 4.3+ | a dropdown (or combobox) field, values could be pre-defined or referenced from other form with ability for users to enter their own | ||||||||||||||||||||||||||||||||||||||||||||
Enroll button | 5.0+ | one-click registrations and enrolments. | ||||||||||||||||||||||||||||||||||||||||||||
File | 4.3+ | to upload files/images. Files will be stored as attachments on the page where the ConfiForms form is defined | ||||||||||||||||||||||||||||||||||||||||||||
Formula | 4.3+ | Enables you to set values for the field based on the expression. You can reference record owner as [owner]; record modifier, as [modifier]; any record field as [entry.FIELD_NAME]. Important: value is calculated every time when an entry is updated (and created). See "Calculated" type field if you need a calculable field which is NOT recalculated on each edit. See Supported math operators and functions | ||||||||||||||||||||||||||||||||||||||||||||
Hidden | 4.3+ | a hidden constant to be stored with the record | ||||||||||||||||||||||||||||||||||||||||||||
Link | 4.3+ | convenient way to store links to other resources and show them as links | ||||||||||||||||||||||||||||||||||||||||||||
Masked Text | 4.3+ | Masked input for your text control. See here, how to define a mask: Text masks and masked input | ||||||||||||||||||||||||||||||||||||||||||||
Multiselect | 5.1+ | Useful when multiple values for the field should be stored | ||||||||||||||||||||||||||||||||||||||||||||
JIRA issue | 4.3+ | You can reference a JIRA issue with this field. Requires an application link to be set up | ||||||||||||||||||||||||||||||||||||||||||||
Page/Blog post | 4.3+ | Reference Confluence page or blogpost | ||||||||||||||||||||||||||||||||||||||||||||
Password | 5.0+ | Password fields | ||||||||||||||||||||||||||||||||||||||||||||
Radio group | 4.3+ | group of radio type inputs. Useful with surveys | ||||||||||||||||||||||||||||||||||||||||||||
Section | 4.3+ | section placeholder for your form. Use it to separate fields logically | ||||||||||||||||||||||||||||||||||||||||||||
Simple date | 4.3+ | 3 dropdowns (year, month, day) for easier date selection | ||||||||||||||||||||||||||||||||||||||||||||
Smart classifier | 4.3+ | sophisticated field type to allow users to enter data based on stored structured dataset. You can define as deep structure as you need. | ||||||||||||||||||||||||||||||||||||||||||||
4.3+ Smart-multiselect 5.1+ | a field to use for referencing the data from other ConfiForm forms. You can reference either other forms dropdown values or directly records stored (see the flag 'Reference to values'). | |||||||||||||||||||||||||||||||||||||||||||||
Status | 5.0+ | easily group and visualize your data. Each status has own color, useful when you need to group (or label) your data. Important Filtering by status field is a bit complex. As each colour has a constant value which is used to store the data. Here is the list of statuses and constants to use:
| ||||||||||||||||||||||||||||||||||||||||||||
Textarea | 4.3+ | shows user input in textarea field | ||||||||||||||||||||||||||||||||||||||||||||
User | 4.3+ | User's lookup field, useful when you need to store a reference Confluence users | ||||||||||||||||||||||||||||||||||||||||||||
User (multiselect) | 5.1+ | User's lookup field with ability to select many users | ||||||||||||||||||||||||||||||||||||||||||||
WYSIWYG | 5.0+ (on 4.3 this controls is shown as textarea) | simple editor, supports basic formatting styles |
* Compatibility column shows Confluence version number this field type is compatible with.
ConfiForms Registration Control
confiform-entry-register
Macro to define form's registration behaviour and the way how form is shown (dialog or embedded to page). You can have many 'Registration Controls' on different pages (or even on the same page) which use the same form (form definition)
When macro has a body defined then it will be used as an input for your form layout. To enable WYSIWYG mode you must have "ConfiForm Field" macros as a body of your "ConfiForms Registration Control" macro. You can place "ConfiForm Field" macros with any styling and any additional text.
If "ConfiForms Registration Control" macro is not defined (empty) a default layout will be used (table/card with key-value fields)
ConfiForms Form name | formName | Name of the ConfiForm this registration control should be linked to. The parameter is required when the macro is used stand-alone (not inside the ConfiForms Form macro). Could be skipped when the macro is configured inside the ConfiForms Form macro (in this case form name is taken automatically) |
---|---|---|
Page name where the form is defined | pageTitle | Leave blank if the form is defined on the same page |
Embedded or Dialog? | embedded | Check this option if you want to have your form embedded on the page, uncheck if you want your form as a pop-up dialog |
Label for Registration button | registrationButtonLabel | Caption for registration button used |
Message to show after a record been created | registrationMessage | |
Set values as key-value pairs, separated by & (as request parameters) | presetValues | Where ''key'' is ConfiForms Field name and ''value'' is the value you want to preset, separated by & |
Enable auto enroll | autoenroll | Useful when form has preset values (key-value pairs) and can be auto submitted. As you can have multiple registration controls for one form you can use "autoenroll" with predefine set of data to enable one-clieck submissions - works great when you want to capture yes/no feedback |
Valid redirect URL | redirectUrl | URL to redirect after successful ''save'' operation if needed. Supports parameters/references to record fields. You can reference record owner as [owner]; record modifier - as [modifier]; any record field as [entry.FIELD_NAME] |
CSS styles, separated by semicolon | css | Applied on ''Registration'' button when Dialog mode is on (when in embedded mode this button is not shown) |
Visible only to groups/users | restrictions | Comma-separated list of group names/usernames this field is visible to. Leave blank if there are no restrictions |
Hide control when stored data matches this criteria | hideIfMatches | Same syntax as in filters . The scope is ALL ConfiForms entries stored by the form referenced. The control will be hidden when the condition/filter given is met |
ConfiForms Edit Controls
confiform-entry-edit
Macro defines Edit controls behavior for ConfiForms ListView and ConfiForms TableView
Inline edit or through the modal dialog | inline | Defines how the record edit should be done: through dialog or inline on the page |
---|---|---|
Show both, Edit and Delete, buttons or just Edit | showBoth | You can restrict the 'Delete' action for users or allow both: Edit and Delete. If you want to restrict both: Edit and Delete then do not define the 'ConfiForms Edit Controls' macro |
Label for Edit button | editButtonLabel | Caption to use for edit button |
Label for Delete button | deleteButtonLabel | Caption to use for delete button (delete button is actually a link in UI) |
Message to show after a record been updated | updateMessage | |
Hide controls when stored data (for given record) matches this criteria | hideIfMatches | Same syntax as in filters. The scope is one current ConfiForms entry. The control will be hidden when the condition/filter given is met |
ConfiForms TableView
confiform-table
Macro to visualize your stored data as table, with instant search, filtering and data sorting/ordering
ConfiForms Form name | formName | Name of the ConfiForm form TableView should use |
---|---|---|
Page name where the form is defined | pageTitle | Leave blank if the form is defined on the same page |
Filter to apply on entries dataset | filter | See detailed documentation at ConfiForms Filters and/or in the tutorials |
Ordering/Sorting rules to apply on entries dataset | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
Enable instant search field over the table data | enableSearch | Adds search input to the table to enable quick search/filter on stored data |
Enable export | export | Provides a way to download forms content in CSV, XML and JSON formats. Admin users could always export ConfiForms data via the admin UI. For non-admin users, form's owner should enable support for data export via 'Allow data export' on ConfiForms form macro |
Pagination | pager | Showing records in sets (1, 5, 10, 20, 50, 100, 200 per page). If not configured then all stored records are shown |
If set when the resulting page will be wrapped into a scrollable container | wrapped | Parameter to wrap tables in scrollable divs, useful for showing big datasets |
CSS styles for TableView (table) | css | Custom CSS to place on the table generated. To apply a CSS class - prefix it with 'class:' |
Render a striped table | withHighlighting | Highlight every second row in a table |
ConfiForms ListView
confiform-list
Macro to visualize your stored data in WYSIWYG view (also supports filtering and data sorting/ordering)
ConfiForms Form name | formName | Name of the ConfiForm form TableView should use |
---|---|---|
Page name where the form is defined | pageTitle | Leave blank if the form is defined on the same page |
Filter to apply on entries dataset | filter | See detailed documentation at ConfiForms Filters and/or in the tutorials |
Pagination | pager | Showing records in sets (1, 5, 10, 20, 50, 100, 200 per page). If not configured then all stored records are shown |
Ordering/Sorting rules to apply on entries dataset | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
CSS styles for ListView (div) | css | Custom CSS to place on the section (div) generated. To apply a CSS class - prefix it with 'class:' |
ConfiForms CardView
confiform-card
Macro to visualize your stored data as vertical table (card), with instant search, filtering and data sorting/ordering
ConfiForms Form name | formName | Name of the ConfiForm form CardView should use |
---|---|---|
Page name where the form is defined | pageTitle | Leave blank if the form is defined on the same page |
Filter to apply on entries dataset | filter | See detailed documentation at ConfiForms Filters and/or in the tutorials |
Ordering/Sorting rules to apply on entries dataset | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
Enable instant search field over the table data | enableSearch | Adds search input to the table to enable quick search/filter on stored data |
Enable export | export | Provides a way to download forms content in CSV, XML and JSON formats. Admin users could always export ConfiForms data via the admin UI. For non-admin users, form's owner should enable support for data export via 'Allow data export' on ConfiForms form macro |
Pagination | pager | Showing records in sets (1, 5, 10, 20, 50, 100, 200 per page). If not configured then all stored records are shown |
If set when the resulting page will be wrapped into a scrollable container | wrapped | Parameter to wrap tables in scrollable divs, useful for showing big datasets |
CSS styles for TableView (table) | css | Custom CSS to place on the table generated. To apply a CSS class - prefix it with 'class:' |
ConfiForms Field
confiform-field
Macro to define a field to show within ConfiForms TableView, ConfiForms ListView or ConfiForms CardView macros
|
ConfiForms IFTTT
confiform-ifttt
Macro to define the integration rules for ConfiForms forms (to be placed inside ConfiForms Form macro body). Macro body is used as message body, page content or request content (depending on an action type)
Macro body totally supports referencing records, You can reference record owner as [owner]; record modifier, as [modifier]; any record field as [entry.FIELD_NAME]. Including complex types: See "Subject for email / title for page / url for request" below for details
- onCreated - when new record is created
- onModified - when record is modified
- onDeleted - when record is deleted
- Send Email - Send email to the list of participants, defined below
- Create Page - Creates page based on a given template
- Make request - Performs an HTTP request (GET or POST, depending on a macro body).
- Send Notification - Send Confluence notification
- Create ConfiForms Entry - creates ConfiForms entry in another form
Allows parameters and substitutions - could be constructed dynamically. You can reference record owner as [owner]; record modifier, as [modifier]; any record field as [entry.FIELD_NAME]
Complex fields (such as of type page/blogpost or user) are also supported.
When referencing a smart classifier field. It has all the standard field, plus additional fields defined in the ConfiForms entry
id - record id, unique uuid for every saved record - [entry.FIELD_NAME.id]
ownedBy - username of the user who owns the record (and can fully control it) - [entry.FIELD_NAME.ownedBy]
ownedByName - full name of the user who owns the record - [entry.FIELD_NAME.ownedByName]
createdBy - username of the user who has created the record (admin users can create records for other users) - [entry.FIELD_NAME.createdBy]
createdByName - full name of the user who has created the record - [entry.FIELD_NAME.createdByName]
created - timestamp when the record was created - [entry.FIELD_NAME.created]
dateCreatedFormatted - formatted way to see created timestamp - [entry.FIELD_NAME.dateCreatedFormatted]
And other, non standard fields, defined in the ConfiForms entry. [entry.FIELD_NAME.FIELD_NAME]
username - [entry.FIELD_NAME.username]
email - [entry.FIELD_NAME.email]
spaceKey - [entry.FIELD_NAME.spaceKey]
id - [entry.FIELD_NAME.id]
version - [entry.FIELD_NAME.version]
and other simple Page properties, which are available via getters
When you need to reference fields to create email body / page template / data to send to another service, you will need to use either ${} notation or the same notation as above using [entry.FIELD_NAME]. Both methods are supported. (see detailed example at Using IFTTT macro for integrations)
When referencing a smart classifier field. It has all the standard field, plus additional fields defined in the ConfiForms entry
id - record id, unique uuid for every saved record - ${entry.FIELD_NAME.id}
ownedBy - username of the user who owns the record (and can fully control it) - ${entry.FIELD_NAME.ownedBy}
ownedByName - full name of the user who owns the record - ${entry.FIELD_NAME.ownedByName}
createdBy - username of the user who has created the record (admin users can create records for other users) - ${entry.FIELD_NAME.createdBy}
createdByName - full name of the user who has created the record - ${entry.FIELD_NAME.createdByName}
created - timestamp when the record was created - ${entry.FIELD_NAME.created}
dateCreatedFormatted - formatted way to see created timestamp - ${entry.FIELD_NAME.dateCreatedFormatted}
And other, non standard fields, defined in the ConfiForms entry. ${entry.FIELD_NAME.FIELD_NAME}
Warning |
---|
Important. The preferred way to reference such field types is using [entry.FIELD_NAME.property] syntax! |
Current user is available under name "user"
fullName - ${user.fullName}username - ${user.username}
email - ${user.email}
spaceKey - ${page.spaceKey} to reference current page or ${entry.FIELD_NAME.spaceKey} to reference page in form
id - ${page.id} to reference current page or ${entry.FIELD_NAME.id} to reference page in form
version - ${page.title} to reference current page or ${entry.FIELD_NAME.version} to reference page in form
and other simple Page properties, which are available via getters
When "Send Email" action is setup you can specify the sender
When "Create Page" action is setup you can specify own page to be used as a parent page for these pages
Warning |
---|
Important to know that "Create ConfiForms Entry" action does not support propagation of "Create ConfiForms Entry" actions further. This is to avoid infinite loops (an entry creates an entry in another form using IFTTT macro, which creates another entry in the 1st form) |
ConfiForms TableView Merger
confiform-table-merger
ConfiForms helper macro to merge TableView results
Macro takes RICH TEXT as an input, and you need to define which fields (ConfiForms Field macros) to show and which tables to merge (ConfiForms TableView macros). There is a support for expressions to be used when aggregating your data. Learn more in TableView Merger examples
Filter to apply on entries dataset | filter | See detailed documentation at ConfiForms Filters and/or in the tutorials |
---|---|---|
Ordering/Sorting rules to apply on entries dataset | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
Enable export | export | Provides a way to download forms content in CSV, XML and JSON formats. Admin users could always export ConfiForms data via the admin UI. For non-admin users, form's owner should enable support for data export via 'Allow data export' on ConfiForms form macro |
Pagination | pager | Showing records in sets (1, 5, 10, 20, 50, 100, 200 per page). If not configured then all stored records are shown |
Render a striped table | withHighlighting | Highlight every second row in a table |
For examples see documentation in Merge and aggregation for ConfiForms and for advanced techniques: Advanced aggregations in TableView Merger |
ConfiForms Field Definition Rules
confiform-field-definition-rules
Macro to configure how ConfiForms Field Definitions are related. Supports creating complex relationships between form fields, based on selections, values entered and so on. To be used inside the ConfiForms Form macro to define rules for Field Definitions
Field name | actionFieldName | Name of the field you want to track |
---|---|---|
Action | action | Action to perform
|
Condition | condition | Action will be executed when condition is met. Same syntax as in filters. The scope is current entry/record |
Actionable field name | fieldName | When 'Show/Hide field' action is used you can specify which fields are affected. List of field names should be given as comma separated |
Values to set | values | When 'Set value' action is configured you can specify which fields and values to be set. Set values as key-value pairs, separated by & (as request parameters). Where ''key'' is field name and ''value'' is the value you want to set |
CSS Rules for ConfiForms Fields
confiform-field-css
Macro to use when you want to show fields differently, based on their values. To be used inside the ConfiForms TableView, ConfiForms ListView or ConfiForms CardView macros
Field value or expression to match | condition | You can use values or expressions, similar to filters. See detailed documentation on filters: ConfiForms Filters. The scope for filtering is the whole dataset (depends on a container macro where this macro is used, as the dataset is passed from container macro) |
---|---|---|
Field name | fieldName | Name of the field this rule should be applied on, if left empty then rule is applied on the row |
CSS to apply when condition is met | css | Valid CSS styles, separated by semicolon (example: color:red;border:1px). Styles will be applied on a field (if given) or on a row when used within table (container div when used in ConfiForms List) if field name is not set |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms View Control (EntryViewer)confiform-entry-viewer | The macro to use when you need to show all the fields for the stored entity in a readonly pop-up dialog.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms IFMatches View Helperconfiform-ifmatches | The macro helps you to show the content blocks based on the field values in ConfiForms records (to be used inside the ListView or CalendarView)
Use macro body to put the content you want to show/hide depending on the specified condition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConfiForms Dynamic Filterconfiform-entry-filter | The macro helps you to create dynamic filters for your ConfiForms views.
Use macro body to create a custom layout for your filter control, just same as ConfiForms Registration Control macro. Also expects ConfiForms Field macros referencing a form to be present in the macro body. When macro body is blank / empty then standard card-style layout is used and all form fields are set as filtering fields | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
How to reference a ConfiForms field (also Accessing field values and properties)
...
:
from IFTTT macro body |
|
|
| |
from IFTTT macro title parameter | [entry.FIELD_NAME] |
ConfiForms Registration Control, redirectURL parameter | [entry.FIELD_NAME] |
in Calculated/Formula field, when constructing an expression | [entry.FIELD_NAME] |
Info | ||
---|---|---|
| ||
More detailed documentation bits
Children Display |
---|