Readme
File
Together 2.2
ABOUT PORTABILITY INSTALLATION STARTUP GETTING HELP VERSION HISTORY

Thank you for your interest in the Together® family of object modeling tools. The readme files provide late-breaking information and things you should know before installing the product. You may also want to have a look at the Frequently Asked Questions (FAQ) file before you proceed to installation or using the product. Information in this file is applicable to all Together products unless otherwise noted. Platform-specific readme files are provided. 

About Together

Together is the first platform-independent Unified Model Language modeler that delivers simultaneous round-trip engineering.

Together includes the following features (new features in version 2.2 are marked with *):
 

  • Simultaneous round-trip engineering for Java™, C++, and more.
  • UML 1.2: use-case, package, class, sequence, collaboration, and state diagrams. Also Coad notation: object models and scenario views 
  • * Deeper integration between diagrams: import physical and logical packages, exchange diagram elements 
  • Fully customizable code construction and round-trip engineering 
  • Large project support: display control (by element, by category), view management with autoupdate (physical and logical package content), source and diagram-layout files (as scalable as your file system itself) 
  • * Server mode support: multi-platform, multi-user installation in a shared location
  • Documentation generation: HTML output with GIF image maps of all diagrams standard. Optional multi-frames: Click on a class or member in the image map and simultaneously view the corresponding text. 
  • External tools access: Launch your favorite code editor or IDE. Interact with version control directly from Together). * Capture navigable output (from compilers, etc). Integrate with SCC systems.
  • Import from and export to Rational Rose™ 
  • Support for CORBA and COM IDL 
  • Extensive configurability: key system properties are modifiable in a configuration file. These include text editor tab size, highlighting of diagram elements, code generation and parser blueprints, file templates, default stereotype list, and stereotype colors). * More text editor customizations!
  • Versatile in-place diagram editing: Full-declaration editing of attributes and operations. In-place editing of link labels, roles, and cardinalities. Optional auto-detection and display of dependencies. 
  • Together scripts: open API for user-defined script development. Use project and model information to generate custom documentation, metrics, presentations, or other relevant information.
  • Tested on leading operating systems and Java virtual machines (refer to Portability topics for the last information about supported platforms) 

  • * Running under JDK 1.2 (Release Candidate) in Windows NT and Sun Solaris.

Portability

Together has been tested on various popular OS + JavaVM combinations.

Information specific to each supported operating system is provided in a separate readme file. These tell you about the Java versions under which Together has been tested. Together may run under other, untested Java Virtual Machines as well, but Object International cannot vouch for the results. Please feel free to report your experiences with unsupported JVMs.

Windows NT and Windows 95/98 users:

Please see readme_windows.html

OS/2 users:

Please see readme_os2.html

UNIX users:

Please see readme_unix.html
(This covers the different UNIX systems, Linux, Sun Solaris, and different hardware platforms, Intel-x86, SPARC)
This file continues with the information applicable to all supported operating systems.



Together Installation

Together has a pure-Java installer as well as platform-specific installers. The installation process varies depending upon which product version and which variant of the installer you have obtained. All installers for all products provide a wizard to guide you through the installation.

White board installation

Whiteboard Edition installer installs Together with only Whiteboard features enabled.
During the installation you choose the desired language for round-trip engineering (Java or C++). Together Whiteboard Edition will only work with projects of the selected language, and only the samples for selected language are installed.
The Whiteboard Edition installer creates a Whiteboard Edition license file in the destination directory.

License installation

The Together installers install the full product and generate a license file that enables specific features. Distribution media purchased from Object International or an authorized distributor includes the appropriate license file. Installation enables the features for the license you purchased.

If you are upgrading a Whiteboard installation with a higher license purchased on-line, you will need to copy the upgraded license file to your installation's /bin directory. If you are not overwriting your current installation with an updated build, copying the license file is all you need to do to enable the features for your license.

Installing over previous versions

The Together installer first looks for a license file in the setup directory. If none is present, it checks the destination directory and preserves any existing license file found there. If no license file is present in either location, the product installs to the specified destination directory with Whiteboard Edition's feature set and license file. If license files are found in both setup and destination locations, the installer asks you to if you want to overwrite the old one (in destination) with the new one (from setup).

When over-installing with a new build and a license higher than your present license, you should overwrite the existing license file. If installing only a new build, not upgrading your license, preserve your existing license file.

Beginning with build #356, Together's installer preserves existing configuration properties and license files. You can simplify upgrades to updated Together builds by choosing the same destination directory as your present installation.

