Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


UI Text Box
sizemedium
typeinfo
JWT offers the Execute remote action post function to execute predefined or custom actions not only locally on the current Jira environment, but also on any other web service using JSON.


Configuration

The post function offers two types of configuration. In the default view you can choose between predefined and directly usable action templates. In the expert mode, actions can be freely defined and configured.

UI Tabs


UI Tab
titleWizard


UI Text Box
sizemedium
typeinfo

The wizard is the default configuration view of the Execute remote post function. It was built to enable an easy and efficient configuration of common use cases. For those use cases, action templates are shipped with the app, which can be configured in a three-step approach.


UI Text Box
typetip
You can switch at any time to the Expert mode, where the configuration so far is taken over, using the Expert mode button on the top. Be aware that once you change something in expert mode, you cannot switch back.



UI Steps

Create remote action

UI Step

Select action

At the very beginning, you need to choose an action template that suits your purpose. You can filter those templates by the target service and search across all provided ones. After selecting one, click next to get to the next step. 


UI Step

Select connection

After selecting an action template, you need to choose the remote service, the action shall get executed against. If you have selected an action template that fits to the target platform, you can select next to your custom connection, the current instance additionally.

If you cannot find a connection that fits, you can easily configure a new one

After selecting one, click next to get to the next step. 


UI Step

Customize your action

In the last step, you can finish your configuration by setting all the required action template parameters using the set value link next to the parameter name. Some templates have optional parameters that can be chosen using the "Add parameter" action.

Each parameter can be set either by selecting a Jira field that contains an according value or by setting a custom value using the "set value manually option" and passing a parser expression (tick)

Besides setting the action parameters, you can also configure fields to be updated after the action has been executed. If provided in the action template, you can set a field using a dedicated part of the remote service's response. In every case, you can store the complete response and the status code of the remote service after executing the action.

After setting the action parameters and optionally storing the service response, you can click "Add" to store the post function in your transition.




UI Tab
titleExpert mode


UI Text Box
sizemedium
typeinfo

The expert mode allows you to act as an expert in many other complex directions and possibilities! You can create your own actions, connections and extend the already created actions!

Basic configuration

Here you can define the core parts for setting up the communication with the external service. For this, you need the following:

UI Expand
titleAction

Within the action parameter you can either choose an existing custom action or create a new one. Additionally, you can select and use any action template known from the Wizard configuration.
An action is composed of:

  • Method
  • REST path
  • Parameters
  • Action body


Learn more about how to create a custom action!


UI Expand
titleConnection

Within the connection parameter, you can choose or define, where your action get executed against. You can either use the default connection configured in the selected action or override it with a different one. Learn more about creating new connections.



UI Text Box
typetip

You can use a connection for many actions.

Customize action


UI Expand
titleParameters


UI Text Box
typenote

You can only query parameters


OptionDescription
NameA proper name to describe the parameter
ValueYou can choose between:
  • Get field value from current issue
  • Set field value manually (by passing a parser expression (tick))
UI Expand
titleCustom headers

You can edit the custom headers from the selected connection, as well as remove or add new headers.

UI Expand
titleFields


UI Text Box
typenote

Please note that only web services providing JSON are currently supported. To easily navigate in JSON structures, you can use the JMESPath.


OptionDescription
Action template specific Most action templates provide action-specific options to access attributes out of the action body quickly.
Response bodyChoose if you want to get the whole body of the response.
Response statusChoose if you want to get only the status of the response.
Set field value manually (parser expression)

Select the field to copy from using an expression. 

Include Page
DECADIS:_snip_generic_expression_editor
DECADIS:_snip_generic_expression_editor




UI Expand
titleAdditional options
  • Send email notification: Notification will be sent according to the associated notification scheme.
  • Update issues immediately: Choose if you want Jira to fire a separate "Issue updated" event for any field change.  This will also result in a dedicated issue history entry.
UI Text Box
typeinfo

By default, all the additional options are disabled.



UI Expand
iconfalse
titleConditional execution

Include Page
DECADIS:_snip_condExecution_Server
DECADIS:_snip_condExecution_Server


UI Expand
iconfalse
titleRun as

Include Page
DECADIS:_snip_runAs_Server_postFunction
DECADIS:_snip_runAs_Server_postFunction





Use cases and examples

Page properties report
firstcolumnUse case
headingsJWT feature, Workflow function, Parser functions, Label
sortByTitle
cqllabel = "remote-action" and space = currentSpace()


Excerpt Include
DECADIS:Contact support
DECADIS:Contact support
nopaneltrue


Page properties
hiddentrue


Tech review

Status
colourGreen
titledone

Style guide

Status
colourGreen
titledone

Status
titletodo
Status
colourYellow
titleReady for review
Status
colourGreen
titledone
Status
colourRed
titleflagged