Sage X3 installation procedure

Introduction
This document describes the installation procedure of a Sage X3 solution on Windows,
Linux and AIX servers.
Warning: This process is only valid for the first installation of a SAFE X3 technology
version 11 product on new servers and workstations (that do not host a prior product
update of the product).
( For end users who wish to upgrade their existing Sage X3 solution in 10 to 11, please
check the 10 to 11 Easy Upgrade Guide )
There is no specific recommendation, the user must simply:
 Define the architecture of the servers that make up the SAFE X3 solution.
 Check the compatibility of your system environment with the hardware and software prerequisites of each
component and follow the installation process that is available on the official support supplied (product
DVD-ROM or network location where all the installation files have been placed).

Installation steps
The installation steps are described below. Additional information about the detail process will
be found in the corresponding paragraphs.
Notes:
 Before doing Sage X3 installation, Java Runtime Environment or JDK version 7 or higher must
be installed first. It can be downloaded from Oracle
website http://www.oracle.com/technetwork/java/javase/downloads/index.html. Make sure to download
and install the correct java version based on your operating system. For example, select Windows x64
java file for a 64-bit Windows operating system or Windows x86 java file for a 32-bit Windows operating
system.
Installation and configuration of the SAFE X3 solution (Linux,
AIX or Windows):
 Install the SAFE X3 ADXADMIN administration runtime
 Install the components to configure a Sage X3 solution
 Install the SAFE X3 management console on a Windows workstation
 Create a Sage X3 solution using the SAFE X3 management console
Install the Web "Syracuse" Server components (Linux or
Windows):
 Install MongoDB
 Install Elastic Search
 Install the Web "Syracuse" component
Complete the installation for the Web "Syracuse" server and
Sage X3 solution:
 On the Web "Syracuse" server
 On the Sage X3 solution
 Install the SEED folder
 Apply list of patches
 Update search index
Installation of the Production Scheduler :
 Install the Production Scheduler
Installation of the Print server component (Windows):
 Install a SAFE X3 Print server component
o Configure the print server using the SAFE X3 console
o Publish the SAFE X3 folders for the print server using the console
Further installation of Documentation servers, Print servers,
Process servers, Java servers or Webservice and ADC servers:

* Install a Documentation server component (Linux or Windows)

* Complete the installation on the Web "Syracuse" server

* Install an additional Print server component (Windows)
* Configure the Print server using the SAFE X3 console
* Publish the Sage X3 solution folders on the print server using the console

* Install an additional Process server component (Linux, AIX or Windows)

* Configure the process server using the SAFE X3 console

* Install a SAFE X3 Java server component (Linux or Windows)

* Configure the Java server using the SAFE X3 console
* Publish the Sage X3 solution on the Java server using the console

* Install a SAFE X3 Webservice and ADC server component (Linux or Windows)

* Configure the Webservice and ADC server using the SAFE X3 console
* Publish the Sage X3 solution on the Webservice and ADC server using the console

Installation and configuration of the SAFE X3 Business

Intelligence:
 Install the Business Intelligence

Install the SAFE X3 ADXADMIN administration

runtime
Installing an administration runtime on each server is mandatory for all Process, Application,
Database, Print, Java servers and Webservice and ADC servers. It is not necessary
to install the administration runtime on the client workstations or on the workstation that will run
the management console.
 To launch the installation, double-click the '.jar' file in the SafeX3Adxadmin folder.
* Administration runtime: SafeX3Adxadmin. The ADXADMIN service port will default to 1818.
This is the port that the service will use to communicate with the Console. It must not be blocked
by existing firewalls or Virus software.
For Windows servers, it is mandatory to launch the installer as a user with administrator rights
and 'Log on as a service' right on each server.
For Linux servers, it is recommended to launch the installer as root; otherwise, the
corresponding service will not be created (adxadmin). It is then recommended to launch the
adxadmin service as root and to use, in the SAFE X3 Console, the proprietary account of the
SGBD Oracle installation to configure the database component. For more information on this
topic, refer to the console documentation, paragraph 'AdxAdmin process rights' on page
'Component loading - dialogue box'.
For AIX servers, the installer doesn't create an adxadmin service but it launches an adxadmin
process (adxd). It is then recommended to launch the installer as root and to use, in the SAFE
X3 Console, the proprietary account of the SGBD Oracle installation to configure the database
component. For more information on this topic, refer to the console documentation, paragraph
'AdxAdmin process rights' on page 'Component loading - dialogue box'.

