Description:

This step executes a Jira Query Language (JQL/JSQL) query against a Jira instance.

The Execute Jira JSQL workflow step connects to a Jira server using the configured Jira URL, user credentials, and API token, executes the specified JQL/JSQL query against the selected project, retrieves the matching issues, and stores the complete JSON response in a FlowWright Variable or Global Variable.

This step provides an efficient way to integrate FlowWright workflows with Jira, enabling automated issue retrieval, project reporting, DevOps automation, release management, incident tracking, and business process automation.

The returned JSON can be parsed by subsequent workflow steps to extract issue information, status, assignees, priorities, due dates, comments, custom fields, and other Jira metadata.

The step supports:

• Jira server connectivity
• Jira API authentication
• JQL/JSQL query execution
• Project-specific issue searches
• JSON result retrieval
• Storage of JSON in Variables or Global Variables
• Integration with FlowWright workflow automation

This step can be used for:

• Issue tracking
• Release reporting
• Sprint monitoring
• DevOps automation
• Incident management
• Project dashboards
• Business process automation

Usage:

The Execute Jira JSQL step is typically placed before reporting, issue synchronization, approval workflows, dashboard generation, or DevOps automation activities.

The workflow connects to the Jira server, authenticates with the supplied credentials, executes the specified JQL/JSQL query, stores the resulting JSON, and makes the data available for subsequent workflow processing.

A typical workflow might look like this:

Once the JSON response has been retrieved, later workflow steps can:

• Parse issue information
• Generate management reports
• Create dashboards
• Send notifications
• Synchronize external systems
• Update workflow variables
• Continue workflow execution

The Jira server must be accessible before this step is executed.

Example:

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

• Create a new process definition named “clsJiraSQLDef” and open it in designer mode. 
• Drag a “clsJiraSQL” step to the canvas.
• Connect the dots between the “Start” and “clsJiraSQL” steps, as shown above. 
• Define a variable or a global to store the JSON result.
• Click the "clsJiraSQL" step to configure its "Required" properties. Provide a name for the step. Provide the Jira URL. Provide the Jira username and API token. Provide the Jira project name. Provide the Jira SQL syntax. Provide the variable or global reference to store the Jira result. Click the Save button. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

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

• Save the Process Definition. Create a new Process Instance and execute it. When the workflow reaches the Execute Jira JSQL step, FlowWright connects to the specified Jira server, authenticates using the configured credentials, executes the supplied JQL/JSQL query against the selected project, retrieves the matching issues, and stores the returned JSON in the configured Variable or Global Variable. If the operation completes successfully, the workflow follows the True return path. If the Jira server cannot be reached, authentication fails, the JQL/JSQL query is invalid, or the requested data cannot be retrieved, the workflow follows the False return path. Click the process step to view its properties. The step should successfully retrieve the matching Jira issues, populate the configured Variable or Global Variable with the returned JSON, and return True upon completion.

Tips:

• Verify that the Jira URL is accessible from the FlowWright server.
• Use a Jira API token instead of a password whenever possible.
• Ensure that the configured Jira account has permission to access the selected project.
• Test JQL/JSQL queries in Jira before using them in a workflow.
• Store the JSON response in a Global Variable when multiple workflow steps need access to the returned data.
• Use JSONPath or JSONPathToList workflow steps to extract individual values from the returned JSON.
• Use the True and False return paths to implement appropriate success and exception handling.
• Combine this step with JSONPathToList, Convert JSON to XML, REST Call, Send Email, Generate Report, or Conditional Routing workflow steps to automate Jira reporting and DevOps workflows.

Notes:

• The Jira server must be reachable from the FlowWright server.
• A valid Jira user account and API token are required for authentication.
• The configured account must have permission to query the specified project.
• The returned JSON contains all issue data provided by the Jira REST API for the executed query.
• Invalid credentials, malformed JQL/JSQL queries, insufficient permissions, or network connectivity issues may cause the step to return False.
• This step retrieves issue information only and does not create, modify, or delete Jira issues.
• The workflow should include appropriate handling for both True and False return paths.
• The JSON response can be reused by downstream workflow steps for reporting, analytics, integrations, or additional business processing.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition page.

Note: Verify and complete any missing configuration after importing the sample, including:

• Jira URL
• Jira Username
• Jira API Token
• Project Name
• JQL/JSQL query
• JSON Variable or Global Variable mapping
• Network connectivity
• Environment-specific settings

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.