Activities

Connect to JIRA

This activity connects to the specified JIRA account and outputs a JIRA client connection.

Activity Parameters

The Connect to JIRA activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Base URL (text box editor type) (type: string): enter the URL for the JIRA website. E.g. "https://flowster-solutions.atlassian.net" .
• Password (password editor type) (type: string): the password for the provided username.
• Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the connection. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Portal).
• Username (text box editor type) (type: string): the username for the JIRA account.

The Read Only Output variable are the possible output values that the activity will provide:

• Connection (type: object): outputs an JIRA Connection. This parameter should be used as input for all Connection parameters used for activities placed under JIRA category.

Disconnect from JIRA

This activity disconnects the specified JIRA account. 

Activity Parameters

The Disconnect from JIRA activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Connection (text box editor type) (type: object): the JIRA Connection. The output parameter from Connect To JIRA activity should be used as Input here.
  
  

Create Issue

This activity creates a new issue in JIRA.

Activity Parameters

The Create Issue activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Assignee (text box editor type) (type: string): enter the assignee name. E.g. "D00018" is the username of the JIRA account that the new created workflow will be assigned to.  
• Affects Versions (text box editor type) (type: string): enter the affected versions name. E.g. "4.1,4.2" if you need to insert more than one version.
• Business Value (text box editor type) (type: string): enter the value for Business Value field. E.g. 10.
• Components (text box editor type) (type: string): enter the component name. E.g. "Administrator,Agent" if you need to insert more than one component.
• Description (text box editor type) (type: string): enter the description for the new created JIRA issue.
• Description Formatted (text box editor type) (type: string): the input content to be set as the workflow's description if a binding to a variable is used ($using). If set and if the $using:variable syntax is used, this parameter will take precedence over the Description parameter. For example, the $using:DescriptionString syntax will take the value stored in the DescriptionString variable and will use it as the workflow's description.
• Due Date (text box editor type) (type: string): enter the due date according to the format: "YYYY-MM-DD". E.g. "2016-01-01" .
• Fix Versions (text box editor type) (type: string): enter the fix versions name. E.g. "4.1,4.2" if you need to insert more than one version.
• Issue Type (combo box control) (type: string): select the text value of the issue type. E.g. "New Feature" if the new created issue is a new feature type of JIRA workflow.
• Other (collection editor type) (type: string): specify other required Field IDs if they are not found among specified parameters of this activity. E.g field ID: customfield_10900 for a custom required field in JIRA.
• Project Key (text box editor type) (type: string): enter the project key where the new JIRA issue will be created. Use GetProjects activity to obtain the existing JIRA project keys or input directly the project key value. E.g. "FLOWSTER" for the project key.  
• Reporter (text box editor type) (type: string): enter the reporter account. Note: the user account used to connect to JIRA must have 'Modify Reporter' rights in order to create an issue with a specified reporter.
• Story Points (text box editor type) (type: string): enter the story points for the new issue. E.g. 2.
• Summary (text box editor type) (type: string): enter the summary text (title of the issue) for the new JIRA issue.
• Summary Formatted (text box editor type) (type: string): the input content to be set as the workflow's summary if a binding to a variable is used ($using). If set and if the $using:variable syntax is used, this parameter will take precedence over the Summary parameter. For example, the $using:SummaryString syntax will take the value stored in the SummaryString variable and will use it as the workflow's summary.

A common way to obtain additional information about the parameters required for this activity is provided as helper in this dummy project .

Here you will find the example powershell script of the screenshot below:

