Configuration Console
Configuration Console
Index
Configuration Console
Index
1. General
2. Presentation of the Configuration Console
3. Basic solution
4. Additional X3 Runtime
5. Sage X3 Print-server
6. Sage X3 Webservice and ADC server
7. Web services Connection pools management
8. Sage X3 Business Intelligence Server
9. Sage X3 Java Bridge Server
10. Main X3 test Runtime
11. Documentation server
12. Folder import and export with the Console
Export a folder
Import a folder with SVG flat directory
Import a folder from another solution
14. Appendix
General
Sage X3 Configuration Console is the configuration and administration tool required to implement Sage X3 products.
It is used to configure the Sage X3 components and to establish links between them in order to set up a solution. It produces the configuration files which will be
used by the targeted sub-systems.
Since the configuration of the various Sage X3 servers is controlled from a centralized workstation, the installation of complex configurations, namely in multi-
tier architecture and in heterogeneous UNIX or Win32 environments, is simplified.
Solution
An installation can take the name of a Sage X3 solution and is characterized by an alphanumeric code with a maximum of 20 characters defined in the Sage X3
Configuration Console.
To define a basic solution, the following components are mandatory:
Database server
X3 application server
X3 main runtime
Additional X3 runtime
Sage X3 Print Server
Sage X3 Webservice and ADC Server
Business Objects Sage X3 Business Intelligence Server
Sage X3 Java Bridge Server
X3 test extra connection server
X3 documentation server (V6 only)
A main menu
A general tool bar
A left panel with a hierarchical left list of components to manage each entity
A configuration screen related to each entity
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 1/40
08/03/2021 Configuration Console
Configuration Console
Main menu
When activating the left-list panel or loading a configuration screen, the main menu can be completed by two new entries containing on the one
hand the specific menus of the selected entity (module) and on the other hand the action menus of the loaded configuration screen.
Icon Action
Return to the start-up page of the Configuration Console
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 2/40
08/03/2021 Configuration Console
When activating a left-list entity, this tool bar is completed/modified with icons that are specific to the selected entity. They are generally shortcuts to
the selected entity configuration screens.
Solutions
Sage X3 Print Server
Sage X3 Webservice and ADC Server
Sage X3 Business Intelligence Server
Sage X3 Java Bridge Server
Sage X3 AdxAdmin Administration Server
Sage X3 Documentation server
Each component in the left list is a tree of entity components and their linked components.
It also includes a toolbar for importing or deleting entity components. These toolbars are described in the configuration screen specific to each entity.
Configuration screens
The configuration screen is made up of three elements:
The action menu: this menu completes the main menu; it contains shortcuts to the possible actions that are loaded depending on the selected
component.
The action tool bar: this tool bar is directly placed above the configuration screen and under the general tool bar. This bar contains shortcuts to frequent
actions of the loaded screen.
The Display / Input panel: it is the right side of the Console screen.
Basic solution
The Basic solution is made up of the three mandatory components required for running a Sage X3 product: the database server,
the X3 application server and the X3 main runtime.
The following dialog box entitled Create a new solution is displayed; it enables to build the basic solution using the components that have already been
installed on the servers:
The process starts with the selection of the application component that refers to the product and determines the solution type.
The following dialog box entitled Create a new solution is displayed:
Then the Console submits a list of main runtimes available for your solution in the following dialog box:
The next step is to choose via the following dialog box the configuration method for the database to be used by the solution.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 4/40
08/03/2021 Configuration Console
Select one of the two proposed configuration methods and click the "Next" button.
For Configuration by the console method, data server is configured with a Sage X3 AdxAdmin Administration server. The Create a new solution
dialog box is displayed again requiring new information:
Then, a new dialog box is triggered where all database components available on the indicated server are listed. Select a database component from the list and
click the Next button.
For an Oracle database on a Linux platform you should use the Manual configuration method.
For Manual configuration method, data server will not be configured with a Sage X3 AdxAdmin Administration server as it may has been already
created, and therefore cannot be accessed through an AdxAdmin administration engine on the server.
The following dialog box is displayed:
To enable Sage X3 AdxAdmin Administration server to connect to the data server, you need to enter all the required settings to create a virtual database
component that matches your disconnected database.
For further details about database setup, refer to the Specific actions with the Configuration console paragraph.
The last phase enables you to enter an identifier, a description and a message (optional) defining your new solution.
If you enter a message, it will be displayed each time the solution is loaded onto the Console. This can be useful if you manage many solutions, adding a
message on opening critical solutions is intended to avoid confusion with test solutions.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 5/40
08/03/2021 Configuration Console
Once this information is validated, the Console displays the solution configuration screen. The setup components of the servers for the solution are loaded with
the components that you have selected.
To install the solution, it is necessary to load and configure the mandatory Database server component first.
The Console is used to reference a database considered as disconnected.
The principle is to create a solution in which the database server cannot be accessed from the Console. For more information on adding a disconnected
database, click here...
The component status is Idle, on exiting the configuration it becomes Active.
Configuration
To configure the database server component, enter the mandatory parameters.
Only the instance in the case of SQL Server must exist beforehand.
The Configuration Console creates the database (Oracle or SQL Server) and the ODBC source (SQL Server).
1. Enter Db login user code and password of the instance sysadmin user.
2. Set a password for X3 folders schemas.
3. Select the Sql Server instance.
4. Enter a database name: maximum thirty alphanumeric characters, displayed in lowercase.
5. Select the DBMS tools installation path: osql.exe has been deprecated and replaced by sqlcmd.exe. The entered path should include a tool folder
where sqlcmd.exe is located.
6. Select the ODBC tool path: sqlcmd.exe and bcp.exe must be in Binn directory located on the path.
7. The system fills the DBMS version, Data directory path, Scripts directory path and Transactions log directory path fields.
1. Define the Oracle SID: maximum eight alphanumeric characters, displayed in uppercase.
2. Define a connection user name as SYSDBA: maximum 250 alphanumeric characters, the default value is SYS. This field is accessible for a component
version that is equal to R090 or above, otherwise the default value is considered.
3. Enter a password for the SYSDBA user: minimum 8 and maximum 250 alphanumeric characters, forbidden characters are ^,$,%,\,/,",',-,@,*,!. The
password should fulfill the complexity requirements of Oracle server.
4. Define a name for the DB user with SYSTEM privilege: maximum 250 alphanumeric characters, the default name is system. This field is accessible for a
component version that is equal to R090 or above. Otherwise the default value is considered.
5. Enter a password for the DB user with SYSTEM privilege: minimum 8 maximum 250 alphanumeric characters, forbidden characters are
^,$,%,\,/,",',-,@,*,!. The password should fulfill the complexity requirements of Oracle server.
6. Enter a password for X3 folders schemas: maximum 250 alphanumeric characters, forbidden characters are ^,$,%,\,/,",',-,@,*,!. This field is accessible
for a component version that is equal to R090 or above; otherwise the default value tiger is considered.
7. Indicate the DBMS tools installation path; it corresponds to the ORACLE_HOME directory. Other remaining fields will be automatically filled.
Once these parameters are entered, click the Save button of the Configuration Console.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 6/40
08/03/2021 Configuration Console
To start the configuration of the database server, click the Data button. A dialog box displaying the different configuration options appears.
Three options are proposed:
Script generation: This option generates database creation scripts in the script directory of the database component on the server. It can be used to
introduce modifications to the scripts directly via the "Database scripts" menu entry by clicking the corresponding icon on the general tool bar.
Script execution: This option launches scripts that are located in the script directory of the component. It is used to subsequently run scripts that have been
modified by means of the 'Script generation' option.
Full configuration: This option links the two previous options into one single step but without any possible script modification. Executed scripts are those
that are automatically generated.
To configure the database component, select the Full configuration option and validate.
When exiting the configuration log screen, the component status becomes Active if the database configuration process ends successfully without any errors.
In order to solve the most common database configuration problems, refer to the To know... paragraph.
Apache installation path: it specifies the installation path of the Apache http web publication server.
Warning
It is recommended to use a dedicated Apache installation when using the Apache process model parameters in order to avoid possible problems with the
values of another solution using the same Apache server.
Sage X3 Runtime
Sage X3 service port number: it specifies the port to be used by the main runtime service.
Sage Serial path: (up until V6 version); it specifies the local path to recover the Sage license and copy it onto the remote server.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 7/40
08/03/2021 Configuration Console
For a Distant database (up until the V6 Version, these parameters are only available in Expert mode panel):
DBMS client path: ORACLE client installation path. It is necessary to click on this setup to enable the Console to search for possible values. If the
ORAHOME variable is defined, the Console proposes that its value be recovered. Make sure that the version of your DBMS corresponds at least to
the version of your DBMS server.
Name of the link to the remote database: Access link to the database. This value must be left blank. On exiting the configuration this parameter will have
as its value the name of the Runtime component.
The user login and password of the account to be used to create and run the service.
Update
Special case:
It is important to point out that latest upgrades of Sage X3 Runtime abide by new security requirements imposed by recent database versions. So, for Oracle
19.0 database, the compatible Runtime versions to install are from 92.2 onwards.
To ensure compatibility with older Oracle database versions on mono-tier architecture, the Configuration Console requires database to be considered as
virtually remote in order to enforce using the Oracle TCP protocol of the "instantclient_19_3" folder in the Runtime repository.
So, while in mono-tier architecture using a Runtime version from 92.2 onwards, if you are configuring a new solution or updating the runtime component of an
existing solution, the Configuration console detects the Oracle database version.
For versions prior to Oracle 19.0 database, the following warning message is triggered:
Clicking the "OK" button displays the "Oracle Remote Connection" option to set to "True":
You need to enter the InstantClient path if the parameter "runtime.odbc.dbhome" is empty.
Note that the X3 Runtime includes InstantClient in its folders.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 8/40
08/03/2021 Configuration Console
Remote Dbms
Note:
For Oracle database, the Console will create its own TNSNAME.ORA file in the "Runtime" directory of the solution. In this way, the original Oracle file will not be
affected.
To launch the configuration of Application and main runtime components, click on the Application button.
If you update your version on the last X3 Runtime version, R093.0, you will have a warning.
You'll need to execute the listed scripts before continuing the update process.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 9/40
08/03/2021 Configuration Console
You can download the SQL script, then you have to edit it and check whether there is input parameters to enter according to the application you are configuring.
For example, on "update_ora_R92_3.sql" script file the parameter DOSSREF should be attributed a value as per the following explanation stated in the upper
part of the script itself:
DEFINE DOSSREF=&1
Once the script is compatible with your application, you can include it with other scripts on your Oracle Server to be launch on a started Oracle instance using
an Oracle account with DBA role as "sysdba".
Example :
On exiting the configuration log screen, the ADXD process of the main runtime is already started and the status of both components becomes "Active" if the
configuration process ends successfully without any errors.
At this stage, the solution can be used. It is therefore possible to connect via the web browser (from the version 7) or via the Client Sage X3 workstation (up
until the version 6).
To configure security to the filesystem, file "configRuntime.json", please go to
" Sandbox configuration file / filesystem security"
Additional X3 Runtime
Main or Full runtimes
There are two kind of architecture depending of the type of the additional runtimes.
* All the additionnal runtimes have the type MAIN (V12 only) (recommanded architecture)
Prerequisite : For this architecture the Application component must be installed in cluster mode on a shared folder using an UNC network path. For further
information, read the application server installation procedure.
After the runtimes installation : In the X3 Solution entity, the "Enable application cluster" checkbox must be set
* All the additional runtimes have the type FULL
To implement an additional X3 runtime, it is necessary to:
Loading
To load an Additional runtime component, click the New button, in the Runtimes tab.
For more information on the component loading dialog box, click here...
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 10/40
08/03/2021 Configuration Console
Runtime
The component status is Idle. On exiting the configuration it becomes Active if the configuration process ends successfully without any errors.
Configuration
To configure the additional runtime component, enter the mandatory parameters:
Sage X3 service user account: Name of the user account starting the Sage X3 service (By default LocalSystem for Windows, and root for UNIX)
Password of the user account: Password of this account
DBMS client path: (up until V6 version) ORACLE installation path. Make sure that the version of your DBMS corresponds at least to the version of your
DBMS server.
Multi Main rutime
A new field UNC network path is mandatory. It's the network path of the Folders directory. It is automatically managed if the Application component has
been deployed as a shared folder (Windows only) otherwise it can be set manually (using the expert mode).
This network path and the installation path must be the same for all the runtimes.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 11/40
08/03/2021 Configuration Console
On Windows, the symbolic link to the folder directory will be created automatically by the Console on the runtime server.
On Linux, the Console just verify that there is a valid access to the files stored in the mounted path.
NB For each action on folders, the Console allows to choose another main runtime.
ChooseMainRuntime
To launch the actual configuration of the Additional runtime component, click the Configuration button:
* The service must be created on the port chosen for the configuration of the main Runtime. If this port is already taken on the additional Processing Server, the
configuration cannot be done..
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 12/40
08/03/2021 Configuration Console
When exiting the configuration, the ADXD process of the additional runtime is created and started. The component appears in the left-hand panel of the
screen and in the list of runtimes. Its status will become Active if the configuration process ends successfully without any errors.
The runtime can now be used. It is now possible, using this server, to connect to the application folders.
NB: After adding the runtime, an update of the publications can be necessary.
In such a case, the solution must be published again for the Sage X3 Web Server, the Sage X3 Java Bridge Server and the Sage X3 Print Server.
From the Sage X3 PrintServer version 2.20 and the Sage X3 Console 2.47
No more manual process is required to manage Oracle Datasource with InstantClient
"Basic Package", "SQL*Plus Package" and "ODBC package" from Oracle are automatically installed by the PrintServer setup.
The setup installs Oracle Instant Client on the station on demand.
Ex: the root dir is "C:\Sage\SafeX3\EDTV2\EDTSRVFRDEP\srvedit\", the ODBC client is installed in C:\Sage\SafeX3\EDTV2\EDTSRVFRDEP\srvedit\instantclient_19_5
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 13/40
08/03/2021 Configuration Console
The entry "Oracle InstantClient_19_5" is available within the ODBC datasource manager after installation.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 14/40
08/03/2021 Configuration Console
Print Server
Loading
To load this component, click on the Add button of the Print servers left list.
For more information on the component parameters entry panel, click here...
The Console loads the different parameters of the Print server component.
Note that the value of the status of the Print server is "Idle" and will switch to "Active" once the configuration is done.
Configuration
To configure the Print server component, enter the mandatory parameters:
On exiting the configuration, the component status is "Active", and the 'Safe_X3_SE_V2DEFAULT' service is created but not started;
it will be launched automatically on the first solution publication.
It is neither useful nor recommended to start this Windows service if no solution has been published.
Solution publication
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 15/40
08/03/2021 Configuration Console
Print Server : Publish solution, folders
To publish the solution, select the Publications tab of the Print server component.
Click the Add button of the toolbar and select the solution to publish in the list of the solutions managed by the Console.
Once the solution has been added to the publications of the print server,
select the folders of the solution to be published via the checkboxes and validate by clicking on the "Apply" button.
If you have installed another ODBC driver that can disturb the Print Server, you can force within the Console (in the 'ODBC Source' tab) the ODBC driver to be
used, for instance the InstantClient_19_5 :
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 16/40
08/03/2021 Configuration Console
ODBC driver
After this, you can publish the Solutions and folders with the Console.
Expert mode
Print processes management :
This parameter sets the maximum number of print requests that the PrintServer will be allowed to run in parallel.
This setting should be adjusted based on the average number of requests to submit and the overall availability desired for the system.
When the maximum number of jobs is reached, the server put the new print requests in a queue of pending requests.
These requests are then unpaved when one of the print processes is in the "available" state again.
print.jobs.purgetimeproc: Time before automatic deletion of an untreated print request (expressed in minutes).
Condition for purging a request: the printout is not in 'execution' mode, it has exceeded the limit or it is in error.
Please note: printings in current execution are not taken into account. They are processed in the purge at the 'processus' level.
print.processes.nbmaxproc: Maximum number of processes (ex: AdxImpNet.exe process) the PrintServer will be allowed to run in parallel.
Default value max="5".
print.processes.killtimeproc: Maximum duration before deletion of a blocked print process (expressed in minutes).
Ex : process AdxImpNet.exe. Default value max="20".
print.processes.maxjobsbyprocess: The maximum number of jobs that a "AdxImpNet" print process can handle before committing suicide.
Default value="10".
These parameters can avoid memory leaks that SAP Crystal Report can cause.
To have more information about the PrintServer, please go to
Print Server Presentation and Operation Guide
Update
To update the print server, follow the steps described below:
Stop the print server service via the Console in the Print server Administration tab.
Install the update (check out the installation procedures for further information) in order to replace your version with the new one.
Refresh the print server configuration screen in the Console. The update should automatically be detected by the Console.
Click the Configure button to complete the update.
Verify that the service has been restarted following on from the configuration.
Deconfiguration
To deconfigure the print server, follow the steps described below:
Stop the print server services via the Console in the Print server Administration tab.
Unpublish all the solutions.
Click the Deconfigure button in the Configuration screen of the Print server component.
Uninstall your component on the server.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 17/40
08/03/2021 Configuration Console
Loading
To load the Web server component, activate the left list Sage X3 WebService and ADC Server and click on the Add button.
For more information on the component loading dialog box,click here...
The Console acquires the different Web parameters and loads the component, its parameters appear in the right-hand half of the page.
Note that the component status is "Idle". Once configured, this value will switch to "Active".
Configuration
To launch the actual configuration of the Web presentation server component, click on the Configure button.
On exiting the configuration, the component status is "Active", and the 'adonix_print_server_DEFAULT' service is created and launched.
Solution publication
Pre-requisite to a solution publication : the configuration of the Apache server of the solution
To configure the Apache server of the application server, enter the "Apache installation path" setup in the Application server in the solution management screen
and click on the Web publication button to launch the http server configuration for the application server.
If no value is proposed, it is pointless to continue with the publication. It is absolutely necessary to resolve the problem linked to the installation of Apache on
the server.
It is possible to check the configuration of the HTTP server by launching Internet Explorer then the following URL:
http://[servername]/[AliasOfSolution]/DOSB/GEN/FRA/FENW/FUSER.xml.
Note: the publication alias is in the form of 'Adonix_NameOfTheSolution'. Respect the case.
To publish the solution, select the Publications tab of the Sage X3 Web Server component .
Click on the button Add... and select the name of the solution to be published.
Update
To update the Sage X3 Webservice and ADC Server, follow the steps described below:
Stop the services of the Sage X3 Webservice and ADC Server via the Console in the server Administration tab.
Install the update (check out the installation procedures for further information) in order to replace your version with the new one.
Refresh the configuration screen of your Sage X3 Web Server in the Console. The update should automatically be detected by the Console.
Click on the configure button to complete the update.
Verify that the services have been correctly restarted following the configuration.
Deconfiguration
To deconfigure the Sage X3 Webservice and ADC Server, follow the following steps:
Stop the services of the Sage X3 Webservice and ADC Server via the Console in the server Administration tab.
Depublish the web services connection pools connected to the solution
Depublish all the solution published on the Sage X3 Web Server.
Click on the deconfiguration button.
Uninstall your component on the server.
Presentation
The Console is used to configure the groups of web-service connections for the Sage X3 Web Server. An additional tab is available within the Sage X3 Web
Server configuration panel. To access the configuration of a group of connections, the Sage X3 Web Server must be configured and the services launched. If it
is not the case, the tab is not active.
it is mandatory to publish the solutions in order to configure the group of web-services connections,
in fact these are configured to establish a physical connection to a solution folder and by the intermediary of the runtime configured for the solution.
This tree structure represents the Sage X3 Web Server configuration and the configuration of the group of web service connections.
The following are found, in order :
the X3World node that is the central point of the Sage X3 Web Server configuration.
the solutions published on this Sage X3 Web Server.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 18/40
08/03/2021 Configuration Console
the folders published on this Sage X3 Web Server for the selected solution.
the runtimes configured for the solution.
the groups of web-service connections connected to the process server for the solution.
the physical connections to the selected connection group.
The actions possible on a group of connections are determined by its status, plus the addition, deletion and modification of parameters imposes the saving of
the new configuration to the server with the "Save" button, which becomes active after any configuration modification.
Loading
To load this component, click on the Add button of the Business Objects servers left list.
For more information on the component loading dialog box, click here...
The Console acquires the various parameters of the Sage X3 Business Intelligence Server component:
Note that the value of the Sage X3 Business Intelligence Server component status is "Idle", once configured this value will become "Active".
Configuration
To configure the Sage X3 Business Intelligence Server component, the following parameter MUST be entered:
Password of the administrator account: Specify the password that should be assigned to the Business Objects Server administrator account
To launch the actual configuration of the Sage X3 Business Intelligence Server component, click on the Configure button.
Right after the configuration, the status of the component is "Active" and the password of the Business Objects server administrator has been set.
Solution publication
To publish the solution in the Sage X3 Business Intelligence Server, server, click on the Business Objects servers then on the "Publications" button.
Click on the Add button of the toolbar and select the solution to publish in the list of the solutions managed by the Console.
A "Sage X3 user" dialog box appears and mentions the application user that the Console will use to initialize the product for the Business Intelligence support.
The Console then enables you, if need be, to choose a 'decision-support' solution to be used to store the decision-support of the Business Intelligence of the
products based on the Sage X3 technologies.
If no decision-support is selected, the solution being published is used as decision-support solution and the Business Intelligence decision-support data will be
stored in the same database as the data of the solution being published.
Up until the V6 version : If the solution is published on a Sage X3 Web Server, a warning message will appear during the publication and it will be necessary to
update the publication of the solution in the "Sage X3 Web servers" Module of the Console by means of the Apply button in the "Publication" screen.
This will make it possible to benefit from the possibilities offered by the Business intelligence with the Web client.
If the application component of the published solution is located on a Unix type server, the Apache server on which the solution is published will have to be
restarted manually.
Right after the publication, the Business Intelligence functions will be available in the application folders of the published solution.
it is possible to publish a solution only on one single Sage X3 Business Intelligence Server,
a Sage X3 Web Server can only publish one solution, itself published on a Sage X3 Business Intelligence Server,
all the solutions published on the same Apache web server can only be published on the same Sage X3 Business Intelligence Server. To publish
solutions located on the same physical server, but on different Sage X3 Business Intelligence Server servers, you need to install several Apache servers
and publish your solutions on these various Apache servers.
Deconfiguration
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 19/40
08/03/2021 Configuration Console
To deconfigure the Sage X3 Business Intelligence Server component, all published solutions must have been previously depublished.
Click on the button Deconfigure of the Configuration screen. At the end of the process, the component will switch from the status "Active" to the status "Idle".
The Console acquires the various parameters of the component and loads it. Its parameters appear in the right-hand half of the page.
Note that the component status is "Idle". Once configured, this value will switch to "Active".
Configuration
To launch the actual configuration of the Sage X3 Java Bridge Server component, click on the Configure button.
On exiting the configuration, the component status is "Active", and the service on the host server is created and launched.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 20/40
08/03/2021 Configuration Console
The Sage X3 Java Bridge Server is configured. It is now necessary to publish the solution.
Solution publication
To publish the solution, select the Publications tab of the Sage X3 Java Bridge Server component.
Click on the button Add... and select the name of the solution to be published.
Update
To update the Sage X3 Java Bridge Server, follow the steps described below:
Interrupt the services of the component via the Console in the Administration tab of your Sage X3 Java Bridge Server.
Install the update (check out the installation procedures for further information) in order to replace your version with the new one.
Refresh the configuration screen of your Sage X3 Java Bridge Server in the Console. The update should automatically be detected by the Console.
Click on the configure button to complete the update.
Verify that the services have been correctly restarted following the configuration.
Deconfiguration
To deconfigure the Sage X3 Java Bridge Server, follow the steps described below:
Interrupt the services of the component via the Console in the Administration tab of your Sage X3 Java Bridge Server.
Unpublish all the solutions.
Click on the deconfiguration button.
Uninstall your component on the server.
Loading
To load a principal test runtime component, click the New button, in the Runtimes tab.
For more information on the component loading dialog box, click here...
The component status is Idle, on exiting the configuration it becomes Active if the configuration process ends successfully without any errors.
Configuration
To configure the principal test runtime component, enter the mandatory parameters:
Sage X3 service user account: Name of the user account starting the Sage X3 service (By default LocalSystem for Windows, and root for UNIX)
Password of the user account: Password of this account
Sage X3 service port number: Specify the port to be used by the test main runtime service.
DBMS client path: (up until V6 version) ORACLE installation path. Make sure that the version of your DBMS corresponds at least to the version of your
DBMS server.
To launch the actual configuration of the Additional runtime component, click the Configure button:
The service is going to be created on the port chosen for the test main runtime configuration. If this port is already taken on the server, the configuration
cannot take place.
On exiting the configuration the ADXD process of the principal test runtime is created and started. The component appears in the architecture on the left
and in the list of process servers.
Its status will become "Active".
The server can now be used. It is now possible, using this server, to connect to the application folders.
NB: After an additional runtime has been added, an update of the publications can be necessary.
In such a case, the solution must be published again for the Sage X3 Web Server, the Sage X3 Java Bridge Server or the Sage X3 Print Server.
Update
To update the principal test runtime, follow the next steps:
Stop the principal test runtime service via the Console in the Runtimes tab of the solution.
Install the update (check out the installation procedures for further information) in order to replace your version with the new one.
Refresh the solution configuration screen in the Console. The update should automatically be detected by the Console.
Click the Configure button to complete the update.
Check that the service has been correctly restarted following the configuration.
Deconfiguration
To deconfigure the principal test runtime, follow the next steps:
Stop the principal test runtime service via the Console in the Runtimes tab of the solution.
Select the principal test runtime to be deconfigured from the list of runtimes.
Click the Deconfiguration button.
Uninstall your component on the server.
Documentation server
(V6 only)
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 21/40
08/03/2021 Configuration Console
The documentation server provides the applicative documentation of the configured solution. This documentation is delivered in compressed format (CHM
format) on Windows environment and decompressed (HTML) on UNIX environment.
Starting from version Sage X3 V7, the product documentation is available online. However, a documentation server component exists and can be configured for
the product, but it is neither configured nor managed by the Configuration Console Sage X3 V2.
To implement the Documentation server, you will need to :
Loading
To load this component, click the Add button of the Documentation server left list.
For more information on the component loading dialog box, click here...
The Console loads the various parameters of the Documentation server component
Note that the status value of the Documentation component is "Idle". Once configured, this value will change to "Active".
Configuration
Access format to the documentation
Two types of access to the documentation exist. The chosen access type depends on the client used and the operating system:
Only for a Client-Server client if the documentation server is installed on a Windows machine.
Documentation access root: Path to reach the documentation via the Sage X3 C/S Client (in the case of a UNC path, you must manually share the
documentation access directory on the server).
Client workstation usage format: specifies to the Sage X3 client that it must configure itself to use the help in compressed format (CHM) or in
decompressed format (HTML).
If you choose to publish your documentation via an Apache server installed on the same machine as the documentation server, you can input the "Apache
installation path" parameter. When this parameter is entered, the Console adds an alias (/AdxDoc_[DocComponentName]) in the httpd.conf of the Apache
server.
If the Documentation Server component is located on a Unix server, you will have to restart the Apache server manually to take this new alias into account.
In order for the Sage X3 Client Server client can access the documentation via the Apache server of the documentation server, the value of the Documentation
access root parameter must be: http://[MachineName][HTTPPort]/AdxDoc_[DocComponentName]
Once the setup(s) are entered, click on the Configure button.
It is possible to check the access to the documentation. For that purpose, click the ClientDoc.test or WebDoc.test buttons.
If the application is to be used via the Web, the documentation format must be "decompressed". To change this format, click the "Decompress (HTML)" button.
After decompressing the documentation, the value of the Decompressed documentation parameter changes to 'Yes'.
Documentation installed on a UNIX server is always delivered in decompressed format. It is not useful to carry out a Decompress/Compress action.
Important reminder: No space is allowed in the documentation server installation path.
Documentation format
If the application is to be used via the Web, the documentation format must be "decompressed". To change this format, click the "Decompress (HTML)" button.
After the breaking down the documentation, the value of the 'documentation decompressed' parameter changes to 'Yes'.
This operation is used to extract all the documentation in HTML format from the CHM file. Once the 'documentation decompressed' parameter passes to Yes,
and therefore the HTML files are generated, it is no longer possible to return to the previous 'Compressed documentation' status.
It is possible to decompress the documentation at any time using the "Decompress (HTML)" button. This operation will nevertheless overwrite the html files
already present if the documentation has already been decompressed.
It is also possible to "compress" the documentation in order to create a CHM file from the aleady existing html files. This operation overwrites the original CHM
file and replaces it with the new CHM file generated from the present html files. It is not possible to compress a Documentation that has has not been broken
down. To compress a documentation, click the "Compress (CHM)" button. In order for the CHM generation to take into account new html documentation files,
these must be indexed in the current documentation. As a matter of fact, the CHM generator works in "spider" mode and finds new documentations by following
the html links of the current documentation. The easiest way is to add links in the html document of the general index.
Note: These operations can take a while if the documentation is installed in several languages. Indeed, the compression or breaking down of the
documentation is applied to all the languages installed for the documentation.
Publication
Publishing the Solution
To publish the solution in the documentation server, click the 'Documentation Servers' button and then the "Publications" button.
Click on the Add button of the toolbar and select the solution to publish from the list of the solutions managed by the Console.
At the end of the publication, the documentation is automatically available in the 'Help' menu of the Sage X3 client.
Update
To update the documentation server, follow these steps:
Install the update (check out installation procedures for further information) in order to replace your version with the new one.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 22/40
08/03/2021 Configuration Console
Select the documentation server to configure in the 'Documentation servers' left list.
For Windows, break down the CHM if necessary by clicking the "Decompress (HTML)" button.
Click the "Configure" button to update the configuration of the component and existing publications.
Note: During configuration, all published solutions should be accessible for updating documentation information. If some solutions are not accessible or
are locked, warnings will be issued during the configuration of the Documentation server component.
Deconfiguration
To deconfigure the Documentation Server component, follow these steps:
Unpublish all the solutions published on the Documentation Server in the "Publication" screen
Click the "Deconfigure" button in the configuration screen of the Documentation server component, the component switches from the "Active" to the "Idle"
status.
Uninstall your component on the host server.
The first function is the Import a folder. from a a backup (file copy) with a SVG data directory containing the flat data to be imported.
The Console folder Export a folder. makes it possible to perform this operation in a simple way.
The other function is used to Recopy a folder. directly from another online solution, by means of an assistant.
Therefore it is no longer necessary to go through manual backup/export/restoration phases to copy the folder of a solution to another.
The various options and possibilities offered by the import functions of the Console make it possible to meet a wide range of requirements in terms of folder
copy/restoration/migration.
Export a folder
The folder export function carries out the creation of a SVG directory containing the flat data of a folder.
The goal is to make possible the later import of the folder into another solution by means of the folder import function.
To export a folder, launch the Sage X3 Configuration Console and click on the Export button in the Folders tab of your solution after choosing the folder to
export.
In the dialog box choose the directory containing the extracted flat data. The Console suggests SVG by default.
The option "Export data to Native dump files" uses native dump mechanism from Microsoft SqlServer and Oracle,
which are faster than the SVG format for big volumes.
The Console launch "bcp" (Bulk Copy utility) on Microsoft SQLServer, and "exp" (Export Data Pump) on Oracle.
A file [folderName].pdmp is generated with Oracle and exp, located in the SVG directory, and bcp generates one file [TableName].dmp for each table to export.
The last checkbox "Delete the SVG directory before export" is set to "True" by default. In this case, the mechanism deletes the entered SVG directory, if it
already exists, before starting the export process. If this checkbox is set to "False" and the entered SVG directory already exists, then existing files remain in the
repository, new files will be added in the repository and those with the same file name will replace the existing ones. This option is to be handled carefully to
avoid any database errors after a subsequent import of this repository.
A last warning message is triggered after you confirm your choice by clicking the "OK" button.
Warning:
Business Intelligence: When importing a demonstration folder provided on the product DVD, if the Business Intelligence functionalities need to be operational in
the folder at the end of the import, the solution MUST have been published on the Business Objects server prior to the folder import.
Import a folder
To import a folder, launch the Sage X3 Configuration Console and click on the Import button in the Folders tab of your solution.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 23/40
08/03/2021 Configuration Console
In the dialog box choose the folder to be imported and the sub-directory that contains the extracted flat data.
The Console proposes automatically SVG if it is present.
Importing a folder to an Oracle database
In the import of the folder to an Oracle database, the Console is used to specify the size of the tablespaces.
Importing the folder to an SQL Server database
In the import of the folder to an SQL Server database, the Console is used to specify that the folder import will be carried out in a new group of files:
Use the groups of files (checkbox selected) : the folder import is going to create two files Sql Server:
[DataBaseName]_[FolderName]_DAT.ndf to store the data.
Note that Dump files are managed with both Microsoft SQLServer and Oracle.
The Console calls bcp tool on Ms SQLServer to import data (Bulk Copy Program), and exp utility on Oracle (Oracle Data Pump).
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 24/40
08/03/2021 Configuration Console
An assistant will guide you through the phases necessary for the copy of your folder from one solution to your current solution.
By means of this assistant, it is also possible to migrate a V6 folder from an online solution without any additional manual or technical stages.
Nota : in order to use the remote import function with a solution installed on a Unix type server, the "tar" and "gzip" utilities must be installed and available in the
PATH.
phase 1 of the remote import wizard
This screen is used to select the online folder to be imported into your current solution from the online source solution.
Only the folders from volume A are listed.
phase 2 of the remote import wizard
This screen gives the opportunity to choose whether the archived folder should be imported at the same time as the online folder.
The archived folder is detected automatically.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 25/40
08/03/2021 Configuration Console
phase 3 of the remote import wizard
This screen is used to define the export options of the source folder to be migrated.
Two options are possible based on the compatibility and required performances.
The first mode uses the neutral flat file format in an SVG type directory whose name shall be specified.
This format enables lesser performances but it makes it possible to migrate the folder of a solution using an SQL Server base to Oracle and vice-versa.
This format is not adapted to very large volumes but it is adapted to a migration with database type change.
It is possible to check the box "Do not export the data", which would only export the folder structure with all the tables empty.
The data can be imported via a customized script launched at the end of the import by the Sage X3 configuration Console and by means of optimized external
tools.
The second mode uses the proprietary export tool of the source database for the data as well as an SVG format with empty tables for the folder structure.
This mode is adapted to larger volumes but it limits the target database to the same technical platform as the source database.
An Oracle export can only be read to feed an Oracle database and an SQL Server export can only feed an SQL Server database because the tools being used
are 'exp' for Oracle and 'bcp' for SQL Server.
The Console does not manage external tools enabling the conversion of technical database platforms.
The advised platforms for this mode of operation are Oracle 12 and 19 and SQLServer 2016 and superior.
If this mode is chosen, the database export will automatically be restored in the target database using the same options and tools.
If you are in X3 v6, the password of the database administrator must be entered in this screen because it is necessary for various tasks like the sequence
export.
phase 4 of the remote import wizard
This screen contains the same options as the saved folder standard import screen.
Please refer to the explanations about the creation option for file groups, tablespace sizes, reference and copy folders, etc.
An additional field can be used to rename the folder during its transfer.
This field cannot be accessed in some situations where the Oracle proprietary export option is used
(exp and imp utilities are used).
phase 5 of the remote import wizard
A standard progress window shows the progress of the folder migration phases.
In case of errors, you should look at the log files in order to know why the progress has failed.
The folders are extracted to a compressed archive that is transferred to the target server. From here,
the archive reconstructs the folders in volume A, then, the standard folder import is launched with the options defined in the wizard.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 26/40
08/03/2021 Configuration Console
Once the folder import in the Console is over, you have to:
imperatively revalidate your imported file from the main folder of your solution, and
save the folder record in the Folder function, then validate it. (see the migration method for more details).
Once these actions have been completed, your folder will have been migrated to the last online version and it will be possible to log on to your folder.
WARNING : Do not import a folder of a higher version or with a patch level higher than the main folder of your solution.
/Sage/SQLLINUX01/folders/SEEDNEW/init_console.sh
The .cmd ou .sh extension is determined according to the platform on which the folder is imported.
The Console is sensitive to the return error codes and to the standard strerr output.
If an error is detected, a warning is issued during the import phases and the standard strerr et strout outputs are displayed in the import log file.
Here is an example of customized Unix/Oracle script particularly useful in case of remote import or folder migration because it makes it possible to copy data
from one base to another,
directly via a link network and, consequently, to use the powerful Oracle datapump tools to manage the data.
This script is an example used to explain the mechanism of customized scripts at the end of an import,
it does not constitute any reference and any deployed script must be deployed subject to the architecture and the target needs.
#!/bin/bash
ORACLE_HOME=/opt/oracle/product/11.2.0.1
ORACLE_SID=ORCL
NEWFOLDER=NEWFOLDER
OLDFOLER=OLDFOLDER
###############################################
# Drop all folder sequences and truncate tables
$ORACLE_HOME/bin/sqlplus -L NEWFOLDER/tiger << EOF
set serveroutput on
BEGIN
FOR s IN (SELECT SEQUENCE_NAME FROM USER_SEQUENCES WHERE SEQUENCE_NAME LIKE 'SEQ_%') LOOP
dbms_output.put_line ('Processing table ' || SUBSTR(s.SEQUENCE_NAME,5));
EXECUTE IMMEDIATE ' DROP SEQUENCE ' || s.SEQUENCE_NAME ;
EXECUTE IMMEDIATE ' TRUNCATE TABLE ' || SUBSTR(s.SEQUENCE_NAME,5);
END LOOP;
END;
/
EOF
###############################################
# import data with datapump and dblink
$ORACLE_HOME/bin/impdp system/manager DIRECTORY=dmpdir SCHEMAS=$OLDFOLDER NETWORK_LINK=OLDDB REMAP_SCHEMA=$OLDFOLDER:$NEWFO
In this Unix script example, we consider that the option 'Import table structure only' has been used. That is why the first part of the script consists in "preparing"
the folder by suppressing all the sequences that were initialized with a minimal value and not with the real value as a result of the previous option. Then, just in
case the script were run several times, all the tables are carefully emptied before effective import of data.
Finally, in the last part of the script, the Oracle datapump is used via a link network to copy data and sequences directly from a base to another. It is not
necessary to copy other data since the configuration Console has already created the complete folder structure, the objects and the rights.
Don't forget!
You encounter an error of type "User SYS cannot connect to database: SP2-0640: Not connected".
In order to solve the most common problems upon configuration of the databases, consult the field "To know" by clicking here...
You encounter an error of type "cmd538647161.sh: line 3: gzip: command not found" when you use the remote import function.
You are trying to transfer a folder from or to a solution installed on a Unix server but the 'tar' and 'gzip' utilities are not installed or available in the PATH.
After the import of a folder via the Console, the folder does not appear in the solution Folders tab.
The Console could not complete the creation of the folder record. Consult the log file in order to determine why the folder record creation was interrupted. So
that the imported folder is displayed in the solution folders list, it is necessary either to save the record for your imported folder from the parent folder in the case
of the duplication of a folder or revalidate the imported folder from the parent folder in the case of a migration of a folder from a previous version.
Beware that the import of very large folders via the Console can take a long time (more than 2 hours for valfil).
When the Console launches an action on the server, it waits for a response with a maximum timeout (by default 720000 milliseconds that is 2 hours). It is
possible to increase this timeout in the Console preferences. Solution tab, field config.solution.comm.timeout.long.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 27/40
08/03/2021 Configuration Console
Increase this value if the 2 hour timeout is insufficient and blocks the importation of your folder. The field must be entered in milliseconds. It is possible to add
the field to the list of values if it is not already present in this list.
Error "AINSTCONS : the process does not exist in the archive"
At the end of the import, the Console logs on to the application via the root folder in order to initialize the newly imported folder.
Once it is connected, the Console launches the INIT_CONSOLE function of the AINSTCONS process.
If the message "AINSTCONS: the process does not exist in the archive" appears, you need to update your application by carrying out the available patches and
restart the import.
Database servers
Moving table spaces
To move the tablespaces of your database after its configuration by the Configuration Console, it is imperative to modify your 'adcrap' file and the tag
'database.adonix.oradirdat' in the 'adxinstalls.xml' files of the data server and in the 'solution.xml' file of your application server
To know...
Remote / disconnected Oracle database and remote connections
If you create a disconnected database using your own scripts or if you modify the scripts generated by the console, the following prerequisites must be
observed:
* the SID of the database must be a capital character string,
* the base must be in UTF8 or AL32UTF8,
* the open_cursors parameter must be at least 300.
When configuring the database prior to the integration of the main folder, the Configuration Console needs to launch the "role.sql" script for creating the
application roles. This script is created in the "tmp" directory of the connection server main. To do this, the console uses the DBMS client configured with the
main connection server and the SYS account previously configured in the database component. It is therefore important to keep the password of the SYS user
up-to-date in the Database component.
If you encounter a "User SYS cannot connect to database: SP2-0640: Not connected" error, there is two major common reasons:
1. In case of remote or disconnected databases, it is essential to have an Oracle listener configured and started.
1. For Oracle databases mainly on Unix platform, you may be required to authorize remote connections of the SYS user using the Oracle utility "orapwd". In this
case, your Oracle database administrator has to create a password file for your Oracle instance with the "orapwd" utility. Normally, this file is created by the
'launch_ORASID_3.sh' script generated by the Sage X3 configuration console; check that the owner of this file is the owner of the database software
installation, the more often it is the 'oracle' user.
Make sure of these prerequisites before configuring the 'Application' component of your solution in the Configuration Console.
When configuring the main Runtime component, you have to enter the DBMS client path in the advanced settings of the "remote base" panel.
Check that the version of your DBMS client corresponds to the version of your DBMS server.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 28/40
08/03/2021 Configuration Console
Manual configuration
Select 'Manual configuration' mode and click the 'Next' button; the following page is displayed:
Manual configuration
Fill in the required information in the corresponding fields and click the 'Next' button; the 'Data - Application' page is displayed. You need to complete the
missing information on the following panel:
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 29/40
08/03/2021 Configuration Console
Manual configuration
Click the 'Configure Database' button of the upper horizontal menu; then on the displayed panel, define the repository on the local machine where you want to
get the scripts generated.
Manual configuration
Click the 'OK' button to launch the generation of the database scripts.
/Sage/V12X3ORA/database/scripts/.installationinformation
/Sage/V12X3ORA/database/scripts/cr0_base_ORASID.sql
/Sage/V12X3ORA/database/scripts/cr1_base_ORASID.sql
/Sage/V12X3ORA/database/scripts/cr2_base_ORASID.sql
/Sage/V12X3ORA/database/scripts/cr3_base_ORASID.sql
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 30/40
08/03/2021 Configuration Console
/Sage/V12X3ORA/database/scripts/cr4_base_ORASID.sql
/Sage/V12X3ORA/database/scripts/initORASID.ora
/Sage/V12X3ORA/database/scripts/launch_ORASID_0.sh
/Sage/V12X3ORA/database/scripts/launch_ORASID_1.sh
/Sage/V12X3ORA/database/scripts/launch_ORASID_2.sh
/Sage/V12X3ORA/database/scripts/launch_ORASID_3.sh
/Sage/V12X3ORA/database/scripts/launch_ORASID_4.sh
If Runtime >= R092
/Sage/V12X3ORA/database/scripts/launch_ORASID_5.sh
/Sage/V12X3ORA/database/scripts/rolesora.sql
launch_ORASID_0.sh example :
export ORACLE_HOME=/opt/oracle/product/19c/dbhome_1/
export ORACLE_SID=ORA19R92
export LIBPATH=${ORACLE_HOME}/lib
export LD_LIBRARY_PATH=${ORACLE_HOME}/lib
export SHLIB_PATH=${ORACLE_HOME}/lib
mkdir /Sage/V12X3ORA/database/traces
mkdir /Sage/V12X3ORA/database/index
mkdir /Sage/V12X3ORA/database/data
mkdir /Sage/V12X3ORA/database/log
mkdir /Sage/V12X3ORA/database/log1
mkdir /Sage/V12X3ORA/database/log2
mkdir /Sage/V12X3ORA/database/scripts
mkdir /Sage/V12X3ORA/database/system
mkdir /Sage/V12X3ORA/database/dump
mkdir /Sage/V12X3ORA/database/dump/audit
These folders are owned by the user 'oracle' that should be set as belonging to the group 'oracle'.
Example:
Define recursive permission via the command line chmod 770 for the following folders: 'data', 'index', 'log', 'log1', 'log2', 'system', 'traces', 'scripts'.
Define recursive premission via the command line chmod 777 for the 'dump' folder.
Example:
4. Verify sqlnet.ora :
Verification of the sqlnet.ora file
$ORACLE_HOME/network/admin/sqlnet.ora
Example:
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 31/40
08/03/2021 Configuration Console
more /products/oracle/product/12.2.0/dbhome_1/network/admin/sqlnet.ora
#SQLNET.AUTHENTICATION_SERVICES = (NTS)
#SQLNET.AUTHENTICATION_SERVICES = (ALL)
#SQLNET.AUTHENTICATION_SERVICES = (NONE)
#SQLNET.ALLOWED_LOGON_VERSION=8
These special Authentication commands were dedicated to be compliant with old and deprecated ODBC Driver for Oracle
(CR Oracle Wire Protocol ODBC Driver 7.0.1, Driver 5.3).
It is not usefull anymore since PrintServer 2.20 and use of ODBC Oracle InstantClient
export ORACLE_SID=V12X3ORA;
export ORACLE_HOME=/products/oracle/product/12.2.0/dbhome_1;
/products/oracle/product/12.2.0/dbhome_1/bin/sqlplus -L "/ AS SYSDBA" @/Sage/SafeX3/ADXADMIN/tmp/exit.sql
Disconnected
/Sage/V12X3ORA/database/scripts/launch_ORASID_0.sh
/Sage/V12X3ORA/database/scripts/launch_ORASID_1.sh
/Sage/V12X3ORA/database/scripts/launch_ORASID_3.sh
/Sage/V12X3ORA/database/scripts/launch_ORASID_4.sh
If Runtime >= R092
/Sage/V12X3ORA/database/scripts/launch_ORASID_5.sh
/Sage/V12X3ORA/database/scripts/launch_ORASID_0.sh
Example : /Sage/V12X3ORA/database/traces/cr0_base_V12X3ORA.log
If all your scripts have correctly been executed, you can come back to the Console
and configure the Runtime and the Application.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 32/40
08/03/2021 Configuration Console
Helper ,
Import folder,
Export folder,
Copy/duplicate a folder
Helper
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 33/40
08/03/2021 Configuration Console
Commands and options :
launcherSolution.exe option1 option2 option3 ....
Treatment of options is "burst", that means each option generates a treatment. However, a failure stops the process.
The solution must exists on the target server, except for the creation process
The login account must exists before connection.
Options :
LauncherSolution.exe /help
Mandatory parameters:
/target:[xmlFile.xml] or /T:[xmlFile.xml] : "model" file path
OR in place of /target:xmlFile.xml
/solutioninfo:'name=[solutionname];configpath=[folders path];servername=[hostname];label=[the solution label]' or /I:[...]
/account:host=[AdxAdmin hostname];user=[AdxAdmin user];pass=[CRYPT:AdxAdmin encrypted password];port=[AdxAdmin port - default:1895] /a:host=[...]
Options:
/solution:[solutionname] or /S:[solutionanme] : name of the target solution
/host:[host] or /H:[host] : target application server
/dbhost:[host] or /B:[host] : database target server
/database:[level] or /D:[level] : configure IDLE database in solution (level : 1 = generate; 2 = execution; 3 = full)
/application or /A : configure IDLE application in solution
/main or /M : configure IDLE MAIN runtime
/full : configure IDLE FULL runtime
/folder:[parameters] or /F:[parameters] : import folder
parameters: folder=[folderNameToImport];histo=[name];svg=[svgName];runtime=[runtime name in multi-main solution]; data=[data files size. Default: 1100];index=[default: 500
/export:[parameters] or /E:[parameters] : export a folder
parameters: folder=[folderNameToExport];svg=[svg foldername];nodata=[0 or 1. Default: 0]; usedbimport=[Use database BulkCopy. 0 or 1. Default: 0]; deletesvgfolder=[Delete S
/copyfolder:[parameters] or /U:[parameters] : duplicate a folder
parameters: sourcefolder=[folder to copy];destfolder=[new foldername];svg=[svgName];data=[data files size. Default: 1100];index=[default: 500];x3user=[for V6 only];x3pwd=[u
/remoteimport:[parameters] : import an existing folder from a remote X3 server to an other X3 server
parameters: sourcesolutionname=[source solution name];sourceservername=[source server host name];sourceuser=[source AdxAdmin user Id - for V6 only];sourcepassword=[for V
/create or /C : create solutions.xml file and Console solution
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 34/40
08/03/2021 Configuration Console
/confighome:[HomeProfile directory] Default=C:\Users\[user]\AppData\Roaming\Sage\Console. ex : 'C:\Sage\consoleprofile'
/VerifPort:[Runtime Port Number] Verify Runtime port available. Example: /VerifPort:20100
/ApacheDirList:[filename.txt] Directory list of installed Apache Servers. Example Apache 2.2.25 : C:\Program Files (x86)\Apache Software Foundation\Apache2.2\
/SQLInstanceList:[filename.txt] Save in [filename] list of SQL instances on the target database server
/SQLClientPathList:[filename.txt] Save in [filename] list of SQL installations & Paths located on the database host
/OraHomeList:[filename.txt] Save in [filename] list of Oracle installations & Paths located on the database host
Samples:
Import a folder under Linux + mono:
mono LauncherSolution.exe /solutioninfo:'name=SQLLINUX01;configpath=/Sage/SQLLINUX01/folders;servername=myhost.sagefr.com;' /account:'host=myhost.sagefr.com;use
Create a solution:
LauncherSolution.exe /solutioninfo:'name=X3V12;label=X3V12 label;servername=test.adinternal.com;configpath=D:\Sage\X3V12\folders;' /account:'host=test.adinternal.com;use
The template file contains either the definitions of the components for their configuration or definitions for the creation of the solution (definitions + component).
When interpreting this file, only the "necessary" information is read.
Format for this file is :
A '0' return code is equivalent to a successful configuration, otherwise the return code is an error equivalent to the X3 error codes, see traces for details.
x3configureEngine.xml :
CODECODE CODExml
<solution name="CLUSTERMM" type="X3">
<label>Sage X3 on matrixw16sql17.sagefr.adinternal.com</label>
<comment>
</comment>
<servername>matrixw16sql17.sagefr.adinternal.com</servername>
<configpath>d:\Sage\CLUSTERMM\folders</configpath>
<module name="CLUSTERMM2" family="RUNTIME" type="FULL">
<component.runtime.installstatus>idle</component.runtime.installstatus>
<component.runtime.name>CLUSTERMM2</component.runtime.name>
<component.runtime.path>d:\Sage\CLUSTERMM\runtime</component.runtime.path>
<component.runtime.platform>WIN64</component.runtime.platform>
<component.runtime.servername>matrixw16sql17.sagefr.adinternal.com</component.runtime.servername>
<component.runtime.version>R093.001.00007</component.runtime.version>
<runtime.adxd.adxdlog>
</runtime.adxd.adxdlog>
<runtime.adxd.adxdtra>
</runtime.adxd.adxdtra>
<runtime.adxd.adxlan>eng</runtime.adxd.adxlan>
<runtime.adxd.adxport>20101</runtime.adxd.adxport>
<runtime.adxd.adxserialpath>
</runtime.adxd.adxserialpath>
<runtime.adxd.adxstatus>
</runtime.adxd.adxstatus>
<runtime.adxd.adxtra>
</runtime.adxd.adxtra>
<runtime.http.hostnamepublic>
</runtime.http.hostnamepublic>
<runtime.http.portpublic>
</runtime.http.portpublic>
<runtime.login.adxservicepwd>CRYPT:verkRgrsw3TmrdoxktvatccVr</runtime.login.adxservicepwd>
<runtime.login.adxserviceusr>sagefr\QualityAdmin</runtime.login.adxserviceusr>
<runtime.odbc.dbhome>
</runtime.odbc.dbhome>
<runtime.odbc.dblink>
</runtime.odbc.dblink>
<runtime.odbc.forcedblink>False</runtime.odbc.forcedblink>
<runtime.odbc.tools>C:\Program Files\Microsoft SQL Server\Client SDK\ODBC\130\Tools</runtime.odbc.tools>
<runtime.system.adxcacheenabled>
</runtime.system.adxcacheenabled>
<runtime.system.atxinddisabled>
</runtime.system.atxinddisabled>
<runtime.system.fdecachedisabled>
</runtime.system.fdecachedisabled>
<runtime.system.lowperformance>true</runtime.system.lowperformance>
</module>
</solution>
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 35/40
08/03/2021 Configuration Console
Import folder:
/folder:
Ex: /folder:'folder=MYSEED;dosref=X3;svg=MYSVGFOLDER;'
LauncherSolution.exe
/target:target.xml
/account:'host=test.adinternal.com;user=sage;pass=CRYPT:EncryptedPassword' /folder:'folder=MYSEED;dosref=X3;svg=MYSVGDIR;x3user=ADMIN' /debug
mono LauncherSolution.exe
/target:X3_Import.xml
/account:'host=matrixw16sql16.sagefr.adinternal.com;user=sagefr\qualityadmin;pass=CRYPT:tesgrQrtvaWalun;'
/folder:'folder=SEED;dosref=X3;svg=MYSVGDIR;'
with target.xml:
CODECODE CODExml
<solution name="SQLLINUX01" type="X3">
<label>Sage X3 onSage X3 sur matrixlrhora1.sagefr.adinternal.com [ID : SQLLINUX01]</label>
<comment></comment>
<servername>matrixlrhora1.sagefr.adinternal.com </servername>
<configpath>/Sage/SQLLINUX01/folders </configpath>
</solution>
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 36/40
08/03/2021 Configuration Console
To avoid to create the Xml file "target.xml", you can add the information in parameter /solutioninfo:
mono LauncherSolution.exe
/solutioninfo:'name=SQLLINUX01;configpath=/Sage/SQLLINUX01/folders;servername=myhost.sagefr.com;'
/account:'host=myhost.sagefr.com;user=sagefr\qualityadmin;pass=QXXXX'
/folder:'folder=MYSEED;svg=MYSVG;'
Export a folder:
/export:[parameters]
Sample :
Export "SEED" folder, solution "UPDV12U90", with structure and its data, in directory "MYSGV2020" :
LauncherSolution.exe
/export:'folder=SEED;svg=MYSGV2020;nodata=0;'
/solutioninfo:'name=UPDV12U90;configpath=d:\Sage\UPDV12U90\folders;servername=MATRIXW16SQL16.sagefr.adinternal.com;'
/account:'host=MATRIXW16SQL16.sagefr.adinternal.com;user=sagefr\qualityadmin;pass=CRYPT:verkRgrsw3TmrdoxktvatccVr;port=1802;'
Example:
LauncherSolution.exe
-solutioninfo:'name=LOCAL91SQL;servername=PO027493;configpath=C:\Sage\LOCAL91SQL\folders;'
-copyfolder:'sourcefolder=SEED;destfolder=TEST10;'
-account:'host=PO027493;user=sagefr\user;pass=CRYPT:uo2qrAAosvaUAAuxptkuvaVcc;port=1818;'
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 37/40
08/03/2021 Configuration Console
LauncherSolution.exe
-remoteimport:'sourcesolutionname=SQLLINUX01;sourceservername=matrixlrhora1.sagefr.adinternal.com;sourceuser=sage;sourcepassword=CRYPT:uo2qrAAosvaUAAuxptkuv
-solutioninfo:'name=LOCALSQL91;servername=PO027493.sagefr.adinternal.com;configpath=C:\Sage\LOCALSQL91\dossiers;'
-account:'host=PO027493.sagefr.adinternal.com;user=sagefr\frdepo;pass=CRYPT:wdorpPccrmTeqrxptkuvaVcc;port=1895;'
Appendix
Presentation
The setup entry panel is made up of two parts:
* The title bar.
* The list of parameters.
On the right of the title bar, a tool bar includes several icons for different actions.
Component status
The component status is located to the right of the title bar. Based on a specific parameter value of Adxinstalls.xml file, is automatically refreshed each time
the component is loaded. So, if you update a component by means of the installation script, the "Update" sttus is automatically detected by the console.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 38/40
08/03/2021 Configuration Console
It is a horizontal series of icons located on the far right of the title bar:
Icon Action
Activates or not the Expert mode display
Expert mode: displays all parameters of the component sorted by category. Categories are ordered in a tree structure on the 'Parameters' column of the
input panel.
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 39/40
08/03/2021 Configuration Console
Index
https://online-help.sageerpx3.com/erp/12/public/configuration-console_console.html#CONSOLE/INDEX.htm 40/40