Install the components to configure a Sage X3

solution
Install the required components from the SafeX3Installs folder on the corresponding destination
server(s):
To launch the installation, double-click the '.jar' file in the folder of each component.
 Database: SafeX3Sqlserver or SafeX3Oracle depending on the database to be used for SAFE X3 (SQL
Server or Oracle). You will need to have completely installed MS SQL or Oracle database engine using
the required settings before attempting this installation. This component should only be installed on the
database server.
 Application: SageX3Application. This component should be installed on the application server that hosts
the SAFE X3 Runtime component. For a new installation, select 'New installation' option.
 Process server: SafeX3Runtime. This component should be installed on the application server. For a
new installation, select 'New installation' option.

Install the SAFE X3 management console on a

Windows workstation
Install the required component from the SafeX3Installs folder on the corresponding destination
server:
 Management console: SafeX3Console
To launch the installation, double-click the '.jar' file in the SafeX3Console folder.

Create a Sage X3 solution using the SAFE X3

management console
Note: The Apache HTTP Server 2.2 or higher must be installed on the Application Server before
a Sage X3 Solution can be configured. It can be downloaded from Apache website
at http://httpd.apache.org/download.cgi. For Windows distribution, it is located in binaries/win32.
Select the no_ssl MSI Installer Package.
 Note: the user account used in the steps below must have administrative right and 'Log on as a
service' right on each server.
Using the SAFE X3 management console:
 Create a new solution in the console
o Open SAFE X3 V2 management console and select the Solutions tab from the left list
o Click on the Add button to create a new solution.
o Click on the New button.
o Enter the server name where the Application and Runtime components were installed.
o Enter the port, user, and password for the Sage SAFE X3 AdxAdmin service, and select 'Keep password'
checkbox. The AdxAdmin default port is 1818.
o Choose the APPLICATION component and click Next.
o Choose the RUNTIME component and click Next.
o Choose the option for 'Configuration by the console' and click Next to continue.
o Click on New button and enter the server name where the Database component was installed.
o Enter the port, user, and password for the Sage SAFE X3 AdxAdmin service, and select 'Keep password'
checkbox. The AdxAdmin default port is 1818.
o Choose the DATABASE component and click Next.
o Enter the Identifier (name of the solution), Label, and Commentary fields.
 Configuring the database server
o On 'Data - Application' tab, double click on the Password of 'sa', Sql Server instance, Database name, and
DBMS installation path fields to enter the parameters value.
o Click on 'Data' button to configure the data server.
o Select the 'Full configuration' option to use the default scripts and click on 'Ok' button.
o Confirm that the Data portion is set to Active.
 Configuring application and main process server components
o Double click on the 'SAFE X3 service port number' to enter the port to be used by the main process server
service. Use a different port as port 1801 is now used by Microsoft Message Queuing.
o Double click on the 'User login for the SAFE X3 service' to enter the user that will start the SAFE X3
runtime service.
o Double click the 'User account password' to enter the password for the user account.
o Double click in the 'Apache installation path' field to enter the path where Apache software was installed.
o Click on 'Save' button to save the new parameter settings.
o Click on the 'Application' button to configure the application and main process server.
o Sage X3 solution will be created on the server when the application and runtime configuration is
complete.
o Confirm that all three components of the solution are set to Active.
Please refer to SAFE X3 management console help page (open SAFE X3 management console
and press F1) for more information.

Install MongoDB
MongoDB (as defined by its editor) is an open source document database, that you need
to install before installing the Web "Syracuse" component.
From release 9, the installation support provided by Sage includes MongoDB folder version
number 3.0 Entreprise for easy installation. New options have been added (especially for secure
MongoDB connection).
 The detailed procedure is given in the following document.

