Sage X3 rules

Introduction

This document describes the main rules a development partner should follow when using the development language and workbench to create or adapt Sage X3 functions.

Naming conventions

This convention is valid for every name that can be present as a symbol in Sage X3 scripts. This includes the following:

  • The name and abbreviation of tables
  • The name of classes and representations
  • The name of context chapters and parameters
  • The name of the Sage X3 scripts
  • The name of additional properties added in standard representation on classes (on specific classes and representation, the name is not constrained)

The naming convention is the following:

  • Any symbol starting with 'A' is a supervisor symbol. Thus, any functional or specific development partner cannot use this initial for naming classes, representations, variables, and so forth.
  • Any name starting with 'X','Y',or 'Z' is reserved for specific or vertical development. Thus, any standard functional development partner cannot use these letters for naming classes, representations, variables, and so forth.
  • Any symbol starting with 'W' is reserved for codes generated from a dictionary. Thus, any modification on a generated dictionary element is not allowed. The element can be automatically regenerated during a validation, and any manual modification would be lost.
  • Creating a table or a class starting with 'U' should be avoided.