clsJiraSQL Step

Use this step to execute Jira JSQL and get JSON result

Last published at: March 13th, 2025

Description:

This step executes Jira JSQL and gets JSON results. 

 

Inputs

  • jiraURL – Jira URL
  • jiraUserName -Jira Username     
  • jiraToken -Jira API Token        
  • jiraProject - Project Name   
  • jiraSQL - Jira SQL    
  • varGlobalToStoreValue - variable/global to store the JSON result      
 

 

Returns

  • True – step executed successfully
  • False - step failed to execute
 

 

Usage:

 

 

Example:

Let’s build and execute the “clsJiraSQLDef” example. 

  • Create a new definition called “clsJiraSQLDef”
  • Select the definition and click the “design” button
  • Drag a “clsJiraSQL” step to the canvas
  • Connect the dots between the start and “clsJiraSQL” step
  • Define a variable/global to store the JSON result after execution
  • Click the "clsJiraSQL" step to configure its "Required" properties. Provide a name to the step. Provide the Jira URL. Provide the Jira user name and the API Token. Provide the Jira project name. Provide the Jira SQL syntax. Provide the variable/global to store the Jira result. Click the Save button. 

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties. The "Send Test Mail" feature is provided to send a test email with the contents configured in the email body to the current (logged-in) user. Click the “Auto Config Choices” button to label the outgoing link connections according to the choice task values configured. 

 

  • Save the process definition, create a new instance, and execute. Render the process instance. Click on the process step to view its properties. The step should fetch the Jira SQL result and store it in the variable/global as JSON. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.

Click here to download the sample file.

 

 

How can we improve this article?

Share additional info and suggestions