⟦543858086⟧

TextFile

Insight Demo Script  

Demo requirements

- Sun SPARC workstation
- X display terminal  
- X 11 version 4 and Motif
- Insight product and demo code, installed on the R1000 and Sun workstation
                


SET-UP FOR THE DEMO

a) Traverse to !tools.design.Insight.tutorial.In this library, you will
see the subsystems of the tutorial. This code is used for the Environment
demo, it runs an airline seat that allows the passenger to chose
entertainment, make reservations, communicate with the ground, etc., all
from the seat. Note that while the structure is complete, not all the
units contain code. The 8 subsystems are:

    Air_Phone
    Cabin_Configuration
    Cabin-Operations  
    Cabin_Tests
    Entertainment
    Ground_Link
    Ip_Communications  -> all units contain code
    Seat_Services


b) Set the default activity to 'Activity'.  

    [Create Command] Activity.set_default[Complete] 
        Activity.Set_Default (The_Activity => "<ACTIVITY>", 
        Response => "<PROFILE>");
    end; 

    [Promote]


c) To start the demo clean each time, remove any previous diagrams,
using Lib.delete ("diagrams.@"). (This is the diagram context, where all
the diagrams you create will be stored by default. This is set up when
you launch Insight.)

    [Create Command] Lib.delete[Complete]

        Lib.Delete (Existing => "diagrams.@", 
            Limit => "<DIRECTORIES>", 
            Response => "<PROFILE>");
        end;
        
    [Promote]      
    



                   



I. INITIATE INSIGHT

 
        NOTE:   
        You may want to start Insight prior to the actual start of the demo,
        sometimes it may take a while to begin if the environment is being used
        heavily.    
               

STEP 1: 
Traverse to !tools.design.Insight.tutorial  

[Create Command] Insight[complete]

Insight (Object_Context => "$",
  Diagram_Context => "Diagrams",
  Remote_machine => "Your Workstation Name",
  X_Display => "X Display Device Name:0",
  Remote_Username => "Sun User Name",
  Start_Server_Only => False,
  Response => "<PROFILE>";
end;
        
[Promote]

In the command, only change:
    A) the Diagram Context field (to "Diagrams");
    B) the Remote_Machine field to the name of the machine
        running Insight; 
    C) the X_Display field to the name of your X display device, 
        if different from the machine running Insight. Use the 
        format 'X Display Device Name:0'.    
    D) the Remote User Name field to the user
       name on the Sun running Insight;
            

        NOTE:   
        BE CAREFUL TO CHECK SPELLING - if you specify a server or X
        display that is incorrect, you may get hung up.
        If this happens, use 'Meta G' to kill the job.
 

        There are no visual cues that the product is coming up.
        Please be patient; it may take up to 30 seconds to
        respond, depending on the environment loading.    
                                                          
        
STEP 2: 
Put the environment in the background by typing 'Control G'.
             

    DEMO INFO: The first Insight window to appear will be empty. Its
    title will be 'Insight'.
             
         
    
    


STEP 3:  
Pull down 'Definition' from the FILE menu, to specify what objects to
diagram.       



DEFINITION: This will bring up a Dialog Box which is looking for a
naming expression for a subsystem or library. For this query, you must
enter a full environment name, or use '$' to diagram the subsystems
included in the current activity on the environment. In this case, just
use '$'.
                                                      

        NOTE:   
        For all dialog boxes, you must click on the text input field
        before it will accept typed input. If you mis-type, and the 
        backspace and delete keys don't work, you can either double-
        click in the text field to select the entire filed, and re-type,
        or use the cursor to select the incorrect characters and re-type.
                                                   

    DEMO INFO: Now Insight is processing the selected subsystems and
    using tools such as LRM Interfaces, building up a semantic
    representation of the subsystems and underlying Ada program
    libraries in terms of unit visibilities. The semantic representation
    is passed to the workstation where it is converted into Booch module
    diagrams. This will take 10 - 15 seconds, if the environment is not busy. 
                

