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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 96 Next »

This is the documentation for ConfiForms Server/Data Center app

In order to make it easier to integrate with other external systems, such as JIRA, for example, we have implemented so called "virtual" functions, what you can call on field values.


  • When using in IFTTT macro body or in ListView/PlainView/CalendarView - the notation would be: [entry.fieldname.virtual_function] 

  • When using in ConfiForms Field macro then reference it by fieldname, adding the virtual function name: fieldname.virtual_function

Useful, when you try to prepare a JSON or some other format when used together with IFTTT macro to enable integrations with other systems

See also Accessing field values and properties. You can use complex properties in your filters. For example filtering dropdown fields by values and by labels, filtering page type fields by page metadata fields, filtering user fields by, for example - email property

As of now, the following functions are supported:

FunctionDescriptionUsing in ConfiForms Field macroUsing in ListVIew/PlanView/CalendarView or in IFTTT macro body

Does URL encode on given value, see "urlEncode" method in


Escapes XML on given value, see "escapeXml" method in


Escapes string as in "escapeForHtmlAttribute" method in

Tries to format date fields in the specified format, expects date format as in


(no quotes)

Same as "formatDate" method above, but specifies constant dateformat pattern (yyyy-MM-dd), suitable for JIRA REST APImyfield.jiraDate[entry.myfield.jiraDate]
Same as "formatDate" method above, but specifies constant dateformat pattern ("yyyy-MM-dd'T'HH:mm:ss.SSSZ"), should be compatible with ISO 8601 standard as JIRA requires when setting timestamps to JIRA fieldsmyfield.jiraDateTime[entry.myfield.jiraDateTime]

Escapes illegal characters in the field value to generate a valid JSON property. New lines, quotes, tabs and etc will be properly escaped


Tries to create an array from the value. Useful when you want to pass ConfiForms multi-select values to JIRA. Something like

"customfield_XXXX" : [[entry.myfield.asArray]]
this will generate
"customfield_XXXX" : ["val1","val2"]
assuming "myfield" field is a multi select and has 2 values: val1 and val2

There are variations to support other multi-select fields in JIRA

  • asArrayMultiSelect
  • asArrayMultiUserPicker (can be used to generate arrays for both: multi-user and multi-group field types)








FROM V. 1.35

Same as "asArray" without a parameter, but allows you to set own separator


