sybase powerdesigner report guide

146
Sybase ® PowerDesigner ® Reports User's Guide Version 11.0 DC38091-01-1100-01 Last modified: November 2004

Upload: rene-gonzalez-bravo

Post on 12-Apr-2015

151 views

Category:

Documents


20 download

TRANSCRIPT

Page 1: Sybase PowerDesigner Report Guide

Sybase®

PowerDesigner®

Reports

User's Guide

Version 11.0DC38091-01-1100-01

Last modified: November 2004

Page 2: Sybase PowerDesigner Report Guide

Copyright © 1991-2004 Sybase, Inc. All rights reserved.Information in this manual may change without notice and does not represent a commitment on the part of Sybase, Inc. and itssubsidiaries.Sybase, Inc. provides the software described in this manual under a Sybase License Agreement. The software may be used only inaccordance with the terms of the agreement.No part of this publication may be reproduced, transmitted, or translated in any form or by any means, electronic, mechanical, manual,optical, or otherwise, without the prior written permission of Sybase, Inc.Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of DFARS 52.227-7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for civilian agencies.

Sybase, SYBASE (logo), ADA Workbench, Adaptable Windowing Environment, Adaptive Component Architecture, Adaptive Server,Adaptive Server Anywhere, Adaptive Server Enterprise, Adaptive Server Enterprise Monitor, Adaptive Server Enterprise Replication,Adaptive Server Everywhere, Afaria, AppModeler, APT Workbench, APTBuild, APT-Edit, APT-Execute, APT-Translator, APT-Library, ASEP, AvantGo, AvantGo Application Alerts, AvantGo Mobile Document Viewer, AvantGo Mobile Delivery, AvantGoMobile Inspection, AvantGo Mobile Marketing Channel, AvantGo Mobile Pharma, AvantGo Mobile Sales, AvantGo Pylon, AvantGoPylon Application Server, AvantGo Pylon Conduit, AvantGo Pylon PIM Server, AvantGo Pylon Pro, Backup Server, BayCam, Bit-Wise, BizTracker, Certified PowerBuilder Developer, Certified SYBASE Professional, Certified SYBASE Professional Logo,ClearConnect, Client-Library, Client Services, CodeBank, Column Design, ComponentPack, Connection Manager, Convoy/DM,Copernicus, CSP, Data Pipeline, Data Workbench, DataArchitect, Database Analyzer, DataExpress, DataServer, DataWindow, DB-Library, dbQueue, Developers Workbench, Direct Connect Anywhere, DirectConnect, Distribution Director, Dynamic Mobility Model,e-ADK, E-Anywhere, e-Biz Integrator, E-Whatever, EC Gateway, ECMAP, ECRTP, eFulfillment Accelerator, Electronic CaseManagement, Embedded SQL, EMS, Enterprise Application Studio, Enterprise Client/Server, Enterprise Connect, Enterprise DataStudio, Enterprise Manager, Enterprise Portal (logo), Enterprise SQL Server Manager, Enterprise Work Architecture, Enterprise WorkDesigner, Enterprise Work Modeler, eProcurement Accelerator, eremote, Everything Works Better When Everything Works Together,EWA, Financial Fusion, Financial Fusion (and design), Financial Fusion Server, Formula One, Fusion Powered e-Finance, FusionPowered Financial Destinations, Fusion Powered STP, Gateway Manager, GeoPoint, GlobalFIX, iAnywhere, iAnywhere Solutions,ImpactNow, Industry Warehouse Studio, InfoMaker, Information Anywhere, Information Everywhere, InformationConnect, InstaHelp,Intelligent Self-Care, InternetBuilder, iremote, iScript, Jaguar CTS, jConnect for JDBC, KnowledgeBase, Logical Memory Manager,M-Business Channel, MBusiness Network, M-Business Server, Mail Anywhere Studio, MainframeConnect, Maintenance Express,Manage Anywhere Studio, MAP, MDI Access Server, MDI Database Gateway, media.splash, Message Anywhere Server, MetaWorks,MethodSet, ML Query, MobiCATS, My AvantGo, My AvantGo Media Channel, My AvantGo Mobile Marketing, MySupport, Net-Gateway, Net-Library, New Era of Networks, Next Generation Learning, Next Generation Learning Studio, O DEVICE, OASiS,OASiS logo, ObjectConnect, ObjectCycle, OmniConnect, OmniSQL Access Module, OmniSQL Toolkit, Open Biz, Open BusinessInterchange, Open Client, Open ClientConnect, Open Client/Server, Open Client/Server Interfaces, Open Gateway, Open Server, OpenServerConnect, Open Solutions, Optima++, Orchestration Studio, Partnerships that Work, PB-Gen, PC APT Execute, PC DB-Net, PCNet Library, PhysicalArchitect, Pocket PowerBuilder, PocketBuilder, Power++, Power Through Knowledge, power.stop, PowerAMC,PowerBuilder, PowerBuilder Foundation Class Library, PowerDesigner, PowerDimensions, PowerDynamo, Powering the NewEconomy, PowerScript, PowerSite, PowerSocket, Powersoft, PowerStage, PowerStudio, PowerTips, Powersoft Portfolio, PowersoftProfessional, PowerWare Desktop, PowerWare Enterprise, ProcessAnalyst, QAnywhere, Rapport, Relational Beans, RemoteWare,RepConnector, Report Workbench, Report-Execute, Replication Agent, Replication Driver, Replication Server, Replication ServerManager, Replication Toolkit, Resource Manager, RW-DisplayLib, RW-Library, SAFE, SAFE/PRO, SDF, Secure SQL Server, SecureSQL Toolset, Security Guardian, SKILS, smart.partners, smart.parts, smart.script, SQL Advantage, SQL Anywhere, SQL AnywhereStudio, SQL Code Checker, SQL Debug, SQL Edit, SQL Edit/TPU, SQL Everywhere, SQL Modeler, SQL Remote, SQL Server, SQLServer Manager, SQL SMART, SQL Toolset, SQL Server/CFT, SQL Server/DBM, SQL Server SNMP SubAgent, SQL Station, SQLJ,Stage III Engineering, Startup.Com, STEP, SupportNow, S.W.I.F.T. Message Format Libraries, Sybase Central, Sybase Client/ServerInterfaces, Sybase Development Framework, Sybase Financial Server, Sybase Gateways, Sybase IQ, Sybase Learning Connection,Sybase MPP, Sybase SQL Desktop, Sybase SQL Lifecycle, Sybase SQL Workgroup, Sybase Synergy Program, Sybase Virtual ServerArchitecture, Sybase User Workbench, SybaseWare, Syber Financial, SyberAssist, SybFlex, SybMD, SyBooks, System 10, System 11,System XI (logo), SystemTools, Tabular Data Stream, The Enterprise Client/Server Company, The Extensible Software Platform, TheFuture Is Wide Open, The Learning Connection, The Model For Client/Server Solutions, The Online Information Center, The Power ofOne, TotalFix, TradeForce, Transact-SQL, Translation Toolkit, Turning Imagination Into Reality, UltraLite, UltraLite.NET, UNIBOM,Unilib, Uninull, Unisep, Unistring, URK Runtime Kit for UniCode, Viewer, VisualWriter, VQL, WarehouseArchitect, WarehouseControl Center, Warehouse Studio, Warehouse WORKS, Watcom, Watcom SQL, Watcom SQL Server, Web Deployment Kit,Web.PB, Web.SQL, WebSights, WebViewer, WorkGroup SQL Server, XA-Library, XA-Server, XcelleNet, and XP Server aretrademarks of Sybase, Inc. or its subsidiaries.

All other trademarks are property of their respective owners.

Page 3: Sybase PowerDesigner Report Guide

Reports User's Guide iii

Contents

About This Book ...........................................................................................vii

1 Using the Report Editors ...................................................1What is a report? ...................................................................... 2Introducing the Report Editors .................................................. 3Using the Report Template Editor ............................................ 4

Opening the Report Template Editor.................................. 4Standard report templates.................................................. 6Creating a report template.................................................. 7Modifying a template ........................................................ 10Closing the Report Template Editor ................................. 12

Using the Report Editor........................................................... 13Opening the Report Editor................................................ 13Displaying the Report toolbar ........................................... 15Creating a report .............................................................. 17Previewing a report from the Report Editor ...................... 18Printing a report from the Report Editor ........................... 19Generating an RTF or HTML file from the Report Editor . 19Closing the Report Editor from a model ........................... 20Closing the Multi-Model Report Editor.............................. 21

Organizing the Report Editor .................................................. 22Creating a report section .................................................. 22Creating a template from a report section........................ 26Modifying the structure of a report section ....................... 28Reapplying the template default values to a reportsection .............................................................................. 28Renaming a report section ............................................... 30Deleting a report section .................................................. 32

Using the Report Language Editor.......................................... 34Understanding the Report Language Editor..................... 34Opening the Report Language Editor............................... 37Translating a report language resource file...................... 38Attaching a language resource file to a report.................. 46

Page 4: Sybase PowerDesigner Report Guide

iv PowerDesigner

2 Managing a Model Report ...............................................49Using a report template for a model report............................. 50Creating a model report .......................................................... 51Generating a model report...................................................... 54Modifying a model report ........................................................ 56Saving a model report............................................................. 58

3 Managing a Multi-Model Report ......................................59Using a report template for a multi-model report .................... 60Creating a multi-model report ................................................. 61Generating a multi-model report ............................................. 64Modifying a multi-model report ............................................... 66Saving a multi-model report.................................................... 68

4 Building Reports ..............................................................69Managing report items ............................................................ 70

Adding items to a report ................................................... 70Adding nodes to a report .................................................. 72Modifying the collection of a node .................................... 73Inserting a table of contents ............................................. 74Inserting a text paragraph ................................................ 74Inserting a text file or a graphical file................................ 75Inserting graphs................................................................ 76Repositioning an item....................................................... 76Changing the depth level of an item................................. 77Copying an item in a report .............................................. 78Deleting an item from a report.......................................... 78Making a global object selection for the report................. 78Refining the report object selection.................................. 81

Using nodes............................................................................ 86Node dependency ............................................................ 87Using node titles............................................................... 88Modifying a node title........................................................ 88

Using items ............................................................................. 91Model-dependent items.................................................... 91Object-dependent items ................................................... 91Independent items............................................................ 93

Formatting items..................................................................... 94Defining global format for an item .................................... 94Formatting individual items .............................................. 95Defining a default report font............................................ 95Selecting text to format .................................................... 96Selecting a font................................................................. 99Formatting a paragraph.................................................. 101Selecting border format.................................................. 102

Page 5: Sybase PowerDesigner Report Guide

Reports User's Guide v

Selecting tab spacing format .......................................... 104Editing text...................................................................... 106Formatting a graph......................................................... 106Formatting a list item...................................................... 108Selecting information to display in a card....................... 110

Setting up report pages......................................................... 112Modifying a report header or footer ................................ 112Including a title page....................................................... 116Removing the title of an item.......................................... 117Modifying report properties............................................. 119Customizing an HTML report ......................................... 120

Using print preview ............................................................... 127Opening print preview..................................................... 127Navigating in print preview ............................................. 128Finding an object in print preview................................... 128Zooming in print preview ................................................ 130Printing a report from print preview ................................ 130Generating an RTF or HTML file from print preview ...... 130Closing print preview ...................................................... 130

Index .........................................................................................131

Page 6: Sybase PowerDesigner Report Guide

vi PowerDesigner

Page 7: Sybase PowerDesigner Report Guide

Reports User's Guide vii

About This Book

This book describes the creation and generation of reports in PowerDesigner.It shows you how to do the following:

♦ Build and generate model reports in various languages

♦ Build and generate multi-model reports in various languages

This book is for anyone who will be building reports with PowerDesigner.

The PowerDesigner modeling environment supports several types of models:

♦ Conceptual Data Model (CDM) to model the overall logical structureof a database, independent from any software or data storage structureconsiderations

♦ Physical Data Model (PDM) to model the overall physical structure ofa database, taking into account DBMS software or data storage structureconsiderations

♦ Object Oriented Model (OOM) to model a software system using anobject-oriented approach for Java or other object languages

♦ Business Process Model (BPM) to model the means by which one ormore processes are accomplished in operating business practices

♦ XML Model (XSM) to model the structure of an XML file using a DTDor an XML schema

♦ Requirements Model (RQM) to list and document the customer needsthat must be satisfied during a development process

♦ Information Liquidity Model (ILM) to model the replication ofinformation from a source database to one or several remote databasesusing replication engines

♦ Free Model (FEM) to create any kind of chart diagram, in a context-free environment

Subject

Audience

Documentationprimer

Page 8: Sybase PowerDesigner Report Guide

About This Book

viii PowerDesigner

This book only explains the creation and generation of reports inPowerDesigner. For information on models or other aspects ofPowerDesigner, consult the following books:

General Features Guide To get familiar with the PowerDesignerinterface before learning how to use any of the models.

Conceptual Data Model Getting Started To learn the basics of theCDM.

Conceptual Data Model User’s Guide To work with the CDM.

Physical Data Model Getting Started To learn the basics of the PDM.

Physical Data Model User’s Guide To work with the PDM.

Object Oriented Model Getting Started To learn the basics of theOOM.

Object Oriented Model User's Guide To work with the OOM.

Business Process Model Getting Started To learn the basics of theBPM.

Business Process Model User's Guide To work with the BPM.

XML Model User's Guide To work with an XSM.

Requirements Model User’s Guide To work with the RQM.

Information Liquidity Model User’s Guide To work with the ILM.

Repository Getting Started To learn the basics of the Repository.

Repository User’s Guide To work in a multi-user environment using acentral repository.

PowerDesigner documentation uses specific typefaces to help you readilyidentify specific items:

♦ monospace text (normal and bold)Used for: Code samples, commands, compiled functions and files,references to variables.Example: declare user_defined…, theBeforeInsertTrigger template.

♦ UPPER CASEObject codes, reversed objects, file names + extension.

Typographicconventions

Page 9: Sybase PowerDesigner Report Guide

About This Book

ix

Example: The AUTHOR table appears in the Browser. Open the fileOOMAFTER.OOM.

♦ bold textAny new term.Example: A shortcut has a target object.

♦ SMALL CAPS

Any key name.Example: Press the ENTER key.

Page 10: Sybase PowerDesigner Report Guide

About This Book

x PowerDesigner

Page 11: Sybase PowerDesigner Report Guide

Reports User's Guide 1

C H A P T E R 1

Using the Report Editors