STEP 4:
To launch into the demo, explain this scenario to your customer: Imagine
that I am a new engineer on the project, and I want to get a better
understanding of the system components and their relationships.  
Using Insight will give me that knowledge. During this time, you can
also mention how Ada program semantics are stored persistently in DIANA,
and how the LRM Interfaces provide a very effective tool interface to
that information.


    DEMO INFO: The next window to appear will display all the subsystems
    in the object context.
                    
     
       
    
    

II) BROWSE MODULE DIAGRAMS      


        NOTE:
        On your workstation, you will see a Booch module diagram display
        containing subsystem representations for the subsystems of
        the tutorial. The 8 subsystems are:

                Air_Phone
                Cabin_Configuration
                Cabin-Operations
                Cabin_Tests
                Entertainment
                Ground_Link
                Ip_Communications
                Seat_Services
         
                
           
STEP 5:   
Briefly introduce the window and the icons. Use the inside back cover of
Grady's book for reinforcement. Mention to the user that, at this point, if they
have lost track of where they came from, Insight will help them out.
    

STEP 6:
Select the 'Generating Expression' command from the Browse menu. The origins
of the diagram are displayed in a dialog box.  
    

        NOTE: 
        This window will be named "noname0" until you save it and give
        it a name.
                

STEP 7:
Pull down 'Save' from the File menu.

SAVE: This will bring up the "Diagram Name" Dialog Box. Remember to
click on the text field, and enter "Tutorial". Mention that the diagram
will be saved under the filename you just gave it, "Tutorial", in the
diagram context that you entered in the Insight command.
               

    DEMO INFO: The Dialog Box will remain on the screen, for what may
    seem like an unusually long time after you dismiss it with the OK
    button. The product is working on it, eventually the dialog box
    will go away. When it does, notice that the diagram is now titled with 
    its complete path, !tools.design.insight.tutorial.diagrams.tutorial
 
          
        NOTE: 
        Subsequent newly-created windows will be nonameX, with X
        incrementing by one for each new window. Saving a window allows
        the user to give it a name.

        The Palette tool at the side of the windows, while selectable,
        is not working at this time. 
                                                        

    DEMO INFO: The subsystem that has the most complete code is
    Ip_Communications. Use this to show Ada units later on in the demo.
    

          
STEP 8:  
Explain to the user that the arrows between icons indicate subsystem
visibilities ("imports"). In this case, Ground_Link is visible to both
Air_Phone and Seat_Services; Cabin_Configuration is visible to
Seat_Services and Cabin_Operations; Ip_Communications is visible to
Seat_Services, Cabin_Operations, Cabin_Test, and Entertainment; and
Cabin_Operations is visible to Cabin_Test.

                       
Make a quick point about the power of Rational Subsystems, and emphasize
the usefulness of Ada Insight, allowing users to graphically see, traverse,
and print these relationships.  
      
 
STEP 9:
Double-click the Ip_Communications icon to display the Ada package
relationships within the subsystem. Emphasize the ease of traversing the
subsystems, and that the double-click generates the next diagram.  

    DEMO INFO: There are 7 units:   
        Message Dispatch
        Transport
        Network
        Message
        Message Types
        Client
        Log Writer
  

STEP 10:
Briefly introduce the window and the icons. Use the inside back cover of 
Grady's book for reinforcement.               

Explain to the user that this window displays Ada package visibility
("withing") relationships. Emphasize to the customer that they can get
postscript or hardcopy graphic of any of the windows they see in
Insight.  Point out that the status is shown in the lower right hand corner
of the diagram, which is now 'modified'.
        

STEP 11:    
Save this diagram. Pull down 'Save As' from the File menu.


SAVE AS: This will bring up the "Diagram Name" Dialog Box. Enter
"Ip_Communications", remembering to click on the text input field before
it will accept typed input.  
        
Point out that the status of this diagram is updated to 'saved'. 
                            

    DEMO INFO: 'Save As' will let you save the diagram in a different 
    place than the default diagram context. You must enter the full
    pathname to do so.
  