asArray(') will wrap the values into list of 'v1', 'v2'...
asArray will do the same with default separator ", like this "v1", "v2"
asArray(_) will output _v1_, _v2_

Same as the above, but exporting IDs of the multi-select values in the following format:

"1", "2"


FROM V. 1.35

Will output the list of values in a format:

{"key":"value"}, {"key2": "value2"}

Useful for adding JIRA labels, like when giving a key as "add"

{"add": "value"}, {"add", "value2"}

Replaces CR/LF with <br/> tag to show with line brakes in HTML (useful when you reference the textarea field using [entry.] notation)myfield.replaceCRLFWithBR[entry.myfield.replaceCRLFWithBR]
Does the opposite to "replaceCRLFWithBR" and replaces <br/> tags with CRLF

Works only with User multi-select fields and shows list of full names for selected usersmyfield.asUserFullNames[entry.myfield.asUserFullNames]
Works only with User multi-select fields and shows list of emails for selected usersmyfield.asUserEmails[entry.myfield.asUserEmails]
Works only with User multi-select fields and shows list of usernames for selected usersmyfield.asUserNames[entry.myfield.asUserNames]
Formatting date and date/time field types with[entry.myfield.friendlyDate]
Returns size of a collection for multi-value fields or number of chars for other typesmyfield.asCount[entry.myfield.asCount]
Returns size of a collection for multi-value fields or number of chars for other types (same as "count")myfield.asSize[entry.myfield.asSize]
Returns size of a collection for multi-value fields or number of chars for other typesmyfield.asLength[entry.myfield.asLength]

Tries to format value as currency using either default or given format

If value could not be formatted according to given format then value will be returned as is

Can be used with any number (and not only currency)



(default decimal format is used if empty)


(no quotes, JAVA_FORMAT could be empty, default will be used)

[entry.myfield.formatCurrency(# ###.##)]

[entry.myfield.formatCurrency(# ###.00)]

alias to formatCurrency



(default decimal format is used if empty)


[entry.myfield.formatNumber(# ###.##)]

[entry.myfield.formatNumber(# ###.00)]


Very powerful function to extract the value by given filter (mostly used for multi-value fields).

Especially useful with Multi-select fields which are of type "smart fields", the ones referencing other forms and fields


You have one form which has a field called "mf" which holds multi-value references to another form which has the following fields: name, surname, position

Then... when showing the data from the first form you can actually show only specific choices.

For example:

  • - to show only persons selected with name Alex only (here "name" references a field in 2nd form)
  •*) - to show only persons selected with surnames starting with "Ve" only (here "surname" references a field in 2nd form)
  • - to filter OUT all those selected who are NOT in CEO position

Filter should be in a format:



The following filters are supported:

  • value*
  • *value
  • *value*
  • *
  • [empty]


Removes all the spaces in the field value.

Can be used when creating page labels automatically from ConfiForms field values and want to ensure the value is taken as a label and not split by spaces into differenet labels

Makes a CamelCase string from a given valueentry.myfield.camelCase[entry.myfield.camelCase]
Makes a CamelCase string from a given value and, additionally, removes all the spacesentry.myfield.camelCaseAndTrim[entry.myfield.camelCaseAndTrim]
addCRLFAdds CR and LF characters after the valueentry.addCRLF[entry.addCRLF]
addCRLFHtmlAdds <br/> (brake) after the value in HTML formatentry.addCRLFHtml[entry.addCRLFHtml]




Truncates the value. Leaves "n" first symbolsentry.trunc(100)[entry.trunc(100)]



Trims the value, Skips "n" first symbolsentry.trim(10)[entry.trim(10)]
trimRight(NUMBER)Trims the value, Removes "n" last symbols



You can reference a particular attachment stored in Confluence and linked though ConfiForms Field (either File or Attachment picker)

n - is the index of the attachment stored/linked using ConfiForms Field. Index starts with 0. When no index is specified, then the 1st attachment is taken (1st attachment is stored with index 0)

This means that

asAttachment = asAttachment(0)

This function is a "bridge" to get other properties of the attachment stored. See below.







Returns bas64 encoded string of the file contents in this attachmententry.asAttachment.base64






Where ANY_PROPERTY is the "get" methods of the class Attachment


and many other properties of the Attachment object
asAttachment(1).displayTitle - also perfectly valid and will try to get the display title for the attachment stored "second" in the field


FROM V. 1.39.2

Converts multi-user / multi-owner (ownedBy field in ConfiForms) field values to list of user objects, which can be then transformed into the desired output as needed, for example:


Any property of the User object (see below) is accessible






 When working with multi-select user control/field and want to get a particular user info

Only works with Multi-select user field!




This will return


When this is necessary?

The use case is when you use it within an IFTTT or have a ListView which has another ListView inside and you want to prevent ConfiForms from applying the context variables onto the sub-lists

The function can be used with any field type (as long as the field exists) and actually the following constructions are perfectly valid

[] will return [entry.somefield]
[] will return [entry.mytextfield]
[] will return [entry.anotherfield]
[] will return []

As you can see we apply the function on the same ID field (exists in every ConfiForms record) and the parameter you give in is the important bit in all this...

So, the parameter (PARAM) you give to asEntryRef is wrapped into the brackets and returned:


You can also use "_func" pseoudo property of a record as a bridge to "asEntryRef" function when the "id" is not available (assigned)

This is always available

[entry._func.asEntryRef(entry.somefield)] will return [entry.somefield]
[entry._func.asEntryRef(entry.mytextfield)] will return [entry.mytextfield]
[entry._func.asEntryRef(entry.anotherfield)] will return [entry.anotherfield]
[entry._func.asEntryRef(] will return []


FROM V. 1.50.1

Same as asEntryRef, and asIFTTTRef, but returns a value wrapped in ${}, like ${VALUE}

asJSONConverts a value to JSON and allows to access JSON object properties




FROM V. 1.53.8

Same as asEntryRef, and asIFTTTRef, but returns the exact experssion as you have put inside the arguments

asRef(VALUE) will return VALUE


Converts to User profile (or tries to, if a given field value can be resulved as a user object)

Available user profile properties (all standard ones, available in the profile) to reference are:

  • phone
  • im
  • website
  • position
  • department
  • location




where "somefield" should get resolved into username (can be user field)







asListExtracts values of a list and converts to a comma-separated string, see below for examples on transform and asList


Converts the file/attachment field values into the array of Attachment objects


Converts the list of some objects into the list of values for the given property

For example:


When "myfile" is a field of type file/attachment, a function "asAttachments" will convert it's values into the list of Attachments objects and then function "transform" will extract and "id" property of each Attachment object and will put it into the resulting list


Same as in previous example, but we convert the otput into a comma separated list of attachment IDs

Below, is another example, which returns a result of ID's, but wrapped into quotes


Function "transform" can be used on a multi-value field.(on Multi-select fields, which hold the structure of ID and LABEL (properties "id" and "label")) See Accessing field values and properties and dropdown fields

For example, to get the list of dropdown IDs


To get the list of dropdown labels


To get the list of User's full names for multi-user field (User field has properties: fullName, username, email, lastName, firstname) See Accessing field values and properties


same as above, but in "coma-separated" string



Transform function also works with smart fields, and could transform the fields / values referenced from another form through the reference (a field) in your current form

See an example here: Using transform function with smart fields


Adds a numeric value to a field (can substract as well, if a negative number is given)


to add 1 day to the date (value of 86400000 is in milliseconds)


to add -1 day (substract a day) to the date (value of 86400000 is in milliseconds)

Supports dynamic parameters via [entry.field_name]


Subtracts value from field value

Supports dynamic parameters via [entry.field_name]


Multiplies value by given parameter value


Supports dynamic parameters via [entry.field_name]


Divides value by given parameter value 


Supports dynamic parameters via [entry.field_name]


separator could be a space, like:

split( )

Split is an intermediate function to help you with transforming the string values into the arrays of strings, which then can be used with "array type" virtual functions

For example:

We have a field type called "mytextfield" and want it's content to be passed to JIRA as labels. For this we need to make sure we split the entered text by "space" and then use a corresponding virtual function to transform the object inti the desired representation

mytextfield.split( ).asArrayMultiSelect

Any other "array type" function can be applied. For example to get the count, one will write the following

mytextfield.split( ).asCount


FROM V. 1.36

FROM V. 1.50.1 - can be used in Field Definition Rules as well!

FROM V. 1.51.6 - you can use it without specifying property to track ANY field change.

By using


Now you can easily understand if the field value has been changed or not. Can be used ONLY (from ConfiForms version 1.50.1 can be used in field definition rules as well!) in IFTTT macro, in "condition" parameter. Only in this case, we have a previous snapshot of the data for this record. And the function is applied on the whole entry and not on the field.

Example in IFTTT macro:

The result of the function is a boolean, "true" is returned when the value for the field is different from current, and "false" is returned otherwise




hasChanged(somefield):true AND hasChanged(anotherfield):false

In addition to "hasChanged" function, ConfiForms has a support to get "previous state" of the record. And that is using a "virtual property" called: "_previousState"

Below example has the same result as "hasChanged(somefield):true"


This expression could be also used with IFTTT macro condition to determine if the value has been changed, but also allows you to create a more sophisticated filters like the one below:

hasChanged(mynum):true AND mynum:<[entry._previousState.mynum]

Checks if the value has been changed and if the previous value was bigger than current

This is available only in IFTTT and this also means that the synthetic property _previousState is available for you to us ein filters

For example - we want to run another IFTTT when the record status has changed from one value to another

(when "MyStatus" status field has changed it's value and the value was changed from "requested" to "development")

hasChanged(MyStatus):true AND MyStatus:development AND _previousState.MyStatus:requested


asUserLinks (same as above, but works on user multiselect fields)

FROM V. 1.36.3

Also, there is a function which renders it as a macro: useful for usage withing a template or LIstView/CalendarView


Generates a macro

<ac:link><ri:user ri:userkey="USER_KEY_HERE"></ac:link>

and renders the HTML out of it

USER_KEY_HERE is looked up by function based on the username given


on multi-select user fields use



FROM V. 1.37.1


FROM V. 1.38

asLink(Some label)

FROM V. 1.44

Returns value as HTML link (<a href="VALUE">VALUE</a>)

Also, for collections: function "asLinks"


entry.myfield.asLink(I am a link label)


[entry.myfield.asLink(I am a label)]



Renders a link to local resource

acLinkMacro functions generates a macro only (without rendering to HTML)

<ac:link><ri:page ri:content-title="SPACEKEy:PAGE_TITLE"/></ac:link>


FROM V. 1.36.6

Tries to format date fields in the specified format, expects date format as in

Example on how to parse and format a date from JIRA issue


In this example we have a field called "jirakey" in ConfiForms Form, and access a property "created" from JIRA issue.

Then we parse the created date, using the format JIRA uses when returning the date/time field via REST API and then we format the date using another virtual function called "formatDate" to show it as year-month-day only



Returns a timestamp, which you can transform to date using formatDate function or use as a filtering criteria


Converts timestamp to Iranian/Persian date


Converts timestamp to Iranian/Persian date with time



FROM V. 1.38

You can join the field values into one string. Works best on multi-select fields

Form example (expect a field to be a multi-select field here):

id:[entry.mymultifield.transform(id).join( OR id:)]

Will extract the ID's from a record stored, and then join (concatenate) those ID's into one string, separated by OR id:

Something like this (when mymultifield contains 2 items):

id:1234-5678-9000-1234-5678-9000 OR id:1234-5678-9000-1234-5678-9001
entry.myfield..join(SOME VALUE)[[entry,myfield.join(, Hello: )]


FROM V. 1.40

Helps you to transform the values of a "JIRA Issues multi-select" field into a JIRA objects to allow access to any property/field of the JIRA issue



Any property from JIRA issue, See Accessing field values and properties for JIRA field type


FROM V. 1.49.1

Helps you to transform the values of a "Insight Objects multi-select" field into a list of Insight Objects, which can be then transformed via "transform" function or properties can be accesssed directy


FROM V. 1.40

Helps you to transform the values saved to Page objects when used on Page/BlogPosts multi-select fieldentry.myfield.asPage.spaceKeyAny property from a Page object, see Accessing field values and properties



FROM V. 1.40

Both functions allow you to check if a particular user belongs to a given security group or not


If field "u" is holding a username and we want to check if this user belongs to "confluence-administrators" group


If field "sg" holds a name of a security group and we want top check if a username is in this security group


In the example below we check the same, but for currently logged in user


Both functions return "true" when condition is matched and "false" otherwise

(without quotes)

This means that if you need to put a filter to check the condition, the full expression will look like:





FROM V. 1.42.4

Using get() without an index will return the last item from the list

FROM V. 1.44.2

Get's the element by index form a multi-value field

To get the first element (index starts from 0)


Another example with chaining the functions (when somefield holds a string value and we split it by "," and get the first element)



FROM V. 1.43

Appends text to a value

Will append a space to the value of "somefield"

somefield.append( )

For multi-select dropdown, adding space after transformation and shows in as html link


Argument can be dynamic, and reference another field, like [entry.somefield], so you can concat values together


FROM V. 1.45.2

Prepends text to a value

Will append a space to the value of "somefield"

somefield.prepend(SOME TEXT HERE)

Argument can be dynamic, and reference another field, like [entry.somefield], so you can concat values together


FROM V. 1.44.2

Returns a lowercases value for the field


FROM V. 1.44.2

Returns a uppercased value for the field


FROM V. 1.45.2

Tries to format the http(s) links found in the text as HTML links



FROM V. 1.45.3

Tries to parse the fiedl value returned by JIRA API for greenhopper fields

com.atlassian.greenhopper.service.sprint.Sprint@71f1f2ae[id=6745,rapidViewId=2391,state=ACTIVE,name=My Sprint 2,startDate=2017-08-29T10:46:33.923+01:00,endDate=2017-09-08T10:46:00.000+01:00,completeDate=<null>,sequence=6745]

to a structure you can access via properties

name=My Sprint 2

Example (to return a sprint name)


FROM V. 1.47.2

The idea and the need for this function is the same as described for function asEntryRef(REF_TO_ENTRY)

This allows you to "escape" the ${IftttResult_NAME.someproperty} into a function to workaround template evaluations against the current record. Useful when your ConfiForms Form creates a page with another ConfiFormiForms Form and that form has various rules using iftttResults or entry.fieldnames will produce ${} will produce ${iftttResult_MYRESULT}


FROM V. 1.48

Outputs a field value as a link to user profile (with avatar and full name). The field must have a username as a value




FROM V. 1.48.2

Replaces the following accents letters using the folllwing mapping

"Ä" -> "Ae"
"Æ" -> "Ae"
"ä" -> "ae"
"æ" -> "ae"
"Ö" -> "Oe"
"ö" -> "oe"
"Ü" -> "Ue"
"ü" -> "ue"
"ß" -> "ss"
"ó" -> "o"
"ú" -> "u"
"Ç" -> "C"
"ç" -> "c"
"í" -> "i"
"Ñ" -> "N"
"ñ" -> "n"
"À" -> "A"
"Â" -> "A"
"à" -> "a"
"â" -> "a"
"È" -> "E"
"É" -> "E"
"Ê" -> "E"
"è" -> "e"
"é" -> "e"
"ê" -> "e"


FROM V. 1.48.2

Replaces every value matching "search string" in a field with given "replace with" value


Will match every "hi" and replace it with "hola"



FROM V. 1.51.3

Helps you to create http links from values in ConfiForms directly in teh views


will create a <a href="<VALUE_OF_MY_FIELD>" target="_blank"><VALUE_OF_MY_FIELD></a>

the below example shows how to specify a contant label for your links


will create a <a href="<VALUE_OF_MY_FIELD>" target="_blank">search</a>


FROM V. 1.52.1

Tries to get the timestamp from date/datetime/timestamp holding fields in epoch format


FROM V. 1.52.1

Converts string into hex representation


You can use it with other functions, as usual... something like



FROM V. 1.52.1

Converts decimals to hex


As always, you can chain the functions

[entry.myfield.dec2Hex.trim(4)] - returns last 4 digits, instead of 000000D2 for 210 will return 00D2


FROM V. 2.0.8

You can generate tips from ConfiForms data with something like

<ac:macro ac:name="confiform-plain">
  <ac:parameter ac:name="filter">valuecounter:[entry._total.randomInt(1)]</ac:parameter>
  <ac:parameter ac:name="formName">f</ac:parameter>
  <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter>

To show "random" advice from your form of "advices"

Where "valuecounter" field is autonumber field and we randomly picking one record from a dataset, starting from 1 (that is why we use "randomInt(1)" function on _total field)

toStringEnsures the value is a string value

timezoneAwareDateTries to format the date given in the user's timezone. Uses user's defined formatting pattern to format the date

timezoneAwareDateTimeTries to format the date/time given in the user's timezone. Uses user's defined formatting pattern to format the datetime


Formats number with a given locale

formatNumberWithLocale(de) will format the number in German locale.

See supported locales in Java 8,


FROM V. 2.0.23

Helper function to render DateTime Interval field values in a more compact way when the date for start and end is within the same day


Example (the output format is specific to your Confluence date/time formatting settings):

DateTime Interval valueOutput
Mar 19, 2019 2:00 PM  - Mar 19, 2019 3:00 PM
Mar 19, 2019 2:00 PM – 3:00 PM
Transforms to a short format
Mar 19, 2019 2:00 PM  - Mar 20, 2019 3:00 PM
Mar 19, 2019 2:00 PM  - Mar 20, 2019 3:00 PM
Stays in long format, as event spans 2 days

truncWithExpand(N) where N is the number of characters to show

FROM V. 2.0.25


will show the first 10 symbols and if the value is longer then the "..." block will be shown to allow your users to expand the value

extractTextExtracts text from HTML value

renderAsTextRender as Text (mainly to be used with values produced by wiki markdown field type)

renderAsHtmlRender as HTML (mainly to be used with values produced by wiki markdown field type)


FROM V. 2.1.0

Renders wiki markup contents as html


FROM V. 2.1.0

Removes all new lines in a field value


FROM V. 2.1.0

Removes all the spaces in the field value

remove(value)Removes value from the field (works as replaceWith for non-collections (single fields) and as remove item for multi-value fields)


FROM V. 2.6.0

Hides the value behind the given mask

pwd.obscure(********|click to view)

Will create something like

Clicking on the "click to view" link will reveal the actual value of the "pwd" field

If entry value is null or could not be formatted according to rules then value is returned as-is 

See also Accessing field values and properties. You can use complex properties in your filters. For example filtering dropdown fields by values and by labels, filtering page type fields by page metadata fields, filtering user fields by, for example - email property

It is important to understand that it is absolutely possible to combine virtual functions WITH field properties


  • No labels