Enum exceptions

Enums in GraphQL are the equivalent of local menus or lists of values in Sage X3. They provide a standardized way to represent predefined values in your data model.

Some local menus cannot be directly translated into Enums. These must be handled using this Enum exceptions function (GESAENUMB).

Exceptions are required when:

  • The Enum must be included in a different package than the one associated with the local menu’s module.

  • The local menu description or values do not comply with GraphQL naming rules. For example, they contain special characters like %, >, =, ;.

How enums are generated

When a node binding record is validated:

  • Most existing local menus in Sage X3 tables are automatically converted into Enums in Sage X3 Services.

  • No additional setup is required.

  • The module defined for the local menu determines the package where the Enum is included.

Naming conventions

US English texts and local menu values are used to define the Enum.

Naming follows standard conventions:

  • PascalCase for Enum names

  • camelCase for Enum values

Here’s an example of a local menu managed through an exception:

  • The Enum name was modified by Sage.

  • The Enum was moved to the x3-master-data package.

  • Enum values were adapted to remove special characters.

When node bindings are validated and packages are generated, a file is created for each Enum in the appropriate lib/enums package directory.

Path: node_modules/@sage/x3-master-data/lib/enums/related-company-settings.d.ts

Generated code:

Copy 
import { X3EnumDataType } from '@sage/xtrem-x3-gateway';
export declare enum RelatedCompanySettingsEnum {
    notRelated = 1,
    votingRightsMoreThanOrEqual10Percent = 2,
    votingRightsLessThan10Percent = 3
}
export type RelatedCompanySettings = keyof typeof RelatedCompanySettingsEnum;
export declare const relatedCompanySettingsDatatype: X3EnumDataType<"notRelated" | "votingRightsMoreThanOrEqual10Percent" | "votingRightsLessThan10Percent", unknown>;
//# sourceMappingURL=related-company-settings.d.ts.map
This code is automatically generated by Sage X3 and is for informational purposes only.
  • Enums simplify the use of local menus in GraphQL.
  • Most are auto-generated, but exceptions must be manually managed.
  • Follow naming conventions and use the Enum exceptions function (GESAENUMB) for special cases.

Enum extensions

A standard local menu can be extended with custom values to meet specific business needs. These customizations are known as enum extensions.

For detailed guidance on how to implement and manage Enum extensions, refer to the dedicated documentation.

Screen management

The screen is defined in 2 tabs:

  • The header

  • The List of values tab

This section outlines the key information for Enum exceptions.

Chapter (AMENLOC)

Select the chapter number you want to configure.
Description (TITCHP)
Title associated with the previous code.
Module (MODULE)
This field displays the module to which the local menu is assigned.
Activity code (CODACT)

An activity code is used to:

  • Make an element optional in the dictionary if the value associated with the activity code is null

  • Identify the specific/custom elements if they are marked with a code starting with X, Y, or Z
Enum name (AENUMNAM)
Enter the Enum name to map the exception to the local menu.
Default package (LOCPACK)
This field displays the local menu's default package.
Package name (APACK)
Select the package where you want to include the Enum.

List of values

This section displays the different messages related to the local menu.

Message number (LANNUM)

Indicates the message number within a chapter. The local menu uses this rank to determine the value of the field associated with the title.
Message (LANMES)
Displays the title associated with the message number in a chapter. This title appears in UI components such as selection lists or toggle switches when the field is used as a local menu.
Enum value (AENUMVAL)
Indicates the Enum value corresponding to local menu's message.
Package name (APACKVAL)
Indicates the package name when the enum value extends the current enum in a custom package.

Error messages

The only error messages are the generic ones.

Tables used

The following tables are implemented by the function:

Table Table description
AENUMBDGH [AENUMH] Enum binding header
AENUMBDGL [AENUML] Enum binding lines