IBM Rational Synergy version 7.1a readme | IBM Corporation 6 November, 2009 |
© Copyright IBM Corporation 1992, 2009
U.S. Government Users Restricted Rights - Use, duplication, or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
This file contains last-minute product information and updates to IBM Rational Synergy 7.1a.
It is divided into the following sections:
For the latest news and information on Rational Synergy 7.1a, visit the Web site at http://www.ibm.com/software/rational/support/
To run Rational Synergy 7.1a, you need one of the following operating systems installed on your computer, running on a supported locale:
CPU, OS and version |
Locales |
Server |
User Interfaces |
---|---|---|---|
Sun SPARC |
China zh_CN.GB18030 |
Informix |
Synergy GUI |
IBM |
China Zh_CN |
Informix |
Synergy GUI |
Pentium or equivalent |
China zh_CN.gb18030 |
Informix |
Synergy GUI |
Pentium or equivalent |
Chinese (PRC) |
Informix |
Synergy GUI |
Pentium or equivalent |
Chinese (PRC) |
Not supported |
Synergy GUI |
Pentium or equivalent |
Chinese (PRC) |
Not supported |
Synergy GUI |
Pentium or equivalent |
Chinese (PRC) |
Informix |
Synergy GUI |
This release provides support for Asian language characters, with the restrictions noted in this document.
Synergy clients on Windows may connect to a Synergy server in the same Windows locale, or to a Synergy server in a UNIX® locale for the same country. UNIX clients may connect only to Synergy servers in the same UNIX locale. For example, a Solaris server in Japan (the ‘ja’ locale) may be accessed from a ‘ja’ Solaris client, from a ‘ja_JP.eucjp’ Linux client, and from Windows Japanese clients.
Cross-locale working, for example, a Synergy client in a Chinese locale connecting to a Japanese Synergy server, is not supported.
The minimum hardware requirements for the server are:
The minimum hardware requirements for the client are:
Rational License Server TL 2.0 must be installed and operational.
Rational Directory Server 5.0, 5.1, or 5.x must be installed and operational.
Rational Synergy release 7.1a has the following restrictions.
The Synergy Classic GUI is not supported on UNIX or Linux.
The HP-UX operating system is not supported.
Windows FAT-16 file systems are not supported. Rational Synergy Windows servers must be installed on NTFS file systems. Windows work areas may be placed on NTFS or FAT-32 file systems.
Rational Synergy does not adapt numeric formats or sorting orders according to the locale.
For additional information on system requirements, including recommended configurations, visit the Rational Support Web site at: http://www.ibm.com/software/awdtools/synergy/sysreqs
Rational Synergy 7.1a is compatible with the following products:
* If you intend to run Rational Change with Rational Synergy 7.1a, see the Rational Change 5.2 readme on the IBM Rational Information Center for the manual steps necessary to support this configuration.
Rational Synergy 7.1a is DCM-compatible with the following versions:
Previous releases of Synergy require patches to support DCM compatibility with Rational Synergy 7.1a. See the Rational Support Web site for more information.
DCM and DCS transfers between two Synergy Asian-release databases, i.e., Release 7.1a and 6.6a, are supported, even when those two databases are in different locales. DCM automatic receive across different locales is not supported. Also note that that operating system settings and fonts might not permit simultaneous display of characters from multiple locales.
Login to IBM Passport Advantage to download platform-specific installation images for Rational Synergy or to request a physical media kit.
See the IBM Rational Synergy Installation Guide for detailed directions about installation. The documentation can be found online at the Rational Information Center.
Synergy 7.1a uses the IBM Rational License Server TL, which is a FLEXlm-based license server that manages licenses for heritage Telelogic products.
You must install the latest Rational License Server TL and request a new license.
The following sections provide brief descriptions of product features available in the Rational Synergy Asian release stream, including Synergy 7.1a:
This release provides support for characters from the Unicode 5.1 standard, including right-to-left characters. The ability to display characters in the supported Unicode set depends upon your operating system settings and fonts. Rational Synergy itself does not provide any fonts.
Rational Synergy supports Asian language characters in most attributes, including:
Input method editors (IMEs) are enabled in Rational Synergy dialogs, so you can enter the range of characters supported by the IMEs. IBM has verified Rational Synergy with the standard IMEs supplied by the operating system vendors; third-party IMEs have not been tested.
In some contexts, Rational Synergy allows use of external viewers and editors to display or edit the contents of string and text attributes. For example, the Task Browsing dialog in Rational Synergy classic client has an Edit button to edit the Task Description. The command line also provides this facility - for example, the ccm attr -m
command allows users to edit any text attribute value (subject to the usual permissions checks). In all cases, the text sent to the external viewers and editors is in the default system encoding, and the text returned from the editor is assumed to be in that same encoding. In many locales, this means that characters from other locales will be lost or modified. For example, an attribute containing both Chinese and Japanese characters cannot be edited using ccm attr -m
on a Japanese system with the Shift JIS encoding - the Chinese characters would be lost or be substituted by incorrect Japanese characters.
For more general information about encodings for Rational Synergy files and attributes, see File Encodings.
Rational Synergy Asian releases extend support for Asian language character in source files.
The bundled Rational Synergy graphical compare and merge tool (Synergy Compare/Merge) is supported for source files that contain Asian language characters. For more information, see Compare/Merge.
A wide range of encodings are supported for source files, but see below for information on UTF-16 and UTF-32, and see the restrictions on Keyword Expansion. Files in encodings incompatible with ASCII (such as EBCDIC) should be defined as binary types. For more general information about encodings for Rational Synergy files and attributes, see File Encodings.
It is the user’s responsibility to ensure that the editors used with Rational Synergy can handle the encodings used. Some editors allow the encoding to be selected when opening or saving files; others assume files are in the default system encoding.
For some files in some encodings (and for almost all files in UTF-16 or UTF-32 encodings), source files are treated as binary even if they have a subtype of ascii. This means that the Rational Synergy type of the object may be ascii
or a subtype of ascii, but internally, Rational Synergy treats the file as binary. A file is treated as binary due to the appearance of null bytes, Control-Z, or too many other non-printable characters. UTF-16 or UTF-32 files may contain a large number of null bytes. This has the following implications for files that are treated as binary:
Newline translation is not performed. This means that if the CM server is on UNIX or if the database contains data that was received in a DCM package from a UNIX database (which is supported), and the CM client is on Windows, source files in the Windows work area might contain UNIX-style newline characters. Unicode-aware editors and IDEs are likely to handle both types of newline characters (because the Unicode standard recommends that). It is not necessarily true that other Windows-based, non-Unicode Asian language tools can handle UNIX newline conventions.
The binary compare and merge tools are used. This means that compare and merge do not work unless a tool that understands the specific encodings used is configured for the binary type . Note that the bundled Telelogic Synergy Compare/Merge tool does handle UTF-16 and UTF-32.
Source file keyword expansion is not performed.
The graphical Synergy Compare/Merge tool supports a large number of file encodings. When you first run the tool, it asks permission to create a list of encodings in a file .ccm_merge.enc
in your home profile directory. When you start a merge or compare, you may choose the encoding for the files from this list. If you wish to make the list shorter, you can remove encodings from the menu selection by editing the .ccm_merge.enc
file, and restarting the Compare/Merge tool. If you wish to restore the full list, delete the .ccm_merge.enc
file.
If you select an encoding that is not appropriate for the files being merged or compared, the tool may detect that and prompt you to select a different encoding. If the tool does not detect the incorrect encoding automatically, and you see the wrong characters displayed on screen, you should restart the merge or compare and select the right file encoding explicitly.
Synergy Compare/Merge does not support merging or comparing files with different encodings.
The tool also creates a .ccm_merge.dat
file in your home profile directory. This file holds your default settings, including the encoding most recently used. You can edit the .ccm_merge.dat
file to change the default Compare/Merge settings.
Text written by Rational Synergy to the standard output and standard error streams is in the system default encoding. Text read by Rational Synergy from the standard input stream is assumed to be in the same system default encoding. This means that scripts using the CLI might not be able to handle attribute values from multiple locales, since many encodings cannot represent (for example) both Chinese and Japanese characters at the same time.
On Windows, programs may read their command line parameters in the default system encoding, or in Unicode. Programs that read the parameter values in Unicode can handle strings from multiple locales. Programs that use the default system encoding probably support only one locale.
On UNIX, the command line parameters are only available in the encoding for the current locale. If that encoding is Unicode (for example, UTF-8), characters from multiple locales can be handled correctly. If the locale encoding is not Unicode (for example, EUC), programs can only support command line characters from that one locale.
Source files are sent to and read from editors, viewers, merge tools, etc., as an uninterpreted stream of bytes. It is up to the user to select tools, and/or tool options, that match the actual source file encodings.
Rational Synergy expects its own files to be in specific encodings - either UTF-8 or the system encoding. Note that files containing only 7-bit ASCII characters are compatible with both UTF-8 and system encodings such as Shift-JIS.
The following frequently edited Rational Synergy files must be in UTF-8 (or ASCII) encoding:
ccm_home/etc/ccm.properties
ccm_home/etc/ccm.help.file.properties
ccm_home/etc/ccm.server.properties
ccm_home/etc/ccm.ini
ccm_home/etc/om_hosts.cfg
ccm_home/etc/ignored_file_patterns
database/db/MDL_INFO
database/etc/dcm*.txt
database/lib/Unix/migrate.rul
database/lib/Windows/migrate.rul
database/lib/notify/*.tpl
database/pt/attrange.dft
The following frequently edited files must be in the system default (or ASCII) encoding:
All files in and below
ccm_home/bin
All files in and belowdatabase/bin
database/db/DBINFO
database/etc/NTftp.in
database/etc/Unixftp.in
Scripts indatabase/lib/notify/Unix
Batch files indatabase/lib/notify/Windows
The following frequently edited Rational Synergy files must be limited to 7-bit ASCII characters only:
ccm_home/etc/remexec.cfg
ccm_home/etc/ccminit
ccm_home/etc/ccm_locales.map
ccm_home/etc/ccm.svm.properties
ccm_home/etc/javatoolargs
ccm_home/etc/system_info.txt
ccm_home/etc/trusted_clients
database/lib/ccminit
database/lib/notify/Unix/*.def
database/lib/notify/Windows/*.def
Rational Synergy supports having multiple names, or aliases, for locales and encodings. For example, in Japan, the user might log in using the shorter and more convenient locale name ja instead of the more complete name ja_JP.eucJP
. Rational Synergy has a built-in table of the common forms of these aliases, but provides a way to extend the list if necessary.
The valid synergy_encodings
are UTF8, BIG5, eucJP, EUC-KR, SJIS
, and GB18030.
If you need more information on encodings, refer to the technical note "Encoding Translations" on the Support website.
Rational Synergy supports different encodings for the same source file. This allows source files to have encodings that correspond to where they are stored. Three different encodings may be specified for each object: one encoding for the server, one encoding for the Windows work area, and another encoding for a UNIX work area. This ensures that the appropriate encoding conversions are made when a file is copied from one location to another. To accomplish this, two attributes must be set.
The attribute encoding_conversions
is set on the model object. When this attribute is set to TRUE
, the multiple-encoding feature is enabled for the database. If this attribute does not exist or is set to FALSE
, this feature is not enabled for the database.
The attribute encoding_rules
is set on the object type. This attribute specifies that encoding translations occur when the files are copied between the client and server, and vice versa. The encoding_rules
attribute is of the following form:
Server-encoding:encoding
Unix-wa-encoding:encoding
Windows-wa-encoding:encoding
Specifying the UNIX or Windows work area encoding is optional. An encoding
must be the name of a character encoding that is recognized by standard encoding conversion programs, such as iconv
. If you need more information on encodings, refer to the technical note "Encoding Translations" on the Support website.
This section covers areas where Asian characters are not supported, where Rational Synergy 7.1a does not offer the full functionality of the underlying release 7.1, and other issues in product usage.
Some string or text fields and values are restricted to 7-bit ASCII characters, excluding control characters, but including white space characters. The restricted fields and values are:
Some characters are reserved for use as delimiters by the operating systems, INFORMIX, or Rational Synergy, and may not be used in object names. For example, the colon (:), slash (/), and backslash (\) characters (amongst others) may not be used in object names. Project names must not contain tabs. See Rational Synergy Help and the Rational Synergy Administration Guide for more information.
Rational Synergy places limits on the lengths of various names and other strings. These limits are in terms of bytes, not characters. Some error messages might describe limits in terms of characters; such messages are incorrect, and should be taken as referring to byte length limits. All strings are held internally in Rational Synergy as UTF-8, so the length limits in Asian characters would normally be one third of the byte limit. For example, the length of an object name is limited to 155 bytes; this would imply a limit of 51 Asian characters. Version strings are limited to 32 bytes, or 10 Asian characters.
Due to operating system restrictions, you must use only ASCII characters in passwords when starting a remote session from Windows to UNIX using rexec
. If you have non-ASCII characters in your password, you must use ESD to start a Windows session on a UNIX database. This limitation on starting remote sessions also applies to DCM automatic receive; for this reason, IBM recommends that the password for ccm_root be limited to ASCII characters if DCM automatic receive is used.
In the Rational Synergy Classic clients, only the following date formats are supported for date input, such as entering dates in queries or in task estimated completion dialogs:
YYYY/MM/DD hh:mm:ss
+dd:hh:mm:ss
or -dd:hh:mm:ss
, >where the relative displacement is from the start of todayRational Synergy supports a locale-appropriate calendar widget for date selection, but only for Gregorian calendars.
For date output, the default date display format is YYYY/MM/DD
. You can select other date formats using the environment variable CCM_DATETIME_FMT
. However, non-numeric date formats might not always work, and cannot be copied to a date input field.
Migration of source (in any encoding) from plain files is supported. Migration of archives from SCCS, RCS, CVS, and PVCS is not supported.
Keyword expansion in source files is disabled by default in Rational Synergy 7.1a, using a new model attribute keyword_expansion
.
Keyword expansion can be enabled by setting this model attribute to TRUE:
ccm attr -c keyword_expansion -f -t boolean -v TRUE base-1:model:base
Keyword expansion can be disabled by deleting this attribute, or setting it to FALSE:
ccm attr -c keyword_expansion -f -t boolean -v FALSE base-1:model:base
or:
ccm attr -d keyword_expansion base-1:model:base
Note that the strings inserted by keyword expansion are always in UTF-8, regardless of the encoding of the source files in question. If your source files do use UTF-8, or if the strings generated by keyword expansion are always 7-bit ASCII, then the result works as expected.
However, if your source files use any encoding other than UTF-8, and the values substituted for the keywords include Asian or other non-ASCII characters, then keyword expansion would generate incorrect results.
Keyword expansion in source files whose names include spaces may contain syntax errors when compiled. Avoid using spaces in source code file names, or comment out (or remove) the keyword.
The ccm import
and ccm export
commands are not supported in this release.
The commands ccmsrv archive
and ccmsrv restore
are not supported in this release.
ObjectMake is not supported in this release.
ACcent and GUILD customizations are not supported in this release. The custom database pack file is not provided. GUILD files may contain only 7-bit ASCII characters, so may not be used for localization.
Changes to Rational Synergy 7.1a from the previous release (6.6a) are summarized below. See the following sections for details.
Important! Before you upgrade to Rational Synergy release 7.1a, carefully read this entire readme document and Appendix B of the Rational Synergy Upgrade Instructions.
The primary goal of Rational Synergy release 7.1a is improved performance for users accessing a Synergy database across a wide area network (WAN). This enables distributed team members around the world to work together on a central Synergy server without using data replication, thereby reducing complexity and administration costs.
Although the performance improvements are most dramatic for users with a high latency (slow) network connection, most local area network (LAN) users also will enjoy significantly improved performance.
To improve performance, Rational Synergy 7.1a introduces a new communication architecture called Web Mode. Synergy sessions can be started in either Traditional Mode, which is similar to 6.6a, or Web Mode, which is much faster and suitable for WAN or remote users.
For end users, Web Mode and Traditional Mode look and behave very similar. The differences are described below.
Web Mode is appropriate for most users. Traditional Mode is appropriate for administrators and users doing migration.
Traditional Mode will be phased out in a future release, but it minimizes risk of upgrade to release 7.1a. If some users find that Web Mode is not suitable for them, they can continue to use Traditional Mode for the time being.
For more information about the architecture, see the Rational Synergy Administration Guide.
Web Mode users are authenticated via RDS, which is an LDAP directory service. (In previous releases, RDS was known as TDS, or Telelogic Directory Server.)
The RDS installation and user definitions can be shared with other products such as IBM Rational Change. Web Mode users must also be added as users in the Synergy databases they will access; this permits them to start sessions on those databases and defines which roles are available to them in each database.
It is not necessary to create operating system (OS) accounts on the server for Web Mode users. Web Mode is well-suited for remote or offshore users who may tend to change more frequently, because you can add them to RDS and the appropriate Synergy databases without assistance from your system administrator.
Traditional Mode users are authenticated against the OS as in previous releases. Traditional Mode is suitable for administrators and local long-term users.
The Unix Engine Start Daemon (ESD) service is not required for users to start Web Mode sessions. If Traditional Mode users still need to access the server through a firewall, or if you run Rational Change, the ESD must run on the server; however, Web Mode users must not have the option engine_daemon=true set in the ccm.ini file when they start sessions.
Web Mode users must always provide a password in order to start a session. The “trusted users” feature that enables Windows client users to start sessions without a password is not supported for Web Mode users. For information on the use of passwords in scripts, see Starting and managing sessions in New command line interface (CLI).
For more information on user authentication, see the Rational Synergy Administration Guide.
By default, a single CCM server serves all Rational Synergy databases. For improved scalability when supporting large numbers of users, you can create additional CCM servers on different physical servers to serve different Rational Synergy databases. All back-end Rational Synergy sessions will run on the physical server that hosts the CCM server. (Note: A single database cannot have more than one CCM server.)
Rational Synergy 7.1a improves the ability to manage which CCM servers serve which Rational Synergy databases with the following features:
A Rational Synergy end user can now change his or her RDS password via the Rational Synergy CCM server by navigating to the URL CCMServerAddress/user.
The program to manage work areas was rewritten for Web Mode to be more efficient and faster. Traditional Mode continues to manage work areas in the same way as previous releases.
The new work area is identical in behavior to the classic work area as much as possible. The data in the file system is identical, so it is possible for a user to switch between Web Mode (new work area) and Traditional Mode (classic work area) sessions if needed. Users may do this as a workaround if they find an issue in the new work area.
Important! Users should not run Web Mode and Traditional Mode sessions on the same work area at the same time.
The following improvements were made to support component-based development in Rational Synergy:
Rational Synergy 7.1a provides a new CLI for use with Web Mode. It is called the Synergy CLI.
The CLI from previous releases is unchanged, and is now referred to as the Classic CLI. It works with Traditional Mode and the classic work area. Because the Classic CLI is still available, there is no urgency to port all of your scripts to the new Synergy CLI at this time. (Note that the Classic CLI will become obsolete in a future release.)
Important! If you have scripts that run on work areas that will be maintained by GUI sessions in Web Mode starting in 7.1a, you should update those scripts to use the Synergy CLI rather than the Classic CLI. The Web Mode work area and Traditional Mode work area are compatible, but running Web Mode and Traditional Mode sessions in parallel on the same work area may cause data loss.
The Synergy CLI does not contain all of the functionality from the Classic CLI yet, but in many ways, it is better. It is faster than the Classic CLI, and provides better consistency, improved formatting capabilities, and several new commands.
The Synergy CLI is backward compatible with the Classic CLI as much as possible, so many scripts will run almost unchanged. The messages intended for users have been improved, but messages intended for program consumption (for example, messages whose output is typically read by a script and then acted upon) have not changed.
Rational Synergy 7.1a includes new help for the Synergy CLI. For more details on any of the information summarized in this section, see the Synergy CLI help.
To start the Synergy CLI, specify the ccm start
command
with the –s
(server) flag and the URL of the CCM server.
For example:
$ ccm start –d database_path –s http://galaxy:8400 –pw password
By default, the password is required for the Synergy CLI even on Unix,
since Web Mode sessions are authenticated using RDS. You can use the
ccm set_password
command to save the password in an encrypted file
in your home directory. If that file exists and you do not specify
the password, Rational Synergy will use the password from that file.
Use the ccm start -fpw file
command to have
Synergy read the password from the specified file.
To tell which kind of session you are running, use the ccm status
command. Classic CLI sessions are shown as "Classic Command Interface" and
Synergy CLI sessions are shown as "Command Interface". For example:
$ ccm status
Sessions for user fred:
Graphical Interface @ sirius:51765:192.168.22.33
Database: /vol/ccmdb/mydb/db
Private Session @ sirius:51771:192.168.22.33
Database: /vol/ccmdb/mydb/db
Classic Command Interface @ sirius:61029:192.168.22.33
Database: /vol/ccmdb/mydb/db
Command Interface @ sirius:52515:192.168.22.33 (current session)
Database: /vol/ccmdb/mydb/db
Current project: 'commons,fred'
("Private Session" indicates a back end session used by a Synergy GUI session
running in Traditional Mode. You should not issue commands to a private
session because it is reserved for use by the Synergy GUI.)
Commands
The following ccm commands are available in the Synergy CLI. (These are
mostly identical in behavior to the same commands in the Classic CLI.)
alias
attr
baseline
candidate
cat
change_type
checkin
checkout
checkpoint
conflicts
copy_project
copy_to_file_system
create
dcm
delete
delimiter
diff
dir
edit
finduse
folder
folder_template
groups
history
ln
ls
make
merge
move
process_rule
project
project_grouping
project_purpose
properties
query
reconcile
relate
release
set
show
soad
soad_scope
start
stop
sync
task
type
undo_update
unrelate
update
unalias
unset
unuse
use
view
work_area
In addition to the list above, the following four new commands are introduced in the Synergy CLI.
ccm cmdhistory
saves and lets you display your
recently-executed CLI commands. It is similar to the Unix history
command, or the Windows command history accessed via the up and down arrows
on your keyboard.
ccm get_debug_logs
enables you to get the Synergy log files
from the server. You would use this as requested by Support when working
with them to debug issues.
ccm process
enables creating and maintaining processes from the command line. It includes the following subcommands:
ccm process -copy
ccm process -create
ccm process -delete
ccm process -list
ccm process -modify
ccm process -show
ccm show_servers
displays CCM server processes.
The following commands are available in the Synergy CLI, but the options shown
below are not yet available:
ccm create -t project -r
(creating a project using an existing directory as its root)
ccm dcm -change
, -init
ccm delimiter
(when used to set the delimiter)
ccm groups -create
, -edit
, and -list
ccm process_rule -compare
ccm release -rename
ccm work_area -find
and -dbpath
- All
ccm -g
options (used to display a dialog in the Classic GUI)
The ccm baseline
command was extended to support creating and displaying component tasks:
- A new
ccm baseline -create_component_tasks
subcommand can be used to create component tasks for a baseline.
ccm baseline -show
now shows component tasks if they exist.
The ccm dcm
command has new options for –mark_up_to_date
and –recompute -releases
. See help for more information.
The ccm finduse
command was extended with new options for folders, folder templates, and change requests. Also added was a new scope for finding process rules that use an object.
The ccm folder
, ccm folder_template
, and ccm task -query
subcommands were extended to support convenient querying for component tasks.
The ccm groups
command has a new –unassign
option.
For details, see help.
The ccm process_rule -copy_baseline_rules_only
command was implemented to support copying baseline rules to other process rules.
The behavior of the ccm project
command has changed. See help
for more information.
The information formats for various objects has been extended to show:
- Directory entries for directories and projects in verbose mode
- Component tasks for baselines in verbose mode
- Baseline project for projects
- Component tasks for release definitions
The following ccm commands are not yet available in the Synergy CLI. They are
mostly administrative. Use the Classic CLI to run these commands.
archive_fix
clean_cache
clean_up
collapse
db_udpate
depend
expand
export
fs_check
help
import
license
migrate
resync
typedef
users
win_fixup
The ccmdb
, ccmsrv
, and ccmadm
commands
are not a part of the Synergy CLI, but are available as they were in previous
releases.
The “3.2 commands” such as ccm bindsite
are not available in the
Synergy CLI. These commands are not defined by default, but you may have been
instructed by Support to define these in your .ccminit file in a previous release.
Dropped legacy features
The following features are not supported in the Synergy CLI and will not be
supported in the future.
- Manual reconfigure/update properties, including the following command.
Use
ccm project_grouping
and ccm process_rule
in
place of these commands.
ccm reconfigure_properties
(reconf_prop
,
rp
)
ccm update_properties
(update_prop
,
up
)
- Object-status based CM
- ACcent customization commands:
ccm define
, ccm
accent
, and ccm load
- Use of
–task
"" to bypass the requirement that a task must
be specified
- Obsolete DCM options to support data formats prior to release 6.3,
including project instance mapping and non-XML interchange formats for DCM
and import/export
Command formatting
The Synergy CLI provides much more extensive formatting options than the
Classic CLI for the output from query and similar commands, and is capable
of producing nicely formatted reports. Here are some of the formatting
options available.
- Strings can be formatted using either Java MessageFormat or printf
styles.
- You can use escape sequences to embed special characters in the output,
such as newline (
\n
), tab (\t
), and backslash
(\\
).
- You can format dates using the
–format
option of the
query command, and dates are sorted by value rather than alphanumerically.
For example:
> ccm query ... -f "%{completion_date[dateformat=\"H.mm a 'on' EEEE, MMMM dd yy\"]}"
1) 8.14 AM on Friday, September 12 08
2) 21.56 PM on Sunday, September 14 08
3) 18.22 PM on Monday, September 15 08
4) 14.24 PM on Tuesday, September 16 08
5) 15.08 PM on Wednesday, September 17 08
- String fields such as task numbers and release numbers sort numerically,
rather than alphanumerically; for example, when sorting by task number,
task 8 no longer appears after task 12.
- You can sort in ascending or descending order; you can sort by multiple
fields; and you can sort by fields not shown in the output. The following
example shows sorting by multiple fields.
> ccm query ... -format "%displayname %resolver %release" –sortby +release+resolver
1) 102 fred 1.0
2) 101 joe 1.0
3) 1000 fred 1.1
4) 1003 joe 2.0
- A new
–groupby
option enables you to group query output
by values such as the resolver.
> ccm query ... -format "%displayname %task_synopsis" –groupby
"Resolver: %resolver"
Resolver: fred
1) 101 Fix defect M#12345
2) 1000 Implement sorting
Resolver: joe
3) 102 Implement date formatting
4) 1003 Extend grouping feature
- String or text fields can be truncated to a certain column length, or
wrapped to fit within that field length.
See help for more information on formatting.
Options, preferences, and settings
The Classic CLI reads preferences from the database, the ccm.ini file in the
installation directory, and your ccm.ini file in your home or profile directory.
The Synergy CLI reads preferences from the database, the ccm.properties file
in the installation directory, and your ccm.user.properties file in your home
or profile directory. Review the ccm.properties file in the installation to
see what you can set. Many new options are available, including command
output format options. Not all preferences supported in the Classic CLI
are available in the Synergy CLI.
Object specifications
The Synergy CLI has a complete and consistent syntax for identifying objects
of all types, and the various specifications can be used consistently
throughout commands. See help for complete details.
Interactive or piped mode
The Classic CLI enables you to run the program ccm
, and then
interactively enter commands at the ccm>
prompt, or use the
ccm source
command to read and run a series from a file. This
avoids the cost of starting the ccm
process for each command,
and is sometimes used within scripts or programs for performance reasons.
This mode is not yet available with the Synergy CLI.
Cross-computer security restrictions
The Classic CLI permits users to issue commands to a CLI running on a different
computer, using the deprecated .rhosts
file for authentication.
The Synergy CLI does not support this capability. After starting a Synergy
CLI session, all commands must be issued from the system where the ccm
start
command was run. This ensures that the user issuing commands
is authorized to access that session.
Stdout, stderr, and return status
In the Classic CLI, all output goes to stdout. In the Synergy CLI, normal
output and progress messages go to stdout, and error messages go to stderr.
When writing scripts for the new CLI, be sure to capture the output from
stderr as well as stdout.
The Synergy CLI is more consistent about command return status. The following
status values are used.
Return status...
Means
0
Success
1, 2 or 3
Invalid command syntax, invalid option or argument
4 or 8
Other error during execution
5
Command not implemented
6
Query found no results
7
Command usage shown
Converting Classic CLI scripts to run with the Synergy CLI
Check the Support site for a paper on converting Classic CLI scripts to use the Synergy CLI.
Changes to the Synergy graphical user interface (GUI)
The Synergy GUI can be started in Web Mode or Traditional Mode. All
functionality is the same, except as described in this document.
To start the Synergy GUI in Web Mode, specify the URL of the CCM Server for
your database in the Server field of the start dialog. If you enter a hostname
in the Server field, your session will start in Traditional Mode. (The Classic
GUI runs only in Traditional Mode.)
The Synergy GUI shows the server or hostname in the bottom right corner.
A URL indicates that the session is running in Web Mode, whereas a hostname
indicates that the session is running in Traditional Mode.
Other changes in the Synergy GUI include:
- New welcome page
The Synergy GUI displays a web page in the work pane the first time a new user
starts a session. This page, called the welcome page, provides options to help
users get started or find more information; for example, it gives options to
create a new project, open a project, or visit the Support site.
This page can be opened any time from the Help menu.
The page source is stored in the etc\welcome\
directory in the
Synergy client installation. You can configure the page source, for example,
to add links to your Intranet or central documentation site. The GUI’s
embedded web browser supports simple HTML only, and does not support
scripting, so if you decide to configure the page, keep your changes simple
and set up links so that other pages are opened in a separate browser.
Changes to the welcome page would need to be deployed to all clients,
and you would need to merge your changes when you upgrade Synergy.
- History dialog
The History dialog was updated to make it easier to manage a complex history containing many versions. A new macro view provides context and easy navigation. A new list view provides easy sorting and filtering to enable users to quickly find a specific version and navigate to it. Show only the selected version, predecessors and successors with one click to easily traverse complex histories. Increase or decrease the font size and number of versions shown with one click.
- Selection of release values
Selecting release values has been improved. By default, Rational Synergy saves the most recently-used release values at the top of the release drop-down list so that the user does not need to expand the release tree. These release values are referred to as favorites. The user can set preferences for how many release favorites will appear and which values should be permanently displayed in the release drop-down list.
- DCM transfer set maintenance
Any object that can be included in a transfer set now has a Transfer Sets pane
in the Properties dialog. Users with the dcm_mgr privilege can add objects to
transfer sets using copy/paste or the Select Transfer Set dialog. The Query
dialog also has full support for querying and viewing transfer sets.
Generating and receiving DCM packages is not supported from the Synergy GUI;
use the CLI or Classic GUI.
- Easier error reporting
There is a new option on the Help menu to submit a support request. This
option opens a dialog where you can enter a question or record a defect.
It collects information about your Synergy installation, build number, JRE,
and operating system, and also gathers relevant log files from both client
and server. You can attach extra files or remove files if you’d like. It also
offers options to create a snapshot or recording and attach it to the request;
these options can be used to demonstrate the issue.
When the user submits the request, it is emailed to an address that is configured
in the etc/system_info.txt
file in the Synergy server installation.
By default, the email address is not defined. You will probably want to route
support requests to your internal support team so that you can monitor issues
and prevent end users from accidentally sending confidential information
outside the company.
After changing the email address on the server, you must restart the router.
- Improved keyboard navigation
Deployment of Windows clients
Rational Synergy Windows client users can now install and patch their Rational Synergy client installations using the Rational Synergy deployment feature without having Administrator privilege on the Windows desktop.
If the user installing Rational Synergy has Administrator privilege, the Rational Synergy client is installed for all users of the local machine, and requires the end user to have Administrator privilege to update the client installation in the future. This is how the client behaved in previous releases.
If the user installing Rational Synergy does not have Administrator privilege, the Rational Synergy client is installed for the current user only. The registry entry is stored under HKEY_CURRENT_USER rather than HKEY_LOCAL_MACHINE. This enables the user to automatically update/patch his or her own client from the server using the Rational Synergy deployment feature.
Note: Windows Vista has additional security restrictions that may prevent automatic deployment.
New archiver
Rational Synergy 7.1 includes a new underlying archiver used to archive source files. The new archiver is scalable, reliable, and fast, and is used for both ascii and binary data types. This change is transparent to all users except the administrator.
Starting in Rational Synergy 7.1, archiving is asynchronous for fast file check in. Upon check in, source files are synchronized from the work area to the Rational Synergy server, but the check in operation does not wait until the file is archived before completing. This improves the performance of check in, especially for large files.
All related tools and commands such as ccm clean_cache
and ccm archive_check
were updated to behave appropriately to work with the new archiver and asynchronous archiving behavior.
Each database has one back-end session dedicated to archiving checked-in files for all users of that database. Administrators may want to configure the CCM server to increase the number of back-end sessions for a given database to account for this dedicated session. See the IBM Rational Synergy Administration Guide for more information about configuring the server.
Compliance with IBM Standards
Rational Synergy release 7.1a was updated to comply with IBM technical, legal,
and marketing requirements, in order to ensure quality of the products and
protection of intellectual rights.
In the process of updating Rational Synergy to comply with IBM standards,
the following changes were made:
- The product name was changed from Telelogic Synergy to IBM Rational Synergy.
The splash screen and About dialog were updated. On Windows, the installation path,
Start menu entry, and desktop icons were updated.
- Copyrights, trademarks, license information, and notices were updated.
- The Java Runtime Environments bundled with Rational Synergy on all platforms
were upgraded to the IBM Java JRE version 1.6.
- The tutorial.cpk packfile containing sample code for JRisk was replaced with
a training.cpk packfile containing sample code for JavaGameBook. The tutsetup
program was removed, but the Windows installer provides an option to unpack
training.cpk.
- Some underlying utilities used to archive, package, and compress data in
Rational Synergy were replaced with alternative programs. These changes should
be transparent to Synergy users and administrators. For details about
this change, see the Rational Synergy Upgrade Instructions.
- The feature to migrate data into Rational Synergy from PVCS archives was
removed. To migrate PVCS data, contact Professional Services for assistance.
- Underlying utilities used for compare and merge in the Classic GUI and Classic
CLI were replaced with alternative programs. These changes should be transparent
to users, but it is possible that the results of merge will differ slightly from
previous releases.
- The ico program was removed from the CCM_HOME/samples directory.
- The Jetty web server was upgraded to version 5.1.14, and several components
not used by Rational Synergy were removed from the installation.
- Contributed programs in the extras directory were removed from the Rational
Synergy installation. Check IBM DeveloperWorks for free add-ons that work with
Rational Synergy 7.1a.
Upgrading to Rational Synergy 7.1a
Rational Synergy 7.1a is a big release with many improvements, and also many
underlying changes. Before upgrading, it is a good idea to test carefully and
thoroughly, as described in the Rational Synergy Upgrade Instructions.
Rational Synergy 7.1a provides some new utilities for use during the upgrade
process. See Appendix B of the Rational Synergy Upgrade Instructions
for more information.
Important! Before you upgrade, be sure to carefully read the Rational
Synergy Upgrade Instructions, including Appendix B.
Known problems
Visit the IBM Support site for an updated list of known problems.
Fixed problems
Visit the IBM Support site for a list of problems fixed in Rational Synergy 7.1a.
Contacting Support
Please visit our Rational support overview site at: http://www.ibm.com/software/rational/support/telelogic/
You will find a one-sheet reference guide about how to best contact support in your geography.
Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send written license inquiries to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send written inquiries to:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan
The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions. Therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:
Intellectual Property Dept. for Rational Software
IBM Corporation
1 Rogers Street
Cambridge, Massachusetts 02142
U.S.A.
Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.
The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.
Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.
This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.
If you are viewing this information softcopy, the photographs and color illustrations may not appear.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at Copy and Trademark information at www.ibm.com/legal/copytrade.html.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries.
IT Infrastructure Library is a registered trademark of the Central Computer and Telecommunications Agency which is now part of the Office of Government Commerce
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
ITIL is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office
UNIX is a registered trademark of The Open Group in the United States and other countries.
Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in the United States, other countries, or both and is used under license therefrom.
Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
Other company, product or service names may be trademarks or service marks of others.