Use Automation to Synchronize Tickets with External Sources
A common use case of automation is to synchronize tickets created in your Brinqa Platform with outside ticketing systems. You can create a ticket in your Brinqa Platform and push its content to Jira or ServiceNow. This article details how to send tickets to your organization's Jira project boards.
1.) Create data integration for Jira Cloud
Before you can synchronize tickets between the Brinqa Platform and your organization's Jira project board, you need to install and use the Jira Cloud connector in a data integration. To do so, follow these steps:
Navigate to Integrations > Connectors.
Locate the Jira Cloud connector and click Install.
Click Use. The Create data integration screen displays.
Fill out the General information.
Title: Provide a title for the data integration. For example, "Jira Cloud."
Connector: The Connector field is filled in with the Jira Cloud connector.
Server: The server to process the data integration. Local server is selected by default for cloud data sources. You can also create your own data servers for on-premise data sources.
Description: Provide a description for the data integration. For example, "Jira Cloud data integration for ticket sync."
Fill out the Connection information for the Jira Cloud connector.
Service URL: Your organization's Jira Cloud URL.
Email: Your company email address. This user must have proper permissions to query, create, and delete issues in your Jira project.
API token: The User API token for your Atlassian account. If you are unsure of your Atlassian API token or do not know how to create one, see the Atlassian Support documentation on how to Manage API tokens for your Atlassian account.
Project key: The key of the Jira project you want to push the Brinqa ticket to. This project key is typically a three or four letter abbreviation of the project name. You can enter multiple project keys separated by commas.
Default issue type: The default issue type when creating new issues. For example, Bug, Task, Improvement, New Feature, and etc.
Leave Page size and Parallel requests as is.
Select Supports issue linking. This enables the action of syncing tickets between your Brinqa Platform and your Jira project board.
Optional: Convert field values from html to wiki markup. Converts html text in markup language.
For Types, choose Vulnerability Ticket.
For Sync Interval, choose how far back you want to sync your data. By default, the beginning of time is selected, which means when the ticket is created in your Brinqa Platform. You can leave this field as is.
If you have completed the fields correctly, the page reloads and you should see the Jira Cloud data integration listed. If you do not see it, click Refresh .
By default, the Jira Cloud data integration runs once per day as part of the data orchestration.
2.) Configure data mapping for Jira Cloud
After creating the Jira Cloud data integration, you need to create a data mapping to map the tickets created in the Brinqa Platform to your Jira project. To do so, follow these steps:
Navigate to Integrations.
Hold your pointer over the Jira Cloud data integration, click the kebab (three vertical dots) menu, and click Mappings.
Fill out the General fields.
Title: Provide a title for the data mapping. For example, "Brinqa to Jira."
Source: The data model containing the data you want to push. Select Vulnerability ticket.
Target: The data model selected for Types in the Jira Cloud data integration. Select Vulnerability ticket.
Click Map attributes. Mapping source attributes to targets lets you match aspects of the Brinqa ticket to the ticket that is pushed to the Jira project board.
Click the desired source attribute, use Search if needed, and then click the target attribute. A line displays linking the mapped attributes. You must map the required targets before you can advance to the next step.
Click Preview to ensure that the source attributes and targets align.
You can create multiple mappings for the same data integration. Different Jira projects may require specific mappings based on the fields of the Jira project.
3.) Create ticket sync automation
You must create an automation to push tickets in your Brinqa Platform to your organization's Jira account. To create tickets for critical vulnerabilities and send them to Jira, follow these steps:
Navigate to Automation.
Fill out the Information fields.
Title: Provide a title for the automation. For example, "Jira Ticket Sync."
Description: Provide a description for the automation. For example, "Sync tickets in Brinqa Platform to Jira."
Type the following Brinqa Query Language (BQL) query to find all critical vulnerabilities in your data:
FIND Vulnerability as v WHERE v.riskRating = "Critical"
Click Test to ensure your query is valid and returns data.
In Actions, select Create vulnerability ticket. More options display.
For Sprint, select the quarter for the tickets to cover. For example, Q1, Q2, Q3, or Q4.
For SLA, select an SLA to be associated with the tickets. For example, Ticket Default SLA (Start time for SLA based on earliest finding first found).
For Grouping, select Type > Name.
Grouping puts the tickets into specific categories so a single ticket is created rather than one ticket for every finding associated with the query.
- For Assignment policy, select Unassigned.
Click Add action and select Push vulnerability tickets. More options display.
- For Data integration mapping, select the mapping created for your project in the configure data mapping for Jira Cloud section.
For Run, choose the method in which the automation runs.
Manual: Manually launch the automation from the Automation page.
Schedule: Specify a schedule for the automation to run (for example, once per day, every day at a specified time).
Orchestration: Set the automation to run as part of the data orchestration
4.) Launch the ticket sync automation
The final step in synchronizing tickets in your Brinqa Platform with your Jira project board is to launch the ticket sync automation. To do so, follow these steps:
Navigate to Automation.
Hold your pointer over the Jira ticket sync automation and click Run.
Click Confirm when prompted.
Navigate to Remediation > All to view the tickets created from the automation.
- You can also navigate to Remediation > Sprints, hold the pointer over the Sprint indicated in step 6 of the create ticket sync automation section, and select Show to view the tickets created from the automation.
Hold your pointer over one of the tickets and click Show to view the details.
Log in to your Jira project board to view the tickets created from the ticket sync automation in your Brinqa Platform.
If your ticket sync automation fails, you can view information on what has caused a step in the automation process to fail. To do so, follow these steps:
Navigate to the Automation page and select the automation you want to view the logs for.
Copy the Transaction ID of the failed automation.
Navigate to Administration on the upper-right corner and under System, select Logs.
Paste the Transaction ID into the search bar and press Enter or Return on your keyboard.
If you click the link in the Message column, you can see what has caused the automation to fail. The error message is included in the Detail section.