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

This is the documentation for ConfiForms Server/Data Center app


ConfiForms has a lot of various field types to help you with building your data forms. And it has very sophisticated system to retrieve the values stored, including accessing rich objects such as Page, User and other referenced Records when used together with "smart fields"

Accessing values using Velocity syntax is deprecated since ConfiForms 1.16 and not supported in 100% of cases. Please try to accomplish what you have to do using [entry.] notation

If you are upgrading from 1.30 and you have configurations using "virtual functions" which collect the data from multi-select fields then please be aware, that the standard behaviour has chnaged to return ID's, and NOT labels of the fields

If you need to have labels then a transform operation is needed. See "transform" function in Virtual functions for details

But, basically, you will need to call on your multiselect field something like this (for example, and assuming your multiselect field is called "mymultiselectfield"):

mymultiselectfield.transform(label).asArrayMultiSelect

Before 1.30

mymultiselectfield.asArrayMultiSelect

was returning field labels, now (without a transformation) it returns ID's

Accessing rich properties is also supported in ConfiForms Field macros. Giving myfield.subproperty as a field name is totally valid and supported. For smart fields this can be of any level deep, but please keep in mind the performance issues this might cause (as values are lazy loaded for each sub-field for "smart" fields).

Make sure the [entry.myfield] is actually stored the way you see it, as sometimes Confluence editor injects some "invisible to user" blocks of HTML, such as spans... and the text becomes actually something like [entry.<span>myfield</span>] which makes it not to work correctly with ConfiForms parser.

