> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/documentations/efalia-compose/mapping-suite/onyx-server/installation-onyx-server-pour-windows.md).

# Installation ONYX Server pour Windows

## Prérequis

* ONYX Server 9.0 fonctionne sous Windows Server 2012 R2, 2016 ou 2019
* Le serveur Web Apache version 2.4 doit être installé sur le serveur avant d’installer ONYX Server
* Si vous souhaitez appeler les fonctions d’ONYX Server via le module complémentaire API REST (web service), il convient d’installer Node.js version 8.10 ou supérieure au préalable

## Installation du serveur Mapping

Lancer **Setup\_ONYX\_Server\_XXXXX.exe**. Le setup s’exécutera dans cet ordre :

* Page de bienvenue

<figure><img src="/files/r9Jt12LFQjoYJb0rAlqq" alt=""><figcaption></figcaption></figure>

* Page de chargement de ONYX Server : le chargement peut prendre plusieurs minutes; à la fin du chargement, une deuxième fenêtre s’ouvre sur l’installation de M-Processing Server

<figure><img src="/files/uhoImluvO2rIAj8HiEdS" alt=""><figcaption></figcaption></figure>

* Page de bienvenue de M-Processing Server

<figure><img src="/files/fxDmpQVwFkzlXGznkIDV" alt=""><figcaption></figcaption></figure>

* Conditions d’utilisation

<figure><img src="/files/k4YhLUQWG8LBmKEjTFVU" alt=""><figcaption></figcaption></figure>

* Prérequis et recommandations : lire attentivement cette page afin d’obtenir un environnement propice à l’installation de ONYX Server

<figure><img src="/files/NIKGGqTsvtPIiKrBXth1" alt=""><figcaption></figcaption></figure>

* Dossier d’installation : choisir le dossier d’installation de ONYX Server, par défaut un chemin d’installation standard est pré-rempli, cependant nous vous recommandons de l’installer dans un dossier spécifique à la racine de votre lecteur système, et sans espace. Exemple : “C:\Mapping\MappingServer”

<figure><img src="/files/8qeHGnShsUE9L7qvMR3Y" alt=""><figcaption></figcaption></figure>

* Mode d’installation : deux modes d’installation sont disponibles, **Custom** ou **Typical**. Dans les deux cas, l’installation se fera toujours dans le dossier précédemment choisi mais des options de configuration spécifiques seront disponibles en mode **Custom**. Nous vous recommandons de choisir le mode d’installation **Typical**. Les options du mode **Custom** seront toujours modifiables après l’installation.

<figure><img src="/files/mjclp0qKIfl6UH1gX7TS" alt=""><figcaption></figcaption></figure>

* Dossier de configuration d’Apache : renseigner le chemin du dossier **conf** d’Apache

<figure><img src="/files/usNyR1TW3Mw7yWc1gwgh" alt=""><figcaption></figcaption></figure>

* Dossier des binaires d’Apache : renseigner le chemin du dossier **bin** d’Apache

<figure><img src="/files/QFsnpbvuZtAx8fKT3zbI" alt=""><figcaption></figcaption></figure>

* Paramètres d’installation : trois paramètres sont demandés. Ces données serviront pour le paramétrage de ONYX Server dans le fichier de configuration d’Apache : nom de société, nom du serveur sur lequel est installé le logiciel, adresse IP du serveur (il est fortement conseillé d’utiliser l’adresse de boucle locale “127.0.0.1”)

<figure><img src="/files/mub9SGlKGvZF64YYnJO0" alt=""><figcaption></figcaption></figure>

* Installation du logiciel. A la fin de l’installation, une page de fin s’affiche, une fois le bouton **Finish** cliqué, ONYX Server est installé et le setup de base reprend avec la page suivante
* Extensions disponibles : liste des extensions disponibles. **Attention** : certaines extensions nécessitent des prérequis !

<figure><img src="/files/HETByMJ8vvROdFXloCrl" alt=""><figcaption></figcaption></figure>

* Quitter le setup : Si aucune des extensions n’est nécessaire, le setup peut-être quitté via le bouton **Annuler** de l’image 12, une popup de confirmation s’affichera, cliquer sur **Oui** pour quitter le setup.

<figure><img src="/files/TosIsjlRVSGbfhcvD92u" alt=""><figcaption></figcaption></figure>

## Installation de l’extension API REST

**Prérequis**

Node.js version 8.10 ou supérieur doit être installé sur le serveur.

**Installation**

* Lien de téléchargement de Node.js : si Node.js n’est pas installé sur le serveur, ce lien vous redirigera vers la page de téléchargement

<figure><img src="/files/kVNH3rcAIgnQXHfZtec0" alt=""><figcaption></figcaption></figure>

* Paramètres d’installation : le port d’écoute depuis lequel l’API REST sera disponible

<figure><img src="/files/xAp681LxF4mr3OhEzvaa" alt=""><figcaption></figcaption></figure>