STEP 12:    
Demonstrate the ability to edit a diagram by selecting (single-clicking)
the Message Dispatch spec (at the top of the diagram) and moving it
towards the right hand side of the screen by a few inches. Point out
that the spec has a different number of imports than the body, and they
are from different units.
                            

    DEMO INFO: To move an arc, you must select its elbow - the bend
    (elbow) of the arc.
   

STEP 13:
Select the elbow of the arc to the Log Writer icon, and move it to 
clean up the diagram.        
      

STEP 14:
Save this revised diagram by pulling down the 'Save' command from the File
menu. Point out that no dialog box will appear this time, and that this
version of the diagram replaces the last version in the environment. Note that
the status is changed to saved. (This is the cue that the operation has
completed.)


                            



III) BROWSE ADA CODE IN THE ENVIRONMENT FROM INSIGHT
             

STEP 15:     
Double-click on the Network icon, either the spec or the body. The
associated code is brought up in an environment window. Reinforce the
concept that users can create pictures of their Ada subsystems and
program libraries. Highlight the ease of traversing the subsystems and
Ada program libraries graphically, and how quickly code can be accessed
when needed.  
        

STEP 16:
Select another icon in this window, and use the 'Environment Definition'
command (under the Browse menu) as an alternative way of displaying code
in the environment.
    

STEP 17: 
While you are in the environment, traverse to the location you specified
to store diagrams. (If you followed the set-up instructions, they will be
at !tools.design.Insight.tutorial.diagrams) Point out that the diagrams
are now stored in the environment.
         

STEP 18:  
Bring the subsystem window (Named 'Tutorial')to the top of the window
stack by clicking on it. Select one of the subsystems shown there and
pull down the 'Environment Definition' command from the Browse menu.
Point out again the easy traversal between the graphic representation
and the environment objects. 
           

STEP 19: 
Pull down the 'Print' command from the 'File' menu, and select the 
standalone Format, exclude the Title, and select Drawn Icons. Press
the OK button. Explain to the customer that Insight 'prints' to a file
in the Environment - ASCII or Encapsulated Postscript. The diagram
can then be printed from the Environment. 

                 



IV) GROUP OBJECTS WITH INSIGHT
        

STEP 19: 
Selected objects can be grouped together to further clarify a display.
Return to the diagram of the Ip_Communications subsystem.  Select the
Message Dispatch, Message and Message Types icons (Shift left-click to
do multiple selects). Under the edit menu, pull down the 'Group'
command.

GROUP: This will bring up a 'Group Name' Dialog Box. Enter the name 'Message',
and hit the OK button.  
        

    DEMO INFO: After you have completed naming the group, the selected
    icons of the group will disappear, and be replaced in the diagram by
    a box labeled with the group name.
        

STEP 20:
Save the diagram using the 'Save' command.     
         

    DEMO INFO: You cannot perform an 'ungroup'. If you don't like what
    you have done, you can chose not to save the modified diagram (with
    the created group in it), and just regenerate that diagram. OR, you
    can delete the diagrams from the diagram context and regenerate
    them.


STEP 21:
Double-click on the new group box to bring up the diagram of the group.
Remind the user that grouping is a convenient way for them to clarify
their diagrams. Also point out that grouping is Insight information
only, nothing equivalent exists or is created in the environment.
                

        NOTE: 
        A group is an Insight convention only, and it depends on
        information supplied by the user. There is no environment analog
        to 'group'.  
 
           
STEP 22:
Wrap up the demo by pointing out that the user can quickly establish
where they are in their data, and easily navigate between the diagrams
and the environment.
             
At this point, the demo is complete.
                                                                    





V) RESET DEMO  

Pull down 'Close All' from the File menu in the subsystem window
(labeled 'Tutorial')to close all the diagrams. 

Pull down 'Exit' from the File menu in any window to terminate
the workstation session.

Return to the R1000 window to start again.
DataMuseum.dk

Rational R1000/400

⟦543858086⟧ TextFile

Derivation

TextFile
