Description de la fonction :

Un webmaster administre un dossier produit dont le nom court est "monproduit" et il veut afficher les manuels utilisateurs correspondants à "monproduit", sans connaitre l'arborescence du site de documentation qui peut être très différente de celle de SOL.

Il a été décidé d'utiliser les noms courts des dossiers produits comme mots-clés pour être à même de réaliser cette passerelle.

Recherche du dossier de même nom sur SOLDOC
Récupération des documents

Mise en oeuvre de la passerelle d'affichage de la documentation entre SOL et SOLDOC :

Exemple : 
on est sur https://support.bull.com/ols/product/platforms/hpc/ns-bas3

le nom court est "ns-bas3". C'est ce dossier l'on doit trouver de manière unique sur SOLDOC.
 

SOL

L'utilisateur clique sur le menu "Manuels utilisateur" de ns-bas3

• affichage de la ZPT (page template) "soldoc_listDocument_view"
• celle-ci filtre le path courant avec le script python "soldoc_trimPath" pour éliminer les dossiers non significatifs comme 'doc' ou 'udocf'.
  (En effet, lorsqu'on est positionné sur ns-bas3 et qu'on demande les manuels utilisateur dans la documentation (avec la barre de service), on appelle en réalité l'URL suivante : ns-bas3/doc/udocf.)
• puis elle appelle la page template "soldoc_remoteList" sur SOLDOC avec le lien "https://support.bull.com/documentation/byproduct/soldoc_remoteList?k=path" via javascript qui lui-même ouvre une nouvelle fenêtre.
  

SOLDOC

La page template "soldoc_remoteList" déclenchée effectue les tâches suivantes :

• Recherche du dossier "ns-bas3" dans SOLDOC :
  le script python "soldoc_convertPath" (pour conversion de path) : celui-ci recherche, dans le site SOLDOC, le dossier fourni dans le paramètre k.
  D'où l'importance de l'unicité des noms courts !
  Le script retourne alors le path SOLDOC demandé.
  

  Exemple : 
  
  Sur SOL "https://support.bull.com/ols/product/platforms/hpc" 
  est converti sur SOLDOC en 
  "https://support.bull.com/documentation/byproduct/servers/ns/solutions/hpc/"
  

• Recherche des documents et classement :
  

  On étudie s'il s'agit d'un noeud terminal ou d'un noeud intermédiaire.
  Un script étudie le path fourni pour déterminer le mode de recherche des documentations (soldoc_selectSearchMode):
  

  • Si on se trouve dans une terminaison (un produit),
    on effectue une recherche par mots-clés qui nous renvoit les documents classés dans les 3 catégories documentaires habituelles (spécifique, associé et générique)
  • Si on se trouve sur un noeud intermédiaire de l'arborescence,
    
  • on effectue d'abord une recherche "arborescente" c'est à dire on recherche tous les documents situés à partir et en dessous de ce niveau, et on considère qu'il s'agit de la catégorie "spécifique".
  • on effectue ensuite une recherche par mots-clés en utilisant chacun des termes de l'arborescence.
    

    Exemple : 
    "servers/ns/solutions/hpc" donne la liste de mots-clés suivante (servers, ns, solutions, hpc).  
    
    Le dernier terme (ici "hpc") a le plus de poids :
    - Tous les documents dont la liste de mots-clés contient le dernier item de l'arborescence (exemple : hpc) 
      sont qualifiés de "documents associés".
    
    - Tous les autres sont qualifiés de "documents génériques"  car ils sont effectivement physiquement 
      situés au dessus dans la hiérarchie arborescente de SOLDOC.
    
    

• Affichage du résultat
  le script python"soldoc_htmlListDocuments" qui affiche le résultat.

Les contraintes sur la terminologie des noms courts

Ces passerelles ne sont possibles que si les 2 règles suivantes sont scrupuleusement suivies :

les noms courts des dossiers "Produits" (ns3025, redhat etc...) sont IDENTIQUES sur les 2 sites
les noms courts des dossiers produit sont UNIQUES sur SOLDOC.

Les noms courts devenant les éléments du thésaurus, il faudra veiller en permanence à ce que ces règles soient respectées sur les 2 sites.