Please note : This help page is for an older version of Enteprise Archtiect. The latest help can be found here.

Create a Schema Profile

A schema profile identifies the name, technology and content of the schema as a precursor to defining how the schema is generated. You can create and edit as many schema profiles as you need. Schema profiles are typically bound to a single technology and will either map to a generated schema or a sub-setting transform.

Access Tools | Schema Composer

Creating a new Profile

If you are creating a schema for a particular technology, start by opening a model that has the requisite meta-model loaded. Sparx Systems make a number of meta-models available when using the Model Wizard and/or from the Sparx RAS/Cloud services. If you are using a customized or domain specific model, make sure that model is loaded. Once you have a suitable model and have opened the Schema Composer, you can follow these steps to build a new Profile.

Field/Option/Button

Action

See also

Profile (name)

This field is initially blank. When you have created a schema, the name displays in this field.

New

Click on this button to start creating the schema profile.

The 'New Message' dialog displays.

  • 'Schema Set' - Click on the drop-down arrow and select the standard that you have created your model for; if you have not adopted a standard, select the 'Generic' option
  • 'Namespace' - If required, type in the XML Namespace that this schema is associated with; if you have selected the CIM standard, the 'Namespace' field takes an automatic value
  • 'Save In' - Click on the appropriate radio button for the format in which to save the schema
  • OK button - Click on this to create the profile and close the dialog

Model Ref

Depending on the standard you have selected for the Schema Set, this field takes an automatic value or remains blank. If blank, you can type in a reference name if required.

<other options>

Depending on the standard you have selected for the Schema Set, other fields might display. Either leave blank, type in the appropriate value, or click on the button and select the appropriate library Package.

Update

Click on this button to save the schema details you have defined.

Define Schema Content

These steps walk you through the basic procedure of adding elements to a Schema profile and show how you might customize the content of the profile to create the required schema output.

Step

Action

See also

1

Drag the required Class elements from the Project Browser into the 'Classes' panel. As you add an element:

  • Its model structure path is shown underneath the 'Classes' panel
  • Its attributes and Association connectors are listed in alphabetical order in the 'Attributes' panel, with a blank check box against each one; the Association entries identify the connector name and target element name, but are treated as attributes
  • The schema name is displayed in the 'Schema' panel

If necessary, you can list the elements and attributes in reverse alphabetical order (and change the sequence back again) by clicking on the column title.

2

If a selected Class is in a Generalization relationship with another Class, and you want to include attributes that the selected Class inherits, select the 'Show Inheritance' checkbox underneath the 'Attributes' panel.

The inherited attributes are shown - also with checkboxes - at the end of the list in the 'Attributes' panel.

3

Click on a Class in the 'Classes' list and, in the 'Attributes' list, select the checkbox against each attribute and Association from that Class to include in the schema.

The element and its selected attributes and Associations are added to the 'Schema' panel.

You can select all checkboxes for an element at once by clicking on the All button, and clear all selected checkboxes by clicking on the None button.

If you select the checkbox for an Association that links to an element you have not added to the 'Classes' list, that element is automatically added and reported in the status panel in the top right of the screen.

4

In the 'Classes' list, right-click on a Class and set element properties as required:

  • Set element as root - make the selected element the root in the schema
  • Edit root element cardinality - if you have selected 'Set element as root', the 'Restrictions' dialog displays for the Class; set the minimum and maximum number of instances of the root element that can exist in the model (selecting the 'Unbounded' checkbox sets the 'Maximum' field to infinity)
  • Remove root attribute from element - if you previously selected 'Set element as root', reset the selected element to 'normal' and not to a root
  • Remove the selected element - delete the selected element from the schema profile
  • Find in Project Browser - locate and highlight the element in the Project Browser

You can double-click on the element to display its 'Properties' dialog, where you can define a wider range of  element properties as necessary.

Cardinality Properties Dialog

5

In the 'Attributes' list, right-click on a selected attribute or Association and select:

  • Restrict this property - to display the 'Restrictions' dialog to set the cardinality of the:
         -  Attribute, and simply set the default of 1:1 by clicking on the OK button, or
         -  Association, and type in the minimum and maximum number of instances of the target element that can exist
            in the model (selecting the 'Unbounded' checkbox sets the 'Maximum' field to * for infinity); select the 'By
            Reference' checkbox to emit the property in the schema as an attribute naming the reference rather than a
            complex or simple type being emitted directly
  • Edit Restriction - only effective for an Association; modify the values you have set for the restriction
  • Remove Restriction - delete the restriction on the attribute or Association

The values you have set display after the attribute or Association name in the 'Schema' panel.

You can double-click on the attribute or Association to display its 'Properties' dialog, where you can define a wider range of properties as necessary.

Create and Manage Attributes

6

Click on the Update button to validate and save your schema profile.

If there are any problems with the profile, they are identified in the status panel in the top right of the screen.

7

You can now go on to generate schema based on your profile.

Notes

  • The process of creating and generating schema for NIEM has additional notes in the MDG Technology for NIEM Help topic
  • The Schema Composer is supported in the Corporate, Systems Engineering, Business and Software Engineering and Ultimate editions of Enterprise Architect

Learn more