This chapter describes what is a report and the use of the Report TemplateEditor to create and edit templates, the use of the Report Editor and theMulti-Model Report Editor to create and edit reports for one or severalmodels. It also describes how to use the Report Language Editor to createand edit report language resource files.

Topic Page

What is a report? 2

Introducing the Report Editors 3

Using the Report Template Editor 4

Using the Report Editor 13

Organizing the Report Editor 22

Using the Report Language Editor 34

About this chapter

Contents

Page 12: Sybase PowerDesigner Report Guide

What is a report?

2 PowerDesigner

What is a report?A report allows you to publish valuable information about one model (modelreport) or several models (multi-model report) using different outputs. Youcan print a report in order to have it on a paper support, or you can generate itin RTF or HTML format for better reusability.

PowerDesigner manages a structured representation of the report using a treeview format. You define a report by selecting items in the Available Itemspane (left pane) and insert them in the Report Items pane (right pane). Eachitem you add in your report can be formatted individually. The items you useto create your report structure are part of a stored list of items. You generatethe created structure from the design objects of your model.

You use the Report Editor to define a model report structure. You use theMulti-Model Report Editor to define a multi-model report structure.

You can also use a predefined structure called template to help you quicklygenerate a report or save your current report structure as a template to add itto the list of available templates. You can preview your report before its finaloutput and also select the objects to generate.

The report is an easy to consult document that shows parts or the globalcontent of a model under a textual format.

Page 13: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 3

Introducing the Report EditorsThe Report Template Editor is an independent module. It allows templatecreation and modification. You can open the Report Template Editor with nomodel attached to it.

A report template is an independent and reusable file saved on your harddisk, which indicates what information to include in your report.

You can create this file to generate model reports or multi-model reports(several models in the same report).

You use the Report Editor to define a report structure in order to generate areport for a single model.

A model report is the association of a model, a report structure and aselection of objects. It graphically reflects the structure of a model.

You generate a model report to document a particular model and analyze itscontents.

You use the Multi-Model Report Editor to define a report structure in orderto generate a multi-model report.

A multi-model report is the association of several models to several reportstructures and several selections of objects. It is the graphical representationof the structure of several models.

You generate a multi-model report when you want to have a clear overviewof several models in the same report. You can see for example to which table(physical data) corresponds an entity (conceptual data).

The Report Editor and the Multi-Model Report Editor have their ownrespective windows but share the same graphical interface.

The title bar indicates which editor you are using.

Since both Editors share the same features, the term Report Editor is used inthis manual when specifying is not required.

The Report Language Editor is an independent module. You can open itwithout any model opened in the workspace. It allows you to create andmodify language resource files for reports. Language resource files can beattached to reports in order to generate reports in any other languages thanEnglish.

Report TemplateEditor

Report Editor

Multi-Model ReportEditor

Report LanguageEditor

Page 14: Sybase PowerDesigner Report Guide

Using the Report Template Editor

4 PowerDesigner

Using the Report Template EditorYou use the Report Template Editor to build report templates.

With the Report Template Editor, you can:

♦ Create a template

♦ Modify a template

♦ Save a template in a .RTP file

Opening the Report Template Editor

You open the Report Template Editor when you need to create or modify areport template.

You can also create a template in the Report Editor using a report section.

For more information on how to create a template from a report sectionsee section Creating a template from a report section.

To open the Report Template Editor:

1 Select Tools→Resources→Report Templates.

The List of Report Templates appears. It displays the alphabetical list ofall the templates saved on your hard disk.

2 Select a template type in the Type dropdown listbox.

Page 15: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 5

The list of available templates corresponding to the selected typeappears. If no template is available, you can open the Report TemplateEditor by clicking the New tool to create a new template.

For more information on creating a template, see section Creating areport template.

3 Select a template.

4 Click the Properties tool.

The Report Template Editor window appears.

The Available Items pane lists all the standard items available for allreport types and the items corresponding to the type of template youhave selected.

Page 16: Sybase PowerDesigner Report Guide

Using the Report Template Editor

6 PowerDesigner

The Template Items pane lists all the items of the selected template.

Opening the List of Report Templates from the List of ReportsYou can open the List of Report Templates from the List of Reportsby selecting Model→Reports from the model diagram window. In theList of Reports, click the Manage Report Templates tool.

Standard report templates

By default PowerDesigner ships with a series of predefined structures calledtemplates.

Page 17: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 7

Standard report templates are installed in the Resource Files sub-directory ofyour PowerDesigner directory. There are three types of standard templatesfor each type of model.

Templatetype

File namingconvention* Contents of resulting report

Full modelFULlanguage.RTP Table of contentsAll main model items

Standard modelSTDlanguage.RTP Table of contentsModel graphsPackage graphsMost list items

List modelLISlanguage.RTP Title itemAll list items

* language in a filename is a two letter code for the language of the report template. Forexample, a PDM list report in English uses the template file PDMLISUS.RTP.

Creating a report template

A report template is a file that you can use to quickly generate a report. Youcan use standard templates that ship with PowerDesigner or create your owntemplates. When you create a template, you indicate what information youwant to include in the report. You can select a language to displayinformation in the desired language.

When you create a template you need to provide the following information:

Option Description

Name Name of the template

Language Language in which you want to create your template. English is thedefault language

Type Type of the model for which you create the template

To create a template:

1 Select Tools→Resources→Report Templates.

Page 18: Sybase PowerDesigner Report Guide

Using the Report Template Editor

8 PowerDesigner

The List of Report Templates appears.

2 Click the New tool.

The Report Template Type dialog box appears.

3 Type a template name in the Name box.

4 Select a language from the Language dropdown listbox. It displays theavailable languages. English is the default language in which the reportis printed.

For more information on languages in reports, see section Usingthe Report Language Editor.

5 Select a template type in the Type box.

6 Click OK.

Page 19: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 9

The Report Template Editor window appears.

7 Add items to the Template Items pane. They display in the language youselected.

For more information on adding items to the Report Items pane,see chapter Building Reports.

For more information on languages in reports, see section Usingthe Report Language Editor.

8 Select File→Save.

A Save As dialog box appears.

The name you type at creation in the Report Template Type dialog boxappears by default with an RTP extension. You can choose anothername.

9 Click Save.

The next time you create a report, you will be able to use this newtemplate that appears in the List of Report Templates.

Language in a templateWhen you use a template created in a language different from the oneyou select to create your report, only user-defined items such as Titleor Text paragraph will keep the language of the template. Other itemswill be displayed in the report language.

For more information on creating a report, see chapters Managing aModel Report and Managing a Multi-Model Report.

Page 20: Sybase PowerDesigner Report Guide

Using the Report Template Editor

10 PowerDesigner

Undo functionality not availableYou cannot use the Undo functionality in reports.

Modifying a template

You can modify an existing template and save it in an RTP file.

You can, for example, keep the global structure of a template but displayonly object lists.

You can reuse a modified template to create other reports.

To modify a template:

1 Select Tools→Resources→Report Templates.

The List of Report Templates appears.

2 Select a template type in the Type dropdown listbox.

Page 21: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 11

The list of available templates corresponding to the selected typeappears.

3 Select a template.

4 Click the Properties tool.

The template appears in the Template Items pane.

5 Modify the template in the Template Items pane.

6 Select File→Save.

Page 22: Sybase PowerDesigner Report Guide

Using the Report Template Editor

12 PowerDesigner

Renaming a templateYou can rename a template in the Template Items pane by right-clicking the Template node at the root of the tree and select Renamefrom the contextual menu.

For more information on modifying a template, see section Addingitems to a report in chapter Building Reports.

Accessing a report template from the BrowserYou can also access a report template from the Browser by right-clicking the Workspace node and in the contextual menu select Add.From the standard Open dialog box that appears, select an RTP fileand click Open. The template file appears in the Browser. You canthen open it.

Closing the Report Template Editor

Once you have modified the template, you can close the Report TemplateEditor.

To close the Report Template Editor:

1 Select File→Close.

If you did not save the changes, a confirmation box prompts you to saveyour template.

2 Click OK.

Page 23: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 13

Using the Report EditorYou use the Report Editor to build report structures. A report structureindicates what will be printed in a report.

With the Report Editor, you can create and modify the structure of a report.You can include objects from the model diagram or listed objects in a reportstructure.

The Report Editor allows you to preview and print a report and also generatea report as an RTF or HTML file.

Opening the Report Editor

You open the Report Editor when you want to create or modify a report.

You can open two types of reports:

♦ A model report

♦ A multi-model report

Opening the Report Editor from a model

You open the Report Editor from a model using the List of Reports.

From this list, you can also create, modify or delete a report. You canpreview a report, print it or generate it as RTF or HTML file.

To open the Report Editor from a model:

1 Select Model→Reports.

Page 24: Sybase PowerDesigner Report Guide

Using the Report Editor

14 PowerDesigner

The List of Reports appears. It displays the alphabetical list of all thereports saved in the model. If there are no existing reports, all the tools inthe List of Reports dialog box are grayed, except for the New Report tooland the Manage Report Templates tool.

2 Select a report.

If no report is available, you can open the Report Editor by clicking theNew tool to create a new report.

For more information on creating a model report, see chapterManaging a Model Report.

3 Click the Edit Report tool.

The structure of the selected report appears in the Report Editor window.

Opening the Report Editor from the BrowserYou can open the Report Editor from the Browser by double-clickinga report node in the Browser.

Page 25: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 15

Opening the Multi-Model Report Editor

Since multi-models reports are saved in individual files (.MMR), you openthe Multi-Model Report Editor from the Browser.

To open the Multi-Model Report Editor:

♦ Double-click a multi-model report in the Browser.

The structure of the selected multi-model report appears in the Multi-Model Report Editor window.

Multi-model report not visible in the BrowserIf there is no multi-model report visible in the Browser, right-click theWorkspace node and in the contextual menu select Add. From thestandard Open dialog box that appears, select a multi-model report(MMR) and click Open. The report appears in the Browser. You canthen open it.

For more information on creating a multi-model report, see chapterManaging a Multi-Model Report.

Displaying the Report toolbar

PowerDesigner provides a predefined Report toolbar that is designed toprovide quick access to the most commonly used commands for reportmanagement.

To display the Report toolbar:

1 Select Tools→Customize Toolbars.

The Toolbars dialog box appears.

Page 26: Sybase PowerDesigner Report Guide

Using the Report Editor

16 PowerDesigner

2 Select the Report checkbox to display the Report toolbar.

The Report toolbar appears simultaneously.

3 Click Close.

For more information on managing toolbars, see section Managingtoolbars in chapter Using the PowerDesigner Interface in the PowerDesignerGeneral Features Guide.

The following table indicates the names and actions of common tools in theReport toolbar:

Tool Name Action

Print Preview Displays a report print preview

Print Prints a report

Generate RTF Generates a report as an RTF file

Generate HTML Generates a report as an HTML file

Add Item Adds item to the Report Items pane

Up One Level Moves item up one level

Down One Level Moves item down one level

Raise Level Moves item at the same level as a node

Lower Level Moves item within a node

Page 27: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 17

Creating a report

You use the Report Editor to create model reports and the Multi-ModelEditor to create multi-model reports.

Whatever the Editor you use to create a report, you must have at least onemodel opened in the workspace and a section is automatically created bydefault.

For more information on sections, see section Organizing the ReportEditor.

When you create a model report, a Reports category appears under the Modelnode in the Browser tree view and the Report Editor window opens.

When you create a multi-model report, a Multi-Model Report node appearsunder the Workspace node in the Browser tree view and the Multi-ModelReport Editor window opens.

Page 28: Sybase PowerDesigner Report Guide

Using the Report Editor

18 PowerDesigner

You can:

♦ Print a report

♦ Generate a report as an RTF file

♦ Generate a report as an HTML file

If you use a template, you do not have to define the contents of the report.However, you can create sections and select objects from the model diagramor from a list.

For more information on selecting objects, see section Selecting objectsto include in a report in chapter Building Reports.

Previewing a report from the Report Editor

The Report Editor provides a preview feature that allows you to see whatyour report will look like once printed.

To preview a report from the Report Editor:

♦ Select File→Print Preview.orClick the Print Preview tool.

The Print Preview window displays the first page of the report.

Page 29: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 19

Previewing a report from the List of ReportsYou can also preview a report from the List of Reports by selectingModel→Reports. From the List of Reports, select the report you wantto preview and click the Print Preview tool.

Printing a report from the Report Editor

Once you have selected or customized a template for the report, you can printit from the Report Editor.

To print a report from the Report Editor:

♦ Select File→Print.orClick the Print tool.

Printing a report from the List of ReportsYou can also print a report from the List of Reports by selectingModel→Reports. From the List of Reports, select the report you wantto print and click the Print Report tool.

Generating an RTF or HTML file from the Report Editor

You can generate a report file as an RTF or HTML file (compliant withXHTML standards) from the Report Editor.

Each time you generate an HTML report and change the name of the HTMLfile, a report generation folder is created in your Windows Explorer. Itcontains all the files associated to the generated report. HTML files, imagesand style sheet files are stored in this folder for example.

The folder name is composed of the name of the HTML file followed by_files and displays as follows:

For more information on style sheet files, see section Customizing anHTML report in chapter Building a report.

HTML reportgeneration folder

Page 30: Sybase PowerDesigner Report Guide

Using the Report Editor

20 PowerDesigner

HTML reports respect the package tree view defined in your model.

To generate an RTF file from the Report Editor:

♦ Select File→Generate→RTF.orClick the Generate RTF tool.

To generate an HTML file from the Report Editor:

♦ Select File→Generate→HTML.orClick the Generate HTML tool.

Generating an HTML or RTF file from the List of ReportsYou can also generate an HTML or RTF file from the List of Reportsby selecting Model→Reports. From the List of Reports, select thereport you want to generate and click the Generate RTF or GenerateHTML tool.

Closing the Report Editor from a model

When you close the Report Editor from a model, you return to the currentmodel and the report is not saved until you save the model.

To close the Report Editor from a model:

♦ Select File→Close.

Saving reportsWhen you save the model, you also save the reports it contains. To lowerthe size of your model, you can create a multi-model report even for asingle report as a multi-model report is saved in a file external to themodel. To do so, you have to create a template from the section of yourreport, then create a multi-model report using the template thatcorresponds to the section of your report for a model. For moreinformation on how to create a template from a section, see sectionCreating a template from a report section. For more information on how tocreate a multi-model report using a template, see chapter Managing aMulti-Model Report.

Packages in HTMLreport

Page 31: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 21

Closing the Multi-Model Report Editor

When you close the Multi-Model Report Editor, you have to save the reportin a file with a .MMR extension.

To close the Multi-Model Report Editor:

♦ Select File→Close.

