For Developers

       You'll most likely need a client if you plan on uploading files from your Version Control/SCM.  Download the "Client Installer" listed under your platform from the Download page, http://www.smartbearsoftware.com/codecollab-download.php.  To view more about clients and to find out which is most appropriate for you, visit the Clients Section.

       Once you've downloaded the installer, open it to begin the installation wizard.  The wizard should guide you through the steps below:

       a.  Welcome Screen

       This just welcomes you to the installation process.  Click Next to proceed.

       b.  EULA

       Read the license agreement, and select "I accept the agreement" before clicking Next.

       c.  Destination Directory

       Choose the folder where you would like the Code Collaborator client to be installed.  You'll need at least 21.58 MB of disk space.

       d.  Start Menu Folder

       Select a Start Menu folder where you'd like to create the Code Collaborator shortcut.

       e.  Code Collaborator Configuration

       Here, you will enter the Code Collaborator server URL, username, and password.  Remember to specify the protocol (e.g. http:// or https://) and port number, and path.  If you do not know this, ask your Code Collaborator system administrator.

       f.  Additional Tasks

       Choose whether to run the Tray Notifier on Startup.

       g.  Finish

       Click Finish, and you're done installing the client.

       GUI - Open up the GUI Client, and click Add or Edit on the right side of the client.  Use the Configuration wizard to enter the location of your local source code into the Local Path field at the top.  For more information, please visit the GUI Client section.

       Command-Line -  For more information, visit the Command Line Client page.

       Open a web browser, and go to the Code Collaborator server URL provided by your system administrator.  Enter your login name and password.  Once you log in, you can check your Action Items to see if you have any assigned reviews.  You can also edit Preferences by clicking Prefs in the menu bar on the top right of the screen.

       1.  When making a new review, click New Review in the menu bar at the top right.

       2.  Fill in the basic information and participants in the review wizard.

       3.  Add review materials via GUI Client, Command Line Client, or web browser client.

       a.  GUI - Open up the GUI Client and click on the SCM of your choice.  Use the Add to Review buttons at the bottom to add materials to an existing or new review.

       b.  Command-Line - Visit the Command Line Client section for specifics.

       c.  Web browser - You can add supporting document not under Version Control by clicking Attach File in the Materials section.

       4.  Click Apply and Begin Review to start the review and set out notifications to reviewers.

       Once you receive a review under your Action Items, click on the review.  Under the Materials section, click a file.  The side-by-side view will open, and you will be able to make comments and defects here.

       Comment - Click on the line number you want to comment on, and type your comment.  Comments will be threaded into a conversation, and unread comments will be marked in yellow.  You can click Accept or Mark Read to clear the unread markings.

       Defects - Click on the line number you want to attribute the defect to.  Make sure the Add Defect tab is selected and write a description of your defect, filling in the fields underneath.  Once a defect is made, you can mark the defect as fixed, edit or delete the defect, and track it externally by using the links at the bottom of the comment box.  If defects are made, authors should fix the defects and upload the fixes, and reviewer should inspect the code again until the code is acceptable.

       Once all the defects are found and all the comments are read, you can finish the review by clicking Review Finished at the bottom of the review summary page in your web browser client.