$credential = get-credential -Message "Please enter Jira credentials:" 
$BSTR = [System.Runtime.InteropServices.marshal]::SecureStringToBSTR($credential.Password) 
$jPassword = [System.Runtime.InteropServices.marshal]::PtrToStringAuto($BSTR) 
$jLogin = $credential.UserName.TrimStart("\") 
$bytes = [System.Text.Encoding]::UTF8.GetBytes("$jLogin`:$jPassword") 
$encodedCredentials = [System.Convert]::ToBase64String($bytes) 
  
$restapiuri = "https://flowster-solutions.atlassian.net/rest/api/2/issue/createmeta?projectKeys=SA&issuetypeNames=Bug&expand=projects.issuetypes.fields" 
$jsonresponse = Invoke-RestMethod -Uri $restapiuri -Headers @{"Authorization"="Basic $encodedCredentials"} -ContentType application/json -method get #-body $body 
$jsonresponse.projects 
$jsonresponse.projects.issuetypes.fields

The Read Only Output variable are the possible output values that the activity will provide:

• Output Id (type: string): outputs the ID for the new created issue. 
• Output Key (type: string): outputs the Key for the new created issue.

 If you want to display the value of the string output parameters use any logging activity that displays string values. E.g. LogTrackData activity.

Delete User

This activity deletes a specified user account in JIRA.

Activity Parameters

The Delete User activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• User Key (text box editor type) (type: string): enter the user key of the user to be deleted. Use Get User/Create User/ListUsers activities to obtain the JIRA Users keys or input directly the value.  E.g. "demouser" representing the key of the Demo User account. This parameter takes precedence over Username parameter. 
• Username (text box editor type) (type: string): enter the existing username. The username for the user is visible in JIRA website.   

Delete User

This activity deletes a specified user account in JIRA.

Activity Parameters

The Delete User activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• User Key (text box editor type) (type: string): enter the user key of the user to be deleted. Use Get User/Create User/ListUsers activities to obtain the JIRA Users keys or input directly the value.  E.g. "demouser" representing the key of the Demo User account. This parameter takes precedence over Username parameter. 
• Username (text box editor type) (type: string): enter the existing username. The username for the user is visible in JIRA website.   

Edit User

This activity edits a user account in JIRA.

Activity Parameters

The Edit User activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Display Name (text box editor type) (type: string): the new Display Name for the specified user account.
• Email Address (text box editor type) (type: string): the new email address for the specified user account. 
• Existing User Key (text box editor type) (type: string): enter the existing user key. Use Get User/Create User/ListUsers activities to obtain the JIRA Users keys or input directly the value.  E.g. "demouser" representing the key of the Demo User account. This parameter takes precedence over the Existing Username parameter. 
• Existing Username (text box editor type) (type: string): enter the existing username. The username for the user is visible in JIRA website.

The Read Only Output variable are the possible output values that the activity will provide:

• Output Result (type: boolean): outputs the status of the operation. True if succeeded , otherwise False. 

NOTE: the username used to create the connection to the JIRA website must have rights to edit users. (E.g. the user must have Administrative rights)

Get User

This activity retrieves a collection of user information for the existing JIRA account.

Activity Parameters

The Get User activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• User Key (text box editor type) (type: string): enter the user key of the user to be returned. Use Get User/Create User/ListUsers activities to obtain the JIRA Users keys or input directly the value.  E.g. "demouser" representing the key of the Demo User account. This parameter takes precedence over Username parameter. 
• Username (text box editor type) (type: string): enter the existing username. The username for the user is visible in JIRA website.   

The Read Only Output variable are the possible output values that the activity will provide:

• Output (type: collection<string>): outputs a collection of user info.  

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables ( E.g.JIRAConnection variable for 'Connection' property) or input directly in the property field (E.g "Demo User" value for 'Username' property).

Use the following workflow logic as example to iterate through a variable of type collection<collection<string>>. For more information on how to use Custom ForEach activity please check Workflow link.

1. Add a CustomForEach activity of type string to iterate through the UserInfo collection of information.
2. Add in the body of the CustomForEach sequence a logging activity, e.g. LogTrackData to display the string value of the Iterator.

Get Issues

This activity retrieves a collection of issues for the existing JIRA account.

Activity Parameters

The Get Issues activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Assignee (text box editor type) (type: string): enter the assignee name. E.g. return only the issues assigned to "D00012" assignee. 
• Additional Fields (text box editor type) (type: string): enter the additional fields to be added to the returned output values. E.g. "Story Points, Business Value" . 
• Max Results (text box editor type) (type: Int32): the maximum number of results to returned by this activity (note: Because the type of the editor is Int32, the value is inserted without ""). E.g. 20 value used as input.  
• Project Filter (text box editor type) (type: string): enter the project key where the issues will be searched and returned. Use GetProjects activity to obtain the existing JIRA project keys or input directly the project key value. E.g. "FLOWSTER" for the project key.  
• Summary (text box editor type) (type: string): filter returned issues by summary text.

The Read Only Output variable are the possible output values that the activity will provide:

• Output Issues (type: collection<collection<string>>): outputs a collection of issues with all their properties. 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables ( E.g.JIRAConnection variable for 'Connection' property) or input directly in the property field (E.g "FLOWSTER" value for 'Project Filter' property).

Use the following workflow logic as example to iterate through a variable of type collection<collection<string>>. For more information on how to use Custom ForEach activity please check Workflow link.

1. Add a CustomForEach activity of type collection<string> to iterate through the main collection of Issues variable of type collection<collection<string>>.
2. Rename the Iterator to a specific name. E.g. Iterator -> Issue
3. Add inside the Issues - Properties Collection sequence a new CustomForEach activity of type <string> to iterate through each Issue which is the iterator of the main collection.
4. Add in the body of the Display Property sequence a logging activity, e.g. LogTrackData to display the string value of the Iterator.

Get Issue By Id

This activity returns a specific issue based on Id or key.

Activity Parameters

The Get Issue By Id activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Issue Key Or ID (text box editor type) (type: string): enter the key or id for the issue to be deleted. Use Get Issues activity to obtain the existing JIRA issues keys and ids or input directly the value.  E.g. "FLOW-1200" representing the key of the issue to be deleted. This key of the issue is also visible in JIRA website.   

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables ( E.g.IssueKey variable for 'Issue Key Or ID' property) or input directly in the property field. The value stored in IssueKey variable may be the output of Create Issue or Get Issues activities.

The Read Only Output variable are the possible output values that the activity will provide:

• Output Issue (type: collection<string>): outputs all properties of the specified issue. 

Get Projects

This activity retrieves a collection of projects for the existing JIRA account.

Activity Parameters

The Get Projects activity parameters can be provided by manual inserted values or via IN arguments or variables:

The Read Only Output variable are the possible output values that the activity will provide:

• Output Projects (type: collection<collection<string>>): outputs a collection of issues with their properties. 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables ( E.g.JIRAConnection variable for 'Connection' property).

Use the following workflow logic as example to iterate through a variable of type collection<collection<string>>. For more information on how to use Custom ForEach activity please check Workflow link.

1. Add a CustomForEach activity of type collection<string> to iterate through the main collection of Projects variable of type collection<collection<string>>.
2. Rename the Iterator to a specific name. E.g. Iterator -> Project
3. Add inside the Projects - Properties Collection sequence a new CustomForEach activity of type <string> to iterate through each Project which is the iterator of the main collection.
4. Add in the body of the Display Property sequence a logging activity, e.g. LogTrackData to display the string value of the Iterator.

List Users

This activity retrieves a collection of users with their specific infos. 

Activity Parameters

The List Users activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Filter (text box editor type) (type: string): specify a filter for username or email to return filtered users.E.g. "Demo" to return all users that contain in Name or email address value Demo.  

The Read Only Output variable are the possible output values that the activity will provide:

• Output Users (type: collection<collection<string>>): outputs a collection of collections of user info.  

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables ( E.g.JIRAConnection variable for 'Connection' property).

Use the following workflow logic as example to iterate through a variable of type collection<collection<string>>. For more information on how to use Custom ForEach activity please check Workflow link.

1. Add a CustomForEach activity of type collection<string> to iterate through the main collection of ListUsers variable of type collection<collection<string>>.
2. Rename the Iterator to a specific name. E.g. Iterator -> User
3. Add inside the Users - Properties Collection sequence a new CustomForEach activity of type <string> to iterate through each User which is the iterator of the main collection.
4. Add in the body of the Display User sequence a logging activity, e.g. LogTrackData to display the string value of the Iterator.

Resolve Issue

This activity resolves a specified issue in JIRA.

Activity Parameters

The Resolve Issue activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

• Issue Key Or ID (text box editor type) (type: string): enter the key or id for the issue to be resolved. Use Get Issues activity to obtain the existing JIRA issues keys and ids or input directly the value.  E.g. "FLOW-1200" representing the key of the issue to be resolved. This key of the issue is also visible in JIRA website.   
• Resolution (combo box control) (type: string): select the resolution type to be applied to the specified issue. E.g. "Fixed" if you want to close the issue with the resolution Fixed. Regardless of the selected resolution, the issue will appear Closed in JIRA website.