Page 32: Sybase PowerDesigner Report Guide

Organizing the Report Editor

22 PowerDesigner

Organizing the Report EditorA report must always contain at least one section, which appears as a tab atthe bottom of the Report Items pane of the Report Editor.

A report section allows you to segment your model in order to facilitate youranalysis. Each section has its own selection of objects and can only be of onetype (PDM, CDM, OOM, BPM, XSM or FEM).

When you create a model report or a multi-model report, a section isautomatically created by default. The type of the section is the one you selectwhen you create the report.

In a model report, sections are always related to the type of the model forwhich you generate the report. For example, if you want to generate a reportfor a BPM model, all the sections you create in your report are of a BPMtype.

In a multi-model report, sections can be related to different model types,depending on the type of the models referenced in the workspace. Forexample, a multi-model report can contain a PDM related section, an OOMrelated section and a BPM related section, if these types of model arereferenced in the workspace.

You can create, delete, modify and rename as many sections as you wantusing the List of Report Sections. You can create an empty section or asection based on a template.

By default, sections are numbered in a report but you can modify thisproperty in the report property sheet.

For more information on paragraph numbering, see section Modifyingreport properties in chapter Building Reports.

Creating a report section

There are two ways of creating a report section:

♦ Creating an empty section

♦ Creating a section based on a template

When you create a new section, the Template column is set to <None> bydefault and the Apply Template check box is automatically selected.

Page 33: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 23

Creating an empty section

You can create an empty section that you will customize afterwards.

To create an empty section:

1 Select Report→Sections from the Report Editor.

The List of Report Sections appears. It contains a section by default.

2 (Optional) Type a section name.

If you do not type a section name, the section tab appears with a defaultname in the Report Items pane that you can modify afterwards.

3 (Optional for the multi-model report only) Click the Model column andselect a model from the dropdown listbox.

The section is of the same type as the selected model.

Model selectionFor a model report, the Model column displays by default the currentmodel.For a multi-model report, the Model column displays the alphabeticallist of all the models referenced in the workspace.

Page 34: Sybase PowerDesigner Report Guide

Organizing the Report Editor

24 PowerDesigner

4 Click the Template column and select None from the dropdown listbox.The Apply Template check box is automatically selected.

5 Click OK.

The Report Editor window appears. The new report section appears as atab at the bottom of the Report Items pane, which is empty.

Creating a section based on a template

You can create a section based on a template.

You can keep the template default values or use them as a basis for furthermodifications of the section.

To create a section based on a template:

1 Select Report→Sections from the Report Editor.

Page 35: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 25

The List of Report Sections appears.

2 Click a blank line.orClick the Add a Row tool.orSelect a section in the list and click the Insert a Row tool to insert thenew section before the selected line.

An arrow appears at the beginning of the line.

3 (Optional) Type a section name.

If you do not type a section name, the section tab appears with a defaultname in the Report Items pane that you can modify afterwards.

4 (Optional for the multi-model report only) Click the Model column andselect a model from the dropdown listbox.

The section is of the same type as the selected model.

Model selectionFor a model report, the Model column displays by default the currentmodel.For a multi-model report, the Model column displays the alphabeticallist of all the models referenced in the workspace.

Page 36: Sybase PowerDesigner Report Guide

Organizing the Report Editor

26 PowerDesigner

5 Click the Template column and select a template from the dropdownlistbox. The templates corresponding to the type of the model youselected are listed. The Apply Template check box is automaticallyselected.

6 Click OK.

The Report Editor window appears. The section you created appears as atab at the bottom of the Report Items pane.

7 Click the section tab.

The Report Items pane is filled with the template you have selected.

Creating a template from a report section

Once you have created a report section, you can save it as a template. Youcan use that template to create other reports.

Page 37: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 27

To create a template from a report section:

1 Click the tab corresponding to the section you want to save as atemplate.

The corresponding report appears in the Report Items pane.

2 Select Report→Create Template From Section.

The Report Template Editor appears. The items which were listed in theReport Items pane of the Report Editor appears now in the TemplateItems pane

3 Select File→Save.

A Save As dialog box appears.

4 Type a template name.

5 Click Save.

The next time you create a report, you will be able to use this newtemplate that appears in the List of Report Templates.

Page 38: Sybase PowerDesigner Report Guide

Organizing the Report Editor

28 PowerDesigner

Modifying the structure of a report section

You can modify the structure of any report section.

To modify the structure of a report section:

1 Click the section tab that you want to modify at the bottom of the ReportItems pane.

The corresponding report appears in the Report Items pane.

2 Modify the report.

For more information on modifying a report structure, see sectionAdding items to a report in chapter Building Reports.

Undo functionality not availableYou cannot use the Undo functionality in reports.

Reapplying the template default values to a report section

You can easily delete the modifications you applied to a report in the ReportEditor and return to its initial state without deleting the selection of objects.

To do so, you have to reapply the template default values to the section usingthe List of Report Sections.

To reapply the template default values to a report section:

1 Select Report→Sections from the Report Editor.

Page 39: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 29

The List of Report Sections appears. The Apply Template check boxcorresponding to the section on which your are working has been clearedbecause you have changed the default parameters.

2 Select the Apply template check box to reapply the template defaultvalues to the section.

3 Click OK.

Page 40: Sybase PowerDesigner Report Guide

Organizing the Report Editor

30 PowerDesigner

You return to the Report Editor. The section appears with the templatedefault parameters and the object selection is preserved.

Renaming a report section

You rename a report section using the List of Report Sections.

To rename a report section:

1 Select Report→Sections from the Report Editor.

The List of Report Sections appears.

2 Click the Name column of the section you want to rename.

An arrow appears at the beginning of the line.

Page 41: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 31

3 Type a new name for the section.

4 Click OK.

The Report Editor window appears. The section is renamed in the ReportItems pane.

Renaming a section in the Report Items paneYou can rename a section directly in the Report Items pane by right-clicking the section node at the root of the tree and select Renamefrom the contextual menu.

Page 42: Sybase PowerDesigner Report Guide

Organizing the Report Editor

32 PowerDesigner

Deleting a report section

You delete a report section using the List of Report Sections.

To delete a report section:

1 Select Report→Sections from the Report Editor.

The List of Report Sections appears.

2 Select the section you want to delete.

An arrow appears at the beginning of the line.

3 Click the Delete tool.

4 Click OK.

Page 43: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 33

The Report Editor window appears. The section you deleted is no longerdisplayed in the Report Items pane.

Section deletionYou cannot delete all the sections contained in a report because areport must always contain at least one section.

Page 44: Sybase PowerDesigner Report Guide

Using the Report Language Editor

34 PowerDesigner

Using the Report Language EditorYou use the Report Language Editor to create or modify report languageresource files.

A report language resource file is a file in XML format saved with the .XRLextension. It contains all the printable texts of a report and their defaultvalues. You use it when you create your report and later generate it whateverthe output. A report language resource file is stored in a central area and canbe shared by any report to guarantee data consistency and save time to theuser.

PowerDesigner ships with a series of report language resource files located inthe Resource Files directory.

Report V7 and higherWhen you open a report from version 7 or higher, strings linked to objectsare displayed in English.

Understanding the Report Language Editor

You access the Report Language Editor from the List of Report Languages.

The Report Language Editor is composed of two distinct parts: the languagetree view displayed on the left hand side to navigate through the languagecategories and entries and their corresponding information displayed to theright of the tree view.

The language tree view contains the following three categories:

Category Description Used for translation of

Object Attributes Contains all the strings linkedto objects (names of objectsproperties, for example) permodule

Name of object propertiesin cards, checks, and lists

Report Titles Contains all the strings linkedto report items (Organizationunit annotation, for example)per module

Titles of any report items

Values Mapping Contains all the strings linkedto keywords used in propertyvalues (Undefined or None forexample)

Keywords in objectproperty values in cards,checks, and lists

Report languageresource file

Page 45: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 35

For more information on object lists, see section Formatting a list itemin chapter Building Reports.

For more information on object cards, see section Selecting informationto display in a card in chapter Building Reports.

The Report Language Editor looks as follows:

For more information on how to manipulate categories and entries inthe Report Language Editor, see chapter The Resource Editor in the GeneralFeatures Guide.

The Object Attributes and Report Titles categories both contain a sub-category per module of PowerDesigner together with a Common Objects sub-category that contains objects common to all modules.

For more information on how to translate the name of object propertiesin cards, checks, and lists or to translate report titles, see section Translating akeyword in an object property value.

Object Attributesand Report Titlescategories

Page 46: Sybase PowerDesigner Report Guide

Using the Report Language Editor

36 PowerDesigner

The Values Mapping category contains two sub-categories that both containsa Standard entry:

Category Used for translation of

Forms Keywords in object property values in cards and checks

Lists Keywords in object property values in lists

The Standard entry appears by default and contains a mapping table thatapplies to all modules. It displays existing keyword names whatever themodel in the Name column and their replacing value in the Value column thatis used when the report is generated or previewed.

You can customize the default mapping tables. They are always used for allmodules unless you define a mapping table for a particular module.

A Standard mapping table looks as follows:

You can only define mappings for boolean values (Yes, No or True, False forexample) and predefined values (None or Undefined for example).

For more information on how to customize the default mapping tables,see section Translating a keyword in an object property value.

Values Mappingcategory

Page 47: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 37

Opening the Report Language Editor

You open the Report Language Editor when you need to create or modify areport language resource file.

You can also modify a report language resource file directly from the ReportEditor by right-clicking an item in the Report Items pane.

For more information on how to modify a report language resource filefrom the Report Editor, see section Translating a report language resourcefile.

To open the Report Language Editor:

1 Select Tools→Resources→Report Languages.

The List of Report Languages appears. It displays the alphabetical list ofall the report language resource files saved on your hard disk.

2 Select a report language.

3 Click the Properties tool.

The Report Language Editor window appears.

Opening the Report Language Editor from the Report EditorYou can also open the Report Language Editor from the ReportEditor by selecting Report→Edit Current Language.

For more information on the management tasks you can perform fromthe List of Report Languages, see chapter The Resource Editor in theGeneral Features Guide.

Page 48: Sybase PowerDesigner Report Guide

Using the Report Language Editor

38 PowerDesigner

Translating a report language resource file

In a report language resource file, you can translate:

♦ Name of objects properties in cards, checks, and lists using the ObjectAttributes category

♦ Titles of any report item using the Report Titles category

♦ Keywords in object property values in cards, checks, and lists using theValues Mapping category

Translating object property names and report titles

To translate object property names and report titles, you must open a reportlanguage resource file and click each entry individually in the language treeview to modify its corresponding value in the Value box.

The translations you perform in the report language resource file are visiblein the generated report.

Whatever the category you choose (Object Attributes or Report Titles), youcan apply translations to:

♦ Each module individually (for example Business process Model)

♦ All modules at a time (Common Objects)

Module Category to select Applies to

Unique Conceptual Data ModelObject Oriented Data ModelPhysical Data ModelBusiness Process ModelXML ModelFree Model

Each module individually

All Common objects All modules

To translate object property names and report titles:

1 Open the Report Language Editor.

2 Select the Objects Attributes category if you want to translate an objectproperty name.orSelect the Report Titles category if you want to translate a report title.

3 Drill down to the entry you want to translate.

Page 49: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 39

The name, comment and value for the entry appear to the right of the treeview.

4 Type a translation in the Value box and click Apply to commit thechanges.

5 Click OK to close the Report Language Editor.

A confirmation box appears asking you if you want to save the modifiedresource file.

The next time you open any report that uses the customized reportlanguage resource file, the generated report will take these modificationsinto account.

Performing translation directly from the Report EditorYou can also right-click an item in the Report items pane and selectthe Edit command. In the Editor dialog box that appears, type atranslation and click OK. Note that the User-Defined check box isautomatically selected in the Editor dialog box, as you are no longerusing the default values used in the report language resource file youhave selected. To revert to the default value, deselect the User-Defined check box.

You translate the following entry in the Report Language Editor:Example of atranslation in anobject card

Page 50: Sybase PowerDesigner Report Guide

Using the Report Language Editor

40 PowerDesigner

How it appears in the generated report:

You translate the following entry in the Report Language Editor:

How it appears in the generated report:

Example of atranslation in anobject list

Page 51: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 41

You translate the following entry in the Report Language Editor:

How it appears in the generated report:

Translating a keyword in an object property value

To translate a keyword in an object property value, you must open a reportlanguage resource file and define mappings in a mapping table.

Mapping tables are made up of:

♦ A Name column, which contains the name of keywords in objectproperty values

♦ A Value column, which contains the value assigned to the keyword

The translations you perform in the report language resource file are visiblein the generated report.

Example of atranslation of areport title

Page 52: Sybase PowerDesigner Report Guide

Using the Report Language Editor

42 PowerDesigner

The Values Mapping category allows you to define translations for keywordsin object property values for:

♦ All modules using the default Standard mapping tables in Forms andLists categories. You can customize these tables

♦ Each module individually by creating a mapping table and assign it to aparticular module

You can customize the predefined Standard mapping table, which containskeywords that apply to all modules.

♦ Click the Standard entry in the Forms or Lists category to display itscorresponding mapping table in the right pane of the report languageproperty sheet.

♦ Click the line that corresponds to the keyword value you want totranslate in the Value column.

♦ Type a translation and click Apply.

The following example shows the translation of the <None> keyword:

Standard mappingtable customization

Page 53: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 43

In addition of using the Standard mapping table, you can create your ownmapping table that you can associate to a particular module afterwards. To doso, you have to do the following:

♦ Create a new mapping table from the root of the Forms or Lists categoryusing the New→Map Item command from their respective contextualmenu

♦ Type keyword names and their corresponding values in the mappingtable

The following example shows a new mapping table DisplayMap createdfrom the Lists category. You cannot use it until you assign it to a particularmodule:

Once you have created a new mapping table, you can assign it to a particularmodule.

To do so, you have to recreate the Object Attributes tree view in the Forms orin the Lists category.

For example if you want to assign a mapping table for columns in a PDM,you have to do the following:

♦ Create a new category from the Forms or Lists category contextual menuusing the Add→New category command and name it Physical DataModel

Mapping tablecreation

Mapping tableassignment

Page 54: Sybase PowerDesigner Report Guide

Using the Report Language Editor

44 PowerDesigner

♦ Create a new entry from the Physical Data Model category contextualmenu using the Add→Map Item command and name it Column

♦ Assign an existing mapping table to each property of the Column objectfor which you want to translate keywords

The following example shows a mapping table in which each column objectproperty uses a different mapping table:

To translate a keyword in an object property value:

1 Open the Report Language Editor.

