ONYX Server installation on Windows

This page explains how to install ONYX Server on Windows.

Requirements

• ONYX Server 9.0 runs under Windows Server 2012 R2, 2016 or 2019
• The Web Apache server version 2.2 or 2.4 must be installed on the server before ONYX Server is installed
• If you wish to call ONYX Server functions via the additional API REST module (web server), install Node.js version 8.10 or more beforehand.

Installing the Mapping server

Launch Setup_ONYX_Server_XXXXX.exe. The setup will execute itself in the following order:

1. Home page
2. M-Processing Server loading page: this can load for a couple minutes; once it is loaded, a second window opens to install the M-Processing Server
3. M-Processing Server Home page
4. Terms of use
5. Requirements and recommendations: read this page carefully to set the installation environment properly
6. Installation folder: choose the M-Processing Server folder, a standard installation path is already filled in by default, however we would recommend you to install it in a folder which is specific to the root of your system drive, ex: C:\Mapping\M-ProcessingServer
7. Installation mode: two installation modes are available, Custom or Typical. In both cases, the installation is done in the file chosen previously but the specific configuration options are available in Custom mode. We recommend you to choose the Typical installation mode. You can always come back to the options of the Custom mode and change them after the installation.
8. Apache configuration folder: specify the path of the Apache conf folder
9. Apache binary folders: specify the path of the Apache bin folder
10. Installation parameters: three parameters are required. This data is used to parameter the M-processing Server in the Apache configuration folder: name of the company, name of the server on which the software is installed, IP address of the serveur (we recommend you to use the local loop address "127.0.0.1")
11. Installation of the software. Once the software is installed, the end page is displayed, click on the Finish button, ONYX Server is then installed and the following page lets you parameter the basic setup
12. Extensions available: list of all the extensions available. Caution: some extensions may need you to abide by some requirements!
13. Leave the setup: If no extensions are needed, you leave the setup via the Cancel button in image 12, a popup window will appear, click on Yes to leave the setup.

• 

  1.Home page

• 

  2.M-Processing Server loading page

• 

  3.M-Processing Server Home page

• 

  4.Terms of use

• 

  5.Requirements and recommendations

• 

  6.Installation folder

• 

  7.Installation mode

• 

  8.Path of the Apache configuration folder

• 

  9.Path of the Apache binary folders

• 

  10.Installation parameters

• 

  12.Extensions available

• 

  13.Leave the setup

Installing the API REST extension

Requirements

Node.js version 8.10 or higher must be installed on the server.

Installation

1. Link to download Node.js: if Node.js is not installed on the server, this link redirects you to the download page
2. Installation parameters: the listening port from which the API REST is available
3. Confirm the installation: once you have clicked on the installation button, a loading page appears as the extension is installed
4. Loading page: this page shows the state of the installation, this can take a few minutes. Once the extension is installed, an ending page is displayed

• 

  1.Link to download Node.js

• 

  2.Installation parameters

• 

  3.Confirm the installation

• 

  4.Loading page

Post-installation configuration on Windows

Software keys

Once the installation is finished, the first thing you have to do is enter the license keys.

1. Open the Software activation application in the list of applications
2. Enter the license keys: check the Software key box, two input fields appear.

• In the first field: enter the product number (number from 1 to 5)
• In the second field: enter the license keys (combination of numbers and uppercase letters, separated by dashes)
  

• 

  Open Software activation

• 

  Enter the software keys

Launching the interface

Once the installation is finished, the Apache server needs to be restarted before accessing the managing web interface of ONYX Server.

1. Open your web browser

2. Enter the following URL:

• From the local server: http://127.0.0.1:8002
• From a workstation in the network: http://<ip.du.serveur>:8002

8002 being the port configured by default during the installation

Common errors

The 8002 port is already used

In this case, Apache cannot restart. Change the port used to access the web interface of the Mapping server:

1. Open the Apache configuration file, httpd.conf (it is located in the conf file, specified during installation)
2. Search for the configuration block between #BEGIN_MAPPING and #END_MAPPING (it is usually at the end of the file)
3. Change the listening 8002 port in the following lines:

• Listen 8002
• NameVirtualHost *:8002
• <VirtualHost *:8002>
  

Then, restart the Apache server.

An error message is displayed when opening the page

Errors can occur when opening the Mapping page. If the 2.4 version of Apache was installed, activate the mod_access_compat module in the Apache configuration file, httpd.conf.

To do so:

1. Open the Apache configuration file, httpd.conf (it is located in the conf folder, specified during installation)
2. Search for the line which contains mod_acces_compat.so

Delete the # character at the start of the line as can be seen in the following example:

#LoadModule access_compat_module /usr/lib/apache/mod_access_compat.so

LoadModule access_compat_module /usr/lib/apache/mod_access_compat.so

Then, restart the Apache server.

Start the Mapping Spooler

To activate the Mapping spooler:

1. Open the M-processing Server interface
2. Click on the following icons in this order:

• Management Menu
• Print Management
• Spooler Management
• Start Spooler

Once the spooler is started, a service called Mapping_spooler appears in the list of Windows services (services.msc)

Updating M-Processing Server

1. Launch the setup and choose option Repair
2. If the question "Do you confirm the update of this environment?" appears, select Yes
3. As the server is updating, if an error related to map_daemon.exe occurs, check that the Mapping_Spooler service is stopped. Stop it if it is still active.
4. Click on Finish to end the M-Processing Server update and display the extensions window.

• 

  1.Choose the Update option

• 

  3.Update loading

• 

  4.End update

Updating the API REST extension

If the extension is already installed, the only option you have is to update it.

1. Click on Next to update the extensions.

• 

  1.Update the extension