Working With The RTF Generator - Enterprise Architect

3y ago
39 Views
2 Downloads
642.32 KB
39 Pages
Last View : 13d ago
Last Download : 3m ago
Upload by : Wade Mabry
Transcription

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comUsing EAWorking withthe RTFGeneratorby Dermot O’BryanAll material Sparx Systems 2009http://www.sparxsystems.com Sparx Systems 2009Page1

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx oft, Microsoft Word are trademarks or registered trademarks of the Microsoft Corporation.All other product and / or company names mentioned within this document are used for identificationpurposes only, and may be trademarks or registered trademarks of their respective owners. Sparx Systems 2009Page2

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comTable of ContentsINTRODUCTION TO RTF DOCUMENT GENERATION.4HOW TO GENERATE RICH-TEXT DOCUMENTS .5INTRODUCTION TO THE RTF EDITOR .6SECTIONS WINDOW .7CONTENT WINDOW .7MENU OPTIONS .8SIMPLE SETUP OF A DOCUMENT.9COPYING A TEMPLATE .9MODIFYING A TEMPLATE .9Re-ordering Sections .9Adding a New Section .10Removing a Section.11STARTING A DOCUMENT FROM SCRATCH .12CREATING A NEW TEMPLATE .12RECURSION THROUGH PACKAGES AND ELEMENTS .12FORMATTING .151.2.3.4.5.6.7.8.9.10.11.HEADER AND FOOTER .15TABLE OF CONTENTS (TOC).15GROUPING WITH TABLES .16DIAGRAM LAYOUT FOR RTF REPORTS .19REPORTING ON DIAGRAMS WITH ELEMENTS FROM OTHER PACKAGES .21INCLUDE OR EXCLUDE A PACKAGE IN THE RTF REPORTS .21DOCUMENTING LINKED DOCUMENTS AND DOCUMENT ARTIFACT ELEMENTS .22NUMBERING .23CREATING AND EDITING STYLES .27DEFAULT TEMPLATE: NORMAL.RTF .29IMPORTING A COMPANY TEMPLATE .29SETTING DOCUMENT OPTIONS.30Settings for the Current Run of a Document.30Default Settings for a Document.30Options tab .31The Advanced Settings tab.32Filtering .32USING THE SEARCH VIEW TO CREATE RTF DOCUMENTS .33VIRTUAL DOCUMENTS.35SUMMARY.36APPENDIX .37ADVANCED FACTORS TO CONSIDER WHEN GENERATING DOCUMENTS .371.Creating Word Master Documents.372.Setting the Default Viewer.373.Overwriting Document Fields (Open Office) .375.Adding Specific Tagged Values Views to Sections .38 Sparx Systems 2009Page3

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comIntroduction to RTF Document GenerationEnterprise Architect provides a powerful mechanism for generating high-quality,customized documents directly from the UML model. This whitepaper gives a broadintroduction to using the Rich Text Format (RTF) report generator for creating customreports from Enterprise Architect (EA).Enterprise Architect supports the definition of reports that are output in RTF. Rich-Textis a format familiar to many word processors; in particular it is supported by MicrosoftWord, which is common to many desktops.The RTF report generator allows users to define a structure for a report to be generated,along with layout and formatting, to suit their specific needs. By adding tables ofcontents, figure tables, headers and footers, and sections, you can create a layout for acomplex document with relative ease.Since many corporations have their own standard report formats, Enterprise Architectprovides an easy-to-use, yet powerful facility for customizing its document generator tomeet these standards.The general topics covered in this paper are listed below.How to generate Rich-Text documentsHow to access the RTF report generator and generate a document.Introduction to the RTF editorUsing the WYSIWYG editor for customizing document templates in EnterpriseArchitect.Simple setup of a documentHow to create a simple document using an existing document template.Starting a document from scratchA step-by-step guide to the creation of a document from scratch.FormattingAn overview of various features and hints when using the generator.Appendix – advanced factors to consider when generating documentsAdditional tips on how to take advantage of the RTF generator. Sparx Systems 2009Page4

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comHow to Generate Rich-Text DocumentsEnterprise Architect can generate Rich-Text reports for an entire model package, or forselected results of a model search.To generate a report of the currently selected Package in the Project Browser: Right-click the package in the Project Browser and select Documentation Rich Text Documentation from the context menu; or Select Project Documentation Rich Text Format Report from EA’s mainmenu; or Use the F8 keyboard short-cut.To generate a report based on the results of a model search: Right-click selected elements and choose from the RTF Report options.The “Generate RTF Documentation” dialog box will be invoked, as shown below.The simplest process for generating a report from here is:1. Select a template from the Use Template drop-down list.2. Click on Generate to create the document.3. Use the View button to see the generated document. Sparx Systems 2009Page5

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comThe rest of this whitepaper describes approaches for customizing report templates. Ifyou require further information on getting started with the Rich-Text report generator,please refer to the EA help topic: Creating Documents RTF Report GeneratorIntroduction to the RTF EditorWhen initially using the RTF report generator, the key window that any user shouldbecome familiar with is the RTF editor. This section gives a brief overview of the keyfeatures in the editor, along with methods for accessing it.The editor is accessible from the Generate RTF Report window shown above. Toaccess this, from the main menu, select Project Documentation Rich Text FormatReport, or press F8.The Edit Current option is only available to user created templates. It is not enabled forexisting system templates. To create a copy of a system template to be edited take thefollowing steps:1. In the Use Template drop-down select New Template to create a newtemplate.2. In the New Document Template dialog box, fill in the following:a. New Template: Give it a name (e.g. “NewTemplate”).b. Copy Template: Select a template type (e.g. {requirements template}.)3. Press OKThis will open the editor as shown below.Figure 1 – RTF Template EditorThis editor consists of three key areas, as highlighted in the above diagram. These are:1. Sections2. Content3. Menu Sparx Systems 2009Page6

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comAlso marked above is an example of a Field {Pkg.name}. A Field produces the final textto be generated in the report.The details of the area are as follows:Sections WindowThis is a tree of model items that can be placed in the report. These items are related toPackages, Elements and Diagrams in the repository. Ticking one of these boxes will inserta Section such as a ‘Package’ or ‘Element’ (see Figure 2 below). Each Section has aspecific set of Fields.Figure 2 – Sections AreaSections in this tree can be moved within their parent Section (see the hands at the top).This allows the user to define the precedence of Sections. For example,Package::Diagram can take precedence over Package::Element by selecting it and movingit above Package::Diagram.Content WindowThe content window contains the structure for defining the document contents. Part ofthis structure is created by selecting items from the Sections window. This creates abracketed Sections area for adding Fields (i.e. diagram diagram). See Figure 3 –Contents Area below.Figure 3 – Contents Area Sparx Systems 2009Page7

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comOnce a bracketed Section area is created in the Contents area (see diagram diagram in Figure 3 – Contents Area). The user then has the option of right-clickingwithin the Section group and selecting from the context menu any Field related to thisgroup. Figure 4 is an example of the context menu shown when the cursor is in theDiagram Section.Figure 4 – Inserting FieldsAt any point, the user can create additional text or format the text within the group area.Menu OptionsThe main menu of the editor provides a set of standard editing features for modifying thetext and adding structural definitions. Some of the key features, such as numbering andstyles, will be covered in the sections below. Sparx Systems 2009Page8

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comSimple Setup of a DocumentIn this section we will run through the scenario of setting up a simple document bycopying an existing template, making modifications to the document format, and savingthe new document template.Copying a TemplateTo copy an existing RTF document template, perform the following:1. From the main menu, select Project Documentation Rich Text FormatReport.2. From the Use Template drop-down, select New Template .This will bring up the “New Document Template” dialog window, shown below.Figure 5 – Creating/Copying a Template3. In New Template textbox, type in a new name for your report (e.g. ‘EditedBasic Template’)4. In New RTF Document Template window, select from the Copy Templatedrop-down {Basic Template}.This will open the RTF editor ready for you to start editing the new template ‘EditedBasic Template’ based on the {basic template}.Modifying a TemplateWhen modifying a template there are numerous functions that can be performed tochange the template. Some of the key functionality supports the addition and removal ofDocument Sections and Fields.The following runs through the process of adding and removing a Section, changing theorder of Sections, as well as adding Fields to this Section.We have created a copy of the basic template above. We can now add a new Section tothis report. A Section that is not shown on the {basic template} is the Element::RiskSection. We will move this to the top of the element Section and then add it as a newSection.Re-ordering SectionsIn the Sections View select the Risk section. Use the Up/Down arrows (shown below)to move the Risk section up to the top of the Element grouping. Sparx Systems 2009Page9

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comAdding a New SectionTo add the Risk Section to the Content template, select the box for the Risk Sectionand click on it to create a tick in the box.This will create the tags for the Risk Group in the Content Area.Right-clicking between the risk group tags risk. risk prompts the user with adrop-down list of available fields to add for risks.For consistency with the rest of this report we can add these fields into a table.Between the risk tags risk. .risk – highlight “ insert Risk contenthere ”o To add a table, from the main menu, select Table Insert Table. Whenprompted for rows and columns, set the rows to two and columns to four.This should create the table as follows:o Sparx Systems 2009Page10

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comPlacing the titles in the first row will set the generator to show the titles as the firstrow for the Group.To add the Risk Fields, right-click in the second row and select the appropriate fieldsto add within each column.Note: Remove any lines between the end of the table and the end ofthe risk section to ensure the table does not create extra lines whengenerated.Once this is complete you can save the document. From the main menu, select File Save. This will save the document in the repository under the title it was created as.Generating Edited ReportsTo run and test this, perform the following:ooooooClose the Documentation windowSelect a package to report onPress F8In the Generate RTF Documentation window using the drop-down UseTemplate, select the report just saved (i.e. ‘Edited Basic Template’)Click on Generate to start the report generationOnce completed select View to display the completed report.While the template is still selected in the drop-down, further editing can easily beaccessed here by selecting the Edit Current button.Removing a SectionRemoving a Section from the report generator is straightforward. When in Edit mode,simply click on the tick box associated with the Section to be removed. Deselecting itwill remove the section from the Content area, including any fields or child Sections. Sparx Systems 2009Page11

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comStarting a Document from ScratchWhen starting a new document from scratch, there are a number of features that are notso obvious when using a predefined template. This section will run through thesefeatures with recommendations on using them. This section will also cover someadditional features used to personalize the document defined in the template.Creating a New TemplateTo start with, we will create a new RTF template. To create a new template, performthe following: Open the Generate RTF Documentation window (or press F8)From the Use template drop-down select New Template In the New template field add a name for the documentIn Copy template set this to NonePress OKThis will create a new blank document ready for editing in the Document Editor.Before adding Document Selections and Fields to the Content area, a key factor is toset the Sections to support recursion through the packages, as well as the order ofitems within the Section grouping. We will also look at a number of key options forsetting up formatting within the document to create a corporate standard document.Recursion Through Packages and ElementsMost documents you create will use the Package and Element Sections. By defaultthese are set to return just the current package that is selected in the Project View. It is acommon scenario that the child packages and child elements are to be presented in adocument. To set this so that it recursively returns these children, set Child Packagesand Child Elements at the base of the Sections Tree.Note: Post version 6.5, the Parent and Element child Sections are nowset on, when creating Package and Element Sections respectively.In addition to the Child Packages and Child Elements, do the same for theElement::Diagram to include the diagram contained in a child element.There are a set of Child Document sections that work in this manner. The following is atable of Child Documents sections with their corresponding Parent section. Sparx Systems 2009Page12

