Nexfield Systems Developer Tools & Digital Products

Data Guard Quick Start

This guide is for first-time packaged-install users who want one successful run as quickly as possible.

If Data Guard is already installed in your Unreal project, you can reach a passing validation in a few minutes using the bundled example files.

Before you start

Confirm these are true:

  • the Data Guard plugin is installed in your project
  • Unreal opens the project without plugin load errors
  • Data Guard appears in the editor Tools menu

Where the bundled example files are

In a packaged install, the starter example files live inside the installed plugin folder:

  • Plugins/DataGuard/Resources/Examples/Example_ItemStats_Valid.csv
  • Plugins/DataGuard/Resources/Examples/Example_ItemStats_Schema.json
  • Plugins/DataGuard/Resources/Examples/Example_ItemStats_Overlay.json

These files are designed to work with the built-in example struct:

  • Example Item Stats Row

Fastest first success

The fastest first run is Struct-only.

1. Open Data Guard

  1. Open the Tools menu.
  2. Open Data Guard.
  3. Confirm Validation Setup appears.

2. Choose Struct-only

  1. Click Struct-only.
  2. In Choose Struct, select Example Item Stats Row.
  3. Continue to the CSV step.

3. Choose the bundled example CSV

Select:

  • Plugins/DataGuard/Resources/Examples/Example_ItemStats_Valid.csv

Expected result:

  • Validation Summary
  • Overall status: Passed
  • Import readiness: Passed

At this point, you have confirmed that:

  • the plugin is loaded
  • the built-in example struct is available
  • Data Guard can validate a CSV successfully

Optional next two checks

JSON Schema

  1. Start again from Validation Setup.
  2. Choose JSON Schema.
  3. Select:
    • CSV: Plugins/DataGuard/Resources/Examples/Example_ItemStats_Valid.csv
    • schema JSON: Plugins/DataGuard/Resources/Examples/Example_ItemStats_Schema.json

Expected result:

  • Schema Validation Summary
  • Overall status: Passed

Struct + JSON Rules

  1. Start again from Validation Setup.
  2. Choose Struct + JSON Rules.
  3. Select:
    • struct: Example Item Stats Row
    • CSV: Plugins/DataGuard/Resources/Examples/Example_ItemStats_Valid.csv
    • overlay JSON: Plugins/DataGuard/Resources/Examples/Example_ItemStats_Overlay.json

Expected result:

  • Validation Summary
  • Overall status: Passed