Serveur de documentation
Le serveur de documentation fournit la documentation applicative de la solution configurée. Cette documentation est livrée au format compressé (format CHM) sous Windows et "éclaté" (HTML) sur Unix.
Depuis la version V7, la documentation du produit est accessible en ligne. Toutefois, un composant serveur de documentation existe et peut être configuré pour le produit mais il n'est ni configuré, ni géré par la Console de Configuration Safe X3 V2.
Configuration
Pour mettre en œuvre le Serveur de documentation, il faudra :
- charger le composant Serveur de documentation,
- configurer le composant Serveur de documentation,
- publier la solution sur le Serveur de documentation.
Chargement
Pour charger ce composant, cliquer sur le bouton Ajouter du tiroir Serveur de documentation.
Pour plus d'informations sur la boîte de dialogue chargement d'un composant, consultez la documentation Composant de saisie des paramètres.
La Console fait l'acquisition des différents paramètres du composant Serveur de documentation.
La valeur du statut du composant Documentation est Non Configuré. Une fois configuré, cette valeur passera à En fonctionnement.
Configuration
Format d'accès à la documentation
Il existe deux types d'accès à la documentation. Le choix du type d'accès est fonction du client utilisé et du système d'exploitation :
- Format compressé (CHM)
- Seulement pour un client CS si le serveur de documentation est installé sur une machine Windows.
- Format éclaté (HTML)
- Pour un client CS si le serveur de documentation est installé sur une machine Windows.
- Pour un client CS si le serveur de documentation est installé sur une machine Unix.
- Obligatoire pour un client web quel que soit la machine (Windows ou Unix).
Pour configurer le composant Serveur de documentation, renseignez le paramètre obligatoire :
- Racine d'accès à la documentation : chemin pour atteindre la documentation via le client C/S SAFE X3 (dans le cas d'un chemin UNC, vous devez partager manuellement le répertoire d'accès à la documentation sur le serveur).
- Format d'utilisation des postes clients : spécifie au client SAFE X3 qu'il doit se configurer pour utiliser l'aide au format compressé (CHM) ou au format éclatée(HTML).
Si vous choisissez de publier votre documentation via un serveur Apache installé sur la même machine que le serveur de documentation, vous pouvez renseigner le paramètre Chemin d'installation Apache. Lorsque ce paramètre est renseigné, la console ajoute un alias (/AdxDoc_[NomComposantDoc]) dans le httpd.conf du serveur Apache.
Si le composant Serveur de documentation se trouve sur un serveur Unix, vous devrez redémarrer le serveur Apache manuellement pour prendre en compte ce nouvel alias.
Pour que le client C/S SAFE X3, accède à la documentation via le serveur Apache du serveur de documentation, la valeur du paramètre Racine d'accès à la documentation devra être : http://[NomMachine]:[PortHTTP]/AdxDoc_[NomComposantDoc]
Une fois le ou les paramètres renseignés, cliquez sur le bouton Configurer.
Il est possible de vérifier l'accès à la documentation : cliquez sur les boutons Test doc. Client ou Test doc. Web.
Si l'application est destinée à être utilisée via le Web, le format de la documentation doit être 'éclaté'. Pour changer ce format, cliquez sur le bouton "Decompresser (HTML)". Après l'éclatement de la documentation, la valeur du paramètre Documentation éclatée passe à Oui.
La documentation installée sur un serveur Unix est toujours livrée au format éclatée. Il n'est pas utile de faire un Eclate/Compresse.
Rappel important : pas d'espace dans le chemin d'installation du serveur de documentation.
Format de la documentation
Format de la documentation
Si l'application est destinée à être utilisée via le Web, le format de la documentation doit être 'éclaté'. Pour changer ce format, cliquez sur le bouton Décompresser (HTML). Après l'éclatement de la documentation, la valeur du paramètre Documentation éclatée passe à Oui.
Cette opération permet d'extraire toute la documentation en format HTML à partir du fichier CHM. Une fois le paramètre Documentation éclaté passé à Oui, et donc les fichier HTML produits, il n'est plus possible de revenir à l'état de documentation non éclaté.
Il est possible de décompresser la documentation à n'importe quel moment avec le bouton Décompresser (HTML), cette opération va toutefois écraser les fichiers html déjà présents si la documentation à déjà été décompressée.
Il est également possible de "compresser" la documentation pour créer un fichier CHM à partir des fichiers html présents. Cette opération écrase le fichier CHM original et le remplace donc avec le nouveau fichier CHM produit à partir des fichiers html présent. Il n'est pas possible de compresser une documentation non éclatée. Pour compresser une documentation, cliquez sur le bouton Compresser (CHM). Pour que la génération de CHM prenne en compte de nouveaux fichiers html de documentation, ces derniers doivent être indexés dans la documentation actuelle. En effet, le générateur CHM fonctionne en mode "spider" et découvre les nouvelles documentations en "suivant" les liens html de la documentation courant. Le plus simple est d'ajouter des liens dans le document html de l'index géneral.
Note : Ces opérations peuvent durer un long moment si la documentation est installée en plusieurs langues. En effet, la compression ou l'éclatement de la documentation est appliquée à toutes les langues installées pour la documentation.
Publication
Publication de la solution
Pour publier la solution dans le serveur de documentation, cliquez sur le bouton Serveurs de Documentations puis sur le bouton Publications.
Cliquez sur le bouton Ajouter de la barre d'outils et sélectionnez la solution à publier dans la liste des solutions administrées par la console.
A l'issue de la publication, la documentation est automatiquement disponible dans le menu aide du client SAFE X3.
Mise à jour
Pour mettre à jour le serveur de documentation, suivez ces étapes :
- Installez la mise à jour (reportez-vous aux procédures d'installation pour plus d'informations) afin de remplacer votre version par la nouvelle.
- Sélectionnez le serveur de documentation à configurer dans le tiroir Serveurs de Documentations.
- Pour Windows, éclater le CHM si nécessaire en cliquant sur le bouton Décompresser (HTML).
- Appuyez sur le bouton Configurer pour mettre à jour la configuration du composant et des publications existantes.
Note : Lors de la configuration, toutes les solutions publiées devraient être accessible pour la mise à jour des informations de documentations. Si des solutions ne sont pas accessibles ou verrouillées, des warnings seront émis lors de la configuration du composant Serveur de documentation.
Déconfiguration
Pour déconfigurer le composant Serveur de documentation, suivez ces étapes :
- Dépubliez toutes les solutions publiées sur le Serveur de Documentation dans l'écran Publication.
- Cliquez sur le bouton Déconfigurer dans l'écran de configuration du composant Serveur de documentation, le composant passe de l'état En fonctionnement à l'état Non configuré.
- Désinstallez votre composant sur le serveur hôte.