Enterprise ArchitectSeries: Using EAWorking with the RTF GeneratorUML 2 Case Tool by Sparx Systemshttp://www.sparxsystems.comChild SectionPackage- Child PackagePackage- ElementPackage- Element- DiagramPackage- ElementPackage- Diagram- ConnectorSection Rendered when used as a placeholderPackagePackage- Element- Child ElementPackage- DiagramPackage- Diagram- ElementPackage- Element- ConnectorWith these particular sections you can choose to populate a recursive section withtemplate content or leave it unpopulated. The two possible results of this are as follows:¾ If it is populated, it will render the template with the child section layout.¾ If it is left unpopulated, it will use the content from the parent template.Example of a Rendered Child SectionThe example below (Figure 6) shows a template with content between the childelement tags. In this example, as it contains content and fields, the child elements of theparent are rendered using the Child Elements section.Figure 6 – Child ElementsBelow is a simple sample of the o

introduction to using the Rich Text Format (RTF) report generator for creating custom reports from Enterprise Architect (EA). Enterprise Architect supports the definition of reports that are output in RTF.

Related Documents:

May 02, 2018 · D. Program Evaluation ͟The organization has provided a description of the framework for how each program will be evaluated. The framework should include all the elements below: ͟The evaluation methods are cost-effective for the organization ͟Quantitative and qualitative data is being collected (at Basics tier, data collection must have begun)

