The password is required for the Synergy CLI even on Unix, since Web Mode sessions are authenticated using TDS. On Unix, 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, Telelogic Synergy will use the password from that file. On Windows, you must specify the password with the start command in order to start a Synergy CLI session.

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:

("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.)

The following two new commands are introduced in the Synergy CLI.

• 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.



• 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.

The following commands are available in the Synergy CLI, but the options shown below are not yet available:

• Link-based work area options
• ccm attr -cp option
• Several ccm dcm options, including
• -init, -change, -modify -settings
• Some -show options
• ccm finduse -folder and ccm folder -finduse
• 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 project command has changed. See help for more information.

The ccm dcm command has new options for –mark_up_to_date and –recompute -releases. See help for more information.

The ccm groups command has a new –unassign option. For details, see help.

The following ccm commands are not yet available in the Synergy CLI. They are mostly administrative. Use the Classic CLI to run these commands.

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 depracated .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.

Converting Classic CLI scripts to run with the Synergy CLI

A paper on converting to the Synergy CLI will be available in the coming weeks. Check the Support site.

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 that link-based work areas are not supported when running in Web Mode.

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:

• 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.
  
  
• 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.
  
  
• 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

Compliance with IBM Standards

Telelogic Synergy release 7.0 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 Telelogic Synergy 7.0 to comply with IBM standards, the following changes were made:

• Copyrights, trademarks, license information, and notices were updated.



• The Java Runtime Environments bundled with Telelogic Synergy on all platforms were upgraded to the IBM Java JRE version 1.6.



• Telelogic Synergy 7.0 was certified as Java compatible.



• 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 Telelogic Synergy were replaced with alternative programs. These changes should be transparent to Telelogic Synergy users and administrators. For details about this change, see the Telelogic Synergy Upgrade Instructions.



• ObjectMake is no longer supported for new customers starting with Telelogic Synergy 7.0. Customers who used ObjectMake in previous releases can continue to use ObjectMake; see the Telelogic Synergy Upgrade Instructions for more information.



• The feature to migrate data into Telelogic 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.



• Merge tools MergeAhead (for Unix) and diffmrge (for Windows) that were available in previous releases are no longer available.



• The Jetty web server was upgraded to version 5.1.14, and several components not used by Telelogic Synergy were removed from the installation.



• Contributed programs in the extras directory were removed from the Telelogic Synergy installation, including the ccm_annotate program. Check IBM DeveloperWorks for free add-ons that work with Telelogic Synergy 7.0.

Upgrading to Telelogic Synergy 7.0

Telelogic Synergy 7.0 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 Telelogic Synergy Upgrade Instructions. Telelogic Synergy 7.0 provides some new utilities for use during the upgrade process.

Before you decide to upgrade, consider the following points:

• ActiveCM is not supported in Telelogic Synergy 7.0. This includes both the Windows Explorer integration and the Taskbar interface with file monitoring. These features will be available in a future release.



• Release 7.0 has changed some of its underlying utilities used for data archiving and storage. See Appendix B of the Telelogic Synergy Upgrade Instructions for more information.



• For customers who are new to Telelogic Synergy and starting out with release 7.0, ObjectMake is no longer supported. Customers who used ObjectMake in previous releases can continue to use ObjectMake with release 7.0. See the Telelogic Synergy Upgrade Instructions for details.

For more information on installation, see the Telelogic Synergy Upgrade Instructions.

Important! Before you upgrade, be sure to carefully read Appendix B of the Telelogic Synergy Upgrade Instructions.

Known problems

For details about known problems in Telelogic Synergy 7.0 and how to work around them, visit the support center on the Telelogic Synergy Support Web site.

Fixed problems

For details about problems that have been resolved in Telelogic Synergy 7.0, visit the support center on the Telelogic Synergy Support Web site.

Contact Support

Support and information for Telelogic products is currently being transitioned from the Telelogic Support site to the IBM Rational Software Support site. During this transition phase, your product support location depends on your customer history.

• If you are a heritage customer, meaning you were a Telelogic customer prior to November 1, 2008, visit the Telelogic Synergy Support site.
  
  Telelogic customers will be redirected automatically to the IBM Rational Software Support site after the product information has been migrated.

• If you are a new Rational customer, meaning you did not have Telelogic-licensed products prior to November 1, 2008, visit the IBM Rational Software Support site.

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, ibm.com, AIX, Telelogic, Telelogic Synergy, Telelogic Change, Telelogic License Server, and Telelogic Directory Server are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. These and other IBM trademarked terms are marked on their first occurrence in this information with the appropriate symbol (® or ™), indicating US registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web 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.

Citrix, the Citrix logo, Citrix Presentation Server, MetaFrame, and other Citrix product names referenced herein are trademarks of Citrix Systems, Inc. and/or one of its subsidiaries, and may be registered in the United States Patent and Trademark Office and in other countries.

Firefox is a trademark of the Mozilla Foundation.

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Internet Explorer, Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

Java, Solaris, Sun, and Sun Microsystems are registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Red Hat, Red Hat Linux, and the products listed are trademarks or registered trademarks of Red Hat, Inc. in the US and other countries.

UNIX is a registered trademark of The Open Group in the United States and other countries.

VMware and ESX Server are trademarks or registered trademarks of VMware, Inc. in the United States and/or other jurisdictions.

WinZip is a registered trademark of WinZip International LLC.

Other company, product or service names mentioned may be trademarks or service marks of others.