* Confirmation de l’installation : après avoir cliqué sur le bouton Installer, une page de chargement s’affichera pendant l’installation jusqu’à la page de fin du setup

<figure><img src="/files/XP24q8fBLSeZD1HK6kre" alt=""><figcaption></figcaption></figure>

* Page de chargement : cette page indique la progression de l’installation, le chargement peut prendre plusieurs minutes. L’installation débouchera sur la page de fin de setup

<figure><img src="/files/k4YhLUQWG8LBmKEjTFVU" alt=""><figcaption></figcaption></figure>

## Configuration post-installation sur Windows

### Clés de licence

Une fois l’installation terminée, la première chose à faire est de saisir les clés de licence.

* Ouvrir l’application **Software activation** dans la liste des applications

<figure><img src="/files/QUEqlOqYZy2tfsvDQWh3" alt=""><figcaption></figcaption></figure>

* Saisir les clés de licence : cocher **Clé logicielle**, deux champs de saisie apparaissent.

<figure><img src="/files/dQjdt48cfNSJH6VkwVn4" alt=""><figcaption></figcaption></figure>

* Dans le premier champ : saisir le numéro de produit (chiffre allant de 1 à 5)
* Dans le deuxième champ : saisir la clé de licence (combinaison de chiffres et de lettres en majuscules, séparés par des tirets)
* Ouvrir Software activation
* Saisir les clés

## Modification de la configuration Apache dans le cas d’une version 2.4

Si, comme cela est préconisé, la version 2.4 d’Apache a été installée, il faut procéder à une petite modification du fichier httpd.conf d’apache, dans la section ajoutée automatiquement lors de l’installation de Mapping.

La section Mapping du httpd.conf est identifiée par le mot clé `#BEGIN_MAPPING_...`

Pour cela :- Supprimer le noeud `<Directory C:\xxxxx\xxxxx\MapHTTPServer\cgi-bin>` du fichier httpd.conf (c’est-à-dire le noeud xml complet avec tout son contenu et la balise de fin `</Directory>`)- Supprimer les instructions suivantes`NameVirtualHost ...``AllowOverride all``Order allow,deny``Allow from all`– Ajouter les instruction présentes dans le fichier `MapHTTPServer\.htaccess` directement dans le noeud `<Directory C:\xxxx\xxxx\MapHTTPServer>`– Remonter l’instruction ServerName en début de bloc, avant la balise - Supprimer (mettre en commentaire) le module “mod\_access\_compat.so” si jamais il était activé- Supprimer (ou renommer) le fichier `MapHTTPServer\.htaccess`

La section Mapping du fichier httpd.conf devrait alors ressembler à ceci (exemple basé sur une installation effectuée dans “C:\Mapping\MappingServer”) :

```
#BEGIN_MAPPING_v9.0.0_2019/06/12_16_10_57
#DO NOT MODIFY THIS BLOCK. It will be automatically updated.
ServerName mapping-server
Listen 8002
&lt;VirtualHost *:8002&gt;
       DocumentRoot "C:\Mapping\MappingServer\MapHTTPServer"
       ScriptAlias /cgi-bin/ "C:\Mapping\MappingServer\MapHTTPServer\cgi-bin\"
       &lt;Directory "C:\Mapping\MappingServer\MapHTTPServer"&gt;
               AuthType Basic
               AuthName "Identification"
               AuthBasicProvider file
               AuthUserFile "C:\Mapping\MappingServer\MapHTTPServer\.htpasswd"
               AuthGroupFile "C:\Mapping\MappingServer\MapHTTPServer\.htgroup"
               Require valid-user
               Options None
       &lt;/Directory&gt;
&lt;/VirtualHost&gt;
#END_MAPPING_v9.0.0_2019/06/12_16_10_57
```

### Blocs de configuration optionnels (modèles)

Il s’agit de configurations optionnelles pouvant être ajoutées directement dans le noeud décrit ci-dessus.

#### Pour lister le contenu des dossiers de configuration du serveur

Cette configuration permet de parcourir les fichiers de configuration Mapping directement depuis l’interface, avec accès limité à l’utilisateur **mapadmin**. Pour l’utiliser, il suffit d’ajouter “/dir” derrière l’url.\
Exemple : `http://monserveurmapping:8002/dir`

```
       Alias /dir "C:\Mapping\MappingServer\Settings"
       &lt;Directory "C:\Mapping\MappingServer\Settings"&gt;
              AuthType Basic
              AuthName Identification
              AuthBasicProvider file
              AuthUserFile "C:\Mapping\MappingServer\MapHTTPServer\.htpasswd"
              Require user mapadmin
              Options +Indexes
       &lt;/Directory&gt;
```

#### Pour protéger l’accès à l’interface de Workflow

Cette configuration permet limiter l’accès à l’interface du Workflow uniquement à l’utilisateur **mapadmin**.

