Cette fonction permet d'extraire l'ensemble des paragraphes d'une documentation sous la forme d'un fichier XML.

Trois choix d'extraction sont possibles :

  • Extraction pour (re)traduction : ce choix permet d’extraire une documentation déjà traduite, c'est-à-dire qui n’apparaît pas dans le plan de travail, mais qui nécessite une (re)traduction car des modifications de contenus ont été faite sans modifier la date de validation. Les en-têtes sont dans la langue cible d’extraction et le contenu des documentations est dans la langue de référence. Les contrôles de cohérence entre Langue Cible/Référence sont faits mais pas les contrôles de validation. Cette option permet ainsi de retraduire des documentations via le logiciel de traduction ;
  • Extraction pour traduction : ce choix se substitue complètement au plan de travail. Il permet de générer des documentations pour traduction via n'importe quel logiciel de traduction. Les en-têtes sont dans la langue cible d’extraction et le contenu des documentations est dans la langue de référence. Les contrôles de cohérence entre Langue Cible-Référence sont faits ainsi que les contrôles de validité. Cette option permet d’extraire par exemple l’ensemble des documentations validées à traduire d’une langue donnée ;
  • Extraction par langue : ce choix permet d’extraire l’ensemble d’une ou de plusieurs langues. Les en-têtes et le contenu des documentations sont dans la langue cible d’extraction. Une option pour ce choix permet la sélection des documentations "Validées", "Non validées", "Toutes". Ce choix permet d’extraire toute une langue pour comptage de mots par exemple.

Pour extraire, afin d'effectuer la traduction avec des progiciels à même de traduire des fichiers XML, il faut utiliser la fonction plan de travail documentation.

L'extraction se fait par défaut dans un répertoire xml créé, et s'il n'existe pas, dans le répertoire de documentation défini par le paramètre DIRDOC.

Une fonction d'intégration de documentation permet de réaliser l'opération inverse.

Pré-requis

See also Reportez-vous à la documentation de Mise en oeuvre

Gestion de l'écran

Ecran de saisie