Install Elastic Search

Note: The Java Development Kit (JDK) version 7 or later must be installed first before installing
Elastic Search server.
Elastic Search (as defined by its editor) is an open source, distributed real-time search and
analytics engine for the cloud. The DVD-ROM includes the Elastic Search folder version number
0.90.12 for easy installation.
Install the required components from the SafeX3Installs folder on the corresponding destination
server(s):
To launch the installation, double-click the '.jar' file in the SafeX3ElasticSearch folder.
 ElasticSearch server: SafeX3ElasticSearch. For a new installation, select 'New installation' option. If
this is an upgrade from existing installation, select 'Modify installation' option.
Take note of the Elastic Search hostname and the corresponding http service port number that
have been setup, and keep this information at hand while launching the Web "Syracuse"
server installation.
There is a known issue in Elastic Search which causes the error message "Search engine failed
due to stack size configuration. Please increase the stack size of elastic search in order to fix
this problem.". To fix this issue you have to increase the stack size of Elastic Search. Please
contact support to do it.

Install the Web "Syracuse" component

Install the required components from the SafeX3Installs folder on the corresponding destination
server(s):
To launch the installation, double-click the '.jar' file in the folder of each component.
 Web "Syracuse" server: SafeX3Syracuse
For more information about the Web "Syracuse" server installation, see the Web Syracuse
server installation procedure.
For Windows servers, it is mandatory to launch the installer as a user with administrator rights.
For Linux servers, it is recommended to launch the installer as root; otherwise, the
corresponding service will not be created.
Reminder: As a prerequisite, it is necessary to install the MongoDB database and Elastic
Search onto the server for the Web "Syracuse" component.

On the Web "Syracuse" server

 If the generation of certificates did not occur during the installation of the administration server
component, you need to generate the public key corresponding to the server. This file must be generated
with the name of the server ('hostname'.pwd - in which hostname matches the name of the SAFE X3
administration server).
Please refer to the corresponding Certificate installation documentation.
 Check that the following services have been started:
o Agent Sage Syracuse
o ElasticSearch for Syracuse
o MongoDB for Syracuse
o Sage Syracuse
 Note: You can set a dependency between services to ensure services are started in the order
they are needed. First, you must start the ElasticSearch for Syracuse service and MongoDB
service, and then the Agent Sage Syracuse service. The Sage Syracuse service must not be
set to start automatically.

On the Sage X3 solution

 If the copy of certificates did not occur after the installation of the Web "Syracuse" server component, add
the public key (file [ServerName].pem) in the keys folder of the solution runtime. Note that if the server
name contains dot characters, they must be replaced by the underscore character (for example
'file.domain.name.pem' must be 'file_domain_name.pem')
 Check that the following services have been started:
o Sage X3 solution service (in function of the name of X3 solution).
o Database services (in function of the Sage X3 database which is installed under SQL Server or Oracle).
 From a Web "Syracuse" server connection (as an administrator):
