EDI Schema Importer

Generates Grooper data elements from a specified X12 EDI schema, enabling you to create, configure, and customize EDI data models for extraction and validation.

Remarks

The EDI Schema Importer is used to create a Grooper data model that matches the structure of an X12 EDI transaction set. It automates the process of mapping EDI loops, segments, and fields into Grooper Data Fields, Data Sections, and Data Tables, providing a foundation for extraction, validation, and downstream processing.

Purpose

This importer is designed for users who need to extract, validate, and process data from X12 EDI documents. It streamlines the creation of data models by importing the schema structure, reducing manual configuration and ensuring alignment with EDI standards.

How It Works

• Select the X12 schema that matches your EDI documents using the 'X12 Schema' property.
• Configure naming conventions for loops, segments, and fields using the 'Loop Naming', 'Segment Naming', and 'Field Naming' properties.
• Choose whether to expand composite fields into child sections with 'Expand Composite Fields'.
• Control the generation of captions for sections with 'Generate Captions'.
• Set the character casing for generated names using 'Name Casing'.
• When executed, the importer reads the selected schema and generates a hierarchical data model in Grooper, including all relevant loops, segments, and fields.

Configuration Guidance

• Use the provided properties to match your organization's naming standards and user interface preferences.
• Enable 'Expand Composite Fields' if you need to access or validate individual components of composite fields.
• Enable 'Generate Captions' to improve clarity for end users reviewing or editing data.
• Adjust 'Name Casing' to enforce consistency with your naming conventions.

Usage Notes

• EDI Schema Importer is typically used during initial data model setup or when updating models to match changes in EDI schema definitions.
• After import, you may further customize the generated data elements as needed for your extraction and validation requirements.
• For more information, see Schema Importer, Data Field Container, and Data Section documentation.

Properties

Name	Type		Description
X12Schema	String	►	The name of the X12 schema to import. ConverterX12Schema Converter Requiredtrue Can be one of the following types: Value Description X12 835 X12 837 Dental X12 837 Institutional X12 837 Professional Choose the X12 schema that matches your EDI documents. The list provides available schemas in your environment. The selected schema determines the structure and elements that will be imported.
Expand Composite Fields	Boolean	►	Whether composite fields are expanded and displayed as child sections. DefaultFalse Enabled: Composite fields (fields containing subfields) will be shown as separate child sections, making each subfield individually accessible. Disabled: Composite fields will remain as a single field. Enable this if you need to extract or validate individual components of composite fields.
Loop Naming	NamingMethods	►	How loops are named in the generated data model. DefaultId Can be one of the following values: Name Value Description Id 0 Name using the id. Name 1 Name using a human-readable description. Id: Use the loop's identifier (e.g., 2000A). Name: Use a human-readable description (e.g., Billing Provider Loop). Choose the method that best fits your organization's naming standards or user preferences.
Segment Naming	NamingMethods	►	How segments are named in the generated data model. DefaultId Can be one of the following values: Name Value Description Id 0 Name using the id. Name 1 Name using a human-readable description. Id: Use the segment's identifier (e.g., NM1). Name: Use a human-readable description (e.g., Individual or Organization Name). This affects how segments appear in the data model and user interface.
Field Naming	NamingMethods	►	How fields are named in the generated data model. DefaultId Can be one of the following values: Name Value Description Id 0 Name using the id. Name 1 Name using a human-readable description. Id: Use the field's identifier (e.g., NM101). Name: Use a human-readable description (e.g., Entity Identifier Code). Select the option that makes field names most meaningful for your users.
Generate Captions	Boolean	►	Whether to generate a caption for each created section. DefaultFalse Enabled: Each section will display a caption, improving clarity in the user interface. Disabled: Captions will not be generated. Captions can help users quickly identify sections when reviewing or editing data.
Name Casing	CharacterCasing	►	The character casing to use for generated names. DefaultNone A combination of the following flags: Name Value Description None 0 None. Upper 1 All letters should be in UPPER CASE. Lower 2 All letters should be in lower case. Title 4 All letters should be in Title Case. Options include Original, Upper, Lower, and Title case. Affects the appearance of all generated names in the data model. Use this to enforce consistency with your organization's naming conventions.

Used By

Data Field Container - Import Schema