Installation manuelle de ELOas

Ce document décrit l'installation manuelle des ELO Automation Services (ELOas). Sous ELOprofessional, le module est créé automatiquement par l'installation serveur. Dans le cas d'une installation ultérieure ou dans un environnement dispersé, il faut effectuer une installation manuelle.

Comme presque tous les modules provenant de la ligne de serveur ELOenterprise, ELOas est programmé comme servlet et requiert un environnement runtime Java ainsi qu'un serveur d'application, par exemple Tomcat 9.0. Pour cela, au minimum la version 11 de Java est requise.

La configuration est déposée dans un fichier XML config.xml dans le répertoire de configuration standard de ELO. Vous pouvez ainsi effectuer les mises à jour sans aucun problème et la configuration subsiste. La langue standard pour ELOas est déterminée en fonction de la langue d'installation sélectionnée lors de ELO Server Setup; par ailleurs, elle est entrée dans le fichier config.xml dans le paramètre language (dans notre exemple, nous avons entré "en" pour l'anglais) :

<entry key="language">en</entry>

Les directives d'exécution de ELOas avec les règles, les listes de traductions et les scripts de base se trouvent dans un classeur dans l'archive. Dans la configuration, seul l'accès au serveur d'indexation ELO et ce classeur de base doivent être définis.

Fichiers requis

Dans l'archive ZIP destinée à l'installation manuelle, vous trouverez les fichiers suivants:

ELOas.war
ELOas.xml
logback.xml
config.xml
ELO Automation Services Konfiguration.zip
Installation.pdf
JavaScriptCode.pdf
Regeldefinition.pdf

Préparations pour l'installation

Pour l'exploitation ELOas, les librairies ELOas standards doivent se trouver dans le classeur "JavaScript". Les nouvelles versions de ELOas installer automatiquement les libraries ELOas standards, si celles-ci ne sont pas disponibles. Les librairies ELOas standards actuelles peuvent être téléchargées et installées à tout moment à partir du site officiel de scripting (opens new window)*.

Illustr. : classeur pour les rules dans ELO

Le sous-classeur Rules contient les règles personnalisées, voici un exemple qui peut être utilisé comme modèle pour vos propres solutions.

Les fichiers ELOas.war et ELOas.xml doivent être renommés selon le nom d'archive et la convention standard ELO pour les noms de service: as-<nom de l'archive>.war ou as-<nom de l'archive>.xml. Pour l'archive "elo20", il s'agirait alors de "as-elo20.war" ou de "as-elo20.xml". Veuillez respecter les minuscules et majuscules, étant donné que celles-ci sont importantes pour un accès ultérieur. Ces deux fichiers sont alors copiés dans un répertoire temporaire sur votre ordinateur, sur lequel tourne le serveur d'application (par exemple C:\TEMP).

Dans le fichier ELOas.xml, le chemin pour le répertoire de configuration de votre environnement ELO doit être entré :

<?xml version='1.0' encoding='UTF-8'?>
<Context path="/as-elo20">
    <Environment name="webappconfigdir"
                 value="G:\ELOprofessional\config\as-elo20"
                 type="java.lang.String" override="false"/>
</Context>

Un sous-répertoire est créé pour cette configuration ELOas pour les fichiers clogback.xml et config.xml, et ces deux fichiers sont copiés à cet endroit.

Illustr. : répertoire de configuration pour ELOas

Le nom du répertoire de configuration devrait commencer par "as-", puis contenir le nom de l'archive. Pour l'archive "elo20", il doit donc porter le nom "as-elo20". Dans le fichier logback.xml, le chemin pour le répertoire du sortie doit être adapté à l'installation locale.

<file>C:/Programme/Tomcat 9.0/logs/as-elo20.log</file>

Dans le fichier config.xml, les paramètres d'accès au serveur d'indexation doivent être adaptés.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
<comment>parameters for this web application</comment>
<entry key="url">http://testserver:8080/ix-elo20/ix</entry>
<entry key="user">Services</entry>
<entry key="password">130-167-2-31-129-121-203-174-234-167-21-87-88-80-78-122</entry>
<entry key="rootguid">(F6C173D7-3F71-4559-91E5-4886139B12CF)</entry>
</properties>

La clé url contient le chemin d'accès au serveur d'indexation ELO. Soyez attentif aux majuscules et minuscules, en cas d'erreur, le serveur d'indexation sera introuvable.

La clé user contient le nom d'authentification de ELOas au serveur d'indexation. Normalement, vous devriez créer un propre compte pour des services additionnels, qui ne peut pas être utilisé par d'autres utilisateurs.

