How to install X3 Services (Mobile Automation) on Sage X3 2025 R1 (Patch 37)

4 minute read time.

Installing and configuring Sage X3 Services and or GraphQL

This Blog will be updated to include required configuration for Sage X3 Services to be configured with SSL.

1) Check that you have a Badge for ADC’s:-

Check under the normal license Sage X3 file that the required ADC Badges has been added
to the Role of the User that will be using Mobile Automation to log into Sage X3.

Licenses should look like the below, with a combination of these licenses or all of them
selected for ADC Operation:-

A minimum requirement here is 1 of the listed Badges.

The specific Badge being used for ADC’s then also has to be assigned against the user
who will be using it for Sage X3 Mobile Automation.

2. Check that SQL Server supports External connectivity

Check that the SQL Browser Service is running.

Then also check that TCP/IP connections onto SQL Server is Enabled for the Sage X3
Instance Name.

Ensure the TCP/IP protocol above is Enabled

Check that you have a port number, assigned against Dynamic ports.

If you have Enabled TCP/IP for the first time you will have to restart the service in-order to
have the system assign a port number to this service, 49712 is the default port that will be
assigned.

You may use SQL Configurator to restart the SQL Services:-

A new Dynamic port will now be assigned to TCP/IP Protocol:-

3. Extract the X3 Services Installation files

Extract the installation ZIP file into a Directory of your choice.

Install the X3 Services by selecting the X3-services-54-0-36.jar file.
This installation file should be run with administrator privileges.

Follow the prompts:-

Select the directory where to install X3 Services:-

Specify the owner name of the X3 Service.

Specify the HTTP name of the Syracuse Sage X3 connection. This name will be paste into
the YML file required by Sage X3 Services (Mobile Automation)

Copy the User ID and Secret and paste it into Notepad++. Finalize the installation of
Sage X3 Services (Mobile Automation)

4. Configure the Nodelocal.js file

Now we must modify nodelocal.js file under the …\bin\... directory of Syracuse.

exports.config = {

port: 8124,

x3key: true,

collaboration: {

driver: "mongodb",

dataset: "syracuse",

hostname: "x3erpv12sqlvm",

port: 27017,

logpath: "C:\\Sage\\SyracuseComponent\\syracuse\\logs",

certdir: "C:\\Sage\\SyracuseComponent\\syracuse\\certs",

cacheDir: "C:\\Sage\\SyracuseComponent\\syracuse\\cache"

session: {

timeout: 20, // minutes

checkInterval: 60, // secondes

auth: "basic"

x3fusion: {

records: {

"dumpPath": "C:\\Sage\\SyracuseComponent/syracuse/cache/_cvg___USERNAME__"

}

};

Prior to editing the file, ensure to create a backup, any syntaxial errors will result in
Syracuse not starting.

The following lines that must be added to nodelocal.js

exports.config = {

port: 8124,

x3key: true,

collaboration: {

driver: "mongodb",

dataset: "syracuse",

hostname: "x3erpv12sqlvm",

port: 27017,

logpath: "C:\\Sage\\SyracuseComponent\\syracuse\\logs",

certdir: "C:\\Sage\\SyracuseComponent\\syracuse\\certs",

cacheDir: "C:\\Sage\\SyracuseComponent\\syracuse\\cache"

session: {

timeout: 20, // minutes

checkInterval: 60, // secondes

auth: ["basic", "bearer"]

x3fusion: {

records: {

"dumpPath": "C:\\Sage\\SyracuseComponent/syracuse/cache/_cvg___USERNAME__"

}

etna: {

security: {

clientid: "93134d25-7fe0-a092-d302-f8b750bc4560",

secret: "qmaDTb@,$p&AG8ah)vCa2vC1OCqW,=Z#$m"

}

};

Once the above changes have been made, restart the Syracuse Service.

Configure the MS SQL Service for the Schema user that will be used for X3 Services.

Create a SQL Server Service user account that will be used by Mobile Automation
to connect to the SQL Database.

After creating the above SQL Server Service, logout of Sage X3.

Test the connection onto the Mobile-Automation port, by running the below command
inside PowerShell:- (“Invoke-WebRequest http://localhost:8240/ping”)

You should receive a status code of 200 if successful.