Classes

A unique identifier used to reference and manage classes within the system.

A brief label that explains the purpose of the class.

Defines how the class behaves and under what conditions it can be used. The type determines its relationship with the database, the availability of methods and accessors, and its role within the system.

Persistent

Represents an entity stored in the database. Standard operations such as Create, Read, Update, and Delete (CRUD) are available and can be managed by the Sage X3 supervisor layer. This type supports both accessors and methods.

Interface

Used for manually managing CRUD operations. It is not linked to database tables but still supports accessors and methods.

Basic

Supports accessors and methods but does not allow mappings. Typically used for child classes within a persistent class structure.

Technical

Represents an entity where methods can be defined, but accessors are not available. Properties of this class type cannot be displayed in representations.

System

Defines a data structure without accessors or methods. Properties of system classes are not visible in representations.

Applicable only to persistent classes. It defines the main table on which the CRUD operations are performed. The other tables are defined in the Mapping tab.

Specifies the database index used to define the class key and determines which table fields uniquely identify records for CRUD operations.

This field is only applicable to persistent classes.

Displays the key structure used to identify records, depending on the class type:

• Persistent classes: Displays the key components of the selected index. If multiple segments are present, they display in the SEGMENT1+SEGMENT2+SEGMENT3 format, matching the syntax used in the table dictionary.

• Interface classes: Allows the entry of key components using the same syntax if several components exist. The properties used must belong to the class.

• Other class types: This field remains empty and is not applicable.

Indicates whether operations on the class are executed within a database transaction. Ensures data consistency and rollback capability in case of errors.

This field is only applicable to interface classes.

Defines whether the class is protected during standard patching (if the code starts with X, Y, or Z) or marked as optional.  It behaves like all activity codes defined in the dictionaries.

If left empty or if the code is active, the structure is generated.

Technical module to which the representation is associated.

When selected, marks the class as hidden. Hidden classes are not exposed in representations or standard interfaces, and are typically used for internal or technical purposes.

When selected, enables the class data to be indexed by the search engine for properties marked as Searchable.

Applicable only to persistent classes.

Unique identifier for the collection within the class. Used to reference and manage the collection's structure and behavior.

A brief label for the collection. Helps identify its purpose or contents within the class structure.

Specifies how the property array is allocated in memory for class instances.

• 0: No allocation.

• 1: Allocate one instance.

• Maximum: Allocate the maximum number defined.

Used to control memory usage and structure initialization.

If specified, this sizing activity code defines the maximum size of the collection dynamically. It enables automatic memory allocation during processing, eliminating the need for manual memory adjustments.

Maximum size of the collection. The maximum size is mandatory only when the collection is used by properties and not by an instance.

This field refers to the property of the class that stores the number of lines created in the collection.

If this check box is selected (Insertion = yes), lines can be inserted on the collection. This will be used as the default value on the representation based on the class, but you can change this value (Insertion = no) on the representation. The corresponding method is called ADDLINE.

Select this checkbox to enable line deletion within the collection. This setting will be used as the default value on the representation based on the class, but you can change this value on the representation. The corresponding method is called ADDELLINE.

Select this checkbox to enable line sorting within the collection. This setting will be used as the default value on the representation based on the class, but you can change this value on the representation. The corresponding method is called ASORT.

Select this checkbox to enable the insertion of lines at the end of the collection. This will be used as the default value on the representations based on the class, but you can change this value on the representation.  The corresponding method is called AINSERT.

Indicates the origin of the script.

• Standard: Provided by the software vendor.

• Vertical: Supplied by the vendor or a partner for a specific industry sector.

• Specific: Developed by a partner or customer to meet custom needs.

This is the name of the script. Follows the class_Cyyyy naming convention, where:

• class is the class code

• yyyy begins with:

  • STD for standard scripts

  • VER for vertical scripts

  • SPE for specific scripts

This ensures consistent identification and categorization of scripts.

Order in which the $METHODS and $PROPERTIES labels are called during the event.

Used to protect the script during standard patching (if starting with X, Y, or Z) or to control its activation. When active, the script is executed. When inactive, the call is skipped.

Identifies the name of the method or operation callable on the entity. At runtime, this value is stored in the ACTION variable when the corresponding event is triggered in the $METHODS label, provided CURPTH = "".

A short description to help understand the context and intended use of the class.

