This is the documentation for ConfiForms Server/Data Center app
However, this might also work for ConfiForms cloud and in most cases it does. But please see this page to understand the differences between server and cloud versions of the ConfiForms 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.
Usage:
- 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
As of now, the following functions are supported:
| Function | Description | Using in ConfiForms Field macro | Using in ListVIew/PlanView/CalendarView or in IFTTT macro body |
|---|---|---|---|
urlencode | Does URL encode on given value, see "urlEncode" method in | myfield.urlencode | [entry.myfield.urlencode] |
escapeXML | Escapes XML on given value, see "escapeXml" method in | myfield.escapeXml | [entry.myfield.escapeXml] |
escape | Escapes string as in "escapeForHtmlAttribute" method in | myfield.escapeForHtmlAttribute | [entry.myfield.escapeForHtmlAttribute] |
formatDate | 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 | myfield.formatDate(JAVA_FORMAT) | [entry.myfield.formatDate(JAVA_FORMAT)] (no quotes) |
jiraDate | Same as "formatDate" method above, but specifies constant dateformat pattern (yyyy-MM-dd), suitable for JIRA REST API | myfield.jiraDate | [entry.myfield.jiraDate] |
jiraDateTime | 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 fields | myfield.jiraDateTime | [entry.myfield.jiraDateTime] |
escapeJSON | Escapes illegal characters in the field value to generate a valid JSON property. New lines, quotes, tabs and etc will be properly escaped | myfield.escapeJSON | [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
| myfield.asArray myfield.asArrayMultiSelect myfield.asArrayMultiUserPicker | [entry.myfield.asArray] [entry.myfield.asArrayMultiSelect] [entry.myfield.asArrayMultiUserPicker] |
replaceCRLFWithBR | Replaces CR/LF with <BR/> to show with line brakes in HTML (useful when you reference the textarea field using [entry.] notation) | myfield.replaceCRLFWithBR | [entry.myfield.replaceCRLFWithBR] |
asUserFullNames | Works only with User multi-select fields and shows list of full names for selected users | myfield.asUserFullNames | [entry.myfield.asUserFullNames] |
asUserEmails | Works only with User multi-select fields and shows list of emails for selected users | myfield.asUserEmails | [entry.myfield.asUserEmails] |
asUserNames | Works only with User multi-select fields and shows list of usernames for selected users | myfield.asUserNames | [entry.myfield.asUserNames] |
friendlyDate | Formatting date and date/time field types with https://docs.atlassian.com/confluence/latest/com/atlassian/confluence/core/datetime/FriendlyDateFormatter.html | myfield.friendlyDate | [entry.myfield.friendlyDate] |
If entry value is null or could not be formatted according to rules then value is returned as-is