Add a Step to a Single Issue Operation

Create new page

Creates a Confluence page for the current issue from a template.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Select the template that should be used. You can create new templates on the "Manage Templates" page.
  • Parent Page Selection: Select how the parent page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Parent Page" text box. Variables will be replaced.
    • No parent page: Select the target server from the "Server" drop-down menu and enter the space key in the "Space" text box.
  • Existing Page: Select what to do when a page with the same title exists already in the space. Possible options are throwing an error (Fail), skipping creating the page (Skip), updating the existing page in-place (Update in-place) or updating the page and moving it under the selected parent page (Update and move).
  • Create Link: Select if a link to the new page should be added to the Jira issue. If there is already a page with the same title and you selected an option other than "Fail" under "Existing Page", the link will point to the existing page.
  • Save Page ID: Select weather the ID of the new page should be saved in a custom field.
    If you select "Yes", a drop-down menu "Field to Save Page ID" is displayed.

    If there is already a page with the same title and you selected an option other than "Fail" under "Existing Page", the ID of the existing page is saved.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.


Create new blog post

Creates a Confluence blog post for the current issue from a template.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Select the template that should be used. You can create new templates on the "Manage Templates" page.
  • Server: Select the target server.
  • Space: Enter the space key. Variables will be replaced.
  • Create Link: Select if a link to the new blog post should be added to the Jira issue.
  • Save Page ID: Select weather the ID of the new blog post should be saved in a custom field.
    If you select "Yes", a drop-down menu "Field to Save Page ID" is displayed.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Update (overwrite) existing page

Updates respectively overwrites a Confluence page for the current issue from a template.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Select the template that should be used. You can create new templates on the "Manage Templates" page.
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Update field value macros on page

Updates the values of the Jira Field Value macros on the current issue's Confluence page.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Page Title: Enter a new page title. Variables will be replaced. If this is left empty the current page title will be kept.
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Update labels on page

Sets labels on a Confluence page. Existing labels are removed.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Labels: Enter the labels that should be set. Multiple labels can be separated by blank spaces. Variables will be replaced.

    To keep existing labels, add $currentPage.labels.

  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.


Move Page

Moves a Confluence page within a space.

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Parent Page Selection: Select how the new parent page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Parent Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.


Create link to page

Creates a link from the Jira issue to an existing Confluence page.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.


Copy attachments to page

Copies the attachments of the current Jira issue to a Confluence page.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Exclude Old Attachments: Select if want to exclude older versions of attachments with the same name from copying.
  • Name Filter: Optionally enter a regular expression to filter the attachments by their name. 
  • Size Filter: Optionally enter minimum and/or maximum values (in byte) to filter the attachments by their size. Values smaller than 1 are ignored. 
  • Date Filter: Optionally enter minimum and/or maximum dates to filter the attachments by their date. You can use any format that works in a JQL (but no functions), e.g. "-2w" or "2020-03-31 18:00". Invalid values are ignored.
  • Files From Operation Store: Select this option to copy files from the operation storage to a Confluence page.

    The operation store is used to store files (attachments) temporarily during an operation to be used in other steps.

  • Labels: Optionally enter labels that should be set on the attachments. Multiple labels can be separated by blank spaces. Variables will be replaced.

  • File Name: Optionally enter a new name for the file(s). Variables will be replaced. Use $fileName to access the current file name.
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.


Move attachments to page