2 Click the Values Mapping category in the Language tree view to displayits tree view.

3 Click the Lists or the Forms category to display its tree view.

4 Click a module category to display its tree view

5 Drill down to the object for which you want to display the mapping tableto translate.

The corresponding mapping table appears to the right of the tree view.

6 Click a blank line in the Name column.

7 Type a keyword value to translate.

Page 55: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 45

8 Click the corresponding line in the Value column and type the mappingtable name you want to use for the translation of the keyword value thatwill display in the generated report.

9 Click OK.

Each time a mapping applies, the exact content of the keyword in theName column is evaluated (disregarding the case) and replaced with itscorresponding translation, which is defined in the mapping table thatappears in the Value column.

You define the MandMap mapping table in the Report Language Editor thatwill be used by another mapping table that you define afterwards:

Example of atranslation with amapping tableassigned to aparticular module

Page 56: Sybase PowerDesigner Report Guide

Using the Report Language Editor

46 PowerDesigner

You define the Column mapping table that uses the MandMap mappingtable you have previously defined:

How it appears in the generated report:

Attaching a language resource file to a report

When you create a report, you can select a report language. The selectedreport language is a resource file that contains all the printable texts valuestranslated in a given language. These values will appear in the generatedreport.

Page 57: Sybase PowerDesigner Report Guide

Chapter 1 Using the Report Editors

Reports User's Guide 47

To attach a language resource file to a report:

1 Select Model→Reports from the model diagram window.

The List of Reports appears. It displays the alphabetical list of all reportssaved in the model. If there are no existing reports, all the tools in theList of Reports dialog box are grayed, except for the New Report tooland the Manage Report Templates tool.

2 Select the New Report tool.

The New Report dialog box appears. It displays a default report name.

3 Type a report name in the Report Name box if you want to modify thedefault name.

4 Select a language from the Language dropdown listbox. It displays theavailable report languages. English is the default language in which thereport is printed.

5 Click OK.

Changing the language of a reportYou can change at any time the language of a report from the ReportEditor by selecting Report→Report Properties.

Page 58: Sybase PowerDesigner Report Guide

Using the Report Language Editor

48 PowerDesigner

The Report Editor window appears. If you add to the Report Items panean item which is translated in the language resource file, the itemautomatically appears translated in that pane.

Opening the report language property sheetYou can at any time edit a report language from the Report Editor byselecting Report→Edit Current Language.

Page 59: Sybase PowerDesigner Report Guide

Reports User's Guide 49

C H A P T E R 2

Managing a Model Report

This chapter describes how to manage reports for a selected model.

Topic Page

Using a report template for a model report 50

Creating a model report 51

Generating a model report 54

Modifying a model report 56

Saving a model report 58

About this chapter

Contents

Page 60: Sybase PowerDesigner Report Guide

Using a report template for a model report

50 PowerDesigner

Using a report template for a model reportYou can use a template to generate a report for a selected model. Reporttemplates are reusable, they list information to include in reports.

You can create your own template in a given language, modify it and save itin an RTP file. However, when you use a template created in a languagedifferent from the one you select to create your report, only user-defineditems such as Title or Text paragraph will keep the language of the template.Other items will be displayed in the report language.

For information on how to create or modify a template, see sectionUsing the Report Template Editor in chapter Using the Report Editors.

You can also use standard report templates that ship with PowerDesigner.

For information on standard report templates, see section Standardreport templates in chapter Using the Report Editors.

You can apply a template to a report when you create the report using theList of Reports or afterwards, using the List of Report Sections.

For each report section, you can apply a different template, but all sectionsare always of the same type of the model, for which you generate the report.

Page 61: Sybase PowerDesigner Report Guide

Chapter 2 Managing a Model Report

Reports User's Guide 51

Creating a model reportYou create a model report using the Report Editor. You cannot open theReport Editor without at least one model opened in the workspace.

When you create a model report, you need the following information:

Option Description

Report Name Name of the report provided by default

Language Language in which the report can be printed. English is thedefault language

Report Template List of available templates related to the opened model:

♦ Full: contains the table of contents and all main modelitems

♦ Standard: contains the table of contents, model andpackage graphs and most list items

♦ List: contains Title item and all list items

To create a model report:

1 Select Model→Reports from the model diagram window.

The List of Reports appears. It displays the alphabetical list of all reportssaved in the model. If there are no existing reports, all the tools in theList of Reports dialog box are grayed, except for the New Report tooland the Manage Report Templates tool.

Page 62: Sybase PowerDesigner Report Guide

Creating a model report

52 PowerDesigner

2 Select the New Report tool.

The New Report dialog box appears. It displays a default report name.

3 Type a report name in the Report Name box if you want to modify thedefault name.

4 Select a language from the Language dropdown listbox. It displays theavailable languages. English is the default language in which the reportis printed.

For more information on languages in reports, see section Usingthe Report Language Editor in chapter Using the Report Editors.

5 Select a template from the Report Template dropdown listbox. The listdisplays the templates related to the type of the model you are workingon.orSelect None, if you do not want any particular template.

Language in a templateWhen you use a template created in a language different from the oneyou select to create your report, only user-defined items such as Titleor Text paragraph will keep the language of the template. Other itemswill be displayed in the report language.

6 Click OK.

Page 63: Sybase PowerDesigner Report Guide

Chapter 2 Managing a Model Report

Reports User's Guide 53

The Report Editor window appears. A section is created by default at thebottom of the Report Items pane, which is filled with the template youhave selected. If you did not select a template, the Report Items pane isempty. Simultaneously a report node appears under the Reports categoryin the Browser.

For more information on the Report Editor, see section Using theReport Editor in chapter Using the Report Editors.

7 Build the report structure in the Report items pane.

For more information on building a report structure, see chapterBuilding reports.

8 Select File→Save from the model diagram window to save your report.

Page 64: Sybase PowerDesigner Report Guide

Generating a model report

54 PowerDesigner

Generating a model reportWhen you generate a model report, you must select a destination file (RTF,HTML, or Print)

Depending on the generation option you select, you generate your report on aprinted paper or in a file:

Generation option Output

RTF RTF file

HTML HTML file

Print Printed paper

You can customize your HTML report before generating it.

For more information on customizing an HTML report, see sectionCustomizing an HTML report in chapter Building a Report.

To generate a model report:

1 Double-click a report node in the Browser tree view.

The structure of the selected report appears in the Report Editor window.

2 Select File→Print.orSelect File→Generate→RTF.orSelect File→Generate→HTML.

A standard Print dialog box appears if you have selected Print and astandard Save As dialog box appears if you have selected RTF orHTML.

Page 65: Sybase PowerDesigner Report Guide

Chapter 2 Managing a Model Report

Reports User's Guide 55

3 Click OK in the Print dialog box.orType a file name in the Save as dialog box for RTF or HTML.

A confirmation box indicates that the report has been successfullygenerated and asks you if you want to open it with your default browserfor an HTML report or your default RTF editor for an RTF report.

4 Click Yes to open the report.

Quick model report generation from the BrowserIf you want to quickly generate a report from the Browser, right-clicka report node and from the contextual menu that appears, select Printor Generate→RTF or Generate→HTML.

Page 66: Sybase PowerDesigner Report Guide

Modifying a model report

56 PowerDesigner

Modifying a model reportYou can use an existing model report to generate a modified model report.

You can select an existing report from the List of Reports if you need to:

♦ Generate for a different output

♦ Change selection of objects

♦ Add sections

To modify a model report:

1 Select Model→Reports from the model diagram window.

The List of Reports appears. It displays the alphabetical list of allavailable reports saved in the model.

2 Select the report you want to modify and click the Edit Report tool.

The structure of the selected report appears in the Report Editor window.

Page 67: Sybase PowerDesigner Report Guide

Chapter 2 Managing a Model Report

Reports User's Guide 57

3 Do all the necessary changes.

4 Select File→Print.orSelect File→Generate→RTF.orSelect File→Generate→HTML.

A standard Print dialog box appears if you have selected Print and astandard Save As dialog box appears if you have selected RTF orHTML.

5 Click OK in the Print dialog box.orType a file name in the Save as dialog box for RTF or HTML.

A confirmation box indicates that the report has been successfullygenerated and asks you if you want to open it with your default browserfor an HTML report or your default RTF editor for an RTF report.

6 Click Yes to open the report.

Quick model report generation from the List of ReportsIf you want to quickly generate a report from an existing one withoutmodifying it, select a report in the List of Reports then click the PrintReport tool, or the Generate HTML or Generate RTF tool.

Page 68: Sybase PowerDesigner Report Guide

Saving a model report

58 PowerDesigner

Saving a model reportWhen you want to save a model report, you have to save the model.

You can then keep the report for a later use.

To save a model report:

♦ Select File→Save from the model diagram window.

Page 69: Sybase PowerDesigner Report Guide

Reports User's Guide 59

C H A P T E R 3

Managing a Multi-Model Report

This chapter describes how to manage multi-model reports.

Topic Page

Using a report template for a multi-model report 60

Creating a multi-model report 61

Generating a multi-model report 64

Modifying a multi-model report 66

Saving a multi-model report 68

About this chapter

Contents

Page 70: Sybase PowerDesigner Report Guide

Using a report template for a multi-model report

60 PowerDesigner

Using a report template for a multi-model reportYou can use templates to generate a multi-model report. Report templates arereusable, they list information to include in reports.

A multi-model report can contain items of all the different types of models ofyour session. It allows you to have a global view across different models.

You can create your own template in a given language, modify it and save itin an RTP file. However, when you use a template created in a languagedifferent from the one you select to create your report, only user-defineditems such as Title or Text paragraph will keep the language of the template.Other items will be displayed in the report language.

For information on how to create or modify a template, see sectionUsing the Report Template Editor in chapter Using the Report Editors.

You can also use standard report templates that ship with PowerDesigner.

For information on standard report templates, see section Standardreport templates in chapter Using the Report Editors.

Each section can be applied a different template type, depending on themodels opened in the workspace.

For example, if you only have a PDM model and an OOM model opened inthe workspace, no BPM type template will be available.

Page 71: Sybase PowerDesigner Report Guide

Chapter 3 Managing a Multi-Model Report

Reports User's Guide 61

Creating a multi-model reportYou create a multi-model report using the Multi-Model Report Editor.

You cannot create a multi-model report without at least one model opened inthe workspace.

At creation, a multi-model report must always contain a section that youdefine by selecting a model.

For example, if you want the first section of your multi-model report to be anOOM type section, you have to select an OOM model in the New Multi-Model Report dialog box.

When you create a multi-model report, you need the following information:

Option Description

Report Name Name of the report provided by default

Language Language in which the report can be printed. English is thedefault language

Model Name List of models to which the first report section can be related.This list depends on the models opened in the workspace

Model Type Type of the model (OOM, CDM, PDM, BPM, XSM or FEM)

Report Template List of available templates related to the selected model:

♦ Full: contains the table of contents and all main modelitems

♦ Standard: contains the table of contents, model andpackage graphs and most list items

♦ List: contains Title item and all list items

To create a multi-model report:

1 Open a model.

2 Select File→New from the model diagram window.

Page 72: Sybase PowerDesigner Report Guide

Creating a multi-model report

62 PowerDesigner

The New dialog box appears.

3 Select Multi-Model Report from the Model Type group box.

The New dialog box displays a default report name.

4 Type a report name in the Report Name box if you want to modify thedefault name

5 Select a language from the Language dropdown listbox. It displays theavailable languages. English is the default language in which the reportis printed.

For more information on languages in reports, see section Usingthe Report Language Editor in chapter Using the Report Editors.

6 Select a model in the Model Name dropdown listbox. This is the modelto which your first report section is related. The Model type box isautomatically updated.

7 Select a template from the Report Template dropdown listbox. The listdisplays the templates related to the type of the model you selected.orSelect None, if you do not want any particular template.

Language in a templateWhen you use a template created in a language different from the oneyou select to create your report, only user-defined items such as Titleor Text paragraph will keep the language of the template. Other itemswill be displayed in the report language.

8 Click OK.

Page 73: Sybase PowerDesigner Report Guide

Chapter 3 Managing a Multi-Model Report

Reports User's Guide 63

The Multi-Model Report Editor window appears. A section is created bydefault at the bottom of the Report Items pane, which is filled with thetemplate you have selected. If you did not select a template, the ReportItems pane is empty. Simultaneously a multi-model report node appearsunder the Workspace node in the Browser.

9 Build the report structure.

For more information on building a report structure, see chapterBuilding reports.

10 Select File→Save from the Multi-Model Report Editor window to saveyour report.

Creating a multi-model report from the BrowserYou can also create a multi-model report from the Browser by right-clicking the Workspace node and from the contextual menu selectNew→Multi-Model Report.

Page 74: Sybase PowerDesigner Report Guide

Generating a multi-model report

64 PowerDesigner

Generating a multi-model reportWhen you generate a multi-model report, you must select a destination file(RTF, HTML, or Print)

Depending on the generation option you select, you generate your report on aprinted paper or in a file.

Generation option Output

RTF RTF file

HTML HTML file

Print Printed paper

You can customize your HTML report before generate it.

For more information on customizing an HTML report, see sectionCustomizing an HTML report in chapter Building a Report.

To generate a multi-model report:

1 Double-click a multi-model report node in the Browser tree view.

The structure of the selected report appears in the Multi-Model ReportEditor window.

2 Select File→Print.orSelect File→Report→Generate→RTF.orSelect File→Report→Generate→HTML.

A standard Print dialog box appears if you have selected Print and astandard Save As dialog box appears if you have select RTF or HTML.

Page 75: Sybase PowerDesigner Report Guide

Chapter 3 Managing a Multi-Model Report

Reports User's Guide 65

3 Click OK in the Print dialog box.orType a file name in the Save as dialog box for RTF or HTML.

A confirmation box indicates that the report has been successfullygenerated and asks you if you want to open it with your default browserfor an HTML report or your default RTF editor for an RTF report.

4 Click Yes to open the report.

Multi-model report not visible in the BrowserIf there is no multi-model report visible in the Browser, right-click theWorkspace node and in the contextual menu select Add. From thestandard Open dialog box that appears, select a multi-model reportfile (MMR) and click Open. The report appears in the Browser.

Page 76: Sybase PowerDesigner Report Guide

Modifying a multi-model report

66 PowerDesigner

Modifying a multi-model reportYou can use an existing multi-model report to generate a modified multi-model report.

You can select an existing multi-model report from the Browser if you needto:

♦ Generate for a different output

♦ Change selection of objects

♦ Add sections

You can open a multi-model report, even though the models for which youhave created the report are closed in the workspace.

