Borland Together Edition for Borland C++ 2005 Readme

The information in this readme represents known issues at the time of this release. For late-breaking information that may become available after the release, check the Borland web site for the most recent version of this readme: http://info.borland.com/techpubs/together/.

About Together Edition for Borland C++ 2005

Borland Together Edition for Borland C++ 2005 provides Together functionality to complement Borland C++ 2005. The features provided by Together include:

UML modeling plus robustness diagrams and business diagrams
IDL generation
LiveSource™ for C++ and CORBA IDL (simultaneous round-trip engineering)
Pattern support
Model-level refactoring
Audits and metrics
Documentation generation
XMI import/export
Synchronization with Borland C++ 2005 source paths, class paths, and project settings
Mobile C++ support

Together Edition for Borland C++ 2005 is intended to run at the same time as Borland C++ 2005, so that you can use both products in coordination to work on the same project files. For example, you may use Together to model an application and then move to Borland C++ 2005 for code editing and deployment, with diagrams and code automatically kept in synch between the two products. For recommendations on how to coordinate your work with Together and Borland C++ 2005, refer to Getting Started with Together Edition for Borland C++ 2005, available in the Together Edition for Borland C++ 2005 installation ($TGH$/doc/gettingStarted.pdf) or on the Web at info.borland.com/techpubs/together/.

What's new

Borland Together Edition for Borland C++ 2005 provides the following new features:

Support for Solaris and Linux operating systems

Significant fixes and improvements

Accented characters (from European languages with ASCII codes between 128 and 255) in identifiers now parsed by the parser.
A problem with missing some of association links in case fo sources of links are in read-only files is now fixed.
A problem with Together removing macro calls from method bodies during some operations with file containing such code is corrected.
$LINENUMBER$ macro for external tools now work correctly. Therefore you can use it with appropriate command line options in your external editor.
Tools/external editor menu item now available for members on Class diagram and some elements in Sequence diagram.
Enumerations are not lost now when copying or editing classes they belong to, if the Show enumerations as classes option is off.
Together now properly assigns new names while cloning classes in a namespace. No name duplication occurs.
Local declarations of reference variables (like A & a;) were not treated properly in previous version of Together. Now it is corrected. Therefore dependant features like Find Usages and Generate Sequence Diagram features now behave properly.
Handling return non-trivial (for example, pointers, references) types of operations when generating code from sequence diagram now works properly.

Licensing notes

Together supports Borland named user licenses and concurrent licenses (enterprise licenses are managed using the Borland License Server or FLEXlm™). Single-user named licenses must be registered before working with Together.

If you have a valid Borland C++ 2005 Architect license and registered your copy of Borland C++ with that license, you do not need any additional license to run Together. Together will automatically recognize your Borland C++ 2005 Architect license.

In case you have a separate Together license, you need to register your copy of Together. For more information and licensing instructions, see the Setting Up Licensing for Borland® Together® document in your Together installation folder.

Integrations

To download any of the supported integrations and plug-ins, get updates of new integrations, or access documentation for integrations and plug-ins, visit the Integrations page at www.togethersoft.com/developers/integrations/

Back to top

Installation and Startup

Together installation is designed to be easy and straightforward.

Together Edition for Borland C++ 2005 Setup includes the required JDK. There is also no JAR installation.

Windows™ systems

When installing Together on Windows 2000, or XP Professional, make sure you are logged on to the machine with Administrator privileges.

System requirements

Resource	Requirement	Notes
Hardware
CPU	Pentium-II, 350 MHz or faster	Recommended: Pentium-III, 500 MHz or faster
Memory	512 MB minimum	768 MB or more is recommended when working with large-scale projects. You might want to adjust the JVM heap setting "-Xmx" (which is 768m by default) in Together.bat to better reflect your physical and virtual memory configuration as well as your typical project size. For more information, refer to the Sun® FAQ: http://java.sun.com/docs/hotspot/PerformanceFAQ.html#171.
Disk Space	NTFS: 180 MB FAT: 180-360 MB (depending on the cluster size)
Video	SVGA, high color mode, 1024x768	Recommended resolution: 1280x1024 or more
CD Drive	Optional	Necessary only if installing from CD
Software
Operating system	Windows XP SP2 Windows 2000
Java SDK	Sun® Java2™ SDK version 1.3.1	See Prerequisites for more information.
License Manager	Together floating license client (built-in) and valid node-locked or floating license	Running license server on remote license host with valid license is required for floating licenses. See Licensing notes for more details.
Web Browser	MS Internet Explorer 5.0 (or later), or Netscape Navigator 4.6 (or later)	Needed for viewing API documentation
Other
	An Internet connection is useful for obtaining software updates, node-locked licenses, and support, and for accessing Borland Together on-line resources.

