Page tree
Skip to end of metadata
Go to start of metadata

This is the documentation for ConfiForms Server/Data Center app


Below, please find the list of field types available in ConfiForms.

Important page to help you with accessing and transforming values can be found here: Accessing field values and properties


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

TypeCompatibilityDescription
Text 4.3+A simple text input field.
Action Button4.3+Action button to update the entry when in "view mode". Easy to implement quick notifications when used together with IFTTT module
Attachments Picker5.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...)


On highly concurrent systems you might see duplicate values for the autonumber (Duplicate values for internal recordId field,  in fact) 


ConfiForms does not guarantee uniqueness. 


To fix the issue please use the following service method on your form to remove duplicates (duplicates will get new IDs)

[YOUR_CONFLUENCE_SERVER_URL]/ajax/confiforms/rest/fix-storage.action?formName=<FORM_NAME>&pageId=<PAGE_ID>

See more on Release Notes#Version2.0.15

Autopage

(tracking record soource)

4.3+This field type records the source page where the record was submitted.
Calculated4.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.
Captcha5.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.
Comment5.1+

A field to hold multiple comments (can be also enabled with anonymous user commenting on your record)

Comments are READONLY. You or your users, can only append new comments to the record.

Editing the ConfiForms record with a comment field and saving it will APPEND the comment typed to the list of existing comments for this record

Update: Since Release Notes#Version2.16.9 there is a way to delete comments (by comment writer or by form's administrator)

Confluence Multi-label5.1+Provides a list of Confluence labels to pick from
Currency5.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 interval5.0+Datepicker which enables you to select 2 dates, start and end, could be used on CalendarView to show time periods / events
Database Dropdown5.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-select5.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 Checkbox5.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 group5.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 Classifier5.1+Same as Smart classifier but backed up by YOUR database (available since version 1.24)
Database Row Referencing Field5.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-label5.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) - Database5.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) - Webservice5.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-label5.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/Attachment4.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.
Formula4.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.
Link4.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)
Html4.3+raw HTML content
Hidden 4.3+This type provides for a concealed constant value to be stored with the record.
Hidden Html4.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 tracking5.1+Hidden field to track user's IP address and save it together with form entry data
Iranian Calendar5.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+This field type offers a convenient way to store links to other resources and display them as links.
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 Text4.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.
Numeric4.3+Same as text field but is converted to number when used in sorting/ordering
Numeric hidden4.3+Same as numeric but hidden (useful when calculations and later filtering should be applied over the datasets)
Jira issue4.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

From ConfiForms version 1.30 - you can access ANY property of the JSON returned by JIRA

The syntax is as described in detail here: Using Field Definition Rule to request data from JIRA and set it to ConfiForms fields

The tutorial is for Field rules, but the idea and the concept on how to access the data returned by JIRA is the same



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:

asJIRAIssue.title

Will print a title for each JIRA issue referenced with this field

JIRA JQL5.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.

Readonly4.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').
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:

ColorConstant
DEFAULT
default
ERROR
error
CURRENT
current
SUCCESS
success
COMPLETE
complete
MOVED

Please be ware that the coloring scheme may be different in your Confluence installation. See https://aui.atlassian.com/aui/8.5/docs/lozenges.html to match the color of the "status" field with the constant it is represented by


Current colouring scheme in our Confluence as of now (live example)

status

constant

black default
green success
red error
blue current
purple complete
orange moved


moved

However, as the status field is actually a dropdown with values, the texts you specify for dropddown choices is accessible thought the "label" property.

mystatusfield.label:My Text for label


See Accessing field values and properties

Storage format5.1+The field can hold and render the storage format (other macros)
Time5.1+Field to store time
Timestamp5.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 control5.0+Enables quick voting control (renders as a button in "view mode" and rendered as "user picker" in "edit mode")
Version5.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.


Please be aware that since 2.4, ConfiForms is compatible with Confluence versions 6.0+

Compatibility shown here for the field types is for historical reasons only.

Check out the Accessing field values and properties document which explains how to use each field type in "views", to show the data