Overview

Batch export helps you incorporate platform-generated enterprise data into your data collection and analysis.

You can snapshot and batch export the following types of data for each client on demand and at scheduled intervals to Amazon AWS S3 and Microsoft Azure Blob Storage:

  • Alert: Each Client alert lists will export into the cloud storage.
  • Audit: Each Client and All Client audit data will export into the cloud storage.
  • Integrations: Each Client / Partner installed integration configuration data will export into the cloud storage.
  • Inventory: Each Client level inventory data will be exported into the cloud storage.
  • Metrics: Each Client level metric data will be exported into the cloud storage.
  • Tickets: Each Client level ticket data will be exported into the cloud storage.
  • Usage: The usage collection data(metering usage data for billing purposes) will be exported at the partner level into the cloud storage.
  • Tenants: User can configure the export at partner level, and it gives the partner details and all client details under the partner.

Navigate to Setup > Export > Batch Export and click Type to see the list of supported batch exports.

bootstrap

Data is exported in JSON format. A list of failed exports is also provided if applicable.

The exported data content depends on the type and frequency of the export schedule, which determines the data items and quantity.

Only a partner can setup a batch export, and a partner can specify different data types by client for export. When a partner uses the API to create an export, the export is created for all clients who have not previously created the same export using the user interface. You can schedule batch exports using the Batch Export API.

The following batch export types for different data types are available:

Export TypeApplicable Data Type(s)Description
SnapshotInventory, Integrations, and TenantsThis data export provides a snapshot view of the data at the instance of export generation into the Amazon S3 bucket folder or Azure Blob storage.
IncrementalAlert, Ticket, Metric, Audit and UsageThe incremental batch export sends the previous three months of data as the first batch export. Subsequent exports are the incremental export of updated records. You can schedule recurring or on-demand data export:
  • On-demand - Export provides a snapshot of the data at the time of the generation of the export.
  • Recurring - Export provides snapshots of the data at the chosen time.
When you request incremental data on demand, the export generates a snapshot of the previous three months.

Metric data export occurs every hour by default and cannot be customized. You can get metric data using the metric APIs.

After exporting the data to the installed integrations you can view the exported data on the platform, AWS S3, and Azure Blob.

Step 1: Select the Batch Export Add-ons

Follow the steps below to enable the Batch Export Add ons:

  1. At the partner level, go to Setup > Accounts > Partners.
  2. Click a Partner Name from the list for which you want to select Batch Exports add-on.
  3. Click Edit.
  4. Click the Add ons tab.
  5. Select the Batch Exports.
  6. Click Save.
bootstrap
bootstrap

Step 2: Install an Export Integration

Integrate with AWS S3 or Azure Blob to export the data to an AWS S3 bucket or an Azure Blob container.

To create an Export integration from the integration section, follow the steps below:

  1. Go to Setup > Integrations > Integrations.
  2. From Available Integrations, go to Exports and then select AWS S3 or Azure blob apps.
  3. Click the Install button.
  4. The Install Integration page will appear, enter the following information and click Install.
    • Name: Name of the integration
    • Upload Logo: Optional logo for the integration.
  5. It will take you to the configuration page, where you need enter the following details:
    • Access Key ID
    • Secret access key
    • Bucket Name
    • Base URI
  6. Click on Save.

When creating a new batch export, this saved integration will be available in the “Export to” drop-down menu in the Batch Export section.

Refer to the following links for more information on how to create AWS S3 bucket storage or Microsoft Azure Blob storage folders:

Step 3: Create a Batch Export

Follow the steps below to create a batch export:

  1. Select Setup > Exports > Batch Export.

  2. From the BATCH EXPORT screen, click the Add + icon.

    bootstrap

  3. Enter the following information:

    PropertyDescription
    NameUnique name of the export.
    TypeType of data to export: Alerts, Audit, Integrations, Inventory, Metrics, Tickets, Tenants, and Usage

    ClientClient for whom the data is exported.
    Schedule
    • On Demand Only generates exports when a request is created or rerun.
    • On-Demand and on Recurring Schedule generates export data when you raise a rerun request and generates an incremental export at scheduled intervals.
    Export toSpecify integration to AWS S3 or Azure Blob.
    Failure Export NotificationIf you enable this option, you will receive a notification if the export fails.
  4. Click Save & Run to apply the export and display export details.

bootstrap

Change in the file name format of the file, see the View Metric Type Batch Export

The above note is only applicable if Type is selected to “Metric” from the dropdown.

View Batch Exports

You can view the configured Batch Export details in Setup> Exports > Batch Export. The BATCH EXPORT list page displays the details of the Batch Export.

bootstrap
AttributeDescription
Batch Export NameName of a batch export
Client NameSelected client name
Last RunTime and date of the last export
Last ExportStatus of the last export:
  • Success
  • Failed
Created ByAuthor
ActionTo export data. The Run Now action is available only for data export with the On Demand Only option.

View Batch Exports on AWS S3

You can view the generated batch exports in an AWS S3 bucket in the corresponding folders. For example, the alerts export is stored in the alerts folder:

View Batch Export in AWS S3

AWS stores the export files in S3 folders in JSON format. The export file name has the following encoding:

Export Name Details
  • (a) schedule of batch export, recurring or on-demand
  • (b) batch export type
  • (c) unique client ID
  • (d) schedule starting timestamp
  • (e) schedule ending timestamp
  • (f) recurring export serial number

View Metric Type Batch Export

You can view the latest file format for AWS S3 metric batch export. The export file name has the following encoding:

Export Name Details

  • (A) schedule of batch export, recurring or on-demand
  • (B) batch export type
  • (C) unique client ID
  • (D) schedule starting timestamp
  • (E) unique id of the file
  • (F) unique timestamp of the file

View Batch Export on Azure Blob

You can view the generated data exports in the Azure Blob container in the corresponding folders:

View Batch Export in Azure Blob

Azure Blob stores the export files in Azure Blob containers in JSON format. The export file name has the encoding shown in the following figure:

Export Name Details
  • (A) schedule of batch export, recurring or on-demand
  • (B) batch export type
  • (C) unique client ID
  • (D) schedule starting timestamp
  • (E) schedule ending timestamp
  • (F) recurring export serial number