Home

Generating Documents.book

Contents

1. a Document Manager D Rapid Applics CG_DEMO do ES File Edit Insert Test Options Help layout eons asa 2 0 el rl User Interface Specification For Telephone D Rapid 4pplics CG_DEMO doc de User Interface Elements Specification document Graphic object A Network de Data Elements Nongraphic object E answerStatus de State Charts State chart Sa on de Use Cases Use case b Use case 1 Power on 2 Move UtionOff Sw to on position e Event Util powerOn was triggered F Icons showR SSI called Pa message Union1 ASS sent from Network Test document gt result layout heading A Reports Modes Data Report on Acceptance Test Procedure For Telephone D Rapid Applics CG_DEMO doc de Test 1 Test case b Test case 1 Dial number Move UtitonOff Sw to on position Keypad Pb39 in Status and message area Quick Start This chapter presents a step by step tutorial to guide you through the process of creating a simple specification document in HTML format The document is based on the application Tutorial rpd which you can find in the EXAMPLES folder of your RapidPLUS CD ROM This tutorial explains how to e Open the Document Manager and create a new document layout e Add and update a graphic object e Add a nongraphic object e Generate and view the generated document e Add a state chart e Record and add a use case with screen captures e Add a Simulator and run
2. button in the dialog box to rename i e update all objects in the branch Re evaluation Effects Re evaluating cases Simulators verification test results reports and coverage test results presents outcomes as described in the following table ITEM TYPE Case RE EVALUATION EFFECTS RapidPLUS quickly reruns the case in a separate window and incorporates any changes made to graphic objects C NOTE If the Prototyper window is open when you re evaluate a case you must make sure that it is large enough to contain the whole application otherwise you may lose part of the case graphics The re evaluated case also reflects any changes made to filters in the Cases tabbed page of the Document Manager Options dialog box Simulator RapidPLUS repackages the application using the same ZRP name and path specified when you inserted the Simulator External files such as user objects and multimedia files added to the application since the package was created are automatically added to the re evaluated package NOTE The Simulator is automatically re evaluated whenever the document is generated RE EVALUATING ITEMS ITEM TYPE Verification test results 77 RE EVALUATION EFFECTS RapidPLUS checks if there are any discrepancies between the verification test s mode name in the document layout and the mode name in the application If a discrepancy is found a message appears Document Manager D
3. Preview Examples of events that Lamp drag to 10 10 would show in the Lamp1 drag to 20 20 generated document Lamp1 drag to 30 30 Lamp1 drop Potentiometer set to 1 Potentiometer set to 2 Potentiometer set to 3 Potentiometerl set to 4 PushButtoml in Choose to show pushbutton in out or both in IV Object drag positions PushButton1 out OPTION DESCRIPTION Pushbutton events generated document Mouse move When selected includes the mouse move events that events are generated while the use case is recorded NOTE This filter is only relevant if the mouse object is activated Potentiometer Deselecting the option removes all sequenced changes interim events when moving a potentiometer Only the last event is included Object drag Deselecting the option removes all sequenced positions interim events when dragging an object Only the last event is included NOTE When a case is re evaluated the current event filter settings take effect DESIGNING THE LOOK OF GENERATED DOCUMENTS 60 Specification Test Options The Specification and Test tabbed pages present template options for each document type General Editor lx Objects Sh State Charts UY Cases Specification E Test m Templates m Layout structure Browse template uis r Document header Browse uishe Case trailer Browse AE Specification tabbed page
4. ee ee 13 Step 4 Generating and Viewing the Document 0 02008 14 Step 5 Adding a State Chart co mments 17 Step 6 Adding a Use Case caia as A ER a Ra OT ava IE RAR eS 19 Step 7 Adding a Simulator aii a eee ee ere te tte pe io eee OE 21 Step S Adding Free Text ses is oot PR tana et AL a Se a Sa LS SA oa a 22 CHAPTER 3 BUILDING DOCUMENT LAYOUTS o o ooooooooo o 25 Managing Document Layout Files o o ooooo oo ee eee 26 Creating a Document Lay0Ut e 26 Opening a Document Lay0Ut ee ee eee 26 Saving a Document Layout e 28 Closing a Document Layout 2 2 0 0 e 28 iv CONTENTS Managing Document Items 2 eee 29 InSerting Hem a Ge ea ean Gat lees a oe ease ga Saige Be LS Sees 29 Editing Items ses od accede ag A amp a PGE ee Hs aoe 38 Working with Cases uote eee A A eo Pa ee de a eee 41 Cases in the Document Layout 2 0 0 0 00 02 ee eee eee ee 41 Recording and Inserting a Case 2 eee 43 Adding Items to a Case Continue Case 2 ee 44 Capturing an Images s ex cas ee ew BES A we ee a 44 Rearranging Case lteMS eee 45 Playing Back Gases tii ot eye be estes eden Bd eB ne Mapes gh ae cen rad 46 CHAPTER 4 DESIGNING THE LOOK OF GENERATED DOCUMENTS 49 Setting Globa Options s sa ag soy eee EM ere eet AE ag a Ee 50 General OptOns Fars yanata ae Fae ee Sid a ae EOS He EA ek ale
5. ATP vertest atp x Vertest Mode name has changed rename Vertest to VERTEST1 No Yes to al Click Yes to update the mode name in the document layout Click No to leave the mode name unchanged in the document layout the item will not be included in the generated document Report Any changes to modes or objects are reflected in the re evaluated report RapidPLUS also checks if there are any discrepancies between the report s mode name in the document layout and the top mode of the report If a discrepancy is found a message appears as shown above for verification test results NOTE Reports are automatically re evaluated each time the document is generated State chart RapidPLUS checks if there are any discrepancies between the state chart s mode name in the document and the selected state chart mode name in the application If a discrepancy is found a message appears as shown above for verification test results GENERATING DOCUMENTS BREAKING LINKS There may be situations in which you want to break the link between documents or document items and their sources in the application In particular you may want to annotate or change the bitmap of an item in the output document without worrying that the annotations or changes will be overwritten when the document is regenerated Rather than making your changes in the output document you can break the item i e turn it into free text wh
6. The test document must contain at least one test case on which to base a coverage test To run a coverage test 1 Select a heading in a test document layout 2 Choose one of the following options from the Test menu e Coverage Test to analyze a single application e Project Wide Coverage Test to analyze a parent application and all of its user objects NOTE You can also run a project wide coverage test through the Prototyper See the RapidPLUS User Manual Supplement for details RapidPLUS runs the coverage test over all the test cases nested under the selected heading If you want to run the test on all test cases in the document PERFORMING COVERAGE TESTS FOR TEST CASES be sure to select the document layout tree s top heading Any item in the document that is not a test case is ignored When completed the results are displayed in the Coverage test results window like this zal Coverage test results Eel X A COVERAGE RESULTS MODES NOT ACCESSED diskin operate stop run play paused display remain lap TRANSITIONS TRIGGERS NOT EXAMINED powerOn to powerDff D gt amp power_Pb is out TRANSITIONS TRIGGERS NOT ACTIVATED CDPLAYER internal gt Pushbutton1 out amp electricPlugin to electricPlugOut D gt electricPlug_Sw left make amp noDisk to diskin D gt disk_Pb in amp OBJECTS NOT TESTED CDPLAYER song_Stopwatch songTime_Int song_Wav WinHelp simulation_Group NOTE Each user objec
7. the case looks something like this 4 Use Cases Graphic representations of user actions 4 1 Use case 1 Move Sw power to up position Result 1 screen capture Press Pb operate Result 2 screen capture Run button will appear here after a Simulator has been added to the r document Press Pb operate Case trailer inserted by RapidPLUS _ End of Use Case STEP 7 ADDING A SIMULATOR 21 STEP 7 ADDING A SIMULATOR In order to exploit to the fullest the benefits of an HTML document you can add a specially packaged RapidPLUS application called a Simulator to the generated document A Simulator is a Netscape plug in or Microsoft ActiveX version of the RapidPLUS runtime Prototyper When you add a Simulator RapidPLUS automatically packages the application and its associated files such as fonts and multimedia files into a special compressed format The packaged file is included with the HTML document With this file you can play back a case or just run the application To add the Simulator 1 Right click the document layout tree s top heading and choose Insert Simulator from the popup menu 2 Click OK to accept all of the default settings in the Simulator dialog box and create the application package Now that the Simulator has been added a Run button appears at the end of the use case in your generated document You can replay the use case in th
8. List ot user objects List ot intertace elements for selected user object User Object interface filter MYTV M RemoteClick Property M u Union HELP1 2 Select a user object from the left panel Its interface elements are listed in the right panel 3 From the right panel select the elements to be recorded with cases Click OK NOTE Re evaluating a case that includes interface results ignores all existing results and inserts new ones according to the current settings in the User Object interface filter dialog box Selecting Object Events to Exclude You can use the Filter certain events option to include exclude the following object generated events from the generated document e Pushbutton in and or out events e Mouse move events e Interim potentiometer events when changing its position e Interim object drag events when dragging and dropping an object NOTE The filter settings only determine if an event appears in the generated document It always appears in the case in the Document Manager layout SETTING GLOBAL OPTIONS 59 To exclude or include certain object events 1 In the Cases tabbed page click the Filter certain events Filter button 2 Select options as needed Click OK Pushbutton event options Show E vents Filter r Include in cases Pushbutton in Pushbutton out Pushbutton in and out IV Potentiomenter changes
9. and numbered headings are set for each newly inserted document layout item You can override this default by editing the prop erties of individual items in the document layout SETTING GLOBAL OPTIONS 53 Editor Options Free text items i e sections of text or graphics not generated directly from the application are written in a text editor appropriate to the document format chosen in the General tabbed page RTF or HTML The supported editor for RTF documents is Microsoft Word version 6 or higher For HTML documents the supported editor is Netscape version 3 0 or higher The Editor tabbed page presents options for editing free text Shortcut to the driver appropriate text editor General da Editor A Objects Eb State Charts bf Cases Specification E Test m Editor Jeditor m New text template Browse fecittat m Editor behavior JV Launch automatically Template file that opens the first time you edit an empty item Selected to automatically launch document appropriate editor when inserting free text The Editor Shortcut During installation two shortcuts are copied to the RapidPLUS working folder e Editor rtf gives a default path to Winword exe the supported RTF editor e Editor htm gives a default path to Netscape exe the supported HTML editor Before using the Document Manager you must ensure that the shortcut paths are correct for your part
10. changes before RapidPLUS closes the file MANAGING DOCUMENT ITEMS 29 MANAGING DOCUMENT ITEMS You can include the following items in a generated document Graphic and nongraphic objects State charts Use or test case scenarios recorded in the Prototyper which describe how the user interface is operated or tested Free text i e additional text and or graphics HTML documents only Simulator for running the application as executable content in a Web browser Reports about modes objects user object interface elements and overall logic validity You can also insert items from an application s user objects This section describes how to insert each kind of document item Inserting Items The procedure for adding items is the same for all items To insert items into the document layout tree 1 Prepare an item to insert when inserting free text or a Simulator skip this step e Select graphic or nongraphic objects in the Object Layout e Select a mode in the State Chart e Display verification test results or coverage test results e Record a case e Generate a report Select a heading in the Document Manager window 30 BUILDING DOCUMENT LAYOUTS aa 3 Choose an item from the Insert menu Alternatively e Click the appropriate button in the toolbar e Right click the heading and choose the item from the Insert submenu Simulation Objet State Chart Break Generat
11. click the Case button again all the user actions are being recorded as part of the case Carry out the following actions a Click the switch to its on position b Click the pushbutton The lamp should turn on Click the Pause Resume button The Prototyper pauses and a frame used to capture part of the Prototyper appears Move and resize the frame to enclose the entire application including the background frame Click the Capture button to capture an image of the application Click Pause Resume to resume the application Click the application pushbutton again The lamp should turn off Click Capture in order to capture another image By default the capture frame maintains its last position and size Click the Case button to end the case To include the case in the document 1 In the Document Manager window select the Use Case heading in the tree Click the Insert Case button on the toolbar 19 QUICK START 20 Your window should now look something like this Elajs al Sell 40181 8 de Data Elements BE timeout tmr de State Charts Cases are numbered So TUTORIAL sequentially as they are diy Use Cases added to the documen gt be Move Sw power to up position Pb operate in 2 Pb operate out gt resulti Pb operate in zA Pb operate out gt result2 de Reports User action item Result captured item In the generated document
12. click the item and choose Paste Rearranging headings with Alt arrow keys You can use the Alt arrow keys to move a selected item as follows ARROW MOVEMENT up Moves the item up one position among its siblings If the item is the first child in a subtree Alt up acts like Alt left down Moves the item down one position among its siblings If it is the last child in a subtree this action has no effect left Raises the item s hierarchy in the tree by one level If the item is already at the topmost level i e child of the root this action has no effect right Lowers the item s hierarchy in the tree by one level and inserts the item as the child of its top sibling Deleting Items To remove an item and all its children from the tree 1 Select the item 2 Choose Edit Delete or right click the item and choose Delete 3 Click OK to confirm the deletion or Cancel to stop the delete operation WORKING WITH CASES WORKING WITH CASES A case is a sequence of application actions carried out and recorded in the Prototyper There are two types of cases use cases and test cases Use cases are for specification documents They demonstrate how the user interacts with the RapidPLUS application You can divide the application s behavior into several use cases each case demonstrates a related set of actions Test cases are for test documents They demonstrate the test procedures to be carried out on the end product s
13. computers Reports You can insert text reports about objects modes user object interfaces and project components Any of the text reports listed in the Reports menu of the Application Manager can be inserted Reports are updated when the document is regenerated Free Text Free text refers to text and or graphics added in a text editor and then inserted into the document layout Free text is edited in the editor appropriate to your document format RTF or HTML You can use free text items to add information that is not directly generated from the application Chinese text can be added to HTML documents DOCUMENT ITEMS Verification Test Results A verification test is a test performed by the Verification Test tool which checks for modes that cannot be reached or existed transitions that have no triggers and objects that are not referenced in the logic A verification test is inserted using the Insert Verification Test command Coverage Test Results for test documents only A coverage test is a test performed by the Document Manager which reports any modes transitions triggers user functions or objects that are not referenced in the specified test cases A coverage test is inserted using the Insert Coverage Test for a single application or Insert Project Wide Coverage Test for a parent application and its user objects This item is inserted as free text and can be edited accordingly Sample Document Layout Tree
14. document layout Cases can be recorded from parent applications and user objects When you want to record a case from a user object make sure that the user object is in focus via the Project Component list in the Application Manager To record and insert a case 1 Run the application or user object in the Prototyper until you reach the case s initial state i e the state in which the application is ready to demonstrate the user actions relevant to the case 2 To start recording the case choose Controls Case or click the Case button 3 Manipulate controls in the Prototyper until you have covered all of the actions required for the case 4 To stop recording the case choose Controls Case or click the Case button 5 Select the item in the Document Manager tree to be the case s parent and choose Insert Case or right click the parent item and choose Insert Case The case is inserted as the last child of the selected item and is numbered sequentially i e the first case recorded in that document is Use Test case 1 the second case in the same document is Use Test case 2 etc 6 Repeat this procedure for each case NOTES After you reload the parent application as the active application you cannot re evaluate or continue the user object s cases Each time you initiate a case the previous case is overwritten If you have not added it to the tree it is lost 44 BUILDING DOCUMENT LAYOUTS ml Adding Items to a C
15. document layout tree or for just one branch or item Once a document has been generated you can set the Document Manager to automatically update the generated document every time a change is made to the document layout You can also break the link between the document layout and the generated document Generating the Entire Document To generate an output document for the document layout tree 1 Select the top heading of the document layout tree 2 Choose File Generate Document As or click the Generate Document button 3 Specify a file name and location for the output document It is recommended that you put each output document in its own folder NOTE RapidPLUS automatically provides the correct extension RTF or HTML depending on the selected document driver When the generation is complete the name and full path of the output document appear in parentheses next to the top heading of document layout tree Generating a Subdocument Once you have generated an output document for the entire document tree you can follow the same procedure to generate a separate document for any item or branch in the tree This could be useful for example if you are working on a specific section of a large document layout and you do not want to keep generating the entire document in order to view the results You should note that generated subdocuments do not affect the overall output document generated for the entire document layout tree
16. from control message u RemoteClick1 received at MY TW 8 control StendBy out gt resulti diy New Text 9 control CHinc in F message u RemoteClick1 sent from control F message u RemoteClick1 received at MYTY gt 2 result2 control CHinc out The case items are designated by the following icons CASE ICON DESCRIPTION b Each use or test case heading is numbered in the order that it was inserted into the document For instance the Case heading first use case is Use case 1 the second use case is Use case 2 and so on 2 Each action item appears with a heading that describes the user action In the generated document it can Action item include a bitmap of the object manipulated by the action WORKING WITH CASES 43 CASE ICON DESCRIPTION Each result item is a screen image that you captured while recording in the Prototyper By default the Result item heading is numbered in the order that it was captured in the case e g Result 1 Result 2 etc an Each interface item appears with a heading that describes the interface change that took place i e an event User object triggered a message sent and received a function called interface tem or a property changed In the generated document the message sent interface items appear in the Results column Recording and Inserting a Case Cases are recorded in the Prototyper and then inserted into the
17. later The saved file s extension depends on the document type UIS for a specification document ATP for a test document NOTE It is highly recommended that you save each document layout file in the application folder and then create a new folder for the generated document HTML or RTF In the case of an HTML file RapidPLUS automatically saves the document s auxiliary files e g graphic images for each object or state chart recorder files for cases etc in the same location as the HTML file To save document layout information 1 Select the document layout tree by clicking any one of its items 2 Choose File Save or click the Save File button To save document layout information under a different file name 1 Select the document layout tree by clicking any one of its items 2 Choose File Save as and specify a file name and location To save all document layouts currently open in the Document Manager e Choose File Save all The Save As dialog box opens automatically for each document layout that has not yet been saved Closing a Document Layout If you want to remove a document from the Document Manager tree you close the document layout file To close a document layout file 1 Select the document layout tree by clicking any one of its items 2 Choose File Close To close all document layout files at once e Choose File Close all If a document layout has unsaved changes you are prompted to save or discard the
18. net Name of the root object mode chosen for the report Report type NOTE The report item preserves the scope and filter selections made when the report was first generated Every time the item is re evaluated or the document is generated the report is updated dynamically Report Format in the Generated Document The report s header that is application name date and time stamp and report title as seen in the Report Viewer is not included in the generated document Other than the header object and mode tree reports appear in the generated document as they do in the Report Viewer MANAGING DOCUMENT ITEMS The numbered items in object data mode data and user interface reports are integrated into the generated document s numbering system as shown in the following illustration 1 2 4 Modes Data Report tel net 1 2 4 1 MODE tel_net Parent none Type root Note Entry Activities a tel _ net Unionl updateRequest status 0 1 2 4 2 MODE incomingCall Parent tel _ net Type concurrent Transitions a Internal transition al Trigger incomingCall Ph in RSSI_Value lt gt 0 Actions 1 tel_net sendIncomingCall al Trigger incomingCall Ph in RSSI_Value O Actions 1 noLink Window open Inserting Verification Test Results With the Verification Test tool you can perform a basic check on certain aspects of an application s logic design e Modes checks for modes that cann
19. note on the lamp object When the system is powered on the pushbutton turns the lamp on and off 1 2 Pb operate This is a note on the pushbutton When the system is powered on each time you click the button the lamp turns on Gf off or off if on 1 3 Sw power 0 This is a note on the switch object The switch powers the system on and of 2 Data Elements 2 1 timeOut tmr This 5 sec timer is started upon entry to powerOn mode If it ticks before the pushbutton is pressed the system shuts down automatically NOTE RapidPLUS generates the graphics for its HTML documents in PNG format g STEP 5 ADDING A STATE CHART 17 STEP 5 ADDING A STATE CHART To set up and add the state chart 1 In the State Chart window select Tools Options 2 Make sure that No of Levels Shown is set to 3 and that Number Transitions is selected Chart Options xi State Chart Screen Transition Single State Transition Scheme No of Levels Shown a Scheme for exported chart Minimum Name Length KI Settings 3 In the State Chart window select the root mode TUTORIAL 4 Inthe Document Manager window right click the State Charts heading and choose Insert State Chart The window should look like this D Pb operate D Sw power E ey Data Elements BE timeout tmr Ah State Charts S ity Use Cases de Reports Y Updating document ajajajaja jajaja Message that gener
20. right panel will automatically include the following files that are included in an application e An instance of display udo e A sound file applause wav specified for a WaveAudio object RapidPLUS however cannot detect external files that are referenced only in the Logic Editor actions and activities For example the following activity loads data into a data store object from an external text file Names_DS loadFromFile names rds In order for the application to run properly you must manually add this file to the list of files to be packaged NOTE Do not add the application file RPD or RVR to the package It is automatically included 36 BUILDING DOCUMENT LAYOUTS Inserting Reports You can insert the most recently generated RapidPLUS text report as a linked item in the document layout The RapidPLUS text reports include e Objects tree or data e Modes tree and data e User object interface e Components dependencies tree list detailed list and target graphic displays These reports are generated via the Application Manager Reports menu An inserted report appears in the document layout like this Ba Document Manager D Rapid applics CG_Demo Pi E3 File Edit Insert Test Options Help HELLE ajeje el ael User Interface Specification For TEL MAIN RPD D Rapid applic El ey User Interface Elements E de Network User Object PX outgoingCall pb A networkEnd pb E Modes Data Report tel
21. tae tia Sa 51 Editor Options is 06 iho eco a a aa ute ee Seca eles aldo de 28 53 Object Options lt 2 s aas seas eye hoki ard A We A eg DE 54 State Chart OPUS iia ds whe Oe SE ee ON Te RO ed Ae ete a 55 Case and Case Item Options s acri o 0 0 eee eee 56 Specification Test Opti0MS eee 60 Customizing Individual Items ee ee 61 Changing Graphic Object and State Chart Properties 0 0 61 Changing Case and Case Item Properties o oo o o 61 Formatting Cases Examples oo ooo 63 Customizing Document Templates o ooo ooo o e 68 Changing the Default New Layout Structure ooo o 02 000 68 Changing the Document Header 2 0 0 000000 eee eee 69 Changing the Case Trailer e na a ee a a ee es 70 CHAPTER 5 GENERATING DOCUMENTS c c oo oo ooo ooo 0 000 71 The Document Generation Process 1 ee ee 72 Generating and Viewing Output Documents o ooo ooo oo o 73 Generating the Entire DOocUMENt o o ooo ooo e 73 Generating aSubdocument o es 73 Activating Automatic Generation 0 2 ee ee eee 74 Viewing a Generated Document o ooo 74 Re evaluating Items ci A A eae he eed 75 CONTENTS Re valtiating ted oe be SROs a Pee tt a 75 Re evaluation Effects iii A hs Reels o As we SEE aes BRS 76 Breaking LINKS 3 0 ice ab hae dees bee hee ba ote De 78 Breakin
22. the Document Manager Options dialog box When you change an option the change takes effect in the next new document item created so that any existing document items will not be affected by changes to the settings You can also override the global setting and change certain options for individual items You may decide to further customize documents through the use of templates Templates provide defaults for the document layout structure headers for generated documents and trailers for the end of cases in generated documents This chapter presents e Setting global generation options e Editing individual items e Formatting cases showing examples of how settings influence the generated document e Customizing document templates DESIGNING THE LOOK OF GENERATED DOCUMENTS 50 SETTING GLOBAL OPTIONS The Document Manager Options dialog box is used to specify global defaults for each new HTML or RTF document generated The appearance of certain items graphic objects state charts and use cases can be modified individually as described in Customizing Individual Items on p 61 To open the Document Manager Options dialog box e Choose Options Preferences There are seven tabbed pages PREFERENCE General USED TO Select the document driver show hide branch headings in document contents notes and or table of contents number headings set generation options Editor Select a text editor and
23. the application Test cases Used for acceptance test documents to demonstrate the test procedures to be carried out on the end product so that all of its man machine interface functions are tested OVERVIEW Both case types are added using the Insert Case command and you can choose how you want to present the case information For each case inserted the generated document can include e Descriptions of the user actions either textual e g Move Switch1 to up position or Press Pushbutton1 or graphical i e an image of the manipulated object e Screen images that you captured while recording the case e Descriptions of user object interface changes such as functions called or properties changed e In HTML documents A Run button enabling the end user to replay the case in the Simulator Once a case is inserted into the document changes that you make in the RapidPLUS application are reflected in the document when the document is regenerated Simulator for HTML documents only The Simulator is a Netscape plug in or Microsoft ActiveX version of the RapidPLUS runtime Prototyper If you insert the Simulator into your document layout tree the specially packaged RapidPLUS application is automatically embedded in the generated document The Simulator package is updated when the document is regenerated To view a Simulator end users must have the Netscape plug in or ActiveX component installed on their
24. the ellipses with Tutorial rpd STEP 1 CREATING A NEW DOCUMENT LAYOUT 11 3 Click outside the field to accept the change The window should now look like this Ga Document Manager User Interface Specification O ES File Edit Insert Test Options Help aasia kirac e a MEEUser Interface Specification For Tutorial rpd de User Interface Elements iy Data Elements de State Charts de Use Cases de Reports To save the document layout to a file l 1 Choose File Save or click the Save button 2 Save the document layout file with the suggested default name i e the application name with the UIS extension in a new folder called DocManTutorial The document layout file name appears in the Document Manager window s title bar The Document Manager Toolbar The toolbar presents the following tool buttons Insert free text Insert verification test results E e we slale Rr a Generate document Insert case Insert Simulator Insert state chart nsert simulation object New test document New specification document QUICK START 12 STEP 2 ADDING AND UPDATING A GRAPHIC OBJECT In this step you will add graphic objects as user interface elements then rename one of the objects and updated it in the Document Manager To add graphic objects to the document layout 1 2 In the Object Layout select the lamp pushbutton and switch objects In the Document Manag
25. the item STEP 8 ADDING FREE TEXT 23 To edit a free text item 1 Right click the free text item and choose Edit from the popup menu The page reopens in the HTML editor 2 Make the desired changes and save the page RapidPLUS automatically updates the generated document You can view the changes in Tutorial HTML Carry out the following steps in order to a put the introductory statement in its proper place at the beginning of the generated document and b give it a more descriptive heading To change the free text item s position in the tree 1 Select the item 2 Press Alt up arrow until the New Text heading appears above User Interface Elements To rename the New Text heading 1 Right click the New Text heading and choose Rename from the popup menu 2 Type the name Introduction and press Enter to confirm QUICK START 24 The beginning of your generated document after the document header and table of contents should now look something like the following illustration Tutorial Microsoft Internet Explorer ioj x File Edit view Favorites Tools Help Bak gt gt Y A Qsearch Favorites Smeda lt 4 Eh E gt Address E D Rapid DocManTutorial Tutorial HTML Links User Interface Specification For Tutorial rpd 1 Introduction This document provides a full description of the user interface for the system under design 2 User Interfa
26. to record See Selecting User Object Interface Elements to Record on p 58 Filter certain When selected cases can exclude certain object events events Click Filter to select which object events to exclude See Selecting Object Events to Exclude on p 58 Show graphics When selected includes a bitmap of the RapidPLUS object associated with the use case item Graphics scaling The scaling factor for object bitmaps A value of 1 0 means 1 1 or the same size as in the Object Layout 2 0 means 2 1 or twice the size 0 5 reduces the size by half and so on Show Event Shows the RapidPLUS text description of actions and Description interface changes such as Pushbutton in and Cover click The description is the same as the item heading when the case is first inserted in the document layout Changing this default item heading does not affect the description NOTE For examples of how case settings affect the format of cases in the generated document see Formatting Cases Examples on p 63 DESIGNING THE LOOK OF GENERATED DOCUMENTS Selecting User Object Interface Elements to Record When you select the Record interface changes option changes are recorded for all user object interface elements of all user objects To limit the scope of recorded interface changes 1 In the Cases tabbed page click the Record interface changes Filter button The Filter dialog box opens
27. Document Manager can have any number of specification and or test document layout files open simultaneously This section presents instructions to create open close and save document layout files Creating a Document Layout If you want to add a new document layout to the Document Manager you have to create a new file To create a new document layout file e Choose File New and select either Specification Document or Test Document Alternatively click the New Specification Document or New Test Document button A skeletal document layout unique to each document type appears To modify the default skeleton see Changing the Default New Layout Structure on p 68 Opening a Document Layout If you want to work with an existing document layout you add it to the Document Manager by opening its file To open an existing file 1 Choose File Open or click the Open File button iG 2 Browse to a previously saved UIS or ATP file The document layout appears in the Document Manager SHORTCUT A list of recently opened document layout files appears at the bottom of the File menu You can open one of these files by clicking its name MANAGING DOCUMENT LAYOUT FILES 27 Why are item icons crossed out If you open a document layout for a RapidPLUS application that is not currently open all icons for items that are generated directly from the simulation are overlaid with red xs Ba Document Manager D Rapid D
28. GENERATING DOCUMENTS Activating Automatic Generation Once a document has been generated Document Manager can automatically regenerate the document each time a change is made in the layout To activate automatic generation 1 Choose Options Preferences 2 In the General tabbed page select the option Continuous automatic generation of final document Viewing a Generated Document You can open a generated document from the Document Manager window To view a generated document e Right click the top heading of the document layout tree and choose View The generated document will open in the default browser or in Microsoft Word depending on the document driver that was used to generate the file If the Show contents option is selected in the Document Manager Options dialog box see General Options on p 51 a table of contents is automatically generated from the headings Note the following for each document type e RTF You have to update the table of contents field manually by selecting the field and pressing F9 e HTML Each content listing is a hyperlink There is also a hyperlink from the section heading back to the content listing RE EVALUATING ITEMS 75 RE EVALUATING ITEMS If you make any change in the application after you have generated a document you need to relink re evaluate the information Otherwise the affected Document Manager items cannot be included in the generated docume
29. Generating Documents Generating Documents 2004 e SIM Ltd All rights reserved e SIM Ltd POB 45002 Jerusalem 91450 Israel Tel 972 2 5870770 Fax 972 2 5870773 Information in this manual is subject to change without notice and does not represent a commitment on the part of the vendor The software described in this manual is furnished under a license agreement and may be used or copied only in accordance with the terms of that agreement No part of this manual may be reproduced or transmitted in any form or by any means electronic or mechanical including photocopying and recording for any purpose without the express written permission of e SIM Ltd Microsoft Windows ActiveX Access and Excel are registered trademarks or trademarks of Microsoft Corporation in the United States and or other countries Other product and company names mentioned in this manual may be trademarks or registered trademarks of their respective owners Written and produced by e SIM Ltd MAN DOC 8 0 Printed in Israel Contents E NS ie teats fe katy Bale vii CHAPTER 13 OVERVIEW SI LE ae ee Oe EE A SS Oh aE 1 About Document Generation 2 o 2 Document Tesi A eS WP OE BP IRE a dt ae Rea 4 CHAPTER 2 QUICK START q pit ee E Bae ne OO ae ew Ree Oe A 9 Step 1 Creating a New Document Layout 2 2 0 eee 10 Step 2 Adding and Updating a Graphic Object o o o oooooooo oo 12 Step 3 Adding a Nongraphic Object
30. Set options as required OPTION DESCRIPTION Show header When selected the heading Simulator will show in the generated document Stand alone or Embedded Opens the Simulator in either its own window default or embedded in the HTML page BUILDING DOCUMENT LAYOUTS 34 OPTION DESCRIPTION Application size options Sets the Simulator to the size of the application or a custom size in pixels If the application is larger than the Simulator s maximum size scroll bars will appear Package Path The name and path for the ZRP file The default setting is the application name and path Create package When selected the package ZRP file is created when you click OK This option is automatically selected if e The specified ZRP file does not yet exist e Changes have been made to the package Specify package files Select to specify external files to be included in the package see below To specify external files to be included in the package 1 Click the Specify package files button The Package files dialog box opens List ot available tiles List of files to include in the package Package files Rapid way CDROM1 HLP Add gt lt Remove Add Application Files y caps RPD nd T Show full path r Filter Rapid objects RPX UDO RDO C Database and array files ADS RAR Multimedia files WAV FLC AVI C State and recorder files C DLL file DLL C
31. Show headings When selected all document layout headings are included in the generated document Show notes When selected object and mode notes are included in the generated document Object notes appear with inserted objects mode notes appear with inserted state charts Show contents When selected a table of contents is generated from the document layout headings and included in the generated document right after the document header In HTML documents contents entries and section headings have hyperlinks to one another In RTF documents the headings are listed as a table of contents field which must be updated in Microsoft Word by selecting the field and pressing F9 DESIGNING THE LOOK OF GENERATED DOCUMENTS 52 OPTION Number headings DESCRIPTION When selected document layout headings are numbered hierarchically in the generated document For information on how to change the format of the heading numbers in RTF documents see Changing the Document Header on p 69 Generation Options Continuous automatic generation of final document When selected the final document is updated automatically as you update the document layout Update final document even if some items could not be generated When selected the document is generated even if items in the document layout can no longer be linked to the application The Default properties group for headings notes contents
32. Specification amp Test Default properties Y Show graphic Graphic scaling 1 000 SETTING GLOBAL OPTIONS 55 OPTION DESCRIPTION DEFAULT Show graphic When selected includes the bitmap Selected representation of objects in the generated document Graphic scaling The scaling factor for object bitmaps 1 0 A value of 1 0 means 1 1 or the same size as in the Object Layout 2 0 means 2 1 or twice the size 0 5 reduces the size by half and so on State Chart Options da The State Charts tabbed page presents options for displaying state chart graphics and transitions General fy Editor Objects Eb State Charts W Cases Specification Test Default properties Y Show graphic Show transitions Graphic scaling 1 000 OPTION DESCRIPTION DEFAULT Show graphic When selected includes state chart Selected bitmaps in the generated document Graphic scaling The scaling factor for state chart bitmaps 1 0 A value of 1 0 means 1 1 or the same size as in the State Chart window 2 0 means 2 1 or twice the size 0 5 reduces the size by half and so on Show transitions When selected includes a list of Cleared transition triggers to appear after the state chart The list is numbered to correspond with the transitions shown in the chart DESIGNING THE LOOK OF GENERATED DOCUMENTS Case and Case Item Options Me Case items The Cases tabbed page presents o
33. Text files TXT ActiveX controls 00 DLL Images JPG GIF BMP Help files HLP a i r Search directory DAR apid Applics Browse m Embedded true type fonts T Add true type fonts to package MANAGING DOCUMENT ITEMS 2 Determine the necessary settings see also About packaging external files 35 below e Add or remove selected files as required RapidPLUS automatically includes files specified in the Object Layout during the design process e Click Add Application Files to include all RapidPLUS detectable files which may have been removed e Use a filter to determine the file types to be displayed in the left panel e Under Search directory type or browse to folders containing external files used in the application in order to include them in the package e Select to add all application true type fonts to the package About packaging external files A RapidPLUS application may contain external files such as user objects multimedia files DLLs and specialized fonts For the application to run properly in the Simulator you must include its supporting files in the ZRP file The folder hierarchy is preserved so that the application will run properly When you open the Package files dialog box the right panel automatically lists any user objects as well as external files that you specified in the Object Layout during the design process For example the
34. and add text or graphics To add text or graphics to a free text item 1 Select the item heading 2 Choose Edit Edit Item or right click the object and choose Edit The item opens as a temporary file in the default text editor MANAGING DOCUMENT ITEMS R 33 3 Add delete and modify the data When done save the file See Editor Options on p 53 for information on selecting a text editor and setting the editor to launch automatically when adding free text Inserting a Simulator A Simulator is a Netscape plug in or Microsoft ActiveX version of the RapidPLUS runtime Prototyper When you add a Simulator RapidPLUS automatically packages the application and its associated files such as fonts and multimedia files into a special compressed format The packaged file has a ZRP extension and is opened by the Simulator that is included with the HTML document With this file you can play back a case or just run the application A Simulator is always available for insertion when the HTML document driver is set in the Document Manager Options dialog box see General Options on p 51 Inserting a Simulator opens the following dialog box Simulator 2 xi Properties MV Show header C Stand alone r Size Application size C Custom Width 581 Height fai m Package Path C Rapid4 cdplayer Cdplayer 2rp Browse IV Create package Specify package files Cancel
35. ase Continue Case After inserting a case into the document layout you may want to replace some case items with new ones or add items to the case You can accomplish this by using the Continue Case command and then deleting and rearranging the items as needed To append actions results and user object interface changes to a case 1 Select the case 2 Right click and select Continue Case The Prototyper quickly replays all the actions that took place before the case was started and then the actions in the case itself The Prototyper then pauses Click Pause in the Prototyper window to resume the recording 4 When you have finished recording actions and captures click Stop The new actions and captures are automatically appended to the end of the selected case For information about moving case items from one location in a case or document to a new location see Rearranging Case Items on p 45 Capturing an Image At any time while you are recording a case you can capture an image of a selected area of the application by clicking the Capture button The captured image is included as a result item at the appropriate place in the case tree You can capture as many images as you like while recording the case or capture images automatically To change the size and location of the capture frame 1 Choose Controls Pause or click the Pause Resume button An adjustable rectangle appears in the Prototyper window 2 Place an
36. ase 1 and Test case 2 e Free text items have the name New Text You may want to give more descriptive headings to items in your document layout and generated document To rename a heading 1 Make the heading into an editable field by e Selecting the item and choosing Edit Rename or e Right clicking the item and choosing Rename or e Clicking a selected item 2 Type your changes When done press Enter or click outside the heading Rearranging Items The most direct method for rearranging items is with a drag and drop operation NOTE Cases and case items cannot be nested To move an item to a new location e Drag the selected item and its descendants to the desired location The item is added as the last child of the highlighted item To copy an item to a new location e Ctrl drag the selected item to the desired location The item is copied as the last child of the highlighted item NOTE When you drag an item to a different document it is always copied not moved Another method to rearrange items in the document is to cut or copy an item and paste it in another location BUILDING DOCUMENT LAYOUTS 40 To cut or copy an item to the paste buffer 1 Select the item 2 Choose Edit Cut or Edit Copy or right click the item and choose Cut or Copy To paste a cut or copied item 1 Select the item onto which the cut or copied item is to be appended as the last child 2 Choose Edit Paste or right
37. ated document Progress bar shows status is being updated QUICK START 18 In the generated HTML document the state chart looks something like this Numbered and hyperlinked headings Mode notes 3 State Charts 3 1 TUTORIAL TUTORIAL This is a note on the tutorial root mode powerOff The default system mode Nothing happens until the switch makes the transition to powerOn powerOn Tn this mode the system moves from standby lamp off to operate lamp on by clicking the pushbutton standby The default power on mode The lamp can now be activated by the pushbutton operate Upon entry the lamp goes on Upon exit the lamp goes off Source Destination Triggers Actions 1 jpowerOff powerOn amp Sw_power up is connected 2 powerOn powerOff amp Sw_power downis connected 2 powerOn powerOff time Out_tmr tick 3 standby operate Pb_operate in timeOut_tmr stop 4 operate standby Pb_operate in Listing of numbered transitions STEP 6 ADDING A USE CASE la lw E El O N A U E STEP 6 ADDING A USE CASE In this step you will add a use case a sequence of user actions performed and recorded in the Prototyper that demonstrates how the system operates To record the case including screen captures 1 2 9 Start the application in the Prototyper Click the Case button From this point until you
38. bbed page of the Document Manager Options dialog box In addition you may run into problems if your designated template for RTF documents as discussed on The New Text Template on p 54 contains fonts that are not included in the RTF document header DESIGNING THE LOOK OF GENERATED DOCUMENTS Changing the Case Trailer A case trailer appears at the end of every use case or test case inserted in your documents The style and content of case trailers are held in template files located in the Rapidxx folder e For specification documents the templates are uistrail rtf and uistrail html The default case trailer is End of Use Case e For test documents the templates are tsttrail rtf and tsttrail html The default case trailer is End of Use Case You can edit these files directly or specify another template file in the Generated Case Trailer field of the Specification Document or Test Document tabbed page Generating Documents Once you have set options in the Document Generation Options dialog box customized your templates and created your document layout files you are ready to generate your document This chapter presents e The document generation process e Generating and viewing a document e Re evaluating items or branches e Breaking a document or item link 71 GENERATING DOCUMENTS THE DOCUMENT GENERATION PROCESS RapidPLUS combines the document layout information in the Docume
39. ce Elements 2 1 Status LED O This is a note on the lamp object When the system is powered on the pushbutton turns the lamp on and off 2 2 Pb operate LJ This is a note on the pushbutton When the system is powered on each time you click the button the lamp turns on Gf off or off if on 4 gt Done orn S my Computer YA Generated document Congratulations You have completed the Document Manager tutorial You may now want to go to Chapter 4 Designing the Look of Generated Documents to learn how to customize the appearance of your generated documents 25 Building Document Layouts Each generated document is based on a hierarchical document layout created and edited in the Document Manager The document layout information is stored in a file UIS files for user interface specification documents and ATP files for acceptance test procedure documents In the document layout file you build documents by inserting editing and rearranging items This chapter presents e Managing document layout files creating opening closing and saving e Inserting document items e Rearranging and deleting items e Working with use cases and test cases NOTE Settings that determine the appearance of inserted items in the generated document are discussed in Chapter 4 Designing the Look of Generated Documents BUILDING DOCUMENT LAYOUTS 26 MANAGING DOCUMENT LAYOUT FILES The
40. cument layout Adding Free Text to Any Item No matter how well annotated your RapidPLUS application you will probably want to enhance the generated document with further annotations textual graphical or both In addition to individual free text items which appear in the generated document as blocks of text under separate headings you can add free text to any item The free text material appears in the generated document just below the item s heading For example free text added to a graphic object would appear after the heading and before the object s graphic image To add free text to any item 1 Select the item heading 2 Choose Edit Edit Item or right click the object and choose Edit The item opens as a temporary file in the default text editor 3 Add text and or graphics When done save the file After you have saved the file it becomes an integral part of the generated document You can go back to an item and edit it as many times as you like Each time you save your changes the material is modified in the generated document MANAGING DOCUMENT ITEMS 39 Renaming Items Default headings are automatically given to items inserted into the document layout e Simulation objects have the name of the objects from the Object Layout e State charts have the name of the selected mode in the chart e Cases are numbered in the order that they are inserted into the document e g Use case 1 and Use case 2 Test c
41. d size the rectangle so that it encloses the image that you want to capture Click Pause Resume again in order to continue recording the case and click Capture to grab the image within the rectangle 3 To capture another image within the same rectangle simply click Capture or press Ctrl C To capture an image in another area of interest repeat steps 1 and 2 WORKING WITH CASES 45 Automatically Capturing Results You can set the Prototyper so that screen image results are automatically included in the case When automatic capture is enabled before a user input is actually recorded in the case RapidPLUS checks if the image inside the capture area has changed since the last capture If the image has changed a result image is captured and then the user input is recorded The area captured is determined by the last size and location that you set for the result frame For performance reasons mouse move events are not selected Note however that automatic capture can still have an impact on application performance especially when the capture area is large To enable disable Automatic Capture mode e In the Prototyper click the Automatic Capture button or select Controls Automatic Capture Regular Capture button pause Prototyper size and place frame then click Capture h sue E H Automatic Capture button NOTE You can continue to capture images manually even when automatic capture is enabled Rearran
42. e document by clicking the Run button NOTE The Netscape plug in and or ActiveX runtime prototyper must already be installed on your computer QUICK START 22 STEP 8 ADDING FREE TEXT To complete this tutorial you will add an introduction i e free text to your document To check the text editor settings 1 Choose Options Preferences and click the Editor tab 2 Make sure that the options are set as shown Shortcut to driver appropriate editor For details on tailoring this path to your environment see p 53 General da Editor IS Objects Eb State Charts bf Cases E Specification E Test m Editor editor m New text template Browse edt Editor behavior JV Launch automatically To add free text 1 In the Document Manager window right click the document layout tree s top heading and choose Insert Free Text from the popup menu The New Text item is added as the last child under the heading and the default HTML editor Netscape Composer automatically opens the page New Text HTML 2 Type in a brief introductory statement such as This document provides a full description of the user interface for the system under design You could also import graphics into the page When you are finished save the page You can now view the updated generated document Tutorial HTML which includes your free text item If you would like to make changes you can edit
43. e Coverage test results on p 38 Inserting Simulation Objects Simulation objects are available for insertion when at least one active graphic object or nongraphic object is selected in the Object Layout By default the item s heading is the object s name in the Object Layout Underscore characters in the object name are automatically converted to spaces Thus the default heading for the object Power_Sw is Power Sw See Object Options on p 54 for a discussion of the graphic object format in the generated document When an inserted graphic object has children Unnamed children of an inserted graphic object are treated as an integral part of the object and are included in the bitmap of the graphic object in the generated document For example if you used an unnamed label object to identify a pushbutton the label will appear together with the pushbutton in the generated document Named children of a graphic object on the other hand are not included in the generated document For example you may have a switch lamp combination whereby the lamp child of the switch lights up when the switch is turned on The lamp would not appear in the bitmap of the switch in the generated document To include the lamp in the User Interface Elements add it as a separate item or create a group 31 32 BUILDING DOCUMENT LAYOUTS Inserting State Charts A state chart is available for insertion when one is selected in the State Chart windo
44. e S CEE EIE Free Text Se BES Simulator Cut Ctrl X Report Sopy ie Verification Test Paste GrH Coverage Test Results Delete Delete The inserted item appears in the tree as the last child of the selected item To insert items from a user object 1 Select a user object component from the Application Manager E Rapid TEL_MAIN ioj x File View Reports Code Options Help Co co e a esjeals2 gt Dle Edit TEL_MAIN DARAPIDIAPPLICSACG DEMO zl TEL MAIN D RAPIDSAPPLICS SCE DWSARAPIDAPPATEL MAIN RPD Display D SRAPIDSPPLICS CES DEMO WINDOWS RAPIDAPPATEL__ DISP UDO Icons D RAPID APPLICS CG_DEMO WINDOWS RAPIDAPP TEL_ICON UDO s Keypad D RAPID APPLICS CG_DEMO WINDOWS RAPIDAPPSTEL_KPAD UDO File Edt I Messages DARAPIDASPPLICSACG_DEMONWINDOWSARAPIDAPPATEL_MSGS UDO Network DARAPIDAAPPLICSACG_DEMONWINDOWSARAPIDAPPATEL_NET UDO Util DARAPIDASPPLICSACG_DEMONWINDOWSARAPIDAPPATEL_UTIL UDO Select a component to switch to the desired user object view 2 For simulation object state charts and reports follow the usual procedure to insert items For cases see Recording and Inserting a Case on p 43 MANAGING DOCUMENT ITEMS For more specific details about inserting each kind of item see e Simulation objects on p 31 e State charts on p 32 e Cases on p 32 e Free text on p 32 e Simulators on p 33 e Reports on p 36 e Verification test results on p 37
45. e default file Alternatively you could save your desired default structure as another UIS or ATP file and then specify that file as the default layout structure in the Specification or Test tabbed page CUSTOMIZING DOCUMENT TEMPLATES 69 NOTE Remember that changes you make in the Document Manager Options dialog box will be reflected only in subsequent new documents of that type that you add to the Document Manager Changing the Document Header A document header appears at the beginning of every generated document The style and content of the header are held in template files located in the Rapidxx folder e For specification documents uishead rtf or uishead html The default header is User Interface Specification Automatically generated with RapidPLUS e For test documents tsthead rtf or tsthead html The default header is Acceptance Test Procedure Automatically generated with RapidPLUS You can edit these files directly or specify another template file in the Document Header field of the Specification or Test tabbed page Important Information on RTF Document Headers The header for RTF documents is a Microsoft Word template that contains important information on fonts paragraph styles and numbering styles If for example you edit the document header in Word and you disable numbering the generated document will not have section numbers even if the Number Headings option is selected in the General ta
46. elevant case and case item property settings e Table style two columns new row before action e Case items show graphic show headings do not show event description e Include both pushbutton in and pushbutton out events The use case in the document layout looks like this El b Use case 1 pea Move electricPlug Sw to right position 28 power Pb in gt resultl 3 instruction Display click 8 disk Pb in 2 disk Pb out 8 display Pb in 8 display Pb out gt result2 2 instruction Display click 64 DESIGNING THE LOOK OF GENERATED DOCUMENTS The generated output looks like this Action items Move electricPlug Sw to right position Result capture items result power Pb in instruction Display click THSERT MISK disk Ph out arrowr uisa result2 display Pb out instruction Display click Rrwowr RISK FORMATTING CASES EXAMPLES New Row After Each Result Capture The relevant case and case item property settings for this example are e Table style four columns new row after each result e Use case items show graphics show headings do not show event description e Include both pushbutton in and out events The use case in the document layout looks like this Ei b Use case 2 LD Move electricPlug Sw to right position 42 power Pb in gt result ee instruction Display click 8 disk Pb in 8 disk Pb out display Pb in 8 display Pb ou
47. er right click the User Interface Elements heading and choose Insert Simulation Objects The window should now look like this a Document Manager D Rapid DocManTutorial T Mal E3 File Edit Insert Test Options Help Dajee ejeje 2 me User Interface Specification For Tutorial rpd E de User Interface Elements A Lampi D Pb operate D Sw power it Data Elements gh State Charts de Use Cases e Reports Notice that the object names appear without the underscores e g Sw power appears instead of Sw_power To update the document layout after a change 1 In the Object Layout rename the lamp from Lamp1 to Status_LED STEP 3 ADDING A NONGRAPHIC OBJECT 13 2 Inthe Document Manager right click the Lamp1 item and choose Re evaluate The following dialog box opens Document Manager D Rapid DocManTutorial Tutorial UIS E3 Lamp1 Object name has changed rename Lamp1 to Status LED E No Yes to al 3 Click Yes to confirm the change Notice that the item s heading now shows the updated name STEP 3 ADDING A NONGRAPHIC OBJECT In this step you will add a nongraphic object as a data element To add a nongraphic object to the document layout 1 In the Object Layout open the Nongraphic Objects dialog box and select the timer object timeOut_tmr 2 Inthe Document Manager select the Data Elements heading and click the Insert Simulation Object
48. format in generated document 36 37 inserting 29 36 re evaluating 77 result items cases 43 RTF files default editor 53 document driver 51 document headers 69 updating table of contents 74 Run button 46 56 S saving documents recommended file location 28 simulation objects overview 5 inserting 29 31 inserting example 12 13 options 54 61 re evaluating 75 updating example 12 Simulator overview 6 browser requirements vii inserting 29 33 inserting example 21 packaging external files 34 35 re evaluating 76 Specification tab 60 state charts overview 5 generated format example 18 85 inserting 29 32 inserting example 17 options 55 61 re evaluating 77 State Charts tab 55 subdocuments generating 73 T templates case trailer 70 document header 69 document layouts 68 free text 53 54 setting options 60 test cases running coverage tests 79 See also cases use and test Test tab 60 text See free text toolbar Document Manager window 11 trailers case 70 U UIS file extension defined 2 updating items See re evaluating items use cases See cases use and test user interface elements overview 4 5 See also simulation objects user objects inserting items from 30 packaging with Simulator 35 project wide coverage test 7 79 recording and inserting cases 43 recording interface elements 57 Vv verification tests overview 7 inserting results 29 37 re evaluating results 77 viewing a generated doc
49. g at Item Link ia Wk a a PSs Be ae bre oe R 78 Breaking a Document Link 2 ee eee eee 78 CHAPTER 6 PERFORMING COVERAGE TESTS FOR TEST CASES 79 Running a Coverage Test ei A ab Gates ee REN ee i ee ee 79 Coverage Test Warning Messages o ee ee 81 Inserting Coverage Test Results 2 ee eee 82 PREFACE vii PREFACE This manual was written with the assumption that you are familiar with RapidPLUS and Microsoft Windows conventions The Document Manager automatically generates software engineering and specification documents and acceptance test documents directly from RapidPLUS applications Generated documents can be RTF or HTML files To insert text or graphics in addition to the automatically generated content the following editors are supported e Microsoft Word version 6 or higher for RTF documents e Netscape version 3 0 or higher for HTML documents To view HTML documents the following browsers are supported e Netscape 4 04 or higher e Microsoft Internet Explorer 4 x or higher In HTML documents you can include a Simulator which is a Netscape plug in or Mircrosoft ActiveX version of the RapidPLUS runtime Prototyper To view a Simulator end users must have the Netscape plug in or ActiveX component installed on their computers Overview The Document Manager tool is used to create software engineering specification documents and acceptance test documents directl
50. ge of the Document Manager Options dialog box see Case and Case Item Options on p 56 DESIGNING THE LOOK OF GENERATED DOCUMENTS 62 m Properties ME m Use Case Item Properties M Table I Show header Camre f Y Show graphics Graphics scaling fico IV Show Event Description I New row before action I New row after result IV Show arid T Exclude from final document Y Run button I Record interface changes Filter IV Filter certain use case events Events Modified properties will be applied to all use case items under this use case cmos When selected use case items are not included in the generated document but they will take place when the use case is run Remember that these options apply to the use case and all of its case items To change the properties of a SINGLE case item 1 Select the case item heading 2 Choose Edit Item Properties 3 Set properties in the dialog box Messages getMessage number called Ed Properties I Show header IV Show graphics Graphics scaling 1 000 Y Show Event Description I Exclude from final document FORMATTING CASES EXAMPLES 63 FORMATTING CASES EXAMPLES This section presents several examples of case output illustrating various formatting results you receive depending on the properties selected for the cases and case items New Row Before Each Action Item User Event R
51. ging Case Items After you have inserted a case into a document the case tree displays all the action user events interface user object interface changes and result capture items recorded by the Prototyper You can rearrange case items as you would other items in the Document Manager window see Rearranging Items on p 39 Keep in mind that a case or case item cannot be the child of another case or case item i e they cannot be nested NOTE A case item moved outside of a case tree is displayed in the generated document according to its properties but not inside a table See relevant sections in Chapter 4 Designing the Look of Generated Documents The use case may become invalid and will not run in the Simulator as a result of rearranging its items BUILDING DOCUMENT LAYOUTS Playing Back Cases You can play back cases in the generated document or through the RapidPLUS Recorder in the Prototyper Playing Back Cases in the Generated Document You can play back cases in the generated document provided that all of the following conditions are set during development e Your document driver is HTML see General Options on p 51 e You have inserted a Simulator into your document layout see Inserting a Simulator on p 33 e You have chosen to embed a Run button for the case see Case and Case Item Options on p 56 To play back a case Open the generated document and click the R
52. ich can be edited like any other free text item Keep in mind however that free text items cannot be re evaluated You should break an item only if you are confident that its source in the application is not going to change Breaking an Item Link Break the link between a selected item and its source in the RapidPLUS application Remember that once the link is broken it cannot be re evaluated To break an item link 1 Select the item 2 Choose Edit Break Item or right click the item and choose Break Breaking a Document Link You can break the link between a document layout item and its generated document This could be helpful for example when you want to generate a new document with a different document driver To break the link between an item and its generated document e Right click the item heading next to which the name and path of the generated file appear in parentheses and choose Cancel generate The generated file information is removed from the Document Manager window Next time you generate the document you will see the Save As dialog box 79 Performing Coverage Tests for Test Cases In a test document you can run a coverage test on the test cases A coverage test reports any modes transitions triggers user functions or objects of the RapidPLUS application that are not referenced in the specified test cases You can insert the test results into the generated document RUNNING A COVERAGE TEST
53. icular computer When you choose the RTF document driver in the General tabbed page the shortcut in the Editor tabbed page DESIGNING THE LOOK OF GENERATED DOCUMENTS automatically switches to editor rtf similarly when you choose the HTML document driver the Editor shortcut switches to editor htm NOTE Instead of using the shortcuts you can specify a path directly to an editor in this field In this case however you must remember to switch the editor when you change the document driver If you are using Windows NT 3 51 you should always use this method The New Text Template The New text template is used when free text is added to the document RapidPLUS comes with a default template file for each document driver edittxt html and edittxt rtf When you switch document drivers in the General tabbed page the New text template field in the Editor tabbed page automatically points to the correct template file You can edit these files or create completely new files and browse to the appropriate one This field however must point to a valid template file for the editing function to work properly NOTE For RTF documents it is important that the new text template and the document header be coordinated See Changing the Document Header on p 69 for more information Object Options EN The Objects tabbed page presents options for displaying graphic objects General Ay Editor Objects Sa State Charts Wg Cases E
54. imilar 1 In the Document Manager the document type is selected either specification or test A type specific template appears in the Document Manager window 2 Information is inserted into the template such as a state chart use case and report 3 The layout information is saved with a UIS extension for a user interface specification document or an ATP extension for an acceptance test procedure document 4 The inserted items and layout information are generated to an HTML or RTF file At any point you can generate and view the HTML or RTF document You can then go back to the Document Manager and continue inserting editing and arranging the items that will comprise the generated document In addition the document items are not limited to items taken directly from the application you can add textual and graphic information as document layout items These free text items become an integral part of the generated document As you can see the document development process is open and iterative You build the document layout in the Document Manager add additional text and graphic items as you may require view the generated document in the RTF editor or Web browser and then go back to the Document Manager to continue the document building process ABOUT DOCUMENT GENERATION The following illustration shows i RapidPLUS items that can be inserted into a document template ii A sample document layout iii The type
55. ing is by default the object s name as it appears in the Object Layout If the object has notes then they are also inserted into the generated document These graphic and nongraphic items are added using the Insert Simulation Objects command Once an object is inserted into the document changes that you make to it in the application are reflected in the document when the document is regenerated State Charts You can insert any number of state charts in the generated document The mode that appears as the top mode in the State Chart window is the one that is added to the document when the Insert State Chart command is used In the generated document the State Chart section presents each inserted state chart its notes if any and an easy to read table listing triggers for each transition in the chart NOTE In HTML documents if a listed mode is the top mode for another state chart in the document the mode name is hyperlinked to the relevant state chart Once a state chart is inserted into the document changes that you make to mode names or transitions in the RapidPLUS application are reflected in the state chart in the document when the document is regenerated Use Test Cases Recorded in the Prototyper A case is a sequence of user actions performed and recorded in the Prototyper There are two types of cases CASE TYPE DESCRIPTION Use cases Used for specification documents to demonstrate how the user interacts with
56. ings 56 ATP file extension defined 2 automatic document generation 74 automatic result capturing 45 B branches re evaluating 76 broken links 78 appearance in document layout 27 72 browser requirements vii Cc capture frame 44 capturing case results 43 45 77 case items changing selected 61 icons 42 setting global defaults 56 case trailer 60 Cases tab 56 59 cases use and test overview 5 appearance in Document Layout 41 43 capturing results 44 45 changing selected 61 examples 19 20 63 67 filtering 58 59 inserting 29 32 playing back 46 rearranging items 45 83 recording 43 44 re evaluating 76 setting global defaults 56 59 trailers 70 Chinese text HTML documents 6 closing documents 28 contents updating in RTF 74 continuing acase 44 copying items 39 coverage tests 79 82 overview 7 messages 81 D data elements overview 5 defaults See properties setting defaults deleting items 40 document driver 51 document generation automatic generation 74 manual generation 73 See also generating documents document headers 69 document items overview 4 document layouts closing 28 generated format example 16 new 26 open 26 saving 28 templates 68 Document Manager Options dialog box 50 84 INDEX Document Manager window opening 10 sample 7 toolbar 11 drivers 51 E editing any item 38 free text example 23 Editor tab 53 54 editors shortcut 53 supported vii F free text overview 6 addi
57. iti love electricPlug Sw to right position power Pb in Comments oe de This is the CD player display after the power is turned on instruction Display click disk Pb out result2 This is the CD player display after a disk has been inserted End of Use Case Free text item without the heading displayed FORMATTING CASES EXAMPLES 67 Excluding Graphics In this case the default generation property for use case items has been set to not show graphics NOTE Result items are always graphical this setting affects only the action items Other relevant case and case item properties e Table style three columns new row after action e Use case items show event description do not show headings The use case in the document layout looks like this b Use case 1 Move electricPlug Sw to right position a power Pb in gt result 2 disk Pb in 4 disk Pb out gt result2 The generated output looks like this Move electricPlug Sw to right position power Pb in DISPLAY EJ Press disk Pb gt play DISPLAY Ea HI PAUSE m STOP Note that the two discrete action items disk Pb in and disk PB out are combined into the one event description Press disk Pb DESIGNING THE LOOK OF GENERATED DOCUMENTS CUSTOMIZING DOCUMENT TEMPLATES RapidPLUS comes with template files that provide defaults for e The structure of a ne
58. ng to items editing 38 example 22 23 inserting 32 template 53 54 G General tab 51 generating documents overview 2 automatic generation 74 breaking links 78 document quality 4 examples 14 16 24 manual generation 73 process described 72 subdocuments 73 graphic objects with children 31 See also simulation objects H headings renaming 39 HTML files Chinese text 6 default editor 53 document driver 51 inserting items general procedure 29 interface items cases 43 items renaming 39 L links broken appearance in document layout 27 document links 78 generated document omitted items 72 item links 78 M manual result capturing 44 moving items 39 N new documents 26 example 10 New text template field 54 nongraphic objects See data elements O Objects tab 54 opening documents 26 P package See Simulator pasting items 40 playing back cases 46 47 project wide coverage test 7 79 properties setting defaults case options 56 61 case trailer template 60 editor options 53 54 free text template 53 general options 51 specification options 60 state chart options 55 test options 60 Prototyper playing back cases 47 See also cases use and test INDEX R RCD RapidPLUS Recorder files 47 rearranging items 39 case items 45 example 23 via Alt arrow keys 40 recording cases 43 45 example 19 red xs 27 72 re evaluating items 27 75 76 removing items 40 renaming items 39 reports overview 6
59. nt Some examples of changes which would require re evaluation are e Changing the name of an object e Changing the name of a mode e Replacing an object with another without changing the object s name such as replacing a round lamp named Lamp1 with a square lamp of the same name When RapidPLUS detects that an item has lost its link it appears in the Document Manager window with red xs These item should either be re evaluated or deleted from the document layout Re evaluating Items You can re evaluate relink a specific item or a branch and all of its nested items To re evaluate an item 1 Select the item to be evaluated 2 Choose Edit Re evaluate or right click and choose Re evaluate 3 Choose whether or not to rename the object in the Document Manager Document Manager D Rapid simple uis x status LED Object name has changed rename status LED to Lamp1 Current name in the application E No Yes to all Current name in the Document Manager Click Yes to rename the object in the Document Manager and reestablish the link with the application Click No to retain the current Document Manager name the item will not be included in the generated document 76 GENERATING DOCUMENTS To re evaluate a branch and any nested items 1 Select the branch heading 2 Choose Edit Re evaluate branch or right click and choose Re evaluate branch 3 If applicable click the Yes to all
60. nt Manager with the most updated object and mode data of the referenced application All this data is processed by the document driver to generate a file or files for the selected output format HTML or RTF RTF DOCUMENT EMBEDDED GRAPHICS l N RTF GENERATE RAPID APPLICATION ote OD RPD UDO OR RVR AND DOCUMENT LAYOUT HTML DOCUMENT UIS OR ATP f a HTML GENERATE Dover 1 Uli se i 4d 7 RI D ZRP FILES ke PNG FILES SIMULATOR RCD FILES GRAPHICS CASES If RapidPLUS cannot find in the application a mode or object referenced in the document layout the relevant item is omitted from the generated document and a red x appears over its icon in the tree This situation could arise for example if you changed the object name in the Object Layout after inserting the object into the tree You can reestablish the link between the application and the document layout item by selecting the item and choosing Edit Re evaluate If you have chosen the HTML driver and have included the Simulator in the document layout then the packaged application in ZRP format is embedded in the generated document You can run the application or cases in the Simulator from within the generated document GENERATING AND VIEWING OUTPUT DOCUMENTS 73 GENERATING AND VIEWING OUTPUT DOCUMENTS You can generate output documents for an entire
61. o that all of its man machine interface functions are tested Here too you would divide the RapidPLUS application s behavior into several test cases each case demonstrates a related set of actions You can then run a coverage test see Chapter 6 Performing Coverage Tests for Test Cases to ensure that all modes transitions and objects of the RapidPLUS model have been referenced in at least one test case Cases in the Document Layout When you insert a case into a document layout a tree is added that contains e User events recorded action items e Screen images captured result items e User object interface events function calls and property changes recorded interface items NOTE In the Document Manager Options dialog box Cases tabbed page you determine the scope of user object interface changes to be included in cases These default preferences can be changed for individual cases in the document 41 BUILDING DOCUMENT LAYOUTS 42 The case items are arranged in the order in which they took place in the Prototyper The following illustration shows a typical use case E Document Manager D RapidCD SAMPLES Ed File Edit Insert Test Options Help Basm gl 018 8 ve User Interface Specification For D YRapidCD1SAMPLESAT de User Interface Elements State Charts de Use Case E b Use case 1 8 Panel Cover Closed click 29 Power On in 42 control StendBy in Pa message u RemoteClick1 sent
62. ocManTuto M E3 File Edit Insert Test Options Help Dazju Djela el a User Interface Specification For Tutorial rpd D Rapic de Introduction E dy User Interface Elements Status LED IX Pb operate IX Sw power dy Data Elements IX timeout tmr diy State Charts SO TUTORIAL E ey Use Cases E b Use case 1 Move Sw power to up position a Pb operate in of Object does not exist Status message These xs indicate that RapidPLUS is unable to include these items in the generated document because the simulation from which they are derived is not available When you load the application referenced in the document layout the Document Manager automatically removes the xs from the icons By the same token if you delete or change the name of graphic objects or modes that are referenced by items in the document layout an x appears over the icons of the affected items Thus for example suppose you change the name of a switch in the Object Layout from PowerOn_sw to Power_sw and that switch is included as a user interface element in the document layout The next time you open the document layout or generate the output document a red x appears over the icon of that item You can update the item by selecting it and choosing Edit Re evaluate BUILDING DOCUMENT LAYOUTS 28 Saving a Document Layout Save the document layout tree information so that you can access it
63. ot be reached or exited e Transitions checks for absent triggers e Objects checks for referenced objects that are not referenced To run and insert a verification test 1 In the Application Manager choose View Verification Test 2 Inthe Verification Test window choose Check Check Results from the test will appear in the Verification Test window 3 Right click a heading in the Document Manager and choose Insert Verification Test By default the item s heading is the name of the mode from which the test was run NOTE When you generate the document the verification test is rerun according to the options originally set for the test start mode and categories to be included and the results are updated BUILDING DOCUMENT LAYOUTS Inserting Coverage Test Results A coverage test relevant for test documents only reports any modes transitions or objects of the RapidPLUS project that are not referenced in the selected test cases See Chapter 6 Performing Coverage Tests for Test Cases on pp 79 82 for details You can insert the results of the coverage test that is currently displayed in the Coverage Test Results window Editing Items In the Document Manager you can add free text and graphics to any item as well as rename and rearrange headings Since any editing you do on the output document could easily be lost when the document is regenerated the best way to modify the document is by editing items in the do
64. ptions for displaying cases and their General da Editor iS Objects Sh State Charts UY Cases Fe Specification Test m Use Case JV Show header v Table IV Run button Use Case ltem IV Show graphics able Style Y New row before action Columns 2 Y New row after result Y Show grid Graphics scaling 1 000 Y Show Event Description Filter certain events Record interface changes Filter Me Filter OPTION DESCRIPTION Show header When selected includes the case heading in the generated document Run button When selected a button is embedded in the generated document in order to play back the case Table When selected the generated case items are placed in a table the appearance of which is determined by the settings in the Table Style area Table Style Columns The number of table columns in which to display the case items New row before action When selected every action item is placed at the beginning of a new row in the table New row after result When selected every result capture is placed in the right most column The next item in the case starts a new row Show grid When selected places a grid around the table s cells SETTING GLOBAL OPTIONS 57 OPTION DESCRIPTION Record interface When selected cases include user object interface changes changes Click Filter to select which interface elements
65. s button The window should now look like this Ga Document Manager D Rapid DocManTutorial T Mal Ea File Edit Insert Test Options Help easa s alal e User Interface Specification For Tutorial rpd ey User Interface Elements D Status LED D Pb operate IX Sw power Data Elements EE timeout tmr it State Charts de Use Cases de Reports es 1 lo QUICK START 14 STEP 4 GENERATING AND VIEWING THE DOCUMENT At this point you can generate the specification document from the document layout As you continue to develop the document layout you will be able to observe how the Document Manager continuously updates the generated document as you make changes to the document layout In this tutorial you will use the HTML format Before you generate the document check that the driver type is set for HTML To view the selected document driver 1 Choose Options Preferences The Options dialog box opens to the General tabbed page Document Manager Options General dla Editor SX Objects Sh State Charts Wf Cases Specification m Document driver Default properties Selected driver HTML pe IV Show notes Y Show contents Y Number headings Generation Options IV Continuous automatic generation of final document V Update final document even if some items could not be generated 2 Make sure tha
66. s of generated documents i Items trom RapidPLUS ii Document layout iii Generated documents applications saved as UIS and ATP files as HTML and RTF files Y y Y E Document Manager D Rapid Applics CG_DEMO do Mila E3 File Edit Insert Test Options Help eaea sjer 08 8 e User Interface Specification For Telephone D Rapid Applics CG_DEMO ido Generate Specification Simulation de User Interface Elements me ne aa Network HTML or RTF ity Data Elements E answerStatus ey State Charts Sa on dy Use Cases b Use case 1 Power on 29 Move UtionOff Sw to on position e Event Util powerOn was triggered 7 Icons showRSSI called e message Union1 ASS sent from Network gt result ky Reports Modes Data Report on Acceptance Test Procedure For Telephone D Rapid Applics CG_DEMD doc ity Test 1 k Test case 1 Dial number 22 Move UtiLonOff Sw to on position 2 Keypad Pb3 in JEE Y State Charts Reports Test document HTML or RTF Generate ATP file Simulator The document building process OVERVIEW Document quality application quality The quality of the generated document is a reflection of the quality of the application For your documents to be readable and communicative you should ensure for example that your objects and modes have descriptive names and are well annotated You should con
67. same as Test OPTION DESCRIPTION Layout structure Determines the default tree structure for new specification test document layouts Document header Determines the default document header for generated specification test documents Case trailer Determines the default trailer for use test cases in the generated document See Customizing Document Templates on p 68 for details about these options CUSTOMIZING INDIVIDUAL ITEMS 61 CUSTOMIZING INDIVIDUAL ITEMS The following item types have properties that control how the item appears in the generated document e Graphic objects e State charts e Cases e Case items user actions screen capture results and user object interface changes Changing Graphic Object and State Chart Properties To edit the properties of an individual graphic object or state chart item 1 Select the item 2 Choose Edit Item Properties An item specific dialog box opens in which you can change the properties for that particular item These changes do not affect any of the other items in the document Changing Case and Case Item Properties For a specific use or test case or for a specific case item you can set document generation properties that are different from the default properties To change the properties of a selected case and ALL of its items 1 Select the case heading 2 Choose Edit Item Properties 3 Set properties in the dialog box similar to the Cases tabbed pa
68. struct the mode tree as well as the transitions between modes so that the state charts clearly map the application logic DOCUMENT ITEMS In the Document Manager window you build and manage the layout of the generated documents The window can hold any number of documents and each document is presented as a tree with branches Each branch refers to a particular item to be included in that document In the generated documents the tree is presented as levels of headings in an outline type format You can include the following items in a generated document e User interface elements i e named graphic objects e Data elements i e nongraphic objects e State charts e Use test cases recorded in the Prototyper e Simulator for HTML documents only e Reports e Free text i e additional text and or graphics e Verification test e Coverage test for test documents only Descriptions of these items are presented in this section The descriptions are based on the Document Manager default settings For details about customizing the generated document format see Chapter 4 Designing the Look of Generated Documents Following the descriptions is an illustration of the Document Manager containing a sample document layout tree DOCUMENT ITEMS User Interface Elements and Data Elements You can insert any named graphic object and any nongraphic object into the generated document In the document layout tree the object head
69. t 2 display Pb in 8 display Pb out 3 instruction Display click 2 disk Pb in 8 disk Pb out 42 power Pb out ol Move electricPlug Sw to left position The generated output looks like this Action items Empty cell because result item is always in the right most column and this table has 4 columns Result capture item Move electricPlug Sw to right position instruction Display click INSERT DISK Ire sultl power Pb if disk Pb out display Pb out display Pb out REMOVE DISK 65 DESIGNING THE LOOK OF GENERATED DOCUMENTS 66 Using Free Text Items In this case a free text item is inserted before each result item These free text items contain extra information about the case s state Most relevant for this example is that the table is set to four columns with a new row after each result Because each comment and result is preceded by two user actions the resulting effect is a Comments column before the result item In the document layout the use case looks like this b Use case 1 A Move electricPlug Sw to right position o power Pb in ey Comment gt resulti a instruction Display click 8 disk Pb in 4D disk Pb out dy Comment gt result2 The generated output looks like this Free text item with Action items Action items heading displayed Result capture items E result1 Move electricPlug Sw to right pos
70. t HTML is selected for Document driver and that all the options and property settings match those shown above Click OK to confirm To generate the document 1 Select the document layout tree s top heading and then click the Generate button the Save As dialog box opens 2 Save the file in the DocManTutorial folder using the suggested default name the application name with the HTML extension STEP 4 GENERATING AND VIEWING THE DOCUMENT 15 When the generation procedure is complete your window should look like this E Document Manager D Rapid DocManTutorial Tutorial E3 File Edit Insert Test Options Help Dasu atest cie e e EP user Interface Specification For Tutorial rpd D Rapid DocManTutorial y User Interface Elements D Status LED D Pb operate D Sw power gly Data Elements E timeout tmr de State Charts de Use Cases Generated document s file path To view the generated document e Right click the document layout tree s top heading and choose View from the popup menu 16 QUICK START The generated HTML document will look something like this Headings Note the numbering hierarchy and hyperlinks to and from the table of contents not shown Graphic object image as seen in Object Layout Object note User Interface Specification For Tutorial rpd 1 User Interface Elements 1 1 Status LED O This is a
71. t will appear only once in the results no matter how many instances are used in the project COVERAGE TEST WARNING MESSAGES 81 COVERAGE TEST WARNING MESSAGES The following warning messages can appear in the Coverage test results window DESCRIPTION OF WARNING Modes Not Accessed SYNTAX lt model name gt lt mode2 name gt Transitions Triggers Not Examined lt sourceModel1 name gt to lt destinationMode2 name gt lt D H P gt gt lt trigger statement gt Transitions Triggers Not Activated lt sourceModel name gt to lt destinationMode1 name gt lt D H P gt gt lt trigger statement gt lt sourceMode2 name gt to lt destinationMode2 name gt lt D H P gt gt lt trigger statement gt Objects Not Tested lt object1 name gt lt object2 name gt User Functions Not Tested lt userFunction1 name gt lt userFunction2 name gt PERFORMING COVERAGE TESTS FOR TEST CASES 82 INSERTING COVERAGE TEST RESULTS You can insert the results of the coverage test currently displayed in the Coverage test result window To insert coverage test results into the document layout 1 Select a heading in the Document Manager window 2 Choose Insert Coverage Test Results or right click the heading and choose Insert Coverage Test Results The inserted item is free text and can be edited as any free text item Index A action items cases descriptions 42 sett
72. template for adding free text set the text editor to launch automatically when when free text is inserted Objects Show hide graphic representations of graphic objects set the scaling of the graphic representations State Charts Show hide graphic representations of state charts set the scaling of the graphic representations include a list of transition triggers Cases Determine the presentation of case items Specification and Test For each document type Specify template files for e Document layout structure e Font paragraph and numbering styles for the document header inserted at the top of the generated document e Trailer i e text added to the end of each case in the generated document The following sections present the various options available SETTING GLOBAL OPTIONS General Options 51 The General tabbed page presents options related to the output format General de Editor iS Objects Sa State Charts W Cases E Specification amp Test m Document driver HTML y Default properties M Show notes IV Show contents Y Number headings M Generation Options IV Continuous automatic generation of final document Y Update final document even if some items could not be generated OPTION Document driver DESCRIPTION Determines whether the output format of your generated document is RTF or HTML Default driver HTML
73. the application as executable content in the generated document e Add and edit free text e Rename and rearrange items in the document layout QUICK START 10 STEP 1 CREATING A NEW DOCUMENT LAYOUT In this step you will open the Document Manager create a specification document for Tutorial rpd and save it To begin the tutorial 1 Open RapidPLUS 2 Open Tutorial rpd located in the EXAMPLES folder of your RapidPLUS CD ROM To open the Document Manager and create a new document layout 1 Inthe Application Manager choose View Document Manager or click the Document Manager button The Document Manager window opens If a document layout was previously created it will appear in the window To remove any existing document layout trees from the window choose File Close or Close all 2 Inthe Document Manager choose File New Specification Document or click the Specification Document button The following template is added ES Document Manager User Interface Specification Al x File Edit Insert Test Options Help aasal ajoja 2 x User Interface Specification For de User Interface Elements de Data Elements de State Charts de Use Cases des Reports Document layout tree s top heading To name the document layout Default branch headings 1 Select the document layout heading and choose Edit Rename The heading becomes an editable field 2 Overtype
74. ument 74 86 INDEX xs 27 72 Z ZRP files 33 35
75. un button The focus switches to the Reviewer window which is either embedded in the browser or is in a standalone window depending on the properties you chose when inserting the Simulator The application appears in the case s initial state The case plays to the end with a hand cursor tracking the path of mouse movement between user actions NOTE Mouse movements not directly involved in user actions are automatically filtered out of the case playback WORKING WITH CASES 47 Playing Back Cases in the Prototyper When you generate a document with inserted cases the cases are automatically saved as RapidPLUS recording RCD files which can be played back in the Prototyper To play back an RCD file 1 In the Prototyper choose Controls Recorder or click the Recorder button 2 From the Recorder window choose Cassette Load Browse to the RCD file which was saved automatically in the folder with the generated document The naming convention is as follows e For cases with the same name lt caseName gt _case1 rcd lt caseName gt 1_casel rcd lt caseName gt 2_casel rcd etc e For more than one case that is recorded in the same Prototyper session lt caseName gt _case1 rcd lt caseName gt _case2 rcd lt caseName gt _case3 rcd etc 3 Press the Play button in the Recorder window 49 Designing the Look of Generated Documents The style of generated HTML and RTF documents is based on the settings in
76. w By default the item s title is the name of the selected mode in the chart In the Chart Options dialog box Tools Options from the State Chart window you can determine e The depth of the chart i e how many levels of modes are to be shown below the selected mode e Whether or not the transitions in the chart are to be numbered The generated document includes the notes if there are any for each of the modes included in the chart To format the chart in the generated document see State Chart Options on p 5S Inserting Cases A use case or test case is available for insertion after you have recorded one in the Prototyper The case is added to the layout as a subtree of items comprised of user actions screen capture results and user object interface changes The case heading is by default numbered in the order that it was added to a document layout tree For instance the first test case inserted is Test case 1 the second is Test case 2 See also e Working with Cases on p 41 for details about recording and inserting cases e Case and Case Item Options on p 56 for details about default settings e Changing Case and Case Item Properties on p 61 for details about settings for an individual case or case item Inserting Free Text Free text is always available for insertion By default the item s title is New Text The inserted item is just a heading until you open it in an editor
77. w document layout e The header that appears at the top of the generated document e The trailer that appears at the end of a case in the generated document One set of templates is used for specification documents and another for test documents The templates are designated in the Specification and Test tabbed pages see Specification Test Options on p 60 of the Document Manager Options dialog box Document headers and case trailers are determined by the selected document driver HTML or RTF By default RapidPLUS uses the correct format for the selected driver You can change the default settings in one of the following ways e Edit the default template files directly e Specify different template files in the Options dialog box Changing the Default New Layout Structure The default structure of a new document added to the Document Manager is determined by UIS and ATP files copied to the RapidPLUS working folder during installation Specifically the files are e Template uis for specification documents e Template atp for test documents You can change the default template by replacing the default file or by specifying a different file in the Document Manager Options dialog box Replace the default template by adding a new document and making changes to the layout as described in Managing Document Items on p 29 When you are satisfied with the template save it with the default name and location i e overwrite th
78. y from RapidPLUS applications The layout for these documents is built in the Document Manager window using items from the RapidPLUS design tools Documents are then generated as RTF or HTML files The generated documents can include the following linked items Graphic and nongraphic objects State charts Use or test case scenarios that describe how the user interface is operated or tested Reports about modes objects user object interface elements and overall logic validity In HTML documents an embedded Simulator for running the application as executable content in a Web browser In addition to the linked items you can freely insert your own textual and graphical annotations into the documents OVERVIEW ABOUT DOCUMENT GENERATION The Document Manager works in conjunction with the RapidPLUS design tools to document any or all stages of a product s design Instead of the documentation process being separate from the design task the RapidPLUS application becomes the basis of the documents that will accompany the product throughout its life cycle When the application changes there are linked items in the generated documents that are easily updated by regenerating the documents The application s objects and their notes modes and their notes state charts and behavior in the Prototyper become linked items in the documents The procedure for creating a specification document or an acceptance test document is s

Download Pdf Manuals

Related Search

Related Contents

PDF形式（72KB）  S.H.Figuarts 仮面ライダーアマゾン＆ジャングラーセット 取扱説明書  Advance Acoustic MCD 404  Global Series Brakes User Manual  HP g6-1b60us User's Manual  Adesso WKB-4100UB User's Manual  医薬品・医療機器等安全性情報265号  Orbit Manufacturing 2000 Printer User Manual  - NEC Display Solutions Europe  

Copyright © All rights reserved. Failed to retrieve file