Skip to content

Manage Connections Enterprise

A connection defines how TestGen accesses your database for profiling, testing, and monitoring. TestGen requires only read-only access — see Database Access Requirements for the specific permissions needed for each database type. Each project can have multiple connections, and each connection can have multiple table groups.

The open-source version is limited to a single connection. Select Connection from the menu to edit its configuration, then click Setup Table Groups to set up a table group.

Note

Creating, editing, and deleting connections requires admin access.

Create a connection

The Data Configuration Setup wizard walks you through creating a connection, setting up a table group, and optionally configuring profiling, testing, and monitors.

  1. Select Connections from the menu.
  2. Click Add Connection.
  3. Select the database type, and click Next.

Fill in the connection details

  1. Give the connection a name, unique within the project.

  2. Enter the connection details specific to your database type — typically a Host, Port, Database, and credentials.

    • If the database is running on localhost on the same machine as TestGen, set the Host value to host.docker.internal.

  3. Optional. Expand Advanced Tuning to adjust Max Threads and Max Expression Length. The defaults are set for optimal performance and do not need to be changed in most cases.

  4. Optional. Click Test Connection to verify the connection.
  5. Click Next.

Create a table group

  1. Give the table group a name, unique within the project.
  2. In Schema, enter the name of the schema that includes the tables you want to profile.

  3. Use the Tables to Include Mask, Tables to Exclude Mask, and Explicit Table List fields to specify which tables within the schema should be profiled.

    • Mask fields accept wildcard characters.
    • All three fields accept table names.
    • Use commas to separate table names in the Explicit Table List field.
    • The default include and exclude masks are set to: include everything but do not include temporary tables.

  4. Use the Profiling ID column mask and Profiling Surrogate Key column mask fields to specify any ID and surrogate key data present in your tables.

  5. Optional. Review the Settings. By default, critical data elements (CDEs) are detected during profiling, the table group is included in the Project Dashboard, and a scorecard is added to the Quality Dashboard.

  6. Optional. Assign a profiling delay for test generation.

    • By default, the delay is 0. That is, any tests generated for a table group use the most recent profiling results.
    • Note that tests are expected to pass when generated against the most recent profiling results.
    • You can choose to generate tests against profiling results that are <X> days old.

  7. Optional. Toggle on Use profile sampling, then assign a sample percent and minimum count.

    • Sampling restricts the system's analysis of the tables included in a table group.
    • You can narrow the total scope (sample percent) of the tables to profile and set a lower bound (minimum count).
    • For a more accurate representation of your data, run profiling without sampling.

  8. Optional. Expand Table Group Tags to add metadata such as a description, data source, business domain, or stakeholder group.

  9. Click Next.

Verify table access

The wizard previews the tables found in the schema. Optionally, click Verify Access to confirm that TestGen can query the tables.

Click Next to continue.

Run profiling

  • To profile the table group immediately after creation, leave Run profiling toggled on.
  • To skip profiling and run it at a later time, toggle off Run profiling. You can run profiling later from the Table Groups page.

Click Next to continue.

Set up testing

You can optionally create a test suite and schedule automated test runs as part of the setup.

  • To generate tests and schedule test runs, leave Generate and schedule tests toggled on. Enter a Test Suite Name, set a Test Run Schedule, and select a Timezone.
  • To skip this step, toggle off Generate and schedule tests. You can create a test suite later from the Test Suites page.

Note

Tests are auto-generated after profiling completes and then run on the schedule you configure. See Recommended frequency for guidance.

Click Next to continue.

Set up monitors

You can optionally configure monitors for the table group as part of the setup.

  • To configure monitors, leave Configure monitors toggled on. Set the Monitor Run Schedule, Timezone, and optionally adjust the Sensitivity and other prediction model settings.
  • To skip this step, toggle off Configure monitors. You can configure monitors later from the Monitors page.

Note

Volume and Schema monitors are created immediately. Freshness monitors are created after the first profiling run completes. See Configure Monitors for details on monitor settings.

Click Save to complete the setup. If profiling is enabled, the button reads Save & Run.

Edit a connection

Select Connections from the menu, and click the (edit icon) on the connection you want to modify. Make changes as needed, and click Test Connection to verify before saving.

Delete a connection

Warning

Deleting a connection permanently removes the connection and all associated table groups, profiling runs, test suites, test results, and monitors. This action cannot be undone.

Select Connections from the menu, and click the (delete icon) on the connection you want to remove. Confirm the deletion.

Manage Table Groups

Manage Test Suites