o Log on to the following URL "http://[ServerName:port]" (for example: http://aysyrqav7:8124), using an
Internet browser, and the user/password: admin/admin.
o Define the Sage X3 solution: Click the link “Sage X3 solution” in the administration menu and then click
“+New Sage X3 solution”. Enter a Code, a description, an Application and the exact name of the Sage X3
solution, Main server host and Main server port. Click “Save”.
o Use the „Create endpoints‟ service in this Sage X3 solution entity. It displays a dialog box with all the
available endpoints for the solution. Select the check box at the beginning for the root folder (e.g. X3 ).
o Update the endpoint : use the “Endpoints” link in the administration menu. The endpoint corresponding
to the root folder that was previously selected, will have been automatically created. Select it and add
access to the 'Super administrators' group under ADMINISTRATION section. Click “Save”.
o Log out from the web server (Log out action in 'Your profile'), then log in again as admin.
o In the black header, just at the left of the 'Home' picture, click on 'Your current endpoint is' and select the
endpoint of the root folder of the product e.g. X3.
o Finalize the Supervisor installation: Click on the Setup menu on the upper left corner, and click on
'Users' (Setup > Users > Users, GESAUS function). Wait until the Supervisor Installation is complete.

Install SEED folder

 A demonstration folder is supplied with Sage X3. The name of this folder is SEED, this means that the
first endpoint which you can connect on (aside from the root folder X3) is the SEED endpoint. Once the
complete installation path has been done, you can play with this folder as a self-training material.
o Navigate to SageSEEDFolder directory included in product DVD-ROM.
o Double click on the SEED.zip file to launch the self-extracting archive.
o There are two folders SEED and X3_PUB after extraction, copy the extracted SEED folder to the location
where the Sage X3 application folders were installed e.g. C:\Sage\SAGEX3V7\X3V7\folders\
o Copy the extracted X3_PUB\SEED subfolder to the location where the Sage X3 application X3_PUB
directory is located e.g. C:\Sage\SAGEX3V7\X3V7\folders\X3_PUB\
o Launch the SAFE X3 Management Console, select the X3V7 solution from the Solutions tab and click on
the folders icon.
o Click on the Import button, choose SEED folder from the drop-down list and be sure that SVG is set as
the data directory.
o Leave 'Import of the table structure only' option unchecked, click OK button to launch the folder import.
o Define an endpoint for SEED folder before using it.
 Apply list of patches
Apply the list of patches which is delivered with the product update in all folders;
Mandatory if a zip file exists under the directory SageX3Patch :
 Use the 'Updates' function : Administration menu (Utilities> Update> Updates)
 Upload the zip file present in the SageX3Patch directory of the installation support. For more details, refer
to the documentation Administration reference updates.

Update search index

 In order to use data search feature for a current endpoint, the search index must be updated first.
o Log in Sage X3 as admin user
o On administration menu, select 'Search Index Management' under tools section
o Enter data source endpoint to be indexed
o Leave Entities blank
o Enter Locale language in which index will be updated
o Check the 'Delete index before update' option
o Click 'Update index' on the upper right corner to start updating search index.
For more information, see Administration reference Search Indexes Administration.

Install the Production Scheduler

The Production Scheduler is an option of the Manufacturing module.
Install the required component from the SafeX3Installs folder on its destination server.
 Production Scheduler: SafeX3ProductionScheduler
To launch the installation, double-click the '.jar' file in the folder of the component.
For more information about the Production Scheduler installation, see the Production
Scheduler installation procedure.

Install a SAFE X3 Print server component

Install the required component(s) from the SafeX3Installs folder on the corresponding
destination server(s):
 Print server: SafeX3PrintServer
To launch the installation, double-click the '.jar' file in the folder of the component. Then
configure this component with the management console.

Install a Sage X3 Documentation server component

Install the required component from the SafeX3Installs folder on its destination server.
 Documentation server: SageX3Documentation
The installation of a documentation server is an option. By default the software seeks to access
the help pages on the online documentation server through internet, but a local server can be
used to manage custom help pages, or in case of internet unavailability.
To launch the installation, double-click the '.jar' file in the folder of the component.
 Specify a component name for the local documentation server, and an available port number which will
be used for the help base url (for example 8127).
 In the 'Select Installation Packages' step, check the 'Sage X3 11 documentation files' if you wish to copy
locally all the standard help pages of the product documentation. Otherwise, if you only intend to manage
 custom pages on the local documentation server, do not check this option, and the standard help pages
will be seeked on the online documentation server through internet.
Then complete the installation on the Web "Syracuse" server:
* On each endpoint definition where you want a local documentation access, specify the help
base url, based on the port number specified for the local documentation access (for
example http://myserver:8127/).

Install an additional SAFE X3 Process server

component
Install the required component from the SafeX3Installs folder on its destination server.
 Additional process server: SafeX3Runtime
To Launch the installation, double-click the '.jar' file in the folder of the component.
For Windows servers, it is mandatory to launch the installer as a user with administrator rights
and 'Log on as a service' right on each server.
For Linux servers, it is recommended to launch the installer as root; otherwise, the
corresponding service will not be created (adxadmin). It is then recommended to launch the
adxadmin service as root and to use, in the SAFE X3 Console, the proprietary account of the
SGBD Oracle installation to configure the database component. For more information on this
topic, refer to the console documentation, paragraph 'AdxAdmin process rights' on page
'Component loading - dialogue box'.
For AIX servers, the installer doesn't create an adxadmin service but it launches an adxadmin
process (adxd). It is then recommended to launch the installer as root and to use, in the SAFE
X3 Console, the proprietary account of the SGBD Oracle installation to configure the database
component. For more information on this topic, refer to the console documentation, paragraph
'AdxAdmin process rights' on page 'Component loading - dialogue box'.
Then configure this component with the management console.

Install a SAFE X3 Java server component

Install the required component from the SafeX3Installs folder on its destination server.
 Java Bridge server: SafeX3BridgeJava
To launch the installation, double-click the '.jar' file in the folder of the component.
Then configure this component with the management console.

Install a SAFE X3 Webservice and ADC server

component
This component provide web-service soap server (for Sage X3 people portal) and VT
connection.
Install the required component from the SafeX3Installs folder on its destination server.
 Webservice and ADC server: SafeX3WebServices
Before launching the webservice and ADC server installation, make sure that all the system requirements,
CPU, RAM, and space disk capacities that are mentioned in the Prerequisites section are met.
To launch the installation, double-click the '.jar' file in the folder of the component.
If the webservice and ADC server has not been installed, select the 'New installation' option. To
modify or update an existing installation, select 'Modify installation' option.
Firstly you have to indicate the path where the component will be install.
 Then specify the component name, path for all temporary and log (directory data), and finally
specify the passphrase that you want to use in order to encrypted the private key that it will be
generated at the end of te installation.
Take note of the entered passphrase, and keep this information at hand while launching the
configuration of the component in the management console.
For Linux installation you will have to set the user and group that will be owner of the folder
where the component will be located.
Then configure this component with the Management console. Note that this component is
called 'Web server' in the Management console.

Configure the Webservice and ADC server using the SAFE X3

console
After installing the component you need to use the SAFE X3 console in order to: configure the
server, launch the service, define the port to use for the http and also link the different solutions
and folders to that component.
This configuration is defined in several steps:
* Firstly, you define the port to use, then enter the passphrase that you have set during
the installation step and some specific parameter if necessary. In the configuration step the
component presents standard parameters and some expert parameters (jvm options for
instance). Each parameter is defined in a module and has a little description about what it is for.
* Then, you link to that component the folders that will be used for web-service or VT connection
and complete the required setup. The webservice component public key that was generated
during installation is automatically copied by the publication process of the solution into the right
folder of the runtime server in order establish an operationnal connection between these 2
components.
* Finally, you define some web-service pools to enable soap clients call X3 Objects and sub
program using soap protocol. For that you just have to configure a pool per folder.
Note : The web-server uses the configured passphrase to uncrypt the private key in order to
have a secure connection between the runtime and webservice server. The passphrase is also
encrypted.
* If you connect to the Management console via another user, you must reenter the passphrase
because the webservice server needs the current user in order to descrypt the passphrase.
* If you update a webservice adc server 231 to a newer product update, and you've already
published the solution, make sure that the public key of the webservice adc server is present in
the sub-directory "keys" of each runtime directory of the linked solutions.
Installation after syracuse web server
if you have installed a syracuse web server before installing the webservice adc server
component, you'll need to copy the public key of the syracuse web server to the location
\data\KEYSTORE\WEBSERVER\ in order to put up a secure connection between syracuse and
webservice adc server for HRM portal.

Install the Business Intelligence

Install the required component from the SafeX3Installs folder on its destination server.
 Business Intelligence component: SafeX3BO
To launch the installation, double-click the '.jar' file in the folder of the component.
For more information about the Business Intelligence installation, see the Business
Intelligence installation procedure.