To modify a multi-model report:

1 Double-click a multi-model report node in the Browser tree view.

The structure of the selected report appears in the Multi-Model ReportEditor window.

2 Do all the necessary changes.

3 Select File→Print.orSelect File→Generate→RTF.orSelect File→Generate→HTML.

A standard Print dialog box appears if you have selected Print and astandard Save As dialog box appears if you have selected RTF orHTML.

Page 77: Sybase PowerDesigner Report Guide

Chapter 3 Managing a Multi-Model Report

Reports User's Guide 67

4 Click OK in the Print dialog box.orType a file name in the Save as dialog box for RTF or HTML.

A confirmation box indicates that the report has been successfullygenerated and asks you if you want to open it with your default browserfor an HTML report or your default RTF editor for an RTF report.

5 Click Yes to open the report.

Quick multi-model report generation from the BrowserIf you want to quickly generate a multi-model report from an existingone without modifying it, right-click a multi-model report node in theBrowser and from the contextual menu that appears select Print orGenerate→RTF or Generate→HTML.

Page 78: Sybase PowerDesigner Report Guide

Saving a multi-model report

68 PowerDesigner

Saving a multi-model reportWhen you want to save a multi-model report, you have to save it in a file witha MMR extension.

You can then keep the report for a later use.

To save a multi-model report:

1 Select File→Save in the Multi-Model Report Editor.

A standard Save As dialog box appears.

2 Type a name for the multi-model report.

3 Click Save.

Saving a multi-model report from the BrowserYou can also save a multi-model report from the Browser by right-clicking a multi-model report node and from the contextual menu thatappears select Save.

Page 79: Sybase PowerDesigner Report Guide

Reports User's Guide 69

C H A P T E R 4

Building Reports

This chapter describes how to build a model report or a multi-model report.

Topic Page

Managing report items 70

Using nodes 86

Using items 91

Formatting items 94

Setting up report pages 112

Using print preview 127

About this chapter

Contents

Page 80: Sybase PowerDesigner Report Guide

Managing report items

70 PowerDesigner

Managing report itemsYou can use the following types of items in your report:

Item Description

Node Contains dependent items. Nodes appear as booksin the Report Editor

Model-dependent item Contains information about a model or a package

Object list Contains tables listing objects from a model or apackage

Object-dependent item Contains information about a specific object typeand can only appear under an object node

Independent item Can appear anywhere in a report (for example, atable of contents or a graph)

Adding items to a report

You use the Available Items pane to add items to the Report Items pane ofthe Report Editor.

You can add an item to the Report Items pane using:

♦ Drag and drop

♦ Double-click on the item

♦ The item contextual menu

You can drag and drop an item in the Report Items pane only when it alreadycontains at least one item.

When you drag an item in the Report Items pane, you must choose a dropposition. A box or a line appears indicating where the drop will occur.

While you drag an item over a node If a line appears, drop positions theitem at the line and if a box around the node appears, drop positions the itemlast in the node.

While you drag an item over another item If a line appears, droppositions the item at the line and if a box around the item appears, droppositions the item immediately after the item surrounded by the box.

Drag & drop

Page 81: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 71

Drag & drop between reports of the same typeYou can also drag and drop items between reports of the same type. If yousimply drag and drop an item from one report to another without pressingany key, you move the item from one report to another. You can copy anitem by pressing the CTRL key while dragging and dropping the item toanother report. The report in which you want to drop the item must alreadycontain at least one item.

When you double-click an item in the Available Items pane, the item in theReport Items pane is placed at the pointer position in that pane.

If the pointer is on the root node or on the last item in the Report Items pane,the item you have double-clicked on is placed at the last position in theReport Items pane.

When you add an item to the Report Items pane, the item remains in theAvailable Items pane. You can insert the same item several times in the samereport contents.

The following report structure contains three instances of the Page break itemand two instances of the Text paragraph item.

To add an item to a report:

♦ Drag an item from the Available Items pane into the Report Items pane.orDouble-click an item in the Available Items pane.orSelect an item in the Available Items pane, right-click and select Add inthe contextual menu.

The item appears in the Report Items pane.

Double-clicking an itemIf you want to add an item at the same level as a node, press the ALT

key while you double click the item.

Double-click

Page 82: Sybase PowerDesigner Report Guide

Managing report items

72 PowerDesigner

To add several items to a report:

♦ Select items in the Available Items pane, right-click and select Add inthe contextual menu.orSelect items in the Available Items pane and click the Add Item tool.

The items appear in the Report Items pane.

Multi-selectionPress CTRL while selecting items with the Pointer tool, or use theSHIFT key to select a continuous list of items.

Drag-and-drop not possibleWith the drag-and-drop method, the pointer becomes a barred circlewhen the mouse position is not an available drop target. You can onlydrop the item when the barred circle becomes a pointer again.

Adding nodes to a report

When you add a node to a report, you automatically add its dependent itemsbut you can then delete the dependent items you do not need by selecting theDelete command in the item contextual menu.

To add a node to a report:

♦ Drag a node item from the Available Items pane to the Report Itemspane.

The node and its dependent items appear in the Report Items pane.

Package hierarchyWhen you add a package node to a report, you can click the HierarchicalDisplay command in the package node contextual menu to display thepackage hierarchy in the generated report.

Page 83: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 73

Modifying the collection of a node

A collection is a list of child objects associated with a parent object. Forexample, the collection of a class is the list of classes in the current model.By default, each pre-built node in the Available Items tree is associated witha collection.

You can create calculated collections. A calculated collection is a list ofassociated objects with a particular semantic, these associated objects are notdirectly linked to the current object in the PowerDesigner metamodel. Youdefine a calculated collection on an object when you want to highlight aspecific aspect of an object, like for example the sequence diagrams thatdisplay a certain operation.

For more information on how to create a calculated collection, seesection Defining a calculated collection in a profile in chapter ManagingProfiles of the Advanced User Documentation.

You can change the collection associated with a node and set it to acalculated collection to use the report to document calculated collections.

Since calculated collections can associate objects that are not directly linkedin the metamodel, you can drag and drop any item under any other item in thereport. There is no control over the place where you drop report items, andyou are responsible for the global consistency of books and collections inyour report.

Once you have added the appropriate node, you can modify its collection andselect a calculated collection.

In our example, you define on operations a calculated collection that retrievesthe diagrams where messages using a given operation are displayed. In thereport, if you want to have these diagrams displayed, you have to insert adiagram node under the operation node and select the calculated collectionfor the diagram node.

As a result, the generated report displays for each operation, the diagramsshowing the messages used by this operation.

To modify the collection of a node:

1 Drag and drop the appropriate node in the selected node.

2 Right-click the node and select Collection in the contextual menu.

The Book Collection page appears.

Page 84: Sybase PowerDesigner Report Guide

Managing report items

74 PowerDesigner

3 Select a collection in the Collection dropdown listbox.

4 Click OK.

Inserting a table of contents

A table of contents specifies a complete list of node titles with their pagenumbers. You can insert a table of contents anywhere in a report.

To insert a table of contents:

♦ Drag a table of contents item from the Available Items pane to theReport Items pane.

The table of contents appears in the Report Items pane.

Page breakWhen you insert a table of contents in a report, you do not need to have itfollowed by a page break because PowerDesigner automatically providesone after each inserted table of contents.

Inserting a text paragraph

You can use the text paragraph item to type free text in an Editor dialog box.

To insert a text paragraph:

1 Drag a text paragraph item from the Available Items pane to the ReportItems pane.

The paragraph item appears in the Report items pane.

2 Double-click the text paragraph.orSelect the item in the Report items pane and select Report→Edit.

Page 85: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 75

The Editor dialog box appears.

3 Type text.

4 Click OK.

Inserting a text file or a graphical file

You can insert an ASCII format text file or a graphical file in a report.

To insert a text file or a graphical file:

1 Drag a text file item or a graphical file item from the Available Itemspane to the Report Items pane.

A standard Open dialog box appears.

2 Select a text file or a graphical file.

3 Click OK.

The text file or the graphical file appears in the Report Items pane.

Page 86: Sybase PowerDesigner Report Guide

Managing report items

76 PowerDesigner

Inserting graphs

You can add diagram graphics to a report by inserting the Graphics item inthe Report Items pane. When you insert this item under a package node, thereport will print the package graphs.

In the following structure, you will print the graph of a diagram:

In the following structure, you will print the graphs of each package of thediagram:

To insert a graph:

♦ Drag a graph item from the Available Items pane to the Report Itemspane.

The graph appears in the Report Items pane.

Repositioning an item

You can change the order of items in the report using the drag and dropmethod within the Report Items pane. The only item you cannot reposition orremove in the Report Items pane is the root node that appears in each sectionof your report.

When you drag a node, you also drag its dependent items.

For more information on the drag and drop method, see section Addingitems to a report.

Page 87: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 77

To reposition an item:

♦ Drag an item to a new location within the Report Items pane.orSelect an item in the Report Items pane and select Report→Up orReport→Down.

The item is repositioned in the Report Items pane.

Contextual menusYou can right-click any item to access its contextual menu and display thecommands that apply to it.

Changing the depth level of an item

Items can be positioned at the same level as nodes or within nodes.

This change is not possible for object-dependent items that must remainbelow a node.

To change the depth level of an item:

1 Select an item in the Report Items pane.

2 Select Report→Raise Level.

The item is positioned at the same level as the node.orSelect Report→Lower Level.

The item is positioned within the node.

Contextual menusYou can right-click any item to access its contextual menu and display thecommands that apply to it.

Page 88: Sybase PowerDesigner Report Guide

Managing report items

78 PowerDesigner

Copying an item in a report

You can copy any item within the Report Items pane, except the root node.

When you copy an item in the Report Items pane, the formatting you haveapplied to the item is preserved.

To copy an item:

♦ Press CTRL while you drag an item to a second location within the ReportItems pane.

The item is copied at the desired location in the Report Items pane.

Deleting an item from a report

In the Report Items pane, you can delete any item except the root node.

When you delete a node, you also delete its dependent items.

To delete an item from a report:

1 Select an item in the Report Items pane.

2 Press SUPPR.orRight-click the item and select Delete from the contextual menu.

The item is deleted from the Report Items pane.

Making a global object selection for the report

You create a report to document objects in models and packages. You firstmake a global selection of objects to appear in the report using theReport→Select Objects dialog box. This selection is saved with the report.

You can then fine tune the object selection from individual items the ReportItems pane. For more information see section Refining the report objectselection.

Page 89: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 79

You can use the following tools in the Report Object Selection dialog box:

Tool Name Action

Include Sub-Objects Displays sub-objects (like sub-process or sub-activity) and objects contained in the sub-packages

Include Sub-Objectsusing same namespace

Displays sub-objects (like sub-process or sub-activity) and objects contained in the sub-packages that use the same namespace (with theUse Parent Namespace check box selected)

Select All Selects all objects in the object type page

Deselect All Deselects all objects in the object type page

Use Graphical Selection Adds graphically selected objects in the modeldiagram window

Move Selected Items toTop

Moves the selection to the top of the object list

Move Selected Items toBottom

Moves the selection to the bottom of the objectlist

Customize Columns andFilter

Opens a Filter dialog box to define a filter onthe list

Enable/Disable Filter Enables the filter on the list

Include Shortcuts Displays objects shortcuts contained in themodel or package. If both the Include Shortcutsand Include Sub-Objects tools are enabled inthe selection list, all the objects shortcuts of thecurrent package and those of the sub-packagesappear

The way you use the Include Sub-Objects tool allows you to display either:

♦ All objects in the current model or package including sub-objects andobjects contained in packages or sub-packages

♦ All objects in the current model or package, except sub-objects andobjects contained in packages or sub-packages

Include Sub-Objects tool

Page 90: Sybase PowerDesigner Report Guide

Managing report items

80 PowerDesigner

You can include in a report shortcuts contained in a model or package usingthe Include Shortcuts tool.

Shortcuts are displayed in each object type page in the Report ObjectSelection dialog box. For example table shortcuts display on the Tables pagewhen you click the Include Shortcuts tool.

By default shortcuts are not selected.

To include shortcuts in a report, you have to select a model or package andclick the Include shortcuts tool, then select the check boxes corresponding tothe shortcuts you want to include in your report.

When you include in your report shortcuts whose target model is closed,some information such as comment or description for example areunavailable.

For more information on shortcuts, see chapter Managing Shortcuts inthe General Features Guide.

You can select objects that are not visible in the current list by clicking the:

♦ Include Sub-Objects tool

♦ Include Sub-Objects using same namespace tool

♦ Include Shortcuts tool

However, if you deselect these tools before you commit your selection, theobjects you selected are no more visible in the current list. That is why whenyou want to commit your selection, a confirmation box asks you if you wantto include non visible selected objects in the current selection.

If you answer:

Yes Objects selection is composed of the objects selected in the current listtogether with non visible selected objects.

No Objects selection is only composed of the objects selected in the currentlist. Other non visible selected objects are ignored and deselected.

Selection tipsIf you want to use a selection tool for all object type pages, press CTRL andclick the desired tool.

To make a global object selection for the report:

1 Select Report→Select Objects from the Report Editor.

Including shortcutsin a report

Confirming objectsselection

Page 91: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 81

The Report Object Selection dialog box appears. All the objects areselected by default, except shortcuts if any.

2 Select a section from the Section dropdown listbox.

3 Select a package from the package dropdown listbox.

4 Select the objects to include in the report from the object list in eachobject type page.

5 <optional> Click the Use Graphical Selection tool to automatically selectthe check boxes of objects selected in the diagram.

6 Click OK.

Refining the report object selection

If you need to refine the global selection of objects in your report you candefine object selections and filter criteria on the report items displayed inthe Report Items pane of the report.

In the final report, both object selection and filter criteria are taken intoaccount to edit the final selection of objects of your report.

Page 92: Sybase PowerDesigner Report Guide

Managing report items

82 PowerDesigner

Sorting CRUD matrix itemsYou can use object selections and filter criteria to sort rows and columnsin a CRUD matrix table using the Row Selection and Column Selectioncommands in the CRUD matrix contextual menu in the Report Items pane.

Defining an object selection for a selected report item

When you call the Select Objects dialog box from a report item in the ReportItems pane, you can select instances of objects and order them in the printedreport.

Note: the Select Objects dialog box only displays instances of object selectedat the global level, in the Report Object Selection dialog box. See sectionMaking a global object selection for the report for more details on the globalselection.

To order selected objects, use the arrows in the lower left corner. You canalso automatically sort objects alphabetically in ascending or descendingorder by clicking a column header. You have to click OK to commit theselection in the report.

