Data Field Container - Import Descriptions

Imports property descriptions from a JSON schema into the current Data Field Container.

Remarks

The Import Descriptions command allows you to automatically populate or update the 'description' metadata for each property in a Data Field Container (such as a Data Model, Data Section, or Data Table) by importing them from an external JSON schema. This is especially useful for synchronizing documentation across systems, reusing schema documentation, or bulk-updating property descriptions without manual editing.

Role and Usage

Use this command when you have a JSON schema (typically generated or maintained externally) that contains up-to-date or standardized descriptions for each property. By importing these descriptions, you ensure that your Grooper data model is well-documented and consistent with external specifications or integration partners.

• The command parses the provided JSON schema and extracts the 'description' for each property.
• Descriptions are mapped to the corresponding properties in the current Data Field Container.
• You can choose whether to overwrite existing descriptions or only fill in those that are missing.

Configuration Guidance

• Paste or load the JSON schema containing the desired property descriptions into the 'Schema' property.
• Set the 'Overwrite' option to control whether existing descriptions are replaced.
• Execute the command to import and apply the descriptions to your data model.

How It Works

1. The command parses the JSON schema provided in the 'Schema' property.
2. For each property in the schema, it locates the corresponding data element in the Data Field Container.
3. The 'description' from the schema is imported, either overwriting or preserving existing documentation as configured.
4. All changes are saved to the repository.

Related Commands

• Data Field Container - Generate Schema: Generates a JSON schema representing the current structure of the data model.
• Data Field Container - Generate Descriptions: Uses generative AI to create or enhance property descriptions.

Properties

{
  "type": "object",
  "properties": {
    "InvoiceNumber": {
      "type": "string",
      "description": "The unique identifier for the invoice."
    },
    "InvoiceDate": {
      "type": "string",
      "description": "The date the invoice was issued."
    }
  }
}

See Also

Data ModelData SectionData Table