Page tree

Versions Compared

Key

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

Creating a post

...

function template

  1. Log in as a user with the 

...

  1. Jira Administrators global permission.
    Choose 

...

  1. Image Added > Issues. Select Workflows > Post

...

  1. Function Templates to open the Post functions Templates page.
    (info) Tip:

...

  1. Use a Keyboard shortcutg + g + start

...

  1. typing Post Function Templates
  2. Click the Add Template button.

...

  1. The dialog displays the Template's Name and Description fields. 

...

  1. Image Added
  2. Fill in the fields and confirm

...

  1. with the Add button.
    (info) Note that a newly created template is inactive

...

  1. by default.



Panel
borderColor#5db037
titleColorwhite
borderWidth1
titleBGColor#5db037
titleContents:


Excerpt

Table of Contents
maxLevel2
minLevel2
indent25px
stylesquare




Adding Post functions to a Post function Template

...

  1. In order to define your template, you need to add

...

  1. the post functions you've chosen
    Select the Add Post function button to open the list of available post functions to choose from.

...

  1.  Apart from the standard post functions

...

  1. which are always assigned to the workflow, there are some additional ones. Please note that the Workflow PowerBox plugin delivers 15+ post functions. Click on the chosen one and confirm it with the Add button.

...

  1. Image Added
  2. You can always

...

  1. check the order of the post functions execution by using arrows (move up/move down) or delete

...

  1. a selected post function. Some post functions are editable

...

  1. .


Editing a post

...

function template

  1. Log in as a user with the 

...

  1. Jira Administrators global permission.

...

  1. Choose Image Added  > Issues. Select Workflows > Post functions Templates to open the

...

  1. Post Function Templates page.
    (info) Tip:

...

  1. Use a Keyboard shortcutg + g + start typing post function templates
  2. Click the Edit Template button.


Executing a post function template

 Executing a template means nothing more than adding a template to the chosen transition in a workflow. In order to do so you have to:

  1. Log in as a user with the Jira Administrators global permission.

...

  1. Choose Image Added > Issues. Select Workflows > Workflows to open the workflows page.
    (info) Tip: Use a Keyboard shortcutg + g + start typing workflows.
  2. As soon as you have all workflows listed, you have to select one of them and click the Edit button in the Operations section. You will be redirected to the Edit Workflow page where you can see all the transitions which take place.
    Image Added
  3. Click on a selected transition, then choose the Post Functions tab and click Add post function.
  4. From the list of post functions choose the Run Post Function Templates option and confirm it with the Add button.
    Image Added
  5. Choose any previously created predefined template you want and add those parameters to your post function.
  6. Your template will be added to the list of post functions that will be run for this particular transition.
    Image Added


Disabling templates

Once your template is active you can always

...

disable it.

  1. Log in as a user with the JIRA Administrators global permission.
  2. Choose 

...

  1. Image Added > Issues. Select Workflows > Post functions Templates to open the

...

  1. Post Function Templates page.
    (info) Tip:

...

  1. Use a Keyboard shortcutg + g + start typing post functions templates.
  2. Click the Edit Template button.
  3. Click the Disable button.


Post function templates options

Workflow PowerBox allows you to control some not normal situations on the plugin level.

To change the Post Function Templates settings click the cog icon located next to the "Import" option:

Image Added

There are two options available. One is the reaction on executing a disabled template, the second one describes plugin behavior when a non-existing template (e.g. a deleted one) is called in a workflow.

You can choose between two options in each case:

  • Do nothing - your workflow transition will be executed.
  • Throw exception - stop your workflow transition and log an error to the Jira log file.

Image Added


Importing templates

  1. Log in as a user with the 

...

  1. Jira Administrators global permission.

...

  1. Choose Image Added  > Issues. Select Workflows > Post functions Templates to open the

...

  1. Post Function Templates page.
    (info) Tip:

...

  1. Use a Keyboard shortcutg + g + start typing post functions templates.
  2. Click the Import button.
  3. Choose the XML file you want to upload and

...

  1. then accept your choice with the Import button.


Exporting templates

Already created templates can be exported any time to the XML file to your drive. In order to do so:

  1. Log in as a user with the 

...

  1. Jira Administrators global permission.

...

  1. Choose Image Added  > Issues. Select Workflows > Post functions Templates to open the

...

  1. Post Function Templates page.
    (info) Tip:

...

  1. Use a Keyboard shortcutg + g + start typing post functions templates.
  2. Select the template

...

  1. you want to

...

  1. export and click Edit in the Operations section.
  2. As soon as you

...

  1. choose the Export button, your template will be downloaded.