Grooper Help - Version 25.0
25.0.0040 2,257

JSON Schema Importer

Schema Importer Grooper.EDI

Generates data elements corresponding to the properties and structure defined in a JSON Schema file.

Remarks

JSONSchemaImporter automates the creation of Grooper data elements (fields, sections, and tables) by reading the structure of a JSON Schema file.

This tool is designed for end users who want to quickly build a data model that matches the structure of JSON documents they need to process.

How It Works

  1. Schema File
    Select a Resource File containing your JSON Schema. The importer will read this file to determine the properties, types, and structure to create.

  2. Element Name Format and Casing
    Configure the character casing for generated data element names to match your organization's naming conventions.

  3. Value Delimiter
    For fields that can have multiple values (such as arrays), specify the delimiter to use when storing multiple values in a single field.

  4. Tables and Extended Properties
    Enable 'Use Tables' to generate Data Tables for repeating object arrays when possible.
    Enable 'Use Extended Properties' to import Grooper-specific metadata from schemas produced by Grooper.

What Gets Imported

  • Properties: Each property in the schema becomes a Data Field, Data Section, or Data Table, depending on its type and structure.
  • Arrays: Arrays of objects are imported as Data Tables or multi-instance sections, based on configuration.
  • Enumerations and Choices: Enum and oneOf definitions are imported as field choice lists.
  • Descriptions: Property descriptions from the schema are imported as field or section descriptions.
  • Extended Properties: Grooper-specific extensions (e.g., computed values, required conditions) are imported if enabled.

Usage Notes

  • The importer will create a hierarchy of fields, sections, and tables that matches the schema's structure, including nested and repeating elements.
  • If the schema changes, you can re-run the importer to update your data model.
  • Review the generated fields, sections, and tables after import to ensure they meet your requirements.

Example Workflow

  1. Add your JSON Schema file as a Resource File in your Grooper project.
  2. Create or select a Data Model or Section where you want to import the schema.
  3. Add an Import Schema command and set the Source to JSONSchemaImporter.
  4. Configure the properties as needed and execute the import.

Properties

NameTypeDescription

See Also

Used By

Notification