09/14 Notions de base concernant l utilisation de la documentation-utilisateur dans les applications logicielles de HEAD acoustics Vous connaissez peut-être le problème : lors d une mesure que vous avez réalisée, vous avez donné un nom à vos enregistrements de manière intuitive tel que Moteur_ 2245_Transfo_3_Mod_1.hdf ou Carr 465_ Testmed_A1_Couv.hdf. Au moment de la mesure, vous saviez bien entendu que «Mod1» représentait la modification avec couvercle et «Couv», la modification sans couvercle. Ou est-ce que ça n était pas plutôt l inverse? Réaliser des enregistrements coûte du temps et de l argent. Et si au bout de quelques mois, plus personne n est capable de se souvenir du contenu de chaque fichier, ces enregistrements perdent rapidement toute leur valeur. Le fait d assurer une documentation correctement réalisée et de manière cohérente permet de préserver la valeur du travail effectué. Pouvoir créer une documentation-utilisateur dans le HEAD Recorder et dans ArtemiS SUITE vous aide à résoudre ce problème! Vous pouvez ainsi mettre de l ordre dans vos données et accéder aisément et simplement à vos enregistrements. Cette vous explique, après une courte introduction, comment créer et utiliser des modèles de documentation, comment documenter des fichiers dans la pratique et comment utiliser des listes de choix pour la documentation : Qu est-ce que la documentation-utilisateur? 1 Création d un modèle de documentation 3 Documentation de fichiers 6 Documentation dans le HEAD Recorder 6 Sauvegarde de la documentation-utilisateur 8 Utilisation de listes de choix 9 Qu est-ce que la documentation-utilisateur? La fonctionnalité de documentation proposée dans ArtemiS SUITE vous permet de sauvegarder des informations techniques relatives à vos mesures. La documentation se divise en documentation système, c est-à-dire des informations toujours disponibles, et la documentation-utilisateur dont la maintenance est assurée par l utilisateur (voir figure 1). La documentation-système avec des signaux temporels contient des informations qui sont automatiquement écrites dans le fichier pendant l enregistrement, par exemple, des informations concernant le nombre de voies, les unités, la date de l enregistrement et des informations concernant le frontal d acquisition. Avec les fichiers contenant des résultats d analyse, la documentation-système contient des informations concernant les paramètres d analyse, par exemple, le fenêtrage et la longueur de fenêtre. 09/14 1
Vous pouvez créer la documentation-utilisateur pendant l enregistrement avec le HEAD Recorder et aussi la modifier par la suite. C est vous qui déterminez ce qu elle doit contenir. Elle peut, par exemple, ne concerner que l état de fonctionnement, ou une description détaillée du montage de l essai. Figure 1 : et documentation-système d un fichier HDF Le visualiseur de documentation (engl. Documentation Viewer) permet d afficher la documentation du fichier sélectionné sous ArtemiS SUITE. De plus, la documentationutilisateur permet par ex. des recherches dans la base de données ou encore la description des diagrammes ou de vos rapports. Dans le cas idéal, il ne vous restera plus qu à échanger dans un rapport préconfiguré les fichiers HDF, et les informations utilisées sont alors automatiquement mises à jour dans la documentation. Vous gagnez donc du temps ainsi que du travail d écriture et de recherche. La documentation-utilisateur a été délibérément conçue pour être transparente et simple : il vous suffit de créer un modèle de documentation dans ArtemiS SUITE, c.-à-d. un petit formulaire que vous aurez configuré vous-même, de le remplir et de l affecter à un fichier. C est tout ce que vous avez à faire pour documenter vos données. Vous pouvez ensuite utiliser le modèle créé pour d autres mesures. L avantage d utiliser des modèles est qu ils permettent de standardiser la documentation, ce qui apporte de vastes possibilités d utilisation dans le domaine du 09/14 2
reporting et de la recherche dans des bases de données. Le fait de définir des champs obligatoires vous permet d imposer la saisie de certains champs importants. D un autre côté, les champs qui peuvent être remplis librement laissent suffisamment de liberté pour consigner des remarques individuelles concernant une mesure. Création d un modèle de documentation Pour créer un modèle de documentation, ouvrez dans ArtemiS SUITE un nouveau modèle (Fichier -> Nouveau -> Modèle de documentation, en anglais, File -> New -> Documentation Template). Vous pouvez bien entendu créer différents modèles que vous pourrez personnaliser pour différents types de mesures, par exemple, un modèle pour la mesure des bruits de moteur pour documenter les paramètres du moteur et un modèle pour la mesure des bruits de roulement avec des informations concernant le pneu. Pour pouvoir remplir le modèle rapidement et facilement lorsque vous réaliserez ensuite des mesures, nous vous recommandons de bien réfléchir au préalable à ce que vous voulez faire au moment de créer un modèle, car plus le modèle de documentation est adapté, plus l on pourra le remplir facilement par la suite. Et ce n est que si le modèle de documentation est conçu de manière à bien s adapter aux mesures et à pouvoir être rempli rapidement qu il sera effectivement utilisé dans la pratique. Un modèle de documentation est en fait un formulaire contenant plusieurs champs. Il peut être divisé en plusieurs sous-formulaires pour le rendre plus clair. Et cette division apporte également par la suite une plus grande clarté lorsqu il est ensuite utilisé dans ArtemiS SUITE. La figure 2 représente un exemple de modèle auquel on a ajouté une subdivision. 09/14 3
Figure 2 : Modèle de documentation avec subdivision supplémentaire A l ouverture d un nouveau modèle de documentation, un modèle standard avec 3 champs de texte est affiché. (voir figure 3). Figure 3 Modèle de documentation par défaut avec 3 champs de texte Vous n avez plus qu à adapter ce modèle standard à vos exigences et à vos applications. Cliquer sur le bouton vous permet d ajouter d autres champs de documentation à votre modèle. Outre les champs de texte (en anglais, Text Field), vous disposez également d autres types de champs de documentation : Formulaire de documentation (en anglais, Subform) : les sous-parties de formulaire vous aident à structurer votre modèle pour lui donner de la clarté. Champ de nombre (Entier) (en anglais, Number Field (Integer)) : ce champ de documentation vous permet de documenter des valeurs entières qui se prêtent 09/14 4
particulièrement bien à la recherche avec des opérateurs de comparaison dans une base de données (par exemple,, ). Champ de nombre (Réel) (en anglais, Number Field (Real)) : vous pouvez entrer dans ce champ de nombre des valeurs réelles pour la documentation. Champ de Date (en anglais, Date Field) : ce champ vous permet de saisir une date et une heure. Vous pouvez ensuite effectuer cette saisie dans la documentation, directement par l intermédiaire du clavier ou en la sélectionnant dans un calendrier. La saisie de la date par le clavier est ensuite standardisée afin que cette information soit uniformisée pour tous les fichiers, permettant ainsi une recherche correcte. Champ de Booléen (en anglais, Boolean Field) : lorsque vous réalisez une documentation, un champ de Booléen vous permet d alterner uniquement entre deux états (vrai ou faux) en cochant ou décochant une case. Lorsque vous créez un nouveau champ de documentation, notez que le type du champ ne peut plus être modifié par la suite. Cliquer sur le bouton vous permet de modifier le nom d un formulaire ou d un sousformulaire. Vous pouvez modifier d autres éléments sur la page de propriétés de chaque champ de documentation. La figure 4 montre l exemple de la page de propriétés d un champ de texte. Figure 4 : Page de propriétés d un champ de texte Vous pouvez notamment réaliser les paramétrages suivants pour ce type de champ : Dans la rubrique Champ de Nom (en anglais, Field Name), vous pouvez modifier le titre d un champ de documentation, par exemple, remplacer Text Field 1 par Modèle. Dans la rubrique Valeur (en anglais, Value), vous pouvez imposer un texte. Lorsque vous ouvrirez le modèle de documentation, il contiendra alors déjà le texte entré ici dans le champ de documentation. Ceci est utile si l un des paramètres reste le même pour pratiquement toutes les mesures et que l entrée ne doit être modifiée que pour une seule valeur divergente. Les cases à cocher Visible (en anglais, Visible), Lecture seule (en anglais, Read only) et Obligatoire (en anglais, Mandatory) permettent de définir si le champ de documentation devra apparaître lorsque le modèle sera ouvert par la suite, si le 09/14 5
contenu d un champ sera protégé contre l écriture et s il sera obligatoire de remplir ce champ de documentation. De plus, il est possible de créer une liste de choix (engl. Pick List) sur la page des propriétés. La manière d utiliser des listes de choix sera expliquée en détail dans un chapitre ultérieur. Les pages de propriétés des autres champs de documentation disponibles se distinguent de la page affichée et sont présentées en détail dans l aide en ligne d ArtemiS SUITE. Une fois que vous avez terminé la configuration du modèle de documentation, sauvegardez-le par l intermédiaire de l option Sauvegarder sous (en anglais, Save as). Vous pouvez sauvegarder plusieurs fois le même modèle en adaptant les informations indiquées dans le champ Valeur. Lorsque vous créez la documentation, ouvrez alors le modèle qui est déjà prérempli pour le cas actuel. Documentation de fichiers Pour documenter un fichier, vous pouvez le sélectionner dans le HEAD Navigator d ArtemiS SUITE et ouvrir la documentation-utilisateur en utilisant le raccourci-clavier CTRL + D. L option Attribuer Modèle (en anglais, Assign Template) qui se trouve dans la liste des outils permet d ouvrir le modèle sauvegardé et de le remplir pour le fichier sélectionné. Il est toujours possible de réaliser la documentation ultérieurement dans ArtemiS SUITE. Nous vous recommandons cependant de créer la documentation au moment où vous réalisez l enregistrement dans le HEAD Recorder. Ce type de documentation permet d y consigner les informations concernant la mesure directement là où se trouvent toutes les informations importantes : avec la mesure réalisée sur le banc d essai, la piste d essai, etc. Documentation dans le HEAD Recorder On utilise pour cela le gestionnaire de processus 1 (en anglais, Flow Control) dans le HEAD Recorder. Ouvrez l éditeur de gestionnaire de processus en utilisant le raccourci-clavier Alt + F11 et stoppez le programme en cours en cliquant sur le bouton. Avant de commencer à modifier le gestionnaire de processus, sauvegardez le programme actuel en cliquant sur le bouton. Avant de commencer à modifier le gestionnaire de processus, sauvegardez le programme actuel en cliquant sur le bouton pour pouvoir le réutiliser plus tard. Vous pouvez à présent insérer un bloc de documentation-utilisateur dans le gestionnaire de processus. Le bloc de documentation-utilisateur ouvre un modèle de documentation créé avec ArtemiS SUITE et est généralement inséré après le bloc d enregistrement (voir figure 5). 1 Vous trouverez une description détaillée de la manière d utiliser le gestionnaire de processus dans l «Gestionnaire de processus dans le HEAD Recorder» et dans l aide en ligne du HEAD Recorder. 09/14 6
Figure 5 : Flow Control editor Le modèle souhaité se définit sur la page de propriétés dans le champ Modèle de Documentation (en anglais, Documentation Template file, voir figure 5). Différentes autres fonctions pouvant être activées sur la page de propriétés du bloc de documentationutilisateur aident l utilisateur à documenter les données de son travail : Sauvegarde définitive de la documentation-utilisateur (en anglais, Write documentation to current file) : si vous activez cette option, la documentationutilisateur saisie sera reliée à l enregistrement actuel directement après la mesure. Mais si vous désirez utiliser des éléments de la documentation-utilisateur, par exemple les noms de fichier ou de chemins d accès, il vous faut deux blocs de documentation-utilisateur : o un bloc pour lequel cette fonction est désactivée et que vous avez intégré o dans le gestionnaire de processus avant la mesure, et un bloc pour lequel cette fonction est activée que vous devez intégrer après la mesure. De cette manière, l utilisateur saisit la documentation avant la mesure et elle peut ensuite être par exemple utilisée pour créer le nom du fichier (via le bloc Increment filename) et est de plus écrite après la mesure dans le fichier. Ouvrir éditeur permettant de modifier la documentation (en anglais, Show documentation editor) : si vous activez cette option, l éditeur de documentation s affiche, vous permettant de remplir ou de modifier le modèle de documentation spécifié. Si vous désactivez cette fonction, l éditeur n est plus affiché et c est la documentation-utilisateur qui est utilisée automatiquement (soit celle qui a été saisie en dernier, soit celle qui a été sauvegardée dans le modèle de documentation spécifiée). La documentation-utilisateur est ainsi sauvegardée pour toutes les mesures sans que l utilisateur n ait à intervenir. Utilisez cette fonction 09/14 7
lorsque la documentation-utilisateur que vous avez saisie s applique à toutes les mesures qui suivront, afin d avoir moins de travail. Conserver la documentation-utilisateur saisie en dernier (en anglais, Keep last entered documentation): si vous cochez cette case, le HEAD Recorder préconfigure les champs de la documentation-utilisateur avec les valeurs qui ont été saisies en dernier. Cette fonction vous évite de toujours avoir à saisir les mêmes données. Contrairement à la fonction mentionnée ci-dessus, c est l éditeur qui s affiche, permettant ainsi à l utilisateur d apporter des modifications. Sauvegarde de la documentation-utilisateur D une manière générale, la documentation-utilisateur peut être sauvegardée de deux manières différentes. Elle peut soit être intégrée dans un fichier HDF (en anglais, embedded), soit sauvegardée comme fichier supplémentaire directement à côté de la mesure. Ce fichier supplémentaire porte le même nom que la mesure, mais avec l extension.hadx, en plus de l extension.hdf. Le contenu et l utilisation ultérieure de la documentation-utilisateur, par exemple dans ArtemiS SUITE, dépend de la méthode de sauvegarde que vous avez choisie. L avantage d utiliser la documentation-utilisateur intégrée est que vous ne pouvez pas oublier les informations lorsqu elles sont archivées ou copiées par la suite sur un autre ordinateur puisqu elles sont intégrées dans le fichier HDF. Une documentation-utilisateur intégrée dans un fichier HDF peut néanmoins uniquement être lue et éditée à l aide de logiciels de HEAD acoustics. Si vous utilisez la méthode qui consiste à créer un fichier HADX, vous avez par contre la possibilité d avoir accès à un fichier HADX par l intermédiaire d autres logiciels. Dans les entreprises où les enregistrements sont incorporés dans des bases de données utilisées dans toute l entreprise, ceci permet l accès à la documentation, même avec des applications de base de données d autres fabricants. Le mieux est que vous orientiez le type de sauvegarde aux conditions imposées dans votre entreprise. La manière dont la documentation doit être sauvegardée se configure dans le HEAD Recorder sur la page de configuration, en cochant la case Intégrer la documentation directement dans les fichiers HDF (en anglais, Embed file documentation in HDF file, voir figure 6). 09/14 8
Figure 6 : Page des propriétés de la documentation-utilisateur dans le HEAD Recorder Vous avez d autre part aussi toujours la possibilité dans ArtemiS SUITE d extraire par la suite des données intégrées dans un fichier supplémentaire ou d intégrer de la documentation à partir du fichier supplémentaire dans le fichier HDF (par exemple, en cas de restructuration de la sauvegarde des données au sein de l entreprise ou pour l archivage). HEAD acoustics vous aidera volontiers à déterminer la méthode de sauvegarde la plus adaptée à vos besoins et la programmation du gestionnaire de processus. N hésitez pas à contacter votre interlocuteur HEAD acoustics. Utilisation de listes de choix Utiliser des listes de choix (en anglais, pick list) est un aspect important permettant de rendre la documentation-utilisateur fonctionnelle au quotidien. Intégrer de telles listes facilite d une part le travail lorsque vous créez la documentation car vous n avez plus à la remplir manuellement, mais plutôt à en choisir le contenu confortablement dans une liste. Les listes de choix garantissent d autre part que les informations soient sauvegardées de manière standardisée. Et c est uniquement en sauvegardant toujours les informations similaires de la même manière que l utilisateur peut exploiter au maximum les avantages de la documentation-utilisateur, par exemple, dans la base de données ou en créant des rapports. Les listes de choix peuvent être créées dès la création des modèles sur la page de propriétés d un champ de texte. Cliquez pour cela sur la page de propriétés sur le bouton Liste de Choix intégrées (en anglais, Create Embedded Pick List). S ouvre alors un tableau (voir figure 7) dans lequel vous pouvez ajouter les uns en-dessous des autres les contenus souhaités dans la première colonne (Values) pour la liste de choix. 09/14 9
Figure 7 : Page de propriétés d un champ de texte avec affichage de la liste de choix intégrée Dans la deuxième colonne, vous pouvez également saisir des explications détaillées qui seront affichées pour l utilisateur lorsqu il remplira le modèle. La case N autoriser que les valeurs de la Liste de Choix (en anglais, Allow pick list values only) vous permet de définir si l utilisateur devra par la suite uniquement choisir une seule des valeurs que vous avez prédéfinies ou s il pourra également saisir manuellement d autres valeurs. Lorsque vous sauvegardez à présent le modèle de documentation, la liste de choix créée est alors intégrée dans ce modèle et sera disponible au moment de le remplir. La différence entre une liste de choix intégrée et une liste de choix externe (en anglais, embedded pick list et system pick list) est qu une liste de choix intégrée ne s utilise que pour le modèle actuel, alors que la liste de choix externe ne doit être créée qu une seule fois et qu elle est alors disponible pour tous les modèles, c est-à-dire également si elle est utilisée pour plusieurs modèles de documentation. La méthode des listes de choix intégrées est rapide et efficace et permet de déplacer sans problème le modèle de documentation sur d autres ordinateurs car la liste de choix est intégrée dans le modèle. C est par exemple très utile si vous créez vos modèles de documentation sur un ordinateur fixe et que vous enregistrez les mesures avec un ordinateur portable. Si vous copiez les modèles de documentation sur l ordinateur portable après les avoir créés, vous n avez rien à faire avec les listes de choix intégrées : elles sont disponibles dès que vous ouvrez le modèle sur l ordinateur portable. L avantage d utiliser des listes de choix externes est qu elles sont sauvegardées dans une source de listes de choix séparées et qu elles peuvent ainsi être utilisées pour différents modèles de documentation. Les listes de choix externes peuvent être stockées et leur maintenance peut être assurée par un administrateur à un emplacement centralisé (par exemple, sur un lecteur de réseau). Vous n avez à entrer des informations supplémentaires qu une seule fois, elles restent ensuite à la disposition de tous les utilisateurs de cette source de liste de choix. Les listes de choix externes vous permettent d autre part de définir des dépendances entre les différentes listes de choix. Si un constructeur automobile particulier a par exemple été sélectionné dans une liste de choix, la liste configurée en conséquence dans le champ «Modèle» peut alors ne contenir que les modèles proposés par ce constructeur. 09/14 10
Les listes de choix externes sont donc beaucoup plus flexibles, mais également un peu plus élaborées à créer et à administrer. Si vous déplacez sur un autre ordinateur un modèle de documentation avec un renvoi à une liste de choix externe, vous devez aussi déplacer la source de listes de choix séparée et en rétablir le lien avant de l utiliser. Les possibilités d utilisation et les avantages, particulièrement lorsque l on utilise des listes de choix externes, sont très variés et ne peuvent pas tous être décrits dans cette Application Note. Veuillez vous adresser à votre interlocuteur HEAD acoustics si vous voulez en savoir plus sur la manière de créer des listes de choix adaptées et d exploiter au maximum les avantages de la méthode utilisée. 09/14 11