Prerequisites for installing on Windows

Together Edition for Borland C++ 2005 installs the Java™ 2 SDK, Standard Edition, Version 1.3.1_06 automatically. Together runs by default on this JVM, and by default expects to find it in the $TGH$/jdk directory. The installer sets the JAVA_HOME variable to point to the JVM in Together launchers, as well as in many scripts for bundled tools. If at some point you need to change the JVM for a certain script, you may edit scripts manually to change the path specified in JAVA_HOME.
Borland C++ 2005. Before installing Together Edition for Borland C++ 2005, you must have Borland C++ 2005 already installed on your computer. The installer program will ask for the path to your Borland C++ 2005 installation.

Server installation

If you want to do a server-based installation, please install on a local drive first and review the installation and shared configuration topics in documentation.

Installation

Together installation is carried out using the InstallAnywhere utility.

To install Together on Windows:

Run the Setup file.
Follow the on-screen instructions to complete the installation.

Starting Together on Windows

The Together Setup writes the following runtime files to $TOGETHER_HOME$/bin:

Together.exe
Native Windows executable. It checks the system memory size, sets any necessary variables, and then searches for a compatible Java virtual machine. The search begins with the Sun JDK installed with Together, continues in the %JDK% folder specified in Together.bat, and finally proceeds to the system registry if a JDK has not been found. The launcher runs Together under the first compatible JDK it finds. If it cannot find one, it posts an error message and stops.
TogetherCon.exe
Native console version of the same program, installed under Windows only. It can be helpful to use this version if you want to redirect console input/output to a file. Run Together.exe/? or TogetherCon.exe/? to see the launchers' parameters.
Together.bat
Windows batch file. It sets necessary environment variables to default values and launches Together using the Sun JDK installed with Together. You can edit the file to control all the launch parameters if you wish.

If you have a floating license, you will need to install the Together floating license server on a remote network host accessible by the computer running Together. For complete instructions, see Setting_up_licensing.html in the root directory of your Together installation. Once license management has been configured, you can start Together as described below.
To launch Together under Windows, perform the following:

For floating licenses, make sure that the Together floating license server (either local or remote) is properly configured and running. Evaluation licenses do not require the server.
Run $TG_HOME$\bin\Together.exe . The executable looks for the Java runtime automatically installed with Together on Windows computers. It also looks for the floating license client (if necessary) and starts it automatically. Alternatively, you can use the Start menu shortcut, which points to this launcher.

Alternatively, if you want to customize memory settings, runtime environment path, and so on, you can edit the file $TG_HOME$\bin\Together.bat and then use that file to launch Together in Step 2. If you want to see console output, use TogetherCon.exe . Both launchers automatically start the floating license client if it is necessary for your license.

Note:

Together.exe and TogetherCon.exe use Together.bat as the configuration file. They set all environment variables from this file, except the Java Machine call command.

Back to top

Solaris systems

This section contains system requirements, installation, and start-up information for getting started using Together on systems running the Solaris operating system.

System requirements

