Add a Step to an Operation

To add a step to an newly created operation, click Add Step next to the operation on the "Manage Operations" page.

The "Add Step" dialog is displayed.

The input parameters for the step depend on the selected action. The following actions are available:

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 parent 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 "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. 

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 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 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.
  • Page Title: Optionally 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 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.
  • 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. 

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

    The user who makes the call (the one configured in the remote server) 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 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.

    The user who makes the call (the one configured in the remote server) 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 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. 



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. You can create a new server on the "Manage Servers" page.
  • 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.

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.
  • File Name: Optionally enter a new name for the file. Variables will be replaced. Use $fileName to access the current file name.
  • Server: Select the target server.

  • 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).

  • 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 new PDF file that can be added to 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: Select the template that should be used. You can create new templates on the "Manage Templates" page.

  • 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).

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

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.

  • 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).

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

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.