Assistant z/OS — Édition Entreprise
Retour aux manuels
Guide Administration

Administrer Assistant z/OS

Guide d’exploitation pour la configuration, la maintenance, la sécurité, les mises à jour documentaires, les traitements d’extraction et de traduction, ainsi que la supervision générale de la plateforme.

Administration Documentation & traitements Version 1.0

1. Présentation

L’administration d’Assistant z/OS consiste à maintenir séparément l’application PHP, les documents IBM sources, les données structurées, les traductions et les analyses IA.

ApplicationPortail, guides, modules, includes, assets et composants communs.
DonnéesRéférences extraites et traductions enregistrées dans la base documentaire.
DocumentsPDF IBM conservés comme sources de référence et de traçabilité.

2. Architecture de l’installation

Une installation complète comprend notamment les répertoires suivants :

admin/    assets/    cache/    core/    database/    docs IBM/    includes/    modules/
Important : une sauvegarde fiable doit contenir l’ensemble de ces éléments. Sauvegarder uniquement les fichiers PHP de la racine ne garantit pas la restitution du rendu ou du fonctionnement de l’application.

3. Configuration

La configuration centrale est chargée au démarrage de l’application. Elle contient notamment les paramètres de connexion à la base et, lorsque ces fonctions sont utilisées, les paramètres nécessaires aux traitements IA.

1
Vérifier la base

Contrôler l’hôte, le port, la base, l’utilisateur et l’encodage.

2
Vérifier les chemins

Les modules et documents doivent rester accessibles depuis leur emplacement attendu.

3
Limiter les modifications

Ne modifier qu’un composant à la fois et conserver une sauvegarde avant intervention.

4. Documents IBM

Les PDF IBM constituent les sources documentaires utilisées par les extracteurs. Ils sont conservés dans docs IBM afin de maintenir une séparation nette entre les sources, le code applicatif et les données extraites.

Traçabilité : conserver le nom du document, la version du produit et, lorsque disponible, la date de publication avec les données extraites.

5. Extraction documentaire

Les extracteurs transforment les documents IBM en données structurées utilisables par les modules de recherche et les fiches techniques.

1
Source

Lire le PDF IBM correspondant à la version documentaire retenue.

2
Extraction

Identifier les messages, codes et différentes sections documentaires.

3
Contrôle

Vérifier un échantillon de références avant de considérer le corpus comme exploitable.

4
Chargement

Importer les données structurées dans les tables documentaires.

Certains extracteurs utilisent un fichier d’état dans cache/ pour permettre la reprise d’un traitement interrompu. Ce fichier de reprise ne remplace pas une sauvegarde.

6. Traduction française

La couche française est distincte du texte IBM Original. Une traduction déjà enregistrée peut être réutilisée afin d’éviter un nouveau traitement inutile.

Versions : lorsqu’un corpus français ne correspond pas exactement à la version anglaise de référence, afficher clairement la version de chaque source et ne pas présenter une traduction d’une version antérieure comme étant celle de la version courante.

7. Assistant IA et cache

L’analyse IA est déclenchée à la demande depuis une fiche technique. L’affichage d’une fiche IBM n’entraîne pas à lui seul la génération d’une analyse.

À la demandeL’appel IA intervient lorsque l’utilisateur ouvre ou demande l’analyse.
Cache IAUne analyse déjà enregistrée peut être réutilisée pour la même référence et la même source.
RégénérationUne demande explicite peut forcer une nouvelle analyse lorsqu’elle est proposée par l’interface.
L’analyse IA complète la documentation. Elle ne remplace pas la source IBM, ni les procédures d’exploitation ou de sécurité du site.

8. Sécurité et accès

Les fonctions d’administration et les traitements sensibles doivent rester protégés. Les secrets techniques ne doivent pas être intégrés dans les pages publiques, les guides ou les sauvegardes destinées à être diffusées.

  • protéger les interfaces d’administration et les traitements par authentification ou jeton ;
  • ne jamais afficher une clé API dans l’interface ;
  • limiter les droits d’écriture aux répertoires qui en ont réellement besoin ;
  • conserver les documents IBM et les exports de base hors exposition publique directe lorsque nécessaire.

9. Sauvegarde et restauration

Avant une modification importante, réaliser une copie complète et datée de l’installation.

1
Sauvegarder l’arborescence

Inclure PHP, assets, includes, modules, documents, cache utile et fichiers de configuration nécessaires.

2
Sauvegarder la base

Conserver un export cohérent avec la version de l’application sauvegardée.

3
Identifier la version

Utiliser un nom daté et, après validation, marquer la copie comme STABLE.

4
Tester la restauration

Une sauvegarde n’est réellement fiable que si ses éléments essentiels peuvent être restaurés.

10. Supervision

Après une extraction, une traduction ou une mise à jour applicative, contrôler au minimum :

  • l’ouverture du portail et des modules disponibles ;
  • la recherche d’une référence connue dans chaque produit concerné ;
  • l’affichage d’une fiche IBM Original ;
  • la disponibilité de la vue française lorsqu’elle existe ;
  • le déclenchement de l’Analyse IA uniquement à la demande ;
  • les journaux PHP et les éventuelles erreurs applicatives.

11. Maintenance

Les fichiers .old, .bak et autres copies intermédiaires sont utiles pendant une phase de modification. Ils peuvent être supprimés après validation, à condition qu’une sauvegarde complète et stable existe déjà.

Effectuer le ménage après validation fonctionnelle, jamais pendant une extraction ou immédiatement avant une opération de restauration.

12. Bonnes pratiques

  • modifier un seul ensemble fonctionnel à la fois ;
  • faire une sauvegarde complète avant une modification structurelle ;
  • conserver les sources IBM séparées des traductions et des analyses IA ;
  • tester une référence connue après chaque traitement documentaire ;
  • ne supprimer les anciennes versions qu’après validation de la nouvelle ;
  • documenter la date et le contenu des versions déclarées STABLE.
Assistant z/OS — Guide Administration — Version 1.0