Page History

urlencode

urldecode

escapeXML

escape

escapeJavaScript

formatDate

Example:

formatDate(MM-dd-yyyy, UTC)

Supported timezone arguments

convertDate(FORMAT, TIMEZONE)

Supported timezone arguments

jiraDate

jiraDate(America/Chicago)

Supported timezone arguments

jiraDateTime

jiraDateTime(UTC)

Supported timezone arguments

escapeJSON

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

[entry.myfield.escapeJSON]

asArray

asArrayMultiSelect

asArrayMultiUserPicker

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

https://developer.atlassian.com/jiradev/jira-apis/about-the-jira-rest-apis/jira-rest-api-tutorials/jira-rest-api-example-create-issue

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

asArray(separator)

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

Example:

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_

asArrayOfIds

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

"1", "2"

asArrayOfKVPairs(key)

Will output the list of values in a format:

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

Useful for adding JIRA labels, like when giving a key as "add" → asArrayOfKVPairs(add)

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

replaceCRLFWithBR

replaceBRWithCRLF

asUserFullNames

asUserEmails

asUserNames

friendlyDate

asCount

asSize

asLength

formatCurrency

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

https://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html

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

formatNumber

asFilteredBy(FILTER)

trimAllSpaces

camelCase

camelCaseAndTrim

addCRLF

addCRLFHtml

trunc(NUMBER)

truncLeft(NUMBER)

truncRight(NUMBER)

trim(NUMBER)

trim() - will trim the value from leading/trailing spaces

trimLeft(NUMBER)

trimRight(NUMBER)

asAttachment

asAttachment(n)

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.

asAttachment.base64

asAttachment(1).base64

Returns bas64 encoded string of the file contents in this attachment

ConfiForms uses https://commons.apache.org/proper/commons-codec/apidocs/org/apache/commons/codec/binary/Base64.html#encodeBase64URLSafeString-byte:A- to do this and it is important to note that

base64(true) - generates URL-safe output (same as without parameter)

base64(false) - generates pure base64 hash

asAttachment.ANY_PROPERTY

asAttachment(n).ANY_PROPERTY

Where ANY_PROPERTY is the "get" methods of the class Attachment https://docs.atlassian.com/confluence/5.9.1/com/atlassian/confluence/pages/Attachment.html

Examples:

asAttachment.displayTitle
asAttachment.id
asAttachment.downloadPath
asAttachment.contentType 
 
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

base64Decode

Decodes a base64 string into original text value

asUsers

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:

ownedBy.asUsers.transform(email)

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

asUser.username

asUser.fullName

asUser.email

asUser(n).username

asUser(n).fullName

asUser(n).email

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

asEntryRef(REF_TO_ENTRY)

asVelocityExpRef(VALUE)

asJSON

asRef(VALUE)

asUserProfile

entry.somefield.asUserProfile.phone

entry.somefield.asUserProfile.im

entry.somefield.asUserProfile.website

entry.somefield.asUserProfile.position

entry.somefield.asUserProfile.department

entry.somefield.asUserProfile.location

asList

asAttachments

transform(property_name)

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

For example:

[entry.myfile.asAttachments.transform(id)]

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

[entry.myfile.asAttachments.transform(id).asList]

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

[entry.myfile.asAttachments.transform(id).asArray]

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

[entry.mymultifield.transform(id)]

To get the list of dropdown labels

[entry.mymultifield.transform(label)]

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

[entry.mymultiuserfield.transform(fullName)]

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

[entry.mymultiuserfield.transform(fullName).asList]

add(number)

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

[entry.somedatefield.timestamp.add(86400000)]

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

[entry.somedatefield.timestamp.add(-86400000)]

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

subtract(number)

Subtracts value from field value

multiply(number)

Multiplies value by given parameter value

[entry.somedatefield.multiply(2)]

divide(number)

Divides value by given parameter value 

[entry.somedatefield.divide(2)]

split(separator)

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

hasChanged(fieldName)

By using

hasChanged():true

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:

Image Added

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

Example:

hasChanged(somefield):true

or

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"

!somefield:[entry._previousState.somefield]

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

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

asUserLink

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

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

asUserLinkMacro

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

asLink

asLinks

asLink(Some label)

asLink([entry.somefield])

acLink

acLinkMacro

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>

asImageLink

parseDate(FORMAT)

Tries to format date fields in the specified format, expects date format as in http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html

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

jirakey.fields.created.parseDate(yyyy-MM-dd'T'HH:mm:ss.SSS'Z').formatDate(yyyy-MM-dd)

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

toPersianDate

Converts timestamp to Iranian/Persian date

date.toPersianDate

toPersianDateTime

Converts timestamp to Iranian/Persian date with time

mydatefield.toPersianDateTime

join

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

For 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

asJIRAIssue

asInsightObject

asPage

userInSecurityGroup

securityGroupHas

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

Examples:

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

u.userInSecurityGroup(confluence-administrators)

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

sg.securityGroupHas(sash)

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

sg.securityGroupHas()

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:

u.userInSecurityGroup(confluence-administrators):true

or

sg.securityGroupHas():true

securityGroups

Retrieves user's securityGroups in a comma separated list

userfield.securityGroups

(Assuming userfiled is the field holding the username)

securityGroupUsers

on cloud version we return only the first 200 members of a group

Lists users (comma separated list of user names) for the given security group

fieldContainingSecurotyGroupName.securityGroupUsers

get(index)

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

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

To get the first element (index starts from 0)

somefield.get(0)

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

somefield.split(,).get(0)

append

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

somefield.transform(label.append()).asLinks

prepend

Prepends text to a value

Will append a space to the value of "somefield"

somefield.prepend(SOME TEXT HERE)

lowerCase

upperCase

formatLinks

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

somefield.formatLinks

greenhopperAsJSON

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

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=
sequence=6745

Example (to return a sprint name)