IBM Rational ClearCase Integration with Cadence Design Framework ---------------------------------------------------------------- This README is structured as following: 1) Supported ClearCase and Cadence Design Framework Versions 2) Install instructions 3) How to Configure ClearCase Cadence Design Framework Integration 4) List of Known Issues with Release 1.0 of ClearCase Cadence Design Framework Integration Supported ClearCase and Cadence Design Framework version : ------------------------------------------------------------- The release 1.0 of the ClearCase-Cadence integration is supported with a ClearCase version that is equal to or later than 7.1.1.3. The following versions of Cadence DFII is validated for this Alpha drop of CC-Cadence integration: RHEL 4.0 EL Update 8 (32) : IC5141 ,IC613 , IC614 RHEL 4.0 EL Update 8 (64) : IC5141 , IC613 , IC614 RHEL 5.0 EL Update 8 (64) : IC613 , IC614 SLES9 ES SP3 (64) : IC5141 , IC613 SLES10 ES SP3 (64) : IC613 , IC614 SLES11 ES SP3 (64) : IC614 Sun Sparc 8(64) : IC5141 , IC613 Sun Sparc 9(64) : IC5141 , IC613 Sun Sparc 20(64) : IC5141 , IC613 Sun x86_64(Solaris) 10 (64) : IC613 Note: Above supported configurations support only Cadence and Clearcase running in 32 bit mode only. Installation instructions: -------------------------- Pre-requisite - Before installing this integration, ensure supported ClearCase Client version ( 7.1.1.3 or above ) is installed on the machine. there is a single zip file that contains the new IM Extension offering. This one zip is applicable to all supported platforms. Install Steps : a) Download zip b) Extract zip c) Start IBM Installation Manager, select the File menu, click on Preferences. d) Add location to the unzipped repository, click OK e) Click the Install button within Installation Manager, "IBM Rational ClearCase Cadence Integration" will show up as an installable product. How to Configure the Integration between ClearCase and Cadence Design Framework: -------------------------------------------------------------------------------- Before the users can start using the ClearCase Cadence Integration, the ClearCase vobs should be set up by the ClearCase administrators. The Cadence design libraries should be put under ClearCase version control so that they can be used by the designers to perform ClearCase DM operations. The ClearCase DM system is named as "ccase". Steps to be done by ClearCase Administrator: 1) Create a Base ClearCase dynamic view (e.g. cds_view) 2) Create a vob (e.g. /vobs/cds_vob) if none exists. 3) Mount the vob. (e.g. % cleartool mount /vobs/cds_vob) 4) Set the view. (e.g. % cleartool setview cds_view) Note: Please refer to ClearCase Manual for help on the above steps. Assuming that there is a library called basic which needs to be managed under ClearCase Design Management System. And the current location of library on filesystem is /cdslib/basic. 5) Make the library and its elements ClearCase elements. % clearfsimport -recurse /cdslib/basic /vobs/cds_vob/ This step will add the library "basic" and all its cells, views, property files, category files under ClearCase Design Management system. (Note : It is a one-time operation. It may be required to run "cleartool protectvob" "cleartool protect" on vob and directory, file elements to give appropriate permission to the users and groups. 6)Also, the ClearCase-Cadence integration supports atomic check-in of co-managed sets of design files. Its required that the vob should be enabled to support atomic checkin. % cleartool protectvob [-atomic_checkin | -natomic_checkin] After the ClearCase is set up and libraries are put under ClearCase source control , the libraries must be configured so that Cadence system recognizes that the libraries are under "ccase" DM system control. Steps to be done by Cadence Design Framework Administrator : 7) Edit "cds.lib" (if there is a centralized Cadence Design framework deployment used by group of users). *Comment the existing entry for library basic and create new entry so that it points to the ClearCase location. #DEFINE basic /cdslib/basic DEFINE basic /vobs/cds_vob/basic 8. Edit cdsinfo.tag inside the library (/vobs/cds_vob/basic/cdsinfo.tag )to enable DMTYPE ccase ( If cdsinfo.tag does not exists , create it) Modify: DMTYPE none to DMTYPE ccase Before Developers can start using the ClearCase Cadence integration they must set up ClearCase on the client machine. 1. Mount the vob (e.g. % cleartool mount /vobs/cds_vob ) 2. Create a Base ClearCase dynamic view (e.g. dev1_cds_view) 3. Set the ClearCase view context ( e.g. % cleartool setcview dev1_cds_view ) 4. Make sure that the cds.lib does have required entry of the above library under ClearCase Design Management System. * Comment the existing entry for library basic so that it points to the ClearCase location. #DEFINE basic /cdslib/basic DEFINE basic /vobs/cds_vob/basic Assuming that user has installed the ClearCase Cadence Integration package on the client machine using IBM InstallManager. The integration bits are installed under /opt/rational/clearcase/ccase_cds. Under/opt/rational/clearcase/ccase_cds there are configuration files ccase_cds_init.sh and ccase_cds_init.csh. To start performing ClearCase Design Management operations users must source the configuration file on the shell before launching the integration commands/virtuoso/libManager. - For bash and zsh : % source /opt/rational/clearcase/ccase_cds/ccase_cds_init.sh - For ksh : % . /opt/rational/clearcase/ccase_cds/ccase_cds_init.sh - For csh, tcsh : % source /opt/rational/clearcase/ccase_cds/ccase_cds_init.csh This is a mandatory step. And user must source the configuration script every time on a new shell. Note: User can put the source command in their .rc file so that the manual step is saved. Note: On rhel_x86 platforms , it is important to append the Cadence library path to LD_LIBRARY_PATH if user want to use the command line gdmxx commands. - Do the following : % export LD_LIBRARY_PATH=$CDS_ROOT/tools/lib:$LD_LIBRARY_PATH or % setenv LD_LIBRARY_PATH $CDS_ROOT/tools/lib:${LD_LIBRARY_PATH} depending on your shell. As part of integration a custom user interface for the ClearCase is also provided which is integrated into virtuoso and is launched from Cadence Library Manager. User' work area must be configured so that user can launch the custom user Interface. Following steps should be performed (once only) to configure the work area: % cd % mv .cdsinit .cdsinit.SAVE % setenv CCROOT /opt/rational/clearcase % ln -s $CCROOT/ccase_cds/examples/cci.cdsinit .cdsinit % mv cdsLibMgr.il cdsLibMgr.il.SAVE % ln -s $CCROOT/ccase_cds/cdsLibMgr.il cdsLibMgr.il Then invoke Virtuoso: - For IC5141: % icfb & - For IC61: % virtuoso & When Virtuoso completes its initialization, choose 'Tools -> Library Manager ...' from the pull-down menus in the Command Interpreter Window (CIW). When the Library Manager appears, choose 'Design Manager -> CciGui' in the Library Manager pull-down menus to invoke the ClearCase work area manager form. Or, you can choose 'Design Manager -> Browse hierarchy' in the Library Manager pull-down menus to invoke the ClearCase hierarchy browser form. List of known issues for 1.0 release : -------------------------------------------- a. Editing of "Access Permission" for artifacts under ClearCase source control can not be done by Library Manager GUI. User needs to use "cleartool protect -chmod " command to change the access permission for library/cell/cellview versioned through ClearCase. b. User will not be able to perform any ClearCase DM operation on a symbolic link. c. ClearCase-Cadence Integration will not work in presence of ClearQuest integration with ClearCase. d. Only checkout operation on lib/cell/cell/cellview, that is mastered remotely, has a mechanism for User to request for mastership by using the xtra flags. Please see the documentation for "-reqmaster" flag under gdmco command for further information. e. Rename operation on a cell/cellview/library may fail because of access permission issue as GDM tries to modify the related metadata file. Users must ensure that proper access permission is given to the related file.(e.g. While "Rename" the "tech.db" in the library may need to have write access. User should check out it to perform "Rename" operation. f. In ClearCase Work Area Manager, The status may not be reflecting the most up-to-date status in a multi-user scenario. User will need to run "Refresh All" to see the latest status. g. On IC5141, gdmco and gdmexport operation with multiple and invalid arguments(not as per library.cell:cellview/file convention) causes a crash. h. Using wildcard "*" with gdmci command eg. "gdmci *" from within a library will start adding library elements to ClearCase system even without -initial option. i. From command line, if "gdmci -initial" is attempted on any cell/cell-view from inside the unmanaged library directory, the operation succeeds but current working directory on shell is no longer valid. Workaround: After completing the command, Users must exit directory and then do a "cd". j. If "Rename" is performed on a cell which is under some category then the renamed new cell is not shown in the old Category in the ClearCase Work Area Manager Form. To refresh user need to restart virtuoso. k. If "Rename" operation fails on a cell due to some permission issues or not finding the referenced file/design it may leave behind the old cell.