If you click the Switch to Criterion button you display the Define Sort andFilter dialog box and you do not commit the selection of ordered objects.

To define an object selection for a selected report item:

1 Right-click a book or a model-dependent list item in the Report Itemspane and select Selection from the contextual menu.or(Matrix items only) Right-click a matrix item in the Report Items paneand select Row Selection or Column Selection from the contextual menu.

The Define Sort and Filter dialog box appears.

Page 93: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 83

2 Click the Switch to Criterion button in the lower left corner of the dialogbox to display the Select Objects dialog box.

The list displays objects selected in the Report Object Selection dialogbox.

3 Select or deselect the check box beside objects you want to display orremove from the report.

4 Use the arrows in the lower left corner to define a display order for theobjects.

5 Click OK.

Hierarchical Display commandIf you define a selection of ordered objects on a package for which youalso select the Hierarchical Display command, objects in the selection aretaken into account when you generate the report but the order in theselection is ignored.For more information on the Hierarchical Display command, see sectionAdding nodes to a report.

Page 94: Sybase PowerDesigner Report Guide

Managing report items

84 PowerDesigner

Defining a filter criterion for a selected report item

The Define Sort and Filter dialog box lets you refine the selection of objectsin your report by adding a filter criterion to the list of objects. You can set thefollowing parameters to define the criterion:

Parameter To define

S column Means sorted, indicates the attribute will be taken intoaccount for the sort

Used to set an order and define a priority among attributes

Expression column Used to restricts the selection to a defined expression

U column Applies the filter expression to the corresponding column

The expression syntax uses standard wildcards as in the Customize Columnsand Filter dialog box.

For more information on the expression syntax, see section Defining afilter on a list in chapter Using the PowerDesigner Interface in the GeneralFeatures Guide.

You have to click OK to commit the criterion. If you click the Switch toSelection button you display the Select Objects dialog box and you do notcommit the criterion.

Lists in booksThe Switch to Selection button is not available if the list you are sortingbelongs to a book.

To define a filter criterion:

1 Right-click a book or a list item in the Report Items pane and selectSelection from the contextual menu.or(Matrix items only) Right-click a matrix item in the Report Items paneand select Row Selection or Column Selection from the contextual menu.

Page 95: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 85

The Define Sort and Filter dialog box appears.

2 Type an expression in the Expression column to restrict the selection inthe column to a defined expression.

3 Select the U column to apply the filter expression to the correspondingcolumn.

4 Select the S column to take the attribute into account for the sort.

5 Click OK.

Cancel filter expressionIf you want to keep the expression in memory but disable this filterfor a while, you can clear the corresponding check box in the Ucolumn. The expression parameter will no longer be taken intoaccount.

Page 96: Sybase PowerDesigner Report Guide

Using nodes

86 PowerDesigner

Using nodesA node is an item that contains dependent items. Nodes appear as books inthe Report Editor.

For example the Business rule node contains items that describe a businessrule.

The Report Generator interprets nodes as print loops. For each object node,the report prints all the dependent items.

For example, when a model contains two business rules ROYALTIES andAUTHOR_SALES the report prints in the following order:

Business rule 1

Card of the business rule ROYALTIESDescription of business rule ROYALTIESAnnotation of business rule ROYALTIESClient check expression of business rule ROYALTIESServer check expression of business rule ROYALTIES

Business rule 2

Card of the business rule AUTHOR_SALESDescription of business rule AUTHOR_SALESAnnotation of business rule AUTHOR_SALESClient check expression of business rule AUTHOR_SALESServer check expression of business rule AUTHOR_SALES

Printing nodes

Page 97: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 87

Node dependency

Nodes can belong to other nodes. The following table lists all possible nodedependencies.

Node type Can belong to Can contain

Root node — All nodes and items in the reportcontents

Title Root nodePackage nodeObject node

Title nodesPackage nodesObject nodesIndependent itemsObject-dependent items

Package Root nodeTitle node

Title nodesObject nodesIndependent items

Object Root nodeTitle nodePackage node

Title nodesObject-dependent nodesIndependent itemsObject-dependent items

Object-dependent Object node Title nodesIndependent itemsObject-dependent items

Page 98: Sybase PowerDesigner Report Guide

Using nodes

88 PowerDesigner

Using node titles

You can associate title text with nodes. The title prints above the item thatfollows in the Report Items pane. A title contains free text.

You can insert titles anywhere in the Report Items pane and as often as youwant. You can use title nodes to organize a report into chapters.

Package, object, and object-dependent nodes have default titles thatincorporate variable information:

Node type Default title Variable syntax

Title None —

Package Package name %ITEM%

Object Object name %ITEM%

Object-dependent Object name %ITEM%

%PARENT%

Modifying a node title

You can modify the title of a node.

Node titles can include the following variables:

DateTimeApplication NameItemItem CodeItem NameModel CodeModel NameModule NameParentParent CodeParent Name

To modify a node title:

1 Select a node in the Report Items pane.

2 Select Report→Edit Title.

Page 99: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 89

The Editor dialog box opens and displays the current title text.

3 Type changes to the title text.

The User-Defined check box is automatically selected, as you are nolonger using the default values of the report language resource file youselected for you report.

4 (optional) Deselect the Show Title check box if you do not want to showthe title of the node in the previewed or generated report.

For more information on the Show Title check box, see sectionRemoving the title of an item.

5 Place the cursor in the text where you want to insert variable informationfor object name or package name.

6 Click the Insert button

7 Select a field in the dropdown listbox.

8 (Optional) Click the Format button.

Page 100: Sybase PowerDesigner Report Guide

Using nodes

90 PowerDesigner

The format dialog box opens to the Font page.

9 Select format options.

10 Click OK in each of the dialog boxes.

The first line of the title appears next to the node in the Report Itemspane.

User-Defined check boxWhen you type changes in the edit box, the User-Defined check boxis automatically selected as you are no longer using the default valuesused in the report language resource file you selected for your report.To revert to the default value, deselect the User-Defined check box.For more information on report language resource files, see chapterUsing the Report Editors.

Page 101: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 91

Using itemsIn a report, items can be of the following types:

♦ Model-dependent items contain information about a model or a package

♦ Object-dependent items contain information about a specific type ofobject

♦ Independent items do not contain information about specific models orobjects

Model-dependent items

Model-dependent items provide information about a model or a package. Ifyou insert a model-dependent item under a package node, the item containsinformation related to the package.

You cannot insert model-dependent items into object nodes.

The following are model-dependent items:

Dependent item Print format Content

Card List of properties Properties of the model or package

Description Text paragraph Description of the model or package

Annotation Text paragraph Annotation of the model or package

Begin script (PDMonly)

Text paragraph Text to add at the beginning of a scriptgenerated from the model

End script (PDMonly)

Text paragraph Text to add at the end of a scriptgenerated from the model

Object list Table Table that lists all objects of a giventype in the model

Object-dependent items

Object items provide information about objects in the model. These itemshave a restricted set of dependent items called object-dependent items.

You can delete and change the order of object-dependent items in the ReportItems pane. You cannot insert object-dependent items into object nodes of adifferent type.

Page 102: Sybase PowerDesigner Report Guide

Using items

92 PowerDesigner

For example, in the following report structure, the node Class precedes itsobject dependent items.

The report generator prints object-dependent items once for each node. If anitem does not have information for a particular object, it does not appear inthe resulting report.

For example if a domain does not have any associated rules or checkparameters, the domain description prints directly after the domain card.

All object nodes have the following object-dependent items:

Dependent item Print format Content

Card List of properties Properties of an object

Description Text paragraph Description of an object

Annotation Text paragraph Annotation of an object

In addition to the items mentioned above, each object node has dependentitems related to the object type. For example, a business rule node has adependent item for server expression.

Printing object-dependent items

Page 103: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 93

Independent items

Independent items do not contain information about specific models orobjects.

You insert an independent item in a report by dragging and dropping the itemicon from the Available pane to the Report Items pane.

You can insert the following independent items anywhere in the report:

Icon Independent item Generated result

Table of contents Complete report table of contents

Text paragraph Paragraph of free text that you type

Text file Contents of a text file

Page break Prints next item on the following page

Graphics Graph of model (or package if under a Packagenode)

Graphical file Contents of a graphical file

Page breakFor a report generated as an RTF file, a page break is inserted at theposition you place the page break icon. However, when you use the icon toinsert a page break in an HTML file, you need to right-click the icon andselect Generate in HTML.

Page 104: Sybase PowerDesigner Report Guide

Formatting items

94 PowerDesigner

Formatting itemsIn a report, the available format options depend on the print format:

♦ Text format

♦ Graph format

♦ Table format

Contextual menusYou can right-click any item to access its contextual menu and display thecommands that apply to it.

Defining global format for an item

Global formats apply to all new items that you add to a report structure. Youapply global format to items in the Available Items pane. After you defineglobal format, it applies every time you add that item to the Report Itemspane.

Global format does not apply to items already in the Report Items pane.

To define a global format:

1 Select an item in the Available Items pane.

2 Select Report→Format.

A Format dialog box that corresponds to the type of the item appears.For example, if you select a graph, the Graph Format dialog box appears.

3 Type format changes.

4 Click OK.

Every time you add that item to the Report Items pane, it retains theglobal format.

Multi-selectionYou can also change format options for several items at once by pressingCTRL while selecting items of the same type or not with the Pointer tool orusing the SHIFT key to select a continuous list of items.

Page 105: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 95

Formatting individual items

You can change the format of an individual item already in the Report Itemspane.

To format an individual item:

1 Select an item in the Report Items pane.

2 Select Report→Format.

A Format dialog box that corresponds to the type of the item appears.

3 Type format changes.

4 Click OK.

The format is applied to the selected item only. If you want to apply thedefined format to all items of that type, you must define global formatoptions for that item in the Available items pane.

For more information on default format options, see sectionDefining global format for an item.

Defining a default report font

You can easily change the default font proposed for report items, reporttemplates and reports using the Change Fonts Properties dialog box. Thatdefault font is saved in the registry.

You can simultaneously define a default font for items with different printformats.

After you define a default font for an item, it applies every time you add thatitem to the Report Items pane.

To define a default report font :

1 Select Report→Change Fonts.

Page 106: Sybase PowerDesigner Report Guide

Formatting items

96 PowerDesigner

The Change Fonts Properties dialog box appears.

2 Select Font format options.

3 Click Ok.

Selecting text to format

Some items include more than one text selection. You can format each textselection independently or altogether using the CTRL or SHIFT key to selectseveral text selections at once from the Available Items pane of the Formatdialog box.

The following text selections are available for card items (lists of properties),which print in table format.

Text selection Description Example

Title Title of the item Card of the Table

Text Label Property name on a list ofproperties

Table Code

Text Value of a property EMPLOYEE

Card items

Page 107: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 97

The following text selections are available for CRUD Matrix items, whichprint in table format.

Text selection Description Example

Matrix title Title of the item CRUD Matrix

Matrix row andcolumn

Resource and processname

Check item (process name inrows)Stock (resource name in columns)

Matrix text CRUD value RU

The following text selections are available for model- and object-dependentitems in text format.

Text selection Description Example

Title Title of the item Table Description

Text Text of the description,annotation, or script

This table describes differentemployee characteristics

The following text selections are available for list items, which print in tableformat.

Text selection Description Example

Title Title of the item List of Indexes

Column Header Heading of column Code

Text Value in the column PK_EMPLOYEE

The following text selections are available for the title page, which print intext format.

For more information on the title page, see section Including a titlepage.

Text selection Description Example

Title Title of the report OOM Report

Optional Fields Text of the author, date,version or summary

VB, 09.15.99, draft, report withlists only

CRUD Matrix items

Model- and object-dependent items

List items

Title page

Page 108: Sybase PowerDesigner Report Guide

Formatting items

98 PowerDesigner

The following text selections are available for the table of contents, whichprints in text format.

Text selection Description Example

TOC title Title of the table of contents Table of contents

Level 1Level 2Level 3Level 4etc.

Text of the different hierarchylevels in the table of contents

2 Association information2.1 Model information2.1.1 Card of the model

OOMetc.

You can select the levels to display from the Show levels to dropdown listboxin the Format dialog box. For an HTML report, you must define the depthlevel of the table of contents in the HTML Format page of the Reportproperties dialog box.

For more information on the HTML Format page, see sectionCustomizing an HTML report.

Table of contents

Page 109: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 99

Besides, you can simultaneously select items with different print formats andapply to them the format options corresponding to the type of the item. Forexample, if you select a card item and a list item, the text selections that youcan format for both items appear in the Available Items pane of the Formatdialog box:

Selecting a font

You can select a font for any item, except for the graph and page break.

If you call the Format dialog box from the Available Items pane, the fontformatting becomes the default format, as explained in section Definingglobal format for an item.

If you call the Format dialog box from the Report Items pane, the fontformatting applies to the selected report item, as explained in sectionFormatting individual items.

The following font formatting is available from the Format dialog box:

♦ Font

♦ Font style

♦ Size

♦ Underline

♦ Strikeout

Simultaneousselection

Page 110: Sybase PowerDesigner Report Guide

Formatting items

100 PowerDesigner

To select a font:

1 Select an item.

2 Select Report→Format.

The Format dialog box opens to the Font page.

3 Select an item in the Available Items pane of the Format dialog box.

The item is highlighted.

4 Select font format options.

5 Click OK.

Page 111: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 101

Formatting a paragraph

You can select a paragraph format for any item, except for graphs and pagebreaks.

If you call the Format dialog box from the Available Items pane, theparagraph formatting becomes the default format, as explained in sectionDefining global format for an item.

If you call the Format dialog box from the Report Items pane, the paragraphformatting applies to the selected report item, as explained in sectionFormatting individual items.

The following paragraph formatting is available from the Format dialog box:

♦ Indentation (left, right, first line)

♦ Spacing (before, after, internal line spacing)

♦ Justification (alignment)

To format a paragraph:

1 Select an item.

2 Select Report→Format.

The Format dialog box opens to the Font page.

3 Click the Paragraph tab to select Indentation, spacing and justificationformats.

4 Select an item in the Available Items pane of the Format dialog box.

Page 112: Sybase PowerDesigner Report Guide

Formatting items

102 PowerDesigner

The item is highlighted.

5 Define paragraph format.

6 Click OK.

Selecting border format

You can define border formatting in the report.

If you call the Format dialog box from the Available Items pane, the borderformatting becomes the default format, as explained in section Definingglobal format for an item.

If you call the Format dialog box from the Report Items pane, the borderformatting applies to the selected report item, as explained in sectionFormatting individual items.