Resource	Requirement	Notes
Hardware
CPU	SPARC Ultra-10 / 450 MHz or faster
Memory	512 MB minimum for running Together	768 GB or more is recommended when generating project-wide doc for large-scale projects. You might want to adjust the JVM heap setting "-Xmx" (which is 768m by default) in Together.sh to better reflect your physical and virtual memory configuration as well as your typical project size. For more information, refer to the Sun® FAQ: http://java.sun.com/docs/hotspot/PerformanceFAQ.html#171.
Disk Space	200 MB free disk space
Video	X Window System, Protocol version 11, Revision 6, minimum 1024x768 screen resolution	Recommended resolution: 1280x1024 or more
CD Drive	Optional	Necessary only if installing from CD
Software
Operating system	Sun Solaris® 9
Java SDK	Sun® Java2™ Standard Edition (SDK 1.3.1_06) plus: OS patches for Solaris (required to run SDK 1.3.1_06)	Together runs under this JRE. It is installed automatically during Together installation. Patches must be installed separately.
License Manager	Borland license client (built-in) and valid license	License registration is necessary after installation. See Licensing notes for more details.
Web Browser	Netscape Navigator 4.6 (or later)	Needed for viewing API documentation
Other
	An Internet connection is useful for obtaining software updates, node-locked licenses, and support, and for accessing Borland Together on-line resources.

Prerequisites for installing on Solaris

Together Edition for Borland C++ 2005 installs the Java™ 2 SDK, Standard Edition, Version 1.3.1_06 automatically. Together runs by default on this JVM, and by default expects to find it in the $TGH$/jdk directory. The installer sets the JAVA_HOME variable to point to the JVM in Together launchers, as well as in many scripts for bundled tools. If at some point you need to change the JVM for a certain script, you may edit scripts manually to change the path specified in JAVA_HOME.
OS patches for Solaris. The bundled JVM will not work unless all the patches for Solaris are installed. The necessary patches are not installed automatically. Before installing Together, make sure that you have installed all the OS patches corresponding to your Solaris version. You can obtain the patches and documentation at:
http://java.sun.com/j2se/1.3/install-solaris-patches.html
Borland C++ 2005. Before installing Together Edition for Borland C++ 2005, you must have Borland C++ 2005 already installed on your computer. The installer program will ask for the location of your Borland C++ 2005 installation.

Installation

Together installation is carried out using the InstallAnywhere utility.

Note:

If you are installing from a CD, locate the appropriate Solaris .bin file.

To install Together on Solaris:

Set executable permission rights for the installation file and run the installation file
Follow the on-screen instructions to complete the installation.
For Solaris, it is strongly recommended to install the JVM that is included in the Together installer (choose the option "Install a JVM specifically for this application" during the installation setup process). This prevents problems when reinstalling over an existing Together installation.

Important:

If you choose to use an existing JVM on your system, make sure that you specify the correct path to the actual JDK in the home directory of J2SDK 1.3 during installation. This path defines the JAVA_HOME environment variable, where Together looks for directories such as /bin (with java and javac), /lib (with tools.jar), /jre/bin (with java, javac), and /jre/lib (with rt.jar). Make sure that the JDK you specify is located in the J2SDK 1.3 home directory that includes these tools.

Starting Together on Solaris

The launcher file $TG_HOME$/bin/Together.sh is written to disk during installation. It sets appropriate environment variables including JAVA_HOME (required), and launches Together. You can edit the file to point to a different Java runtime location if you wish. You may have to edit the startup scripts in this file depending on the location to which you install it.

To start Together on Solaris, run $TG_HOME$/bin/Together.sh.

Back to top

Linux systems

This section contains system requirements, installation, and start-up information for getting started using Together on systems running the Linux operating system.

System requirements

Resource	Requirement	Notes
Hardware
CPU	Pentium-II, 350 MHz or faster	Recommended: Pentium-III, 500 MHz or faster
Memory	512 MB minimum	768 MB or more is recommended when generating project-wide doc for large-scale projects. You might want to adjust the JVM heap setting "-Xmx" (which is 768m by default) in Together.sh to better reflect your physical and virtual memory configuration as well as your typical project size. For more information, refer to the Sun® FAQ: http://java.sun.com/docs/hotspot/PerformanceFAQ.html#171.
Disk Space	200 MB free disk space
Video	X Window System, Protocol version 11, Revision 6, minimum 1024x768 screen resolution	Recommended screen resolution: 1280x1024 or more
CD Drive	Optional	Necessary only if installing from CD
Software
Operating system	RedHat Enterprise Linux WS 3.0	See Prerequisites for more information.
Java SDK	Sun® Java2™ SDK, Standard Edition, version 1.3.1 for Linux	See Prerequisites for more information.
License Manager	Borland license client (built-in) and valid license	License registration is necessary after installation. See Licensing notes for more details.
Web Browser	Netscape Navigator 4.6 (or later)	Needed for viewing API documentation
Other
	An Internet connection is useful for obtaining software updates, node-locked licenses, and support, and for accessing Borland Together on-line resources.

