Cookbook
Overview
This cookbook contains several MetaEd programming recipes targeted at specific problems. Recipes are presented in a problem, solution, discussion format.
Audience
This documentation is for technical professionals developing with MetaEd and the MetaEd IDE.
Please note that this documentation includes concepts relevant to both the core MetaEd system used internally by the Ed-Fi Alliance and the MetaEd IDE used by licensees and their technical providers. For the most part, the concepts and language constructs are identical. Information pertinent to internal — or external — only users is marked as such.
Prerequisites
To gain the most benefit from this information, the reader should already be familiar with the following knowledge areas:
- Ed-Fi technology, see www.ed-fi.org
- MetaEd technology fundamentals, see the MetaEd IDE User Guide
MetaEd Cookbook Contents
📄️ 0 - Templates for New Files
Templates for new files.
📄️ 1 - Updating an Element's Documentation
The Documentation of an existing element needs to be updated or corrected.
📄️ 2 - Change the Type of a Property
A property of an entity is not of the correct type.
📄️ 3 - Create a New Common
The design of a MetaEd model requires a new common.
📄️ 4 - Create a New Association Subclass
The design of a MetaEd model requires the subclassing of an association.
📄️ 5 - Rename Entity
The design of a MetaEd model requires the renaming of an entity.
📄️ 6 - Add Reference Property
The design of a MetaEd model requires the addition of a reference property to an entity.
📄️ 7 - Add Enumeration Item
A MetaEd enumeration requires additional enumeration items.
📄️ 8 - Create a New Enumeration
The design of a MetaEd model requires a new enumeration.
📄️ 9 - Add Enumeration Property
The design of a MetaEd model requires the addition of an enumeration property to an entity.
📄️ 10 - Add Decimal Property
The design of a MetaEd model requires the addition of a decimal property to an entity.
📄️ 11 - Create a New Interchange
The design of a MetaEd model requires a new interchange.
📄️ 12 - Create a New Shared Type
A field with the same properties is frequently included in multiple MetaEd files.
📄️ 13 - Add Reference with Role Name
One entity references another, but the reference has a special meaning.
📄️ 14 - Using Merge Directives
A complex model results in duplicate references flowing through the model.
📄️ 15 - Create a New Descriptor
The design of a MetaEd model requires a new Ed-Fi Descriptor.
📄️ 16 - Create a New Common Subclass
The design of a MetaEd model requires the subclassing of a common.
📄️ 17 - Extend an Existing Entity
The design of a MetaEd model requires extending an entity to include additional properties.
📄️ 18 - Reference an Entity Defined in a Different Project (Including Core)
Need to reference an entity that is defined in a different project.