The following border formatting is available from the Format dialog box:

Frameoption

Result in the generatedreport Result

Left Inserts a vertical line to theleft of all the occurrences ofthe highlighted textselection in the AvailableItems pane

Right Inserts a vertical line to theright of all the occurrencesof the highlighted textselection in the AvailableItems pane

Top Inserts an horizontal line ontop of all the occurrences ofthe highlighted textselection in the AvailableItems pane

Bottom Inserts an horizontal line atthe bottom of all theoccurrences of thehighlighted text selection inthe Available Items pane

Page 113: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 103

Frameoption

Result in the generatedreport Result

Box Inserts a unique rectanglearound all the occurrencesof the highlighted textselection in the AvailableItems pane (only availablefor card and list items)

Width Indicates the width of theborder frame

Box width Indicates the width of thebox frame

From text Sets the amount of spacefrom text to top, bottom,left, and right border

Box option is only available for:

♦ Text Label in card items

♦ Column header and Text in list items

If you select the Box option in the Format dialog box of a card item You insert a unique rectangle that groups all the occurrences of Text Label(property names) including Text (corresponding property values) by default.

If you select the Box option in the Format dialog box of a list item You insert a unique rectangle that groups all the occurrences of ColumnHeader (heading of column, example Code), as well as a unique rectanglethat groups all the occurrences of Text (value in the column), if you havepreviously highlighted each of these text selections in the Available Itemspane.

To select frame format:

1 Select an item.

2 Select Report→Format.

The Format dialog box opens to the Font page.

Box option

Page 114: Sybase PowerDesigner Report Guide

Formatting items

104 PowerDesigner

3 Click the Border tab to select border format.

4 Select an item in the Available Items pane of the Format dialog box.

The item is highlighted.

5 Define border format.

6 Click OK.

Selecting tab spacing format

You can define tab formatting in the report.

If you call the Format dialog box from the Available Items pane, the tabsformatting becomes the default format, as explained in section Definingglobal format for an item.

If you call the Format dialog box from the Report Items pane, the tabsformatting applies to the selected report item, as explained in sectionFormatting individual items.

The following tab formatting is available from the Format dialog box:

Tab formatting Description

Tab stop position Allows you to type the measurement for a tab stop

Default tab stops Sets the default spacing between tab stops

Page 115: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 105

Tab formatting Description

Alignment Allows you to select the way you want text to be aligned atthe tab stop. To change the alignment for an existing tabstop, click it in the Tab Stop Position box, and then clickthe new alignment option

This paragraph formatting is particularly useful for the layout of headers andfooters.

For more information on headers and footers, see section Modifying areport header or footer.

To select tab spacing format:

1 Select an item.

2 Select Report→Format.

The Format dialog box opens to the Font page.

3 Click the Tabs tab to select Tab spacing format.

4 Select an item in the Available Items pane of the Format dialog box.

The item is highlighted.

5 Type a value in the Tab stop position box.

6 Select an Alignment type in the Alignment groupbox.

7 Click Set to set your tabs definition.

8 Click OK.

Page 116: Sybase PowerDesigner Report Guide

Formatting items

106 PowerDesigner

Editing text

You can modify the text of a text paragraph or a text file in a text editor. Thedefault editor is NOTEPAD.EXE.

To edit text:

1 Double-click a text paragraph or a text file in the report items pane.

The Editor dialog box appears.

2 Type modifications to the text.

3 Click OK.

Formatting a graph

You can apply zoom options and frame options to graphs.

Page 117: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 107

The following zoom options are available for graphs:

Format Option What it does

Fit to Page Centered Centers the graph on a page and, ifnecessary, reduces the graph to fit on onepage

As Paragraph Prints the graph on the next line in thereport and, if necessary, reduces the graphto fit on one page

Custom Zoom Prints the graph on the number of pagesrequired at a percentage print scale

Keep DiagramLayout

— Respects the diagram layout and adapts thezoom to generate one page of the diagramper report page

You can also frame a graph using the Left, Right, Top and Bottom frameoptions in the Graph Format dialog box.

For more information on how to frame a graph, see section Selectingborder format.

To format a graph:

1 Double-click a graph item in the report items pane.

The Graph Format dialog box appears.

2 Select Graph Format options.

3 Click OK.

Page 118: Sybase PowerDesigner Report Guide

Formatting items

108 PowerDesigner

Formatting a list item

List items print in the form of tables. You can format a list item using the ListLayout dialog box, which displays the properties of the selected item.

From this dialog box you can:

♦ Select columns to include in a table

♦ Modify column width in a table

Selecting columns for a table

You can choose the columns to include in a table.

To select columns for a table:

1 Click a list item in the Report Items pane and select Report→Layout.

The List Layout dialog box corresponding to the selected item appears. Itdisplays the names of columns available for the table. A check in theEnabled column indicates a column to include in the table.

2 Click a column name.

An arrow appears at the beginning of the line.

3 Select the Enabled check box to include the column in the table.orClear the Enabled check box to remove the column from the table.

4 Click OK.

Page 119: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 109

Modifying column width in a table

You can indicate column width in tables in one of the following ways:

Width Abbreviation Description

Inches inch Indicates column width in inches

Millimeters mm Indicates column width in millimeters

Percentage % Indicates column width in percentage of theremaining space left by columns defined byinches or mm

To modify column width in a table:

1 Click a list item in the Report Items pane and select Report→Layout.

The List Layout dialog box appears. The column width appears in theWidth column.

2 Click a column in the list.

An arrow appears at the beginning of the line.

3 Type a width followed by inch for inches, mm for millimeters, or % fora percentage of the remaining space left by the columns defined byinches or mm.

4 Repeat the previous step until all columns have the width that you want.

5 Click OK.

Page 120: Sybase PowerDesigner Report Guide

Formatting items

110 PowerDesigner

Selecting information to display in a card

A card is the property sheet of an object. Each object type in a modeldiagram has its own property sheet, which displays the properties that definethe object.

In a report, card items print in the form of tables. You can select columns toinclude in a table using the Card Layout dialog box, which displays theproperties included in the property sheet of the selected item.

To select information to display in a card:

1 Click a card item in the Report Items pane and select Report→Layout.

The Card Layout dialog box corresponding to the selected item appears.It displays the names of rows available for the table. A check in theEnabled column indicates a row to include in the table.

2 Click a row name.

An arrow appears at the beginning of the line.

3 Select the Enabled check box to include the row in the table.orClear the Enabled check box to remove the row from the table.

4 Click OK.

Shortcuts cardsSelect the Enabled check box for the Class Name row to distinguishshortcuts cards from the other object types cards in the generated report.

Page 121: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 111

Hyperlinks for object cards in HTML reportWhen you generate an HTML report that contains a diagram graphic andthe object cards of the symbols, hyperlinks are created between thediagram symbols and the corresponding object cards. You can click asymbol in the diagram to access the object card that corresponds to it inthe HTML page.

Page 122: Sybase PowerDesigner Report Guide

Setting up report pages

112 PowerDesigner

Setting up report pagesBefore you print a report, you can set up its pages as follows:

♦ Include a header and footer in each report section

♦ Include a title page for the entire report

These options do not correspond to items in the Report Items pane.

Page setupWhen you define a page setup, it only applies to the current section.

Paragraph numberingIf you do not want the paragraphs of your report to be numbered whenprinted, select the check box No paragraph numbering in the reportproperty sheet.

Modifying a report header or footer

The Report include a default header and footer, which you can modify.

Headers and footers that you modify from the Report menu only apply toRTF reports. Headers and footers in HTML reports are defined in the HTMLFormat page of the report property sheet.

For more information on headers and footers in HTML reports, seesection Customizing an HTML report.

Each report section has its own header and footer.

Headers and footers can include the following variable information that applyto RTF reports only:

Current DateCurrent TimePage NumberModel NameModel CodeModule NameApplication Name

Page 123: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 113

To modify a report header:

1 Click the root node in the Report Items pane.

2 Select Report→Header/Footer.

The Header and Footer dialog box opens to the Header page.

3 Type changes to header text.

The User-Defined Header check box is automatically selected as you areno longer using the default values of the report language resource fileyou selected for your report.

Tabs in a headerUse the key combination CTRL+TAB to insert tabulations in a headeror open the Tabs page in the Format dialog box to set tab stop values.

4 Position the cursor in the header text where you want to add variableinformation.

5 Click the Insert button and select a field from the dropdown listbox.

6 Click the Format button.

Header

Page 124: Sybase PowerDesigner Report Guide

Setting up report pages

114 PowerDesigner

The format dialog box opens to the Font page.

7 Select format options.

8 Click OK in each of the dialog boxes.

To modify a report footer:

1 Click the root node in the Report Items pane.

2 Select Report→Header/Footer.

3 Click the Footer tab.

4 Type changes to footer text.

The User-Defined Footer check box is automatically selected as you areno longer using the default values of the report language resource fileyou selected for your report.

Footer

Page 125: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 115

Tabs in a footerUse the key combination CTRL+TAB to insert tabulations in a footer oropen the Tabs page in the Format dialog box to set tab stop values.

5 Position the cursor in the footer text where you want to add variableinformation.

6 Click the Insert button and select a field from the dropdown listbox.

7 Click the Format button.

The format dialog box opens to the Font page.

8 Select format options.

9 Click OK in each of the dialog boxes.

User-Defined check boxWhen you type changes in the Header and Footer box, the User-Defined check box is automatically selected as you are no longerusing the default values used in the report language resource file youselected for your report. To revert to the default value, deselect theUser-Defined check box. For more information on report languageresource files, see chapter Using the Report Editors.

Page 126: Sybase PowerDesigner Report Guide

Setting up report pages

116 PowerDesigner

Including a title page

A title page prints as the first page in a report. You include a title page oncefor the entire report.

A title page can include any of the following information:

Information Prints

Title Free text, by default the name of the current report

Author Name of the report author, as indicated in the Version Info tab ofthe model property sheet

Date Date when the report is printed. This box is initialized with thecurrent date

Version Version number of the report, as indicated in the model propertysheet

Summary Free text describing the report

To include a title page in a report:

1 Select Report→Title Page

The Title Page dialog box appears. By default, the Include title pageradio button and all the optional fields are selected.

Page 127: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 117

2 Select the check boxes corresponding to information to include in thetitle page and type the appropriate text in each corresponding text box.orClear the check boxes corresponding to information to remove from thetitle page.

3 Click the Format button to customize the title or the optional fields.

The Format dialog box opens to the Font page.

4 Select format options.

5 Click OK in each of the dialog boxes.

Title page in HTML reportThe title page is always generated for a report generated as an HTML file,even if the Include Title Page option is not selected.

Removing the title of an item

You can remove the title of any item in your report in order to ease thereadability of the previewed and generated report. When previewing orgenerating your report, the title of the item is skipped to only display thecontent of the item.

Page 128: Sybase PowerDesigner Report Guide

Setting up report pages

118 PowerDesigner

The following illustration shows a portion of a report preview, with the ShowTitle command selected:

The following illustration shows a portion of a report preview, with the ShowTitle command deselected:

The table of contents also reflects your choice to show or not the title of anitem, depending also on the depth level you have specified in the Formatdialog box of the table of contents.

For more information on the definition of depth levels in a table ofcontents, see section Selecting text to format.

To remove the title of an item:

♦ Right-click an item and deselect the Show Title command in thecontextual menu.orDouble-click an item to open the Editor dialog box and deselect theShow Title check box, then click OK.

The title of the item is not displayed in the previewed or generatedreport.

Page 129: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 119

Modifying report properties

The report property sheet displays the definition of the current report that youcan modify.

A report definition includes the following properties:

Property Description

Name Name for the report. This name makes the report identifiable

Code Reference name for the report

Comment Descriptive label for the report

Language Language of the report. Allows you to change the language of thereport

No paragraphnumbering

When selected, hide section numbers in HTML and printedreports

A report definition also includes the following properties:

♦ HTML Format

♦ Version Info

For more information on HTML Format property, see Customizing anHTML report.

For more information on the Version Info tab, see section DisplayingVersion information in chapter Using the PowerDesigner interface in theGeneral Features Guide.

To modify report properties:

1 Select Report→Report Properties from the Report Editor window.orRight-click the report node in the Browser, and select Properties fromthe contextual menu.

Page 130: Sybase PowerDesigner Report Guide

Setting up report pages

120 PowerDesigner

The report property sheet appears.

2 Type changes to report properties.

3 Click OK.

Customizing an HTML report

From the HTML Format page of the report property sheet, you can customizeHTML reports and define their presentation style (color, font, background,header and footer) using:

♦ Style sheets (CSS files)

♦ Headers and Footers (HTML files)

You can also define the depth level of the table of contents in an HTMLreport.

PowerDesigner ships with a set of predefined style sheets and header andfooter files that you can use to generate your HTML reports. They are storedin the Resource Files\HTML Report Style Sheets folder.

Page 131: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 121

The following table describes the use of classes name in the creation of reportstyle sheets:

Class names Description

BODY Defines the background styles for all report pages,except the home page frame and the browserframe page

.BROWSERBODY Defines the background styles for the browserpage

.HOMEBODY Defines the background styles for the home page

.TEXT Defines the default font styles for text blocks, likedescription, annotation, etc

.TITLE Defines the default font styles for the title of thehome page

TABLE Defines the default styles for tables

TD Defines the default styles for table cells

Table.GRID Defines the styles for object list tables

TABLE.GRID TD.HEADER Defines the styles for the header cells of objectlist tables

TABLE.GRID TD Defines the styles for the cells of object list tablesof even rows

TABLE.GRID TD TD2 Defines the styles for the cells of object list tablesof odd rows

Table.FORM Defines the styles for object card tables

TABLE.FORMTD.HEADER

Defines the styles for the cell name of object cardtables

TABLE.FORM TD Defines the styles for the cell value of object cardtables

Table.TEXT Defines the styles for the tables around the textblocks

TABLE.TEXT TD Defines the styles for the cells of tables aroundthe text blocks

Table.TITLE Defines the styles for the tables around the homepage title

TABLE.TITLE TD Defines the styles for the cells of tables aroundthe home page title

Table.GRAPHICS Defines the styles for the tables around graphics

Style sheetstructure

Page 132: Sybase PowerDesigner Report Guide

Setting up report pages

122 PowerDesigner

Class names Description

TABLE.GRAPHICS TD Defines the styles for the cells of tables aroundgraphics

H1 Defines the styles for level 1 headings

H2 Defines the styles for level 2 headings

H3 Defines the styles for level 3 headings

HR Defines the styles for separator lines

A:LINK Defines the default colors for non-visitedhyperlinks