Specifies the data type of the value returned by the method or operation. This corresponds to the type of the ARET_VALUE variable used in the event linked to the method. It determines how the returned result is interpreted and processed.

Code used to protect the method during the standard patching process if the code starts with X, Y, or Z, or to activate/deactivate the method in the class.

If this checkbox is selected, the line refers to an operation. If not, the line refers to a method.

Required only for operations, this field specifies the default access index used to retrieve class instance values during a Read operation. It determines which key segments are needed when a representation link triggers the operation, ensuring the correct context is built for execution.

Specifies the name of the variable that holds the parameter value during execution. This variable is accessible in the code triggered by the $METHODS event and is used to pass contextual data to the method or operation.

Indicates the data type of the parameter passed to the method. This corresponds to the keyword used in the variable declaration and determines how the method interprets the incoming value.

Provides a brief explanation of the variable’s purpose and usage within the method or operation.

Specifies how the parameter is transmitted during the method or operation call:

• By address: A reference is sent to the call. changes made during the call on the variable will directly change the value of the parameter.

• By value: A parameter is copied and the value sent can be modified during the call with no impact on the parameter value.

• Constant: A reference is sent to the call, but the parameter is read-only. Any attempt to modify it during execution results in an error.

Specifies whether the parameter is an array and defines its starting index:

• No: The parameter is not an array.

• From 1: The parameter is an array with indexing starting at 1.

• From 0: The parameter is an array with indexing starting at 0.

This setting ensures correct handling of parameter values during method or operation execution.

Specifies the class to which the parameter belongs when its Type field is set to Instance.

Key segment name.

Data type of the key segment, based on recognized variable declaration keywords.

Only data types supported by the database segment keys are allowed.

Description of the key segment’s purpose or role. Helps clarify its function in the context of the operation.

Displays the initial letter of each method to indicate its type. For example, C for Create.

This code is restricted to internal use only.

Displays the full name of each method. For example, Create for the C method.

Allows disabling a method by assigning an activity code.

If the assigned activity code is inactive at runtime, the method will be unavailable, regardless of the value of the checkbox.

When selected, this checkbox disables the method and prevents its code from being generated in the class.

Specifies the name of the property, which is used in Sage X3 scripts.

If the class is persistent, it is strongly recommended to name properties identically to the corresponding columns in the database tables used for data storage.

Failing to do so will require additional code to map class properties to the data retrieved from the database cursor during CRUD operations.

Determines the chronological order in which the init and control methods of the structure are generated. Methods are created following the sequence defined by the value of this field.

You can use this property description when designing user interfaces through representations.

Specifies the data type of the field.

Depending on the selected data type, additional information can be required:

• Init and control parameters: Parameters for the initialization and control actions associated with the data type.

• Object options: If the data type is linked to an object, relevant options defined in that object can also be needed.

If this field is left empty, you need to reference the property through an instance of the child class.

Specifies the number of the local menu to use when the internal type of the selected data type is Local menu (M).

This number defines the set of available values for the property.

For example, menu 1 corresponds to the Yes/No options.

Use this field to specify the field length, if this latter is not specified on the data type and if the data type allows it. For example, absence of format, local menu, and so on.

For string values, enter the number of characters.

For numeric values, use the N.M format, where:

• N is the number of digits before the decimal point.

• M is the number of digits after the decimal point.

Defines the activity code that controls whether the field is generated.

• If no activity code is assigned, the field is always present.

• If the assigned activity code is inactive, the field will not be generated, regardless of other settings.

• Activity codes starting with X, Y, or Z are used to protect specific properties in standard classes during the patching process. These codes are not affected by folder updates.

• For other cases, the activity code corresponds to the one defined during Sage X3 folder configuration, and behaves like any standard activity code defined in the dictionaries.

Specifies the name of the class associated with the property, if the property is a class instance.

You can enter a class name only if the Type field is empty. In this case, the class name becomes mandatory.

Specifies the collection to which the property belongs.

• If there is only one property, you can leave this field empty.

• If there are multiple properties, this code must refer to one of the collections defined in the current function. This collection can represent:

  • An array of child references (for example, header/lines structure).

  • A denormalized array stored across multiple columns in a database.

The Lob table and Lob field fields specify where rich media elements (CLOB/BLOB data) are stored.

If the data type is CLOB or BLOB and managed by the supervisor, these fields indicate:

• The table (Lob table)where the LOB is stored.

• The column (Lob field) that contains the media data.

