Model Builder

Introduction

The Model Builder version is intended to generate the xml files based on the UML models designed for a project. The xml files generated are roles.xml , business-function.xml and components.xml. This document will explain how to install the module and generate the xml files using the module. It also explains how to design the UML model , requirements and standards in order to generate the xml files.

Creating Jar file

Get the source files for the module from Sourceforge CVS
To build and generate the jar file do the following:

• Set the Environment variable TGH to the Together installation directory.
  e.g. TGH = C:\TogetherSoft\Together6.0
• Extract the files from CVS under together directory.
• The together package will contain a build script (build.xml) under build package.
• To generate the jar file run the DevelopmentJar ant script.
• The build script will generate both the Dev version as well as the Customer version of the module.
• The jar file will be placed under dist/dev for dev version and dist/cust for customer version.

Installing the Module

Prerequisite: jaffaplugin.jar and jaffa.config files are available .
For creating the jar file see section Creating the jar file

• Place the two files (jaffaplugin.jar and jaffa.config) under $TGH\modules\com\togethersoft\modules\jaffa where $TGH = Together ControlCenter Installation directory.
  Or
  Run the build script CopyDevJar which will copy the files in appropriate directory.
• Once the files are in place , Open Together ControlCenter (if it is already open close it and reopen ).
• Under Tools Menu you will see Jaffa. If you have installed the development version of the module you will see roles.xml , business-function.xml and components.xml sub-menu along with the Jaffa Configuration. You can activate/deactivate the module anytime from Tools | Activate/Deactivate Features .

XML Generation

Generation involves configuring the module and generating the roles.xml , business-function.xml and components.xml depending on which version of the module is installed. Note: The module always works on the current Together project. Open the Together project which has the UML models which complies to the JaffaPlugin requirement. See section How To design/modify UML Models

• Configuring the Module
  Under Tools | Jaffa you will see the Jaffa Configuration sub-menu. The Configuration dialog contains the following options.
  
  • Path for Generated Files - This option enables you to specify the path where the xml files will be stored. If not specified , the current Together project path will be used as the default path.
  
  
  • Root Package for UML Diagrams - This option enables you to specify the root package under which all the uml diagrams needed to generate the xml files reside. E.g. com.together.modules.usecase . If the package is not specified , the current project root is used as the default root package. Note:This option applies only to roles.xml .Business-Function.xml and Component.xml will be generated for the entire project.
  
  
  • Open Generated Files in Editor - If this option is Checked, it opens the generated files in the default editor.
    Note:Enabling this option with XML Support module activated , could slow down the opening of files as Together tries to build the xml structure.
  
  
• Roles.xml
  Click on Jaffa | Generate Roles.xml to generate the roles.xml file .
• Business-Function.xml
  Click on Jaffa | Generate Business-Function.xml to generate the roles.xml file .
• Components.xml
  Click on Jaffa | Generate Components.xml to generate the roles.xml file .
• Viewing Log Messages
  In Together Control Center Either click on the Message pane icon or from the menu select View | Main Panes | Message pane to view the log messages for the generation of xml files.