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 for the 'Save' button in the registration dialog. |
|---|
| Enable full audit | 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. |
|---|
| 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 submission | 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 submission' parameter is set and the user has submitted the form, this text will be displayed. |
|---|
| Track maximum capacity | 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 has been reached, this text will be displayed. |
|---|
| Allow data export | export | Use this parameter to enable data export for non-admin users. The "Enable export" parameter on the TableView macro must also be set. |
|---|
| Enable ''Print'' button | printEnabled | This parameter will enable a print button on the form. |
|---|
| Display 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. When checked |
|---|
| 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) |
|---|
|
confiform-field-definition | The macro to use inside the ConfiForms Form macro to define the form's fields, their types, and behavior. | 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: | 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. | | Autopage | 4.3+ | This field type records the source page where the record was submitted. | | Captcha | 5.1+ | Captcha field to prevent and fight "spam" and auto-submits | | 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. | | 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) | | 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 | | DB 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 | | DB Dropdown (advanced) | 5.1+ | Same as advanced dropdown but backed by database rows | | DB 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 | | DB 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 | | DB 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 | | DB Smart Classifier | 5.1+ | Same as Smart classifier but backed up by YOUR database (available since version 1.24) | | 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 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 | | 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 | | Enroll button | 5.0+ | This field type enables one-click record storage. | | File | 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 | | 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 Label | 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+ | This field type offers a convenient way to store links to other resources and display them as links. | | 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. | | Multiselect | 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 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.
| | 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 Multiselect Smart Radio buttons Smart Checkbox | 4.3+
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'). | | 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 | moved |
| | 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 | 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 | | WYSIWYG | 5.0+ (on 4.3 this controls is shown as textarea) | This field type providea 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 aomma-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 displayd 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 behavior 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. |
|---|
| Submission 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 |
|---|
| Post save message | registrationMessage | The text to be displayed after a record been created. |
|---|
| 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]. |
|---|
| 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 . |
|---|
|
confiform-entry-edit | This macro defines the behavior 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. |
|---|
| 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. |
|---|
| Displays controls in compact mode | compactMode | Displays controls in compact mode as a dropdown menu |
|---|
| Display Copy button | showCopy | Shows "Copy" button, enables easy copying of records / duplication. Disabled by default. |
|---|
| Hide edit button | hideEdit | When enabled, the "Edit" botton 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 Registration Control macro layout (this macro MUST be inside the ConfiForms Form macro body in order fo rthis macro to find it and pick this 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. |
|---|
| 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 edit operation completes |
|---|
| 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 . |
|---|
|
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. |
|---|
| Filter | filter | The filter to be applied to the stored dataset; see detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| 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 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 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. |
|---|
| 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. |
|---|
| Scrollable tables | wrapped | This parameter provides scroll bars for larger tables by applying CSS style rules. |
|---|
| 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. |
|---|
|
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. |
|---|
| 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. |
|---|
| 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 |
|---|
| 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. |
|---|
|
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. |
|---|
| 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. |
|---|
|
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. |
|---|
| 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 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 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. |
|---|
| 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. |
|---|
| Scrollable tables | wrapped | This parameter provides scroll bars for larger tables by applying CSS style rules. |
|---|
| 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:' |
|---|
|
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 |
|---|
| 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. |
|---|
| Ordering/Sorting rules | sort | See detailed documentation at Sorting in ConfiForms and/or in the tutorials. |
|---|
| 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 |
|---|
| 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 |
|---|
| 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:' |
|---|
|
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 |
|---|
| Filters | filter | See detailed documentation at ConfiForms Filters and/or in the tutorials. |
|---|
| Field name | fieldName | Name of the field you want to show value for |
|---|
| Field label | withLabel | The label from the ConfiForms field definition will be added as a prefix 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 |
|---|
| 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 |
|---|
|
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) |
|---|
| 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. |
|---|
| 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. |
|---|
| Message to show when a field value is empty | messageToShowWhenEmpty | Default value to show when field value is empty |
|---|
|
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 | - Send Email - Send email to the list of participants, defined below
- Create Page - Create a page based on a given template (including setting the labels)
- Create Blogpost - Create a blogpost out of a template (or your own inline layout) using ConfiForms
- Add Page label - Add label(s) to existing Confluence page
- Make HTTP request - Performs an HTTP request (GET or POST, depending on the macro body).
- Send Notification - Send a Confluence notification
- Create/Update ConfiForms Entry - create (or update) a ConfiForms entry in another form (macro body is ignored). If id:[entry.id] is given then an UPDATE is fired
- Copy ConfiForms Data - copies data from another form into the form specified. Can copy filtered subsets of data and also filters can be constructed dynamically
- Copy ConfiForms Data to DB - copies (updates) data from a form into the database table specified. Can copy filtered subsets of data and also filters can be constructed dynamically. Expects a proper SQL INSERT or UPDATE statement
- Create Task - Creates task in Confluence for user (NB! Personal tasks were deprecated by Atlassian's since Confluence 5.6)
- Delete ConfiForms Entry - delete the entry, in this or another form (by ID or by given filter). See ConfiForms Filters
- Run JavaScript - runs given Javascript snippet on ConfiForms event (Use this macro body to write your Javascript)
- Create JIRA Issue (macro body should be used as a JSON mapping between ConfiForms and JIRA fields, See Creating JIRA issue with ConfiForms)
- Update JIRA issue (same as "Create JIRA issue", but update API is called, See https://developer.atlassian.com/jiradev/jira-apis/jira-rest-apis/jira-rest-api-tutorials/updating-an-issue-via-the-jira-rest-apis)
- Create Attachment based on the template given and upload it to ConfiForms record automatically
- Application service - calling a service registered through Confluence Application links (you will need to specify it's relevant URL, HTTP method used and parameters). In case of "POST" method used the body of the macro will be used as a body of the request and passed to service
- Move Attachment - moves attachments to a desired page
- Move Page - moves page to a desired place
- Remove Page Label
- Remove Page Watcher
- Rename Page
|
|---|
| Subject for email / title for page / url for request | title | This setting defines the subject to be used on emails, the title for the page created, or the URL for an HTTP request. It
allows parameters and substitutions which can be constructed dynamically, including references to the record owner as [owner], the record modifier as [modifier], and any record field as [entry.FIELD_NAME].
Complex fields (such as of type page/blogpost or user) are also supported. | ConfiForms entry | This is used when referencing a smart classifier field, and it can access all the standard fields, plus additional fields defined in the ConfiForms entry: id - the record id, unique for every saved record: [entry.FIELD_NAME.id] ownedBy - the username of the user who owns the record (and can fully control it): [entry.FIELD_NAME.ownedBy] ownedByName - the full name of the user who owns the record: [entry.FIELD_NAME.ownedByName] createdBy - the username of the user who has created the record (admin users can create records for other users): [entry.FIELD_NAME.createdBy] createdByName - the full name of the user who has created the record: [entry.FIELD_NAME.createdByName] created - the timestamp when the record was created: [entry.FIELD_NAME.created] dateCreatedFormatted - a formatted way to see the timestamp for a created record: [entry.FIELD_NAME.dateCreatedFormatted] As well as other, non-standard fields defined in the ConfiForms entry: [entry.FIELD_NAME.FIELD_NAME] |
|---|
| User | fullName: [entry.FIELD_NAME.fullName]
username: [entry.FIELD_NAME.username]
email: [entry.FIELD_NAME.email] |
|---|
| Page/BlogPost | title: [entry.FIELD_NAME.title]
spaceKey: [entry.FIELD_NAME.spaceKey]
id: [entry.FIELD_NAME.id]
version: [entry.FIELD_NAME.version]
as well as other simple Page properties. |
|---|
DateTimeInterval
| Start date (formatted): [entry.FIELD_NAME.startDateFormatted] End date (formatted): [entry.FIELD_NAME.endDateFormatted] Start date (long / unix time, useful with formulas Supported math operators, formulas and functions): [entry.FIELD_NAME.startDate] End date (long / unit time, useful with formulas Supported math operators, formulas and functions): [entry.FIELD_NAME.endDate] Start and end date as interval together: [entry.FIELD_NAME.asPeriodFormatted] |
|---|
In order to reference fields to create the email body, a page template, and the data to send to another service, use either the ${} notation or the notation above, using [entry.FIELD_NAME]. Both methods are supported. See detailed example at Using IFTTT macro for integrations. See also Virtual functions and Accessing field values and properties |
|---|
| Participants | who | A list of users who will receive a notification / receive task; a list of users involved. |
|---|
| 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. |
|---|
| Sender (or Parent page) | extras | Use this to specify the sender when configuring a "Send Email" action, or to specify the page to be used as a parent page for a "Create Page" action. For Page "Parent page" you can set it dynamically using the same method as described in "Subject for email / title for page / url for request" construction, using [entry.FIELD_NAME] notation |
|---|
| 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. |
|---|
| 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 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. |
|---|
| 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. |
|---|
| Striped table rendering | withHighlighting | This parameter enables highlighting alternate rows 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 |
|---|
| 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) |
|---|
| 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 | The name of the field to be tracked / validated. |
|---|
| Action | action | Action to perform - Show field
- Hide field
- Set value
- Set value if empty
- Set expression
- Validation rule
- Validation rule (dataset) - the whole dataset could participate in the validation, like for example when you want to verify the uniqueness of the field value
- Run custom JavaScript
- Apply CSS on a field
- Lookup and set value (from another ConfiForms Form)
- Lookup and set DB value (from the database table / record / field)
- Lookup and set the values from JIRA issue to ConfiForms 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. |
|---|
| Actionable field name | fieldName | When the 'Show/Hide field' action is used, this parameter specifies which fields are affected (can specify a list of comma-separated field names to affect many fields at once). |
|---|
| Values to be set | values | When the 'Set value' (or 'Set value if empty') action is configured, this parameter specifies which fields and values are to be set. Values are set as key-value pairs, separated by & (as request parameters), where the ''key'' is the field name, and the ''value'' is the entry to be set. |
|---|
| 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 Entry Viewerconfiform-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. |
|---|
|
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 |
|---|
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 |
|---|
| 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 |
|---|
| Additional filter to apply | filterCondition | when set, this "condition" will be always added with "AND" operator to the user picked/constructed filter |
|---|
| Show only relevan choices for ysed dropdowns | showOnlyRelevantChoices | Dropdown fields choices will be reduced to only available items |
|---|
| 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 . |
|---|
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 |