Nuxeo Online Services

Comment remplir un ticket Jira

Updated: September 18, 2017 Page Information Edit on GitHub

Suivre les recommandations décrites ci-dessous permettra d'avoir un délai de traitement de vos tickets plus rapide. D'autre part, les tickets peuvent être rédigés indifféremment en français ou en anglais.

L'écran de création est composé de deux parties : le premier onglet, Main fields, présente les principaux champs à renseigner (titre, description, criticité , version), tandis que le second, Advanced fields, propose les champs optionnels ou de moindre importance pour la résolution du ticket.

Un ticket doit correspondre à un problème. N'hésitez pas à créer un autre ticket pour signaler un autre incident.

Pour créer un ticket JIRA :

  1. Dans JIRA, cliquez sur le bouton Créer une demande.
  2. Sélectionnez le projet Support Nuxeo Connect.
  3. Remplissez les champs aussi précisément que possible. Selon le type de ticket que vous créez, les éléments suivants peuvent être nécessaires :

    • étapes à suivre pour reproduire le problème,
    • copies d'écran,
    • développement client,
    • description de l'environnement. Voir ci-dessous pour la description détaillée des champs disponibles.
  4. Cliquez sur le bouton Créer.

Champs disponibles sur un ticket JIRA

Voici la liste des champs que vous devez renseigner, si possible, lorsque vous créez un nouveau ticket JIRA. Les autres champs seront remplis par l'équipe Support lors de l'analyse du ticket.

ChampDescription
Main fields
Projet Sélectionnez le projet Support Nuxeo Connect. Voir le paragraphe Projet.
Type de demande Sélectionnez quel type de ticket vous souhaitez créer et donc ce que vous souhaitez faire : poser une question, signaler une anomalie ou un problème, etc. Voir le paragraphe Type de demande.
Résumé Tapez une courte description du ticket.
Descriptif Tapez la description détaillée de ce que vous essayez de faire. Si possible, indiquez les étapes à suivre pour reproduire le comportement constaté. Voir le paragraphe Descriptif.
Affecte la/les version(s) Sélectionnez la version de la plateforme Nuxeo sur laquelle votre application est basée. Voir le paragraphe Versions.
Criticité Sélectionnez le niveau de criticité de votre ticket. Voir le paragraphe Criticité.
Nuxeo Connect support Sélectionnez le contrat Nuxeo Connect associé à votre ticket. Pour les comptes associés à un seul contrat, un seul choix est disponible. Voir le paragraphe Nuxeo Connect support.
Instance type Sélectionnez quel type d'instance est concerné par le ticket : une instance de développement, un serveur de production, etc. Voir le paragraphe Instance Type.
Advanced fields
Environnement Donnez autant d'informations que vous le pouvez sur votre environnement : configuration du serveur, y compris le système d'exploitation et la base de données, le navigateur, etc. Voir le paragraphe Environnement.
Composants Sélectionnez la fonctionnalité ou le composant de la plateforme Nuxeo qui est concerné par votre ticket. Voir le paragraphe Composants.
Additional Participant groups Si vous avez plusieurs utilisateurs Connect travaillant sur le même projet, sélectionnez votre groupe de support pour que les autres utilisateurs puissent recevoir des notifications sur le ticket et participer à son traitement si besoin est. Voir le paragraphe Additional Participant groups.
Additional Readonly Groups Si vous souhaitez ajouter des utilisateurs qui ont besoin de suivre l'état des tickets sans en créer ou modifier eux-mêmes, sélectionnez le groupe "read-only" associé à votre groupe de support. Voir le paragraphe Additional Readonly Groups.
Reporter Ce champ est pré-rempli avec votre nom d'utilisateur.
Référence SFDSi vous avez des spécifications fonctionnelles, vous pouvez indiquez leur référence ici pour le reste de votre équipe.
TagsTapez un mot-clé qui peut vous aider à catégoriser vos tickets.

Projet