A: VISITED Defines the default colors for visited hyperlinks

A: HOVER Defines the default colors for highlightedhyperlinks

.BROWSER Defines the default font styles for the browser

A.BROWSER:LINK Defines the default colors for non-visitedhyperlinks of the browser

A.BROWSER:VISITED Defines the default colors for visited hyperlinks ofthe browser

A.BROWSER:HOVER Defines the default colors for highlightedhyperlinks of the browser

TABLE.NAVGROUP Defines the styles for the tables around thenavigation buttons

TABLE. NAVGROUP TD Defines the styles for the cells of tables aroundthe navigation buttons

.NAVBUTTON Defines the default font styles for the navigationbuttons

A.NAVBUTTON:LINK Defines the default styles for non-visitedhyperlinks of the navigation buttons

A.NAVBUTTON:VISITED Defines the default styles for visited hyperlinks ofthe navigation buttons

A.NAVBUTTON:HOVER Defines the default styles for highlightedhyperlinks of the navigation buttons

In a style sheet, you can define font, color, background, size, margin, andalignment for each class name.

When you apply a style sheet to a report, all the options you have definedbefore (ex: font) are no longer taken into account. The styles defined in theCSS file will be applied.

Page 133: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 123

The HTML Format page includes the following properties. Each property isoptional:

Property Description

Style sheet Absolute or relative path of the style sheet file (CSS file).You can browse for a local or shared file (UNC), or type aURL

HeaderLocationHeight

Absolute or relative path of the header file (HTML file).You can browse for a local file or shared file (UNC), ortype a URL

Height in pixels of the upper header

FooterLocationHeight

Absolute or relative path of the footer file (HTML file).You can browse for a local file or shared file (UNC), ortype a URL

Height in pixels of the lower footer

TOCLevelWidth

Number of maximum depth levels to display in the HTMLtable of contents (TOC). 3 is the default level

Width of the table of content expressed as a percentage ofthe total width of the report window

Image FormatPNGJPEG

Format for graphic items associated with diagrams. Duringcompression to reduce the graphic size, the PNGformat (Portable Network Graphic) reduces the loss ofquality but is longer to generate than the JPEG format

List formatNumber of rows per

pageLinks to additional

results

Format for lists.You can define the number of rows you want to display in

the list resultsYou can also define the number of links to additional

results displayed below the list. Additional results arenumbers with hyperlinks to other pages containing thenext rows of the list

Show content in HTML TOCYou can also right-click a node title or an object node in the Report Itemspane and deselect Show in HTML TOC to only display the title of thenode without its content in the table of contents.

For more information on nodes, see section Using nodes.

When you generate an HTML report and want to keep the links associated toyour style sheets (CSS) or headers and footers files (HTML), we recommendyou to gather the linked files in a special folder named as the file to whichthey are associated and located at the same level in your explorer.

HTML reportproperties

Style sheets andheaders andfooters associatedfiles

Page 134: Sybase PowerDesigner Report Guide

Setting up report pages

124 PowerDesigner

For example, the header Header_Blue.html uses files that should be gatheredin folder Header_Blue_files:

This is to make sure that when generating the report, the content of theassociated folders is also copied and links associated to your style sheets andheaders and footers work properly.

Depending on their type of location (local or UNC paths, or URL), stylesheet files and header and footer files are used the following way:

Location Use

Local path or UNC path The HTML or CSS file is copied into the reportgeneration folder

URL The reference in the HTML report uses theHTML or CSS file as it is

By default, PowerDesigner generates in the HTML page a character set(charset) built from the active codepage (Windows-ACP) of the currentsystem.

If the charset is correct the HTML report can be displayed on allsystems.

If the charset is not correct you must create the ReportHtmlCharset keyin [HKEY_CURRENT_USER\Software\Sybase\PowerDesigner 11\General],and give it the value of the codepage that should be generated in HTMLreport.

You can find examples of HTML charset at the following Web address:http://www.w3.org/International/O-charset-lang.html.

To customize an HTML report:

1 Select Report→Report Properties from the Report Editor window.orRight-click the report node in the Browser, and select Properties fromthe contextual menu.

The report property sheet appears.

Location typedependent

Valid codepage

Page 135: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 125

2 Click the HTML Format tab to display the corresponding page.

3 <optional> Browse for a .CSS file or type a URL in the Style Sheet box.

4 <optional> Browse for a local or shared .HTM file, or type a URL in theLocation box of the Header groupbox.

5 <optional> Browse for a local or shared .HTM file, or type a URL in theLocation box of the Footer groupbox.

6 <optional> Type a number in the Level box.

7 Click OK.

When you will generate the HTML report, it will reflect the propertiesyou have defined for the report.

Previous, Next, Home navigation buttonsYou can translate the navigation buttons (Previous, Next, Home)generated by default in your HTML report using HtmlNext, HtmlPreviousand HtmlHome items in the Report Titles\Common Objects category ofthe Report Language Editor. For more information, see section Using theReport Language Editor in chapter Using the Report Editors.

Page 136: Sybase PowerDesigner Report Guide

Setting up report pages

126 PowerDesigner

Default buttonsYou can set as default the current property values for your HTML reportby clicking the Set As Default button.You can also return to the previously saved values, by clicking the Defaultbutton.

Page 137: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 127

Using print previewFrom the Report Editor, you can display a print preview, which shows what areport will look like if printed. Different navigation tools help you find partsof the report to preview.

Opening print preview

You open the Print Preview window from the Report Editor using the PrintPreview tool.

To open the Preview:

♦ Select File→Print Preview.orClick the Print Preview tool in the Report toolbar.

The Print Preview window displays the two first pages of the report ifany.

Page 138: Sybase PowerDesigner Report Guide

Using print preview

128 PowerDesigner

Print preview a report itemYou can rapidly see what a report item will look like if printed. To do so,right-click the report item in the Report Items pane and select Quick Viewfrom the contextual menu that appears. The Print Preview windowdisplays the report item.

Navigating in print preview

In print preview, you can use tools to navigate through the pages in thedisplayed report.

Tool Goes to preview

One page at a time in report

Two pages at a time in report

First page in report

Previous page in report

Next page in report

Last page in report

To navigate in print preview:

♦ Click a navigation tool in the Print Preview toolbar.

Finding an object in print preview

The print preview feature lets you find all references to an object. You canthen go directly to any topic that mentions the object in the current report.

In the case of a multi-model report, you can choose the model in which youwant to search objects.

To find an object in print preview:

1 Click the Find tool.

Page 139: Sybase PowerDesigner Report Guide

Chapter 4 Building Reports

Reports User's Guide 129

2 The Find Objects dialog box appears.

3 (Optional) Select the model you want to search in if you work on a multi-model report.

4 Select an object type from the Object Type dropdown listbox.

5 Select an object name from the Available Objects list.

6 Click the Find button.

7 The Report Topic box displays a list of topics that mention the object.

8 Select a topic in the list.

9 Click the Display button.

The topic you selected appears in the print preview window.

Page 140: Sybase PowerDesigner Report Guide

Using print preview

130 PowerDesigner

Zooming in print preview

You zoom in the preview by clicking inside the preview window. The cursorbecomes a zoom tool.

You toggle between the following two viewing scales:

Scale Description

Whole page Uses a scale that fits the entire page or multiple pages in the printpreview window

Custom view Displays the report in its actual size or in a scale you select

Printing a report from print preview

You can print a report from print preview.

To print a report from print preview:

♦ Click the Print tool.

Generating an RTF or HTML file from print preview

You can generate a report file as an RTF or HTML file from print preview.

To generate an RTF or HTML file from print preview:

♦ Click the Generate RTF or Generate HTML tool.

Closing print preview

To close the print preview:

♦ Select File→Close.orClick the Close tool.

You return to the Report Editor.

Page 141: Sybase PowerDesigner Report Guide

Index

Reports User's Guide 131

Aadd node to report 72

Bborder

format 102width 102

Ccalculated collection 73card

display information 110hyperlinks in HTML report 110shortcut 111

categoryObject Attributes 34Report Titles 34Values Mapping 34

charsetHTML report 124valid codepage 124

closeMulti-Model Report Editor 21preview 130Report Editor from a model 20Report Template Editor 12

columndefault 108, 109table 108width 109

copy item in report 78criterion 84CSS

structure 120style sheet 120

Ddefault

font in report 95value for template 28

Default for HTML report properties 120delete

item from report 78section 32

dependent itemannotation 91begin script 91card 91description 91end script 91object list 91report 72

displaypreview 130toolbar 15

double-clickadd items to report 70

drag & dropadd items to report 70between report editors 70

Eedit text 106editor

Notepad 74text 74

empty section 23expression filter 84

Ffile

graphical 75, 93text 75

filter 84criterion 84

Page 142: Sybase PowerDesigner Report Guide

132 PowerDesigner

filter (continued)define 84filter 84

fontreport 99size 99strikeout 99style 99underline 99

footerassociated files 123frame in HTML report 120modify in RTF report 112

formatborder 102graph 106list item 108paragraph 101report 94report item 94, 95, 96, 99, 101table 108tabs 104text 96, 99, 101title 96

framegraph option 106paragraph 101

free text 93

Ggenerate

as HTML from print preview 130as RTF from print preview 130from existing report 56, 66multi-model report 64quick report 57, 67report 54, 59, 130report as HTML 19report as RTF 19

graphformat 106frame options 106independent item 93package 76report 76, 106zoom options 106

graphical file 75, 93

Hheader

associated files 123frame in HTML report 120modify in RTF report 112

Hierarchical Display 72, 82home 120HTML

file 54, 64generate file 19insert page break 93report 19, 130

HTML reportcharset 124CSS file 120customize 120Default 120footer 120header 120package tree view 19report generation folder 19Set As Default 120style sheet 120table of contents 120

Iinch 109indented paragraph 101independent item

graph 93page break 93table of contents 93text 93

itemadd to report 70multiple selection 94, 96remove title 117show title 117

JJPEG

graphic format 120justified paragraph 101

Page 143: Sybase PowerDesigner Report Guide

Reports User's Guide 133

Llanguage

attach to a report 46change in a report 46in a report template 7

listcustomize columns and filter 78enable/disable filter 78include shortcuts 78include sub-objects 78include sub-objects using same namespace 78item 108

Mmillimeter 109MMR file 21model

report 51, 54, 56, 58select 7

modifyreport template 10section 28

multi-model report 60, 61, 66create 61generate 64modify 66print 64save 68template 3

Multi-Model Report Editor 3close 21open 15

Nnavigate in preview 128navigation option

home 120next 120previous 120

next 120node title 88Notepad 74

Oobject

define ordered selection 82report 78report node 87, 88save selection 21

object-dependent itemmodify 91print 92report node 87, 88

openMulti-Model Report Editor 15preview 127Report Editor from a model 13Report Language Editor 37Report Template Editor 4

Ppackage

graph 76HTML report 19report node 87, 88

package hierarchy 72page break

HTML 93independent item 93

page setup 112paragraph

frame 101indent 101justify 101numbered 112, 119tab space 101

percentage 109PNG

graphic format 120position item in report 76, 77preview

close 130display 130navigate 128open 127print 127, 130quick access 127report 18, 127, 128, 130report item 127search 128

previous 120

Page 144: Sybase PowerDesigner Report Guide

134 PowerDesigner

printmulti-model report 64preview 127, 130report 19, 54, 130report node 86

propertycode 119comment 119language 119name 119no paragraph numbering 119report 119

property sheet of a report 119

Rremove

item title 117report

add item 70add node 72calculated collection 73copy item 78create 17, 51define default font 95definition 2delete item 78dependent item 72depth level 77display preview 130filter criteria 84font 99format 101generate 54, 130generate as HTML 19generate as RTF 19generator 59global format 94global object selection 78graph 76, 106hierarchy 77include shortcuts 78mapping table 34, 38, 41model 51, 54, 56, 58modify 56modify property 119multi-model 61, 66multi-select items 70object selection in report items 81, 82

report (continued)outline 77page break 93page setup 112paragraph 101position item 76, 77preview 18, 127, 128, 130print 19, 54, 130property 119property sheet 119quick generation 57, 67refine object selection 78save 20, 58select object 78sort criteria 81summary 116template 3text 74, 75title page 116toolbar 15translate object property value 41translate property names 38translate report titles 38

Report Editor 3, 13, 18, 19close from a model 20multi-model 3open 13open from a model 13organize 22

report item 91dependent 72, 86format 94, 95, 96independent 70, 93model-dependent 70, 91node 70object list 70object-dependent 70quick preview 127type 70

report languagedefine 34resource file 38, 46translate 38translation examples 38

Report Language Editor 3define 34open 37translate resource file 38

report node 72, 86dependent item 86, 87

Page 145: Sybase PowerDesigner Report Guide

Reports User's Guide 135

report node (continued)modify title 88object 87, 88object-dependent 87, 88, 91package 87, 88print 86template 87title 87, 88

report template 3, 50, 60create 7language 7modify 10node 87standard 6

Report Template Editor 3, 4close 12open 4

resource file for report language 34, 38, 46RTF

file 54, 64generate file 19report 19, 130

RTPfile 7, 10save 7, 10

Ssave

multi-model report 68object selection 21report 20, 58

Save As Default in HTML report 120search in preview 128section 22

create 22create from a template 24delete 32empty 23modify 28numbered 112, 119rename 30

selectmodel 7

shortcutcard 111include in a report 78

Show content in HTML TOC 123Show levels to 98

show title 117standard report template 6style sheet

associated files 123CSS file 120customize 120HTML report 120structure 121

summaryreport 116title page 116

Ttab

alignment 104format 104position 104

tab space in paragraph 101table

column 108, 109default 108, 109format 108

table of contentsHTML report 120independent item 93insert 74limit depth level 98, 123page break 74

templateapply default values 28create from a report section 26modify 10multi-model report 3re-apply default values 28report 3, 50standard 6

textedit 106editor 74file 75font 99format 96, 99, 101independent item 93paragraph 74title 88, 96title page 116

text paragraph 93

Page 146: Sybase PowerDesigner Report Guide

136 PowerDesigner

titleformat 96free text 88removed from report 117report node 87, 88text 88, 96

title pageauthor 116date 116description 116report 116summary 116title 116version 116

toolcustomize columns and filter 78deselect all 78enable/disable filter 78include shortcuts 78include sub-objects 78include sub-objects using the same namespace

78move selection to bottom 78move selection to top 78select all 78use graphical selection 78

toolbardisplay 15report 15

translate report language 38TXT file 75, 93typographic conventions viii

XXHTML

generate file 19report 19

Zzoom for graph 106