Sage X3 solutions

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

A Sage X3 solution entity describes a connection to a Sage X3 solution. Associated with a Sage X3 server, several endpoints that correspond to Sage X3 folders.

Information section

Enter the following information for a Sage X3 server:

Code

A unique code that identifies the solution.

Description

Description of the Sage X3 server that displays when the Sage X3 server is referenced on another page, for example, an Endpoint definition.

Solution name

Indicates the name of the solution.

Solution root directory

Indicates the solution's root directory.

Application

Select your application from the following:

  • Sage X3
  • Sage X3 HR & Payroll
  • Sage X3 Warehousing

File protocol section

Static files protocol

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

  • HTTP protocol (Apache Server)
  • Sage X3 protocol (SADFSQ)

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

Servers section

Main server host

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

Main server port

The port used by the Sage X3 connection service to the solution.

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. The port is usually 80, but it can be changed.

Use HTTP proxy configuration

A check box that indicates if the proxy must be used for HTTP access.

Runtimes section

Enable application cluster

To be checked on a multi main runtime architecture.

Runtimes

A solution can be accessed by several runtimes that are described in this array. If several runtimes exist, the load balancer will, by default, use a round-robin algorithm that selects a runtime at connection time; this algorithm can be changed according to the parameters associated with the runtimes:

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.

Tag

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

This check box can be selected only 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 check box.

Blacklisted

When a runtime server is blacklisted, this check box 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 check box is selected. Additional runtimes can be added manually, then this check box needs to be cleared.

Disabled

Select this check box to disable a runtime that is being used.

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 against the servers.

Runtime assignment

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

The runtime assignment is done in priority on the runtimes that have the same tag as the context runtime execution, (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 those 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.

Batch server section

Defines the batch server associated with the Sage X3 solution.

BO server section

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

Services section

Sage X3 Cloud Development Platform URL

Defines the URL on which the Sage X3 service can be contacted.

Sage X3 Services URL

Defines the URL on which the Sage X3 Services service can be contacted. You need Sage X3 Services to use Mobile Automation (ADC) for distribution.

Besides Mobile Automation, installing Sage X3 Services also allows for the hosting of other applications.

SQL service

Defines the MS SQL service, or Oracle service used by the Sage X3 service.

MongoDB service

Defines the MongoDB service used by the Sage X3 service.

Endpoints section

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

Services available

Several 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 server settings

This service is available directly on the line of the server array. It checks if the connection is possible and 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.

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.