Prise en charge d’OData pour la génération de rapports étendue

Cette section explique comment utiliser OData afin d’améliorer les fonctionnalités de génération de rapports étendues.

Présentation

OData (Open Data Protocol), la norme basée sur OASIS REST pour l’utilisation des API REST, est pris en charge. Vous pouvez utiliser des outils de BI (Business Intelligence, intelligence décisionnelle) prenant en charge OData pour vous connecter à vos données de projet et générer des graphiques et des rapports. Cela vous permet de visualiser et d’analyser les données à l’aide de fonctionnalités de génération de rapports étendue, allant au-delà des fonctionnalités fournies par les rapports et graphiques.

Voici le flux de travail avec OData.

  1. Préparez la connexion OData, comme spécifié dans le chapitre Conditions préalables.

  2. Récupérez les données de projet via OData à l’aide d’outils de BI prenant en charge OData (tels que Power BI et Tableau).

    Pour plus d’informations, voir Se connecter aux données du projet à partir d’un outil de BI.

  3. Traiter les données récupérées avant l’analyse.

  4. Utilisez l’outil de BI pour générer des rapports et des graphiques pour les données de projet.

Retour en haut

Versions OData prises en charge

La version OData 4.0 est prise en charge.

Tout outil prenant en charge OData version 4.0 devrait fonctionner correctement.

Note : Pour obtenir la liste des outils prenant en charge OData, accédez à la page OData Ecosystem (Écosystème Odata) et sélectionnez Consumers (Consommateurs).

La prise en charge d’OData a été testée avec Power BI et Excel.

Retour en haut

Types d’entités prises en charge

Une fois que vous vous êtes connecté à un projet depuis un outil de BI, vous pouvez récupérer les données de projet suivantes :

  • Releases

  • Cycles

  • Exigences

  • Dossiers de test

  • Tests

  • Étapes de conception de tests

  • Dossiers de campagne de test

  • Campagnes de test

  • Instances de test

  • Exécutions de test

  • Utilisateurs

  • Anomalies

Retour en haut

Conditions préalables

Avant d’utiliser OData, rassemblez les informations de connexion suivantes :

Conditions préalables Détails
Enable OData support (Activer la prise en charge d’OData)

Pour activer la prise en charge d’OData, définissez le paramètre IS_ODATA_SERVICE_ENABLED sur Y.

Pour plus de détails, voir Paramètres de site ALM.
URL de la source de données OData

Les données de projet sont accessibles via une source de données OData (ou un flux OData) unique, ce qui permet aux utilisateurs de se connecter de manière transparente aux données via différents outils de BI.

  • Les sources de données OData respectent le format URL suivant :

    https://<serveur>/qcbin/odatasvc/domains/<nom_domaine>/
    projets/<nom_projet>    .

    Par exemple, utilisez l’URL de source de données suivante pour vous connecter aux données du projet DEFAULT/Demo.

    http://<votre_serveur_alm>/qcbin/odatasvc/domains/DEFAULT/projects/Demo

  • Pour inclure les données de plusieurs projets, saisissez les URL des sources de données de ces projets une par une.
Sign-in credentials (Informations d’identification de connexion)

Vous utilisez des clés API pour vous connecter à une source de données OData. Complétez les informations suivantes pour votre compte d’utilisateur :

  • Générez une clé API pour votre compte. Notez l’ID client et le secret de la clé API.

  • Activez OData pour la clé API.

Pour plus d’informations, voir Gestion des clés API.
Enable full name support (Activer la prise en charge du nom complet)

Obligatoire uniquement si vous souhaitez récupérer les noms complets des utilisateurs.

Par défaut, seuls les noms d’utilisateur sont récupérés pour les utilisateurs. Si vous souhaitez également obtenir les noms complets, définissez le paramètre de site IS_ODATA_SHOW_FULL_NAME sur Y.

Remarque : Tenez compte de la stratégie de votre organisation avant d’activer la prise en charge du nom complet.
Installer un certificat privé

Si un certificat privé est utilisé dans votre environnement, assurez-vous qu’il est également installé sur l’ordinateur sur lequel votre outil BI s’exécute.

Retour en haut

Authentifier

L’authentification est requise la première fois que vous vous connectez à une source de données OData à partir de votre outil de BI.

Utilisez l’option d’authentification de base dans votre outil de BI.

Authentifiez-vous à l’aide de l’ID client et du secret de clé API associés à votre compte.

Champ Description
Nom d’utilisateur

Saisissez l’ID client.
Password (Mot de passe)

Saisissez le secret de la clé API.
Select which level to apply these settings to (Sélectionner le niveau auquel il convient d’appliquer ces paramètres)

Varie selon les outils de BI.

