Send Plastic SCM differences to CodeCollaborator

CodeCollaborator is a software tool that allows you to review, annotate, and comment on source code, images, schematics, and shared documents.

If you are working with both Plastic SCM and CodeCollaborator, then you can send Plastic SCM differences to CodeCollaborator as code reviews through the Plastic CodeCollaborator CLI client called codecollaboratorclient.exe.

By using this client, you can send to CodeCollaborator diffs from branches, changesets, or changeset intervals.

Note: This CodeCollaborator client is only available for Windows.

How to configure

You need a configuration file called ccollabclient.conf to use the codecollaboratorclient.exe client. Let's see how to configure it:

Open a command line and go to the Plastic SCM client directory where the codecollaboratorclient.exe client is located.

Then run the following command:

C:\Program Files\PlasticSCM5\client>codecollaboratorclient.exe configure

The command prompts you to enter a value for each of the following settings:
- server - the target CodeCollaborator URI
- login - the user name to use to authenticate into CodeCollaborator
- password - the password to use to authenticate into CodeCollaborator. The password value will be encrypted to prevent it from being stored in plain text.
This is how the file might look like:
```
server=https://mycodecollab.server.com
login=user
password=mypwd
```
The ccollabclient.conf file needs to be placed in your Plastic client configuration directory (typically C:\Users\your-user\AppData\Local\plastic4) or alternatively in the same directory as the codecollaboratorclient.exe executable file.

How to use codecollaboratorclient.exe

This is the command syntax of the codecollaboratorclient.exe client:

codecollaboratorclient <brSpec|csetSpec|csetRange> [--title <reviewTitle>] [--id <reviewID>]

This way you can:

Send to CodeCollaborator diffs from Plastic SCM branches.
The following example creates a review of the branch /main/task1346 in the repository myrep@myserver:8084:
```
codecollaboratorclient br:/main/task1346@myserver:8084
```
Send to CodeCollaborator diffs from Plastic SCM changesets.
The following example creates a review of the changeset 8947 with the title My review
```
codecollaboratorclient cs:8947 --title "My Review"
```
Send to CodeCollaborator diffs between two Plastic SCM changesets.
The following example adds the difference between changesets (536, 539] to the review with id 6473:
```
codecollaboratorclient cs:536-cs:539 --id 6473
```