The easiest way to see that text is clean is by looking at storage format of the page (using Tools menu and then clicking on "View Storage format" or by installing a free add-on from Atlassian which enables you to see raw storage format directly in the Confluence editor - https://marketplace.atlassian.com/plugins/com.atlassian.confluence.plugins.editor.confluence-source-editor/server/overview)


Please also see this: https://wiki.vertuna.com/display/CONFIFORMS/ConfiForms+FAQ#ConfiFormsFAQ-WhyintheeditorIgetautolinksinsteadof[entry.field_name]notations


Accessing ConfiForms fields

Here is the table showing you how to reference field values for different field types. Our field name is: "myfield"

Field typeAccessing in ConfiForms Field macroAccessing though [entry.] notationUsing in filtersSortingRemarks
Textmyfield[entry.myfield]

myfield:*test

myfield:test*

myfield:*test*

myfield:*

as text
Action ButtonmyfieldN/AN/AN/AN/A
Autolinkmyfield[entry.myfield]same as text fieldas textonly dynamic part is taken when shown as [entry.] notation
Autonumbermyfield[entry.myfield]same as text fieldas textautonumber with previx
AutopagemyfieldSee page typeSee page typeSee page typeSee page type
Calculatedmyfield[entry.myfield]Same as numeric fieldas numbernon-numeric values are set as 0 in sorting
CaptchamyfieldN/AN/AN/AN/A
Checkbox

myfield

myfield.label

[entry.myfield]

[entry.myfield.label]

myfield:true

Returns true or false

By using .label you can access checkbox field label you set

Checkbox groupmyfield[entry.myfield]myfield:*fieldvalue* to ensure it is matchedas text
Currencymyfield[entry.myfield]Same as numeric fieldas number
Date

myfield

myfield.timestamp

[entry.myfield] 

[entry.myfield.timestamp] 

Same as numeric fieldas number

timestamp value

Date and Datetime field types allow the following metaparams to be given as input

[now], [tomorrow], [yesterday], [today], [today]-days(n), [datetimeyyyyMMdd HH:mm], [dateyyyyMMdd]

Basically, same as in ConfiForms Filters

Datetime

myfield

myfield.timestamp

[entry.myfield] 

[entry.myfield.timestamp] 

Same as numeric fieldas number

timestamp value

See above

Datetime interval

myfield

myfield.startDateFormatted

myfield.endDateFormatted

myfield.startDate

myfield.endDate

myfield.asPeriodFormatted

[entry.myfield]

[entry.myfield.startDateFormatted]

[entry.myfield.endDateFormatted]

[entry.myfield.startDate]

[entry.myfield.endDate]

[entry.myfield.asPeriodFormatted]

myfield.startDate:

myfield.endDate:

conditions as in numeric field

as number by start datetimestamp value
DB dropdown

myfield

myfield.id

myfield.label

see remarks ->

Same as normal dropdown
DB multi-selectmyfieldsee remarks ->

Same as normal multi-select
DB radio groupmyfieldsee remarks ->

Same as normal radio group
DB checkboxmyfieldsee remarks ->

Same as normal checkbox
Drawing canvasmyfieldN/AN/AN/Ainternal format is returned
Dropdown

myfield

myfield.id

myfield.label

[entry.myfield]

[entry.myfield.id]

[entry.myfield.label]

myfield:ID

myfield.label:LABEL

as text

Each dropdown choice has ID and LABEL

[entry.myfield] returns ID

Dynamic Dropdown

myfield

myfield.id

myfield.label


[entry.myfield]

[entry.myfield.id]

[entry.myfield.label]


myfield:*fieldvalue* to ensure it is matchedas text

Each dropdown choice has ID and LABEL

[entry.myfield] returns ID

Dynamic Multilabel

myfield

myfield.id

myfield.label


[entry.myfield]

[entry.myfield.id]

[entry.myfield.label]


myfield:*fieldvalue* to ensure it is matchedas text

Each choice has ID and LABEL

[entry.myfield] returns ID

Enroll buttonmyfieldN/AN/AN/A
Filemyfield[entry.myfield] - will show as linksame as text, see remarksas textonly attachment/file name is in search
Formulamyfield[entry.myfield]same as numeric fieldas numbernon-numeric values are set as 0 in sorting
Htmlmyfield[entry.myfield]same as text typeas text
Insight

myfield

myfield.attributes.objectTypeAttribute(objectTypeAttributeId=46).objectAttributeValues.value

[entry.myfield]

[entry.myfield.attributes.objectTypeAttribute(objectTypeAttributeId=46).objectAttributeValues.value]


See more details here: Accessing JSON structures. The tutorial is for ConfiDoc plugin but is perfectly validfor ConfiForms (easpecially from teh perspective of accessing the Insight object attributes)




Linkmyfield[entry.myfield]same as text typeas text
Hiddenmyfield[entry.myfield]same as text typeas text
Masked Textmyfield[entry.myfield]same as text typeas text
Multi Selectmyfield[entry.myfield]same as dropdown (ID and LABEL properties)as text
Numeric fieldmyfield[entry.myfield]

myfield:>=

myfield:>

myfield:<=

myfield:<

myfield:

as number
JIRA issue

myfield

myfield.key

myfield.title

myfield.summary (same as title)

myfield.description

myfield.link

myfield.status


V 1.35.5

Any JIRA field which is provided via JIRA REST API

For example:

myfield.fields.assignee.emailAddress

myfield.fields.reporter.displayName

See also: Using Field Definition Rule to request data from JIRA and set it to ConfiForms fields


[entry.myfield]

[entry.myfield.key]

[entry.myfield.title]

 

[entry.myfield.summary] (same as title)

[entry.myfield.description]

[entry.myfield.link]

[entry.myfield.status]

same as text type and only by keyas text
JQL

myfeld

myfeld.jql

myfeld.count

[entry.myfield]

[entry.myfield.jql]

[entry.myfield.count]

Renders as link to JIRA with number of matching issues

2 additional properties available: jql and count



Page/Blog post

myfield

myfield.* - see remarks

[entry.myfield]

[entry.myfield.*] - see remarks

same as text, for properties list see remarksas text, by default pageIdall properties of

AbstractPage class (see Confluence API docs)

Examples:

method in classHow to access
getSpaceKey()myfield.spaceKey
getCreatorName()myfield.creatorName
getVersion()myfield.version
getCreationDate()myfield.creationDate
... any other get method from Page class
Passwordmyfield[entry.myfield]same as text typeas text
Radio group

myfield

myfield.id

myfield.label


[entry.myfield]

[entry.myfield.id]

[entry.myfield.label]

myfield:ID

myfield.label:LABEL

as text

Each choice has ID and LABEL

[entry.myfield] returns ID

Readonlymyfield[entry.myfield]same as text typeas text
SectionmyfieldN/AN/AN/A
Simple Datemyfield[entry.myfield]Same as numeric fieldas numbertimestamp value
Smart Classifier

myfield

myfield.* - see remarks

[entry.myfield]

[entry.myfield.*] - see remarks

Depends on a field referenced. If [entry.myfield] or just "myfield" is referenced then in most cases it acts as text.

But with "smart fields" you reference a record in another form and that means through this reference you can get ANY field of that record, including other smart fields. That said, you can build quite a property graph to get any value, which is lazy loaded for you

depends on a field referenced

Properties you can access totally depend on a structure of the record in the form you reference. You can access ANY field value through this notation, including other smart fields which will be lazy loaded for you.

Example:

[entry.myfield.field_in_another_form]
[entry.myfield.amopther_smart_in_another_form.somefield]
Smart Dropdown

myfield

myfield.* - see remarks

[entry.myfield]

[entry.myfield.*] - see remarks

See Smart Classifierdepends on a field referencedSee Smart Classifier
Smart Multiselect

myfield

myfield.* - see remarks

[entry.myfield]

[entry.myfield.*] - see remarks

See Smart Classifierdepends on a field referencedSee Smart Classifier
Smart Checkbox

myfield

myfield.* - see remarks

[entry.myfield]

[entry.myfield.*] - see remarks

See Smart Classifierdepends on a field referencedSee Smart Classifier
Smart Radio buttons

myfield

myfield.* - see remarks

[entry.myfield]

[entry.myfield.*] - see remarks

See Smart Classifierdepends on a field referencedSee Smart Classifier
Status

myfield

myfield.id

myfield.label

[entry.myfield]

[entry.myfield.id]

[entry.myfield.label]

Same as dropdown field, with IDs and LABELs. But has predefined values for IDs (depending on a colour)

as textSee remarks for dropdown field
Textareamyfield[entry.myfield]same as text typeas text
User

myfield

myfield.username

myfield.fullName

myfield.picture

myfield.email

myfield.lastName

myfield.firstName

[entry.myfield]

[entry.myfield.username]

[entry.myfield.fullName]

[entry.myfield.picture]

[entry.myfield.email]

[entry.myfield.lastName]

[entry.myfield.firstName]

same as text type, but you can query for field properties:

myfield:

myfield.username:

myfield.fullName:

myfield.picture:

myfield.email:

myfield.lastName:

myfield.firstName:

as text, see remarks

sorting is by username field

lastName and firstName are synthetic properties, which we try to extract from a given fullName.

We consider las word as lastName and what is given before is taken as firstName. This solution does not work for the whole world, but this is the best option we can offer you at the moment

User (multiselect)myfield

[entry.myfield]

[entry.myfield.asUserFullNames]

[entry.myfield.asUserEmails]

* - see remarks

Same as Useras text

You can show user full names in a list, or emails or (when no helper function is used) as list of usernames

See Virtual functions

Voting controlmyfieldN/AN/AN/AN/A
Webservice backed fields

As with "JIRA issue" fields you can access ANY property returned by the web service for the option you map with the field.

For example:

[
  {
    id: 1,
    name: "Alex",
    sn: "E123"
  },
  {
    id: 2,
    name: "Vlad",
    sn: "C100"
  }
]

You can map the structures of an array to be used as options for the web services backed fields in ConfiForms

Assuming your field is called "myfield"

then to access the properties you will need to put the following expressions

myfield.id
myfield.name
myfield.sn

There is also a synthetic property called "label" for the field what you use as "label" in your web services backed field

Important note: when your web service returns a structure with ID and you map another field to be used as ID then original data will not be accessible, as mapping overrides it.






WYSIWYG simple editormyfield[entry.myfield]same as text typeas text


Accessing through [entry.] notation can be used in ListView, in PlainView, in CalendarView and in IFTTT macro body, as well as when referencing ConfiForms record fields in macro parameters

See also Virtual functions to help you with formatting values in the format you want


Accessing values using Velocity syntax is deprecated and not supported in 100% of cases. Please try to accomplish what you have to do using [entry.] notation


Additional values available in the context

Variable


[owner]

Deprecated, use

[entry._user]

current record owner (ownedBy field) or Anonymous (when user is "Anonymous")

[modifier]

[user]

Deprecated, use

[entry._user]

current record modifier (User's full name)
[now]
Current timestamp. NB! Not evaluated to the value when in pre-sets and stays as [now] which results ALWAYS in current date. Use [entry._now] for the value
[user.name]

Deprecated, use

[entry._user.username]

current user's username
[user.fullName]

Deprecated, use

[entry._user.fullName]

current user's full name
[user.email]

Deprecated, use

[entry._user.email]

current user's email
[entry._user]_usercurrent user object (can access email, name, and fullname, see accessing properties for user fields)User field
[entry._now]
current timestamp, which can be converted to date using Virtual functions or used for comparison against other date/datetime fieldsDatetime
[entry._page]_pagecurrent page id (present in most cases, but not always)Page
[entry._storagePage]_storagePageform's page idPage
[entry._today]
current timestamp (for date, without time)Date
[entry._count]
number of records in the datasetNumeric
[entry._formName]

Name of the form is now available in the context SINCE 2.2.0

String


See also

Configuring ConfiForms IFTTT actions

Important note about IFTTT macros with macro bodies which are evaluated as velocity templates - there is additional context variables available

Standard set of objects inside the context (Velocity templates)


context.put("entry", entry); <- ConfiForms Entry (raw)
context.put("user", user); <- Confluence user object
context.put("page", contentObject); <- AbstractPage object

From ConfiForms version 1.49.3 there are additional objects in the context:

context.put("generalUtil", newcom.atlassian.confluence.util.GeneralUtil());
context.put("res", ServletActionContext.getResponse());
context.put("req", ServletActionContext.getRequest());
context.put("action", com.atlassian.confluence.renderer.radeox.macros.MacroUtils.getConfluenceActionSupport());

which you can referece as any other variable in Velocity using velocity syntax, for example: ${page.id} to reference page id of current page