Les critères de sélection sont saisis dans l'écran afin de définir ce qui doit être extrait, en sachant que peut être extraite :

  • la documentation sur fonction ou objet fonctionnel ou sur objet (définie par son type),
  • la documentation sur champ (qui peut être extraite séparément, ou de façon liée à la documentation fonctionnelle ; les aides sur champ incluses dans l'aide fonctionnelle étant alors extraites sous forme de fichiers séparés),
  • tout fichier lié qui est alors extrait tel quel.

Extraction

Pour (re)traduction (champ EXTRETRA)

Extraction pour (re)traduction : extraction à des fins de (re)traduction d'une documentation dans une langue cible et selon une langue de référence. Dans ce cas, la date de validité n'est pas testée.
Pour traduction (champ EXTTRA)

Extraction pour traduction : extraction à des fins de traduction d'une documentation dans une langue cible et selon une langue de référence.
Langue de traduction (champ LANTRA)

Définit la langue de traduction
Langue de référence (champ LANREFTRA)

Définit le code de la langue à partir de laquelle la traduction va se faire.

Extraction

Par langue (champ EXTLAN)

Extraction par langue : extraction simple selon une ou plusieurs langues d'extraction.
Toutes langues (champ ALLLAN)

Si cette case est cochée, toutes les langues sont prises en compte pour l'opération.
Langue d'extraction (champ LANEXT)

Définit le code langue à traiter lorsqu'il est unique.
Extraire aussi en langue de référence (champ ENLANREF)
Langue de référence (champ LANREFEXT)
Documentations prise en compte (champ VALDOC)

Extraction XML

Répertoire (champ REPERT)

Indique le répertoire à partir duquel sera fait l'export de documentations, en sachant que les aides sur champs seront extraites dans le sous-répertoire FLD, et les fichiers liés dans le sous-répertoire FILE.

Par défaut, le paramètre utilisateur DIRDOC est utilisé afin d'initialiser ce répertoire.

Le format de saisie du répertoire d'extraction se fait sous ces 4 formes :

  • En local sur un poste client. ex : #@C:\TEMP
  • Sur le serveur d'application. ex : /app/produits/solution/DOSSIER/tmp
  • Sur un serveur distant. ex : aydaix05:2050@/app/produits/solution/DOSSIER/tmp
  • Sur un volume du serveur d'application. ex : [TMP]/repertoire_personalise

ATTENTION : l’utilisation des volumes n’est possible que si l’arborescence du volume fait bien partie de l’arborescence définie dans la SANDBOX pour que le Runtime autorise la Lecture/Ecriture dans ce répertoire.
Sous-répertoire par type (champ REPERTTYP)

Indique si le sous-répertoire par type de documentation sera utilisé pour être concaténé avec le répertoire principal à partir duquel sera fait l'export de documentations.

Les aides sur champs liées sont extraites dans le sous répertoire par type puis FLD.
Les fichiers liés sont extraits dans le sous répertoire par type puis FILE.
Pour tous les groupes (champ ALLCREGRP)

Ce champs permet de choisir entre :

  • Traiter toutes les documentations ou aides sur champ indifférement du groupe d'appartenance de l'utilisateur.
  • Traiter uniquement les documentations ou aides sur champs dont le groupe de l'utilisateur est équivalent au groupe créateur de la documentation trouvé dans la table AOBJGRPDEV

Sélections

Tous types (champ ALLTYP)

Sélectionnez cette case à cocher pour inclure tous les types. Laissez cette case désactivée pour exécuter ce traitement pour un seul type.
Type (champ TYP)

Définit le type de documentation à traiter (lorsqu'il est unique).

Exclusion APM, AT*, AML (champ EXCTYP)
Tous codes (champ ALLCOD)

Si cette case est cochée, tous les codes sont pris en compte pour l'opération, sinon, seuls les codes correspondant aux bornes saisies sont pris en compte.
Code de (champ CODDEB)

Permet de donner une borne de début sur le critère pour déterminer les données prises en compte par l'opération.
à (champ CODFIN)

Permet de donner une borne de fin sur le critère pour déterminer les données prises en compte par l'opération.
Tous codes activités (champ ALLACV)
Code activité (champ ACV)
Tous modules (champ ALLMOD)
Module (champ MODULE)
Exclure un module (champ EXCMOD)
Module (champ MODTOEXC)

Options

Fichiers liés (champ HLPFIL)

Si cette case est cochée, on traite également les fichiers liés aux documentations. Ces fichiers sont en général des images.
Aides sur champs liés (champ HLPLNKFLD)

Si cette case est cochée, sont traitées spécifiquement les aides sur champs relatives aux documentations sur fonction ou objet traitées par ailleurs. Pour savoir quelles sont les aides sur champ à traiter, explorez les écrans associés aux paragraphes de documentation correspondants.
Aides sur champs (champ HLPFLD)

Si cette case est cochée, la documentation sur champs est également traitée.

Cas particulier de l'option 'Extraction pour retraduction'

Pour extraire une ou plusieurs documentation(s) sur champs isolée(s), c'est -à-dire indépendante(s) d'une documentation sur fonction, décochez Tous types, tabulez, puis insérez un espace dans le type.
De (champ FLDDEB)

Permet de borner le traitement de l'aide sur champ entre deux mots-clés.
champ FILLER6
A (champ FLDFIN)

Messages d'erreur

Il n'y a pas de message d'erreur autre que les messages d'erreur génériques.

Tables mises en oeuvre

See also Reportez-vous à la documentation de Mise en oeuvre

Annexe : format des fichiers créés

Le format du fichier XML de documentation sur fonction ou objet, tel qu'on le retrouve dans le répertoire xml, est le suivant :

  • un en-tête normalisé xml,
  • une balise DOC avec les attributs TYPE, NAME (définissant le type et le code de la documentation),
  • à l'intérieur de la balise DOC, pour chaque paragraphe, une balise PAR avec les attributs LAN, LEV, SUBLEV, PAR, MSK, STY, VLDDAT, VLDFLG, ACT, et MOD (définissant dans l'ordre la langue, le niveau, le sous-niveau, le code du paragraphe, l'écran, le style, la date de validité, l'indicateur de validité, le code activité et le module),
  • à l'intérieur de la balise PAR, une balise TIT pour donner le titre du paragraphe (s'il y en a un),
  • à l'intérieur de la balise PAR, une balise HTML contenant le texte du paragraphe en XHTML.

Les fichiers de documentation sur champ sont situés dans le sous-répertoire FLD du répertoire xml d'extraction. Le format est le suivant :

  • un en-tête normalisé xml,
  • une balise FLD avec les attributs NAME, LAN, MOD, GEN, LNKHLP, LNKORD, CREDAT, UPDDAT (définissant le nom, la langue, le module, l'attribut générique de la documentation, l'aide liée, le lien, la date de création et la date de modification),
  • à l'intérieur de la balise FLD, une balise HTML contenant le texte du paragraphe en XHTML.

Les fichiers liés à une documentation sont situés dans le sous-répertoire FILE du répertoire xml d'extraction. Le nom du fichier est constitué de la façon suivante :

COD_LAN_TYP_LEV_SUBLEV_LIG_NOMFICHIER_LGCLE.EXT, où :

  • COD_LAN_TYP_LEV_SUBLEV_LIG est constitué à partir de la clé du fichier lié dans la table ADOCBLB (ceci pour garantir l'unicité du nom,
  • LGCLE contient la longueur de la clé précédente afin de pouvoir extraire correctement le code de la documentation,
  • NOMFICHIER et EXT correspondent au nom du fichier (nom et extension) s'il est indiqué dans ADOCBLB ou à un nom composé avec les caractères IMG, suivis du numéro de ligne sur 3 caractères (préfixé par des zéros si nécessaires), et suivi de l'extension .jpg.