Skip to main content

​
Bulk Import, Export, and Edit Test Cases

You can manage test cases in bulk using CSV files, the same way you can with data assets, instead of creating or updating them one at a time through the UI:
  • Import: Create or update test cases by uploading a CSV file.
  • Export: Download your test cases as a CSV file, to edit offline or use as a template.
  • Edit: Update several existing test cases at once from an inline spreadsheet grid, without preparing a CSV file yourself.
You can use all three at three different scopes:
  • Table: Only the test cases defined on a single table.
  • Test Suite: All test cases that belong to a test suite.
  • Platform-wide: Every test case in your Collate instance.

​
Permissions

  • Import and Bulk Edit require the EditAll permission on the table, test suite, or platform, depending on scope.
  • Export requires the ViewAll permission at the same scope.

​
Where to Find Import, Export, and Bulk Edit

The Import, Export, and Bulk Edit actions are available from the ⋮ menu in three places:
  • The Data Observability tab of a table, scoped to that table’s test cases.
  • A Data Quality > Test Suite details page, scoped to that test suite’s test cases.
  • The platform-wide Data Quality > Test Cases list, scoped to all test cases.

​
CSV Field Reference

Whether you’re editing an exported file, building a new CSV from scratch, or using Bulk Edit’s inline grid, each row represents one test case and uses the following columns, in order:
  • name (required): The name of the test case, for example table_row_count_to_be_between.
  • displayName: The display name of the test case.
  • description: A description of the test case, in Markdown format.
  • testDefinition (required): The fully qualified name of the test definition to run, for example tableRowCountToBeBetween or columnValuesToBeUnique.
  • entityFQN (required): The fully qualified name of the entity being tested. Use a table FQN for table-level tests, or a column FQN (service.database.schema.table.column) for column-level tests.
  • testSuite: The fully qualified name of the test suite the test case belongs to. If left blank, the default test suite for the entity is used, or created if it doesn’t already exist.
  • parameterValues: The parameters the test needs, formatted as {"name":"paramName","value":value}. Separate multiple parameters with a semicolon, for example {"name":"minValue","value":100};{"name":"maxValue","value":1000}.
  • computePassedFailedRowCount: true or false. Whether to compute the count of passed and failed rows.
  • useDynamicAssertion: true or false. Whether the test case uses dynamic assertions.
  • inspectionQuery: A SQL query used to inspect failed test results.
  • tags: Classification tag FQNs associated with the test case, separated by semicolons, for example PII.Sensitive;PersonalData.Personal.
  • glossaryTerms: Glossary term FQNs associated with the test case, separated by semicolons, for example Glossary.Term1;Glossary.Term2.
Test case CSV files don’t have an owner column, unlike some other entity CSVs. In Bulk Edit, the name, testDefinition, entityFQN, and testSuite columns are locked, since they identify the test case and what it runs against.

Bulk Import Test Cases

Create or update test cases from a CSV file.

Bulk Export Test Cases

Download your test cases as a CSV file.

Bulk Edit Test Cases

Update multiple test cases at once from an inline grid.