CQ2SVN Quick Start Guide

Welcome to Clearvision's CQ2SVN: integrating Clearquest with Subversion. This is a guide for the impatient to get started quickly using a typical environment (with Clearquest, Subversion and CQ2SVN on separate servers). For full instructions, including various configuration options, and trouble shooting, please refer to the Administration Guide which also includes instructions for Linux (mostly you can substitute /opt for c:\Program Files in the instructions below).

• Contents

  1. CQ2SVN Quick Start Guide
     1. Prerequisite: License
     2. Clearquest
     3. CQ2SVN Server
        1. Clearquest Configuration
     4. Subversion Repository Hooks
     5. CQ2SVN Clients
  2. Verify your setup
  3. What Next?

---

Prerequisite: License

1. unpack the zip file into c:\cq2svn_server on the CQ2SVN Server machine

2. Run the c:\Clearvision\cq2svn\tools\get_license_info tool on the CQ2SVN server machine

3. Send the output with the requested details to support@clearvision-cm.com to apply for a license

---

Clearquest

This example assumes that you are using the SAMPLE database with the 'Defect Tracking' schema.

1. Use the Clearquest Designer to edit your schema e.g. Defect Tracking

2. Add a MULTILINE_STRING field called cq2svn_integration in the (eg Defect) record.

3. edit the Defect_Base Form and add a tab. The tab can be any name, however we recommend the name 'Subversion'.

   • on this tab add a label 'Change Details' and add a Text Box for the cq2svn_integration field.

   • edit the 'Extended' tab of the Text Box Property Sheet and tick: 'Multi Line'; 'Auto Vert Scroll'; 'Vert Scroll Bar'
4. save and upgrade your databases as normal.

CQ2SVN Server

1. On the CQ2SVN Server, unpack the zip file into c:\cq2svn_server ( Please DO NOT use any path name with a space, such as c:\Program Files, as there is an issue with any path that includes spaces for the perl scripts)

2. Configure the cq2svn_server.cfg file in the server folder

3. On Linux, make the cq2svn_server executable chmod +x /opt/Clearvision/cq2svn/server/cq2svn_server

4. Optionally create a shortcut on the desktop to cq2svn_server.exe (use the -f flag to choose the config file)

5. make sure that this machine has a copy of the perl clearquest API installed (by installing Clearquest)

Clearquest Configuration

1. edit the perl scripts (get_cq_list.pl and update_cq.pl) which are in the cq2svn\server folder to use your Clearquest database schema and user settings

Subversion Repository Hooks

1. unpack the zip file into c:\Program Files on the Subversion repository machine

2. Copy the contents of c:\Program Files\Clearvision\CQ2SVN\subversion hooks folder to the hooks directory of your subversion repository

3. Configure the cq2svn_hook.cfg file in the hooks folder of your repository

4. On Linux, make the cq2svn hooks and the subversion hooks executable, eg chmod +x $MY_SVN_REPO/hooks/*

5. optionally configure the batch/shell files for any local (non CQ2SVN) hooks that you might be using (if you have no local customisation, then no editing should be required)

CQ2SVN Clients

1. unpack the zip file into c:\Program Files on a CQ2SVN user's machine

2. Configure the cq2svn_client.cfg file in the client folder (c:\Program Files\Clearvision\CQ2SVN\client) (in particular, note the svn_uid field)

3. On Linux, make the cq2svn_client executable chmod +x /opt/Clearvision/cq2svn/client/cq2svn_client

4. Optionally, create a shortcut on the desktop to start cq2svn_client.exe(use the -f flag to select a config file)

5. repeat the above on all user machines

---

Verify your setup

Now you are setup, ready to use CQ2SVN. To test your configuration:

1. start the CQ2SVN Server
2. start the CQ2SVN client on your client machine
3. make sure that you have some records in the 'assigned' state in Clearquest.
4. edit a file in a Subversion working copy on your client machine
5. commit the file (making sure that you use the right username)
6. you should see a window pop up on your client with a list of CQ records for you to select: select one and you're done!

To check that CQ2SVN has worked:

• browse the CQ record and review the changelist in the Subversion tab

• check the revprops in subversion with svn proplist -rHEAD --verbose --revprop .

What Next?

The Administration Guide should be your next step. There you will find much more detail on setup and configuration options and a short Troubleshooting guide.

In particular, please note that CQ2SVN is shipped with configuration options set to 'enforcing mode'. There are a number of options in the hook and server configuration files that allow a more permissive setup which may be more applicable to your organization.

If, after having read through all the documentation, you are having problems or just want to give us some feedback, please don't hesitate to email us at support@clearvision-cm.com