Binding dictionary
Use this function to view the generated bindings between API nodes and Sage X3 entities, properties, references, and operations.
The binding dictionary specifies how nodes are linked to Sage X3 tables, windows, subprograms, import templates, and other components. When you create a data model that references a node, a corresponding binding record is automatically generated. Any changes to Sage X3 metadata generate or update the binding dictionary when the nodes are revalidated.
Use the Node bindings function (GESANODEB) to customize API nodes and properties.
Prerequisites
Before viewing the binding dictionary:
-
Define the relevant API packages in the Packages function (GESAPACK).
-
Define nodes in the Data models function (GESAWM) or in the Operations function (GESAPIOPE).
-
Define the API property names for table fields in the Table properties function (GESATBP).
Screen management
The screen is defined in six sections:
-
The header
-
The Node properties tab
-
The Reference properties tab
-
The Denormalized node tab
-
The Node references tab
-
The API operation tab
Header
This section outlines the key information for the binding record.
Node properties
This tab displays the properties associated with the selected node and the metadata used to generate the GraphQL schema.
Reference properties
This tab displays the settings and join criteria for the selected reference property.
Denormalized node
This tab displays the properties exposed through a denormalized node.
Node references
This tab displays the references exposed by the selected node.
API operation
This tab displays the API operations associated with the selected node.
| Main node name (APIREF) |
|
This field indicates the main node associated with the operation. It is the node where the operation is generated. That node shows the operation when you explore the graph through an external tool. You can link multiple custom operations to the same node. You can only define one Create, Update, or Delete operation for a node. For example, SalesOrder.create or SalesOrder.delete. When nodes are generated, Sage X3 only considers the active Create, Update, or Delete operation defined in the Operations function (GESAPIOPE). |
| Mutation type (OPEMUTTYP) |
|
This field contains the mutation type associated with the operation. It can be:
Subprograms have a Custom mutation type. The Custom mutation type is not allowed for window-based operations and classes. |
| Can create (CANCRE) |
|
This field indicates whether the operation supports record creation. Note - informationThe Can create option is set by default for an import template-based CRUD mutation.
|
| Can update (CANUPD) |
|
This field indicates whether the operation supports record updates. For import/export templates, this checkbox depends on the Update allowed checkbox in the Import/export templates function (GESAOE). |
| Can delete (CANDEL) |
|
This field indicates whether the operation supports record deletion. |
| Operation method (AX3OPE) |
|
This field provides the method used by the operation. It can be:
For subprograms, it is Script. For import/export templates, it is Import. For windows, it is Window. For classes, it is Class. Node script declares operations executed at the Sage X3 Services side on a node. The operation executes a function developed in TypeScript that is similar to computed values. |
| Active (ENAFLG) |
|
This field indicates whether the operation is active. |
| API operation (APIOPE) |
|
This field contains the associated API operation identifier. This operation identifier is unique. |
| GraphQL operation name (ANODOP) |
|
This field provides the GraphQL operation name. The operation name must be unique in the node definition, like a property name. The operation name must respect the camelCase naming convention. For example, updatePickTicketLine. For Create/Update/Delete mutation types, the operation name is not used in the GraphQL schema, which always uses the standard naming, such as SalesOrder.create, SalesOrder.delete, or SalesOrder.update. |
| Description (ZADES) |
|
This field displays the short description for your operation. |
| Operation override (APIOPEOVW) |
|
This field indicates whether a mutation override exists for the current API operation. For more information, consult the Mutation override documentation on developer.sage.com. |
Error messages
The only error messages are the generic ones.
Tables used
The following tables are implemented by the function:
| Table | Table description |
| ANODEBDG [ANODEB] | Node binding |
| ANODPRADD [ANODPA] | Additional node settings |
| ANODCPS [ANODCP] | Composite references |
| ANODCPT [ANODCT] | Computed properties |
| ANODTRANS [ANODTR] | Transient properties |
| ANODPEXCL [ANODEX] | Masked properties |