ONYX - 9.0 - Installation

Installation de ONYX Xpress

De MappingDoc

Présentation et objectifs

Cette page explique comment installer, mettre à jour ou désinstaller le logiciel Xpress sur un ordinateur Windows.

Il existe 2 installeurs distribués par Mapping qui incluent Xpress :

  • ONYX Server, qui ne contient que le REST API de Xpress
  • ONYX Xpress, qui ne contient Mapping Processing Server, mais dispose des écrans de configuration des services, en plus du REST API

Afin d'éviter tout conflit de versions, les autres briques logicielles de la suite Mapping (non incluses dans l'installation choisie) doivent être mises à jour en même temps.

La suite de cette documentation présentent le cas de ONYX Xpress.

Prérequis

Systèmes d'exploitation

ONYX Xpress est compatible avec les systèmes d'exploitation suivants :

  • Windows Server 2019, 2016, 2012
  • Red Hat Enterprise Linux (RHEL) 7

Environ 300 Mo d'espace disque sont requis pour l'installation.

Pour un fonctionnement optimal, le système hôte doit

  • posséder la configuration matérielle recommandée par l'éditeur;
  • être à jour des dernières mises à jour publiées par l'éditeur du système d'exploitation.

Sécurité

Les droits Administrateur sont requis pour l'installation.

Ports

Aujourd'hui, ONYX Xpress est compilé en version 32-bit mais demeure parfaitement compatible avec les systèmes 64-bit. ONYX Xpress utilise trois ports réseau pour les communications internes (process) ou externes (interface web d'administration). Les ports utilisés par défaut sont :

  • 8002 (port Web)
  • 515 (port LPD)
  • 2005 (port spooler interne)

Ces 3 ports doivent être ouverts et disponibles pour ONYX Xpress.

En conséquence, le serveur Microsoft LPD/LPR doit être arrêté pour libérer le port 515.

Procédure d'installation

Le setup d'installation peut être téléchargé depuis : https://server.mappingsuite.com

  • Double-cliquer sur le setup.

Important : Sur Windows 7 et supérieur, le programme d'installation demande une élévation de droits supplémentaire qui doit être autorisée.

  • Choisir la langue pour vous guider lors de l'installation
  • Choisir le répertoir d'installation. Cliquer sur Parcourir pour modifier le chemin par défaut. Puis cliquer sur Suivant
  • Choisir le chemin racine du dossier des données applicatives. Cliquer sur Parcourir pour modifier le dossier par défaut. Puis cliquer sur Suivant
  • Choisir le chemin du dossier Fonts. Cliquer sur Parcourir pour modifier le dossier par défaut. Puis cliquer sur Suivant
  • Saisir les ports utilisés par l'application
  • Choisir l'emplacement des raccourcis programmes dans le dossier de démarrage. Cliquer sur Parcourir pour modifier le dossier par défaut
  • Cliquer sur "Installer" pour continuer l'installation ou Précédent pour revenir en arrière
  • Laisser l'installation se dérouler jusqu'à son terme puis cliquer sur Terminer pour terminer l'installation.


Le programme d'installation crée deux dossiers situés dans (par défaut) :

  • Program Files (x86)
  • ProgramData

Le programme d'installation crée deux raccourcis dans le menu Démarrer de l'ordinateur :

  • Pour l'interface Web d'administration : All Programs > ONYX Xpress > ONYX Xpress Interface
  • Pour désinstaller le logiciel

Des entrées sont également ajoutées dans la base de registre Windows du PC. De plus, une variable d'environnement très importante est également créée MAPPING_PATH, laquelle pointe sur le fichier principal de configuration. Ce fichier est renseigné avec les paramètres choisis lors de l'installation.

  • Application Path: chemin des exécutables de l'application requis par le logiciel
  • Data Path: chemin vers tous les fichiers de configuration
  • Spooler port: le port socket pour toutes les communications avec le spooler
  • Web Server port: le port d'accès à l'interface de l'application dans un navigateur web

Activation du logiciel

Après l'installation, les fonctionnalités sont activées en saisissant des clés logicielles dépendantes du système sur lequel le logiciel est installé. Pour obtenir les clés de licence :

  • Récupérer les identifiants du serveur
  • Ensuite, il y a deux possibilités :
    • Se connecter sur l'Espace Partenaires pour générer vos clés à partir des identifiants du serveur
    • Utiliser un voucher sur l'Espace Partenaires pour générer vos clés à partir des identifiants du serveur

Identifiants Serveur

Pour obtenir les identifiants du serveur, il faut exécuter la commande M-Key en mode Console mode sur le serveur. La commande M-Key est située dans le dossier des binaires. Exemple :

C:\>cd "C:\Program Files (x86)\M-Xpress\bin"
C:\Program Files (x86)\M-Xpress\bin >M-Key.exe -displayID
ComputerID : 1_0117160

Saisir les licenses

Pour saisir les clés logicielles, veuillez vous référer au guide d'utilisation.

Procédure de mise à jour

Avant toute mise à jour, il est nécessaire d'arrêter tous les services applicatifs. Puis, exécuter le nouveau setup et choisir "Repair" (ou "Réparer").

Le programme met à jour tous les binaires utilisés par l'application (C:\Program Files (x86)\M-Xpress\bin) ainsi que la description et les fichiers de l'interface Web (C:\Program Files (x86)\M-Xpress\ui). Cependant, il ne modifie par les fichiers de configuration du serveur Mapping ni les différents objets Mapping (maquettes, robots, queues, workflows, profils, etc.) 

Procédure de désinstallation

Pour désinstaller le logiciel, il est recommandé d'utiliser le programme Windows du Panneau de configuration qui gère les installations / désinstallations (rechercher : Ajouter ou supprimer des programmes).
Trouver ONYX Xpress dans la liste et utiliser le bouton de désinstallation.

De façon équivalente, mais plus manuelle, vous pouvez au préalable arrêter tous les services (M-Ui, M-Lpr, M-quelque chose), puis lancer le programme de désinstallation situé dans le répertoire de ONYX Xpress : “unins000.exe”.

Le programme supprime les éléments suivants :

  • Tous les fichiers du répertoire d'installation
  • Les deux raccourcis du menu Démarrer
  • Les entrées de la base de registre