Documentation IBM Offline

Un peu d’histoire

Dans un passé fort fort lointain, la documentation des matériels et logiciels IBM était disponible sur support papier.
De nombreux volumes, au format pas tout à fait A4, aux feuilles perforées pour des classeur au format US, remplissaient alors les armoires des bureaux techniques.
Bien sûr, pas de fonction de recherche, sinon la table des matières, et le classeur recherché n’était pas toujours rangé à l’endroit attendu, voire emprunté par un collègue.

Ensuite est arrivé en 1989 le format BookManager. Les brochures étaient livrées sous forme de fichiers au format propriétaire, lisibles via un programme de lecture, BookManager. BookManager était disponible sur les postes de travail (Windows 3.1, OS/2), sur les grands systèmes (z/OS), et sur iSeries (InfoSeeker).

A partir de 2009, la documentation a été proposée sous forme d’Infocenter.
La version en ligne était accessible sous forme de pages web, avec quelques soucis sur la recherche.
La version offline permettait de télécharger des fichiers zip, utilisables via un outil basé sur Eclipse.
L’installation n’était pas très conviviale, et aucune fonction de mise à jour n’était proposée.
Les pdf disponibles étaient presque plus pratiques pour une utilisation offline

Les temps modernes

A partir de 2018, les Infocenters ont été progressivement remplacés par les Knowledge Center, qui en mode online apportaient permettaient d’un clic de changer de version :

Les fichiers PDF étaient toujours disponibles, et une version locale de la documentation était proposée (MQ KC framework) disponible en version stand-alone ou à hébergée sous un WAS liberty. L’installation et la mise à jour étaient assez complexes, mais ensuite l’utilisation via un navigateur (http://localhost:9090/kc) était simple.

IBM Documentation Offline

IBM propose maintenant la possibilité d’avoir un « vrai » Knowledge Center en local, facile à installer et à mettre à jour. Cette solution se décompose en deux parties :

• Une application Windows, Linux, ou macOS à installer sur un poste de travail
• Une série de (gros) fichiers zip représentant la documentation complète d’une version de logiciel (appelés kits)

L’application est téléchargeable ici : https://www.ibm.com/docs/fr/offline
Il faut spécifier son IBMId pour avoir accès aux binaires.
Une fois téléchargée, on obtient un fichier du type ibm-docs-app-win32-1.0.6-20221128T112200.zip.
La décompression donne un répertoire ibm-documentation-app-win32-x64 (dans le cas de Windows), à recopier dans l’arborescence souhaitée.

Il suffit ensuite de lancer ibm-documentation-app.exe.

Au premier lancement, il n’y a aucun kit d’installé, l’application propose d’en ajouter. Il faut au préalable avoir téléchargé des kits depuis le site IBM. Le plus simple est d’utiliser le lien fourni en bas de la table des matières :

Ce lien télécharge directement le zip correspondant à la version du logiciel consulté. Pour IBM MQ, les fichiers sont nommés : SSFKSJ_<version>_<date>. Pour tWAS, on va avoir SSEQTP_<version>_<date>.

Note : il faut être connecté avec son IBMID pour voir le lien « Offine docs ».

Cela donne :

• SSFKSJ_9.3.0_20230128.zip : Documentation IBM MQ version 9.3
• SSFKSJ_9.2.0_20230128.zip : Documentation IBM MQ version 9.2
• SSFKSJ_9.1.0_20230128.zip : Documentation IBM MQ version 9.1
• SSFKSJ_9.0.0_20230128.zip : Documentation IBM MQ version 9.0
• SSFKSJ_8.0.0_20230127.zip : Documentation IBM MQ version 8.0
• SSEQTP_8.5.5_20220725.zip : Documentation WAS version 8.5.5
• SSEQTP_9.0.5_20230127.zip : Documentation WAS version 9.0.5

Chaque zip contient l’ensemble des langages disponibles pour la version.

En cliquant sur « Upload documentation » dans l’application, on peut sélectionner le kit à installer :

Choix du kit à installer (préalablement téléchargé en local) :

Il est ensuite possible de choisir les langues à installer :

puis « Upload products » :

Note : cette étape peut être assez longue, surtout sir le kit est volumineux.

Une fois la documentation MQ version 9.2 et version 9.3 installées, il est possible de passer de l’une à l’autre comme dans le KC en ligne :

Les KC offline sont disponibles également pour WebSphere Application Server :

A noter : Il n’est pas possible de choisir le chemin d’installation des kits. Ils seront installés dans :

C:\Users\<user>\Roaming\IBM Documentation Offline

Les kits pour les autres logiciels IBM sont disponibles en : https://www.ibm.com/docs/en/products