Info | ||||||
---|---|---|---|---|---|---|
Looking for
|
Info |
---|
ConfiForms IFTTT macro is a powerful tool which helps you to built integrations with other systems: to send emails, to create issues in Jira, to build workflows in Confluence, to organise templates and rules. And also to create various types of cool things around ConfiForms and Confluence. |
...
ConfiForms IFTTT macro is a part of ConfiForms Form definition and must be placed inside the ConfiForms Form macro body. You can place as many ConfiForms many ConfiForms IFTTT macros as you want. Each macro has an event it is binded to. There are 3 4 types of events in ConfiForms:
- onCreated - fires AFTER the record is created
- onModified - fires AFTER the record has been modified
- onDeleted - fires AFTER the record has been deleted
- onError - fires in case if any of the previously executed IFTTT rules failed / resulted in an error
You can define the "condition", to limit the scope when action is fired. Meaning that you can define to execute an action only when certain condition is met.
Conditions macro parameter expects a filter, more about filters could be found here: ConfiForms Filters
At the moment ConfiForms IFTTT macro has 38 action types to choose from.
Each action has different set of parameters to set. In most cases you can use references to your entry fields via [entry.FIELD_NAME] in macro parameters, so these will be replaced with actual values.
Warning |
---|
Important The execution order for actions is the same as you put them inside the ConfiForms Form macro body (obviously, filtered by event type). IFTTT execution also supports referencing of results for previous execution: Advanced integrations with IFTTT macros with ConfiForms |
Below, you can find a list of integrations scenarios the macro can support and it's configuration details
Actions list
ConfiForms IFTTTs generate results (type depends on the IFTTT type)
These results could be used to created "chained" flows, when one IFTTT uses the results of the previous IFTTT(s). The easiest way is to set the name to the IFTTT result (see RESULTNAME), so you can reference it anytime via [iftttResult_RESULTNAME]
Important to note that result chaining is PER EVENT. Which means you can reference results of previous IFTTTs only if the event is matching (onCreated, onModified, onDeleted and onError). Each event has own chain of results.
At the moment ConfiForms IFTTT macro has 38 action types to choose from.
Each action has different set of parameters to set. In most cases you can use references to your entry fields via [entry.FIELD_NAME] in macro parameters, so these will be replaced with actual values.
Warning |
---|
Important The execution order for actions is the same as you put them inside the ConfiForms Form macro body (obviously, filtered by event type). IFTTT execution also supports referencing of results for previous execution: Advanced integrations with IFTTT macros with ConfiForms |
Below, you can find a list of integrations scenarios the macro can support and it's configuration details
Actions list
There are 38 different actions supported by IFTTT out-of-the-box (There are 38 different actions supported by IFTTT out-of-the-box (some actions are very generic, so the integration scenarios number is a lot bigger)
...
Parameter name | Description | ||
---|---|---|---|
Event | Type of event in ConfiForms this IFTTT action should be fired on
| ||
Action to perform | One of the actions to perform. See the list above | ||
Do not report error | A checkbox field to disable error reporting and continue with the workflow even if current macro has resulted in an error | ||
Custom name for the action result | This is used in advanced techniques, when you want to use the result of the IFTTT in next IFTTT or want to save the result of some IFTTT or some part of the result back into a ConfiForms record. See below the result types and the contents stored in the result for each IFTTT action. A result (depending on the action type) is stored in the context in the variable prefixed by "iftttResult_" And is accessible using the Velocity notation via
Where "RESULTNAME" is the value given in this macro parameter. Some results hold rich objects. See "Result type" section for exact IFTTT action below |
Add Attachment Label | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Add a label or labels to attachment | |||||||||||||||||||||||||||||||||||||
Result type: | NO RESULT | |||||||||||||||||||||||||||||||||||||
Add Page Label | ||||||||||||||||||||||||||||||||||||||
| Adds Adds label to a page, you can apply a label (or labels) to page sub-pages as well | |||||||||||||||||||||||||||||||||||||
Result type: | NO RESULT | |||||||||||||||||||||||||||||||||||||
Add Page Watcher | ||||||||||||||||||||||||||||||||||||||
| Adds a user or group of users as a page watcher | |||||||||||||||||||||||||||||||||||||
Result type: | Page object (page where the watcher's were added) Depending on the IFTTT result name you can access all of the properties available from Page object. For example (when result name is MYRESULT)
Any other property, which Page object provide (any "get" method) | |||||||||||||||||||||||||||||||||||||
Applink Service | ||||||||||||||||||||||||||||||||||||||
| Sends a request to configured Application link service A user specifies which HTTP method to use, which URL service to execute (url must be given as "relative" url, this means it is "concatenated" with the base url in your applink service) More about Application links in Confluence could be found here: https://confluence.atlassian.com/display/APPLINKS/Application+Links+Documentation | |||||||||||||||||||||||||||||||||||||
Result type: | Response returned from a request to a service is returned and stored as result If response is a JSON then you can apply Virtual functions to work on a JSON object Please note that virtual functions could be applied only on ConfiForms fields, not the IFTTT result directly. This means you will need to save the response to some ConfiForms field temporarily in order to apply the functions and convert the response to JSON. | |||||||||||||||||||||||||||||||||||||
Audit | ||||||||||||||||||||||||||||||||||||||
Nothing to configure: see Using new Audit IFTTT action |
| Automatic audit for your form. Audit form with <form_name>_log is created for you automatically, with a field referencing your <form_name> | ||||||||||||||||||||||||||||||||||||
Result type: | NO RESULT | |||||||||||||||||||||||||||||||||||||
Copy Attachment | ||||||||||||||||||||||||||||||||||||||
| Copies attachment from one page Copies attachment from one page to another. In contrast to "Move Attachment" action, the copy of an attachment created. Original attachment stays untouched | |||||||||||||||||||||||||||||||||||||
Result type: | NO RESULT | |||||||||||||||||||||||||||||||||||||
Copy ConfiForms Data | ||||||||||||||||||||||||||||||||||||||
| Copies data from one ConfiForms form to another, can have custom mapping for fields and have a filter applied before copying the data Also, it can "flatten" the multi-select values to copy the data to a new form in an "expanded" view Please note that if you leave the filter empty then ALL the records from a source form will be copied to a destination form. To copy just one, current record, you will need to apply the following filter
Usage is very similar to what is shown here but allows you to copy multiple records at a time if necessary | |||||||||||||||||||||||||||||||||||||
Result type: | Last created (copied) record as object. This | Result type: | Last created (copied) record as object. This means that you can access any property available in ConfiForms record. Please note that the values accessed using the Velocity notation (${}) return "raw" (internal) values. More on this | |||||||||||||||||||||||||||||||||||
Copy ConfiForms Data to DB | ||||||||||||||||||||||||||||||||||||||
| Executes a SQL statement you specify on your database (on the database connection you have configured) You must specify a valid SQL statement - either INSERT or UPDATE Similar to "Copy ConfiForms Data" action you can filter records on original form before copying, as well as "flatten" records in order to have multi-value fields as separate rows (if necessary) ConfiForms uses JDBC driver to connect to your database. See more on Some guidelines on using database fields in ConfiForms and Working with database fields in ConfiForms | |||||||||||||||||||||||||||||||||||||
Result type: | NO RESULT | Create Attachment | ||||||||||||||||||||||||||||||||||||
Macro body: |
| |||||||||||||||||||||||||||||||||||||
Result type: | File contents as text into the result | Create BlogPost | ||||||||||||||||||||||||||||||||||||
Creates blog post based on the contents in macro body and the title given. Blog post will be created in a Confluence space specified. You can apply labels to a created blog post | Macro body: |
macro-body-default-text |
---|
Created Blog Post - complete object, as https://docs.atlassian.com/confluence/5.8.9/com/atlassian/confluence/pages/BlogPost.html
Example:
Code Block |
---|
${iftttResult_MYRESULT.id}
${iftttResult_MYRESULT.displayTitle}
other properties from BlogPost object
Same can be archived with
[iftttResult_MYRESULT.id]
[iftttResult_MYRESULT.spaceKey]
[iftttResult_MYRESULT.displayTitle]
since ConfiForms version 2.11 |
(if result was named "MYRESULT")
Create Comment
Macro body is used as comment template
macro-body-default-text |
---|
Copy Page
Status | ||||
---|---|---|---|---|
|
Copies page from one location to another
A user performing an operation should have enough permissions (to copy the page from source location to destination location (create page permission))
Info |
---|
Please note that the page title and the contents of the copied page will be processed against the current record field's - so if your page title contains the [entry.field_name] notation then these will be evaluated against the values in the current record in the context |
You can switch off the processing for the page body, but page title is always processed
Copied page as object. Any property a Page object has
For example (when result name is MYRESULT)
Code Block |
---|
${iftttResult_MYRESULT.id}
${iftttResult_MYRESULT.spaceKey}
${iftttResult_MYRESULT.displayTitle}
...
Same can be archived with
[iftttResult_MYRESULT.id]
[iftttResult_MYRESULT.spaceKey]
[iftttResult_MYRESULT.displayTitle]
since ConfiForms version 2.11 |
Any other property, which Page object provides (any "get" method)
Create Attachment
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Creates a file, based on the content you specify in macro body and uploads it as attachment.
You need to specify field name to use to store the reference to a created attachment - ConfiForms field of type "File" is the preferred field type to store this
macro-body-default-text |
---|
Create BlogPost
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Creates blog post based on the contents in macro body and the title given.
Blog post will be created in a Confluence space specified.
You can apply labels to a created blog post
macro-body-default-text |
---|
Excerpt Include | ||||
---|---|---|---|---|
|
Created Blog Post - complete object, as https://docs.atlassian.com/confluence/5.8.9/com/atlassian/confluence/pages/BlogPost.html
Example:
Create (Update) ConfiForms Entry
Creates (or updates) ConfiForms Entry in the specified form
Warning |
---|
It is important to note that this action never fires any other "Create ConfiForms Entry", "Delete ConfiForms Entry" or "Copy ConfiForms Data" for the entry created |
Additionally, you can stop the propagation of the "create/update" events completely.
To update the current ConfiForms record leave the "Reference to form and it's location" empty and in parameters to set specify:
Code Block |
---|
entryId=[entry.id] |
To target the current record
Created entry object, same as in Copy ConfiForms Data
Code Block |
---|
${iftttResult_MYRESULT.somefield}id} ${iftttResult_MYRESULT.displayTitle} other properties from BlogPost object Same can be archived with [iftttResult_MYRESULT.id] [iftttResult_MYRESULT.spaceKey] [iftttResult_MYRESULT.somefielddisplayTitle] since ConfiForms version 2.11 |
Where "somefield" is the name of the field in ConfiForms form
This action helps you to create different types of update rules for your ConfiForms entries. You can create an audit for all changes, you can update entries in other forms or entries in the same form based on chosen criteria
Same action type is used for creating new entries and updating existing and the parameter to indicate that is "entryId"
So, to create record you will specify:
Code Block |
---|
someparam=[entry.somefield]&anotherparam=[entry.another] |
But to update existing record you will need to have something like this:
Code Block |
---|
entryId=[entry.id]&someparam=[entry.somefield]&anotherparam=[entry.another] |
You can also set constant values, does not have to be a reference to some field value
Code Block |
---|
someparam=MY CONSTANT&anotherparam=[entry.another] |
The above example will set "someparam" to constant value of "MY CONSTANT" and "anotherparam" will be set to a value found on the field named "another"
Warning |
---|
Important bit which is often forgotten is to specify which form and where it is located (form name and pageId), the last parameter in the macro. If this is not specified then nothing is executed, as ConfiForms does not know where this action to be applied |
Other tutorials:
- http://wiki.vertuna.com/display/CONFIFORMS/Advanced+integrations+with+IFTTT+macros+with+ConfiForms
- Creating links in original ConfiForms entry to just created page
Create Insight Object
Creates Insight object based on the JSON mapping given
See Creating Jira issue from Confluence with ConfiForms for a tutorial on Creating JIRA issues, the concept behind creating Insight objects is identical
JSON mapping wrapped in "No Format" macro to have a raw text
JSON mapping should be of structure specified in Insight REST API https://documentation.riada.se/display/ICV50/Version+1.0+documentation
/rest/insight/1.0/object/create service in particular
Created Object ID as text
Code Block |
---|
${iftttResult_MYRESULT}
or (see Velocity templates syntax for more on "!" operator)
$!{iftttResult_MYRESULT}
Same can be archived with
[iftttResult_MYRESULT]
since ConfiForms version 2.11 |
(if result was named "MYRESULT")
If IFTTT macro is set to ignore errors (execute in silent mode, then there might be NO RESULT in the variable, so accessing it with "!", like $!{iftttResult_MYRESULT} is safer)
You can create Insight Objects from ConfiForms entries. However, this is a bit technical to setup as the integration is done through the JSON document you will need to prepare. See tutorial below for more details and examples. Important: you must have a correctly configured Application link to JIRA
Also, there are some helpers to help you with preparing correct JSON, see Virtual functions
Tutorials:
Creating Jira issue from Confluence with ConfiForms (similar concept to creating Insight Objects, but expects a different mapping and uses a different service underneath)
Warning Definitely use the NoFormat macro to place the JSON mapping inside the IFTTT macro body
(if result was named "MYRESULT")
Create Comment
Status | ||||
---|---|---|---|---|
|
Macro body is used as comment template
macro-body-default-text |
---|
Excerpt Include | ||||
---|---|---|---|---|
|
Create (Update) ConfiForms Entry
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Creates (or updates) ConfiForms Entry in the specified form
Warning |
---|
It is important to note that this action never fires any other "Create ConfiForms Entry", "Delete ConfiForms Entry" or "Copy ConfiForms Data" for the entry created |
Additionally, you can stop the propagation of the "create/update" events completely.
To update the current ConfiForms record leave the "Reference to form and it's location" empty and in parameters to set specify:
Code Block |
---|
entryId=[entry.id] |
To target the current record
Info | ||
---|---|---|
You can also have your values be evaluated as expressions and contain Supported math operators, formulas and functions In this case they should be wrapped in () Example:
|
Created entry object, same as in Copy ConfiForms Data
Code Block |
---|
${iftttResult_MYRESULT.somefield}
Same can be archived with
[iftttResult_MYRESULT.somefield]
since ConfiForms version 2.11 |
Where "somefield" is the name of the field in ConfiForms form
This action helps you to create different types of update rules for your ConfiForms entries. You can create an audit for all changes, you can update entries in other forms or entries in the same form based on chosen criteria
Same action type is used for creating new entries and updating existing and the parameter to indicate that is "entryId"
So, to create record you will specify:
Code Block |
---|
someparam=[entry.somefield]&anotherparam=[entry.another] |
But to update existing record you will need to have something like this:
Code Block |
---|
entryId=[entry.id]&someparam=[entry.somefield]&anotherparam=[entry.another] |
You can also set constant values, does not have to be a reference to some field value
Code Block |
---|
someparam=MY CONSTANT&anotherparam=[entry.another] |
The above example will set "someparam" to constant value of "MY CONSTANT" and "anotherparam" will be set to a value found on the field named "another"
Warning |
---|
Important bit which is often forgotten is to specify which form and where it is located (form name and pageId), the last parameter in the macro. If this is not specified then nothing is executed, as ConfiForms does not know where this action to be applied |
Other tutorials:
Create Insight Object
Status | ||||
---|---|---|---|---|
|
Creates Insight object
Create Jira Issue
Creates JIRA issue based on the JSON mapping given
See Creating Jira issue from Confluence with ConfiForms
You can add users as watchers to created JIRA issue. Must be a valid user (list of users) given
When you want to add an attachment to JIRA issue from ConfiForms file field - you will need to place the "ConfiForms Field" macro inside the ConfiForms IFTTT macro body. This way, you will tell ConfiForms, in addition to issue creation, to upload the file to JIRA. You can upload multiple files, just by placing additional ConfiForms Field macros referencing other file fields into the macro body
for a tutorial on Creating JIRA issues, the concept behind creating Insight objects is identical
Excerpt Include | ||||
---|---|---|---|---|
|
JSON mapping wrapped in "No Format" or in "Code
JSON mapping wrapped in "No Format" macro to have a raw text
JSON mapping should be of structure specified in JIRA Insight REST API - https://developerdocumentation.atlassianriada.comse/jiradevdisplay/ICV50/Version+1.0+documentation
https://confluence.atlassian.com/servicemanagementserver050/insightjira-apis/jira-rest-apis/jira-rest-api-tutorials/jira-rest-api-example-create-issuedocumentation-1142253260.html
/rest/insight/1.0/object/create service in particular
Created issue KEY Object ID as text
Code Block |
---|
${iftttResult_MYRESULT} or (see Velocity templates syntax for more on "!" operator) $!{iftttResult_MYRESULT} Same can be archived with [iftttResult_MYRESULT] since ConfiForms version 2.11 |
(if result was named "MYRESULT")
If IFTTT macro is set to ignore errors (execute in silent mode, then there might be NO RESULT in the variable, so accessing it with "!", like $!{iftttResult_MYRESULT} is safer)
You can create JIRA issues Insight Objects from ConfiForms entries. However, this is a bit technical to setup as the integration is done through the JSON document you will need to prepare. See tutorial below for more details and examples. Important: you must have a correctly configured Application link to JIRA
Also, there are some helpers to help you with preparing correct JSON, see Virtual functions
This action type supports uploading files to created JIRA ticket, an example is also available in the same tutorial.
Important to note that currently this action selects a primary app link to JIRA, if you have more than 1 JIRA connected then you will be able to create JIRA issues only in your primary JIRA (the one set as primary in your application links)
Tutorials:
Tutorials:
Creating Jira issue from Confluence with ConfiForms (similar concept to creating Insight Objects, but expects a different mapping and uses a different service underneath)Creating Jira issue from Confluence with ConfiForms
Warning Definitely use the NoFormat macro to place the JSON mapping inside the IFTTT macro body
Create
PageCreates Confluence page based on the template given (in macro body)
See Creating links in original ConfiForms entry to just created page
Using ConfiForms app as template engine to create pages in Confluence
Warning |
---|
In Confluence the page title should be unique within a Confluence space. ConfiForms will create a new version of the page if the page with given title already exists in the Confluence space specified |
Warning |
---|
Important to note is that if you put ConfiForms Field macros inside the IFTTT macro body and this macros will be WITHOUT a "view" macro around them, then a ListView macro with a filter set to current record is created as a wrapper for ALL the content in the IFTTT macro body. If you want to avoid "auto-wrapping" then you need to make sure that all ConfiForms Field macros you put are within the "view" macro (TableView, ListView, CardView, etc) In contrast, when you use [entry.fieldname] notations then there is no need to wrap anything in views macros. But in this case the data is static data copied (not referenced) there from ConfiForms |
All references (like [entry.filed_name]) inside the IFTTT macro body to ConfiForms fields are evaluated against the current record.
If you have an IFTTT action to create a page with ConfiForms Form and it should have filters or field rules which in the created page should look like [entry.fieldname] you will need to wrap these into a virtual function
Jira Issue
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Creates JIRA issue based on the JSON mapping given using https://docs.atlassian.com/software/jira/docs/api/REST/9.2.0/#api/2/issue-createIssue
See Creating Jira issue from Confluence with ConfiForms
You can add users as watchers to created JIRA issue. Must be a valid user (list of users) given
When you want to add an attachment to JIRA issue from ConfiForms file field - you will need to place the "ConfiForms Field" macro inside the ConfiForms IFTTT macro body. This way, you will tell ConfiForms, in addition to issue creation, to upload the file to JIRA. You can upload multiple files, just by placing additional ConfiForms Field macros referencing other file fields into the macro body
Excerpt Include | ||||
---|---|---|---|---|
|
JSON mapping wrapped in "No Format" or in "Code" macro to have a raw text
JSON mapping should be of structure specified in JIRA REST API - https://developer.atlassian.com/jiradev/jira-apis/jira-rest-apis/jira-rest-api-tutorials/jira-rest-api-example-create-issue
Created issue KEY as text
Code Block |
---|
${iftttResult_MYRESULT}
or (see Velocity templates syntax for more on "!" operator)
$!{iftttResult_MYRESULT} |
Code Block |
---|
asEntryRef(REF_TO_ENTRY) |
source | Page |
---|---|
excerpt | vertuna-smart-template#9d900459-6358-4a80-8926-405c32106fd0 |
content | 2359385 |
macro-body-default-text |
---|
Page object (page created)
Depending on the IFTTT result name you can access all of the properties available from Page object.
For example (when result name is MYRESULT)
Code Block |
---|
${iftttResult_MYRESULT.id} ${iftttResult_MYRESULT.spaceKey} ${iftttResult_MYRESULT.displayTitle} ... Same can be archived with [iftttResult_MYRESULT.id] [iftttResult_MYRESULT.spaceKey] [iftttResult_MYRESULT.displayTitle] since ConfiForms ] since ConfiForms version 2.11 |
(if result was named "MYRESULT")
If IFTTT macro is set to ignore errors (execute in silent mode, then there might be NO RESULT in the variable, so accessing it with "!", like $!{iftttResult_MYRESULT} is saferAny other property, which Page object provides (any "get" method)
You can create a page based on the template in this IFTTT macro body. You can have a template embedded or you can reference Confluence template with
Code Block |
---|
[template.TEMPLATE_NAME] |
Templates can reference field values using
- [entry.FIELD_NAME] to embed the values statically
- using ConfiForms Field macro to have a dynamic reference to original form, so when the value is changed in the original form then it will get's changed in the page created
You can set your own root page (also dynamically based on the values in your entries, as usual... by referencing via [entry.FIELD_NAME]), you can enable custom permissions on newly created pages
Additional tutorials:
- Using ConfiForms app as template engine to create pages in Confluence
- Advanced integrations with IFTTT macros with ConfiForms
Delete Attachment
Delete ConfiForms Entry
Deletes the ConfiForms entries by a given filter
You can automatically delete entries, and this is done by specifying a filter. When you want to delete just a record created then the filter is by id:
Code Block |
---|
id:[entry.id] |
Important difference (between Creating and Deleting actions) here is the name of the field used to reference entry ID. In filters you need to specify it as "id" and in field parameters you will need to use "entryId"
So, deleting entries happens by filter, more about filters ConfiForms Filters
You will need also to specify explicitly which form to use and where it is located (pageId). See last parameter in Macro editor for ConfiForms IFTTT macro for this action type
Tutorials:
JIRA issues from ConfiForms entries. However, this is a bit technical to setup as the integration is done through the JSON document you will need to prepare. See tutorial below for more details and examples. Important: you must have a correctly configured Application link to JIRA
Also, there are some helpers to help you with preparing correct JSON, see Virtual functions
This action type supports uploading files to created JIRA ticket, an example is also available in the same tutorial.
Important to note that currently this action selects a primary app link to JIRA, if you have more than 1 JIRA connected then you will be able to create JIRA issues only in your primary JIRA (the one set as primary in your application links)
Tutorials:
Creating Jira issue from Confluence with ConfiForms
Warning Definitely use the NoFormat macro to place the JSON mapping inside the IFTTT macro body
Create Page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Creates Confluence page based on the template given (in macro body)
See Creating links in original ConfiForms entry to just created page
Using ConfiForms app as template engine to create pages in Confluence
Warning |
---|
In Confluence the page title should be unique within a Confluence space. ConfiForms will create a new version of the page if the page with given title already exists in the Confluence space specified |
Warning |
---|
Important to note is that if you put ConfiForms Field macros inside the IFTTT macro body and this macros will be WITHOUT a "view" macro around them, then a ListView macro with a filter set to current record is created as a wrapper for ALL the content in the IFTTT macro body. If you want to avoid "auto-wrapping" then you need to make sure that all ConfiForms Field macros you put are within the "view" macro (TableView, ListView, CardView, etc) In contrast, when you use [entry.fieldname] notations then there is no need to wrap anything in views macros. But in this case the data is static data copied (not referenced) there from ConfiForms |
Info | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
All references (like [entry.filed_name]) inside the IFTTT macro body to ConfiForms fields are evaluated against the current record. If you have an IFTTT action to create a page with ConfiForms Form and it should have filters or field rules which in the created page should look like [entry.fieldname] you will need to wrap these into a virtual function
Example:
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
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
|
Excerpt Include | ||||
---|---|---|---|---|
|
macro-body-default-text |
---|
Excerpt Include | ||||
---|---|---|---|---|
|
Page object (page created)
Depending on the IFTTT result name you can access all of the properties available from Page object.
Delete Page
Deletes the page in Confluence
A user must have enough permissions to delete the page
Page object to be deleted
Depending on the IFTTT result name you can access all of the properties available from Page object.
For example (when result name is MYRESULT)
Code Block |
---|
${iftttResult_MYRESULT.id}
${iftttResult_MYRESULT.spaceKey}
${iftttResult_MYRESULT.displayTitle}
...
Same can be archived with
[iftttResult_MYRESULT.id]
[iftttResult_MYRESULT.spaceKey]
[iftttResult_MYRESULT.displayTitle]
since ConfiForms version 2.11 |
Any other property, which Page object provides (any "get" method)
Force Page Re-index
Forces page re-index
Sometimes you want a particular page to be re-indexed when a ConfiForms entry get's created/updated or deleted. This action type helps you to achieve that.
Resolved Page object to re-index
Depending on the IFTTT result name you can access all of the properties available from Page object.
For example (when result name is MYRESULT)
Code Block |
---|
${iftttResult_MYRESULT.id}
${iftttResult_MYRESULT.spaceKey}
${iftttResult_MYRESULT.displayTitle}
...
Same can be archived with
[iftttResult_MYRESULT.id]
[iftttResult_MYRESULT.spaceKey]
[iftttResult_MYRESULT.displayTitle]
since ConfiForms version 2.11 |
Any other property, which Page object provides (any "get" method)
Generate Next Number
Generates (based on the filtering criteria) and sets next number on the configured field
Warning |
---|
On highly concurrent systems this may generate duplicates. We are working on improving this. At the moment this is an experimental functionality |
See quick tutorial on this here: Using generate next number IFTTT rule and Using generate next number IFTTT rule to have sequence numbers per day
NO RESULT
Move Attachment
Moves attachment from one page to another
You should specify the attachment ID to be moved and the page destination it should be moved to. A user must have enough permissions to attach the file to a destination page and enough permissions to read the configured attachment.
Can move multiple attachments in one go, See Virtual functions for "asAttachment" function to see how
Move Page
Moves page from one location to another
A user performing an operation should have enough permissions (to move the page from source location to destination location)
Moved page as object. Any property a Page object has
For example (when result name is MYRESULT)
Code Block |
---|
${iftttResult_MYRESULT.id} ${iftttResult_MYRESULT.spaceKey} ${iftttResult_MYRESULT.displayTitle} ... Same can be archived with [iftttResult_MYRESULT.id] [iftttResult_MYRESULT.spaceKey] [iftttResult_MYRESULT.displayTitle] since ConfiForms version 2.11 |
Any other property, which Page object provides (any "get" method)
Redirect to URL
Redirects to given URL (server side forward if no timeout is given and if timeout is given then via JavaScript)
You can give timeout in a way: url|timeout
(in milliseconds)
Remove Attachment Label
Remove Page Label
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Remove Page Edit Restrictions
You can create a page based on the template in this IFTTT macro body. You can have a template embedded or you can reference Confluence template with
Code Block |
---|
[template.TEMPLATE_NAME] |
Templates can reference field values using
- [entry.FIELD_NAME] to embed the values statically
- using ConfiForms Field macro to have a dynamic reference to original form, so when the value is changed in the original form then it will get's changed in the page created
You can set your own root page (also dynamically based on the values in your entries, as usual... by referencing via [entry.FIELD_NAME]), you can enable custom permissions on newly created pages
Additional tutorials:
- Using ConfiForms app as template engine to create pages in Confluence
- Advanced integrations with IFTTT macros with ConfiForms
Excerpt Include | ||||
---|---|---|---|---|
|
Delete Attachment
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Deletes attachments from Confluence. A user must have enough permissions to delete attachments
Attachment ID could be extracted from a file/attachment field value in ConfiForms as follows - using Virtual functions
(in case of ONE attachment)
Code Block |
---|
[entry.myattachmentfield.asAttachment.id] |
(in case if you field holds links to multiple attachments)
Code Block |
---|
[entry.myattachmentfield.asAttachments.transform(id).asList] |
Also, some user handy macro to see attachment IDs Attachments list
Delete ConfiForms Entry
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Deletes the ConfiForms entries by a given filter
You can automatically delete entries, and this is done by specifying a filter. When you want to delete just a record created then the filter is by id:
Code Block |
---|
id:[entry.id] |
Important difference (between Creating and Deleting actions) here is the name of the field used to reference entry ID. In filters you need to specify it as "id" and in field parameters you will need to use "entryId"
So, deleting entries happens by filter, more about filters ConfiForms Filters
You will need also to specify explicitly which form to use and where it is located (pageId). See last parameter in Macro editor for ConfiForms IFTTT macro for this action type
Tutorials:
Delete Page
Deletes the page in Confluence
A user must have enough permissions to delete the page
Page object to be deleted
Depending on the IFTTT result name you can access all of the properties available from Page object.
For example (when result name is MYRESULT)
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Remove Page View Restrictions
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Remove Page Watcher
Removes page watcher or watchers from the page
Silently ignores if a page does not have a requested watcher to be removed.
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Rename Page
Renames a page
A user performing an operation should have enough permissions to modify the page
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Restrict Page Edit
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Restrict Page View
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>} id} ${iftttResult_MYRESULT.spaceKey} ${iftttResult_MYRESULT.displayTitle} ... Same can be archived with [iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>id] [iftttResult_MYRESULT.spaceKey] [iftttResult_MYRESULT.displayTitle] since ConfiForms version 2.11 |
Render (execute) macro
Renders a contents of it's body and adds the result of a render into a result chain
What render macro renders, as string
Code Block |
---|
${iftttResult_MYRESULT}
Same can be archived with
[iftttResult_MYRESULT]
since ConfiForms version 2.11 |
Run JavaScript
Executes a JavaScript snippet given in the IFTTT macro body
Code snippet is executed in the "init" block
Code Block |
---|
<script type="text/javascript">
AJS.toInit(function() {
...
YOUR CODE WILL BE HERE
...
});
</script>
|
And will be executed on a page load. Administrators could restrict this in ConfiForms general settings!
Any other property, which Page object provides (any "get" method)
Force Page Re-index
Status | ||||
---|---|---|---|---|
|
Forces page re-index
Sometimes you want a particular page to be re-indexed when a ConfiForms entry get's created/updated or deleted. This action type helps you to achieve that.
Resolved Page object to re-index
Depending on the IFTTT result name you can access all of the properties available from Page object.
For example (when result name is MYRESULT)
Code Block |
---|
${iftttResult_MYRESULT.id}
${iftttResult_MYRESULT.spaceKey}
${iftttResult_MYRESULT.displayTitle}
...
Same can be archived with
[iftttResult_MYRESULT.id]
[iftttResult_MYRESULT.spaceKey]
[iftttResult_MYRESULT.displayTitle]
since ConfiForms version 2.11 |
Any other property, which Page object provides (any "get" method)
Generate Next Number
Status | ||||
---|---|---|---|---|
|
Generates (based on the filtering criteria) and sets next number on the configured field
Warning |
---|
On highly concurrent systems this may generate duplicates. We are working on improving this. At the moment this is an experimental functionality |
See quick tutorial on this here: Using generate next number IFTTT rule and Using generate next number IFTTT rule to have sequence numbers per day
NO RESULT
Move Attachment
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Moves attachment from one page to another
You should specify the attachment ID to be moved and the page destination it should be moved to. A user must have enough permissions to attach the file to a destination page and enough permissions to read the configured attachment.
Can move multiple attachments in one go, See Virtual functions for "asAttachment" function to see how
Move Page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Moves page from one location to another
A user performing an operation should have enough permissions (to move the page from source location to destination location)
Moved page as object. Any property a Page object has
For example (when result name is MYRESULT)
macro-body-default-text |
---|
An internal object holding a JavaScript snippet
You can access script value (as text)
Code Block |
---|
${iftttResult_MYRESULT.script}or${iftttResult_MYRESULT}
Same can be archived with
[iftttResult_MYRESULT]
since ConfiForms version 2.11 |
(when IFTTT result is called "MYRESULT")
Send Email
Send email to a recipient or a group of recipients
Each email is sent individually
To add ConfiForms file field to an email as attachment - place ConfiForms Field macro into the IFTTT macro body
Email server configured in your Confluence server is used for sending the emails
Emails sent by ConfiForms are NOT queued and sent immediately (to avoid "bulk" message flags, and sent "individual and personal" direct messages)
Is the template to be used to construct an email message body
See more on Sending an email with attachments from Confluence with ConfiForms app
macro-body-default-text |
---|
NO RESULT (for versions of ConfiForms prior to 1.39.2)
Status | ||||
---|---|---|---|---|
|
The following properties are supported from version 1.39.2
Code Block |
---|
subject
body
recipientsCount |
This means, you can access it with
Code Block |
---|
${iftttResult_MYRESULT.subjectid} ${iftttResult_MYRESULT.bodyspaceKey} ${iftttResult_MYRESULT.recipientsCountdisplayTitle} ... Same can be archived with [iftttResult_MYRESULT.subjectid] [iftttResult_MYRESULT.bodyspaceKey] [iftttResult_MYRESULT.recipientsCount] since ConfiForms version 2.11 |
There is a number of tutorials on using this action type:
- Creating embedded form with ConfiForms to send emails directly from Confluence
- Sending email from Confluence with ConfiForms IFTTT macro conditionally
- Creating embedded form with ConfiForms to send emails directly from Confluence
- Sending an email with attachments from Confluence with ConfiForms app
- Create a form with ConfiForms which sends internal notification but does not keep/store the data
Send Notification
Sends internal notification to a user (or users) in Confluence
Notification will appear in the top-right corner. The message body is configured using the ConfiForms macro body
This action type send internal Confluence notification to the user specified, the notification will be visible in the "workbox", in the right top corner of Confluence toolbar.
Sending this type of notifications is very similar to Sending email, the difference is only in where the notification ends up. And what you can use for notification message body (defined through the ConfiForms IFTTT macro body) - free to use Confluence formatting macros, as they are correctly shown inside the Confluence notifications workbox.
Confluence Notification could be sent only to a registered user (email notification can be sent to any external email address, unless your email server does not support that)
displayTitle]
since ConfiForms version 2.11 |
Any other property, which Page object provides (any "get" method)
Redirect to URL
Status | ||||
---|---|---|---|---|
|
Redirects to given URL (server side forward if no timeout is given and if timeout is given then via JavaScript)
You can give timeout in a way: url|timeout
(in milliseconds)
Remove Attachment Label
Status | ||||
---|---|---|---|---|
|
Remove Page Label
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Remove Page Edit Restrictions
Status | ||||
---|---|---|---|---|
|
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Remove Page View Restrictions
Status | ||||
---|---|---|---|---|
|
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Remove Page Watcher
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Removes page watcher or watchers from the page
Silently ignores if a page does not have a requested watcher to be removed.
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Rename Page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Renames a page
A user performing an operation should have enough permissions to modify the page
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Restrict Page Edit
Status | ||||
---|---|---|---|---|
|
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Restrict Page View
Status | ||||
---|---|---|---|---|
|
Page object, Any property a Page object via
Code Block |
---|
${iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>}
Same can be archived with
[iftttResult_MYRESULT.<PAGE_OBJECT_PROPERTY>]
since ConfiForms version 2.11 |
Render (execute) macro
Status | ||||
---|---|---|---|---|
|
Renders a contents of it's body and adds the result of a render into a result chain
What render macro renders, as string
Code Block |
---|
${iftttResult_MYRESULT}
Same can be archived with
[iftttResult_MYRESULT]
since ConfiForms version 2.11 |
Run JavaScript
Status | ||||
---|---|---|---|---|
|
Executes a JavaScript snippet given in the IFTTT macro body
Code snippet is executed in the "init" block
Code Block |
---|
<script type="text/javascript">
AJS.toInit(function() {
...
YOUR CODE WILL BE HERE
...
});
</script>
|
And will be executed on a page load. Administrators could restrict this in ConfiForms general settings!
JSON mapping wrapped in "No Format" or in "Code" macro to have a raw text
macro-body-default-text |
---|
An internal object holding a JavaScript snippet
You can access script value (as text)
Code Block |
---|
${iftttResult_MYRESULT.script}or${iftttResult_MYRESULT}
Same can be archived with
[iftttResult_MYRESULT]
since ConfiForms version 2.11 |
(when IFTTT result is called "MYRESULT")
Send Email
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Send email to a recipient or a group of recipients
Each email is sent individually
To add ConfiForms file field to an email as attachment - place ConfiForms Field macro into the IFTTT macro body
Email server configured in your Confluence server is used for sending the emails
Emails sent by ConfiForms are NOT queued and sent immediately (to avoid "bulk" message flags, and sent "individual and personal" direct messages)
Is the template to be used to construct an email message body
See more on Sending an email with attachments from Confluence with ConfiForms app
macro-body-default-text |
---|
Excerpt Include | ||||
---|---|---|---|---|
|
NO RESULT (for versions of ConfiForms prior to 1.39.2)
Status | ||||
---|---|---|---|---|
|
The following properties are supported from version 1.39.2
Code Block |
---|
subject
body
recipientsCount |
This means, you can access it with
Code Block |
---|
${iftttResult_MYRESULT.subject}
${iftttResult_MYRESULT.body}
${iftttResult_MYRESULT.recipientsCount}
Same can be archived with
[iftttResult_MYRESULT.subject]
[iftttResult_MYRESULT.body]
[iftttResult_MYRESULT.recipientsCount]
since ConfiForms version 2.11 |
There is a number of tutorials on using this action type:
- Creating embedded form with ConfiForms to send emails directly from Confluence
- Sending email from Confluence with ConfiForms IFTTT macro conditionally
- Creating embedded form with ConfiForms to send emails directly from Confluence
- Sending an email with attachments from Confluence with ConfiForms app
- Create a form with ConfiForms which sends internal notification but does not keep/store the data
Send Notification
Status | ||||
---|---|---|---|---|
|
Sends internal notification to a user (or users) in Confluence
Notification will appear in the top-right corner. The message body is configured using the ConfiForms macro body
This action type send internal Confluence notification to the user specified, the notification will be visible in the "workbox", in the right top corner of Confluence toolbar.
Sending this type of notifications is very similar to Sending email, the difference is only in where the notification ends up. And what you can use for notification message body (defined through the ConfiForms IFTTT macro body) - free to use Confluence formatting macros, as they are correctly shown inside the Confluence notifications workbox.
Confluence Notification could be sent only to a registered user (email notification can be sent to any external email address, unless your email server does not support that)
Excerpt Include | ||||
---|---|---|---|---|
|
macro-body-default-text |
---|
Excerpt Include | ||||
---|---|---|---|---|
|
Set Page Revision
Status | ||||
---|---|---|---|---|
|
Updates page with a revision information (timestamp and version)
Revision is inserted into the page storage and that increases the page version and generates all related events (page modified event, etc)
This comes handy when you have other plugins that rely on the page versioning and could trigger corresponding actions when it's changes
EMPTY
Update Jira Issue
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Updates JIRA issue using given JSON object by calling to https://docs.atlassian.com/software/jira/docs/api/REST/9.2.0/#api/2/issue-editIssue
JIRA issue key must be set as macro parameter, could be looked up dynamically from ConfiForms field
It is a wrapper action to ease the setup of updates to JIRA issue from ConfiForms. Same could be achieved with the help of "Applink service" action
IFTTT macro body should hold a JSON structure to update the JIRA issue (use "No Format" macro to construct JSON structure as-is)
Example:
Another example:
See more on JSON structure the "update JIRA issue" API expects
Excerpt Include | ||||
---|---|---|---|---|
|
macro-body-default-text |
---|
Excerpt Include | ||||
---|---|---|---|---|
|
Issue key as text, accessible directly via result name (for example, if result name is "MYRESULT")
Code Block |
---|
${iftttResult_MYRESULT}
or (see Velocity templates syntax for more on "!" operator)
$!{iftttResult_MYRESULT}
Same can be archived with
[iftttResult_MYRESULT]
since ConfiForms version 2.11 |
Update ConfiForms Entries by Filter
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Updates ConfiForms entries according to the pattern given by filter
Parameters could be set as expressions (similarly to "Create/Update ConfiForms Entry")
Info | ||
---|---|---|
You can also have your values be evaluated as expressions and contain Supported math operators, formulas and functions In this case they should be wrapped in () Example:
|
WebService Request
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Fires a request to a webservice
Some examples on Jira intergation
JSON mapping wrapped in "No Format" or in "Code" macro to have a raw text (when you want to send POST/PUT requests with body)
macro-body-default-text |
---|
Set Page Revision
Updates page with a revision information (timestamp and version)
Revision is inserted into the page storage and that increases the page version and generates all related events (page modified event, etc)
This comes handy when you have other plugins that rely on the page versioning and could trigger corresponding actions when it's changes
EMPTY
Update Jira Issue
Updates JIRA issue
JIRA issue key must be set as macro parameter, could be looked up dynamically from ConfiForms field
It is a wrapper action to ease the setup of updates to JIRA issue from ConfiForms. Same could be achieved with the help of "Applink service" action
IFTTT macro body should hold a JSON structure to update the JIRA issue (use "No Format" macro to construct JSON structure as-is)
Example:
Another example:
See more on JSON structure the "update JIRA issue" API expects
macro-body-default-text |
---|
Issue key as text, accessible directly via result name (for example, if result name is "MYRESULT")
Code Block |
---|
${iftttResult_MYRESULT}
or (see Velocity templates syntax for more on "!" operator)
$!{iftttResult_MYRESULT}
Same can be archived with
[iftttResult_MYRESULT]
since ConfiForms version 2.11 |
Update ConfiForms Entries by Filter
WebService Request
macro-body-default-text |
---|
Excerpt Include | ||||
---|---|---|---|---|
|
Response returned by a call to webservice is accessible directly via result name (for example, if result name is "MYRESULT")
Code Block |
---|
${iftttResult_MYRESULT} Same can be archived with [iftttResult_MYRESULT] since ConfiForms version 2.11 |
...