Un canevas de document définit la structure, la présentation et le contenu d'un rapport. La création d'un canevas correct requiert la planification, le développement, le test et
le stockage du canevas.
1 : Collecte des exigences
Les conceptions
varient en fonction des besoins. Déterminez les besoins métier et exigences pratiques du
document avant de commencer à concevoir vos canevas.
- Eléments de données
- Divers éléments de canevas affiche différents types d'informations. Quelles
informations sont requises par la ou les personnes qui consulteront le
document ? Une fois que vous le savez, vous pouvez commencer à déterminer les éléments de
données :
- Quels éléments de données affichent ces données ? A quoi ressembleront-elles dans le
document final ?
- Existe-t-il plusieurs manières d'afficher les informations ? Si oui,
laquelle convient le mieux au contexte dans lequel le document
sera visualisé ?
- Quelle quantité de données est nécessaire ? Il se peut que vous puissiez écarter les
données inutiles, ce qui peut vous faire gagner du temps lors de la génération de la
sortie du rapport.
- Type de résultat
- Déterminez le type de sortie qui satisfera le mieux les besoins des personnes
qui consulteront le document. Le canevas que vous concevez peut se présenter de manière différente
lorsqu'il est généré dans des types de sortie différents. Certains éléments
sont optimisés pour être affichés dans un format particulier, tandis que d'autres ne
sont pas pris en charge dans certains formats. Familiarisez-vous avec la manière dont les
éléments de canevas sont affichés dans les différents formats de sortie. Cela vous
permet de sélectionner les éléments et le type de sortie qui fonctionnent le mieux
ensemble.
- Un canevas ou plusieurs canevas
- S'agit-il d'un canevas à utilisation unique ou pouvez-vous en réutiliser
certaines portions dans d'autres canevas ?
- Un canevas : vous pouvez utiliser un canevas qui contiendra toutes les différentes
portions de la conception de document. Cela signifie que tout se trouve dans un même
emplacement et qu'aucune fusion n'est requise.
- Plusieurs canevas : vous pouvez utiliser une approche modulaire et créer plusieurs
canevas qui pourront ensuite être fusionnés pour créer un document complet.
Par exemple, vous pouvez avoir un canevas de table des matières, un canevas de
page de garde avant, un canevas de données, un canevas d'index et un canevas de page de
garde arrière. Ces canevas peuvent être réutilisés lors de la génération de documents
différents.
Déterminez le nombre de canevas requis en fonction de ces exigences.
Vous pouvez nommer et décrire chaque bloc de canevas dans les attributs des métadonnées.
Le contenu du nom s'affiche dans le canevas et le contenu de la description,
dans la zone de suggestion de l'élément de canevas.
- Affichage du contexte
- Comment ce document sera-t-il visualisé ?
- Sera-t-il imprimé ? Affiché à l'écran ? Les deux ?
- Sera-t-il exécuté dans un produit intégré ?
Prise en charge de concepts
2 : Conception d'un canevas
Lors de la conception
d'un canevas, les tactiques ci-après peuvent vous aider à utiliser votre temps de manière
efficace.
- Implémentez la structure générale du canevas à l'aide d'une approche descendante. Commencez
par les éléments les plus généraux, puis entrez dans les détails de manière
incrémentielle.
- Validez la génération de données avant de vous concentrez sur les détails du formatage.
Si vous passez beaucoup de temps sur le formatage, puis découvrez que vos données ne sont
pas générées correctement, il se peut que vous deviez recommencer le formatage. Voir 3. Test du canevas pour plus de détails.
- Affinez les détails et ajoutez les exigences plus détaillées une par
une.
Laissez les détails moins importants ou plus difficiles pour les implémenter plus
tard.
Etudiez la pertinence des exigences difficiles à satisfaire, comme vous le
feriez dans une analyse coûts/avantages.
- Pensez également à utiliser des scripts pour extraire des informations dans un format que Rational
Publishing Engine peut utiliser efficacement.
- Un canevas peut être conçu pour fournir des propriétés de présentation de page
spécifiques, telles que la taille de page, l'orientation, les marges, le nombre de
colonnes et les styles des types de paragraphe qui seront probablement utilisés dans des
documents.
- Un canevas peut contenir :
- Les éléments de structure des documents, tels que les paragraphes, les tables,
les listes et une table des matières.
- Les blocs de présentation des documents, tels que les pages originales, les feuilles
de style, les en-têtes et les bas de page.
- Les styles définis par l'utilisateur internes et externes, tels que du
formatage de texte ou de paragraphe. Le formatage de texte inclut le gras, l'italique,
le souligné, la taille de police et la couleur de police. Le formatage de paragraphe inclut les marges, les bordures, les retraits et le scriptage des paramètres JavaScript.
- Le contenu de canevas imbriqué, tel que les images, le texte statique et les
références à des fichiers statiques et des feuilles de style.
- Les éléments de données, tels que les attributs, les conditions et les éléments
de données dynamiques.
- L'extraction de données sous forme de requêtes et de filtres.
- Les variables externes qui reçoivent des valeurs lors de la phase d'exécution et les
variables internes utilisées pour les calculs. La création de
variables externes est préférable au codage en dur des URL de source de données dans votre
canevas. Si vous codez en dur des URL et que le nom du serveur est modifié, vous devez
mettre à jour les URL dans tous les canevas. Avec les variables externes,
vous pouvez remplacer les URL lors de la phase d'exécution. Pour les canevas imbriqués
dans d'autres produits, utilisez les variables spéciales reconnues par ces produits
lorsqu'elles font référence à des données.
- Démarrez Document Studio.
- Créez un canevas intégralement ou en vous basant sur un canevas
existant.
- Ajoutez le schéma de source de données.
- Ajoutez des éléments.
- Ajoutez un formatage aux éléments.
- Définissez le contenu dynamique.
- Facultatif : Affinez les données avec des filtres, des tris ou des conditions.
3: Testez le canevas
- Le test est effectué de manière incrémentielle lors du développement. Effectuez
souvent des sauvegardes et utilisez des noms uniques lors de vos sauvegardes. Vérifiez
fréquemment la sortie à l'aide d'un petit ensemble de données de test. N'ajoutez pas plus
d'éléments tant que ce que vous avez déjà ne fonctionne pas.
- Une fois que vous avez développé la plus grande partie du document,
effectuez des tests de charge pour vérifier les problèmes de performances. Utilisez
l'outil de prévisualisation pour limiter la taille des données utilisées. Le rapport
généré est toujours précis, mais son exécution est plus rapide car le nombre maximal
d'enregistrements par requête par défaut que Rational
Publishing Engine
extrait est de 10 enregistrements. Lorsque vous testez les conditions, il se peut
qu'aucun enregistrement parmi les 10 premiers ne satisfasse la condition. Dans ce cas,
utilisez l'outil Exécuter au lieu de l'outil de prévisualisation ou modifiez la valeur
du nombre maximal d'enregistrements par requête dans les préférences.
- Testez le canevas dans différents formats de sortie. Il se peut que vous constatiez
qu'un type de sortie n'affiche pas votre canevas aussi bien qu'un autre type de sortie.
- Exécutez l'outil de vérification :
- Générez un aperçu.
Tâche de prise en charge :
4 : Stockez le canevas
- Sauvegardez les canevas développés et testés sur un serveur de fichiers centralisé.
Vous pouvez utiliser le composant Gestion centralisée comme emplacement de stockage.
- Veillez à bien fournir des informations dans les métadonnées du canevas pour permettre aux
autres utilisateurs de savoir comment réutiliser le canevas. Des exemples de données et
des exemples d'informations sur les spécifications de document pour les données du projet
facilitent la réutilisation de ces canevas.
Etapes suivantes
Une fois que vous avez créé et testé
les canevas :