Based on the selected table, the Keys grid is automatically populated to enable proper joins using key values.

If the data type is not managed by the supervisor, you cannot fill these fields in. In such cases, a custom program must handle the join logic manually.

The Lob table and Lob field fields specify where rich media elements (CLOB/BLOB data) are stored.

If the data type is CLOB or BLOB and managed by the supervisor, these fields indicate:

• The table (Lob table)where the LOB is stored.

• The column (Lob field) that contains the media data.

Based on the selected table, the Keys grid is automatically populated to enable proper joins using key values.

If the data type is not managed by the supervisor, you cannot fill these fields in. In such cases, a custom program must handle the join logic manually.

Displays the content type associated with the selected data type.

Indicates whether the property is mandatory.

When set to Yes:

• A Mandatory field check is triggered in the field control method.

• The class instance is only considered valid if this property is not empty.

Use this field to perform additional consistency checks through a simple setup.

This feature is intended for customization purposes and allows for extended validation logic beyond standard controls.

Updating this field does not require protection by an activity code.

Defines a property used when the control table depends on another table.

Defines the access control code used to manage user permissions for this property, based on configuration settings.

Indicates if the field is included in the search index. The field will be indexed only if you select this checkbox.

Defines a category used to filter search results.

For example, if you create a category called SALESREP and assign it to the Sales rep field in a customer record, this same field can also exist in related entities like sales orders and sales invoices.

When searching for MARTIN, and if MARTIN is a sales rep listed in:

• 20 customer records

• 45 sales orders

• 35 sales invoices

Selecting the SALESREP category will restrict the search results to only those records, even if MARTIN appears in other unrelated entities.

Categories are defined in miscellaneous table number 16.

Select this checkbox to generate a GET accessor calling code on the property.

This setting can be changed at any time in the dictionary, including in standard classes.

If selected, this checkbox will not be deactivated by any patch, ensuring the accessor remains active even after updates.

Displays the automatically generated code for each parameter.

This code is system-defined and you cannot modify it manually.

Displays the automatically generated description for each parameter.

This description is system-defined and you cannot modify it manually.

Displays the automatically generated data type for each key segment.

This type is system-defined and you cannot modify it manually.

Defines how the parameter is transmitted during the call. This setting is system-defined and you cannot modify it manually.

• By address: A reference is passed. Changes in the call directly update the parameter value.

• By value: A copy is passed. Changes in the call do not affect the original parameter.

• Constant: A reference is passed as read-only. Any attempt to modify it during the call results in an error.

Specifies the formula that provides the value for the parameter. Some restrictions apply, as the formula must be evaluated in the client context.

Displays the column name of each key segment.

This value is system-defined and you cannot modify it manually.

Displays the description of each key segment.

This value is system-defined and you cannot modify it manually.

Displays the data type of each key segment.

This value is system-defined and you cannot modify it manually.

Specifies the value assigned to the key segment.

You can modify this value if necessary.

Identifies the main table from which other tables are accessed through direct links or cascades.

This field is populated automatically based on the main table defined in the General tab of this function.

This field is automatically populated according to the index and description defined in the General tab of this function. A short description displays next to this field.

Select this checkbox for the generated program associated with the class to manage the Read operation.

If cleared, the development partner must write the code for reading the data from the main table in the corresponding AREAD event.

Select this checkbox for the generated program associated with the class to manage the Create operation.

If cleared, the development partner must write the code for reading the data from the main table in the corresponding AINSERT event.

If this check box is selected, the generated program associated with the class will manage the 'Update' operation. If cleared, the development partner must write the code for reading the data from the main table in the corresponding "AUPDATE" event.

Select this checkbox for the generated program associated with the class to manage the Delete operation.

If cleared, the development partner must write the code for reading the data from the main table in the corresponding ADELETE event.

You can define a formula used to filter the data. The formula can only reference columns from the main table associated with the class.

Specifies the reference of the property belonging to the child class.

Class code associated with the property reference. This field is filled in automatically and cannot be modified.

Identifies the table that is linked to the table of origin.

Specifies the abbreviation under which the linked destination table is opened.

If left blank, the table’s default abbreviation is used.

This field is useful when the same table appears multiple times in the grid, as each linked line must have a unique abbreviation to be opened simultaneously.

Identifies the main table at the origin of the link described on the current line. This can be the main table or one of the linked tables from previous lines.

