Conception de canevas avec Rational Quality Manager 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 Quality Manager et les diverses URL requises pour extraire les données de Rational Quality Manager à l'aide de Rational Publishing Engine. Voir la documentation de l'API REST de Rational Quality Manager.

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. Identifiez un schéma de source de données de votre source de données.
    • Pour ajouter des éléments de données spécifiques à partir d'une collection, par exemple des détails de scénario de test ou des scripts de test, à partir de votre projet Rational Quality Manager ou pour accéder à une ressource unique dont l'URL est connue, créez une URL qui utilise l'argument feed. Vous utilisez toujours ce schéma et le configurez dynamiquement pour des éléments de données spécifiques de votre canevas de votre projet Rational Quality Manager.
      • Exemple : https://serveur:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
    • Pour ajouter des éléments de données spécifiques à partir d'une ressource individuelle, par exemple des détails de scénario de test ou des scripts de test, à partir de votre projet Rational Quality Manager ou pour accéder à une ressource unique dont l'URL est connue, créez une URL qui utilise l'argument qm :
      • Exemple : https://serveur:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
    • Si vous utilisez les API REST v2 pour générer le document, vous devez fournir une URL de schéma de source de données source au fournisseur de service plutôt qu'à l'entrée racine. Exemple :
      • Incorrect : https://serveur:port/qm/oslc_qm/catalog
      • Correct : https://serveur:port/qm/oslc_qm/catalog/référentiel/db/référentiel_schéma/
  4. Ajoutez un schéma de source de données à votre canevas de document. Pour Rational Quality Manager, vous pouvez effectuer les étapes suivantes :
    1. Dans Document Studio, cliquez sur Données > Ajouter un schéma de source de données.
    2. Dans la zone Prédéfinies, sélectionnez l'un des schémas RQM :
    3. Dans Type, sélectionnez le type de schéma dans la liste. Pour Rational Quality Manager, sélectionnez XML générique.
    4. Editez la zone Schéma si nécessaire ou cliquez sur Parcourir pour sélectionner le chemin d'accès au fichier de schéma.
    5. Ajoutez ?abbreviate=false à la fin de l'URL.
      • Exemple : https://serveur:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE Banking (Quality Management)/testcase?abbreviate=false
    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 Quality Manager, vous pouvez utiliser les types d'authentification Form, Basic et OAuth.
  5. 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.
  6. 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.
  7. Ajoutez un formatage et du style aux éléments afin de contrôler leur mode d'affichage dans la sortie.
  8. 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. Voir Rational Quality Manager Reportable REST API pour plus d'informations.
  9. Créez des tris afin d'organiser les données dans votre rapport.

Retour d'informations