confiform | The main macro to define the entry form and its rules | ConfiForms Form name | formName | The name of the form being created. This name be unique within the page and use alphanumeric characters [a-z, 0-9]. |
|---|
| Registration form title | registrationFormTitle | The title for the form to be displayed in the registration dialog. |
|---|
| Save button label | saveButtonLabel | The text to display on the 'Save' button in the registration dialog. |
|---|
| Close button label | closeButtonLabel | The text to display on the 'Close' button in the registration dialog. |
|---|
| Print button label | printButtonLabel | The text to display on the 'Print' button in the registration dialog. |
|---|
| Enable full audit (DEPRECATED) | enableAudit | If set, this enables a full audit, tracking all the changes made to the form and enabling a change history for versioning purposes. The form's admin users are able to see the log as a part of the admin user interface. |
|---|
| Secure storage | secureStorage | When set, if a form has fields of type file then additional subpages with restricted access will be created to hold those files (as page attachments) and enable secure access. Form admins and a record original creator will have access to these attachments for download |
|---|
| Lock form | locked | Use this flag when the ConfiForm should be locked so that additional records cannot be stored. Admin users will still be able to manage the form's data. |
|---|
| Lock message | lockedMessage | The message text that will be displayed to users when the form is locked. |
|---|
| Enforce one entry per user | uniqueByUser | ConfiForms will ensure that only one record per user (ownedBy) is saved. |
|---|
| Enforce one entry per user message | uniqueByUserMessage | Message text to show when a user attempts to register more than one entry and 'One entry per user is enforced'. |
|---|
| Restrict record view for non-admin users | showOnlyOwnRecords | This parameter limits access for non-admin users so that only records owned by the user will be visible to this user. Admin users will still have access to all records. |
|---|
| Read-only after registration | readonlyAfterRegistration | This sets the form to be read-only once the user has submitted it. Users who have not yet submitted the form will still be able to do so. |
|---|
| Read-only message | readonlyAfterRegistrationMessage | When the 'Read-only after registration' parameter is set and the user has submitted the form, this text will be displayed. |
|---|
| Track maximum capacity (records number) | maxCapacity | The maximum number of records that ConfiForms will allow to be submitted. |
|---|
| Maximum capacity message | maxCapacityMessage | When the 'Track maximum capacity' flag is set and the maximum number of records has been reached, this text will be displayed. |
|---|
| Allow data export and enable search | export | Use this parameter to enable data export for non-admin users. The "Enable export" parameter on the TableView macro must also be set. This also enables form's data to be searchable via Confluence search. |
|---|
| Enable form's ''Print'' button | printEnabled | This parameter will enable a print button on the form. |
|---|
| Show editable fields in Print view | printEditable | When this parameter is set, the form's fields will be displayed as editable entries in the Print view. When not set, the fields will be shown as read-only labels. |
|---|
| Additional form admin user names (or groups) | additionalFormAdmins | A comma-separated list of user names / user groups that should be treated as the form's administrators. This parameter can be used to lock the form's configuration but enable full control over the form's data to certain users. |
|---|
| Anonymous form | anonymousInput | Enabling anonymous input for your form will allow you to create records anonymously (createBy and ownedBy fields are not set. Records could be modified only by Form admins) |
|---|
| Disable page re-index | disablePageIndex | When checked, the page with ConfiForms Form will not be reindexed (for search) on every entry modification. |
|---|
| Allow data reads for a user with no read access | allowReads | When set, the data stored with ConfiForms on this page will be accessible by a user even if a user does not have view permissions on the page |
|---|
| Enable form autocomplete | autocomplete | Uses browser based autocomplete feature for field values |
|---|
| Enable form debug mode | debugMode | When you have IFTTTs in your form and you want to see the execution log and order. Please be aware that you need to enable the logging as described here as well |
|---|
|
confiform-field-definition | The macro to use inside the ConfiForms Form macro to define the form's fields, their types, and behaviour. | Field name | fieldName | A required parameter which allows alphanumeric values; the name must be unique within the confluence page. |
|---|
| Label | fieldLabel | The label to be shown with a form element (for example, the caption for a button, the title for input fields, or the header when used in a ConfiForms Field in TableView or CardView). |
|---|
| Required | required | If this parameter is set, ConfiForms will ensure the field has a value and validate the user's input. |
|---|
|
|
|
|---|
|
|
|
|---|
| Field type | type |
The field's type which defines how data can be entered in the field (datepickers for dates, dropdowns, etc.) according to these definitions: Please see Accessing field values and properties on details how to access field's properties and what properties are available for each field type | Type | Compatibility | Description |
|---|
| Text | 4.3+ | A simple text input field. | | Action Button | 4.3+ | Action button to update the entry when in "view mode". Easy to implement quick notifications when used together with IFTTT module | | Attachments Picker | 5.1+ | Convenient way for connecting ConfiForms records with attachments (stored either on the same page or on a configured page) | | Autolink | 4.3+ | This type creates automatic links to resources based on a defined pattern. When used with an IFTTT macro to create pages, autolinks can reference the record owner as [owner]; the record modifier, as [modifier]; and 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+ | This type makes the field's value an auto-incremented number assigned automatically to each record. You can control how the number is displayed by using a mask (prefix) and an initial number. See Text masks and masked input. The pattern could be given as https://docs.oracle.com/javase/7/docs/api/java/lang/String.html#format(java.lang.String,%20java.lang.Object...)
| Autopage (tracking record soource) | 4.3+ | This field type records the source page where the record was submitted. | | Calculated | 4.3+ | This type sets the value for the field based on an expression which can reference record owner as [owner]; record modifier, as [modifier]; any record field as [entry.FIELD_NAME]. Important: the value is calculated only when an entry is created. See the "Formula" field type for a field which is recalculated on each edit. See Supported math operators, formulas and functions. | | Captcha | 5.1+ | Captcha field to prevent and fight "spam" and auto-submits | | Checkbox | 4.3+ | Display the field as a checkbox. | | Checkbox group | 4.3+ | Displays the field's options as a group of checkboxes. | | Comment | 5.1+ | A field to hold multiple comments (can be also enabled with anonymous user commenting on your record) | | Confluence Multi-label | 5.1+ | Provides a list of Confluence labels to pick from | | Currency | 5.0+ | A field to represent money, with currency symbol and in a desired format | | Date | 5.0+ | This type provides a datepicker that stores data in the format specified in Confluence's general settings for Date Format. | | Datetime | 5.0+ | A datepicker with time control to store data in the format specified in Confluence's general settings for Date Time Format. | | Datetime interval | 5.0+ | Datepicker which enables you to select 2 dates, start and end, could be used on CalendarView to show time periods / events | | Database Dropdown | 5.1+ | Same as simple dropdown, but backed up by the resultset from your database query. Your query must return 2 columns where first will be taken as ID and second will be used as field label | | Database Dropdown (advanced) | 5.1+ | Same as advanced dropdown but backed by database rows | | Database Multi-select | 5.1+ | Same as simple multi-select, but backed up by the resultset from your database query. Your query must return 2 columns where first will be taken as ID and second will be used as field label | | Database Checkbox | 5.1+ | Same as simple checkbox, but backed up by the resultset from your database query. Your query must return 2 columns where first will be taken as ID and second will be used as field label | | Database Radio group | 5.1+ | Same as simple radio group, but backed up by the resultset from your database query. Your query must return 2 columns where first will be taken as ID and second will be used as field label | | Database Smart Classifier | 5.1+ | Same as Smart classifier but backed up by YOUR database (available since version 1.24) | | Database Row Referencing Field | 5.0+ | Allows you to link a database record to the particular field / record in ConfiForms. As this is a "rich field" it means you can access through this field any linked data from your database record | | Database Dynamic Multi-label | 5.1+ | Allows you to set up lookups agains your database/table and assign labels to the field of this type | | Drawing canvas | 4.3+ | A field type for capturing simple drawings such as 'wet signatures,' for example. | | Dropdown | 4.3+ | This field type creates a drop-down list (or combobox) for capturing user input. | | Dropdown (advanced) | 5.1+ | A dropdown with a filtering field to make lookups. Useful with large number of choices | | Dynamic Dropdown (auto-suggest field) | 4.3+ | This one offers a dynamic drop-down list (or combobox) in which the values can be pre-defined or referenced from another form; it includes an option for users to enter their own values.
| | Dynamic Dropdown (auto-suggest field) - Database | 5.1+ | Dynamic dropdown field with the choices served from a database query. Make sure you have a column ID in your query, and it is unique - this will be used as identifier and stored in ConfiForms for later lookups. You can have multiple columns returned. All values then can be referenced through this field and shown in ConfiForms views. Second column will be used as a label for a dropdown choice | | Dynamic Dropdown (auto-suggest field) - Webservice | 5.1+ | Dynamic dropdown field with the choices served from a database query. Make sure you have a column ID in your query, and it is unique - this will be used as identifier and stored in ConfiForms for later lookups. You can have multiple columns returned. All values then can be referenced through this field and shown in ConfiForms views. Second column will be used as a label for a dropdown choice | | Dynamic Multi-label | 5.1+ | This controls behaves similarly to Confluence labels, and allows setting multiple labels to one field. List of labels could be dynamic and you can even set it to reference itself, meaning that when a new label is entered in current form it will be immediately available for lookup | | Enroll button | 5.0+ | This field type enables one-click record storage. | | File/Attachment | 4.3+ | This type provides a way to upload files and images. Uploads will be stored as attachments on the page where the ConfiForms form is defined. | | Formula | 4.3+ | This field type sets the value for the field based on an expression which can reference the record owner as [owner], a record modifier as [modifier]; and any record field as [entry.FIELD_NAME]. Important: this value is calculated every time an entry is updated (and created). See the "Calculated" type if the field should NOT recalculated on each edit. See Supported math operators, formulas and functions. | | Html | 4.3+ | raw HTML content | | Hidden | 4.3+ | This type provides for a concealed constant value to be stored with the record. | | Hidden Html | 4.3+ | Hidden raw HTML content | | Insight object | 5.1+ | Integrations with Riada Insight plugin to reference Insight object and bring access to all it's properties | | Insight object (multi-select) | 5.1+ | Same as above, but allows you to reference multiple objects in one ConfiForms field | | Insight objects dropdown | 5.1+ | Provides you with capability to build a dropdown over the Insight's types and objects | | IP Address tracking | 5.1+ | Hidden field to track user's IP address and save it together with form entry data | | Iranian Calendar | 5.1+ | Shows Iranian calendar as a data/datetime field control. There are Virtual functions to convert the data between the calendars | | Information panel (readonly) | 5.1+ | Similar to "Section" field - this field is not stored in the dataset but used for informational purposes. Can be of 3 types: info, warning and error. Intended use case is to use together with ConfiForms Field Definition Rules to show the field on the form conditionally, based on the values in other fields, to help/guide the users better while they fill in your forms | | Link | 4.3+ | Creates an easy link for you. Convenient way to set up the links that can be stored in the form's dataset and opened in a new tab (when necessary) | | Markdown editor | 5.1+ | Allows you to have contents in a field in a markdown and Atlassian markup (2 options). Value is rendered as HTML when in "view". | | Masked Text | 4.3+ | This type provides a way to mask (or constrain the format of characters entered) in a text field. For example, a mask of 00/00/0000 will format the entry in this way: 23/12/2014. See Text masks and masked input to learn more about defining a mask. | | Multi-select | 5.1+ | This type stores multiple values for the field. | | Numeric | 4.3+ | Same as text field but is converted to number when used in sorting/ordering | | Numeric hidden | 4.3+ | Same as numeric but hidden (useful when calculations and later filtering should be applied over the datasets) | | Jira issue | 4.3+ | This field type provides a means to reference a JIRA issue. It requires an application link between Confluence and JIRA. When issue by key is found you can access some of it's properties: | Property |
|---|
| key | | title | | description | | status | | link |
- title can be accessed via name "summary" as well
See more details on Accessing field values and properties
| | JIRA issues (multi-select) | 5.1+ | Allows you to reference multiple JIRA issues with one ConfiForms field You can access any property from the referenced JIRA issue. Before doing so you need to convert a field to JIRA issue object internally, using Virtual functions called asJIRAIssue For example: Will print a title for each JIRA issue referenced with this field | | Jira Select Field | 7.19+ Available - since 3.13 (Data Center)
- cloud
| Allows you to connect a Jira field that has values defined for the field as a field in ConfiForms. Automatically supports - Multi-select fields (including checkboxes, but will be rendered as a multi-select dropdown)
- Single choice dropdowns
- Cascading dropdowns (will render 2 levels dependent dropdowns)
| | JIRA JQL | 5.1+ | Expects you to put a valid JQL, which will be executed for you and a number of matching issues will be shown (together with the link to JIRA search) | | Page/Blog post | 4.3+ | This type permits the field to reference a Confluence page or blog post. | | Page/Blog post (multi-select) | 5.1+ | Allows you to reference multiple pages in one ConfiForms field. Before accessing properties of the referenced pages you will need to use virtual function called asPage to transform field values to a Page object | | Password | 5.0+ | A type for passwords which obscures the characters being entered. | | Radio group | 4.3+ | This type provides for a group of radio buttons, which allow the user to choose a single exclusive option. This type can be especially useful with surveys.
| | Readonly | 4.3+ | Looks like a text field but is readonly to the user, might have a default value. Usually used with ConfiForms Field Definition Rules which set's value to this field | | Section | 4.3+ | This is a section placeholder to separate fields into groups on the form.
| | Security group | 5.1+ | Field lists security groups available in your Confluence to pick from You can restrict the groups in the list if necessary | | Security group (multi) | 5.1+ | Same as above, but allows multiple security groups to be associated with a field | | Simple date | 4.3+ | This type offers 3-part drop-down lest (year, month, and day) for easy date selection. | | Smart classifier | 4.3+ | This sophisticated field type allows users to enter data based on a stored structured dataset and the deep structure can be defined as needed. | Smart Dropdown Smart Dropdown (advanced) Smart Multiselect Smart Radio buttons Smart Checkbox | 4.3+
5.1+
5.1+
5.1+
5.1+ | These types provide ways to reference the data from other ConfiForm forms, either another form's drop-down values, or records stored directly (see the flag 'Reference to values'). | Smart multi-row | Since ConfiForms version 3.0 and cloud | ConfiForms Smart Multi-row - what it offers and how to use it
| | Spaces | 5.1+ | Available since ConfiForms version 2.21.x List of spaces (current user has 'view' access to) | | Status | 5.0+ | This field type permits easy grouping and presentation for entered data. Each status level is color-coded to foreground data groupings. Important Filtering by the status field can be a bit complex because each color has a constant value which is stored with the data according to this pattern: | Color | Constant |
|---|
DEFAULT | default | ERROR | error | CURRENT | current | SUCCESS | success | COMPLETE | complete | MOVED
Current colouring scheme in our Confluence as of now (live example)
| moved |
| | Storage format | 5.1+ | The field can hold and render the storage format (other macros) | | Time | 5.1+ | Field to store time | | Timestamp | 5.1+ | Field to store a timestamp (in epoch format) | | Textarea | 4.3+ | This type provides a textarea for user input.
| | User | 4.3+ | This field type enables reference to users in the Confluence system. Entering initial letters of a username will automatically provide a list of suggested users.
| | User (multiselect) | 5.1+ | Like the User type, this one allows selection of multiple users. | | Voting control | 5.0+ | Enables quick voting control (renders as a button in "view mode" and rendered as "user picker" in "edit mode") | | Version | 5.1+ | Enables "versionable" record. This means the data will be checked before saving if it has been changed in between | Webservice-backed object referencing field Webservice dropdown Webservice dropdown (advanced) Webservice multi-select Webservice Dynamic Multi-label Webservice checkbox Webservice radio group | 5.1+ | Groups of fields, similar to smart/db fields, but enabling you to connect to web services and show the data from webservices in ConfiForms fields For example to show components from Jira - Building a dropdown field in ConfiForms backed by webservice call to Jira Rest API - createmeta
| | WYSIWYG | 5.0+ (on 4.3 this controls is shown as textarea) | This field type provides a simple editor that supports basic formatting styles. |
* The Compatibility column shows the Confluence version number with which this field type is compatible.
Check out the Accessing field values and properties document which explains how to use each field type in "views", to show the data
|
|---|
| Field description | fieldDescription | This parameter provides a caption text for the field that is visible below the field. |
|---|
| Visibility | restrictions | Use this parameter to limit a field's visibility to selected users or groups. It accepts a comma-separated list of group and users and can be left blank if there are no restrictions. |
|---|
| Editability | editRestrictions | Like the Visibility parameter, this one limits who can edit the field, again using a comma-separated list of group or user names; can also be left blank if there are no restrictions. |
|---|
| CSS styles | css | This parameter can contain the CSS rules that should be applied to the field's input. Adjust the CSS rules on the ConfiForms Field macro to customize the field's output. |
|---|
| Validation rules | validation | A regular expression to validate the field's input; see detailed documentation at Automatic validation for your fields. |
|---|
| Validation message | validationMessage | A message to be displayed when validation fails; if this is not specified, a standard message will be shown. |
|---|
|
confiform-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 Form name | formName | The name of the ConfiForm to which this registration control should be linked. This parameter is required when the macro is used by itself (not inside the ConfiForms Form macro). The name parameter can be skipped when the macro is configured inside the ConfiForms Form macro, and if not defined, the form name is automatically assigned. |
|---|
| Location page name | pageTitle | The name of the page on which the form is defined if not the current one; leave this blank if the form is defined on the same page. |
|---|
| Embedded or Dialog? | embedded | Check this option to have the form embedded on the page, uncheck to display the form as a pop-up dialog. |
|---|
| Use the layout from main 'ConfiForms Registration Control' | regControlLayout | When set, ConfiForms will try to find the Registration Control from ConfiForms Form macro and will try to use that for rendering the view dialog. |
|---|
| Registration button label | registrationButtonLabel | The text to be displayed on the dialog opener button (when form is in dialog mode). |
|---|
| Override Form dialog's 'Save' button | overrideSaveButtonLabel | Now you can override Form's default button caption for saving the records. |
|---|
| Override label for form 'Close' button | overrideCloseButtonLabel | Override Form's default button caption for closing the dialog window. |
|---|
| Override label for form 'Print' button | overridePrintButtonLabel | Override Form's default button caption for printing. |
|---|
| Post save message | registrationMessage | The text to be displayed after a record been created. |
|---|
| Confirmation message to show before form submit | confirmationMessage | Confirmation message to show before form submit. Leave blank if you don't want to have a confirmation dialog to be shown before form submit. |
|---|
| Key-value request parameters | presetValues | This parameter provides a way to preset values for certain fields in the form. These are listed as key-value pairs, separated by & (as request parameters) where the ''key'' is a ConfiForms Field name and the ''value'' is the data to be preset for the field. You can also pre-set some values from a context: - [now] - to set current date/time on the date/time field
- [user.name] - current logged-in username (if anonymous access then "Anonymous" will be set)
- [user.fullName] - current logged-in user's full name (if anonymous access then "Anonymous" will be set)
- [user.email] - current logged-in user's email (if anonymous access then "" will be set as email)
use it like key=value, for example mydt=[now] Also, supports referencing "this" for "user" and "page" fields. Like will reference current page (when field "mypage" is of type "page or autopage") |
|---|
| Enable auto enroll | autoenroll | Use this parameter when the form has preset values (key-value pairs) and can be auto submitted. Because the form can have multiple registration controls, the auto enroll can be combined with predefined data to enable one-click submissions, for example, to capture yes/no feedback. |
|---|
| Valid redirect URL | redirectUrl | An optional location to which the user will be redirected after a successful ''save'' operation. This parameter supports parameters and references to record fields: the record owner can be referenced as [owner]; the record modifier as [modifier]; and any record field can be referenced as [entry.FIELD_NAME]. |
|---|
| Open redirect URL in a new window/tab | redirectUrlOpensInNew | Open redirect URL in a new window/tab |
|---|
| CSS styles | css | CSS rules to be applied to the Register button when the form is displayed as a pop-up dialog (when the form is embedded in the page, this button is not shown). |
|---|
| Visible only to groups/users | restrictions | This parameter accepts a comma-separated list of groups and users to which this field will be visible. Leave this parameter blank if there are no restrictions. |
|---|
| Hide control when stored data matches this criteria | hideIfMatches | ALL ConfiForms entries stored by the form referenced will be concealed when the items in this parameter are matched in the entry. The control itself will be hidden when the condition/filter given is met, and this parameter uses the same syntax as in filters . |
|---|
| Reverse criteria | reverse | Reverses condition defined in "Hide control when stored data matches this criteria" |
|---|
| Field errors | reportFieldErrors | Errors will be reported also with a message shown next to the field. |
|---|
| Form height | formHeight | Form height (in pixels, number only). Leave blank if you are fine to have an automatic form's height calculation. |
|---|
| Form width | formWidth | Form width (in pixels, number only). Leave blank if you are fine to have an automatic form's width calculation. |
|---|
| Execute custom JavaScript function after the form is loaded | afterLoadInit | Put the name of the JavaScript function you want to execute. You can have 'formId' as parameter in this function to receive form element id. Confluence administrators could disable scripts execution in ConfiForms app settings. |
|---|
|
confiform-entry-edit | This macro defines the behaviour of the Edit control for ConfiForms ListView and TableView. | Inline edit or in dialog | inline | Defines how the record edit should be done: through a dialog or inline on the page. |
|---|
| Displays controls in compact mode | compactMode | In compact mode ConfiForms edit controls are rendered as a dropdown menu, not buttons. |
|---|
| Display Edit and Delete buttons | showBoth | This parameter can be configured to conceal the 'Delete' action for non-administrative users, or to display both Edit and Delete. To conceal both Edit and Delete, do not define the 'ConfiForms Edit Controls' macro. |
|---|
| Display Copy button | showCopy | Shows "Copy" button, enables easy copying of records / duplication. Disabled by default. |
|---|
| Hide edit button | hideEdit | When enabled, the "Edit" button will not be shown (for example, when only "Delete" needs to be shown, as a requirement). |
|---|
| Use the layout of Registration Control (from form) | regControlLayout | You can point "Edit controls" macro to reference a default ConfiForms Registrations Control macro layout (ConfiForms Registration Control macro MUST be inside the ConfiForms Form Definition macro body in order for this macro to find it and pick it's layout correctly). |
|---|
| Label for Edit button | editButtonLabel | The text to display on the edit button. |
|---|
| Label for Delete button | deleteButtonLabel | The text to display on the delete button, which is actually a link in the user interface. |
|---|
| Label for Copy button | copyButtonLabel | The text to display on the copy button. |
|---|
| Label for Cancel button | cancelButtonLabel | The text to display on the cancel button. |
|---|
| Post update message | updateMessage | The text to display after a record has been updated. |
|---|
| Redirect URL | redirectUrl | You can specify custom redirect URL to be shown after the 'save' operation completes. Could be constructed dynamically. You can reference record owner as [owner]; record modifier as [modifier]; current user as [user]; any record field as [entry.FIELD_NAME]; you can reference page watchers as [watchers]. You can use @self to stay on current page. |
|---|
| Open redirect URL in a new window/tab | redirectUrlOpensInNew | Open redirect URL in a new window/tab. |
|---|
| CSS styles | css | CSS rules to be applied on the control (when used inside the table you can specify the width it occupies). |
|---|
| Visible only to groups/users | restrictions | This parameter accepts a comma-separated list of groups and users to which this field will be visible. Leave this parameter blank if there are no restrictions. |
|---|
| Hide control when stored data matches this criteria | hideIfMatches | The current ConfiForms entry stored by the form referenced will be concealed when the items in this parameter are matched in the entry. The control itself will be hidden when the condition/filter given is met, and this parameter uses the same syntax as in filters . |
|---|
| Reverse criteria | reverse | Reverses condition defined in "Hide control when stored data matches this criteria". |
|---|
| Form height | formHeight | Form height (in pixels, number only). Leave blank if you are fine to have an automatic form's height calculation. Only works for non-inline edit mode. |
|---|
| Form width | formWidth | Form width (in pixels, number only). Leave blank if you are fine to have an automatic form's width calculation. Only works for non-inline edit mode. |
|---|
|
confiform-table | The macro to display stored data as a table, with instant search, filtering, and data sorting/ordering. | ConfiForms Form name | formName | The name of the ConfiForm form that TableView will use. |
|---|
| Form Location page | pageTitle | The name of the page on which the form is defined if not the current one; leave this blank if the form is defined on the same page. You can use @parent to reference a parent page. |
|---|
| Filter | filter | The filter to be applied to the stored dataset; see detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Distinct filter | distinct | Apply distinct filter to return only unique records. Field names as comma separated list to be used as a key for applying distinct filter. |
|---|
| Ordering/Sorting rules | sort | Rules for ordering and sorting the returned dataset; see detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| Limit a number of records returned (a number) | limit | You can set the limit to the number of records returned. No limit when is blank. The same thing could be done using the filter and adding LIMIT n to the end of the filter. |
|---|
| Enable instant search | enableSearch | This parameter adds a search input field above the table to enable quick searching and filtering of the stored data. |
|---|
| Enable inline individual edits | enableGridEdit | When enabled, a user with sufficient permissions will be able to edit the cell data inline (by double clicking on the table cell holding the value). NOT COMPATIBLE when a view has Edit Controls / Entry Viewer! |
|---|
| Enable support for a filter | enableFilterSupport | Adds a "DIV" element around the rendered table, so the ConfiForms Filter macro will be able to find it on the page (In some cases you need a pure table to be rendered, as when used inside the chart macro, therefore this setting is set to false by default) |
|---|
| Enable 'Add new record' inline button | enableInlineAdd | Enables users to have a button to add records inline (without a need to have to open the form's dialog window). |
|---|
| Caption for 'Add new record' inline button | inlineAddButtonLabel | Text caption for 'Add new record' inline button. |
|---|
| Pagination | pager | A parameter to enable displaying records in sets (for example, in groups of 1, 25, 50, 100, or 200 per page); if not configured then all stored records are shown. |
|---|
| Override 'Hide if empty' parameter | showEmptyValues | Override 'Hide if empty' parameter on fields and force to show empty values. |
|---|
| Enable export | export | This parameter provides a way for non-administrative users to download the returned data in CSV, XML, or JSON formats. While the form's administrative users can always export ConfiForms data with the administrative interface, they should enable data export for non-administrative users with the 'Allow data export' parameter in the ConfiForms form macro. |
|---|
| Comma separated list of fields to export | exportFields | Comma separated list of fields to export. You can put rich properties. When left empty the default list fields list is taken. |
|---|
| Scrollable tables | wrapped | This parameter provides scroll bars for larger tables by applying CSS style rules. |
|---|
| When wrapping is enabled you can limit the scrolling | enableScrollingWhenWrapped | When wrapping is enabled you can limit the scrolling. Effective only when wrapping into scrollable container is enabled. |
|---|
| CSS styles | css | Use this parameter to customize CSS styling for the table to be generated; to apply a CSS class prefix the ruleset with 'class:' |
|---|
| Striped table rendering | withHighlighting | This parameter enables highlighting alternate rows in a table. |
|---|
| Message to show when dataset is empty | messageToShowWhenEmpty | Message to show when dataset is empty. Leave empty if you do not want to show any message. |
|---|
| Show number of records in the footer | showRecordsCount | Shows number of records in the footer. |
|---|
| Label to use for showing number of records | showRecordsCountLabel | Text for label for showing number of records in the footer. |
|---|
| Merge action buttons into one column | mergeActionButtons | By default action buttons, as any other fields in ConfiForms use own column to render the output. |
|---|
| Filter ID | filterId | Do not use spaces or umlauts. Mapping between ConfiForms Filter macro and this view, to ensure the correct view is filtered 'Filter ID' parameter must be identical. |
|---|
|
confiform-list | This macro displays your stored data in WYSIWYG view (it also supports filtering and data sorting/ordering). | ConfiForms Form name | formName | The name of the ConfiForm form TableView should use. |
|---|
| Form Location page | pageTitle | The location of the page on which the form is defined; leave blank if the form is on the same page. |
|---|
| Filter | filter | A parameter for selecting records from the dataset; see detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Distinct filter | distinct | Apply distinct filter to return only unique records. Field names as comma separated list to be used as a key for applying distinct filter. |
|---|
| Ordering/Sorting | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| Limit a number of records returned (a number) | limit | You can set the limit to the number of records returned. No limit when is blank. The same thing could be done using the filter and adding LIMIT n to the end of the filter. |
|---|
| Enable instant search | enableSearch | This parameter adds a search input field above the table to enable quick searching and filtering of the stored data. |
|---|
| Enable 'Add new record' inline button | enableInlineAdd | Enables users to have a button to add records inline (without a need to have to open the form's dialog window). |
|---|
| Caption for 'Add new record' inline button | inlineAddButtonLabel | Text caption for 'Add new record' inline button. |
|---|
| Pagination | pager | A parameter to enable displaying records in sets (for example, in groups of 1, 25, 50, 100, or 200 per page); if not configured then all stored records are shown. |
|---|
| Enable inline individual edits | inlineEdit | When enabled, a user with sufficient permissions will be able to edit the data inline (by double clicking on the value). |
|---|
| Enable export | export | This parameter provides a way for non-administrative users to download the returned data in CSV, XML, or JSON formats. While the form's administrative users can always export ConfiForms data with the administrative interface, they should enable data export for non-administrative users with the 'Allow data export' parameter in the ConfiForms form macro. |
|---|
| Comma separated list of fields to export | exportFields | Comma separated list of fields to export. You can put rich properties. When left empty the default list fields list is taken. |
|---|
| CSS styles | css | Use this parameter to customize CSS styling for the table to be generated; to apply a CSS class prefix the ruleset with 'class:' |
|---|
| Message to show when dataset is empty | messageToShowWhenEmpty | Message to show when dataset is empty. Leave empty if you do not want to show any message. |
|---|
| Show number of records in the footer | showRecordsCount | Shows number of records in the footer. |
|---|
| Label to use for showing number of records | showRecordsCountLabel | Text for label for showing number of records in the footer. |
|---|
| Filter ID | filterId | Do not use spaces or umlauts. Mapping between ConfiForms Filter macro and this view, to ensure the correct view is filtered 'Filter ID' parameter must be identical. |
|---|
|
confiform-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 Form name | formName | The name of the ConfiForm form TableView should use. |
|---|
| Form Location page | pageTitle | The location of the page on which the form is defined; leave blank if the form is on the same page. |
|---|
| Filter | filter | A parameter for selecting records from the dataset; see detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Distinct filter | distinct | Apply distinct filter to return only unique records. Field names as comma separated list to be used as a key for applying distinct filter. |
|---|
| Ordering/Sorting | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| Limit a number of records returned (a number) | limit | You can set the limit to the number of records returned. No limit when is blank. The same thing could be done using the filter and adding LIMIT n to the end of the filter. |
|---|
| Message to show when dataset is empty | messageToShowWhenEmpty | Message to show when dataset is empty. Leave empty if you do not want to show any message. |
|---|
Enable support for a filter | enableFilterSupport | Adds a "DIV" element around the rendered table, so the ConfiForms Filter macro will be able to find it on the page (In some cases you need a pure table to be rendered, as when used inside the chart macro, therefore this setting is set to false by default) |
|---|
| Enable inline individual edits | inlineEdit | When enabled, a user with sufficient permissions will be able to edit the data inline (by double clicking on the value). |
|---|
| Filter ID | filterId | Do not use spaces or umlauts. Mapping between ConfiForms Filter macro and this view, to ensure the correct view is filtered 'Filter ID' parameter must be identical. |
|---|
| How the contents shall be rendered | renderAs | Allows to select how the contents of form will be rendered as default, table or div. |
|---|
|
confiform-plain | This macro displays your stored data in plain view (it also supports filtering and data sorting/ordering). | ConfiForms Form name | formName | The name of the ConfiForm form TableView should use. |
|---|
| Form Location page | pageTitle | The location of the page on which the form is defined; leave blank if the form is on the same page. |
|---|
| Filter | filter | A parameter for selecting records from the dataset; see detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Distinct filter | distinct | Apply distinct filter to return only unique records. Field names as comma separated list to be used as a key for applying distinct filter. |
|---|
| Ordering/Sorting | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| Limit a number of records returned (a number) | limit | You can set the limit to the number of records returned. No limit when is blank. The same thing could be done using the filter and adding LIMIT n to the end of the filter. |
|---|
| Message to show when dataset is empty | messageToShowWhenEmpty | Message to show when dataset is empty. |
|---|
Enable support for a filter | enableFilterSupport | Adds a "DIV" element around the rendered table, so the ConfiForms Filter macro will be able to find it on the page (In some cases you need a pure table to be rendered, as when used inside the chart macro, therefore this setting is set to false by default) |
|---|
| Filter ID | filterId | Do not use spaces or umlauts. Mapping between ConfiForms Filter macro and this view, to ensure the correct view is filtered 'Filter ID' parameter must be identical. |
|---|
| How the contents shall be rendered | renderAs | Allows to select how the contents of form will be rendered as default, table, div or data. |
|---|
|
confiform-card | This macro displays your stored data as a vertical table (or card) with instant search, filtering, and data sorting/ordering. | ConfiForms Form name | formName | The name of the ConfiForm form that CardView should use. |
|---|
| Form Location page | pageTitle | A parameter to store the page where the form has been defined; this should be left blank if the form is defined on the same page |
|---|
| Filters | filter | See detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Distinct filter | distinct | Apply distinct filter to return only unique records. Field names as comma separated list to be used as a key for applying distinct filter. |
|---|
| Ordering/Sorting rules | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| Limit a number of records returned (a number) | limit | You can set the limit to the number of records returned. No limit when is blank. The same thing could be done using the filter and adding LIMIT n to the end of the filter. |
|---|
| Instant search | enableSearch | Adds a search input field above the table to enable quick search and filtering of stored data. |
|---|
| Enable inline individual edits | enableGridEdit | When enabled, a user with sufficient permissions will be able to edit the cell data inline (by double clicking on the table cell holding the value). NOT COMPATIBLE when a view has Edit Controls / Entry Viewer! |
|---|
| Enable support for a filter | enableFilterSupport | Adds a "DIV" element around the rendered table, so the ConfiForms Filter macro will be able to find it on the page (In some cases you need a pure table to be rendered, as when used inside the chart macro, therefore this setting is set to false by default). |
|---|
| Enable 'Add new record' inline button | enableInlineAdd | Enables users to have a button to add records inline (without a need to have to open the form's dialog window). |
|---|
| Caption for 'Add new record' inline button | inlineAddButtonLabel | Text caption for 'Add new record' inline button. |
|---|
| Pagination | pager | A parameter to enable displaying records in sets (for example, in groups of 1, 25, 50, 100, or 200 per page); if not configured then all stored records are shown. |
|---|
| Override 'Hide if empty' parameter | showEmptyValues | Override 'Hide if empty' parameter on fields and force to show empty values. |
|---|
| Enable export | export | This parameter provides a way for non-administrative users to download the returned data in CSV, XML, or JSON formats. While the form's administrative users can always export ConfiForms data with the administrative interface, they should enable data export for non-administrative users with the 'Allow data export' parameter in the ConfiForms form macro. |
|---|
| Comma separated list of fields to export | exportFields | Comma separated list of fields to export. You can put rich properties. When left empty the default list fields list is taken. |
|---|
| Scrollable tables | wrapped | This parameter provides scroll bars for larger tables by applying CSS style rules. |
|---|
| When wrapping is enabled you can limit the scrolling | enableScrollingWhenWrapped | When wrapping is enabled you can limit the scrolling. Effective only when wrapping into scrollable container is enabled. |
|---|
| CSS styles | css | Use this parameter to customize CSS styling for the table to be generated; to apply a CSS class prefix the ruleset with 'class:' |
|---|
| Message to show when dataset is empty | messageToShowWhenEmpty | Message to show when dataset is empty. |
|---|
| Show number of records in the footer | showRecordsCount | Shows number of records in the footer. |
|---|
| Label to use for showing number of records | showRecordsCountLabel | Text for label for showing number of records in the footer. |
|---|
| Merge action buttons into one column | mergeActionButtons | By default action buttons, as any other fields in ConfiForms use own column to render the output. |
|---|
| Filter ID | filterId | Do not use spaces or umlauts. Mapping between ConfiForms Filter macro and this view, to ensure the correct view is filtered 'Filter ID' parameter must be identical. |
|---|
|
confiform-calendar | This macro displays your stored data in a calendar view. | Name of the field to use as a grouping field fro calendar | groupingFieldName | Must be of type Date/Datetime/Datetime interval or field value returns a timestamp |
|---|
| ConfiForms Form name | formName | The name of the ConfiForm form that CardView should use. |
|---|
| Form Location page | pageTitle | A parameter to store the page where the form has been defined; this should be left blank if the form is defined on the same page |
|---|
| Filters | filter | See detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Distinct filter | distinct | Apply distinct filter to return only unique records. Field names as comma separated list to be used as a key for applying distinct filter. |
|---|
| Ordering/Sorting rules | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| Limit a number of records returned (a number) | limit | You can set the limit to the number of records returned. No limit when is blank. The same thing could be done using the filter and adding LIMIT n to the end of the filter. |
|---|
| Pagination | pager | A parameter to enable displaying records in sets (for example, in groups of 1, 25, 50, 100, or 200 per page); if not configured then all stored records are shown. |
|---|
| CSS styles | css | Use this parameter to customize CSS styling for the table to be generated; to apply a CSS class prefix the ruleset with 'class:' |
|---|
| ConfiForms Field name to use as calendar event title | eventTitleFieldName | Value of this field will be used as calendar event title in the Calendar view (as always, you can use [entry.FIELD_NAME] notation to reference field values). When left empty, ConfiForms will try to figure out it for you automatically based on the CalendarView macro body. |
|---|
| Calendar panel title | panelTitle | Header text to show on the calendar entries panel. |
|---|
| Default date | defaultDate | You can override the initial date (day and month) in the CalendarView. Expects the date in ISO8601 format. Example: 2016-02-21 |
|---|
| Body placement | placement | You can have a calendar rendered for you on the Left, Right, as Calendar only or in a Dialog mode |
|---|
| View mode for calendar | viewMode | Various modes to render your calendar: Month, Week, Day. User is able to switch between modes. This defines how the calendar is rendered initially |
|---|
| Next day threshold in month view | nextDayThreshold | When month view is shown, and the event has an end date set, the calendar will span the event to next day if event's time is after this threshold |
|---|
| Weekday from which to start calendar | dayOfWeekStart | By default, user locale settings are taken. |
|---|
| Show detailed view on click in read-only mode | readonlyViewOnClick | By default events are shown in edit mode, if a user has enough permissions to edit a particular record. |
|---|
| Disable showing 'detailed view on event click' | disableViewOnClick | When checked the detailed view will not be shown. |
|---|
| Show delete button on detailed view | viewAndDeleteOnClick | Shows the 'Delete' button on detailed view. |
|---|
| Label for delete button | viewAndDeleteOnClickLabel | Caption text for 'Delete' button. |
|---|
| Filter ID | filterId | Do not use spaces or umlauts. Mapping between ConfiForms Filter macro and this view, to ensure the correct view is filtered 'Filter ID' parameter must be identical. |
|---|
|
confiform-value | This macro displays your stored data in a simple field view | ConfiForms Form name | formName | The name of the ConfiForm form that CardView should use. |
|---|
| Form Location page | pageTitle | A parameter to store the page where the form has been defined; this should be left blank if the form is defined on the same page |
|---|
| Field name or expression* | fieldName | Name of the field defined on the form or context field, or an expression, like [count] (and variants) or [total]. Also you can use virtual functions here. |
|---|
| Filters | filter | See detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Distinct filter | distinct | Apply distinct filter to return only unique records. Field names as comma separated list to be used as a key for applying distinct filter. |
|---|
| Ordering/Sorting rules | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| Limit a number of records returned (a number) | limit | You can set the limit to the number of records returned. No limit when is blank. The same thing could be done using the filter and adding LIMIT n to the end of the filter. |
|---|
| Field label | withLabel | The label from the ConfiForms field definition will be added as message before the field value. |
|---|
| Override output format | overrideFormat | You can specify you own format to be used when field value is shown - expects Java Number Format pattern. See some examples in Virtual functions (formatting currency and formatting number) |
|---|
| Hide if empty | hideIfEmpty | Use this parameter in order to conceal a field when its stored value is blank |
|---|
| Hide field when stored data (for given record) matches this criteria | hideIfMatches | Same syntax expected as in filters. |
|---|
| Reverse criteria | reverse | Reverses condition defined in "Hide control when stored data matches this criteria". |
|---|
| Enable inline individual edits | inlineEdit | When enabled, a user with sufficient permissions will be able to edit the data inline (by double clicking on the value). |
|---|
| Output field value in a raw format | showRaw | You can use virtual functions here to prepare the raw value according to your requirements. |
|---|
| CSS styles | css | Use this parameter to customize CSS styling for the table to be generated; to apply a CSS class prefix the ruleset with 'class:' |
|---|
| Message to show then field value is empty | messageToShowWhenEmpty | Default message to show when field value is empty |
|---|
| Message to show when filter matches no results | valueToShowWhenEmpty | Leave blank if nothing shall be shown when the filter matches no results |
|---|
| Output type | output-type | INLINE or BLOCK. Renders macro output inline or as a block (div). |
|---|
|
confiform-field | This macro defines a field to be displayed within the ConfiForms TableView, ListView, or CardView macros | Field name | fieldName | The name of the field defined on the form referenced. The macro's preview mode displays the field names stored within the form. The ConfiForm metadata fields are available always as well (see above). |
|---|
| Field label | withLabel | The label from the ConfiForms field definition will be added as a prefix before the field value. |
|---|
| Override field label defaults | overrideLabel | When left empty the label for the field is taken from ConfiForms Field Definition for this field, here you can override it |
|---|
| Override output format | overrideFormat | You can specify you own format to be used when field value is shown - expects Java Number Format pattern. See some examples in Virtual functions (formatting currency and formatting number) |
|---|
| Apply filter on choices | filter | Relevant only for dropdown fields (single or multi-select (simple, smart, db)). Filter is applied on the dataset this field is connected to (in case of smart/db fields). Same as in 'Apply filter' rule. |
|---|
| Show label on own line | showLabelOnOwnLine | To be used when 'Show value with label' is set to true and you need a label to be placed on own line. |
|---|
| Hide if empty | hideIfEmpty | Use this parameter in order to conceal a field when its stored value is blank, as in ListView or CardView, for example. |
|---|
| Hide field when stored data (for given record) matches this criteria | hideIfMatches | Same syntax expected as in filters. |
|---|
| Reverse criteria | reverse | Reverses condition defined in "Hide control when stored data matches this criteria". |
|---|
| Do not show description with the field | dontShowDescription | This is sometimes needed when you are building your very own layout for the form and want to control just about everything. |
|---|
| CSS styles | css | This parameter provides a way to apply CSS styles (for example: color:red; border:1px) to the field. Styles will be applied on stored values on output. |
|---|
| Disable inline edit | disableInlineEdit | You can disable inline edits for this particular field when inline edits are enabled for the whole view. |
|---|
| Message to show when a field value is empty | messageToShowWhenEmpty | Default value to show when field value is empty. |
|---|
| Output type | output-type | INLINE or BLOCK. Renders macro output inline or as a block (div). |
|---|
|
confiform-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:
[template.YOUR_TEMPLATE_NAME]
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
| Event | event | - onCreated - when a new record is created
- onModified - when a record is modified
- onDeleted - when a record is deleted
|
|---|
| Action to be performed | action | |
|---|
| Conditionally fire the IFTTT action | condition | A parameter in which to set the condition for activating the IFTTT action. If this parameter is left empty, the IFTTT action is always executed when the event occurs. Conditions use the same syntax as in filters, and the scope is the current ConfiForms entry. |
|---|
| Result name | resultName | You can define your own "name" for IFTTT result, then can be refernced in next IFTTTs as ${iftttResult_YOURNAME}, where YOURNAME is the name you gave to the IFTTT result |
|---|
|
confiform-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. | Flatten multi-value fields before merging and aggregation | flattenEntries | When checked, datasets will be flattened to represent each multivalue field selection as a separate and unique data row. |
|---|
| Filter | filter | Select records based on this configuration; see detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Ordering/Sorting | sort | Rules for ordering or sorting entries in the dataset; see detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| Distinct filter | distinct | Apply distinct filter to return only unique records. Field names as comma separated list to be used as a key for applying distinct filter. |
|---|
| Limit a number of records returned (a number) | limit | You can set the limit to the number of records returned. No limit when is blank The same thing could be done using the filter and adding LIMIT n to the end of the filter |
|---|
| Instant search | enableSearch | Adds a search input field above the table to enable quick search and filtering of stored data. |
|---|
| Enable export | export | This parameter provides a way to download returned data in CSV, XML and JSON formats. Admin users can always export ConfiForms data with the administrative interface. For non-admin users, the form's owner should enable support for data export via 'Allow data export' in the ConfiForms form macro. |
|---|
| Comma separated list of fields to export | exportFields | Comma separated list of fields to export. You can put rich properties. When left empty the default list fields list is taken. |
|---|
| Pagination | pager | A parameter to enable displaying records in sets (for example, in groups of 1, 25, 50, 100, or 200 per page); if not configured then all stored records are shown. |
|---|
| CSS styles | css | This parameter provides a way to apply CSS styles (for example: color:red; border:1px) to the field. Styles will be applied on stored values on output. |
|---|
| Striped table rendering | withHighlighting | This parameter enables highlighting every second row in a table. |
|---|
| Dynamic data sources | sources | Specify a pattern (search criteria) which be used as a search parameter to look for pages with ConfiForms Forms to connect as datasources for this TableView You can see how many pages are matched in the preview mode. This will help you to understand and tune your query |
|---|
| Form name | formName | Form name to include when dynamic sources are given as a pattern, to reduce the discovery scope to certain forms (by name). |
|---|
| Filter to apply on entries dataset (for dynamically discovered sources) | dynfilter |
|
|---|
| Ordering/Sorting rules to apply on entries dataset (for dynamically discovered sources) | dynsort | You can user SQL-like syntax: fieldname1 ASC, fieldname2 DESC, etc. |
|---|
| Limit a number of records returned (a number) (for dynamically discovered sources) | dynlimit | Limit a number of records returned (a number) (for dynamically discovered sources) |
|---|
| Rendering mode | renderMode | Since version 1.19.1 we support rendering of table view merger results in 2 modes: as table (similar to TableView) and as card (similar to CardView) |
|---|
| Enable support for a filter | enableFilterSupport | Adds a "DIV" element around the rendered table, so the ConfiForms Filter macro will be able to find it on the page (In some cases you need a pure table to be rendered, as when used inside the chart macro, therefore this setting is set to false by default). |
|---|
| Show number of records in the footer | showRecordsCount | Shows number of records in the footer. |
|---|
| Label to use for showing number of records | showRecordsCountLabel | Text for label for showing number of records in the footer. |
|---|
| Filter ID | filterId | Do not use spaces or umlauts. Mapping between ConfiForms Filter macro and this view, to ensure the correct view is filtered 'Filter ID' parameter must be identical. |
|---|
For examples, see the documentation in Merge and aggregation for ConfiForms and for advanced techniques, see Advanced aggregations in TableView Merger. |
|---|
|
confiform-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. | Field name | actionFieldName | Name of the field you want to track for changes (leave blank when you configure validation rules, as these rules are applied on form submit). Parameter supports regular expressions to affect multiple fields with the same rule. Can be given as comma separated list of fields. |
|---|
| Condition | condition | This parameter defines the condition to be met in order for the action to be executed; it uses the same syntax as in filters; and the scope is the current entry/record. |
|---|
| Execute only on user action | onUserActionOnly | When checked, the rule will be executed ONLY on user's action (action is NOT executed when form is loaded), and this expects 'Field name' parameter to be specified. |
|---|
| Action | action | Action to perform
| Availability | Action type |
|
|---|
| Apply CSS on a field | Applies CSS styles on a given field, based on the condition set | | Apply Filter on a field | You can apply specific filters on "select"-type fields. This is especially powerful, when your fields are backed by smart fields, web-service or database fields. Your filter is applied ON THE DATASET this field relies on. Which means, the filter is applied on the source dataset Few examples: | | Apply Filter based on matching criteria | Please see the following tutorial for details Using filter based on criteria rule | | Hide field | Conditionally hides the field and the "wrapping" container (if given) | | Hide container | Allows you to hide by CSS selector | | Lookup and set DB value | Helps you to have a lookup against the query you create from your database | | Lookup and set WS value | Allows you to make a request to a webservice and set the received values back to the form's fields | | Lookup and set JIRA issue data | Allows you to request issue details from your Jira (by issue key) and set the received values back to the | | Lookup and set Insight object data | Same as with Jira issue data, but allows you to query Insight data storage | | Lookup and set value | This rule allows you to lookup the data from another ConfiForms form and set received data back to the form's fields | | Run custom JavaScript | ConfiForms can execute a custom JavaScript function via ConfiForms Field Definition Rules, and your function can expect the following variables to be present - formName - is the "form" with HTML field elements. This allows you to access fields very easily via AJS.$(formName).find('#i_FIELD_NAME')
- formId - is the "div" element in HTML holding the whole form and fields. This allows you to access fields very easily via AJS.$('#' + formId).find('#i_FIELD_NAME')
which means your function can have a signature like:
function myfunction(formName, formId) {
}
See demo: Using ConfiForms Field Definition rules with JavaScript action to get and set field values Since version 2.21.5 ConfiForms offers some helper functions to use
| Available since version | Function | Description | Demo |
|---|
| function cfAddFieldRequired(formId, fieldName) | Adds required field mark / asterisk. This does not make the field required - you need to have an additional validation in place to validate the field's value |
| | function cfRemoveFieldRequired(formId, fieldName) | Removes required field mark / asterisk from a field. Important to know that if the field is set as required in ConfiForms Field Definition then it still remains as required and users must provide a value before they can submit the form. This function only changes the visual appearance of a field label |
| | function cfAddTabStop(formId, fieldName) | Adds "tab stop", meaning that the field will be excluded from form's set of fields when moving around using the "tab" key |
| | function cfRemoveTabStop(formId, fieldName) | Removes the "tab stop" marker from a field |
| | function cfSetValue(formId, fieldName, fieldValue, isAdvanced = false) | Set's value on a field. Set "isAdvanced = true" if you want to set the value on "advanced" fields (such as dropdown fields with lookup, etc) |
| | function cfSetValueWithEventPropagation(formId, fieldName, fieldValue, eventType, isAdvanced = false) | Same as "cfSetValue" function but triggers an eventType event eventType can be of the following type: This depends on the field you want to trigger this for. Text fields expect 'input', dropdowns and other choice based fields - "change"; Jira, user and page lookup fields expect a "blur" |
| | function cfResetValue(formId, fieldName, isAdvanced = false) | Resets value on a field (sets it to empty state). |
| | function cfSetValueByIndex(formId, fieldName, index, isAdvanced = false) | Selects value by index in a dropdown (simple or advanced) field. Options start with 0 index (so, the first option will be with index = 0) |
| | function cfToggleReadOnly(formId, fieldName, isReadOnly, isAdvanced = false) | Toggles readonly attribute (either adds it or removes it, depending on a isReadOnly parameter value) |
| | function cfToggleDisabled(formId, fieldName, isDisabled, isAdvanced = false) | Toggles disabled attribute (either adds it or removes it, depending on a isDisabled parameter value) |
| | function cfTriggerEvent(formId, fieldName, eventName) | eventName can be of the following type: |
| | function cfGetValue(formId, fieldName) | Retrieves value from a form's field |
| | function cfGetValueBySelector(formId, fieldSelector) | Retrieves value from a form by CSS selector |
|
More on JavaScript functions | | Set expression | Same as set value, but you can set expression (Supported math operators, formulas and functions), which will be calculated for you Useful to wrap expressions in () to help ConfiForms with parsing | | Set field readonly | Sets field as readonly, setting reverse condition will do the opposite. Please note that you will need 2 rules to set/unset the readonly status - you cannot have one (as with hide/show, for example) Please also note that not all the fields can be set as readonly - dropdowns are ALREADY readonly, and setting the as readonly makes no sense and no impact. Also, not all the fields are supported (work in progress). | | | Rule to help you to changes form's title | | Set field label | Sets label text for the field | | Set value | Set's value to the fields. Please be aware, that internal value for the field is expected. See ConfiForms Field Types Set the value on dropdown choice change | | Set value if empty | Same as above, but has additional check applied to ensure the value is set ONLY when the field has not value set | | | Changes label on submit form button | | Show field | Conditionally shows the field and the "wrapping" container (if given) | | Show container | The opposite what "Hide container" does, and allows you to show elements matching the CSS selector you put | | Reset value | Resets the field value | | | Useful action type to check if the record matching configured condition / filter exists in the other form | | Validate uniqueness | On form submit, the action checks if the record is unique within a dataset. Uniqueness criteria is calculated based on the fields given | | Validate on delete | This action is executed on "record delete", and could prevent the record being deleted based on the condition you set | | Validation rule | Validates record(conditionally) | | Validation rule (dataset) | Validates current record against the rows in the dataset, For example, when you want to ensure the max number of records stored in the dataset | |
|---|
| With reverse rule | withReverseRule | Will create an automatic reverse rule to be applied on the field (works with show/hide fields action) |
|---|
|
confiform-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. | Field value or expression to match | condition | This parameter accepts values or expressions, similar to filters (see the detailed documentation on filters: ConfiForms Filters). The scope for filtering is the whole dataset and depends on the container macro in which this macro is used as the dataset is passed from the container macro. |
|---|
| Field name | fieldName | The name of the field to which the CSS styling rule(s) should be applied; if left empty, the style is applied to the row. |
|---|
| Conditional CSS | css | This parameter accepts valid CSS styles, separated by semicolon (for example: color:red;border:1px). Styles will be applied to a field (if given) or on a row when used within a table (a CSS container div is used when in ConfiForms ListView) if the 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. | Field name | fieldName | Name of the field defined on the form. Leave empty if you want to use just a static caption. See parameter below |
|---|
| Use the layout from ''ConfiForms Registration Control'' | regControlLayout | Will try to find the layout from a "main" ConfiForms Registration Control and use that for showing the form ("ConfiForms Registration Control" should be placed inside the ConfiForms Form macro body to be found) |
|---|
| Caption/label to use | buttonLabel | Static label to use for viewer field |
|---|
| Render as | type | The control can be rendered as: |
|---|
| View mode | mode | How the controls in the dialog should look like |
|---|
| Visibility | restrictions | This parameter accepts a comma-separated list of groups and users to which this field will be visible. Leave this parameter blank if there are no restrictions. |
|---|
| Hide control when stored data matches this criteria | hideIfMatches | Current ConfiForms entry stored by the form referenced will be concealed when the items in this parameter are matched in the entry. The control itself will be hidden when the condition/filter given is met, and this parameter uses the same syntax as in filters . |
|---|
| CSS styles | css | This parameter provides a way to apply CSS styles (for example: color:red; border:1px) to the field. Styles will be applied on stored values on output. |
|---|
| Form height | formHeight | Form height (in pixels, number only). Leave blank if you are fine to have an automatic form's height calculation. Only works for non-inline edit mode. |
|---|
| Form width | formWidth | Form width (in pixels, number only). Leave blank if you are fine to have an automatic form's width calculation. Only works for non-inline edit mode. |
|---|
|
confiform-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) | Type | type | Evaluation method to use:
|
|---|
| Condition | condition | Condition, to match. The expression can be either a valid ConfiForms filter or a valid Velocity IF statement (you do not have to write the IF, but only the condition, which will be wrapped into IF statement for you) |
|---|
| Reverse | reverse | Reverse the condition |
|---|
| Output type | output-type | INLINE or BLOCK. Renders macro output inline or as a block (div). |
|---|
Use macro body to put the content you want to show/hide depending on the specified condition |
confiform-entry-filter | The macro helps you to create dynamic filters for your ConfiForms views. | ConfiForms Form name | formName | The name of the ConfiForm to which this registration control should be linked. This parameter is required when the macro is used by itself (not inside the ConfiForms Form macro). The name parameter can be skipped when the macro is configured inside the ConfiForms Form macro, and if not defined, the form name is automatically assigned. |
|---|
| Location page name | pageTitle | The name of the page on which the form is defined if not the current one; leave this blank if the form is defined on the same page. |
|---|
| Label for filter button | filterButtonLabel | Caption to use for filter button |
|---|
| Include form / filter reset button | includeResetButton | Include or not the button which will help users to reset selected filters with one click |
|---|
| Label for reset form button | resetButtonLabel | Caption for reset filter form selections button |
|---|
| Reset the filtered view on filter reset | resetButtonAction | When set, ConfiForms will reset the connected view automatically on filter reset. |
|---|
| Key-value request parameters | presetValues | This parameter provides a way to preset values for certain fields in the form. These are listed as key-value pairs, separated by & (as request parameters) where the ''key'' is a ConfiForms Field name and the ''value'' is the data to be preset for the field. You can also pre-set some values from a context: - [now] - to set current date/time on the date/time field
- [user.name] - current logged-in username (if anonymous access then "Anonymous" will be set)
- [user.fullName] - current logged-in user's full name (if anonymous access then "Anonymous" will be set)
- [user.email] - current logged-in user's email (if anonymous access then "" will be set as email)
use it like key=value, for example mydt=[now] And also reference to "this" when page/user fields used |
|---|
| Use filter for | filterFor | You can use this filter with - table (TableView)
- card (CardView)
- list (ListView)
- calendar (CalendarVew)
- plain (PlainView)
- clean (CleanView)
View macro must be configured to use the same form as a datasource as this filter macro |
|---|
| Set 'Filter ID' of the view you want to connect this filter to | filterId | Do not use spaces or umlauts. Usually you don't need to have this mapping, unless you have a multiple filters defined on your page which are filtering the same form's datasets. ID should match with the ID you specify for your view. |
|---|
| Additional filter to apply | filterCondition | when set, this "condition" will be always added with "AND" operator to the user picked/constructed filter |
|---|
| Hide free text search option in filter's default view | hideFreeTextSearchOnDefault | Hides free text search option in filter's default view (when macro body is empty and default layout is used). |
|---|
| Field names to include in free text search | columnsToUseInFreeSearch | All fields will be used when left blank. A comma separated list of field names is expected to limit the free text search to include only particular fields. |
|---|
| Use wildcards in free text filtering | useWildcards | Uses wildcards in free text filtering. By default filtering is done by exact value match. |
|---|
| Show only relevant choices in dropdown filter fields | showOnlyRelevantChoices | Dropdown fields choices will be reduced to only available items. |
|---|
| Support multiple choices in dropdown fields | multipleChoices | Supports multiple choices in dropdown fields. |
|---|
| Render Date and Datetime fields as data ranges in filter | renderAsDateRange | Renders Date and Datetime fields as data ranges in filter. |
|---|
| Auto-filter mode | autoFilter | Views are filtered automatically on change. |
|---|
| CSS styles | css | CSS rules to be applied to the Submit button when the form is displayed as a pop-up dialog (when the form is embedded in the page, this button is not shown). |
|---|
| Visible only to groups/users | restrictions | This parameter accepts a comma-separated list of groups and users to which this field will be visible. Leave this parameter blank if there are no restrictions. |
|---|
| Hide control when stored data matches this criteria | hideIfMatches | ALL ConfiForms entries stored by the form referenced will be concealed when the items in this parameter are matched in the entry. The control itself will be hidden when the condition/filter given is met, and this parameter uses the same syntax as in filters . |
|---|
| Execute custom JavaScript function after the filter form is loaded | afterLoadInit | Put the name of the function you want to execute. You can have 'formId' as parameter in this function to receive form element id. Confluence administrators could disable scripts execution in ConfiForms app settings. |
|---|
| Execute custom JavaScript function after the filter is applied | afterFilterApplied | Put the name of the function you want to execute. Confluence administrators could disable scripts execution in ConfiForms app settings. |
|---|
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 |
ConfiForms LiveView macro confiforms-live-view | See documentation and examples on the following page - Using ConfiForms LiveView macro |