Prerequisites for installing on Linux

When running under Linux Together Edition for Borland C++ 2005 requires the Java™ 2 SDK, version 1.3.1_11. J2SDK 1.3.1_11 is included in the Together installation for Linux. Together runs by default on this JVM, and by default expects to find it in the $TGH$/jdk directory. The installer sets the JAVA_HOME variable to point to the JVM in Together launchers, as well as in many scripts for bundled tools. If at some point you need to change the JVM for a certain script, you may edit scripts manually to change the path specified in JAVA_HOME.
Compat-libstdc++-7.3-2.96.122.i386.rpm must be installed in order to make JDK 1.3.1 work properly.
For more information see (http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4964972). It can be found on Linux installation CD #3 (rpms) or downloaded from https://rhn.redhat.com/
Borland C++ 2005. Before installing Together Edition for Borland C++ 2005, you must have Borland C++ 2005 already installed on your computer. The installer program will ask for the path to your Borland C++ 2005 installation.

Installation

Together installation is carried out using the InstallAnywhere utility.

Note:

If you are installing from a CD, locate the appropriate Linux .bin file.

To install Together on Solaris:

Set executable permission rights for the installation file and run it.
Follow the on-screen instructions to complete the installation.

Important:

Starting Together on Linux

To start Together under Linux, run $TG_HOME$/bin/Together.sh.

Back to top

Other UNIX systems

Theoretically, Together should run on any operating system for which there is a Java Virtual Machine, and its development features should work on any platform for which there is a Java SDK. However, this guide lists only those platforms that are supported by both Together and Borland C++ 2005. If you wish to try using Together on other UNIX variants with different JVMs, you can use Linux system requirements as a basic guideline, but first make sure Borland C++ 2005 works on your chosen platform. Please understand that you do so at your own risk. Borland welcomes any feedback on results of running Together on platforms not currently supported.

Back to top

Starting Together from the command line

You can launch Together from the command line. Using command-line startup enables you to use command-line syntax options to:

Open a specific project on startup
Invoke Together with a shared remote configuration
Execute a specific module
Run Together in command mode (that is, without dialogs and user interactions)

You can use command-line syntax in batch files (or command, shell script, or other files) that you write and use to run Together. You can create such files and use them to run Together under different supported JVMs, with different classpaths, and so on.

Running Together in command mode supports the absence of user interactions (message boxes, dialog boxes, and input requests). Command mode is useful for running Together modules or accessing other features via the API as part of some external automated process. For example, during a nightly build process you could automatically generate HTML documentation.

Command mode execution requires careful attention to the use of parameters to construct a proper command line. Check for the existence and accessibility of the necessary project and configuration files. When executing a module in command mode, Together automatically exits after completion.

For information on command line syntax and parameters, see the appendix Command Line Parameters in the User Guide.

Back to top

Getting installation support

If you need installation support, you may contact the Together support center most convenient for you. For complete up-to-date contact information, please visit www.borland.com/support/.

Back to top

Known issues and limitations

