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:
-
config.properties
-
together.properties
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
-
Always back up your existing license file (./bin/license.tg)
-
If you have modified your configuration properties (./lib/config.properties),
back up that file and copy/paste your changes after the new installation.
-
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:
-
Run together.class in your
Java virtual machine and follow the JShield Wizard's instructions.
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:
-
bin/win32/oistart.exe - for running external tools under Windows;
-
bin/os2/oistart.exe - for running external tools under OS/2;
-
bin/x/oistart - for running external tools under UNIX systems.
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
-
Start command line (console, DOS prompt, etc.)
-
Change working directory to /Together/bin (assuming you've
installed the product to /Together)
-
Find the command-line file (script, batch, etc.), which has the name Together
and the extension appropriate to your OS (.bat, .cmd, .sh)
-
Execute this file.
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:
-
Choose File | New Project... to create a new Together project, or
File | Open Project... to open an existing project.
-
To work with existing source code, create the project in any directory
that contains source files (directly or in its subdirectories).
Tip: For very large existing code bases, you will find it more
efficient to create several "sub-projects" at strategic points of interest
in your project tree rather than a single project in the top-level directory.
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 
Together provides command line options that enable multiple
Together
users to access a common set of system properties files on a remote directory
(useful for server-based Together installations).
-ph=<path>
where <path> is the path specification for the remote directory
containing the common properties files.
If you specify this option at startup, Together looks to the remote
location path for the files together.properties and host.properties.
If the specified path is valid, Together accesses the remote files at that
location. If path is invalid or not available, Together accesses the copies
at the default location (./lib subdirectory).
-uph=<userpath>
where <userpath> is the path specification for the directory
(remote or local) containing user's together.properties file.
All changes to global Together's properties will be written to this
directory.
The config.properties file (user-definable configurations, blueprints,
etc.) is not affected by the these command options.
See also: Command line parameters
topic of the Help.
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:
Version History
Version History is now a separate file. See version_history.html