How to add standard properties to types

Type properties are meta data that can be associated to each type.

In the description of the type, they are introduced by the keyword properties followed by the list of properties between {  }

type Person{
   properties {
      label:"Natural Person"
      urlExternalDescription: "https://en.wikipedia.org/wiki/Natural_person"
   }
   name:String
   firstName:String
   age:Integer
   address:Address 
   skills:[Skills] 
}

Standard Type properties :

• label (String)
  
  • short description of the type
  • label is propagated to all facades defined on this type
  • label is also propagated to all fields of this type

• customName (String)
  • Allows you to give a more understandable business name when displaying graphs
  • Custom name is propagated to all facades defined on this type

• customColor (String)
  • Allows to give a custom color to the Entity eg. "#C9A9A9,#543894" ("background,font)
  • customColor is propagated to all facades defined on this type

  • It's much more efficient to use subModels to manage the colors of functional subdomains

• description (String)
  • description of the type

• comment (String)
  • Allows you to add a comment to the type

• urlExternalDescription (String)
  • url pointing to an external description of the type

• deprecated (Boolean)
  • indicates that this facade is deprecated and should not be used in the future.
  • derecated is propagated to all facades defined on this type

• isHidden (Boolean)
  • tells the data explorer that the type is hidden by default in the representations
  • isHidden is propagated to all facades defined on this type

• isHiddenProgateTofield (Boolean)
  • tells the data explorer that the type is hidden by default in the representations, but also the fields of the other types that point to it.
  • isHiddenPropateToFields is propagated to all facades defined on this type

• primaryKey  (field or [list of fields])
  • field or list of fields defining the entity's primaryKey
  • primaryKey is propagated to all facades that have retained all primaryKey fields

• stopx  (Boolean) 
  • Tells the data explorer to stop by default its exploration on this type. These meta data allow to better control the exploration of complex model

• shrinkable  (Boolean) 
  • Tells the Data Explorer not to display fields for this entity when the shrink option is checked
  • shinkable is propagated to all facades defined on this type

These properties are used by Akwatype during the different generations (Graphs, OpenAPI, Excel, Json example, custom export...).

note : premium plan allows you to create and use your own custom properties in addition to the standard akwatype properties.

• a customTypeProperty is propagated to all facades defined on the type that used it.