Génération de log à destination de l'équipe de support
Utilisez cette fonction pour créer un fichier de trace correspondant à un incident créé par le service support, ou déclaré au support.
Vous pouvez utiliser cette fonction pour créer un fichier de trace directement, ou en utilisant une tâche batch (ALOGSUP) démarrée depuis un événement de workflow.
Prérequis
Reportez-vous à la documentation de Mise en oeuvre
Gestion de l'écran
Onglet Écran de saisie
Utilisez cet écran pour définir les détails du fichier trace demandé.
Numéro incident (champ INCIDENT) |
Utilisez ce champ pour définir le numéro d'incident (fourni par le service support), pour lequel vous demandez la liste des traces. Ce champ est obligatoire. |
Adresse e-mail (champ MAILSAGE) |
Utilisez ce champ pour renseigner l'adresse e-mail du demandeur. |
Tâche batch
Cette fonction peut être lancée en batch, mais il n'existe pas de tâche standard dédiée à son lancement.
Informations de la trace
Le fichier de trace est un fichier au format XML (Extensible Markup Language).
Le fichier XML contient une balise <LOGFILE VERSION="n">. Les détails de la trace sont indiqués dans des balises groupées individuelles à l'intérieur de la balise <LOGFILE VERSION="n">. Ces balises individuelles sont les suivantes :
- <INFOS>. Le contenu de cette balise fournit des informations générales, telles que la date à laquelle la trace a été générée.
- <CLIENT>. Le contenu de cette balise fournit des informations concernant le client (si la trace a été générée depuis le client-serveur).
- <CONF_FILE NAME="FOLDERS.xml">. Le contenu de cette balise résume la configuration des dossiers dans le fichier FOLDERS.xml.
- <CONF_FILE NAME="solution.xml">. Le contenu de cette balise résume la configuration de la solution dans le fichier solution.xml.
- <DATABASE>. Le contenu de cette balise fournit les caractéristiques de la base de données courante.
- <WEBSERVERCONF>. Le contenu de cette balise fournit des informations sur les serveurs web accessibles depuis la solution.
- <EDTSERVERCONF>. Le contenu de cette balise fournit des informations sur les serveurs d'impression accessibles depuis la solution.
- <FOLDER CODE="FOLDER">. Cette balise est incluse pour chaque dossier. Le contenu de cette balise décrit les caractéristiques du dossier 'FOLDER' (FOLDER = nom du dossier). Tous les dossiers présents sont listés, mais les caractéristiques sont uniquement fournies pour : le dossier de lancement (toutes informations), le dossier parent du dossier courant si différent (informations sélectionnées), et le dossier racine ('X3') de la solution (informations sélectionnées uniquement).
Les sous-sections suivantes décrivent le contenu de chaque balise.
Contenu de la section INFOS
Le contenu entre les balises <INFOS> et </INFOS> est le suivant :
- <DATE>. Date et heure de départ de la fonction.
- <FOLD>. Dossier depuis lequel la fonction est lancée.
- <USER>. Code de l'utilisateur ayant lancé la fonction.
- <RUNTIME>. Version du client et numéro de licence, défini par ver$(0).
- <SOFTWARE_VERSION>. Le numéro de version de l'application (par exemple, 11.0.12).
- <PATCHLIST>. Le dernier patch réalisé.
- <PATCHDATE>. La date du dernier patch réalisé.
- <INCIDENT_ID>. Le numéro d'incident saisi au lancement de la fonction. En principe, le numéro d'incident est fourni par le service support.
Contenu de la section CLIENT
Le contenu entre les balises <CLIENT> et </CLIENT> est le suivant :
- <X3VERSION>. Numéro de version de l'application correspondant au client (par exemple, 001.12.2019).
- <X3FILEVERSION>. Numéro de version technique (par exemple, 15c.06).
- <X3CLTVERSION>. Numéro de version complémentaire (uniquement utilisé pour le client 107).
Contenu de la section FOLDERS.xml
Le contenu entre les balises <CONF_FILE NAME="FOLDERS.xml"> et </CONF_FILE> correspond au contenu du fichier FOLDERS.xml :
- Balise <INFOFOLDERS versolsup="version">.
Le contenu de cette balise fournit des informations sur la solution : - <ACTUAL>. Liste des dossier (une section <FOLDER> par dossier).
- <DEFLIC>. Définition de la licence (numéro, date d'expiration, textes partenaire/client, nombre de sessions, options).
Contenu de la section solution.xml
Le contenu entre les balises <CONF_FILE NAME="solution.xml"> et </CONF_FILE> correspond au contenu du fichier solution.xml :
- Une balise <solution name="name" mainport="port_number"> fournit des informations sur les composants techniques de la solution ("name") définie sur le port IP ("port_number") :
- <module name="name" family="APPLICATION" type="X3">. Informations sur le serveur d'application.
- <module name="name" family="RUNTIME" type="MAIN">. Informations sur le runtime.
- <module name="name" family="DOC" type="X3">. Informations sur le serveur de documentation.
- <module name="name" family="WEB" type="">. Informations sur le serveur web.
- <module name="BOXIRn" family="BUSOBJ" type="">. Informations sur le serveur Business Objects, où 'n' est le numéro de version de Business Objects (par exemple, 'BOXIR3').
- <module name="name" family="REPORT" type="">. Informations sur le serveur d'impression.
- <module name="name" family="DATABASE" type="database">. Informations sur le serveur de base de données, où le 'type' est la base de données (par exemple, 'ORACLE)'.
- <module name="SAGE_SEARCH" family="EXALEAD" type="MASTER">. Informations sur le serveur de recherche.
- <module name="name" family="SERVERJAVA" type="">. Informations sur le serveur Java.
Contenu de la balise DATABASE
Le contenu entre les balises <DATABASE TYPE="database_type"> et </DATABASE> est le suivant :
- <NAME>. Nom de la base de données.
- <VERSION>. Numéro de version.
- <VERSION_DESC>. Description détaillée de la base de données et du numéro de version.
Contenu de la section WEBSERVERCONF
Le balises <WEBSERVERCONF> et </WEBSERVERCONF>contiennent une balise <WEBSERVER_ID name="name"> par serveur web accessible. Les balises qui décrivent chaque serveur web proviennent du fichier config.ini. Les informations sont indiquées de la façon suivante :
- Les balises <SERVER_NAME> et <SERVER_PATH> indiquent l'emplacement des fichiers de configuration.
- La hiérarchie du fichier config.ini décrit la configuration web en détails :
<ALL>
<APACHE>
<APACHEDOCS/>
<APACHEPORT/>
...
</APACHE>
<CONTROL>
<DOCONFIG/>
<EMBEDEDSOFTS/>
...
</CONTROL>
<CONTROL>
...
Le nombre de sections et de sous-sections est important. Ces détails ne sont pas fournis ici. L'interprétation des valeurs est la responsabilité de l'équipe de développement.
Si, pour quelque raison que ce soit, le fichier de configuration web est introuvable, une section <STATUS> peut s'afficher à la place des détails du fichier de configuration. Si la valeur de cette balise n'est pas accessible, cela signifie que le fichier de configuration est introuvable.
Contenu de la section EDTSERVERCONF
Les balises <EDTSERVERCONF> et </EDTSERVERCONF> contiennent une balise <EDTSERVER_ID name="name"> par serveur d'impression publié disponible. Les balises qui décrivent chaque serveur d'impression proviennent du fichier adxeditionserverconfig.ini, qui se situe dans les répertoires du serveur d'impression. Les informations sont indiquées de la façon suivante :
<AdxSrvImp>
<cap config="" id="">
<general adxsolprf="" lang="" log="" port="" restartrpts="" />
<log number="" size="" />
<jobs max="" purgetime="" vpalloc="" />
<processes killtime="" max="" min="" />
</config>
</AdxSrvImp>
L'interprétation des valeurs est la responsabilité de l'équipe de développement.
Si, pour quelque raison que ce soit, le fichier de configuration du serveur d'impression est introuvable, une section <STATUS> peut s'afficher à la place des détails du fichier de configuration.
- Si la valeur de cette balise n'est pas accessible, cela signifie que le fichier de configuration est introuvable.
- Si la valeur de cette balise n'est pas accessible, cela signifie que le serveur d'impression est introuvable (pas de réponse à la demande de connexion).
Cette erreur peut se produire si le traitement de balayage se connecte au port d'administration 1818. Il s'agit du port utilisé par défaut pour les installations du logiciel. Si ce port n'est pas utilisé, vous devez le redéfinir en créant une variable globale nommée GADMINPORT de type 'Integer'. Cela vous permettra d'obtenir la valeur adéquate.
Contenu de la section FOLDER
Le contenu des balises <FOLDER CODE="folder_code"> et </FOLDER> est le suivant :
Une section différente par dossier.
- <HEADER>. Informations liées aux caractéristiques générales du dossier "folder_code". L'en-tête inclut les balises suivantes :
- <NAME>. Nom du dossier.
- <REFFOLDER>. Nom du dossier de référence.
- <TESFOLDER>. Indicateur pour les dossiers 'test'.
- <SPEFOLDER>. Indicateur pour les dossiers 'spécifiques'.
- <DATABASE>. Nom de la base de données.
- <LANGUAGE>. Liste des langues définies sur le dossier.
- <DEFLANGUAGE>. Langue par défaut.
- <MODULES>. Liste des modules actifs.
- <STARTDATE>. Date de début.
- <RPTCURRENCY>. Devise de reporting.
- <DEFCOUNTRY>. Code pays par défaut.
- Informations du fichier APL.ini. Ces informations sont définies dans une balise <APL_INI>, où chaque variable possède sa propre balise dont le nom est le nom de la variable en majuscules. Lors du dimensionnement de la variable, les parenthèses sont remplacées par un tiret bas ('_'). Par exemple, elle peut inclure les balises suivantes : <ADXMOTHER_0_0>, <ADXMOTHER_1_0>, <ADXMSO>, <ADXMTO>, <ADXMPR>, <ADXMUA>, <MAXMEM>, <SADMEM>, <ADXTCT>, <ADXTLK>, <ADXTMS>, <MAXHEAP>.
- <ACTIVITY_CODES>. Les valeurs des codes d'activité. Cette section comprend trois sous-sections : <FUNCTIONAL>; <SIZING>; <LOCALIZATION>.
Dans chaque sous-section, il existe une sous-section supplémentaire par module nommée <MODULE NAME="module_name"> contenant les informations suivantes : - Une section <ACTIVITY_CODE CODE="activity_code"> avec les sous-sections <ACTIVE> définies sur 'Oui' ou 'Non' ; <DIMENSION>; <DIM_MIN>; <DIM_MAX> pour les codes de type <SIZING> (dimensionnement).
- <ENTRY_POINTS>. Les points d'entrée et, pour chaque point d'entrée, une sous-balise <STD_TRT NAME="standard_entry point_name"> contenant les sections <SPE_TRT> et <ACV_CODE>.
- <CPYLIST>. Liste des sociétés et, pour chaque société, une sou-balise <COMPANY CODE="company code">, qui contient les informations suivantes :
- <NAME>.
- <LEGISLATION>.
- <SITLIST>. Une liste des sites associés et, pour chaque site, une sous-balise <SITE NAME="code">, qui contient le code du site financier associé dans une section <FINANCIAL>.
- <PARAMVALUES>. Les valeurs des paramètres. Les groupes de paramètres sont délimités par une balise <PARAMGRP NAME="group_code"> avec une sous-section <PARAM NAME="parameter_code"> par paramètre. Chaque sous-section contient une balise <VALUES>, qui contient les informations suivantes :
- <FOLDERVALUE>. La valeur du dossier. Si aucune valeur n'est indiquée, la balise contient <LEG NAME="legislation_code">, qui contient :
- <LEGVALUE>. La valeur indiquée au niveau de la législation, si applicable (optionnel). Cela inclut les valeurs paramètres définies par exception sur les niveaux inférieurs (sociétés liées à la législation, sites qui dépendent de ces sociétés).
- <CPY name="company_code">. Défini s'il existe une valeur paramètre de niveau société, ou au moins un des sites associés à la société. Cette balise contient alors les sous-sections suivantes :
- <CPYVALUE>. Valeur liée à la société, si applicable.
- <FCY NAME="site_code"> qui contient une balise <FCYVALUE>, si le paramètre est défini au niveau du site.
- <USER_VALUES>. Valeurs paramètres associées aux utilisateurs, si applicable. Les valeurs sont contenus dans une sous-balise <USER CODE="user_code"> qui contient les valeurs suivantes :
- <LOCALPRG>. Liste des traitements qui ne correspondent à aucun type spécifique, dont le fichier exécutable est situé sur le dossier de référence (et non sur le dossier test ou de développement).
- <SPEPRG>. Liste des scripts qui correspondent à un type spécifique de script.
- <PATCHES>. Liste des patchs installés sur le dossier, par type. Chaque type constitue un groupe <TYPE CODE="code_type">, qui contient une sous-balise <CURRENT_STATUS> qui contient un groupe par version. Chaque groupe contient les informations suivantes :
- <VERSION ID="version_number">. Numéro de version. Cette section contient les informations suivantes :
- <FIRST NUM="number">. Premier numéro de patch réalisé (contenant les informations <COMMENT>, <FILE>, <PATCHNUM>).
- <LAST NUM="number">. Dernier numéro de patch réalisé (contenant les informations <COMMENT>, <FILE>, <PATCHNUM>).
- <MISSING NUM="number">. Nombre de patchs manquants, ou integer au format form first_number - last_number. Cette balise est uniquement présente si des éléments manquent dans la numérotation.
- <INSTALL_HISTORY>. Pour chaque type de patch (balise <TYPE CODE="code">), et pour chaque version majeure (balise <VERSION ID="xxx">), une liste de balises <PATCHLIST num="number" date="date of installation"> est fournie, qui contient les balises :
- <USER>. Code de l'utilisateur qui a installé la liste.
- <COMMENT>. Commentaire associé au premier patch dans la liste.
- <FILE>. Nom de fichier correspondant.
- <MAINTENANCE>. Numéro de maintenance.
Remarque : La même liste de patchs est répétée plusieurs fois dans l'historique si elle a été effectuée plusieurs fois (vous pouvez distinguer les listes en regardant le premier numéro d'un patch). - <DATABASE TYPE="database_type">. Type de base de données. Cette balise contient plusieurs sections :
- <STATS>. Il s'agit de la première section. Pour chaque table, elle contient la sous-section <TABLE NAME="table_name">, qui contient :
- <LAST_ANALYSIS>. Date du dernier balayage des index effectué.
- <NB_ROWS>. Nombre de lignes dans la table.
- <INDEXES_VERIFICATION>. Il s'agit de la seconde section. Elle constitue une fonction distincte. Ainsi, les résultats de l'analyse des index sont présentés sur des sous-sections individuelles :
- <INDEXES_MISSING>. Les index manquants (avec, pour chaque index manquant, une section <INDEX TABLE="table"> qui contient les champs <NAME> et <INDEX>).
- <INDEXES_MISSING_ON_INACTIVE_TABLES>. Contient les index manquants sur des tables inactives (avec les mêmes informations).
- <OPTIMIZATION_INDEX_MISSING>. Contient les index d'optimisation actifs, mais manquants sur les tables (avec les mêmes informations).
- <OPTIMIZATION_INDEX_INACTIVE_ON_TABLES>. Contient les index d'optimisation sur des tables inactives (avec les mêmes informations).
- <INTERNAL_INDEXES>. Liste les indexes internes trouvés.
- <INDEXES_NOT_DESCRIBED_IN_DICTIONARY>. Fournit la liste des index qui existent dans la base, mais non décrits dans le dictionnaire.
- <INDEX_NOT_CONFORMANT>. Liste les index non conformes.
Commentaires
Les informations contenues dans les sections délimitées par la balise <FOLDER CODE="folder_code"> n'existent pas dans tous les dossiers :
- La section <HEADER> est toujours présente.
- La section <ACTIVITY_CODES> est toujours présente.
- La section <ENTRY_POINTS> est toujours présente.
- La section <CPYLIST> est toujours présente.
- La section <PARAMVALUES> est uniquement présente pour les dossiers du dossier Superviseur ('X3' pour l'application).
- La section <LOCALPRG> est uniquement présente pour les dossiers du dossier Superviseur ('X3' pour l'application).
- La section <DATABASE> est uniquement présent pour le dossier depuis lequel l'utilitaire a été lancé. Il est donc important de bien choisir le dossier sur lequel vous souhaitez lancer l'utilitaire.