```
       &lt;Directory "C:\Mapping\MappingServer\MapHTTPServer\JS_Common"&gt;
              AuthType Basic
              AuthName Identification
              AuthBasicProvider file
              AuthUserFile "C:\Mapping\MappingServer\MapHTTPServer\.htpasswd"
              Require user mapadmin
       &lt;/Directory&gt;
```

## Lancement de l’interface

Une fois l’installation terminée, il est nécessaire de redémarrer le service Apache avant de pouvoir accéder à l’interface Web d’administration d’ONYX Server.

1. Ouvrir une page de navigateur internet
2. Saisir dans l’URL :

* Depuis le serveur en local : `http://127.0.0.1:8002`
* Depuis un poste en réseau : `http://<ip.du.serveur>:8002`

*`8002` étant le port configuré par défaut lors de l’installation*

S’ils n’ont pas été modifiés lors de l’installation, les identifiants de connexion sont les suivants :

* Nom d’utilisateur : mapadmin
* Mot de passe : mapadmin

### Erreurs fréquemment rencontrées

**Si le port 8002 est déjà occupé**

Dans ce cas, Apache ne peut pas redémarrer. Il suffit alors de modifier le port utilisé pour accéder à l’interface Web du serveur Mapping :

* Ouvrir le fichier de configuration d’Apache, **httpd.conf** (il se trouve dans le dossier **conf**, référencé lors de l’installation)
* Chercher le bloc de configuration situé entre **#BEGIN\_MAPPING** et **#END\_MAPPING** (généralement en bas du fichier)
* Modifier le port d’écoute 8002 dans les lignes suivantes :
* Listen 8002
* NameVirtualHost \*:8002
* \<VirtualHost \*:8002>

Puis, redémarrer le service Apache.

**Message d’erreur à l’ouverture de la page**

Il est possible qu’une erreur se produise à l’ouverture de la page Mapping si la version 2.4 d’Apache a été installée, mais que la modification relative à sa configuration n’a pas été faite (voir ci-dessus) ou que Apache n’a pas été redémarré correctement.

**L’interface du Workflow ne se lance pas**

Il est possible que les redistribuables nécessaire à l’exécution du binaire mapsoapserver.exe ne soient pas installés sur la machine hôte (en fonction de la version de Windows utilisée). Pour valider l’origine du problème, il suffit d’exécuter le binaire mapsoapserver.exe (situé dans le dossier C:\Mapping\MappingServer\MapHTTPServer\cgi-bin) et constater un message d’erreur lié à une dll manquante.

Les packages redistribuables Visual C++ pour Visual Studio 2013 sont disponibles à la page suivante : <https://www.microsoft.com/fr-FR/download/details.aspx?id=40784>\
Le package concerné est le fichier “vcredist\_x86.exe” qu’il faut télécharger et installer. Il n’est pas nécessaire de relancer l’installation de Mapping Onyx Server.

## Démarrer le Spooler Mapping

Pour activer le spooler Mapping :

* Ouvrir l’interface de ONYX Server
* Cliquer sur les icônes suivantes dans l’ordre :
* Menu d’Administration
* Gestion des Impressions
* Gestion du Spooler
* Démarrer le Spooler

Une fois le spooler démarré, un service nommé Mapping\_spooler apparaît dans la liste des services Windows (services.msc)

## Mise à jour de ONYX Server

1 – Arrêter les services suivants s’ils sont démarrés :

* Mapping\_Spooler
* Mapping\_Mapreport
* Mapping\_ScanFolder\_xxxxxxx

2 – Lancer le setup et de choisir l’option **Repair**

<figure><img src="/files/Rhgda8miLeyVX7XGMrK0" alt=""><figcaption></figcaption></figure>

3 – Si la question “*Do you confirm the update of this environment?*” apparaît, cliquer **Oui**

4 – La mise a jour se déroule, si une erreur concernant map\_daemon.exe apparaît, vérifier que le service Mapping\_Spooler est bien arrêté. L’arrêter s’il est toujours actif. De même avec les éventuels autres services qui pourraient encore être actif au pendant cette mise à jour.

<figure><img src="/files/6BNTQFNST8AdOop8Jfoc" alt=""><figcaption></figcaption></figure>

5 – Cliquer sur **Finish** pour terminer la mise à jour de ONYX Server et afficher la fenêtre des extensions.

<figure><img src="/files/PvpqWgp1mjtj4nBOGYKG" alt=""><figcaption></figcaption></figure>

6 – Redémarrer les services qui avaient été arrêtés.

* 1.Choisir l’option mise à jour
* 3.Chargement de la mise à jour
* 4.Terminer la mise à jour

## Mise à jour de l’extension API REST

Si l’extension est déjà installée, seule la mise à jour est disponible.

* Cliquer sur **Suivant** mettra à jour les extensions.

<figure><img src="/files/rnekNQAJyXn8pojcRUg8" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.efalia.com/documentations/efalia-compose/mapping-suite/onyx-server/installation-onyx-server-pour-windows.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.