Silat is a combative art of self-defense and survival rooted from Matay archipelago. It was traced at thé early of Langkasuka Kingdom (2nd century CE) till thé reign of Melaka (Malaysia) Sultanate era (13th century). Silat has now evolved to become part of social culture and tradition with thé appearance of a fine physical and spiritual .

How I Met RTF Working on a strike. Created 6 new evasion profiles in Ruby (Not better than Python) . Rich Text Format (RTF) \*\featureDemo1 Build an RTF doc from scratch Use an RTF doc to perform a DB . header for RTF Scrutinize \*\generator tags Focus on required parameters first Lookout for .WIZ and .WBK! Disable Packager Objects

Fig2.1.rtf Sample Intended Practice Plan Questions Fig3.1.rtf Sample Initial Application Questions Fig3.2.rtf Sample Policy and Procedure: Clinical References Fig3.3.rtf Professional Reference Questionnaire Fig3.4.rtf Sample Policy: Placing the Burden on the Applicant Fig3.5.rtf Notification of Incomplete Application

On an exceptional basis, Member States may request UNESCO to provide thé candidates with access to thé platform so they can complète thé form by themselves. Thèse requests must be addressed to esd rize unesco. or by 15 A ril 2021 UNESCO will provide thé nomineewith accessto thé platform via their émail address.

̶The leading indicator of employee engagement is based on the quality of the relationship between employee and supervisor Empower your managers! ̶Help them understand the impact on the organization ̶Share important changes, plan options, tasks, and deadlines ̶Provide key messages and talking points ̶Prepare them to answer employee questions

Dr. Sunita Bharatwal** Dr. Pawan Garga*** Abstract Customer satisfaction is derived from thè functionalities and values, a product or Service can provide. The current study aims to segregate thè dimensions of ordine Service quality and gather insights on its impact on web shopping. The trends of purchases have

Blade 330X 2200mAh 3S 11.1V 30 C Li-Po Akku (nur in RTF version) 3S LiPo Balancer Ladegerät (nur in RTF version) DXe Sender (nur in RTF version) 4 AA Batterien (nur in RTF version) Airframe Blade 330 X Motor 440H Brushless Aussenläufer, 4200Kv Empfänger BLH4002 Receiver and Flybarless Controller for 330X ESC 45-Amp .