Specifies the abbreviation under which the linked origin table is opened.

If left blank, the table’s default abbreviation is used.

This field is useful when the same table appears multiple times in the grid, as each linked line must have a unique abbreviation to be opened simultaneously.

Indicates the relationship between the origin table and the linked table. Possible values:

• 1,1: For each line in the origin table, only one line in the linked table is read (defined by the key expression).

• 1,N: Multiple lines in the linked table can be read. These are determined by the key expression, which can be partial if split into several parts (all lines matching the entered key elements are processed).

Defines the table key code used to read the linked lines. By default, the first key of the table is used.

This field defines the initial order of the lines when a Read operation is performed on a class instance. If left blank, the main index is used.

Specifies one or more calculated expressions (separated by semicolons) used to determine the key value for performing the join.

• Each expression is evaluated, and its result identifies the key value.

• When multiple joins are authorized, only the first key elements need to be provided.

• Expressions can include constants and fields from tables previously defined in the link list.

Defines a formula applied to the table specified in the Linked table column to filter data in the template.

• These conditions are not applied during the indexation process.

• The syntax follows the Sage X3 script language used in Filter instructions.

Specifies the activity code used to protect modified or specific lines in the grid, or to disable lines when the associated activity code is inactive.

This checkbox determines how CRUD operations are implemented:

• Selected: The supervisor layer calls the method implemented in the class defined on the line to perform the CRUD operation.

• Cleared: CRUD operations are embedded in the main class code when the corresponding checkboxes are selected.

This checkbox determines how updates on lines are processed:

• Selected: All lines are deleted and reinserted during an update, instead of updating only modified lines. This can impact performance but is necessary when line record keys change on each update or insertion (for example, when line numbers are reassigned).

• Cleared: Only modified lines are updated.

This checkbox indicates whether the generated program associated with the class will handle the Read operation.

• Selected: The generated program manages the Read operation.

• Cleared: The developer must implement the logic for reading data from the main table in the corresponding AREAD event.

This checkbox indicates whether the generated program associated with the class will handle the Create operation.

• Selected: The generated program manages the Create operation.

• Cleared: The developer must implement the logic for reading data from the main table in the corresponding AINSERT event.

This checkbox indicates whether the generated program associated with the class will handle the Update operation.

• Selected: The generated program manages the Update operation.

• Cleared: The developer must implement the logic for reading data from the main table in the corresponding AUPDATE event.

This checkbox indicates whether the generated program associated with the class will handle the Delete operation.

• Selected: The generated program manages the Delete operation.

• Cleared: The developer must implement the logic for reading data from the main table in the corresponding ADELETE event.

Displays the child class. You cannot modify this field.

Displays the property of the class linked to a key segment. You cannot modify this field.

Displays the data type corresponding to the property. You cannot modify this field.

Displays the parent class, which is the class from which the link is established. You cannot modify this field.

Specifies the parent property used to automatically assign values to child properties during CRUD operations.

• You can define either a parent property or a constant value (not both).

• If neither is defined, no automatic assignment occurs (common for the last key element).

This configuration generates propagation rules and an initialization rule (ADDLINE event).

Specifies the constant value used to automatically assign values to child properties during CRUD operations.

• You can define either a parent property or a constant value (not both).

• If neither is defined, no automatic assignment occurs (common for the last key element).

This configuration generates propagation rules and an initialization rule (ADDLINE event).

Identifies a class property where a legislation code can be entered.

• If empty: The record is accessible by all users.

• If populated: The user needs to have rights to access the specified legislation.

This enables the supervisor to automatically filter data accessible in a class instance for a given user.

Identifies a class property where a company code is entered.

The corresponding database column can be empty or contain the company linked to the data.

This allows the supervisor to filter data for CRUD operations based on user rights (for example, read-only access for some companies).

Identifies a class property where a site code is entered.

It is used to filter data at a more granular level than with the Company property field, with similar access control logic.

Identifies a class property where an access code is entered.

Used for more detailed data filtering, similar to Company property and Site property.

If empty in the database, the dataset has no access restrictions.

Unique code for the filter. A selection action is available to select a filter defined for the class.

Displays the description of the filter.

Defines the filter condition using Sage X3 script syntax (same as Filter instructions).

You can only use columns from the main table or directly linked tables (with a 1,1 join).

Specifies the error message displayed to the user if a request does not meet the filtering condition.