Guide d'installation ONYX Server sur Windows

Autres langues :

English • ‎français

Cette page décrit comment installer et mettre à jour ONYX Server sur Windows.

Sommaire

1 Prérequis
2 Installation du serveur Mapping
3 Installation de l'extension API REST
4 Configuration post-installation sur Windows
- 4.1 Clés de licence
5 Modification de la configuration Apache dans le cas d'une version 2.4
- 5.1 Blocs de configuration optionnels (modèles)
  - 5.1.1 Pour lister le contenu des dossiers de configuration du serveur
  - 5.1.2 Pour protéger l'accès à l'interface de Workflow
6 Lancement de l'interface
- 6.1 Erreurs fréquemment rencontrées
7 Démarrer le Spooler Mapping
8 Mise à jour de ONYX Server
9 Mise à jour de l'extension API REST

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
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
Page de bienvenue de M-Processing Server
Conditions d'utilisation
Prérequis et recommandations : lire attentivement cette page afin d'obtenir un environnement propice à l'installation de ONYX Server
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"
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.
Dossier de configuration d'Apache : renseigner le chemin du dossier conf d'Apache
Dossier des binaires d'Apache : renseigner le chemin du dossier bin d'Apache
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")
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 !
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.

1.Page de bienvenue
2.Chargement du setup ONYX Server
3.Page de bienvenue de M-Processing Server
4.Conditions d'utilisation
5.Prérequis et recommandations
6.Dossier d'installation
7.Mode d'installation
8.Chemin du dossier de configuration d'Apache
9.Chemin du dossier des binaires d'Apache
10.Paramètres d'installation
12.Extensions disponibles
13.Quitter le setup

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
Paramètres d'installation : le port d'écoute depuis lequel l'API REST sera disponible
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
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

1.Lien de téléchargement de Node.js
2.Paramètres d'installation
3.Confirmation de l'installation
4.Page de chargement

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
Saisir les clés de licence : cocher Clé logicielle, deux champs de saisie apparaissent.

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 <VirtualHost>

- 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
<VirtualHost *:8002>
       DocumentRoot "C:\Mapping\MappingServer\MapHTTPServer"
       ScriptAlias /cgi-bin/ "C:\Mapping\MappingServer\MapHTTPServer\cgi-bin\"
       <Directory "C:\Mapping\MappingServer\MapHTTPServer">
               AuthType Basic
               AuthName "Identification"
               AuthBasicProvider file
               AuthUserFile "C:\Mapping\MappingServer\MapHTTPServer\.htpasswd"
               AuthGroupFile "C:\Mapping\MappingServer\MapHTTPServer\.htgroup"
               Require valid-user
               Options None
       </Directory>
</VirtualHost>
#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 <VirtualHost> 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"
       <Directory "C:\Mapping\MappingServer\Settings">
              AuthType Basic
              AuthName Identification
              AuthBasicProvider file
              AuthUserFile "C:\Mapping\MappingServer\MapHTTPServer\.htpasswd"
              Require user mapadmin
              Options +Indexes
       </Directory>

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.

       <Directory "C:\Mapping\MappingServer\MapHTTPServer\JS_Common">
              AuthType Basic
              AuthName Identification
              AuthBasicProvider file
              AuthUserFile "C:\Mapping\MappingServer\MapHTTPServer\.htpasswd"
              Require user mapadmin
       </Directory>

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

Arrêter les services actifs : Mapping_Spooler, Mapping_Mapreport et Mapping_ScanFolder_xxxxxxx
Lancer le setup et de choisir l'option Repair
Si la question "Do you confirm the update of this environment?" apparaît, cliquer Oui
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.
Cliquer sur Finish pour terminer la mise à jour de ONYX Server et afficher la fenêtre des extensions.

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.

1.Mettre à jour l'extension