Sage X3 solutions

Administration page Application/Contract Syracuse/Collaboration Class x3solutions Representation x3solutions

A Sage X3 solution entity represents a connection to a Sage X3 system. It is linked to a Sage X3 server and includes multiple endpoints, each corresponding to a specific Sage X3 folder.

Information section

Enter the following details for a Sage X3 server:

Code

A unique identifier for the solution.

Description

A description of the Sage X3 server that displays when the Sage X3 server is referenced on another page. For example, in an endpoint definition.

Solution name

The name of the Sage X3 solution.

Application

Select the appropriate application:

Sage X3 Services

Select the Sage X3 Services connected to your Sage X3 solution.

Use Sage AI

Select this checkbox to activate Sage Copilot's chat and contextual insights features. Clear it to deactivate them.

File protocol section

Static files protocol

Select the protocol used by Syracuse to consume the resource files of the Sage X3 application:

Sage recommends using SADFSQ from Syracuse server version 12.15 (delivered in release 2022 R2/V12.0.30). For earlier Syracuse versions, Apache is still required.

Main server host

The address of the main process server, which can be the network server name or the IP address.

Main server port

The port used by the Sage X3 connection service.

Web server host

The location of the host in which the Apache Web server delivers the Sage X3 resources for classic pages. The host is usually the same as the application server and does not need to be entered. The address can be the network server name or the IP address.

Web server port

The port used by the Apache Web server delivers the Sage X3 resources for classic pages. Default is 80, but you can change it.

Use HTTP proxy configuration

Select this checkbox if a proxy is required for HTTP access.

Runtimes section

Runtime servers are assigned using a round-robin algorithm around the eligible runtimes. A runtime is eligible if is not disabled or blacklisted.

The runtime assignment is done in priority on runtimes with tags matching the execution context, defined in groups, SOAP Pool, or batch server.
If no tag matches, or if the runtime with the same tag is not eligible, the connection is established on the next available runtime according to the round-robin rule, except for runtimes that have a tag with the Exclusive tag checkbox selected.

In a single main runtime architecture, meaning that the enabled application cluster is not set on the Sage X3 solution, certain functions will automatically run only on the main server because of applicative needs. This is an automatic assignment that does not require any configuration.

Server host

The server on which the runtime is installed. It can be a network name or an IP address.

Server port

The port associated with the runtime.

Tags

Represents an affinity list of tags, separated by commas, that allows you to assign the preferred runtime at connection time (see the corresponding paragraph). On the other hand, the same tags can be set either on a group for the user connection, on a SOAP Pool for a SOAP web service connection, or a batch server for the tasks launched by the batch controller.
The application server has by default a MAIN tag.

Exclusive tag

You can only select this checkbox if a tag has been entered. When selected, the runtime can only be accessed if the tags are found in the context of a runtime execution (defined in groups, SOAP Pool, or batch server).

Keep at least one non-exclusive runtime to allow functionalities such as imports to work.

Ban timeout

When a runtime server is not available for connection (if it doesn't answer the connection request), the server is blacklisted and is no longer used to connect during a period in minutes defined by this value. Note that once the banishment has been triggered, the task will cancel the blacklisting that is launched in the server instance. If in the meantime the server is stopped, the blacklist will not be automatically canceled after the time-out. For this reason, it is possible manually to clear the Blacklisted checkbox.

Blacklisted

When a runtime server is blacklisted, this checkbox is selected. It can also be manually selected (for the ban time-out period) and reset. The reset link is particularly interesting if the server was stopped after the banishment because there is no other way to delete it from the blacklist.

Automatic configuration

When the runtime server has been automatically configured by the synchronization service based on the solution.json file, this checkbox is selected. You can add additional runtimes manually, then this checkbox needs to be cleared.

Disabled

Select this checkbox to disable a runtime that is being used.

Enable application cluster

Select this checkbox for a multi-main runtime architecture.

Parallel jobs by runtime during update

Indicates the number of jobs that can run in parallel during the update process. The 0 default value indicates that there is no limitation.

Certificate

Indicates the certificate used by Syracuse to authenticate with servers.

Dependencies section

Batch server

Defines the batch server associated with the Sage X3 solution.

BO server

Defines the BO server, if there is one, that is associated with the Sage X3 server to deliver Business Intelligence data.

Associated endpoints

Selects the endpoints the solution is connected to. Endpoints can be added in multiple selections.

Services available

The following services are available from the right panel:

Check main server settings

This service accesses the main server associated with the solution and checks if the connection is possible. It displays the result on the upper panel.

Check all server settings

This service connects to the main server associated with the solution and checks if the connection is possible on all available servers. It displays the result on the upper panel.

Sage X3 runtime usage

This service displays a table with information about the selected runtime.

Create endpoints

This service displays a dialog box with all the available endpoints for the solution. Select the check box at the beginning of each line to create the endpoint definition with the right parameters.

Synchronize runtimes

This service synchronizes the runtimes.