Skip to main content

Data Exports

This article details how to get your data out of Brinqa, both manually and through an automated process.

What are data exports?​

Data exports in the Brinqa Platform refer to the process of extracting data into external formats like CSV files. This functionality enables you to share data from Brinqa with stakeholders, perform additional analysis, or integrate with other systems.

Exporting data is essential for organizations that require flexibility in auditing, reporting, and compliance. The Brinqa Platform offers both manual and automated data export options to meet your organization's specific needs and requirements.

Data export limits​

The Brinqa Platform supports a default limit of 500,000 records per export, for both manual and automated exports. Should you need to exceed this limit, please contact your Brinqa Support team for assistance.

Manual data exports​

The Brinqa Platform stores highly sensitive data. Many organizations desire a dedicated role that allows users to view data but not export it outside of the Brinqa Platform. To address this, the Brinqa Platform has designated a Data exporter role to manage user privileges at a more granular level.

The Data exporter role on its own does not provide permissions to data in list views. To access the data, users must be assigned additional roles that grant access to data, such as Administrator, Remediation owner, or Risk owner. For additional information on role permissions, please see the Roles documentation.

Users with the Data exporter or System administrator role can manually export and download list views as a CSV file to share with others, or edit and view in a third-party spreadsheet application. To manually export and download a list view, follow these steps:

  1. Navigate to a list view page. For example, Inventory > All assets.

  2. Click Export export arrow icon. A new window appears.

  3. Enter a name for the export.

  4. For Include, select either Displayed attributes or All exportable attributes.

    • Displayed attributes: This option includes only those attributes that are currently visible in your list view. If you have customized your list view to show specific attributes, only these will be included in the export.

    • All exportable attributes: This option includes all attributes that can be exported for the items in your list view, regardless of whether they are currently visible in your list view or not. This option is useful when you want a comprehensive export of all available data. This option might result in a larger CSV file, depending on the number of attributes available.

  5. Click Export. The following message appears on the lower-left corner: "Data will be generated and it will be available on the Export page."

  6. To download the export, navigate to Account account menu icon > Exports. You will also receive an email that contains a link to download the export.

    On the exports page, there are four statuses associated with your exports:

    • Ready: The export process is complete, and the file is ready for download. The data in the list view has been successfully exported and converted into a CSV file.

    • Processing: The export is currently in progress. The data from the list view is being processed and converted into a CSV file.

    • Scheduled: The export has been queued and is scheduled to run.

    • Failed: There was an error during the export process and it could not be completed successfully.

  7. Click the name of the export. A new page appears.

    • You can also hold your pointer over the entry in the list view and click Download. The CSV file downloads directly to your local storage.

  8. Click Download. The CSV file downloads directly to your local storage.

info

Exports remain available for download for 2 days after they are generated. After this period, the export expires, and a new export must be generated.

Automated data exports​

Users with the Configurator or System Administrator role can create an automation to export data as a CSV file.

IMPORTANT

Automated data exports do not adhere to recipient-specific access controls. Instead, the data being shared reflects the access level of the user configuring the export (Configurator or System Administrator). Verify the data before proceeding.

To create an automation for scheduled data exports, follow these steps:

  1. Navigate to Automation.

  2. Click Create Create button.

  3. Provide a title and description for the automation.

  4. Provide a BQL query that defines the data you want to export.

    For example, to create an automated data export for active and critical vulnerabilities, your BQL query might be:

    FIND Vulnerability AS v WHERE v.status = "Confirmed active" AND v.riskRating = "Critical"

    Click Test to check if your query is valid and returns the expected data.

  5. Click the Select an action drop-down, then search for and select the Create dataset export option. More options appear.

    • Export name: Provide a name for the export.

    • Default app: Click the drop-down and select Cyber Risk.

    • Columns: Click the drop-down and select the columns (attributes) you want to retrieve for the given data model specified in the BQL query. The attributes represent the columns in the exported CSV file.

      note

      You must click the Test button for the BQL query in step 4 before you can select any columns.

    • Users: Click the drop-down and select the specific users who will receive an email notification about the completed export and can download the export. Only users with the System administrator role appear in the list of available users.

  6. Specify the method in which the automation runs. You can only select one of the following options:

    • Manual: Manually run 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 and time zone).

    • Orchestration: Set the automation to run as part of the data orchestration and select the stage in which the automation runs. For a full breakdown of why and when you might need to select one of these options, see the Run section of the Create an automation documentation.

  7. Click Create.

Your new data export automation displays in the list view of the Automations page.

Once the automation runs successfully, the users specified in the automation configuration receive an email notification with a link to download the export.

info

Exports remain available for download for 2 days after they are generated. After this period, the export expires, and a new export must be generated.

Last updated on