Conception de canevas avec IBM Rational Team Concert en tant que source de données

Les concepteurs de rapport peuvent utiliser Document Studio pour importer des schémas de source de données et générer des canevas de rapport.

Avant de commencer

Conseil : L'installation de Rational Publishing Engine inclut un ensemble d'exemples de rapport. Avant de commencer à publier des documents, vous pouvez explorer cet exemple de scénario de génération de documents. Voir Création de l'exemple de canevas REST.
Familiarisez-vous avec le service REST de Rational Team Concert et les diverses URL requises pour extraire les données de Rational Team Concert lorsque vous utilisez Rational Publishing Engine. Voir Reportable REST API wiki: Resources provided by Rational Team Concert.
L'API REST rapportable de Rational Team Concert est différente de la plupart des API de domaine classiques. Au lieu de fournir des URL de ressource pointant vers des éléments spécifiques, tels qu'un élément de travail unique ou un résultat de génération unique, l'API REST rapportable offre accès à cinq ressources monolithiques. Chaque ressource monolithique est une ressource de conteneur qui représente le résultat d'une requête pour un ou plusieurs éléments.
  • foundation : artefacts communs tels que des zones de projet, des zones d'équipe, des contributeurs, des itérations et des liens.
  • workitem : artefacts d'élément de travail, tels que des récapitulatifs, des catégories, des gravités et des priorités.
  • apt : artefacts de planification agile, tels que la capacité d'équipe, les plannings de ressources et les absences.
  • generic: artefacts génériques.
  • build : artefacts de génération, tels que des résultats de génération, des contributions de résultat de génération, des définitions de génération et des moteurs de génération.
  • scm : artefacts de contrôle des sources, tels que des flux et des composants, ainsi que des deltas de définition de taille de flux.
Ces ressources offrent une certaine spuplesse en termes de filtrage et d'interrogation lors de la collecte des données pour un rapport. Par exemple, une ressource élément de travail peut contenir un ou plusieurs éléments liés aux éléments de travail, en fonction de la requête ou du filtre transmis à l'API REST.

Pourquoi et quand exécuter cette tâche

Les données sont extraites à l'aide de l'API REST. Cette interface est installée et implémentée avec l'application de source de données et elle fonctionne indépendamment de Rational Publishing Engine. Pour plus d'informations sur l'API REST d'une source de données, consultez la documentation de cette source de données.

Procédure

  1. Pour un aperçu du processus de développement de canevas, voir Conception de canevas de document. Commencez à planifier la structure de votre document et les données qui pourraient y être incluses. Par exemple, déterminez si le document final sera généré à partir d'un ou de plusieurs fichiers de canevas contenant chacun des éléments de contenu réutilisables.
  2. Dans l'application Document Studio, créez un canevas de document.
  3. Ajoutez un schéma de source de données à votre canevas de document. Pour Rational Team Concert, vous pouvez reconnaître le schéma de source de données en entrant l'URL de base de l'application.
    1. Dans Document Studio, cliquez sur Données > Ajouter un schéma de source de données.
    2. Dans Type de schéma, sélectionnez le type du schéma dans la liste. Pour Rational Team Concert, sélectionnez REST.
    3. Dans la zone Fichier de schéma, collez l'URL que vous avez identifiée comme schéma de source de données.
      • https://server:port/ccm/rpt/repository/foundation
      • https://server:port/ccm/rpt/repository/workitem
      • https://server:port/ccm/rpt/repository/apt
      • https://server:port/ccm/rpt/repository/generic
      • https://server:port/ccm/rpt/repository/scm
      • https://server:port/ccm/rpt/repository/build
    4. Ajoutez ?metadata=schema à la fin de l'URL.
      • Exemple : https://server:port/ccm/rpt/repository/workitem?metadata=schema
    5. Dans la zone ID de source de données, entrez un nom pour la source de données dans le canevas. Cliquez sur Suivant.
    6. Si la ressource se trouve sur un serveur sécurisé, indiquez le nom de l'Utilisateur.
    7. Si la ressource se trouve sur un serveur sécurisé, indiquez le Mot de passe.
    8. Sélectionnez le Type d'authentification dans la liste. Pour Rational Team Concert, le type d'authentification est OAuth. Si vous ne sélectionnez pas OAuth, chaque type d'authentification est testé jusqu'à ce que le type correct soit trouvé, ce qui peut accroître la durée de génération de document.
    9. Cliquez sur Terminer. Le schéma de source de données que vous avez sélectionné s'affiche dans la vue Schéma de source de données.
  4. Ajoutez des éléments au canevas. Rational Publishing Engine contient un ensemble complet d'éléments de canevas que vous pouvez utiliser pour structurer votre document. Vous pouvez faire glisser des éléments dans l'éditeur de contenu de canevas. Par exemple, vous pouvez ajouter un élément Conteneur qui contiendra plusieurs paragraphes. Chaque paragraphe peut être contrôlé par une condition de test qui ne l'associe qu'à des données spécifiques. Pour plus d'informations, voir Eléments de canevas dans la vue Palette et Ajout d'éléments à un canevas.
  5. Utilisez des requêtes, des attributs et des variables pour ajouter des données à un canevas. Ces éléments précisent les éléments d'informations générés dans le rapport.
  6. Ajoutez un formatage et du style aux éléments afin de contrôler leur mode d'affichage dans la sortie.
  7. Créez des filtres afin d'affiner les données qui sont extraites et placées dans le rapport. Vous pouvez utiliser des filtres, qui sont des versions détaillées de l'identificateur URI de source de données générale, pour pointer vers des sous-ensembles spécifiques de données, de sorte que Rational Publishing Engine ne tente pas d'extraire plus d'informations que nécessaire de la source de données lors de la génération de rapport. Ces filtres doivent être suffisamment larges pour extraire toutes les données nécessaires référencées par le canevas. Sinon, le rapport généré ne peut pas inclure de données complètes. Rational Team Concert prend en charge l'utilisation des sources de données Rest v1 rapportables dans les filtres natifs. Pour plus d'informations, voir API REST rapportable sur Jazz.net. Exemple :
    [projectArea/name="JKESample"]/*
    Demande résolue :
    https://server:port/ccm/rpt/repository/workitem?fields=workitem/workItem[projectArea/name="JKESample"]/(@href|summary)
    Remarque : Les zones ne peuvent pas toutes être utilisées pour le filtrage natif.
  8. Créez des tris afin d'organiser les données dans votre rapport.

Retour d'informations