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
- 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.
- Dans l'application Document Studio,
créez un canevas de document.
- 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://server: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://server: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://server:port/qm/oslc_qm/catalog
- Correct : https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
- Ajoutez un schéma de source de données à votre canevas de document. Pour Rational Quality
Manager,
vous pouvez effectuer les étapes suivantes :
- Dans Document Studio, cliquez sur .
- Dans Type de schéma, sélectionnez le type
du schéma dans la liste. Pour Rational Quality
Manager,
sélectionnez XML générique.
- Dans la zone Fichier de schéma, collez
l'URL que vous avez identifiée comme schéma de source de données.
- Ajoutez ?abbreviate=false à la fin de l'URL.
- Exemple : https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE
Banking (Quality Management)/testcase?abbreviate=false
- Dans la zone ID de source de données,
entrez un nom pour la source de données dans le canevas. Cliquez sur Suivant.
- Si la ressource se trouve sur un serveur sécurisé, indiquez le nom de l'Utilisateur.
- Si la ressource se trouve sur un serveur sécurisé, indiquez le Mot de passe.
- Sélectionnez le Type d'authentification dans la liste. Pour Rational Quality
Manager,
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 docment.
- 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.
- 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.
- Ajoutez un formatage et du style aux
éléments afin de contrôler leur mode d'affichage dans la sortie.
- 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.
- Créez des tris afin d'organiser les données dans votre rapport.