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

Compare with Current View Page History

« Previous Version 27 Next »

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 services 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.

(Icon to be changed) 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.

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.

Create remote action

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. 

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.

How to create a connection

Head over to your Jira's administration (cogwheel) and click on Manage apps.

On the side bar, under Jira Workflow ToolboxConnector

Click on the Connection tab, then click on Add connection

In the popup window, give the connection a proper name, choose your connection type with the authentication and click on create.

You can also create a new connection directly in the select connection step, by clicking on + Create connection.

After selecting one, click next to get to the next 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.

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:

Action

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
  • REST body
How to create an action
Actions and connections have a "one-to-many" relationship, i.e. one connection can be used by many actions.

Head over to your Jira's administration (cogwheel) and click on Manage apps.

On the side bar, under Jira Workflow ToolboxConnector

Click on Add action


In the popup window:

Give the action a proper name

Choose the method of the action; POST, GET, PUT, DELETE.

Choose the default connection for this action and its REST path.

Additionally, you can add query parameters and body data 

Body data is required for a PUT method.

Click on create

This can also be done directly from the post function configuration.

Connection

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.

How to create a connection

Head over to your Jira's administration (cogwheel) and click on Manage apps.

On the side bar, under Jira Workflow ToolboxConnector

Click on the Connection tab, then click on Add connection

In the popup window, give the connection a proper name, choose your connection type with the authentication and click on create.

You can also create a new connection directly in the select connection step, by clicking on +Create connection.

You can use a connection for many actions.

Customize


Parameters

You can only add query parameters UM: I don't get it - I can also add Path parameters (maybe we have only to change the wording here)?

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))
Fields
OptionDescription
Action template specific what does that mean?? For me (UM) it seems sth to be included in the header?
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. 

Learn more about the possibilities of the JWT expression editor.

Additional 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.

By default, all the additional options are disabled.

Conditional execution

You can optionally specify a logical expression to define the circumstances (or conditions) under which the post function should be executed.

The result of the logical expression must return a boolean value of either:

  • true → the post function will be executed
  • false → the post function will not be executed

Using the conditional operator, even complex or multi-layered conditions can be constructed.

Make sure to learn more about defining logical expressions and browse through the various examples here: Logical mode

Run as

Select which user will be used to execute this post function. By default this parameter is set to the current user. You can also use field codes to run the function as a dynamic user (e.g. current assignee).

Make sure that the user running the post function has all the relevant permissions to perform the actions defined in the configuration (e.g. "Update Issues")!

If you want to keep track the actions being performed automatically, we suggest to create a dedicated JWT account, granted all relevant permissions, and use it in the Run as parameter to identify which changes have been made with JWT.



If you still have questions, feel free to refer to our support team.