Metadata Model Entity Relationship Element

API Type:

X-Ref:

Attribute	API Type	Default	Description
Cardinality	MetadataCardinality	OneToOne	Specifies the type of relationship that exists between the parent entity and the foreign entity. This is a required property
EntityName	AstMetadataModelEntityNode		Specifies a reference to the foreign entity with which the parent entity has a relationship. This is a required reference to an existing definiton.
Name	String		Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property
DynamicObjectClassName	String		Specifies the name to use for the wrapper class that is created as part of the dynamic object for this metadata model entity relationship.
IsDocumentationVisible	Boolean	True	Specifies whether or not the autogenerated documentation for the parent metadata model will include this relationship.
IsUiEditorVisible	Boolean	True	Specifies whether this relationship should be exposed in the editor UI for this metadata model. For instance, in Excel this would correspond to the column for this entity being hidden.

Child	API Type	Description
<Annotations> <Annotation /> </Annotations>	AstAnnotationNode	This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code.
<Lookups> <FilteredLookup /> </Lookups>	AstMetadataModelRelationshipLookupItemNode	This is the optional collection of filtered lookups that will be used by the editor UI to provide completion lists. Each child object will provide configuration information for a completion list. These completion lists can reference each other. For example, a column relationship may provide fields for connection, object, and column. In this case, the object lookup completion list would only contain objects in the selected connection. Similarly, the column lookup completion list would only provide columns in the selected table.
<Properties> <Property /> </Properties>	AstMetadataModelPropertyNode	This is the collection of properties that add configuration values to the metadata model entity relationship.
<Validators> <Validator /> </Validators>	AstMetadataModelValidatorNode	This is a collection of the validator logic objects that will be used to ensure that the metadata model entity relationship is internally consistent and satisfies the constraints imposed by the metadata model.