Skip to main content
Gainsight Inc.

File Analyzer Admin Guide

Gainsight NXT

This article supports Gainsight NXT, the next evolution of the Customer Success platform. If you are using Gainsight CS Salesforce Edition, you can find supporting documentation by visiting the home page, and selecting CS > Salesforce Edition.

Not sure what your team is using? Click here.

 

IMPORTANT - Articles Impacted due to 6.34 October NXT Release

Due to the v6.34 October, 2022 release, this article has been impacted. Steps, images, and playable GIFs in this article will soon be updated to reflect the latest changes.

For more information about the latest UI changes, click here.

 

Overview

Admins can use the File Analyzer to scan any CSV/TSV file to identify the root cause of any upload issues the file might have. After uploading a file to Gainsight, you can use this feature to assess any records that might have failed the upload. You can also use this feature to proactively identify these issues and resolve them before ingesting the data into Gainsight.

To access the File Analyzer, navigate to Administration > Analyzer > File Analyzer

The File Analyzer has the following subtabs:

  • Scan (Beta): Here you can upload CSV/TSV files to scan them.
  • Scan History: Displays a list of each scan completed by the File Analyzer.

Limitations:

  • Only CSV/TSV file formats are supported.
  • The File Analyzer supports uploaded files that are less than 10 MB and S3 files that are less than 100 MB.
  • Uploaded files should contain headers.
  • Compressed and Encrypted files are not supported.
  • Files uploaded to the analyzer, and any generated error files will be stored in your S3 bucket for 30 days and will be deleted after this time.

Scan (Beta)

Under the Scan tab, admins can upload CSV/TSV files to scan them for potential upload issues. Take the following steps to complete a file scan:

  1. Select the type of data you want to analyze. The dataset you select will determine how File Analyzer validates the data. For the purposes of this tutorial, we’ll be selecting the Company dataset. You can select the following types of datasets for analysis
  • User: When you select this dataset option, the File Analyzer will validate the data you upload against the Gainsight Standard User object.
  • Company: When you select this dataset option, the File Analyzer will validate the data you upload against the Gainsight Standard Company object.
  •  People: When you select this dataset option, the File Analyzer will validate the data you upload against the Gainsight Standard Person object
  • Relationship: When you select this dataset option, the File Analyzer will validate the data you upload against the Gainsight Standard Relationship object.
  • Custom Object: When you select this dataset option, the File Analyzer will validate the data you upload against an existing MDA custom object that you select.
  • Generic File: When you select this dataset option, the File Analyzer will validate the data you upload irrespective of data type.

6.10 File Analyzer Choose Dataset.png

  1. Click Next.
  2. Upload your file for analysis either directly from your local machine, or from an S3 Bucket. Use the following tools to configure your file upload method:

6.10 File Analyzer upload file screen breakdown.jpg

  1. Click SELECT to upload a file directly from your local machine.
  2. Click SELECT to read a file from an S3 Bucket. Selecting this option displays the S3 File Configuration section which you must fill out before proceeding. For more information on S3 File Configuration, refer to Gainsight S3 Connector under Additional Resources.

6.10 File Analyzer S3 File Configuration.png

  1. Click to configure the following Advanced Attributes for either upload option:
  • Character Encoding
  • Separator
  • Escape Character
  • Quote Character
  • Header Line
  • Multi select separator

6.10 File Analyzer Expand Advanced Attributes.gif

  1. Click the Eye icon to preview the Data Model you selected. Click the Download icon to download the preview as a CSV. 
    Note: This option is not available for the Custom Object and Generic File datasets.

6.10 File Analyzer Upload file preview download data model.gif

  1. Click the Download icon to download a sample file for the selected Data Model as a CSV. 
    Note: This option is not available for the Custom Object and Generic File datasets.

6.10 File Analyzer Download Sample File.gif

  1. Click Next
  2. Map key identifiers/required fields based on the dataset you selected. For more information on the specific mappings required for each dataset, refer to Dataset Key Identifiers. For our tutorial, we’ll need to make the following selections for the Company Data Model:
  • A field from both the Source File and Company Object to identify each Company record.
  • A field from the Source File to identify the name of each company record.

6.10 File Analyzer Company Key Identifiers.gif

  1. Expand the additional fields section and map any remaining Source Fields to Target Fields. By default, the Ignore Field option will be selected for all field mappings. Source fields with the Ignore Field selection will not be considered for validation.

6.10 File Analyzer expand additonal fields section.gif

  1. (Optional) Click AUTO MAP to instantly map each source field to a target field with an identical name.
  2. Manually map any remaining fields.

6.10 file analyzer auto map fields.gif

  1. (Optional) Select the mapping option New Field for source fields that you would like to add to the target object. You can configure the data type for the new field after selecting this option.

6.10 File Analyzer New Field.gif

  1. (Optional) Click the checkbox under the Required column for any field you wish the File Analyzer to consider Required. When the file is scanned, the File Analyzer will check for null values in required fields for each record.
    Note: The Key Identifier fields for each data set will always be considered required.

6.10 File Analyzer Required Checkbox.gif

  1. (Optional) Click the checkbox under the Lookup Details column to add lookup details between the field and a field in another object. For fields with added lookup details, the File Analyzer validates the data of each field for existence in the looked up object.

6.10 File Analyzer Lookup Details Checkbox.gif

  1. Click Next
  2. Review the scan points selected for file analysis. By default, all scan points will be checked, and the points Columns count mismatch, Duplicate key identifiers, and Null values on Key Identifiers can not be unchecked. For more information on scan points, refer to Scan Points.

6.10 File Analyzer Submit for Validation.jpg

  1. Enter one or more valid email addresses, separated by commas, to send a copy of the analysis results.
  2. Click SUBMIT to initiate the file validation process.

6.10 File Analyzer Click Submit.jpg

Dataset Key Identifiers

Each dataset has different required mappings you must complete in the Select Key Identifiers step. These mappings are defined below:

User

For the User dataset, you need to map fields from the source object to the following key identifiers:

  • User Name (Required)
  • User Type (Required)
  • First Name
  • Last Name

6.10 File Analyzer User datatype key identifiers.gif

Company

For the Company dataset, you need to map fields from the source object to the following key identifiers:

  • Account/Company ID (Required)
  • Account/Company Name (Required)

6.10 File Analyzer Company Key Identifiers.gifPerson

For the Person dataset, you need to map fields from the source object to the following key identifiers:

  • Person Email (Required)
  • Person Name

6.10 File Analyzer Person Key Identifiers.gif

Relationship

For the Relationship dataset, you need to map fields from the source object to the following key identifiers:

  • Relationship ID (Required)
  • Account/Company ID (Required)
  • Relationship Name (Required)

6.10 File Analyzer Relationship Key Identifiers.gifCustom Object

For the Custom Object dataset, you need to map fields from the source object to the following key identifiers:

  • Target Object (Required)
  • Account/Company ID (Required)

6.10 File Analyzer Custom Object Key Identifiers.gifGeneric File

For the Generic File dataset, you have the ability to select any field from the source object as a Key Identifier by checking the Key Identifier checkbox.

6.10 File Analyzer Generic File Key Identifiers.gif

Scan Points

The File Analyzer scans uploaded datasets for the following scan points. Each scan point covers common potential reasons for file upload errors.

Columns count mismatch

This scan point validates if the number of columns for a record matches with the total number of headers.

Duplicate key identifiers

This scan point validates if there are any duplicate records in the key identifiers column combination.

Null values on Key Identifiers

This scan point validates if a record has null values in fields marked as key identifiers.

Duplicate rows in file

This scan point validates if there are any duplicate records.

Data type doesn’t match with the expected data type.

This scan point validates if the column data type matches with the original data type selected by the user.

Null records in required column

This scan point validates if a column marked as required has null values.

Have invalid lookup values

This scan point validates if the data in a lookup column exists in the parent object’s looked up field.

Duplicates on Name field

This scan point validates if rows have duplicate values on the “Name” field.

Scan History

The Scan History Data table contains an entry for every file scan completed within the org and displays the following fields:

  • Triggered By: The user who completed the scan.
  • Triggered Date: The date/time the scan was completed.
  • Scan Type: The file upload method used to complete the scan.
  • File Name: The name of the uploaded file.
  • Result: The completion status of the file’s analysis

6.9 NXT File Analyzer Scan History.jpgYou can take the following actions in the Scan History tab:

  1. Refresh: Reload the table with the latest scan history data.
  2. View Details: Click to view the results of the scanned file analysis. For more information on scan results, refer to Scan Results.
  3. PROCESSING: The file is still being scanned and the results are not ready to be viewed.

Scan Results

You can view the results of any scan completed by the File Analyzer. To view these results, navigate to the Scan History tab and click View details for the results you wish to view. This will open the scan results page.

6.10 File Analyzer Scan Results Breakdown.png

  1. Navigate Back: Click here to navigate back to the Scan History page.
  2. File Scan Dashboard: This displays a summary of the scanned file including the number of Total Rows, Invalid Rows, Errors, and Warnings.
  3. Download Error File: Click here to download the scan’s error file as a CSV.
  4. Scan Points: Each scan point the File Analyzer identified in its scan will be listed here. You can click each scan point to expand it and view more details.

6.10 File Analyzer Expand Scan Point.gif

Additional Resources

  • Was this article helpful?