XML Schema Importer

Generates data elements corresponding to the elements and attributes defined in an XML schema.

Remarks

XMLSchemaImporter automates the creation of Grooper data elements (fields and sections) by reading the structure of an XML Schema (XSD file).

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

How It Works

1. Schema File
   Select a Resource File containing your XML Schema (XSD). The importer will read this file to determine the elements and attributes to create.

2. Element Name Format
   Choose how the names of generated data elements should be formatted (e.g., as-is, display name, or cased).

3. Name Casing
   If you select the 'Cased' naming method, specify the character casing (e.g., PascalCase, camelCase, etc.) to apply to element names.

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

What Gets Imported

• Elements: Each element in the schema becomes a Data Field or Data Section, depending on its type and structure.
• Attributes: Attributes of elements are imported as Data Fields.
• Enumerations and Restrictions: If the schema defines allowed values or restrictions, these are applied to the corresponding fields.
• Documentation: Comments and documentation from the schema are imported as field or section descriptions.

Usage Notes

• The importer will create a hierarchy of fields and sections 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 and sections after import to ensure they meet your requirements.

Example Workflow

1. Add your XSD 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 XMLSchemaImporter.
4. Configure the properties as needed and execute the import.

Properties

Name	Type		Description
Schema File	Resource File	►	The XML Schema (XSD) file to import. EditorNode Reference Editor Requiredtrue Select a Resource File containing your XML Schema definition (XSD). The importer will read this file to determine the elements, attributes, and structure to generate in your data model. To use, add your XSD file as a Resource File in your Grooper project, then select it here. If the schema references other XSD files, ensure those are also added as Resource Files in the same project folder.
Element Name Format	NamingMethods	►	Defines various options for how Data Elements will be named when created from XML schema elements. DefaultNone Can be one of the following values: Name Value Description None 0 Name using the XML element name as is. DisplayName 1 Name using a human-readable description. Cased 2 Name using the configured Name Casing option.
Name Casing	CharacterCasing	►	Specifies the character casing to be used for data element 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. This property is only used when Element Name Format is set to 'Cased'. Choose the desired casing style for generated names, such as PascalCase, camelCase, or UPPERCASE. This helps ensure consistency with your organization's naming conventions.
Value Delimiter	String	►	Specifies the delimiter to be used for multi-cardinality fields. Default, For fields that can have multiple values (such as repeating elements or attributes), specify the character or string to use as a delimiter between values. The default is a comma (,). Example: If a field can have multiple phone numbers, and the delimiter is ;, the value might be 555-1234;555-5678. Choose a delimiter that does not appear in your data values.

See Also

Resource File

Used By

Data Field Container - Import Schema