Free cookie consent management tool by TermsFeed

Generate Sample Data

On This Page

When you create a new record type, you'll often need to fill it with test data to see how different parts of your application interact.

You can develop and test your applications faster by generating sample data with artificial intelligence (AI). With Appian AI Copilot, you can generate realistic data for existing record types and bypass lots of manual entry. This capability provides secure, authentic record data suitable for effective demos and in-depth testing.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/sdg-example.gif

How generating sample data works

Appian AI Copilot uses the record type's name, display name, description, as well as its field names and descriptions to determine what kind of content to generate. You can also use advanced configurations to provide AI Copilot with specific instructions to tailor the output.

AI Copilot also identifies related record types and allows you to choose which one-to-many relationships to include in the data generation process. Once you review and insert the data, AI Copilot writes the data directly to your database table. You can view the generated data in the Data Preview tab.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/sdg-related-checkbox.png

Prerequisites for generating sample data

Before generating sample data, ensure your environment and record types meets the following requirements:

  • Activation: You have contacted Appian Support to enable sample data generation.
  • Region: You have an Appian Cloud environment in a supported region.

    If your Appian environment isn't in a supported region, you can elect to send your data to a supported region. This doesn't change your environment's region. Contact Appian Support to learn more.

  • Record type source: The record type must use a Number (Integer) as the primary key and use a database table as the source. Record types that use a database view as the source are not supported.
  • Record type security: You must have at least Viewer permission to the record type and its related record types.

Usage considerations for generating sample data

There are specific limitations when generating sample data.

Unsupported scenarios

You should not use generated sample data for the following purposes:

  • Performance simulation: This capability is not designed for load testing or high-volume data stress testing.
  • Production debugging: Do not use sample data to identify or replicate issues in production environments.

Relationship constraints

AI Copilot can generate data for related records only if:

Generate sample data

To generate sample data:

  1. In the record type, go to Data Preview.
  2. Click GENERATE SAMPLE DATA.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/generate-sample-data-btn.png

  3. Select which related record types to also generate sample data for. By default, all related record types are selected.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/sdg-related-checkbox.png

    Note:  If the record type has a one-to-many relationship with a record type that doesn't have any data, or you don't have permission to view the related record types, you'll see a different screen. Learn how to resolve the issue.

  4. Click NEXT.
  5. Click the record type names to see a preview of the sample data. By default, the base record type is selected.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/sample-data-view-record-types.png

  6. Adjust the advanced configurations as needed.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/sample-data-advanced-config.png

  7. Click INSERT.

Your customized sample data is written to your database table and appears in the Data Preview page.

Advanced configuration

With the advanced configuration options, you can customize your sample data exactly how you want it: select the specific number of records, choose which fields to include, and add any special instructions.

You can configure the following advanced configurations:

Option Description
How many records do you want to generate? Choose how much sample data you need - 10, 25, or 50 new records.
How many records do you want to generate for each base record? (Related record types only) Choose how much sample data you need - 1, 2, or 3 new records for each base record that gets created.
Record Fields Select which details you want to create. AI Copilot will create sample data for the record fields you select. Clear the checkbox next to the field(s) that you don't want sample data for. Primary key and relationship fields are automatically selected and locked to prevent deselection. This safeguard ensures their connections remain intact.
Additional Instructions Tell AI Copilot about any specific details you want it to consider when creating your sample data. For example, you could provide details about what to include or avoid. For example, you can enter something like this: Include a range of 50 to 90 percent in the discount column.
REFRESH ALL DATA Click REFRESH ALL DATA to simultaneously regenerate sample data for both the base record type and any related record types, provided you're also creating data for related record types.

Modify data from the record type

You can add or edit rows of data directly from the Data Preview page of your record type.

Note:  This capability is only available when the record type uses a database table as the source.

Add new rows

To add a new row:

  1. In the record type, go to Data Preview.
  2. Click ADD ROW.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/add-row-record-type.png

  3. Enter field values for the row. You cannot add field values for custom record fields.
  4. Click ADD.
  5. Click WRITE CHANGES. A Write Changes? dialog appears.
  6. Keep the Download database script checkbox selected to download the script when you finish.

    Caution:  The auto-generated database script is not saved in Appian, so we strongly recommend downloading the script now and storing it locally.

  7. Click WRITE to write the row to the database.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/write-changes-dialog.png

  8. Click SAVE.

Edit field values

To edit a field value in an existing row of data:

  1. In the record type, go to Data Preview.
  2. Click Edit Row next to a row.
  3. Edit the field values for the row. You cannot add field values for custom record fields.
  4. Click APPLY CHANGES.
  5. Click WRITE CHANGES. A Write Changes? dialog appears.
  6. Keep the Download database script checkbox selected to download the script when you finish.

    Caution:  The auto-generated database script is not saved in Appian, so we strongly recommend downloading the script now and storing it locally.

  7. Click WRITE to write the row to the database.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/write-changes-dialog.png

  8. Click SAVE.

Troubleshooting

This section explains why AI Copilot may not be able to generate sample data for your record type and how you can resolve the issue.

If your record type depends on related record types that do not have any data, you might see a message like this:

These are related record types that your record type depends on, but they don't contain data or you can't access them. To continue, insert sample data in the related record type(s) or if access is an issue, contact your system administrator.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/sdg-relatedrecordtype-missingdata.png

To resolve this issue:

  1. Verify related record types: Verify that your current record type truly depends on the identified related record types and that they have data.
  2. Populate related record types first: If the related record types are empty, populate them with sample data first. After they have sample data, return to your base record type to create and insert its sample data.
  3. Check Access Permissions: If the related record types contain data but you're unable to access them, it's likely an issue with your permissions. Contact your system administrator if access is an issue.

Why you might not get all the records you asked for

If AI Copilot doesn't return the requested amount, several factors might be at play:

  • AI Copilot might not have access to a sufficient amount of relevant data to fulfill the request, leading to fewer rows of sample data being generated.
  • For highly specialized or complex data requests, AI Copilot may create fewer records, prioritizing the quality and relevance of the sample data over quantity to ensure the sample data is both accurate and valuable.
  • AI Copilot is programmed to avoid generating data that could be misused, contain sensitive information, or inadvertently create privacy issues.

Feedback