Skip to main content

Manage data imports

Learn how to manage data imports in Settings.

Prerequisites

To manage data imports, you require the Snow Atlas Administrator role.

To create API integrations for your SaaS imports, you must first create an application registration with the Perform CRUD import operations write permission for SaaS Management. Creating an application registration generates client credentials that you can use to obtain an access token for Snow Atlas APIs. For information, see Application registrations and Authentication with client credentials.

Create data imports

  1. In Settings, under SaaS settings, select Data imports.

  2. Select Create import.

  3. On the General step:

    1. Select a vendor and application.

    2. Select the scope of application data that you want to import into SaaS.

      note

      For data from an Activities import to appear in SaaS, you must configure a Users import for the same vendor and application. If users are not imported, the activity data cannot be shown.

  4. On the File upload step, upload a CSV file that contains user or user activity data.

    tip

    Select Download template to download a CSV template that contains all the fields that are supported by SaaS.

  5. On the Mapping step:

    1. Select the CSV fields that correspond to the relevant system fields. The Unique user identifier and Email address of the user are required.
    2. Optional: To map additional fields from your CSV to the supported system fields, select Add additional field.
    3. Select Preview results to review the first few rows of the mapped data.
  6. On the Upload type step, select either of the two:

  • To only create an import configuration, select Create template only.
  • To create an import configuration and upload the data to SaaS, select Create template and upload data.

Upload additional data

You can manually upload additional data for an existing import configuration. The data you upload must match the vendor, application, and Scope of the existing import configuration.

If you upload user data for an import configuration with the Users scope, all new user records are imported into SaaS, and existing users in SaaS are overwritten if they have matching unique identifiers to the users in the CSV. If you upload activity data for an import configuration with the Activities scope, your CSV must contain records with the most recent activity data for the application user. If another discovery source has captured more recent activity, the activity records in the CSV are not imported into SaaS.

  1. On the Data imports page, select an import configuration from the table.

  2. Select Actions > Upload data.

  3. Browse and choose the CSV file that contains the user or activity data you want to upload, and then select Upload.

Create API integrations

Before creating an API integration, you must first create an application registration to obtain an access token for Snow Atlas APIs. This application registration must have the Perform CRUD import operations write permission for SaaS Management. For more information on creating application registrations, see Manage application registrations.

  1. On the Data imports page, select an import from the table.

  2. Select Actions > API integration.

  3. Request an upload URL to upload your mapped CSV file to Azure blob storage:

    1. In Postman or a REST API tool of your choice, copy and paste the following parameters:
      POST https://{region}.snowsoftware.io/api/saas/import/v1/uploads
      Authorization: Bearer {access_token}
    2. Replace access_token with the access token you obtained for Snow Atlas APIs. The API response returns a pre-signed URL that is valid for four hours, and a file ID:
      {
      expires: 14400,
      fileId: "file-001",
      url: "https://azureblob.io/xyz?token=signed-url"
      }
    3. Copy and save these returned values.
  4. Upload your mapped CSV file for users or activities to Azure blob storage:

    1. In Postman or a REST API tool of your choice, copy and paste the following parameters:
      PUT https://azureblob.io/xyz?token=signed-url
      x-ms-blob-type: BlockBlob

      {path/to/file.csv}
    2. Replace the PUT URL with the URL returned in step 3.
    3. Replace path/to/file with the path to the mapped CSV file.
  5. Create the import task:

    1. In Postman or a REST API tool of your choice, construct a request with the following parameters:
      POST https://{region}.snowsoftware.io/api/saas/import/v1/configs/{configuration-id}/records/import
      Authorization: Bearer {access_token}
      Content-Type: application/json

      { "fileId": "file-xxx" }
      tip

      Copy and paste the request sample provided in the API integration panel for the Create import task step. The {configuration-id} and the fileID are autopopulated with your unique values. The {configuration-id} is also provided at the top of the API integration panel, and the fileID value is returned in the response from step 1 of this procedure.

    2. In your request, replace access_token with the access token you obtained for Snow Atlas APIs.

Important: Once you have created an API integration, you can create a script to automate the API calls described in this procedure so they are placed recurringly. This means that any changes you make to your CSV file locally will be automatically imported into SaaS. Without an automation script, you must manually complete these steps again each time your CSV is updated, or alternatively, follow the procedure to upload additional data.

Delete imports

To erase all data historically imported into SaaS by an import configuration, you must delete both the Users and Activities configurations for the same vendor and application. If one is deleted but not the other, the data from both import configurations remain in SaaS.

  1. On the Data imports page, select an import configuration.
  2. Select Actions > Delete.

Delete user records from import configurations

You can remove individual user records from an existing Users import configuration, without deleting the entire configuration. Deleting a record means the user will no longer appear on the SaaS pages.

  1. In your local environment, open the mapped CSV file with user data for this import configuration.
  2. Set the isDeleted column to true for the user you want to delete from SaaS. If this column is not in your CSV, you can add it.
  3. Once you have updated and saved the CSV, if you do not have an API integration and an automation script set up to automate imports, proceed with the steps to upload additional data.

Troubleshoot imports

On the Data imports page, you can view the Last import status column to check the status of your import configurations.

  • A Success status indicates that all records in the CSV are mapped correctly, and were successfully imported during the last import attempt.
  • A Failed status indicates that no records in the mapped CSV were imported during the last import attempt.
  • A Warning status indicates that some records in the CSV may not be mapped correctly. As long as the required fields (Unique user identifier and Email address of the user) are mapped correctly for a given record, it can still be imported into SaaS, but any additional fields with mapping issues are excluded.

If the Last import column has a Warning status, you can view details about which fields in the CSV are incorrectly mapped.

  1. To expand the relevant import configuration, select the arrow next to it.
  2. Select View warnings next to a Warning badge to see more details.

On the Warning details page, the field values that should be reviewed are displayed in red. In the Warning details column, you can select View details to see an error description for that particular record.