Serveur de documentation

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 boite de dialogue chargement d'un composant, cliquez ici ...

La Console fait l'acquisition des différents paramètres du composant Serveur de documentation.

Notez que la valeur du statut du composant Business Objects 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, renseigner 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, cliquer sur le bouton Configurer.

Il est possible de vérifier l'accès à la documentation, pour cela, cliquer 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, cliquer 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, cliquer 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 les étapes suivantes :

• Installer 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écessaires en cliquant sur le bouton "Décompresser (HTML)" 
• Appuyez sur le bouton "configurer" pour mettre à jour la configuration du composant et des publications existantes

nota : 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 emis lors de la configuration du composant Serveur de Documentation.

Déconfiguration

Pour déconfigurer le composant Serveur de Documentation, suivez les étapes suivantes :

• 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.