11script

Introduction to Rational Rose 98i v 5.2Copyright 1993-1999 Rational Software, all rights reserved 1

Introduction to Rational Rose 98i

Module 11: RoseScript


Objectives: RoseScript

You will be able to: Understand RoseScript concepts Use RoseScript to:

• Obtain information from a Rose model• Add information to a Rose model• Update a Rose model• Integrate with third-party products


What is RoseScript?

RoseScript is a full-featured Basic scripting language

It is a customized version of Summit Basic Script


Uses of RoseScript Get information out of a model

Extract all or a portion to export Generate custom reports

Perform checks on the model Enforce project/enterprise semantic check Print to a log window

Create information to model Add and/or update model components Create and/or update interaction diagrams and/or

class diagrams Integrate with third-party tools


How are Scripts Executed?

Interactive Executed via the Start button on the Scripting

Window toolbar Compiled

Saved as a file (.ebx) that may be executed Rose menu may be updated to include any

compiled script


How are RoseScript Classes Used?

Each RoseScript class has a defined interface Properties and methods that are used to

access information in the Rose model Example

Application class property Visible

• Controls whether the Rose application is visible on the screen

Application class method OpenModel

• Opens a Rose model


RoseApp

RoseApp is a global application object All RoseScript programs have access to this

object Example

RoseApp.CurrentModel is the currently open model in Rose

• It is an instance of the Model class RoseApp.Height is the height of the main

window RoseApp.CurrentModel.Save will save the

current open model


RoseScripts and Color

Scripts appear in color

Keywords are in blueComments are in greenCode is in redEverything else is black


Some “Basic” Terms

Add a comment ‘This is a comment

Declare a subroutineSub Name (arglist)

Terminate a subroutineEnd Sub or Exit Sub

Declare the main subroutine Main()

Declare a local variable along with its typeDim variable As type


Some “Basic” Terms

Print data to an output devicePrint

Repeat a block of statements for each element in a collection or arrayFor Each member in group

[statements][Exit For][statements]

Next [member]


Some “Basic” Terms Repeat a block of BasicScript statements while

a condition is True or until a condition is TrueDo {While | Until} condition statements Loop

ORDo

statementsLoop {While | Until} condition

ORDo

statementsLoop


The Scripting Toolbar

CutAddWatchEndStartPaste

ProcedureStep

CallsToggleBreakpoint

Break

UndoCopy

SingleStep


The Script Editor


Debugging

Problems arehighlightedin gray


Sample ScriptSub PrintPackage(theModel As Model)

Dim thePackage As CategoryDim PackageID As IntegerDim allPackages As CategoryCollection

Set allPackages = theModel.GetAllCategories()For PackageID = 1 To allPackages.Count

Set thePackage = allPackages.GetAt (PackageID)Print thePackage.Name

Next PackageIDEnd SubSub Main

Viewport.openPrintPackage RoseApp.CurrentModel

End Sub


The Viewport

The Viewport window shows output of BasicScripts run from Rose

Viewport uses Print script output to the Viewport Print debug output to the Viewport


Viewport Methods

Viewport.Clear Clear the open Viewport window

Viewport.Close Close an open Viewport window

Viewport.Open Opens a new Viewport window or switches the

focus to the existing Viewport window


Scripting and Reports

Problem: How do you print out all of the names of all classes in the model?


Print Package and Class Names Script

'The Main statement defines the subroutine where execution begins Sub Main

'Open the Viewport windowViewport.open'Pass the current open model to the DumpModel subroutine DumpModel RoseApp.CurrentModel

'End the subroutineEnd Sub



'DumpModel subroutine expects a model as an argument

Sub DumpModel(theModel As Model)'Declare local variables AllPackages, thePackage and PackageIDDim AllPackages As CategoryCollection Dim thePackage As CategoryDim PackageID As Integer'Set the package collection to all the packages in the modelSet AllPackages = theModel.GetAllCategories()



'Loop through the packagesFor PackageID = 1 to AllPackages.Count'Set the package

Set thePackage = AllPackages.GetAt(PackageID)'Call the DumpPackage subroutine

DumpPackage thePackage'Get the next packageNext PackageID




'DumpPackage subroutine expects a package as an argument

Sub DumpPackage(thePackage As Category)'Declare local variables -- theClass and ClassID Dim theClass As ClassDim ClassID As Integer'Prints the name of the package to the Viewport

Print "Package"; thePackage.Name'Prints the number of classes in the package to the ViewportPrint "There are "; thePackage.Classes.Count; " classes"



'Loop through the classes in the packageFor ClassID = 1 To thePackage.Classes.Count

'Set the next classSet theClass = thePackage.Classes.GetAt(ClassID)'Print the name of the class to the ViewportPrint theClass.Name'Set the next classNext ClassID'Print a blank line to the ViewportPrint " "



Scripting and Business Problem Solutions

Problem: How can class names be changed? Enforce naming conventions Resolve name clashes Annotate classes to show distribution strategy

A script can be written to change the names of all classes in the model to enforce naming conventions


Creating the Script

Starting point Browse existing scripts as opposed to creating

a new one from scratch Getting help

Rose Extensibility How to Start Scripting from Rose Rose Scripting Online Reference Basic Script Reference


Script Steps

Declare the prefix to be added to the class name

Get the classes from the Model Object Iterate through ClassCollection Check to see that the prefix is not currently

part of the class name If prefix is not present

Assign name = prefix + name


Needed Script Functions

Const Name [As type or type] = expression A statement that declares a constant for use

within the current script

• Const prefix$ As String = “Rose98”Set prefix$ to the string “Rose98”

Left$ (string, length) A function that returns a string that contains the

leftmost NumChars characters contained in the input string

Left$(string,1)

• Return the leftmost character in string


The Prefix Script

' Definition of the prefixConst Prefix$ = "Rose98"

Sub Main' Declare local variablesDim theClasses As ClassCollectionDim theClass As Class

' Set the class collection to all the classes in the model

Set theClasses = RoseApp.CurrentModel.GetAllClasses ()


The Prefix Script

' Loop through the classesFor ClsID = 1 To theClasses.Count

' Get the next classSet theClass = theClasses.GetAt (ClsID)' Get the first n characters of the class where n is equal to the number of characters in the prefix

ClassPrefix$ = Left$ (theClass.Name, Len (Prefix$))


The Prefix Script

' If the prefix has not been used, add the prefix tothe name of the class If ClassPrefix$ <> Prefix$ Then

Viewport.OpenPrint "Renaming ";theClass.Name;" to ";theClass.Name = Prefix$ + theClass.NamePrint theClass.Name

End If' Get the next classNext ClsID

' Create a message box with the message = done!MsgBox "Done!"End Sub


Scripting and Model Updates

Problem: How can packages and classes be added to a model A script can be written to add new packages

and classes to the model Steps

Create the new package Create the class contained in the new package Add the class to the package


' This is the main subroutineSub Main

' Call the CreatePackage subroutineCreatePackage RoseApp.CurrentModel.RootCategory' Create a message box with the message = done!MsgBox "Done!"

End Sub

Script to Add a Package With One Class


Script to Add a Package With One Class

' This subroutine will create a new packageSub CreatePackage (ParentCategory As Category)

' Declare local variablesDim thePackage As Category' Prompt the user to enter the name of the new packagePackageName$ = AskBox$ ("Enter the name for a new package.", "My New Package", "Create A Package")' Add the package to the logical view packageSet thePackage = ParentCategory.AddCategory (PackageName$)' Call the CreateAClass subroutineCreateAClass thePackage

End Sub


Script to Add a Package With One Class' This subroutine will create a new classSub CreateAClass (ParentCategory As Category)

' Declare local variablesDim theClass As Class' Prompt the user to enter the name of the new classClassName$ = AskBox$ ("Enter the name for a new class."_

, "My New Class", "Create A Class")' Add the class to the new packageSet theClass = ParentCategory.AddClass (ClassName$)

End Sub


Exercise

Open the Registration model Run some of the scripts provided with Rose 98i

Modify the Add a Package With One Class script to create a package with a user defined number of classes Hint: Use an AskBox to determine the number

of classes and the name of the classes

11script

Documents

rose viewport

open viewport window

print package

viewport methods viewport

model class roseapp

subroutine sub

viewport printtheclass

subroutine end sub