Skip to main content

Appendix C - Naming Conventions

Overview​

Follow these naming conventions consistently when developing ADITO modules. Some are strictly required because modularization mechanisms depend on them (e.g., language file merging), while others serve to maintain readability and consistency.

Git Repository Names​

  • Use lowercase letters only (e.g., salutation)
  • Hyphens are allowed (e.g., csv-importer)
  • Avoid underscores or other special characters
  • Add a meaningful icon and description in Git, as shown in the xRM-Platform subgroup

Extension Points​

  • Format: <ModelName>ExtensionPoint (e.g., FieldExtensionPoint, ActionFieldExtensionPoint)
  • One-sided ExtensionPoints may use generic names (e.g., OpportunityExtensionPoint)

Extension Point Implementations​

  • Follow AID001 Coding Styles
    • Database EntityFields: UPPER_CASE (e.g., MYFIELD)
    • Calculated fields: CamelCase (e.g., MyField)

Language Files​

  • Format: LANGUAGE_<lang>_<module> (e.g., LANGUAGE_de_activity)
  • Automatically set by the Designer when creating a file via context menu
  • Do not rename – the format is required for proper merging during transpile

Services​

  • Global services: <module><ServiceName>_service (e.g., attributeUsageContexts_service)
  • Entity-bound services: <module><EntityEvent>_service (e.g., activityOnDBDelete_service)

Service Implementations​

  • Use expressive names (e.g., addNewActivity_impl)
  • Avoid generic patterns like <module>_impl unless temporary
  • Temporary services: prefix with tmp_ (e.g., tmp_impl)

Modifications​

  • Do not change the autogenerated names

Keyword Registries​

  • Format: <ModuleName>Keywords_registry (e.g., ActivityKeywords_registry, ContactManagementKeywords_registry)