Operations

Select the mutation type. It can be:

• Custom: These miscellaneous operations can perform any action linked to the node (including creating, updating, or deleting) and return any structure or reference. You can define them freely.

• Create/Update/Delete: These are standard GraphQL operations. A single node can only have one of each.

For subprograms, select Custom.

The Custom mutation type is not allowed for window-based operations and classes.

Select the operation method. It can be:

• Import, Script, or Node script for a Custom mutation type

• Window, Import, or Class for a Create/Update/Delete mutation type.

For subprograms, select Script.

For import/export templates, select Import.

For windows, select Window.

For classes, select Class.

Select Node script to declare 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.

Select or enter your Sage X3 API operation identifier.

This operation identifier must be unique.

Select the node where the operation generates. 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).

Define the GraphQL operation name to generate on the selected node.

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.

Select the module of your operation.

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

Enter the identifier used as a reference for the node bindings records generated for the operation.

The Operation identifier initializes this field by default.

Enter a node name for your request.

The GraphQL operation name field initializes this field by default, but you can modify it.

The node name must respect the PascalCase naming convention.

After saving the operation, a transient node (not linked to a database table) automatically generates in the node bindings tables based on the Node binding (request) node identifier and the Node name (request) node name.

For subprograms, this technical node stores the mapping between the subprogram parameters and the transient properties available on the main node to build the mutation payload and execute the mutation.

The transient properties are added on the main node when you generate the package in VS Code. 

For import/export templates, windows, or classes, this technical node maps the fields to the main node and builds the mutation payload.

An operation using an import template, window, or class, is bound to the main node tied to the import template, window, or class.

The node definition is accessible in the Binding dictionary function (GESAPINOD).

Select the package where you want to generate the operation.

For a script mutation, the node binding (response) is the same as the node binding (request). The node definition for the response is the same as the node definition of the request.

This field is not available for operations using an import/export template or a window.

Select the functional authorization for your API operation.

This ties the operation to the functional access right defined in the user's functional profile (access rights by site).

Select this checkbox to set the Create mutation type for your operation.

Select this checkbox to set the Update mutation type for your operation.

For import/export templates, this checkbox depends on the Update allowed checkbox in the Import/export templates function (GESAOE).

When you select the subprogram, the variables are automatically loaded in the Binding column.

Enter the property names to map to the subprogram variables in the node definition.

After saving the operation, a transient node and properties are automatically created in the node bindings tables based on the node identifier, the node name, and the property names.

The transient node is visible in the Node bindings function (GESANODEB).

The transient nodes and properties are visible in the Binding dictionary function (GESAPINOD) under the Script left list.

In VS Code, the properties are generated on the node as transient, meaning not linked to the database fields as for regular properties that are bound to table fields in the Tables function (GESATB).

This column indicates the node the imported fields belong to.

When you select the import/export template, the fields are automatically loaded in the Binding column.

If you properly configure the import template identifiers and their corresponding nodes, the property names are also automatically loaded.

You must manually select the transient properties used to map the technical field defined in the import template.

After saving the operation, the associated node binding record and properties are automatically created in the node bindings tables.

The node operation is visible in the Node bindings function (GESANODEB) under the Imports left list.

The node operation and properties are visible in the Binding dictionary function (GESAPINOD).

Enter the name of the denormalized collection to which this property belongs.

Use this field to configure your collections.

Enter the collection name in the Property column and select Collection on the same line for your collection's parent level.

The parent level must be on the line just above the collection.

If multiple collections are under the same parent node, then you have to define this parent line for each collection.

Select this checkbox to validate the properties to map on the screen fields.

New fields added afterward in the screen definition will be displayed on the associated API operation but unselected. It will then be possible to set the corresponding property names from the node and mark the new screen fields as selected for the mapping.

You can save the operation even if a mandatory property is missing in the mapping, but you won't be able to activate it.

When you select the window, the fields to map are automatically loaded in the Binding column.

Use this field to configure your collections.

Enter the collection name in the Property column and select Collection on the same line for your collection's parent level.

The parent level must be on the line just above the collection.

If multiple collections are under the same parent node, then you have to define this parent line for each collection.

Use this field to configure your collections.

Enter the collection's name defined at the parent level in the collection's Property column.

This column defines the presentation of the fields inside their block.

• Grid: The fields are organized in a scrolling grid of lines (horizontally and vertically, if necessary).

• List: List of fields independent of one another.

• Text: Display of text in a fixed background without it being entered.

• Hidden: Declaration of an invisible list section. It is used to include in a screen technical fields that are not displayed but usable by the processes linked to the screen.

• Browser: For web pages.

• HTML editor: Reserved for the entry of the documentation.

• Business Intelligence: For executing a BO report (reserved for the supervisor).

Select this checkbox to validate the properties to map on the class fields.

New fields added afterward in the class definition will be displayed on the associated API operation but unselected. It will then be possible to set the corresponding property names from the node and mark the new screen fields as selected for the mapping.

You can save the operation even if a mandatory property is missing from the mapping, but you won't be able to activate it.

When you select the class, the fields to map are automatically loaded in the Binding column.

Use this field to configure your collections.

Enter the collection name in the Property column and select Collection on the same line for your collection's parent level.

The parent level must be on the line just above the collection.

If multiple collections are under the same parent node, then you have to define this parent line for each collection.

Use this field to configure your collections.

Enter the collection's name defined at the parent level in the collection's Property column.

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

Enter the name of the collection to which this property belongs.