Table of Contents
- I. Scarab, qu'est-ce que c'est?
- II. Scarab pour tous
- III. Scarab pour les administrateurs de modules
- IV. Aller plus loin avec Scarab
Table of Contents
Table of Contents
Scarab est un outil complètement paramétrable pour la gestion des faits techniques. Scarab peut être utilisé pour toutes sortes de projets, techniques ou non. Comme tous les paramètres du système sont configurables, cet outil peut répondre aux besoins d'équipes projet ou de personnes individuelles. Chaque implémentation peut être configurée directement au workflow d'un projet donné en définissant des types (de fiches) et des attributs. L'interface utilisateur a été conçue pour être accessible et cohérente: dès que vous êtes familiarisé(e) avec son fonctionnement, vous maîtriserez rapidement les nouveaux processus.
Scarab fournit un ensemble robuste d'outils pour la gestion de faits techniques:
Saisie de fiche : Le processus de saisie de fiche est conçu pour aider les utilisateurs à créer des entrées signifiantes et à éviter les doublons. Les attributs sont utilisés pour décrire une entrée et rechercher dans la base des entrées semblables. Si des résultats sont trouvés, l'utilisateur peut consulter des doublons potentiels, leur ajouter des commentaires ou modifier leur propre saisie avant de l'enregistrer dans la base.
Gabarits de saisie Les critères entrés fréquemment peuvent être enregistrés dans des gabarits pour une saisie plus rapide. Des fichiers peuvent être joints à une fiche et sont gérés directement avec leur fiche. Les utilisateurs peuvent ajouter et éditer des commentaires à une fiche en fonction des besoins. Ils peuvent accéder à l'historique complet d'une fiche lorsqu'ils la consultent.
Recherche de fiche : L'accès aux fiches dans la base est particulièrement simple avec la fonction de requête. L'utilisateur peut facilement trouver, consulter et modifier les fiches, une à la fois ou par groupes. La fonction Requête avancée permet à l'utilisateur de créer des recherches détaillées, en spécifiant les valeurs de plusieurs attributs et en limitant la recherche à certains intervalles de date ou de numéros. La fonction Requête personnalisée permet à l'utilisateur de rechercher une chaîne de caractères - l'utilisateur peut spécifier un ensemble d'informations à comparer aux entrées de la base. Les requêtes utilisées fréquemment peuvent être enregistrées et aisément ré-exécutées.
États imprimés : La fonction Etats imprimés permet à l'utilisateur de créer et d'enregistrer des états. Les états fournissent des métriques intéressantes et personnalisables.
Notifications par courriel : Lorsque survient un événement important, un courriel est généré et envoyé à toutes les personnes associées à cet événement. Les courriels d'alerte contiennent des liens vers les pages décrivant l'événement.
Scarab est écrit en Java et basé sur les technologies du web. Il stocke les informations dans une base de données, le plus souvent MySQL, mais il fonctionne aussi sur d'autres bases telles que Oracle ou PostgreSQL.
Scarab est hautement personnalisable. Il ne contient pas de workflow prédéfini ou codé en dur (qui définisse par exemple ce qui se passe lorsqu'une fiche passe d'un état Ouvert à un état Fermé) et il n'y a pas non plus de types d'artefacts prédéfinis (rapport de bogue, demande d'amélioration, etc.) Vous avez une totale liberté de définir les fiches de la manière qui vous convient le mieux. L'inconvénient en est une prise en main parfois moins facile mais vous obtenez au bout du compte un outil qui correspond mieux à vos besoins.
La plupart des autres systèmes de suivi de faits techniques, dans le monde de l'open source et ailleurs (Bugzilla, Issuezilla, SourceForge, Gnats) contiennent une logique de traitement des fiches qui est embarquée dans l'application. Ceci signifie que vous êtes souvent coincés dans la logique définie par le système en question. Scarab ne vous limite pas de cette manière.
Beaucoup d'histoire (et quelques histoires) entourent la naissance de Scarab. Vous pourrez fureter sur le web pour en apprendre davantage si cela vous intéresse.
Disons pour faire court que Scarab naît de la passion d'un programmeur de grand talent, par ailleurs personnage haut en couleurs : Jon Scott Stevens. Jon a été une figure de proue de Jakarta, où il a notamment joué un rôle de premier plan dans les projets Velocity et Turbine.
Son grand projet était de concevoir et développer un successeur à Bugzilla.
CollabNet lui offre un poste et la possibilité de développer ce logiciel en open-source — mais aussi dans la perspective de l'intégrer aux outils de développement collaboratif de CollabNet.
C'est ainsi que le projet Scarab est né et se développe jusqu'à aujourd'hui.
Un ensemble complet de fonctionnalités telles qu'on en trouve dans les autres systèmes de suivi de faits techniques : saisie de données, requêtes, états imprimés, notifications d'événements aux parties intéressées, accumulation collaborative de commentaires, suivi des dépendances.
En plus de ces fonctionnalités standard, Scarab propose un nombre illimité de Modules complètement personnalisables (vos différents projets), de types d'artefacts (Défaut, Demande d'amélioration ou de changement, Exigence,...), d'Attributs (Système d'exploitation, Statut, Priorité, etc.), d'Options d'attributs (P1, P2, P3) qui peuvent tous être définis module par module, de sorte que chaque module peut êtret configuré pour des besoins spécifiques.
Capacité d'importer et exporter des données au format XML depuis/vers d'autres systèmes (notamment Bugzilla).
Conception modulaire du code, qui permet des modifications gérables et l'ajout de fonctionnalités nouvelles dans le moyen et le long terme.
Entièrement personnalisable par le biais d'un ensemble complet de pages d'administration.
Ergonomie de l'interface utilisateur aisément modifiable.
Peut être intégré dans d'autres systèmes plus vastes en réimplémentant certaines interfaces (cas de l'intégration dans les outils de CollabNet, par exemple).
Construit sur base de la technologie Java Servlet pour sa vitesse, sa capacité à supporter la charge, sa facilité d'installation et de maintenance.
Le succès de tout projet dépend de sa capacité à gérer et résoudre les problèmes. La façon d'utiliser les outils dépend de la manière dont le projet est organisé et des processus envisagés. Vous pouvez utiliser les outils comme dispositif de partage de la connaissance et comme un moyen de suivre la bonne santé du projet.
L'information contenue dans Scarab peut être extrêmement utile dans bien des domaines au sein d'un projet. Parce que Scarab est hautement configurable, les ressources en termes de connaissance peuvent être paramétrées pour les besoins de chaque discipline dans une organisation. Suivre une fonctionnalité au-delà des frontières entre disciplines différentes peut se faire en copiant les fiches et en créant des dépendances entre elles.
Par exemple, le projet Go a ses types de fiche organisés par échéance dans le cycle de vie des caractéristiques. Le projet Go a les types de fiches suivants: Planning, Développement, Test, Gestion de production et Support. De nouvelles fonctionnalités sont entrées dans le type de fiche Planning, où elles sont traitées jusqu'à être prêtes pour le développement. A ce stade, la fiche est copiée dans les types Développement, Gestion de production et Test, et toutes les copies sont bloquées par le Développement. Les intervenants ont tous une description complète de la fonctionnalité, y compris toutes les discussions menées dans la phase de spécification. Comme toutes les fiches ont des dépendances réciproques, le suivi des tâches à travers les frontières des différentes disciplines est facile. Toutes les fiches bloquées par la fiche "Développement", cela signifie qu'aucune ne peut être fermée tant que le cycle de développement n'est pas terminé mais chaque groupe peut continuer son travail sur base de ce qui se passe dans le développement du projet. Par exemple, la documentation peut faire partie du cycle Gestion de production. Les rédacteurs peuvent suivre les fonctionnalités en développement et suivre leur travail de documentation dans leur propre fiche, avec des liens vers la fiche Développement. Lorsque la fonctionnalité a été livrée aux utilisateurs, le support peut commencer à prendre en charge le suivi des anomalies, accéder facilement aux informations sur cette fonctionnalité dans les différents types de fiches et suivre ou créer rapidement des liens vers d'autres zones en consultant l'historique.
Scarab peut aider à suivre et contrôler la bonne santé d'un projet. Si votre projet a un type particulier de problème et que vous devez en assurer le suivi, Scarab peut vous aider à le faire à travers une série de processus.
Par exemple, le projet Go a ajouté une base de données et les développeurs craignent que cette nouvelle base ne cause de sérieux problèmes de performance. En exécutant des requêtes et des états de manière habituelle, la maîtrise du projet détermine qu'il y a, en effet, un problème de performance qui est peut-être associé à la nouvelle base de données. Il apparaît que la résolution de ce problème est hautement prioritaire et critique pour la réussite du projet. Pour faciliter le travail sur ce problème, le propriétaire du projet crée un gabarit de saisie d'anomalie et une série de requêtes et d'états. On demande aux utilisateurs d'utiliser ce gabarit et d'entrer une information spécifique sur ce qu'ils ont trouvé dans un attribut "Description". Le gabarit est utilisé pour régulariser l'information sur les problèmes. En utilisant une requête enregistrée, les membres du projet peuvent rapidement accéder aux anomalies relatives à ce problème et concentrer leur effort sur les zones critiques. Suivre la progression de la résolution des problèmes de performance peut être fait en utilisant un état. La manière de le configurer pour vos besoins peut prêter à confusion. Voilà, ce n'était que deux exemples de bonnes pratiques.
Table of Contents
Table of Contents
Abstract
Pour utiliser Scarab, après vous être connecté(e) à l'URL de votre installation en utilisant votre navigateur Web, vous pouvez ou devez vous identifier. Il vous faut ensuite choisir le module à partir duquel vous allez travailler.
Un accès anonyme peut être permis à certains modules. Ces modules sont affichés sur la page d'accueil de votre installation de Scarab et vous n'avez pas besoin de vous identifier pour y accéder.
Si vous disposez d'un compte Scarab dans cette installation, ou si vous pouvez vous en créer un, il vous sera sans doute possible d'accéder à d'autres modules ou à d'autres opérations dans les modules pour lesquels un accès anonyme est autorisé.
Dans un cadre professionnel, il est possible qu'on vous ait communiqué un identifiant et un mot de passe Scarab.
Dans d'autres situations, ou si ce n'est pas le cas, vous pouvez vous créer un compte utilisateur en utilisant le lien "S'enregistrer". Dans la procédure d'enregistrement, il vous faut ABSOLUMENT renseigner une adresse de courriel à laquelle vous avez réellement accès. Sans quoi la communication entre Scarab et vous ne pourra pas fonctionner.
Si vous avez oublié votre mot de passe, vous pouvez obtenir qu'il soit réinitialisé en utilisant le lien "Réinitialiser le mot de passe". Vous recevrez alors un nouveau mot de passe par courriel. Lors de votre prochaine connexion, après avoir introduit le mot de passe qui vous a été envoyé, il vous sera immédiatement demandé de le changer.
Dans l'écran d'accueil (pour un accès anonyme) ou immédiatement après la connexion, il vous est demandé de choisir un module, dans lequel vous allez pouvoir travailler.
Vous avez aussi la possibilité de demander l'accès à d'autres modules si le gestionnaire de ces modules le permet. Pour cela, cliquez sur le bouton "Demande de rôles".
Note
Si vous n'avez accès qu'à un seul module, vous êtes immédiatement dirigé(e) vers la page d'accueil de ce module.
Cet écran de sélection n'apparaît pas.
Table of Contents
L'interface de Scarab est organisée pour permettre d'accéder facilement aux fonctionnalités les plus importantes d'où que l'on soit dans l'application. Chacun des écrans fournit des informations appropriées ainsi que des liens pour accéder à plus de détails lorsque c'est nécessaire. Une interface unifiée et cohérente vous permet de reconnaître aisément les types d'informations et d'actions disponibles sur chaque écran.
Chaque écran fournit les aides à la navigation suivantes:
La barre de navigation gauche : La barre de navigation est organisée par type de fiche, puis par fonction. Pour accéder à une fonction dans un type de fiche déterminé, sélectionnez le libellé du type de fiche dans la barre de navigation gauche. Les fonctions disponibles pour ce type de fiche apparaîtront sous le libellé.
La barre de requête : La barre de requête donne un accès aisé aux outils de recherche. La boîte ID fiche vous permet d'accéder à une fiche donnée par son identifiant. La boîte de sélection de requête donne accès aux requêtes avancées et personnalisée. Si vous avez enregistré des requêtes, elles apparaîtront dans ce menu de sélection de requête.
Titres de section : La plupart des écrans d'information sont organisés sous forme tabulaire. Chaque section commence par un titre informatif qui décrit la section et, souvent, fournit une information générale sur ce qui suit. Chaque entête de colonne se comporte comme un lien qui permet de modifier le critère de tri pour cette table. La colonne sur laquelle s'effectue le tri a une petite flèche indiquant le sens du tri (ascendant par défaut). Pour changer l'ordre du tri, cliquez cette petite flèche.
Boutons : ils indiquent l'ensemble des actions possibles. Souvent, il y a plus d'un groupe de boutons par page. Les boutons situés directement en-dessous d'une section vont effectuer une action sur cette section seulement; selon le cas, vous pouvez aussi trouver un bouton Mettre à jour les options à côté du sélecteur d'attribut d'une section. Ceci indique que si vous changez l'attribut, en cliquant ce bouton, les options disponibles pour cet attribut changeront.
Cases à cocher : elles sont utilisées pour sélectionner des items dans une liste en vue de les modifier.
Dans la plupart des cas, les informations utiles sont inclues directement dans les écrans pour clarifier les opérations inhabituelles. Des messages d'erreur sont aussi fournis en ligne pour aider à identifier où l'erreur s'est produite et les moyens d'y remédier.
La barre de navigation, à gauche, vous aide à accéder aux différentes fonctionnalités de Scarab -- et à l'aide..
Pour faire un usage efficient de l'espace disponible à l'écran, il est possible (depuis la version 20) de faire apparaître et disparaître la barre de navigation.
Si la barre de navigation est visible, vous pouvez la faire disparaître temporairement en double-cliquant quelque part en dessous.
De même, si vous avez besoin de la barre de navigation et qu'elle n'est pas là, vous pouvez la faire apparaître en double-cliquant dans l'espace libre à gauche.
Les formulaires de saisie sont particulièrement simples à utiliser. Les données requises sont signalées par des * (astérisques) à côté du libellé du champ. Vous trouverez souvent des indications au sein du formulaire pour vous aider dans le processus de saisie.
Des boutons de navigation sont disponibles sur chaque écran. A ces boutons sont associées des actions sur les données entrées dans le formulaire. Le bouton
Annuler annule le processus dans lequel vous êtes engagé(e).
Continuer vous amène à la suite du processus de saisie.
Terminer enregistre votre travail et vous ramène au dernier processus dans lequel vous étiez engagé(e).
Suivant indique que davantage d'information est disponible sur l'écran suivant. En cliquant ce bouton, les données courantes seront mémorisées et vous serez amené(e) à l'étape suivante de l'assistant.
Certaines fonctionnalités en plusieurs parties fournissent des onglets pour naviguer facilement entre les différentes parties. Dans la fonctionnalité Etats imprimés, vous pouvez utiliser les onglets pour passer de la définition des lignes aux caractéristiques finales de sortie.
Si vous avez enregistré la définition d'un ensemble de données pour un formulaire (comme les requêtes enregistrées, les états ou les gabarits de saisie), la section supérieure contient une liste déroulante contenant tous les items disponibles pour cette fiche. Cette liste apparaît pour la saisie de fiche, les requêtes et les états. Pour utiliser un formulaire enregistré, choisissez celui qui vous intéresse dans la liste et utilisez le bouton Sélection pour amener l'objet sélectionné.
Chaque attribut dans un formulaire de saisie affiche toutes les options disponibles, parmi lesquelles on peut en choisir une ou plusieurs.
Les pages de résultats apparaissent lorsque vous avez activé une requête, un état, etc. Chaque écran de résultats fournit une liste d'items avec de l'information descriptive.
Un certain nombre d'écrans de résultats vous permettent d'effectuer des actions sur les items qui apparaissent. Sous les items, vous trouverez un ensemble de boutons associés aux actions possibles. Il peut y avoir deux ensembles de boutons. Le premier n'agit que sur les items que vous sélectionnez en utilisant les cases à cocher. Si un second groupe apparaît, les actions correspondantes portent sur tous les items de la liste.
Sous les boutons d'action, vous trouverez parfois des liens vers des actions supplémentaires. Ces liens vous permettent d'agir sur la disposition des résultats.
Beancoup d'écrans sont personnalisables. Vous pouvez ajouter ou enlever des attributs en cliquant sur ajouter/enlever des attributs à partir du lien Vue. Utilisez les cases à cocher pour montrer ou cacher les attributs. Cochez les items que vous souhaitez voir apparaître dans votre page. Vous pouvez aussi cet écran pour déterminer l'ordre des colonnes en utilisant le champ "Ordre des colonnes".
Table of Contents
Scarab a une stratégie très dynamique de gestion des fiches. Valider, suivre et modifier des fiches est un processus simple. Scarab a les fonctionnalités suivantes en termes de gestion des fiches :
Relations : Scarab permet le suivi des relations entre les fiches. Des dépendances entre fiches peuvent être marquées et suivies soit à travers le processus de saisie de fiche soit en consultation d'une ou plusieurs fiches.
Suivi des modifications : Tous les changements apportés, avec les informations sur l'utilisateur qui a apporté le changement, quand le changement s'est produit et tous les commentaires fournis avec le changement sont suivis dans la fiche.
Consultation et édition des commentaires : Tous les commentaires ajoutés à une fiche sont mémorisés. Les commentaires permettent aux informations de support ou à d'autres types de discussions d'être vus et modifiés par toutes les parties impliquées dans la résolution d'une question ou d'un problème.
Enregistrement d'informations saisies fréquemment : Un gabarit de saisie vous permet d'enregistrer un ensemble de données communes pour les attributs. Quand un gabarit est utilisé, le formulaire de saisie est pré-rempli et l'utilisateur peut en modifier les informations selon les besoins.
Après avoir sélectionné un type de fiche et suivi le lien "Entrer nouveau" dans la barre de navigation, vous pouvez saisir des valeurs pour les attributs disponibles. Chaque attribut aura soit une liste déroulante dans laquelle on peut choisir une option, soit une zone de saisie pour y entrer du texte. Tous les attributs ayant une astérisque (*) à côté de leur libellé doivent être renseignés avant d'enregistrer la fiche.
Si la recherche de doublons est activée, la saisie d'une fiche devient un processus en trois étapes. La première étape est de renseigner un sous-ensemble des attributs, utilisé pour la recherche d'éventuels doublons dans la base lorsque vous aurez cliqué le bouton Suivant . La seconde étape est de passer en revue les doublons possibles et de déterminer la voie à suivre (voir la rubrique Doublons pour plus d'informations sur la gestion des doublons). La troisième étape est de saisir des valeurs pour les autres attributs.
Au cours de la saisie de la fiche vous pouvez lui attacher un fichier en utilisant le même formulaire. Attacher un fichier vous aide et aide les autres à partager des informations pertinentes sur la question, ou des patches par exemple. Pour plus d'informations sur ces pièces jointes, voir la rubrique Pièces jointes.
Avant de valider votre fiche, vous pouvez choisir ce que vous voulez faire immédiatement après dans l'application. Chacune des options valide la fiche et vous emmène à l'une des fonctionnalités suivantes:
Entrer une fiche
Assigner une fiche
Consulter cette fiche
Page de départ
Table of Contents
Les fonctionnalités de recherche incluent: la définition d'une requête très spécifique, l'usage d'une requête personnalisée, l'usage de requêtes enregistrées et l'accès à des identifiants de fiches déterminés. Vous pouvez aussi utiliser la Liste des fiches pour ré-exécuter la dernière requête.
Si vous connaissez l'identifiant de la fiche: entrez-le dans le champ "ID Fiche".
Si vous connaissez des valeurs d'attributs pour la fiche: utilisez une requête avancée.
Si vous connaissez des informations approximatives sur la fiche: utilisez une requête personnalisée.
Pour des paramètres de recherche déjà définis: utilisez une requête enregistrée.
Pour simplifier l'utilisation, les requêtes fréquemment utilisées peuvent être enregistrées. Utilisez le lien sur la barre de navigation à gauche ou la barre de requêtes pour accéder aux requêtes enregistrées.
La barre de requête contient des liens vers les fonctions de recherche les plus utilisées.
Si vous avez des requêtes enregistrées, elles apparaîtront dans la liste déroulante de cette barre de requête.
La page ID fiche vous permet de chercher un identifiant de fiche déterminé dans la base de données.
Requêtes avancées vous permet de spécifier des critères de recherche détaillés.
Requêtes personnalisées est une fonctionnalité de recherche sur les zones textuelles.
Recherche de texte ce lien explique la syntaxe utilisée pour une recherche de texte.
Mes fiches génère une liste de toutes les fiches auxquelles vous êtes associé(e).
Le plus récent ré-exécutera la dernière requête exécutée ou une requête enregistrée que vous avez définie comme requête par défaut.
Pour accéder à une fiche déterminée, entrez son identifiant dans le formulaire de recherche et cliquez le bouton ID fiche . Si l'identifiant que vous avez demandé ne peut être trouvé, un message d'erreur apparaîtra et vous pourrez en entrer un autre.
La recherche de fiches sur plusieurs projets nécessite les informations suivantes:
le droit de consulter des fiches dans le projet cible
le nom abrégé du projet cible
le numéro de la fiche
Par exemple, jdoe est dans le projet Jeu (gam) et il veut consulter une fiche du projet Interface (int). Jdoe peut taper INT1 et cliquer le bouton ID fiche pour voir la première fiche du projet Interface.
Si vous n'avez pas le droit de consulter des fiches dans le projet cible, vous recevrez un message d'erreur. De même, si vous entrez un identifiant ou un numéro de fiche non valide, un message d'erreur approprié sera généré.
Le formulaire de requête avancée vous fournit une interface pour définir sans ambiguïté vos critères de recherche. Vous pouvez utiliser ce formulaire pour entrer des valeurs pour certains des attributs disponibles dans ce type de fiche, ou tous, ou aucun. Vous pouvez qualifier davantage votre recherche en demandant les fiches comprises dans un intervalle donné de dates ou de numéros. Supposons que vous vouliez connaître toutes les fiches concernant le système d'exploitation AIX fermées dans le courant de la semaine dernière. Vous pouvez entrer un intervalle de dates et définir certaines valeurs pour les attributs "Système d'exploitation" et "Etat". Cliquer le bouton Accédez au formulaire de recherche avancée en choisissant l'option requête de la liste Sélection de requête sur la barre de requête. Cliquez le bouton Soumettre pour lancer la requête.
Vous pouvez définir des valeurs pour certains attributs, ou tous, ou aucun. Scarab recherchera dans la base de connaissances des fiches qui contiennent toutes les valeurs que vous avez spécifiées. Le formulaire de requête avancée vous permet de définir des critères de recherche avec une fine granularité. Il y a trois types de critères de recherche disponibles sur le formulaire de requête avancée:
Recherche dans la base de connaissances
Personnes
Changement d'état
Vous pouvez utiliser chacune de ces sections isolément ou en combinaison pour qualifier vos recherches. Si vous exécutez une requête sans définir aucun attribut, toutes les fiches associées à l'utilisateur connecté seront renvoyées.
La page Recherche dans la base de connaissances. Cette section fournit un espace pour vous permettre de définir des valeurs pour les attributs de la fiche. Chacun des attributs disponibles dans ce type est représenté ici. Vous pouvez définir des valeurs pour certains attributs de la fiche, ou tous, ou aucun. Vous pouvez aussi limiter votre recherche à un intervalle de fiches ou de date de création.
Dès que le formulaire est validé, Scarab recherchera dans la base de donnée toutes les fiches contenant des valeurs correspondant à toutes les attributs définis dans vos critères de recherche. Pour trouver efficacement les fiches qui vous intéressent directement, vous voudrez probablement ne définir que les attributs qui correspondent à vos critères. Si vous définissez des attributs hors de vos exigences, il y a moins de chances que vous trouviez des fiches correspondant à vos critères. Par exemple, jdoe cherche des problèmes impliquant la base de données sur un des systèmes d'exploitation UNIX. Plutôt que de définir une valeur pour le système d'exploitation, jdoe peut créer une recherche dans les zones texte sur les termes "erreurs base de donnée". Si jdoe a besoin de préciser davantage ses critères de recherche, d'autres attributs peuvent être renseignés. Lorsque vous définissez vos critères de recherche, vous devriez commencer avec le plus petit ensemble de caractéristiques pertinent pour vos besoins.
La page Recherche par les personnes associées La section recherche sur les personnes vous permet de rechercher des fiches sur base des utilisateurs qui leur sont associés. En fonction des attributs utilisateur qui ont été définis, vous pouvez chercher par exemple la personne qui a soumis le problème ou celle à qui il est affecté. Tous les utilisateurs associés à des fiches peuvent être sélectionnés depuis un attribut utilisateur de cette section. Vous pouvez sélectionner autant d'utilisateurs qu'il est besoin.
Ce champ vous permet de positionner un attribut dont vous souhaitez surveiller l'évolution, sa valeur originale et la nouvelle valeur attendue. Par exemple, il se peut que vous vouliez connaître toutes les fiches qui ont changé d'un niveau de gravité bas à élevé. De plus, vous voulez contrôler ces changements dans un intervalle de dates donné. Par exemple, vous pouvez vouloir connaître les fiches qui ont reçu plus de deux votes dans la dernière semaine. Cliquer le bouton "Mise à jour des options" enregistrera les modifications que vous avez apportées à la requête. Vous pouvez aussi déterminer vos préférences sur l'affichage des résultats à ce stade. Vous pouvez modifier l'ordre de la recherche et le nombre de fiches par page. Vous pouvez soumettre votre requête à ce stade pour exécution, ou l'enregistrer.
Les requêtes personnalisées vous permettent d'effectuer des recherches dans la base avec un ensemble de paramètres très affiné. Vous pouvez chercher dans les attributs texte comme dans n'importe quel autre attribut que le gestionnaire de votre projet a inclus comme paramètre de recherche rapide.
Dans cette section, sélectionnez les attributs sur lesquels vous voulez effectuer une recherche. Entrez ensuite une chaîne de caractères à rechercher. Chaque terme qui apparaît dans cette chaîne sera recherché dans chacun des attributs. Par exemple, le projet Jeu a les attributs texte Description sommaire, Description, Histoire et Message d'erreur. Vous êtes intéressé à retrouver toute fiche qui concerne l'usage d'un joystick. Vous pouvez choisir un attribut texte, plusieurs ou même tous et entrer "joystick" dans la chaîne de caractères à rechercher. Une fois que la recherche est lancée, le terme "joystick" sera cherché dans toutes les entrées des attributs que vous avez choisi.
Vous pouvez utiliser ce formulaire pour déterminer la manière dont vous souhaitez voir les résultats s'afficher. Vous pouvez choisir en fonction de quels attributs vous voulez voir les résultats ordonnés, ou le nombre de fiches par page.
Une fois que vous avez un ensemble de paramètres de recherche bien défini, il se peut que vous vouliez les enregistrer pour un usage ultérieur. Les requêtes enregistrées peuvent être utilisées pour générer des rappels, vous tenir informé de la progression de certains problèmes ou pour accéder rapidement à un ensemble particulier de fiches. Vous pouvez utiliser des requêtes enregistrées disponibles pour tous ou en créer pour votre propre usage.
Enregistrer des requêtes
Pour créer une requête enregistrée, accédez à la page et Requêtes avancées définissez vos paramètres de recherche (pour plus d'informations, voir la rubrique "Avancé"). Cliquez le bouton Enregistrer cette requête . Les requêtes enregistrées sont accessibles via le lien Requêtes enregistrées sur la barre de navigation gauche ou dans la liste déroulante de la barre de requête. La liste déroulante des requêtes enregistrées n'apparaît que si vous avez accès à des requêtes enregistrées.
La page Enregistrer cette requête est l'endroit ou vous pouvez donner à votre requête enregistrée un nom unique. Ce nom doit être court et descriptif. Le nom de la Requête enregistrée apparaît alors dans la barre de requête. Vous pouvez ajouter une description pour caractériser davantage votre requête. La description de la requête apparaît dans la page des requêtes enregistrées; elle peut aider les utilisateurs à déterminer plus facilement la requête à utiliser.
Par exemple, vous pouvez avoir défini plusieurs requêtes pour chercher les fiches associées au système d'exploitation AIX. L'une de vos requêtes recherche en particulier toutes les nouvelles fiches entrées avec une priorité haute. Une seconde requête peut rechercher toutes les fiches fermées, également avec une priorité haute. La première est nommée AIXopen, la seconde AIXclosed. Vous pouvez utiliser le champ Description pour vous rappeler que ces requêtes concernent spécifiquement des fiches à priorité haute.
Avant d'enregistrer votre requête, vous devez en déterminer la disponibilité. Votre requête peut être disponible pour votre usage seulement, en sélectionnant "Personnelle" dans la liste déroulante. Si vous pensez que votre requête peut intéresser tous les membres de votre équipe projet, vous pouvez sélectionner "Globale". Si vous n'avez pas le droit de créer une requête globale enregistrée, la requête sera soumise à l'administrateur du projet pour approbation (voir la rubrique Approbation pour plus d'informations sur le processus d'approbation).
Cliquez le bouton Enregistrer pour terminer l'enregistrement.
Gérer les requêtes enregistrées
La page Requête enregistrée est utilisée pour gérer les requêtes enregistrées. Toutes les requêtes disponibles sur ce type de fiche apparaissent dans ce tableau. Cliquez le nom de la requête pour accéder à la page d'édition de requête. Le lien Location exécutera la requête. Cliquez sur le nom dans le champ Fourni par pour ouvrir une saisie de courriel, en utilisant le client courriel par défaut de votre navigateur. Vous pouvez aussi sélectionner une requête par défaut et vous y abonner (voir ci-dessous pour plus d'informations).
Vous pouvez agir sur plusieurs requêtes simultanément: utilisez les cases à cocher pour sélectionner les requêtes que vous voulez modifier.
La page Copier la sélection va amener une copie de la requête. Vous pouvez cliquer le nom de la copie pour l'éditer. L'utilisation de cette fonctionnalité peut vous aider à créer des requêtes enregistrées avec une granularité fine.
La page Supprimer les items sélectionnés va enlever la requête enregistrée de votre liste. Vous pouvez supprimer n'importe laquelle de vos requêtes personnelles.
Les requêtes sur plusieurs modules vous permettent de rechercher dans plusieurs modules, plusieurs types de fiches ou l'un et l'autre avec une seule requête. En accédant à Scarab depuis la barre de navigation, vous pouvez cliquer l'onglet Construire une requête sur plusieurs modules. Dans cet onglet, vous pouvez sélectionner une requête enregistrée précédemment ou en créer une nouvelle.
La table Projets / fiches dans le domaine liste tous les types de fiches de tous les modules pour les ajouter à votre requête. Les projets ne sont disponibles que si vous avez les droits de lancer des requêtes dans ce module. Ajoutez des types de fiches à votre requête en cochant la case de la colonne Sélection et en cliquant le bouton Ajouter la sélection. Ceci déplacera les types de fiches sélectionnés vers la section Construire la liste des types de fiches. Vous pouvez enlever tous les types de votre requête en cliquant le bouton Enlever tout ou enlever seulement les types sélectionnés en cliquant le bouton Enlever la sélection.
Une fois que vous avez sélectionné tous les types de fiches que vous vouliez inclure dans votre requête, vous pouvez enregistrer la liste pour un usage ultérieur en cliquant le bouton Enregistrer. Vous devez alors saisir le champ Nom et cliquer le bouton Enregistrer à nouveau.
Pour commencer votre requête, cliquez alors le bouton Définir la requête. Ceci vous amènera à la page Requête avancée où vous pourrez définir vos critères de requête comme vous le feriez pour une requête simple. Pour plus d'informations sur la manière de construire des requêtes, voir Requêtes avancées.
Table of Contents
Scarab vous permet de construire des états pour fournir une vue de l'évolution des fiches à un instant donné. Vous pouvez définir les états selon vos besoins particuliers en dénissant les types de données inclues et en choisissant le format de sortie. Les données inclues dans un état peuvent comprendre des attributs et options, des utilisateurs et des dates. L'état peut être formaté pour un navigateur web, pour Excel (.xls) ou comme fichier texte (.txt), les valeurs étant séparées par des tabulations. Les états peuvent utiliser un ou plusieurs types de fiches, dans un ou plusieurs modules.
Pour accéder aux états dans Scarab:
- Sélectionnez le module à partir duquel vous voulez commencer à définir l'état.
- Cliquez le lien Etats. Ceci vous emmène à la Liste des états sauvegardés. Vous pouvez y sélectionner un état enregistré précédemment, ou bien vous pouvez construire un nouvel état.
- Sélectionnez l'état que vous voulez lancer en cliquant sur son nom, ou accédez au concepteur d'état en cliquant le bouton Créer nouveau
La construction d'un nouvel état dans Scarab utilise trois onglets: L'onglet Information sur l'état vous permet de définir l'étendue de l'état et d'entrer les informations de synthèse, qui servent à l'enregistrement des états. Il y a deux sections dans cet onglet : Types d'artéfacts utilisés dans cet état, et Résumé
Le type de fiche inclus dans l'état est par défaut le type de fiche courant. Si vous souhaitez définir un état pour un type différent ou pour plusieurs types ou modules, cliquez le bouton Editer la liste. Ceci vous amènera à la page Liste de plusieurs modules / types de fiches. Vous pourrez utiliser cette page pour définir une liste de types de fiches dans le module courant ou dans plusieurs modules pour les inclure dans votre état. Il est recommandé de choisir les types de fiches de l'état avant de travailler dans les onglets de contenu. Bien qu'il soit possible de modifier la liste plus tard, les ajouts qui entrent en conflit avec des données entrées dans les autres onglets ne seront pas permis.
Dans la page Liste de plusieurs modules / types de fiches, vous pouvez effectuer les tâches suivantes:
Choisir une liste de modules enregistrée précédemment.
Enlever des types de fiches de votre état en cochant la case située à côté de chaque type de fiche dans la section supérieure de la page et en cliquant le bouton Enlever les items sélectionnés. Pour enlever tous les types de fiches, cliquez le bouton Enlever tout.
Ajouter des types de fiche à votre état en cochant la case située à côté de chaque type de fiche dans la section supérieure de la page et en cliquant le bouton Ajouter les items sélectionnés.
Lorsque vous aurez sélectionné l'ensemble de types de fiches pour votre état, vous pouvez sauvegarder la liste pour un usage ultérieur en cliquant le bouton Enregistrer button.
Cliquez le bouton Terminé pour retourner à la page Informations de l'état, page dans laquelle les types de fiche sélectionnés apparaîtront dans la section Types d'artefacts sélectionnés pour cet état.
Entrez les informations générales
La section Général de l'onglet Informations sur l'état vous permet de saisir les informations nécessaires à l'enregistrement de votre état. Ces informations sont facultatives et peuvent être ajoutées à n'importe quel moment du processus de création de l'état. Vous pouvez fournir les informations suivantes:
Entrez un nom pour votre état dans le champ Nom.
Entrez une description dans le champ Description de l'état.
Sélectionnez la Disponibilité de l'état. Si vous avez le droit de partager vos états avec d'autres membres du module, le champ Disponibilité apparaîtra, vous offrant la possibilité d'enregistrer cet état pour votre usage seulement ou pour le module.
Sélectionnez le format de l'état. Les formats disponibles sont Web, Excel (.xls) et fichier délimité par des tabulations (.txt).
Lorsque vous aurez entré toutes les informations souhaitées, cliquez le bouton Mettre à jour pour ajouter ces informations à votre état.
Les onglets Contenu des lignes et Contenu des colonnes vous permettent de définir et d'organiser les données de votre état. Ces onglets contiennent des informations et des options identiques; mais vous pouvez évidemment choisir des types de données différents dans chaque onglet. Ceci vous permet de créer des rapports uniques et très pointus. Lorsque les lignes et colonnes ont été définies, vous pouvez générer l'état.
La section Critères de lignes/de colonnes vous permet de sélectionner le type des données présentées dans les lignes ou colonnes de votre état. Les choix possibles sont ici:
Attribut(s) / option(s) Quand ce type de donnée est sélectionné, vous pouvez choisir parmi les attributs et options définis pour les types de fiches choisis.
Utilisateurs (par attribut utilisateur)Quand ce type de donnée est sélectionné, vous pouvez choisir parmi les membres du module et spécifier un attribut utilisateur pour chaque utilisateur sélectionné.
Date(s)Quand ce type de donnée est sélectionné, vous pouvez définir des dates pour chaque ligne/colonne de votre état.
L'option sélectionnée dans le champ Choix du type de contenu détermine les données disponibles dans le reste des sections de ces onglets. Un seul type de contenu peut être utilisé pour chaque en-tête. Si vous choisissez Date(s) comme type de contenu, soit dans l'onglet Contenu des lignes, soit dans l'onglet Contenu des colonnes, ce doit être le seul en-tête sur cet axe. Par contre, vous pouvez définir des critères utilisateur pour un ou plusieurs niveaux d'en-tête et des attributs d'options pour d'autres en-têtes sur le même axe. Que ce soit dans l'onglet Lignes ou dans l'onglet Colonnes, changer le type de contenu en Date(s) après avoir défini un ensemble de critères utilisateurs ou attributs/options supprimera les données entrées précédemment dans cet onglet.
Lorsque vous concevez des états contenant des options d'attributs et des attributs utilisateurs, l'organisation des données peut faire la différence entre un outil d'analyse fort utile et une masse de nombres complètement illisible. Pour vous aider à organiser vos données, Scarab vous permet d'arranger les données de l'état suivant des en-têtes qui sont combinées dans l'état final pour permettre des critères multiples par cellule.
Les en-têtes sont définis seulement par les données qu'ils contiennent. Pour créer des en-têtes dans votre état:
Dans le Concepteur d'états, cliquez sur l'onglet Contenu des lignes ou sur l'onglet Contenu des colonnes.
Choisissez le type de contenu pour cet en-tête dans la liste déroulante Choix du type de contenu.
Choisissez les options que vous souhaiteriez inclure dans le premier en-tête de votre état.
Cliquez le bouton Mettre à jour.
Si vous souhaitez inclure plus d'un en-tête dans votre état, dans la section contenu des axes: en-têtes de lignes/de colonnes, cliquez le bouton Ajouter un autre en-tête.
Sélectionnez le type de contenu pour cet en-tête dans la liste déroulante Choix du type de contenu. Si l'en-tête défini précédemment contenait des attributs utilisateur ou des attributs/options, vous ne pourrez pas choisir le type de contenu Date(s): faire ce choix supprimerait l'en-tête saisi précédemment.
Sélectionnez les options que vous souhaitez inclure dans cet en-tête.
Lorsque vous avez terminé, cliquez le bouton Mettre à jour
Continuez à ajouter des en-têtes et à sélectionner des options de cette manière jusqu'à ce que toutes les options que vous voulez retrouver dans votre état aient été incluses.
Vous pouvez modifier un en-tête déjà défini en cliquant le radio bouton situé à côté de cet en-tête puis le bouton Editer l'en-tête sélectionné. Vous pouvez supprimer un en-tête déjà défini en cliquant le bouton radio situé à côté de cet en-tête puis le bouton Supprimer l'en-tête sélectionné.
Scarab vous permet d'organiser encore davantage vos états en groupant les attributs et options dans vos en-têtes. Par exemple, si les options P1, P2, P3 et P4 de l'attribut Priorité ont toutes été sélectionnées, vous pourriez grouper P1 et P2 en "haute priorité" puis P3 et P4 en "basse priorité".
Vous devez avoir défini au moins un en-tête contenant un Attribut/option(s) dans votre état avant de pouvoir définir des groupes. Pour grouper les options dans les en-têtes:
Dans l'onglet Contenu des lignes ou Contenu des colonnes, sélectionnez un en-tête avec le type de contenu Attribut/option(s) et cliquez le bouton Editer l'en-tête sélectionné.
Dans la section relative aux données du groupe, entrez un nom pour le groupe et cliquez le bouton Ajouter. Répétez cette étape si vous voulez d'autres groupes dans cet en-tête.
Dans la section Regroupement des attributs/options des données de l'état, sélectionnez le groupe dans lequel vous voulez voir apparaître chaque option en utilisant la liste déroulante Nom de groupe située à côté de chaque attribut/option.
Quand vous avez terminé, cliquez le bouton Mettre à jour.
Concevoir un état basé sur des attributs utilisateur vous permet par exemple de déterminer comment la charge de travail de votre module est répartie. Vous pouvez utiliser le type de données Utilisateurs (par attribut) pour créer des états qui indiquent comment les fiches sont assignées (ou associées d'une quelconque façon) aux utilisateurs.
Pour définir des critères Utilisateurs (par attribut) dans l'état:
Dans l'onglet Contenu des lignes ou Contenu des colonnes, sélectionnez Utilisateur (par attribut) dans la liste déroulante Choix du type de contenu.
Dans la table Utilisateurs, cochez la case dans la colonne Sélection et l'attribut utilisateur désiré dans la liste déroulante de la colonne Association de l'utilisateur que vous voulez inclure.
Cliquez le bouton Ajouter la sélection à la liste des personnes assignées
Pour inclure plusieurs attributs utilisateurs pour un seul utilisateur, vous devez ajouter à nouveau cet utilisateur avec l'attribut supplémentaire sélectionné. Par exemple, si vous vouliez générer un état pour indiquer quels utilisateurs sont propriétaires d'une fiche ou responsables de l'Assurance Qualité, vous devez sélectionner chaque utilisateur deux fois -- d'abord avec l'attribut utilisateur Assigned to, ensuite avec l'attribut QA contact.
Pour vous aider à déterminer comment progresse votre module, Scarab vous permet de concevoir des états basés sur les dates (et heures). Les états de dates et heures donnent un cliché de l'activité sur les fiches à un moment donné. Vous pouvez concevoir les états pour inclure plusieurs dates et heures, en vue de montrer le progrès dans un intervalle de temps donné.
Pour créer des états sur les dates et heures:
Dans l'onglet Contenu des lignes ou Contenu des colonnes, sélectionnez Date(s) dans la liste déroulante Choix du type de contenu.
Dans la table Choix du contenu de ligne/colonne (dates), utilisez les listes déroulantes pour sélectionner les dates et heures que vous voulez inclure dans votre état.
Cliquez le bouton Ajout d'une seule date.
Continuez à ajouter des dates de cette manière jusqu'à ce que toutes les dates désirées soient incluses.
Vous pouvez inclure dans votre état des dates situées dans le futur. Une ligne ou une colonne avec une date située dans le futur apparaîtra vide dans l'état généré; mais cette ligne ou colonne se remplira si l'état est regénéré et que la date est passée. Ceci peut être utilisé pour créer des états d'avancement que l'on peut générer à intervalles réguliers. En ajoutant des dates situées dans un futur assez éloigné et en enregistrant l'état, vous pouvez minimiser le temp passé à définir des états générés fréquemment.
Une fois que vous avez défini le contenu des lignes et celui des colonnes, le bouton Générer l'état apparaîtra. Cliquez ce bouton pour créer l'état au format que vous avez sélectionné dans l'onglet Informations sur l'état.
Lorsque vous visualisez l'état au format Web, vous pouvez effectuer les actions suivantes:
Retourner l'état en cliquant le lien Permuter les lignes et les colonnes.
Enregistrer l'état en cliquant le bouton Enregistrer cet état. Si vous n'avez pas saisi les informations générales dans l'onglet Informations sur l'état, vous serez ramené(e) à cet onglet. Vous devez alors entrer un nom pour l'état et cliquer le bouton Mettre à jour pour ajouter ces informations à l'état. Cliquez alors le bouton Enregistrer cet état pour le sauvegarder.
Exporter l'état au format Excel ou valeurs séparées par des tabulations en sélectionnant le format d'export désiré dans la liste déroulante Exporter les résultats vers.
Table of Contents
Table of Contents
À partir de la page d'accueil, sélectionnez un module si ce n'est déjà fait (la création d'un module ne peut se faire en dehors de tout contexte, mais c'est sans importance pour la tâche considérée).
Depuis la page d'accueil d'un module, ou à partir de la plupart des autres pages d'ailleurs, vous pouvez accéder aux fonctionnalités d'administration des modules mais il vous faudra peut-être double cliquer dans la marge de gauche pour faire apparaître le menu correspondant.
Là, choisissez Modules, Gérer les modules et cliquez le bouton Créer nouveau.
Vous pouvez maintenant entrer les informations relatives au module que vous voulez créer.
Deux champs méritent une attention particulière à ce stade.
Le champ Module parent détermine le module qui sera utilisé comme gabarit, comme modèle, pour le module que vous vous apprêtez à créer. Cela veut dire que le nouveau module "héritera" de tous les types de fiches et attributs du module parent que vous choisissez.
Caution
Cet "héritage" a donc lieu une fois pour toutes à la création du module. Les types de fiches et les attributs sont copiés du parent au nouveau module.
Les modifications ultérieures des types de fiches et attributs du module parent que vous choisissez maintenant ne seront pas propagées au module que vous créez.
Ou pour le dire encore d'une autre manière, les types de fiches et attributs sont copiés du module parent au nouveau module, ils ne sont pas partagés entre eux.
Le module parent apparaît aussi dans les listes de modules. Par exemple, le module Source qui a Pacman JVM comme parent apparaît ainsi dans la liste :
Vous pouvez changer le parent dans un second temps (voir la section suivante) si vous voulez changer la logique de présentation des modules mais ce critère ne doit pas déterminer votre choix au moment de la création du module.
Pour modifier la définition et les propriétés d'un module, cliquez Gérer les modules dans le menu Admin, puis cliquez le module.
L'écran suivant ne nécessite pas grande explication.
Vous ne pouvez pas supprimer complètement un module mais vous pouvez le marquer comme détruit (et donc le faire disparaître des opérations courantes). Le module n'apparaîtra plus dans les listes de modules (mais il apparaîtra encore, barré, dans la liste de l'écran Gérer les modules au cas où vous voudriez le réactiver un jour).
Table of Contents
Du chapitre précédent, vous devriez avoir compris qu'il n'est pas facile (pour l'instant ?) de propager des modifications de "schema" (types de fiches, attributs) dans un grand nombre de modules.
Si vous commencez à utiliser Scarab et que vous pensez mettre en oeuvre un nombre significatif de modules, il est donc très important de bien concevoir le schéma de base dont vous allez partir.
Un conseil donc : ne négligez pas la phase de conception en amont du projet "Scarab". Quels sont les types d'artefacts qui vous sont utiles ? Les attributs que vous allez utiliser ? Le workflow (voir le chapitre suivant) ?
Prototypez ! Même si vous avez une installation Scarab "de production" ou que vous êtes en train de la créer, faites une autre instance de base de données et testez votre design. Pensez-vous que ce que vous avez concçu correspond à vos besoins et à ceux des (futurs) utilisateurs ?
Votre installation de Scarab est ouverte à vos clients, au moins partiellement (le client peut accéder à certains modules). Vous voulez permettre au client de rentrer des fiches d'anomalies ou des demandes d'évolution mais vous ne voudriez pas lui montrer tout le détail (interne à votre organisation) des commentaires ou de la procédure de résolution. Comment faire ? Dans Scarab on ne peut pas montrer ou cacher les attributs en fonction du Rôle par exemple.
Utilisez deux modules différents.
Le premier (on peut l'appeler "Accès client") contient les attributs tels que le client peut les voir et les saisir: description, priorité, gravité, environnement, etc.
Le second, en général plus complet, contient aussi des attributs techniques liés aux processus internes de suivi et de résolution.
Comment cela se passe-t-il ensuite ?
Lorsque le client crée une fiche, cette fiche doit être prise en charge par quelqu'un au sein de votre organisation.
Tip
Pour que quelqu'un soit systématiquement tenu au courant des demandes clients (sans devoir se connecter à Scarab et faire une requête), pensez à mettre ou ajouter son adresse de courriel dans le champ Archive du module. Il est ainsi destinataire de tous les courriels de création ou modification de fiche
La demande est qualifiée et le parcours peut dans certains cas s'arrêter là. Elle peut être soumise à négociation commerciale et/ou rejetée.
Si la demande doit faire l'objet d'une ou plusieurs tâches en aval, la fiche est copiée dans le second module et on crée une dépendance entre la fiche originale et la fiche copiée. Lorsque la tâche correspondante est terminée, elle est marquée comme telle pour l'organisation et peut être signalée comme telle dans le module "Accès client", ce qui informe le client que sa demande a été traitée.
Table of Contents
Le workflow a été un sujet de débats passionnés depuis que Scarab existe. Dans un premier sens, le plus léger, le terme "workflow" désigne le fait d'imposer certains états aux fiches sur base de la valeur de leurs attributs, de leur "état" comme on dit couramment, ou d'autres conditions. Dans un second sens, le workflow désigne l'interaction ou l'intégration entre Scarab et d'autres systèmes ou processus.
Dans Scarab, les workflows sont "enfichables" ‐ vous pouvez retirer le workflow installé par défaut et installer le vôtre à sa place. Jusqu'à la version b19, l'option par défaut était de ne pas avoir de workflow. En fait, il y avait un workflow simple appelé DefaultWorkflow qui ne faisait rien et permettait toutes les transitions. A partir de la version b20, le workflow par défaut est un workflow de base appelé 'BasicWorkflow', dont le comportement est expliqué ci-dessous.
Changer de workflow
Si vous désirez changer de workflow pour en utiliser un autre ou concevoir le vôtre, reportez-vous au chapitre Workflow du Guide de développement.
Les fonctionnalités fournies par BasicWorkflow se rattachent au premier sens donné ci-dessus au terme workflow.
Le concept d'"état" d'une fiche dans Scarab est lié habituellement à un ou plusieurs attributs. Tout attribut choisi dans une liste peut être considéré comme caractérisant l'"état" de la fiche à laquelle il appartient. D'une certaine manière, c'est vrai aussi des autres types d'attributs mais ceux que l'on choisit dans une liste sont mieux adaptés à cet usage parce qu'il y a un ensemble bien défini de valeurs.
Bien que ceci ait toujours été vrai dans Scarab, l'absence de restrictions sur les transitions était souvent source de confusion parce que Scarab, sans workflow, ne faisait rien pour imposer un processus défini.
Avec les fonctionnalités du workflow BasicWorkflow, vous pouvez définir un workflow de transitions d'état pour un attribut choisi dans une liste déroulante, ce qui vous permet de définir les valeurs qu'un attribut peut prendre à partir de sa valeur courante et le Rôle que l'utilisateur doit exercer pour pouvoir effectuer cette modification.
De cette manière, tout utilisateur ne pourra modifier l'attribut caractérisant l'état de la fiche qu'en lui donnant une valeur vers laquelle une transition est possible, sur base de la valeur courante de l'attribut et de ses Rôles.
Les transitions doivent être définies au niveau global, vous devez donc avoir les droits d'administration et vous rendre à l'écran "Administration - Données globales - Attributs globaux".
Choisissez maintenant l'attribut pour lequel vous voulez définir des transitions, ou créez un nouvel attribut. Pour rappel, il doit être du type liste.
En bas de l'écran, notez l'apparition d'une section "Transitions", dont la première ligne est "Nouvelle". Tant qu'il n'y a pas d'autres lignes, il n'y a pas de transitions définies pour cet attribut et il se comportera comme n'importe quel attribut de type liste.
Si vous voulez définir une transition, choisissez la valeur "depuis", la valeur "vers" et le Rôle requis pour accomplir cette transition, puis cliquez sur le bouton "Enregistrer". Si vous voulez supprimer une transition, cochez la case correspondante et cliquez sur le bouton "Supprimer".
Dès que vous avez défini une transition pour un attribut, le comportement par défaut qui permet toutes les transitions est désactivé. Si vous voulez que d'autres transitions soient permises pour un rôle quelconque, vous devez les définir explicitement.
Si vous souhaitez définir un état initial, il vous faudra définir une transition à partir de l'état "Option vide" vers cette valeur. Si vous souhaitez qu'un état soit toujours atteignable, définissez une transition depuis "Toute option" vers cette valeur.
Les conditions ont été développées dans Scarab pour permettre à l'administrateur de rendre certains comportements conditionnels. En l'état courant du développement (milestone 20), les conditions sont définies en choisissant une ou plusieurs valeurs pour les attributs de type liste. La condition est considérée comme remplie pour une fiche donnée si au moins une des valeurs sélectionnées correspond à l'état de cette fiche.
Il est possible d'appliquer des conditions à deux comportements :
- Imposer un attribut (globalement ou par module)
- Les transitions d'état
Dans le premier cas, l'administrateur peut forcer l'état d'un attribut quand la condition est évaluée comme vraie. Dans le second cas, une transition conditionnée ne sera permise que si la condition est évaluée comme vraie.
Dans les deux cas, vous remarquerez un bouton avec le libellé "Editer les conditions". Lorsque vous le cliquez, vous obtenez un écran dans lequel vous pouvez sélectionner les valeurs pour tous les attributs de type liste qui formeront la condition. Cliquez "Terminer" pour revenir à l'écran précédent, et vous pourrez y lire la condition que vous avez définie.
Table of Contents
Table of Contents
Scarab permet aux administrateurs de modules
d'exporter
- les fiches d'un module (données);
- les types de fiches et attributs d'un module (métadonnées);
d'importer
- des données pour constituer ou mettre à jour les fiches d'un module.
L'import des types de fiches et des attributs n'est pas possible en l'état courant du développement.
Table of Contents
Un moyen intéressant d'amener des informations de Scarab dans Eclipse est d'utiliser un plugin de lecture de flux RSS, par exemple Eclipse RSS Reader. Utilisons ce plugin pour les besoins de la démonstration.
Vous pouvez suivre dans Eclipse l'historique d'une fiche ou le résultat d'une requête publique (hors requêtes multi-modules). Supposons par exemple que vous vouliez suivre dans Eclipse l'évolution de la fiche Scarab PACS1. Dans Scarab, dans le coin inférieur droit de cette fiche, il y a des liens RSS et ATOM.
Copiez par exemple le lien RSS.
Dans Eclipse, maintenant, créez un nouveau canal RSS.
Collez l'URL du lien RSS et cliquez "Load".
Il n'y a qu'un traducteur disponible pour ce format, vous pouvez donc continuer.
Choisissez maintenant le projet auquel vous voulez associer le RSS, puis un nom de fichier.
Le flux RSS apparaît maintenant comme une ressource projet dans le navigateur d'Eclipse..
Si vous cliquez sur le fichier du flux RSS, une fenêtre s'ouvre avec l'historique de la fiche (elle est rafraîchie automatiquement, par défaut toutes les 30 minutes). Le lien "Browse" vous ramène directement vers Scarab, à la fiche concernée.
Abstract
Un plug-in NetBeans permet d'inclure des fiches Scarab dans sa liste de tâches.
Ce plug-in (.nbm) est pour l'instant disponible dans le tracker de NetBeans à l'URL suivante : http://tasklist.netbeans.org/issues/show_bug.cgi?id=69572
Comme vous le savez probablement, vous pouvez renseigner l'URL de Scarab dans le POM de votre projet.
Pour cela, insérez l'entité issueTrackingUrl dans votre fichier project.xml:
<issueTrackingUrl>http://192.168.0.151:8888/scarab/</issueTrackingUrl>
Ceci créera un lien vers Scarab dans la section Project Info du site projet généré par Maven:
On peut aller plus loin et lier maintenant les changements, explicités dans le fichier ./xdocs/changes.xml, et des fiches Scarab.
Ajoutez d'abord ceci à votre fichier build.properties :
# Pour le plugin changes maven.changes.issue.template=%URL%/issues/id/%ISSUE%
Vous pouvez maintenant créer des liens entre vos modifications (dans changes.xml) et Scarab. Par exemple :
<release version="1.22" date="2006-02-01">
<action dev="jean-francois.elfouly" type="fix" issue="VDCO134">
Modified FaringServicesBean to fix a bug related to the faring in city pairs where
the departure date determines the season.
</action>
<action dev="jean-francois.elfouly" type="add" issue="VDCO135">
Modified FaringServicesBean to add a faring rule for fare bases with specified
travel dates (inbound, outbound or both).
</action>
</release>
donnera ceci, avec des liens fonctionnels et joliment formatés dans la page changes-report.html :
Abstract
On utilise un flux RSS dans TWiki pour obtenir une vue de l'état d'avancement d'un projet.
TWiki est une plate-forme de collaboration en entreprise qui a un plugin pour afficher le contenu de flux RSS et Arom (le plugin HeadLines). Les résultats peuvent être présentés sous forme tabulaire. On peut utiliser cette fonctionnalité pour afficher les résultats d'une requête publique dans Scarab. Par exemple, on peut créer un sujet TWiki pour montrer tous les défauts ayant à un instant donné le statut "Assigné". Il est même possible de créer un tableau qui liste les fiches dont le statut est passé à "Résolu" dans le mois courant.
Créez une requête publique qui ramène les fiches que vous voulez inclure dans votre rapport. Par exemple, recherchez touts les fiches dont le statut est "Assigné" ou "Réouvert". Utilisez une requête publique de sorte que TWiki puisse obtenir le flux correspondant sans devoir s'authentifier. Sinon, il est aussi possible d'inclure l'identifiant et le mot de passe dans l'URL du flux.
Exécutez la requête depuis la liste déroulante "Requête avancée". Vérifiez que la requête ramène les résultats attendus.
Utilisez votre navigateur pour copier l'adresse du flux RSS ou Atom correspondant au résultat de cette requête. Pour cela, faites un clic droit sur "RSS" ou "Atom" en haut ou en bas du tableau présentant les résultats de la requête dans Scarab.
Dans un sujet (topic) TWiki, utilisez la variable
%HEADLINES%pour présenter le flux dans la page :.%HEADLINES{ href="http://www.saxess.de/testscarab/issues/curmodule/1/tqk/0/template/RSSDataExport.vm/feedType/QueryFeed/queryId/10000/userId/1/type/rss_2.0" refresh="1" header="| *$title* | *$description* |" format="$t| [[$link] [$title]] | $description |" }%
Vous verrez une table formatée présentant les résultats de la requête, comme vous l'aviez vue dans Scarab.
La première colonne donne l'identifiant de la fiche, la seconde l'état, le résumé et les personnes à qui cette fiche est assignée. Les identifiants de la première colonne sont aussi des liens vers la fiche correspondante dans Scarab.
Prenez garde au fait que le plugin Headlines de TWiki met les résultats en cache pour évider de trop charger la source des flux.
Le temps de rafraîchissement est par défaut de 60 minutes; dans l'exemple ci-dessus, le paramètre
refresh est positionné pour ramener ce délai à une minute.