Toutes les demandes de support doivent être faites dans la catégorie Support Nuxeo Connect. Si le ticket n'est pas créé dans la bonne catégorie, le ticket ne sera pas visible par l'équipe du Support et ne recevra pas de réponse.

Type de demande

Ce champ indique le type d'incident lié au ticket créé. Les choix proposés sont :

  • Question: toute question autour de la plateforme Nuxeo,
  • Anomalie: problème lié à la plateforme Nuxeo,
  • Incident: problème lié à vos développements,
  • Amélioration: demande d'améliorations ou de nouvelles fonctionnalités, qui pourra faire l'objet d'une estimation, en vue d'une réalisation au forfait.

Cette identification est importante pour fournir les éléments nécessaires à la description du ticket, traité au paragraphe Description.

Descriptif

Le contenu de ce champ dépend du type de ticket et est essentiel à son traitement. Vous devez donc le renseigner avec soin.

Type Question

Vous devez essayer de décrire précisément quelle information vous recherchez ou ce que vous cherchez à accomplir, en indiquant le contexte de votre demande, afin que l'équipe Support puisse vous fournir la réponse adéquate.

En cas de question jugée trop complexe ou trop dépendante du contexte métier, l'équipe de Support pourra vous orienter vers une prestation de consulting afin d'analyser plus précisément votre besoin et fournir une réponse plus complète.

Type Anomalie

Dans un premier temps, vous devez vérifier qu'il s'agit d'un bug de la plateforme Nuxeo et non d'un incident, c'est-à-dire un problème lié à vos développements. Pour cela, vérifiez la reproductibilité du scénario proposé sur une instance de la plateforme Nuxeo sur laquelle vos plugins ou personnalisations Studio ne sont pas installés.

Si l'anomalie n'est pas reproduite sur le site de démo :

  • cela peut être lié à un environnement différent de la démo (sous Linux Ubuntu 64 bit et PostgreSQL 9.1). Dans ce cas, vous devrez préciser ces différences dans la description de votre environnement ;
  • il peut s'agit d'un problème introduit par vos développements. Dans ce cas, vous choisirez le type « Incident ».

En cas de doute, il vaut mieux privilégier le type « Incident » pour lequel vous devrez fournir plus de détails.

Si l'on se trouve dans le cas d'un bug, il est essentiel de fournir à l'équipe de support un moyen de reproduction de l'anomalie. Vous devez donc indiquer :

  • le scénario pas à pas pour reproduire le bug ;
  • puis les logs du serveur : vous pouvez essayer d'extraire la dernière stacktrace dans la console ou le fichier server.log ou encore le message affiché dans l'interface web ;
  • et une capture d'écran montrant l'interface web avant/après si c'est pertinent pour le bug remonté.

Un seul de ces éléments peut suffire à l'identification de l'anomalie et à sa résolution, mais mieux le ticket sera décrit, plus il sera traité rapidement et efficacement.

Type Incident

Cela concerne un problème directement lié aux développements du client. Dans ce cas, en plus des éléments à fournir pour une anomalie, vous devrez :

  • fournir les plugins que vous avez développés ET/OU les développements que vous pensez être liés à l'incident (classes Java, templates, tests unitaires, fichiers de configuration XML),
  • identifier les derniers changements effectués sur la plateforme depuis le dernier moment où ça fonctionnait.

Si vous travaillez avec Nuxeo Studio, il est probable que vous allez poursuivre votre travail de configuration pendant la résolution du ticket : dans ce cas, il faut que Nuxeo puisse travailler sur une version figée du projet. Pour cela :

  • attachez au ticket JIRA le plugin Studio (fichier .jar) en place au moment des tests,
  • ou posez un tag dans Nuxeo Studio avec le nom du ticket JIRA que vous venez de créer.

En environnement de production, il est important d'identifier la date du problème, pour retrouver les erreurs correspondantes dans les logs.

Type Amélioration

