How to add standard properties to facades

Facade properties are meta data that can be associated to each facade.

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

facade PersonDTO extends Person {
   properties {
      customName:"Natural person"
      label:"Natural person identification"
      urlExternalDescription: "https://en.wikipedia.org/wiki/Natural_person"
   }
   name
   firstname
}

Standard facades properties :

• label (String)
  
  • short description of the facade
  • inherited from the type on which the facade is defined if not specified

• customName (String)
  • Allows you to give a more understandable business name when displaying graphs
  • inherited from the type on which the facade is defined if not specified

• customColor (String)
  • Allows to give a custom color to the Entity eg. "#C9A9A9,#543894" ("background,font)
  • inherited from the type on which the facade is defined if not specified

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

• description (String)
  • description of the facade

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

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

• deprecated (Boolean)
  • indicates that this facade is deprecated and should not be used in the future.
  • inherited from the type on which the facade is defined if not specified

• primaryKey  (field or [list of fields])
  • field or list of fields defining the entity's primaryKey
  • inherited from the type on which the facade is defined if not specified
    • primaryKey is propagated only if that facade have retained all primaryKey fields

• required (List of field names)
  • To be valid, an instance of this object must have these fields filled
  • An exclamation mark to the right of a field name is the simplest way to declare that a field is required.
    
    • eg. name!

• shrinkable  (Boolean) 
  • Tells the Data Explorer not to display fields for this entity when the shrink option is checked
  • inherited from the type on which the facade is defined if not specified

• readOnly (List of field names)
  
  • These fields may be sent as part of a response but should not be sent as part of the request
  • if required AND readOnly, a field will be required on the response only
  • inherited from the type on which the facade is defined if not specified

• writeOnly (List of field names)
  
  • these fields may be sent as part of a request but should not be sent as part of the response 
  • if required AND writeOnly, a field will be required on the request only
  • inherited from the type on which the facade is defined if not specified

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.

• if not specified, a customTypeProperty is inherited from the type on which the facade is defined