Configuring Data Group

To create a new data group, navigate to TDM using the left-hand sidebar and click on New Data Group. If no group exists, this will allow you to create one.

Datachecks supports two types of data groups:

• Default Data Group: You can create a data group manually, or with a YAML configuration.
• Upload Only Test Data: This allows you to upload test data using an Excel file.

1. Default Data Group

For a manual setup, simply provide a name and click Submit. An empty data group will be created.

To proceed with a YAML configuration, enable the Create with YAML Configuration toggle. From here, you can upload your YAML file or paste the YAML configuration directly.

YAML allows you to define entities, parameters, and data relationships in a structured format. For example, you can create a users entity with unique IDs and names, and a transactions entity referencing those users using a foreign key.

Example YAML Configuration:

entities:
  - name: "users"
    rows: 5
    parameters:
      - name: "user_id"
        type: "uuid4"
        is_unique: true
      - name: "user_name"
        type: "user_name"
        is_unique: true
  - name: "transactions"
    rows: 100
    parameters:
      - name: "transaction_id"
        type: "uuid4"
        is_unique: true
      - name: "amount"
        type: "random_int"
      - name: "user_id"
        type: "uuid4"
        ref: "users.user_id"
      - name: "user_name"
        type: "user_name"
        ref: "users.user_name"
        

For this configuration, after clicking Submit, a data group with users and transactions entities will be created. If the YAML format is incorrect, you’ll receive an error message for correction.

2. Upload Only Test Data

To proceed with this option, give a name to the group, select Upload Only Test Data, and click Submit. After the data group is created, you can upload your Excel file. Datachecks will read the file and automatically generate the appropriate parameters based on its content.

Creating Entities

Within a data group, you can create entities using the following methods:

• Manual Creation: Click on New Entity, provide a name, and select the Create a New Data Entity (Manual) option. After submitting, you can configure its parameters.
• Upload Only: If the data group was created using the Upload Only Test Data option, you will see an option to upload an Excel format. Datachecks will read the file and generate parameters based on its content.
• Using a Dataset: Select an existing dataset. Datachecks will fetch the columns from the dataset and generate parameters automatically.

Once the entity is created, expand it to manage parameters. Here, you will see three tabs:

1. Data Parameters

The Data Parameter section allows you to manage parameters within your entity. Click on Parameters to add a new parameter or edit existing ones using the editor section.

Adding Parameters

You can add:

• Parameter Name: Provide a unique name for the parameter.
• Type: Choose a parameter type. For more information, refer to Parameter Types.

Additional Options

You can configure additional options for each parameter, including:

• Null Percentage: Set the percentage of null values.
• Format: Specify a format for the parameter.
• Mask: Apply a masking pattern if necessary.
• Reference: Add a reference (foreign key) to link this parameter to another entity’s parameter.

Saving Configuration

Once you've added your parameters, define the Number of Rows you want to generate and click Save Configuration.

2. Data Preview

After saving, you can preview the generated data by navigating to the Data Preview tab. The first 10 rows will be displayed for quick review, while the rest are stored in the table automatically.

ℹ️

Note: When you download the data, all the defined rows will be available.

You also have the option to:

• Refresh: Update the data if necessary.
• Regenerate: Generate a new dataset using the same configuration.

3. Data Target

To store the generated data to your API endpoint, you can define a Data Target using an API request.Click on New Data Target, provide the target with a name, and click Create. Then, expand the target to configure it further.

Configuring API Requests

API Request

Provide the URL endpoint where the data should be sent. This is the API that will receive the data.

Run Options

Choose how you want the data to be sent:

• Run For Each Row: This option sends data one row at a time. Use this when you want each row to be processed individually.
• Run Once: This option sends all the data in a single request. It's more efficient if you want to submit the entire dataset at once.

Headers

Add custom headers by clicking Define New Headers and providing the key-value pairs.

Body

Define your request body in JSON format to match your API requirements.

Logs

You can monitor actions and track any issues using the Logs tab.

Publish

Once your configuration is complete and verified, click Publish to finalize your data target.