Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DTPDEVEL and version DEV

...

TypeThe requirement management system type (JIRA, DTP, etc.).
ServerThe requirement management system URL.
ProjectThe project for which you want to gather requirements.

Flow Configuration

Excerpt

A flow must be set up with the correct server/credentials for the artifact to function properly. In order to demonstrate how to configure the flow, we will use the JIRA example. The flow specifies how to connect to JIRA, including authentication, and how to transform the response into the appropriate format. If you are working with JIRA, you can customize this flow to suit your JIRA implementation. If you are working with a different requirement management system, you can create a similar flow for that system.

Image Modified

  1. Double click the JIRA Query node to open it in the editor.
  2.  Click the edit icon at the Configuration field to edit http-config settings.
     Image Modified
  3. Specify the JIRA server and authentication credentials.
    Image Modified 

...

  1. Click Add

...

  1.  when finished.

By default, the flow limits the queried results to 1000 items. You can change this limit by setting maxResults property of

the

the jql

parameter

 parameter to a greater value in the Endpoint field of the JIRA Query node. 

Image Modified

The

The jql

parameter

 parameter can be customized to add any valid JIRA JQL parameter, but make sure that the JQL parameter value is HTML escaped. To pass the following JQL parameters, for example:

project={{{system.project}}} AND issueType=Story AND fixVersion=1.2.3

where

where {{{system.project}}}

will

 will be automatically replaced by the flow, you need to set the following (after URL encoding):

project%3D{{{system.project}}}%20AND%20issueType%3DStory%20AND%20fixVersion%3D1.2.3

Image Modified
Make sure not to encode {system.project}}}. Use following characters to escape rest of the parameters:

%3DMatches to equal sign (=)
%27Matches to single quote (')_
%20Matches to a space ( )

The Get JIRA Story node transforms the JIRA API response into the expected format.

Image Modified

You can customize the expected payload to suit your JIRA system details. For other systems or custom implementations, use a function node with

a

msg.payload

property

 property using the following format as a guide, as well as an HTTP Request node similar to the one shown above.

Code Block
{
	"system":	// this object should already exist in msg.system from the profile
	{
		"type": "JIRA", // type of the system defined in the profile
		"server": "http://jira.parasoft.com:8720",	// server defined in the profile
		"project": "SDM Platform",	// project defined in the profile
		"url": "http://jira.parasoft.com:8720/browse/"	// needs to be constructed for different systems
	},
   "requirements":	// array of {id ,name} objects
	[ 
		{ "id": "SP-2", "name": "Test requirement 202" }, 
		{ "id": "SP-1", "name": "Test requirement 201" } 
	] 
}
Widget Configuration

This artifact can be used to create two widgets:

...