Issue	Description
Moving/deleting typedefs	Typedefs cannot be moved or deleted using drag and drop. Instead, use the appropriate commands on the right-click menu.
Undo/redo	When using the Undo command after creating and renaming packages/classes, the elements may disappear from the diagram (but not the model tree). If this occurs, manually update the diagram by pressing F5. If similar problems also occur when moving files, refresh with F5.
References to unnamed elements	Though not typical, you may choose to reference unnamed elements from an existing project when creating models. Because of the way TCB calculates names for unnamed classes, the references may not be valid. Instead, rename the elements for use in modeling.
Search and replace all	Together's Search / Find/Replace in Files command (accessed from the main menu) may not replace all instances of given text when you choose a Replace All... command from the Replace button in the Confirm Replace dialog. Instead, use Search \| Replace from the main menu in Borland C++ 2005. In the Confirm Replace dialog, click All.
Edit Definition	The Edit Definition (right-click) command may not be available unless multi-declarations are separated. For instance: int A::a; int A::b; instead of: int A::a, A::b;
C++ extensions for .NET	C++ .NET extensions may not be parsed correctly.
Search optimization	Optimization via text searching (prior to deep parsing) is not active in this release.
Adding files to CVS	Borland C++ 2005 lets you add files to a project regardless of where the file is located. To add the file to CVs, however, the file must be physically located within the project directory. If the file is located outside the project directory, remove it from the project (Project \| Remove xx From Project, or click the Remove From Project button on the project pane toolbar), move it to a location within the project directory, and add it back to the project (Project \| Add Files, or click the Add File button on the project pane toolbar.
Property patterns and reference type attributes	C++ Property patterns cannot be applied to reference type attributes.
Changing definition files	You cannot change a definition file from the static attribute/operation Inspector. Instead, replace the file externally.
Installation cannot be completed after minimizing and restoring the installer window	If you minimize the installer window during Together installation and then restore it after the installer finishes copying files, the Next button does not work and the installation process cannot be completed (the only solution is to cancel installation and start over). This is a problem in the InstallAnywhere utility. To avoid this problem, we recommend that you do not minimize the installer window.
Printed image cut off for custom page size	When using a custom page size for printing, parts of the image might not be printed if you set a custom page size larger than the default (8.5 x 11) in the Print options (Tools \| Options \| <level> - Print). This is because the JDK does not allow to pass the page size from Together to the system print dialog. To avoid this problem, manually set your system printer properties to a page size that is the same as you set in Together, or larger.
Some tables in Help do not display properly	This is a known problem documented by Sun for JavaHelp. It may be necessary to close and restart the Help viewer from the Help menu.
In the project groups, it is impossible to work with one file that belongs to several projects.	Each project from a project group (for example, each .mmp file from a bld.inf file in a Symbian project) can be represented by a package in the Together project. Thus, all .mmp files are shown in a single model tree. However, if there are duplicated classes with the same fully qualified names, the global macros and includes may clash.
XMI Import doesn't work for mobile projects.	XMI Import adds source-code elements to the default diagram. However, in the Symbian projects it is impossible to create source-based elements in the root package. As of this writing, XMI Import for mobile projects is not supported.
Online help errors on Windows 2000 systems.	Using search capability in the online help on Windows 2000 systems may cause errors in Help. To avoid errors, do not perform full text search in the online help if you are running Together on a Windows 2000 computer.

XMI import issues

Following is a list of known issues that apply to using XMI 1.1 import for IBM Rational Rose models:

Note links to packages are not imported.
Association classes created in Rose are not imported.
String values without quotes are not imported.
In Rose it is possible to have several component diagrams with similar names. For example, Main under the component view, and also Main within a subsystem. In this case, during XMI import, two diagrams will be created in Together: Main and untitled, but all elements will reside on the untitled diagram.
Using XMI import for UML 1.1, the realize relationship link is imported as a generalization or implementation link. Using UML 1.3, the link is not imported at all.
Stereotype properties for transition links are not imported.

Back to top

Additional notes

Drag-and-Drop support

Drag-and-Drop support in Explorer and diagrams is turned off by default. Drag-n-Drop can impact performance, especially if other performance-sensitive options are enabled. You can turn it on in the Options dialog (Tools | Options | <level> - General - Enable Drag-and-Drop) and see how it works on your system.

Back to top

Finding out more

Access Online Help and PDF manuals from the Together Help menu. When Together is not running, you can access documentation from the following locations:

Online help

Help launcher for Windows: $TGH$\bin\win32\showhelp.bat

PDF manuals

User Guide: $TGH$/doc/userGuide.pdf

Getting Started with Together Edition for Borland C++ 2005: $TGH$/doc/gettingStarted.pdf

Note:

Adobe® Acrobat® Reader® is required for viewing documentation in PDF format. The free Acrobat Reader is available for download from www.adobe.com/products/acrobat/

Back to to

Made in Borland ©1998-2004 TogetherSoft Corporation, a wholly owned subsidiary of Borland Software Corporation. All rights reserved.
IBM and Rational Rose are trademarks of IBM Corp. in the United States, other countries, or both.