The installer checks the destination path for a directory named lib and the following files in it:

It makes backup copies if it finds these files.

As mentioned earlier, if the license file license.tg is present in the bin subdirectory of the destination path, the installer keeps it and Together works with that license.
CAUTION: Builds earlier than #356 do no preserve configuration and license files. Check the file buildnum.txt file in the installation directory see what build you have.

Over-install recommendations

  1. Always back up your existing license file (./bin/license.tg)
  2. If you have modified your configuration properties (./lib/config.properties), back up that file and copy/paste your changes after the new installation.
  3. If you wish to keep changes to Global Options settings (made from the Global Options dialog), back up your Together properties (./lib/together.properties) and copy/paste your changes after the new installation.

Using the pure-Java installer:

You can use the pure-Java installer with all supported operating systems and Java VMs. The Java installer ships as a compiled Java class.
You must already have a supported Java VM installed on your computer in order to use the pure-Java installer. For information on supported operating systems see the Portability section above and check the corresponding readme file for your OS.

To install Together using the Java installer:

Should you experience installation problems, please check the  FAQ file  (faq.html) where you'll find answers to many questions including known installation issues.
 

Server installation 

A recent addition, as yet not documented, is server-based installation. During installation you can choose between typical (workstation) or Server-based installation. There is a difference in the installed file set and in processing of properties files that control configuration.

The server installation installs all the platform-specific runnable files (Together.exe, Together.bat, Together.cmd, and Together.sh) and creates in addition three subdirectories under the main executables directory (%TOGETHER_HOME%/bin) for three platform-specific oistart tools:

At runtime, properties are loaded first from the host.properties, together.properties and config.properties files in %TOGETHER_HOME%/lib .

Next, the properties are loaded from together.properties file in the current working directory, if present. This file stores changes in Global Options properties (Edit | Global Options).

This setup enables a project administrator to provide a corporate set of properties (e.g. with styled code-generation) to all users on a team, but leaves freedom to use individual users' own settings.


Start-up

To start Together in any Java machine

  1. Start command line (console, DOS prompt, etc.)
  2. Change working directory to /Together/bin (assuming you've installed the product to /Together)
  3. Find the command-line file (script, batch, etc.), which has the name Together and the extension appropriate to your OS (.bat, .cmd, .sh)
  4. Execute this file.

  5. The command-line file is configured by the installer, however, it may require additional corrections according to your environment and Java VM installation.
    Note that the only command in it should call the Java VM on your computer, pass to it the proper classpath with both Together classes and standard classes, and specify oisoft.together.Main as class to execute.

After startup:

For more information, see the Getting Started part of the Help.

Opening a project file on start-up

The first parameter in a call of Together (the concrete file name varies depending on OS and JVM) specifies the name of the project to be automatically opened. If you start Together manually from the command line you can specify the existing project name. (Together project files have a .tpr extension.)
See also: Command line parameters topic of the Help.

Remote access for system properties 


Getting Help

To open Together's HTML documentation in your browser, choose commands on the Together Help menu or simply press Ctrl+Shift+H key in any Together windows. Click this hyperlink to open the Help contents now.

You can find answers to a number of frequently asked questions in the FAQ document: faq.html. This document includes general information and troubleshooting sections. The list of known problems and possible workarounds is provided in problems.txt file.
If you have questions that are not covered in FAQ and problems, information and support are available from:
 
North and South America:  Object International, Inc.
1720 Leigh Drive, Raleigh, NC 27603-5159, USA
World Wide Web: http://www.oi.com
 E-mail for info: info@oi.com
E-mail for support: support@oi.com
Tech Support Hotline: 1-919-773-1063
Phone: 1-919-772-9350
Fax: 1-919-772-9389
UK and Ireland: Object UK Ltd.
PO Box 64, Southampton SO15 5TG, UK
World Wide Web: http://www.objectuk.co.uk
 E-mail for info: info@objectuk.co.uk
E-mail for support: support@objectuk.co.uk
Phone: +44-1703-399990
Fax: +44-1703-399991
Rest of the World: Object International Software
Schulze-Delitzsch-Str. 16, D-70565 Stuttgart, Germany
World Wide Web: http://www.oisoft.com/
 E-mail for info: info@oisoft.com
E-mail for support: support@oisoft.com
Phone: +49-711-787-100
Fax: +49-711-787-1017


Version History

Version History is now a separate file. See version_history.html