Skip to main content
Ed-Fi.orgDocsCommunityAcademy

0 - Templates for New Files

Below are templates to help you get started creating new files, for every type of supported component, at the parent level (i.e. there is no need for distinct "subclass" templates). For more information on these templates, please see the relevant articles in the Cookbook.

Package.json​

{
  "metaEdProject": {
    "projectName": "${projectName}",
    "projectVersion": "${projectVersion}"
  }
}

Association​

Association ExampleName
    documentation "This is documentation."
    domain entity FirstEntityName
        documentation "This is documentation."
    domain entity SecondEntityName
        documentation "This is documentation."
    bool PropertyName
        documentation "This is documentation."
        is part of identity

Related content:

Choice​

Choice ExampleName
    documentation "This is documentation."
    bool FirstPropertyName
        documentation "This is documentation."
        is required
    bool SecondPropertyName
        documentation "This is documentation."
        is required

Related content:

Common​

Common ExampleName
    documentation "This is documentation."
    bool PropertyName
        documentation "This is documentation."
        is part of identity

Related content:

Descriptor​

Descriptor ExampleName
    documentation "This is documentation."
    with map type
        documentation "This is documentation."
        item "ShortDescription"

Related content:

DomainEntity​

Domain Entity ExampleName
    documentation "This is documentation."
    bool PropertyName
        documentation "This is documentation."
        is part of identity

Related content:

Domain​

Domain ExampleName
    documentation "This is documentation."
    domain entity ItemName
    footer documentation "This is documentation."

Related content:

Enumeration​

Enumeration ExampleName
    documentation "This is documentation."
    item "ItemName"
        documentation "This is documentation."

Related content:

Interchange​

Interchange ExampleName
    documentation "This is documentation."
    extended documentation "This is documentation."
    use case documentation "This is documentation."
    domain entity ElementName

Related content:

SharedDecimal​

Shared Decimal ExampleName
    documentation "This is documentation."
    total digits 9
    decimal places 3
    min value 0
    max value 100

Related content:

SharedInteger​

Shared Integer ExampleName
    documentation "This is documentation."
    min value 0
    max value 100

Related content:

SharedString​

Shared String ExampleName
  documentation "This is documentation."
  min length 1
  max length 20

Related content: