-------------------------------------------------------------------
SCRIPTING HELP
-------------------------------------------------------------------
In general, you can view Rose extensibility as consisting of two
parts, RoseScript language and Rose Extensibility Interface
The RoseScript Language is the core BASIC language. These statements
and functions are what you are used to seeing in Visual Basic.
Rose Extensibility Interface is Rose-specific extensions to
BASIC. A common set of interfaces used by Rose Script and Rose
Automation to access Rose and the RoseScript language.
-------------------------------------------------------------------
ROSESCRIPT:
-------------------------------------------------------------------
Regarding more information on the syntax of RoseScript,
it's VBA compatible so any VBA book will do. Some of the books
that the company Rational licenses this scripting language from,
(Summit Software - www.summsoft.com) suggested at one point
on their web site for reference and learning it are:
Visual Basic for Applications 5.0, QUE Publishing
Teach Yourself Visual Basic for Applications 5 in 21 Days,
Matthew Harris, SAMS, 1997
Special Edition Using Visual Basic for Applications 5,
Paul Sanna, et al., Que, 1997
Visual Basic for Applications Unleashed,
Paul McFedries, SAMS Publishing, 1997
Microsoft Office 97 Programming with VBA for Dummies,
Karen Jaskolka, Mike Gilbert, 1997
-------------------------------------------------------------------
ROSE EXTENSIBILITY INTERFACE (REI):
-------------------------------------------------------------------
Rose-specific extensions to BASIC.
Basic objects which represents parts of the Model.
COM-based API. Any COM-enable language can access the REI.
For example:
Dim roseApp As Object
Dim aClass As Object
Dim allClasses As Object
Or
Dim aClass As Class
Dim allClasses As ClassCollection
You manipulate the model with these objects.
The REI Model is essentially a metamodel of a Rose model, exposing
the packages, classes, properties and methods that define and
control the Rose application and all of its functions.
You communicate with the Rose Extensibility Interface through Rose
Scripts or through Rose Automation. In either case, you will use
the REI calls defined in the Rose Extensibility Interface
Reference. This reference is available in printed form, as well as
part of online help.
A type library for the REI is provided in the file
rationalrose.tlb in the rose installation directory.
See the following for more information:
-> Documentation for Rose's scripting language is contained in the
online help.
Rose REI is documented in the Rose online help under the help book,
Rational Rose Extensibility Interface. In addition, the complete
Summit Script Reference is included in the extensibility online
help under a sub-book, Summit BasicScript Reference.
Help:Search for Help On, Contents tab,
-Rose Extensibiltiy
Key Concepts
Sample Scripts
-How to Start Scripting from Rose
-Rose scripting OnLine Reference
Complete description of the Rose Extensibility classes, their
properties and methods.
-BasicScript Reference
Alphabetical list of Language Elements
-and:
Rose Scripting
Modify existing Rose scripts
Create new Rose scripts
Sample Scripts List
Rose Automation
Rose Extensibility
-> If you are using Enterprise edition you can reverse
engineer the typelib to see what is contained in Rose REI.
Open Explorer, go to Rational Rose directory,
highlight RationalRose.tlb, and drag it on to an blank open
Componet diagram in Rose.
-> You can open up the Rose Type Library in the Visual Basic Object
Browser (Or Start Microsoft COM/OLE Object Viewer (Visual Studio)
open 'RationalRose.tlb' in the installation directory). This will
show you all the classes and their properties and methods. You
can find the Rose Type Library in the Rose installation
directory.
-> Print REI from online documentation:
insert the Online Documentation CD,
Go to Rational Rose, Rose Extensibility Reference
-> Print directly from the Online Help:
Help:Contents and Index, Contents tab, Rational Rose
Extensibility Interface, REI Model Inheritance Diagrams
-> Manual:
Using the Rose Extensibility Interface
Available as online download
Rational Product User Manuals
http://www.rational.com/support/documentation/manuals/rose.jsp?
-> Sample scripts shipped with product.
C:\Program Files\Rational\Rose\scripts
-> Rational Rose Download Center; Add-ins, Models, Scripts
http://www.rational.com/support/downloadcenter/addins/rose/index.jsp
-> Rational Support: Technical Notes
http://eservice.rational.com/eservice/start.swe?SWEView=FAQ+List+View+Search
+(eService)&SWECmd=GotoView&SWECount=5
Script related technotes include:
13284: Is there a script to count the number of lines in a model?
10557: Rose: How do I create the transition lines that go between
states on a diagram using a script?
11179: Using the Help to construct scripts
11765: Rose: Running a script upon loading a new model or opening
an existing one
3681: Script: assign module bodies to classes, 4.0 to 98 conversion
4928: How to do code generation from scripts and how to execute
scripts
6851: RoseForum FAQ - Script for Deleting dangling associations
7321: RoseForum - Has anyone written a script to load a group of
units?
7339: FAQ - Selectively load units from a script
7554: Rosescript is running out of stack
7706: FAQ - Trim$ function and Script
8191: RoseForum FAQ - Autosave script for Rose
8207: RoseForum FAQ - Rose script for generating an Actor
Listing from a Rose Model?
9276: How do I put a default file name in the
SaveFileName$Rosescript function?
8483: RoseForum FAQ - Loading Controlled Units by Script
9764: Rose: A script that iterates through all state
diagrams/activity diagrams in the model
9832: Passing Parameters to Rose scripts
2732: Script: Run Scripts from Dialog
13748: Rose scripts cannot access COM/OLE type-library constants
9016: An add-in stored in a compiled script can not be activated
-> The Rational Edge
http://www.therationaledge.com/admin/archives.jsp
Script related articles include:
http://www.therationaledge.com/rosearchitect/mag/archives/fall99/extend.html
The Finishing Touch on Your Add-In: RoseScript Dialogs
http://www.therationaledge.com/rosearchitect/mag/archives/9904/f5.html
Creating Your Own Rose Add-ins with Visual Basic
http://www.therationaledge.com/rosearchitect/mag/archives/9904/extend.html
Rational Rose 98i: Customizing Shortcut Menus
http://www.therationaledge.com/rosearchitect/mag/archives/9904/f7.html
User-Defined Tags with Rose 98 Scripting
http://www.therationaledge.com/rosearchitect/mag/archives/9901/extend.html
Creating Custom Model Properties
http://www.therationaledge.com/rosearchitect/mag/archives/9810/extend.html
Rose Extensibility: An Architectural Overview
http://www.therationaledge.com/rosearchitect/mag/archives/winter99/extend.ht
ml
Using COM in Your Rose Extensibility Solution
http://www.therationaledge.com/rosearchitect/mag/current/spring00/extend.htm
l
Common Questions from Experienced REI Users
Also see,
Scripts & Models (download examples)
http://www.therationaledge.com/rosearchitect/sm/index.html
-> More scripts:
www.rationalrose.com
www.clarity-dev.com/Downloads.htm
www.eisenhutinformatik.ch/rose/freeware/
www.iconixsw.com/RoseScripts.html
-> In addition there are public classes. See,
Extending Rational Rose:
http://www.rational.com/university/description/07.jtmpl
-------------------------------------------------------------------
Patrick Kennedy
Rational Support
-----Original Message-----
From: Eric D. Tarkington [mailto:[EMAIL PROTECTED]]
Sent: Tuesday, July 23, 2002 6:58 PM
To: ROSE_FORUM
Subject: (ROSE) Learning to Write RoseScript
I want to write my very own first script.
For those of you who have broken through: What books or other resources
will help me to get started?
-Eric
************************************************************************
* Rose Forum is a public venue for ideas and discussions.
* For technical support, visit http://www.rational.com/support
*
* Post or Reply to: [EMAIL PROTECTED]
* Subscription Requests: [EMAIL PROTECTED]
* Archive of messages:
* http://www.rational.com/support/usergroups/rose/rose_forum.jsp
* Other Requests: [EMAIL PROTECTED]
*
* To unsubscribe from the list, please send email
* To: [EMAIL PROTECTED]
* Subject: <BLANK>
* Body: unsubscribe rose_forum
*************************************************************************
************************************************************************
* Rose Forum is a public venue for ideas and discussions.
* For technical support, visit http://www.rational.com/support
*
* Post or Reply to: [EMAIL PROTECTED]
* Subscription Requests: [EMAIL PROTECTED]
* Archive of messages:
* http://www.rational.com/support/usergroups/rose/rose_forum.jsp
* Other Requests: [EMAIL PROTECTED]
*
* To unsubscribe from the list, please send email
* To: [EMAIL PROTECTED]
* Subject: <BLANK>
* Body: unsubscribe rose_forum
*************************************************************************