Moves the attachments of the current Jira issue to a Confluence page.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Exclude Old Attachments: Select if want to exclude older versions of attachments with the same name from moving
  • Name Filter: Optionally enter a regular expression to filter the attachments by their name. 
  • Size Filter: Optionally enter minimum and/or maximum values (in byte) to filter the attachments by their size. Values smaller than 1 are ignored. 
  • Date Filter: Optionally enter minimum and/or maximum dates to filter the attachments by their date. You can use any format that works in a JQL (but no functions), e.g. "-2w" or "2020-03-31 18:00". Invalid values are ignored.
  • Files From Operation Store: Select this option to move files from the operation storage to a Confluence page. The files are removed from the operation store.

    The operation store is used to store files (attachments) temporarily during an operation to be used in other steps.

  • Labels: Optionally enter labels that should be set on the attachments. Multiple labels can be separated by blank spaces. Variables will be replaced.

  • File Name: Optionally enter a new name for the file(s). Variables will be replaced. Use $fileName to access the current file name.
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Preview Links: Select if a link from the Jira issue to the preview in Confluence should be created for each moved attachment.

    Preview links are supported for files with the extensions jpeg, jpg, png, tiff, psd, wmf, emf, ico, icns, doc, docx, ppt, pptx, xls, xlsx, pdf, mp3, mp4.

  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.


Copy attachments from page

Copies the attachments of a Confluence page to the current Jira issue or the operation store.

The operation store is used to store files (attachments) temporarily during an operation to be used in other steps.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Labels Filter: Enter labels to filter the attachments. Multiple labels can be separated by blank spaces. An attachment needs to have all entered labels to be transferred. Variables will be replaced.
  • File Name: Optionally enter a new name for the file(s). Variables will be replaced. Use $fileName to access the current file name.
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Store File: Select whether:

    • to add the file(s) as an attachment to the issue (Save as attachment) or

    • to keep it in the operation storage (Keep in operation storage).

    • In manual synchronous operations you can also let the user download the file(s). 

  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.


Delete attachments from page

Deletes all attachments (or all attachments that contain certain labels) from a Confluence page.



Set page restrictions

Set page restrictions on a Confluence page. Any existing restrictions will be replaced.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • View Users: Enter the users that should be able to view the page.
  • View Groups: Enter the groups that should be able to view the page.
  • Edit Users: Enter the users that should be able to edit the page. For connections using an application link, the executing user is added automatically. For custom connections, the user who makes the call must be added here.
  • Edit Groups: Enter the groups that should be able to edit the page. 
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Add page restrictions

Add page restrictions to a Confluence page.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • View Users: Enter the users that should be able to view the page.
  • View Groups: Enter the groups that should be able to view the page.
  • Edit Users: Enter the users that should be able to edit the page. For connections using an application link, the executing user is added automatically. For custom connections, the user who makes the call must be added here.
  • Edit Groups: Enter the groups that should be able to edit the page. 
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function or event triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Set page property

Sets the property of a page. To delete an existing page property use an empty JSON value.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Key: Enter the key. Variables will be replaced.
  • Enter the JSON value. Use double quotes for a string, e.g. "my value". Variables will be replaced.
  • Page Selection: Select how the page is selected.
    The following options are available:
    • Let the user select the page: The user will be prompted to select a page. (This option is only available if this is the first step and if the operation does not have any post function triggers.)
    • Page of previous step: The page of the previous step in the operation is used. (This option is only available if this is not the first step.)
    • Predefined page: Select the target server from the "Server" drop-down menu and enter the page ID in the "Page" text box. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.



Set field value

Sets the value of a custom field on the current issue. A template for the field value can be defined.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Enter a template that is used to set the field value. Variables will be replaced.
  • Target Field: Select the custom field that should be updated.
  • Variable Target Field: Enter the name or ID of the target field you want to update by the step. The chosen field will take precedence over the above selected Target field. Variables will be replaced.
  • Send Event: Click the checkbox to activate it and send an issue updated event other apps can react to. 
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Create a comment

Creates a new comment on the current issue.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Enter a template that is used to create a new comment. Variables will be replaced.

    If the evaluated comment is empty it wont be created.

  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Create web link

Creates a new web link on the current issue.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • URL: Enter the URL of the link. Use relative URLs for local targets. Variables will be replaced.

    If the evaluated URL is empty no link will be created.

  • Link Title: Enter the link title. Leave empty to use the URL instead. Variables will be replaced.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Set issue property

