Conception de canevas avec Rational ClearQuest 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 ClearQuest et les diverses URL requises pour extraire les données de Rational ClearQuest à l'aide de Rational Publishing Engine. Voir About the Rational ClearQuest information center.

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 ClearQuest, vous pouvez reconnaître le schéma de source de données en entrant l'URL de base de l'application.
    1. Ouvrez l'assistant de reconnaissance de schéma qui s'applique à votre version de Rational ClearQuest
      • Pour les versions antérieures de Rational ClearQuest qui utilisent REST v1, cliquez sur Data > Reconnaissance de schéma > Reconnaissance de schéma REST.
      • Pour les versions les plus récentes de Rational ClearQuest qui utilisent REST v2, cliquez sur Data > Reconnaissance de schéma > Reconnaissance de schéma REST v2.
    2. Spécifiez l'URL de base pour la ressource.
      • Pour les versions REST v1 de Rational ClearQuest, Rational Publishing Engine utilise Rational Data Services pour reconnaître les données de schéma et de requête. L'URL de base d'accès à Data Services est : https://server:port/DataServices/ClearQuest
      • Pour les versions REST v2 de Rational ClearQuest, démarre à partir d'une URL ServiceProvider. Les utilisateurs peuvent obtenir l'URL ServiceProvider en accédant à l'URL ServiceCatalog de Rational ClearQuest REST v2 (par exemple, https://serveur:port/context/oslc). Spécifiez 2.0 pour les en-têtes HTTP OSLC-Core-Version et application/rdf+xml pour les en-têtes Accept. Dans le résultat renvoyé, vous pouvez rechercher l'URL ServiceProvider rdf:about.
        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://server:port/cqweb/oslc
        • Correct : https://server:port/cqweb/oslc/repo/repository/db/schema_repository/
    3. Sélectionnez un Type d'authentification dans la liste. Si vous ne sélectionnez pas de type, chaque type est testé jusqu'à ce que le type correct soit trouvé, ce qui peut accroître la durée de génération de docment.
    4. Si la ressource se trouve sur un serveur sécurisé, indiquez le nom de l'Utilisateur.
    5. Si la ressource se trouve sur un serveur sécurisé, indiquez le Mot de passe.
    6. Cliquez sur Suivant . L'URL de base que vous avez entrée est automatiquement ajoutée à ?metadata=schema. Exemple : https://server:port/service/cq/records/defects?metadata=schema
    7. 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.

    L'adaptateur Rational ClearQuest prend en charge les filtres natifs des sources de données Rest v1 rapportables. Dans les filtres natifs Rest v1 rapportables, vous devez simplement entrer le texte entre crochets []. Le reste du filtre est généré par Rational Publishing Engine. Pour plus d'informations, voir Reportable Rest v1.

    Rational ClearQuest version 8 sans adaptateur prend en charge le filtrage natif des sources de données Rest v2 rapportables. Pour plus d'informations, voir Rational ClearQuest OSLC CM REST API .

    Exemple de filtre variable :
    cq:Product{cq:Product="${productName}") 
    Exemple de filtre résolu où productName correspond à Rational Publishing Engine :
    cq:Product{cq:Product="Rational Publishing Engine")
    Remarque :
    • Les demandes ne sont envoyées à une source de données que si nécessaire. Par exemple, vous pouvez utiliser des conditions pour qu'un élément ne s'affiche dans la sortie que s'il contient des données. La condition sur un élément de conteneur peut être variable == "true". Si cette condition n'est pas satisfaite et qu'aucune donnée ne remplit la condition variable, aucune demande n'est envoyée à la source de données.
    • Vous pouvez déterminer les filtres natifs avant de créer la demande. Le filtre natif est calculé là où la requête est rencontrée et il utilise les valeurs de variable à cet endroit. Cela signifie que vous pouvez effectuer des calculs dans le canevas, ce qui a un impact sur les filtres natifs.
  8. Créez des tris afin d'organiser les données dans votre rapport.

Retour d'informations