Spécifiez le niveau auquel le nom d’utilisateur et le mot de passe peuvent être partagés pour l’authentification :

  • http://<votre_serveur_ALM>/qcbin/odatasvc/domains/. Vous pouvez utiliser le nom d’utilisateur et le mot de passe pour vous connecter à n’importe quel projet de n’importe quel domaine du serveur spécifié.

  • http://<votre_serveur_ALM>/qcbin/odatasvc/domains/<nom_domaine>.Vous pouvez utiliser le nom d’utilisateur et le mot de passe pour vous connecter à n’importe quel projet sous le domaine spécifié.

Note : Si votre ID client ou votre secret de clé API n’est plus valide, l’authentification échoue. Modifiez ou supprimez les autorisations afin de vous authentifier avec vos nouvelles informations d’identification.

Retour en haut

Se connecter aux données du projet à partir d’un outil de BI

Vous pouvez utiliser n’importe quel outil de Business Intelligence prenant en charge OData pour vous connecter aux données de votre projet, par exemple Power BI, Tableau et Excel.

Exemple : Se connecter aux données de projet depuis Power BI

  1. Ouvrez Power BI. Sélectionnez Home (Accueil) > Get Data (Obtenir des données) > OData feed (Flux OData).

  2. Dans la boîte de dialogue OData feed (Flux OData), sélectionnez Basic (De base), saisissez l’URL de votre source de données ALM OData, puis cliquez sur OK.

  3. Sélectionnez Basic (De base) et saisissez vos informations d’identification de connexion.

Exemple : Se connecter aux données de projet depuis Tableau

  1. Ouvrez Tableau. Dans le menu latéral > Connect (Se connecter) > À un serveur (To a Server), sélectionnez More (Plus), puis OData.

  2. Dans le champ Server (Serveur), saisissez l’URL de votre source de données ALM OData.

  3. Dans le champ Authentication (Authentification), sélectionnez Username and Password (Nom d’utilisateur et mot de passe).

  4. Saisissez vos informations d’identification de connexion.

Exemple : Se connecter aux données de projet à l’aide d’Excel

  1. Ouvrez une feuille de calcul Excel. Sélectionnez Données > Obtenir des données > À partir d’autres sources > À partir du flux OData.

  2. Dans la boîte de dialogue OData feed (Flux OData), sélectionnez Basic (De base), saisissez l’URL de votre source de données ALM OData, puis cliquez sur OK.

  3. Sélectionnez Basic (De base) et saisissez vos informations d’identification de connexion.

Retour en haut

Traiter les données récupérées avant l’analyse

Cette section répertorie quelques recommandations sur le traitement des données de projet préalablement à leur utilisation à l’aide de l’outil de BI.

Filtrer les données

Si vous souhaitez utiliser des données restreintes, vous pouvez filtrer les données récupérées par colonnes de table des types suivants :

  • ID. Par exemple ID anomalie.

  • Heure. Par exemple Temps de correction réel.

  • Date. Par exemple Date de fermeture.

Note : Lors de l’utilisation de filtres, seuls l’opérateur AND est pris en charge.

Développer des données

Lors de la connexion à une source de données OData avec plusieurs tables, vous pouvez utiliser l’option de développement sur une colonne de table afin d’ajouter des colonnes supplémentaires à partir de la table associée. Cela vous permet de créer des requêtes sur plusieurs tables.

Note : L’option de développement est recommandée uniquement pour les relations d’entités un-à-un.

Par exemple, la table Anomalies contient des références à plusieurs tables associées, parmi lesquelles la table Releases. Vous pouvez utiliser l’option de développement sur la colonne target_rel de la table Anomalies afin d’ajouter plus de colonnes liées aux releases, par exemple la colonne Nom. Une fois la colonne target_rel développée, une colonne supplémentaire nommée target_rel.name est ajoutée dans la table Anomalies.

Voici un autre exemple de développement de la colonne detected_by_user de la table Anomalies. Sélectionnez full_name et la colonne detected_by_user.full_name est ajoutée.

Note : La possibilité d’ajouter les noms complets des utilisateurs dépend de l’activation ou non de la prise en charge de la récupération des noms complets. Pour plus d’informations, voir Enable full name support (Activer la prise en charge du nom complet).

Créer des relations entre entités

Créez des relations entre les tables afin de calculer avec précision les résultats et d’afficher les informations correctes dans votre analyse. Cela est particulièrement utile lorsque vous avez affaire à des relations d’entités ALM un-à-plusieurs, plusieurs-à-plusieurs ou à plusieurs niveaux.

Vous trouverez ci-dessous une relation pour les dossiers de campagne de tests, les campagnes de test, les instances de test et les tests.

Retour en haut

Dépannage

Le tableau suivant répertorie les problèmes que vous pouvez rencontrer lors de l’utilisation d’OData.

Problème Solution
OData: Request failed: The underlying connection was closed: Trust could not be established for the protected SSL/TLS channel

Ce problème peut être dû au fait que vous utilisez un certificat privé dans votre environnement, mais que vous n’installez pas le même certificat sur l’ordinateur sur lequel votre outil BI s’exécute.