La clé password contient le mot de passe ELO. A des fins de test, vous pouvez effectuer cette entrée dans le texte clair. Après le démarrage du service, le rapport contient une remarque concernant le codage. Vous pouvez copier ce texte dans la configuration avec Copier&Coller à partir du rapport.

La clé rootguid contient le GUID du classeur de base de ELOas, le préréglage est le GUID du classeur d'exemple à partir du jeu de données d'importation. Si vous avez créé un propre registre pour ces données, vous pouvez alors simplement définir le GUID en utilisant le script suivant (fichier GetGuid.vsb dans l'archive ZIP) dans le client Windows ELO :

Set Elo=CreateObject("ELO.professional")
if Elo.SelectView(0)=1 then
    Id=Elo.GetEntryId(-1)
    if Id>1 then
        if Elo.PrepareObjectEx( Id, 0, 0 ) > 0 then
            call Elo.ToClipboard(Elo.ObjGuid)
            MsgBox Elo.ObjGuid
        end if
    end if
end if

Ce script détermine le GUID de l'entrée sélectionnée actuellement et le copie dans le presse-papiers Windows. A partir de là, vous pouvez l'adopter dans la configuration à partir de l'éditeur par Ctrl-V.

La clé rootguid est également utilisée pour la configuration de plusieurs instances ELOas. Vous pouvez exploiter jusqu'à dix instances ELOas. Vous pouvez créer un classeur "ELOas Base" sous <nom de l'archive> // Administration. Dans le fichier config.xml, créez des paramètres rootguid distincts pour chaque classeur "ELOas Base"-comme dans l'exemple suivant :

<entry key="rootguid">(F6C173D7-3F71-4559-91E5-4886139B12CF)</entry>
<entry key="rootguid1">(D6EF1F0B-ADE4-C3E2-74F9-3658ED55449A)</entry>
<entry key="rootguid2">(2CFDEA54-3DA9-E567-F335-6F3D223C9BAF)</entry>

Les règles ELOas des différents classeurs "ELOas Base" sont effectuées indépendamment les unes des autres. Même s'il existe plusieurs instances, les logs sont créés dans un fichier journal (log4j.properties). Le chemin du fichier log est défini dans le fichier de configuration logback.xml.

La clé tempdir contient en option un répertoire pour le téléchargement temporaire des fichier texte, si les données XML et JavaScript doivent se trouver dans des fichiers texte, à la place du texte supplémentaire. Si tempdir est vide ou qu'il n'existe pas, la version du texte supplémentaire est utilisée automatiquement, sinon, c'est la version du fichier texte.

<entry key="tempdir">C:\Temp\ELOas</entry>

Remarque

Lors de la création d'un nouvel utilisateur pour ce service, le serveur d'indexation réagit à cette modification avec un délai. Par sécurité, vous pouvez supprimer le cache utilisateur sur la page de statut du serveur d'indexation ELO, afin de forcer une actualisation immédiate.

Déployement des fichiers

Maintenant, vous pouvez entrer les paramètres pour l'installation dans le serveur d'application. Le chemin de contexte (n'est pas en option, même si c'est noté ainsi dans la console d'administration du Tomcat) contient le nom de l'application Web, les deux chemins de fichiers pointent sur la configuration et le fichier de programme. Il suffit de cliquer sur Installer pour installer l'application.

Illustr. : entrer les paramètres pour le déploiement

Le fichier "ELOas.war" dans la version actuelle d'ELOas contient un fichier de texte du nom "version.txt". Ce fichier contient les extensions des différentes versions ELOas.

Afficher la page des statuts

ELOas dispose d'une propre page de statut, celle-ci peut être atteinte par l'adresse URL suivante:

http://<SERVERNAME>:9070/as-<NOM DE L'ARCHIVE>/as?cmd=status

Illustr. : page de statut ELOas avec règles actives

Les rulesets actifs sont affichés sous forme de liste sur la page de statut, avec l'information, combien de fois ils ont déjà été exécutés et quand la prochaine exécution est prévue.

En cas d'erreur JavaScript, celle-ci est affichée sur la page de statut, afin le numéro de ligne de l'erreur et du code de programme dans cette section.

Illustr. : appliquer les modifications avec Reload

Les modifications des règles et des scripts dans l'archive peuvent être prises en compte par un clic sur Reload sans redémarrer le serveur.

Illustr. : ELO Automation Services reload report

Back to Status Page vous permet de revenir à l'affichage normal de l'état.

Sur l'onglet Ajouter, les catalogues contiennent des éléments, qui devraient être coordonnés avec la mise en page générale du document. A l'aide de ces catalogues, vous pouvez ajouter de tableaux, des en-têtes, des notes de fin de page, des listes etc.