ing
Activities
- Connect to Connect to JIRA
- Disconnect from JIRA
- Create User
- Create Issue
- Delete User
- Delete Issue
- Edit User
- Get User
- Get Issues
- Get Projects
- List Users
- Resolve Issue
- Update Issue
Connect to JIRA
This activity connects to the specified JIRA account and outputs a JIRA client connection.
Activity Parameters
...
Activities
- Connect to Connect to JIRA
- Disconnect from JIRA
- Create User
- Create Issue
- Delete User
- Delete Issue
- Edit User
- Get User
- Get Issues
- Get Projects
- List Users
- Resolve Issue
- Update Issue
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 task, 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.
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "D00012" for Username property.
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:
...
arguments or variables:
Parameters:
- Connection (text box editor type) (type: stringobject): 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 task, for example Flowster Portal).Username 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): the username for enter the assignee name. E.g. "D00018" is the username of the JIRA account .
...
- that the
...
- Connectionnew created task will be assigned to.
- Affects Versions (text box editor type) (type: objectConnection string): outputs an JIRA Connection. This parameter should be used as input for all Connection parameters used for activities placed under JIRA category.
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables or input directly in the property field. E.g. "D00012" for Username property.
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:
- 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.
- Assignee Components (text box editor type) (type: objectstring): 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:
- 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 assignee name. E.g. "D00018" is the username of the JIRA account that description for the new created task will be assigned to. Affects Versions JIRA issue.
- Description Formatted (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 type) (type: string): the input content to be set as the task'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 task's description.
- Due Date (text box editor type) (type: string): enter the value for Business Value field. E.g. 10. Components due date according to the format: "YYYY-MM-DD". E.g. "2016-01-01" .
- Fix Versions (text box editor type) (type: string): enter the component fix versions name. E.g. "Administrator,Agent4.1,4.2" if you need to insert more than one componentversion.
- Description Issue Type (text combo box editor typecontrol) (type: string): enter the description for select the text value of the issue type. E.g. "New Feature" if the new created JIRA issueissue is a new feature type of JIRA task. Description Formatted
- Other (text box collection editor type) (type: string): the input content to be set as the task'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 task's description.Due Date 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 due date according to the format: "YYYY-MM-DD"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. "2016-01-01" .Fix Versions FLOWSTER" for the project key.
- Story Points (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 controlthe story points for the new issue. E.g. 2.
- Summary (text box editor type) (type: string): select enter the summary text value (title of the issue type. E.g. "New Feature" if ) for the new created issue is a new feature type of JIRA taskJIRA issue.Other
- Summary Formatted (collection text box 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.
- 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 task'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 task's summary.
A common way to obtain additional information about the parameters required for this activity is provided as helper in this dummy project .
View file | ||||
---|---|---|---|---|
|
Here you will find the example powershell script of the screenshot below:
...
- the input content to be set as the task'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 task's summary.
A common way to obtain additional information about the parameters required for this activity is provided as helper in this dummy project .
View file | ||||
---|---|---|---|---|
|
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:
...
If you want to display the value of the string output parameters use any logging activity that displays string values. E.g. LogTrackData activity.
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 Key property).
Create User
This activity creates a new user account in JIRA.
Activity Parameters
The Create 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 Display Name for the new user.
- Email Address (text box editor type) (type: string): the email address for the new user account.
- Name (text box editor type) (type: string): enter the name of the new user account.
- Password (password editor type) (type: string): the password for the new user. If left empty, a random password will be generated and assigned to the new user account.
- Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the new user. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal).
The Read Only Output variable are the possible output values that the activity will provide:
- Output Key (type: string): outputs the key for the new user.
- Output Result (type: boolean): outputs the status of the operation. True if succeeded , otherwise False.
If you want to display the value of the string output parameters use any logging activity that displays string values. E.g. LogTrackData activity.
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 Display Name property).
NOTE: the username used to create the connection to the JIRA website must have rights to create users. (E.g. the user must have Administrative rights)
Delete Issue
This activity deletes a specified issue in JIRA.
Activity Parameters
The Delete 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 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.
NOTE: the username used to create the connection to the JIRA website must have rights to delete issues. (E.g. the user must have Administrative rights)
Delete User
This activity deletes a specified user account in JIRA.
...
- 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.
NOTE: the username used to create the connection to the JIRA website must have rights to delete users. (E.g. the user must have Administrative rights)
Create User
This activity creates a new user account in JIRA.
Activity Parameters
The Create 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 Display Name for the new user.
- Email Address (text box editor type) (type: string): the email address for the new user account.
- Name (text box editor type) (type: string): enter the name of the new user account.
- Password (password editor type) (type: string): the password for the new user. If left empty, a random password will be generated and assigned to the new user account.
- Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the new user. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal).
The Read Only Output variable are the possible output values that the activity will provide:
- Output Key (type: string): outputs the key for the new user.
- Output Result (type: boolean): outputs the status of the operation. True if succeeded , otherwise False.
If you want to display the value of the string output parameters use any logging activity that displays string values. E.g. LogTrackData activity.
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 Display Name property).
NOTE: the username used to create the connection to the JIRA website must have rights to create users. (E.g. the user must have Administrative rights)
Delete Issue
This activity deletes a specified issue in JIRA.
Activity Parameters
The Delete 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 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.
NOTE: the username used to create the connection to the JIRA website must have rights to delete issues. (E.g. the user must have Administrative rights)
Delete User
This activity deletes a specified user account in JIRA.
...
- 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.
...
NOTE: the username used to create the connection to the JIRA website must have rights to delete users. (E.g. the user must have Administrative rights)
...
- Output Result (type: boolean): outputs the status of the operation. True if succeeded , otherwise False.
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables ( E.g.UserKey variable for Existing User Key property) or input directly in the property field ( E.g. "Demo User Edited" value for Display Name property).
...
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)
...
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.
- Add a CustomForEach activity of type string to iterate through the UserInfo collection of information.
- 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.
...
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.
- Add a CustomForEach activity of type collection<string> to iterate through the main collection of Issues variable of type collection<collection<string>>.
- Rename the Iterator to a specific name. E.g. Iterator -> Issue
- 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.
- Add in the body of the Display Property sequence a logging activity, e.g. LogTrackData to display the string value of the Iterator.
Get Projects
This activity retrieves a collection of projects for the existing JIRA account.
...
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:
...
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.
...
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.
...
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.
...
- 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.
...
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. "FLOW-1200" for 'Issue Key Or ID' property).
Update Issue
This activity updates s specified issue in JIRA. Complete only the fields that need update.
Activity Parameters
The Update 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 new assignee for the specified JIRA issue.
- Affects Versions (text box editor type) (type: string): enter the new 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 new value for Business Value field. E.g. 50. .
- Components (text box editor type) (type: string): enter the new component name. E.g. "Administrator,Agent" if you need to insert more than one component.
- Description (text box editor type) (type: string): enter the new description for specified JIRA issue.
- Description Formatted (text box editor type) (type: string): the input content to be set as the task'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 task's description.
- Due Date (text box editor type) (type: string): enter the new due date according to the format: "YYYY-MM-DD". E.g. "2016-01-01" .
- Issue Key Or ID (text box editor type) (type: string): enter the key or id for the issue to be updated. 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 updated. This key of the issue is also visible in JIRA website.
- Issue Type (combo box control) (type: string): select the new text value of the issue type. E.g. "Bug" is the new Issue type of the specified JIRA issue .
- Project Key (text box editor type) (type: string): enter the project key where the specified JIRA belongs. Use GetProjects activity to obtain the existing JIRA project keys or input directly the project key value. E.g. "FLOWSTER" for the project key.
- Story Points (text box editor type) (type: string): enter the new value for Story Points field for the desired issue. E.g. 100.
- Summary (text box editor type) (type: string): enter the new summary text (title of the issue) for the specified JIRA issue.
- Summary Formatted (text box editor type) (type: string): the input content to be set as the task'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 task's summary.
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 Key property).
...