Sets the property of an issue. To delete an existing issue property use an empty JSON value.



Send Email

Sends an email to Jira users or other email addresses.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Select the template that should be used.
  • Recipients: Enter the recipients for this mail. Variables will be replaced. Use the $recipientCollector variable to add users, groups or roles as recipients.
  • From: Enter the sender for this mail. Use $!project.email for the project sender, leave empty for the system default. Variables will be replaced.
  • Reply To: Enter the reply to for this mail. This can be left empty. Variables will be replaced.
  • Attachments: Select to add attachments to the the email.
  • Files From Operation Store: Select this option to add files from the operation storage as attachment to the email.

    The operation store is used to store files (attachments) temporarily during an operation to be used in other steps.

  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Send web request

Sends a web request (e.g. an HTTP POST) to a target server.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Select the template that should be used. You can create new templates on the "Manage Templates" page.
  • Server: Select the target server.
  • Skip Status Code Validation: Check to skip the validation of the status code if you want to handle responses with a 400 or 500 status code yourself. To also ignore connection problems or the like, use the Ignore option under error handling.  
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Retrieve file using web request

Retrieves a file using a web request (e.g. an HTTP POST) from a target server.

The operation store is used to store files (attachments) temporarily during an operation to be used in other steps.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Select the template that should be used.
  • Server: Select the target server.
  • File Name: Optionally enter a new name for the file. Variables will be replaced. Use $fileName to access the current file name.
  • Store File: Select whether:

    • to add the file(s) as an attachment to the issue (Save as attachment) or

    • to keep it in the operation storage (Keep in operation storage).

    • In manual synchronous operations you can also let the user download the file(s). 

  • Skip Status Code Validation: Check to skip the validation of the status code if you want to handle responses with a 400 or 500 status code yourself. To also ignore connection problems or the like, use the Ignore option under error handling.  
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Create PDF file

Creates a PDF file that can be added to the current issue.

The operation store is used to store files (attachments) temporarily during an operation to be used in other steps.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Select the template that should be used.
  • Store File: Select whether:

    • to add the file(s) as an attachment to the issue (Save as attachment) or

    • to keep it in the operation storage (Keep in operation storage).

    • In manual synchronous operations you can also let the user download the file(s). 

  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Create a text based file

Creates a text file that can be added to the current issue.

The operation store is used to store files (attachments) temporarily during an operation to be used in other steps.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Template: Select the template that should be used.
  • Store File: Select whether:

    • to add the file(s) as an attachment to the issue (Save as attachment) or

    • to keep it in the operation storage (Keep in operation storage).

    • In manual synchronous operations you can also let the user download the file(s). 

  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Create a ZIP file

Creates a ZIP file that can be added to the current issue.

The operation store is used to store files (attachments) temporarily during an operation to be used in other steps.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Attachments: Select this option to include the attachments of the current issue to the ZIP file.
  • Files From Operation Store: Select this option to add the files from the operation storage to the ZIP file.

  • File Name: Enter a new name for the file. Variables will be replaced. 
  • Store File: Select whether:

    • to add the file(s) as an attachment to the issue (Save as attachment) or

    • to keep it in the operation storage (Keep in operation storage).

    • In manual synchronous operations you can also let the user download the file(s). 

  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one. 

Wait

Waits a number of seconds before continuing with the next steps.

When you use this step in combination with the trigger post function or event, you should make the operation asynchronous.

Enter the following information:

  • Name: Enter a name for this step. If left empty, the name of the action will be used as label.
  • Seconds: Enter how long to wait. Valid values are 1 to 10 seconds.
  • Error Handling: Select whether to fail the operation in case of an error within this step (Fail) or to ignore them (Ignore). The default should be Fail, especially if the next step depends on this one.

When done, click Save.
The new step is listed in the "Single Issue Operations" frame in the "Operations" dialog.

To edit a step, click the pencil icon next to the step.

To delete a step, click the trash icon next to the step.

To add another step to the operation, click Add Step.