Une amélioration est un comportement qui n'est pas disponible dans la plateforme Nuxeo et que vous souhaiteriez voir implémenter. Un ticket de type Amélioration vous permet de demander à l'équipe Nuxeo si une nouvelle fonctionnalité pourrait être réalisé. Pour ce type de ticket, seule le descriptif est nécessaire, dans lequel vous devez décrire le comportement souhaité.

Versions

Le client doit indiquer quelle version principale de la plateforme Nuxeo il utilise (6.0, 7.10, etc.), indépendamment des hotfixes installés (ce qui sera précisé dans l'environnement).

Criticité

Le client indique ici le niveau de criticité du ticket créé :

Niveau de gravité Définitions de gravité NUXEO pour un Entrepôt Documentaire Nuxeo en production Définitions de gravité NUXEO pour un Entrepôt Documentaire Nuxeo en environnement de développement
1. Bloquant (Blocker) Problème de production catastrophique ayant des impacts très importants sur vos systèmes de production, perte des données liées à la production et absence de procédure de résolution. Les problèmes de gravité 1 incluent également les violations de sécurité. Problème critique de blocage, empêchant l'avancement de tout développement.
2. Critique (Critical) Problème ayant un impact élevé, dans lequel l'exploitation de votre application est perturbée, mais vous avez la capacité de rester productif et de maintenir les opérations commerciales à un niveau suffisant. Tout problème rendant l'utilisation ou l'utilisation continue d'une ou plusieurs fonctionnalités de la Plateforme Nuxeo difficile quant au développement, ayant un impact significatif sur l'état d'avancement des projets de logiciels, et ne pouvant raisonnablement être contournée ou évitée de façon temporaire sans y consacrer beaucoup de temps et/ou d'efforts.
3. Majeur (Major) Problème ayant un impact moyen à faible, qui implique une perte partielle et non critique d’une fonctionnalité touchant certaines opérations, mais vous permettant de continuer l’exploitation. Requêtes générales relatives à l'utilisation et/ou à la mise en œuvre de la Plateforme Nuxeo qui ne sont pas classées dans la catégorie problème de gravité 2.
4. Mineur (Minor) Problème d’affichage ou de traduction, questions d'utilisation générale, recommandations pour l'amélioration future de produits ou modifications. Aucun impact sur la qualité, les performances ou les fonctionnalités de la Plateforme Nuxeo. Non applicable
5. Cosmétique (Detail)Détail n'ayant pas d'incidence sur le fonctionnement de l'application (libellé, style, etc.).Détail n'ayant pas d'incidence sur le fonctionnement de l'application (libellé, style, etc.).

La criticité ne dépend pas de critères de priorisation mais uniquement des termes précisés ci-dessus.

Le détail des délais de réponse et de résolution en fonction de la SLA (Service Level Agreement : garantie du niveau de service) est présentée sur cette page : http://www.nuxeo.com/fr/produits/support/.

Nuxeo Connect support

Ce champ sous forme de liste déroulante permet de faire le lien entre le ticket JIRA et le contrat Connect. Après sa sélection, l'équipe de support disposera de quelques informations sur l'application du client (version de Nuxeo, système d'exploitation, base de données), ayant ainsi un rapide aperçu de l'environnement dans lequel est déployé la plateforme Nuxeo.

Pour les comptes associés à un seul contrat, un seul choix est disponible. Pour les autres, il faut prendre soin de choisir le bon projet.

Instance type

Ce champ permet à l'équipe de support de connaître les éventuelles contraintes liées au type d'instance. Ceci peut avoir une influence sur les recommandations qui vous seront données.

Les différents types d'instance sont :

  • Development : le sujet du ticket porte sur un environnement de développement. Certains critères, comme la conservation des données, peuvent être considérées comme non critiques sur une instance de développement.
  • Testing/QA : le sujet du ticket porte sur un environnement de test, qui a généralement un nombre limité d'utilisateurs.
  • Production : le sujet du ticket porte sur un environnement de production. L'équipe de support peut être amenée à proposer une solution de contournement dans un premier temps, afin de débloquer les utilisateurs rapidement, sans attendre de solution à long terme, qui peut être plus longue à mettre en place. L'équipe de support peut également vous proposer un appel téléphonique afin d'obtenir plus d'informations rapidement.

Environnement

Dans le cas d'un bug ou d'un problème, il est important de préciser l'environnement.

A partir de Nuxeo Platform 5.6, le plus simple est de fournir le résultat de la commande showconf, qui donne un résumé de la configuration (nuxeo.conf et packages) en obfusquant les mots de passe.

  • Sous Linux:

      # ./nuxeoctl showconf
    
  • Sous MS Windows:

      > nuxeoctl.bat showconf
    

En plus de ces données, il peut être intéressant de préciser les informations suivantes afin que Nuxeo connaisse exactement l'état de votre serveur :

  • système d'exploitation (Redhat EL 5.4 64 bits, Windows 2003 SP2 32 bits, …) du serveur et du poste client ;
  • navigateur (IE8, Firefox 17, Chrome 23, etc …) : important pour les problèmes liés aux postes client ;
  • base de données utilisée (PostgreSQL 9.1, Oracle 11g, etc …) ;
  • packages additionnels installés ;
  • serveur d'application (Tomcat par défaut, ou JBoss) ;
  • niveau de hotfix installé.

Composants

Parmi les champs additionnels se trouve le choix des composants sur lesquels porte le ticket. Le client peut essayer de le renseigner à partir de la liste à choix multiple. Dans le cas contraire, l'équipe de support le fera.

Ce champ est principalement utilisé à des fins statistiques, pour connaître les composants qui ont besoin du plus d'attention pour les prochains développements.

Additional Participant groups

Ce champ permet de partager un ticket avec un groupe d'utilisateurs. Cette fonctionnalité est principalement utilisée pour les clients disposant de plusieurs comptes.

Le nom du groupe à renseigner fait partie des groupes de l'utilisateur, consultable sur son profil (https://jira.nuxeo.com/secure/ViewProfile.jspa) et habituellement de la forme « support-NOMDEMASOCIETE ».

Additional Readonly Groups

Ce champ permet de partager en lecture seule un ticket avec un groupe d'utilisateurs. Par exemple avec des responsables d'équipe qui ont besoin de pouvoir prendre connaissance des points remontés au support sans pour autant ouvrir ou modifier des tickets.

Les groupes read-only ne sont disponibles que pour les contrats le précisant. Le nom du groupe est habituellement de la forme « support-ro-NOMDEMASOCIETE ».

Autres recommandations

Quelques conseils pour améliorer la qualité du ticket :

  • éviter de décrire le ticket dans un fichier .doc ou .docx, pour que le ticket soit entièrement lisible quelque soit le media utilisé pour sa consultation (navigation sur smartphone, application pour smartphone, tablette, navigation classique sur PC).
  • Ne pas coller des centaines de lignes de logs dans un commentaire et préférer l'attachement des logs en pièce jointe si la trace fait plus d'une vingtaine de lignes.
  • Pour les utilisateurs avancés, ne pas hésiter à utiliser les possibilités de formatage offertes par JIRA pour mettre en valeur la description :
    • texte formaté,
    • code source,
    • lien,
    • puces.
7 days ago GitHub Fix formatting
2 years ago Solen Guitter 18
2 years ago Julie Allouch 17
2 years ago Julie Allouch 16
2 years ago Solen Guitter 15 | Change layout to use 2/3 layout
3 years ago Solen Guitter 14
3 years ago Solen Guitter 13
3 years ago Solen Guitter 12
4 years ago Solen Guitter 11
4 years ago Thierry Martins 10
4 years ago Thierry Martins 9 | detail sur la criticité
4 years ago Thierry Martins 8
4 years ago Solen Guitter 6
4 years ago Solen Guitter 7
4 years ago Solen Guitter 5
4 years ago Solen Guitter 4
4 years ago Solen Guitter 3
4 years ago Solen Guitter 2
4 years ago Solen Guitter 1
History: Created by Solen Guitter