XML accepted by 'ccollab admin batch' Group of commands and global options List of commands to run with the same connection. Commands are run in order found in XML. May also contain at most one global-options element with options applied to all commands Options applied to all commands Updates the changelist ID so Collaborator reflects the renumbered Perforce changelist ID Remove a member from a Group Add a member to a Group Sync to supplied XML Delete a Group Edit a Group Create a new Group Creates a new Review for a changelist if no Review already exists Automatically update Perforce changelist with information about the review of that changelist Ensure the reviewed diffs are the same as the diffs in the change Changelist cannot be submitted until review completed & file list/content is unchanged Changelist cannot be submitted until review of this changelist has been completed Changelist cannot be submitted until review of this changelist exists Delete a Subscription to a file pattern Edit a Subscription to a file pattern Create a Subscription to a file Pattern Delete a Subscription to a Review Author Edit a Subscription to a Review Author Create a Subscription to a Review Author Edit an existing User Create a new User Mark a conversation on a Review as 'accepted' Mark a conversation on a Review as 'read' Delete a Defect Mark a Defect as 'Open' Mark a Defect as not 'Tracked Externally' (Open) Mark a Defect as 'Tracked Externally' Mark a Defect as 'Fixed' Edit a Defect Create a Defect Redact a Comment on a Review Create a Comment on a Review Remove a Review Pool assignment from a Review Take (assign to self) a Review Pool assignment in a Review Create a Review Pool participant Role for a Review Pool Group in a Review Poke a participant in a Review Remove a participant from a Review Assign a User to a participant Role in a Review Set Participants for a Review Copy Participants from one Review to another Move a review from Planning to Annotating Finish current phase of a Review Wait for a response in a Review Reopen a completed Review Reject an in-progress Review Cancel an in-progress Review Delete an existing Review Edit an existing Review Create a new Review Edit an existing custom field definition and overwrites all existing data Get the contents of a URL on the server Process multiple commands with one connection Extract the state of a review in XML form Synchronizes the Perforce user list with the Collaborator server Attaches urls to a review Adds all numbered local changes that fix a job to the review Commit changes in the review Launch a browser to the Collaborator Server homepage Attaches pending differences from an AccuRev stream Attaches file parts for a Track associated with the given defect and release to a review List current action items Attaches file versions in a ClearCase activity to a review Attaches any 2 given versions to a review Uploads diffs generated from 'ss diff' command Uploads diffs generated from the stcmd diff command Uploads diffs generated from p4 diff2 command Uploads diffs generated by hg diff command Uploads diffs generated by git diff command Uploads diffs generated from cvs diff command Uploads diffs generated from accurev diff command Uploads diffs generated from the svn diff command Attaches file differences to a Review Attaches an atomic changelist to a review Attaches local files to a review without diffs Attaches locally-modified files to a review Save a global option setting Clears the stored password and/or login ticket id, and invalidates the user's login ticket on the server Verify and/or change connection to the server Validates server connection and SCM configuration Display help on using the Command Line Client Options applied to all commands Browser to launch (e.g. 'firefox', 'ie', or 'default') Run in debug mode, create a log file at the following location: ~/.smartbear/log/ccollab.log on Unix platforms and USERPROFILE/.smartbear/log/ccollab.log on Windows platforms. External editor to use for editing file list Prompt user for input to signal editing of file list complete Force browser to open new window (only works for some platforms and browsers) Do not pop up a web browser when the command completes Don't interact with user Password to use when connecting to the application server Don't display progress messages Manually sets the SCM system type, e.g. "perforce" or "none" for no SCM System. Clearing this option causes the SCM system to be auto-detected Proxy server URL to use to connect to the application server Proxy server port number to use to connect to the application server URL to use when connecting to the application server Username to use when connecting to the application server AccuRev depot name Full path to the `accurev` command-line client Which algorithm to use when calculating the predecessor, either predecessor, previous-occupant, or basis-version CCRC server URL (for ClearCase Remote Client integration only) CCRC username (for ClearCase Remote Client integration only) CCRC password (for ClearCase Remote Client integration only) Full path to the `cleartool` command-line client Whether to update ClearCase snapshot views prior to uploading files for review Full path to the `cvs` command-line client Connection to the CVS repository Full path to the 'git' command line client Should changes be uploaded from the working tree instead of from the index (like `git commit -a`) Full path to the 'mercurial (hg)' command line client MKS Source server name MKS Source server port MKS Source user name MKS Source user password Whether to expand keywords in MKS source files Full path to the P4 executable How to connect to the Perforce server Perforce user name Perforce password or ticket Mapping of Perforce server data to the local machine Ignore integration history when calculating predecessor Perforce character set used for translation of Unicode files If true, don't allow uploads if the default changelist contains files Should a character set be specified for communication with Perforce Full path to the `ccm` command-line executable User Name to use when starting a Rational Synergy session Password to use when starting a Rational Synergy session Host the Rational Synergy Engine will run on Path of the Rational Synergy database to connect with Path of the local Rational Synergy database, typically c:/temp/ccm or /tmp/ccm Start Rational Synergy sessions as a Remote Client Server URL for Web-Mode Rational Synergy servers Full path to the StarTeam `stcmd` command-line client Full path to the `svn` command-line executable Full path to the `svnlook` command-line executable (used by Subversion triggers) Subversion repository URL Subversion user name Subversion password Use this if you have a non-empty and unsaved password for your SSL Client Certificate Treat unversioned files as if they had been added to Subversion Recurse in the 'svn:externals' directories as if they were part of the same repository Full path to the repository (used by Subversion Triggers) Full path to the Surround SCM `sscm` command-line client Surround SCM server address (server:port) Surround SCM single sign-on Surround SCM user name Surround SCM password Team Foundation collection name (for TFS clients 2010 and later only) Team Foundation server name (for TFS clients 2005 and 2008 only) Full path to the Team Foundation `tf` command-line client Team Foundation alternate user name (atypical) Team Foundation alternate user name password Vault profile name Vault server url (n/a with profile) Vault repository (n/a with profile) Vault user (n/a with profile) Vault password (n/a with profile) Vault proxy domain Vault proxy server Vault proxy port Vault proxy user Vault proxy password SourceSafe password Full path to the SourceSafe `ss` command-line client SourceSafe user name Updates the changelist ID using the provided configuration to match an existing Version Control configuration on the Collaborator server to update all references to the old changelist ID. For example: ccollab --scm p4 --p4port p4server:1666 admin changelist update-id 123 147 Remove a member from to a group. You must be an Administrator to execute this command. Examples: ccollab admin group member remove qa --user joe@example.com ccollab admin group member remove corporate --group qa Login of the group admin user to specify Specify All Users Guid of the group to specify Login of the member user to specify GUID (Globally Unique IDentifier) of the group Add a member to a group. You must be an Administrator to execute this command. Examples: ccollab admin group member add qa --user joe@example.com ccollab admin group member add corporate --group qa Login of the group admin user to specify Specify All Users Guid of the group to specify Login of the member user to specify GUID (Globally Unique IDentifier) of the group Synchronize the server's group configuration to match that of the supplied XML. However, no changes will be made to manually-created groups. See the user's manual for documentation on the XML format. You must be an Administrator to execute this command. Examples: ccollab admin group sync /tmp/input --delete-groups cat /tmp/input | ccollab admin group sync - --create-users Example XML input: <groups> <group guid="groupa" title="Group A" description="The A Group concerned with initials"> <member-user login="alice" /> <member-user login="adama" /> </group> <group guid="groupb" title="Group B" description="The B Group that includes those in Group A"> <member-user login="bob" /> <member-user login="betty" /> <member-group guid="groupa" /> </group> <group guid="groupc" title="Group C" description="The C Group that is everyone." includes-all-users="true" allow-associate-with-reviews="no" > <member-group guid="groupb" /> </group> </groups> Whether to create users in the syncdata that don't already exist; if not specified, nonexistent users will be ignored Whether to delete groups not in the syncdata; if not specified, groups are disabled instead Filename of the input XML syncdata, or - for stdin Delete a group. You must be an Administrator to execute this command. Groups that are associated with reviews can not be deleted - try disabling them instead. GUID (Globally Unique IDentifier) of the group Edit a group. You must be an Administrator to execute this command. Examples: ccollab admin group edit qa --description "Project Foo Quality Assurance" ccollab admin group edit qa --title "Quality Assurance" Allow users to associate this group with reviews (y/n/yes/no/true/false/on/off) Enablement status (y/n/yes/no/true/false/on/off) Enable this group as a Review Pool selection (y/n/yes/no/true/false/on/off) GUID (Globally Unique IDentifier) of the group Manually create a new group. You must be an Administrator to execute this command. Creating a new group with this command is equivalent to manually creating the group using the web UI. The new group will not be modified by subsequent 'ccollab admin group sync' commands. Examples: ccollab admin group create qa ccollab admin group create qa --title "Quality Assurance" Allow users to associate this group with reviews (y/n/yes/no/true/false/on/off) Enablement status (y/n/yes/no/true/false/on/off) Enable this group as a Review Pool selection (y/n/yes/no/true/false/on/off) GUID (Globally Unique IDentifier) of the group The create-review trigger automatically creates a review in Collaborator after the change is committed to the Subversion server. It's smart enough to not create reviews if they've already been created for this code. For this hook to work smoothly you will need your Subversion usernames and Collaborator logins to match. Here "match" means "differs at most in capitalization." This ensures that when a developer checks in code the review is created under his Collaborator account. If you don't do this the hook will still work, but reviews will be created under the system administrator's account. Someone will have to log into the system with that account and assign the review to someone else. You may optionally specify a regular expression that identifies a Collaborator review ID inside a Subversion commit message. If you supply the regular expression, the create-review hook will check for this text in commit messages and automatically not create a new review if a non-canceled review with that ID already exists. This allows some users to do pre-commit review and others post-commit, and either way you know all code has been reviewed or at least that a review of all code exists in the system. For Subversion, to install this trigger you will need to create a post-commit hook. If you already have a post-commit hook, you can add our tool wherever it is appropriate; otherwise you will need to create an executable hook as described in the Subversion documentation (typically a batch file under Windows or a shell script under Linux/Mac). Example Windows batch file: "C:\Program Files\Collaborator Client\ccollab.exe" --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm subversion --svn-repo-url svn://url/to/repo --svn-exe "C:\Program Files\Subversion\bin\svn.exe" admin trigger create-review --review-id-regex "review:\s+(\d+)" %2 || exit 1 Example Linux/OSX shell script: /collab/install/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm subversion --svn-repo-url svn://url/to/repo --svn-exe /usr/bin/svn admin trigger create-review --review-id-regex "review:\s+(\d+)" $2 || exit 1 Note our use of "exit 1" to ensure that the script terminates with a non-zero exit code if our trigger application fails. If a review ID regex matches, add this changelist to the review Regular Expression that identifies Review ID in commit comment SCM-specific ID of an atomic set of changes If you are reviewing changelists prior to submit, you might want some text in your changelist description saying the changelist was reviewed, which review ID, participants, and so on. Running this command on the 'submit' trigger causes a description of the review to be added or updated in the changelist text when a pending changelist is submitted. If you also run this trigger on 'form-in change' then users can see the data update whenever they edit the changelist. To install this trigger edit your Perforce Triggers list (see Perforce manual for details) and add a line like the following (except supply your installation directory for the ccollab application, replace <values> as appropriate, and put everything on one line even though the following text is word-wrapping): ccollabupdatechangelist change-submit //depot/... "/usr/bin/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm perforce --p4port <p4port> --p4user <p4user> --p4passwd <p4passwd> --p4client <p4client> admin trigger update-changelist --description-prefix 'Review: ' --description-template 'ID ${review.id} by ${review.participants.rolename}' %changelist% Optionally you can also add on the next line: ccollabupdatechangelist form-in change "/usr/bin/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm perforce --p4port <p4port> --p4user <p4user> --p4passwd <p4passwd> admin trigger update-changelist --description-prefix 'Review: ' --description-template 'ID ${review.id} by ${review.participants.rolename}' %formfile% Note - This example works under Windows, but under Unix the Perforce trigger system parses this line incorrectly, splitting up arguments by whitespace even though they are quoted using single-quotes. The solution is to use a separate shell script file to call our code and to call that script from the Perforce trigger. The --description-prefix prefix option is the prefix text that means: This is a line that should be updated with review information. The trigger is allowed to replace everything after that prefix with review information. If a changelist doesn't have a line with this prefix, a new line is appended to the end of the changelist description; otherwise the information is updated in-place. The --description-template option is a template that will be inserted after the prefix. The template gives you a chance to decide which information about the review you want to include, in what order, and with any type of textual separators. The template uses the ${...} variable substitution subsystem to let you insert dynamic data. In the example given above, the review ID and a list of participants is inserted between some English text. If there is a review in the system that matches this changelist, the text is always updated either in-place or appended as described. On the other hand, if there is not already a review, the description is updated only if the prefix is already present; if there's no current review and no prefix than nothing is appended to the description. Prefix text for review line in changelist description Template text for review line in changelist description %changelist% for 'commit' trigger, or %formfile% for 'form-in change' trigger Ensure that the difference between the current content and proposed content of each file is the same as the difference between the base and proposed content in the review by comparing the line-wise changes.com.smartbear.scm.impl.perforce.PerforceSystem@1bc74f37 Allow integration changes to proceed without review Disallow keyword expansion Regular Expression that identifies Review ID in commit comment Changelist ID This trigger ensures that a Review has been completed and the file list and file content is unchanged before changes can be submitted to version control. If a Review has not been completed, or the Review contains different files or file contents, the submit will fail and the user will get an error message explaining that the changes need to be reviewed before submit. For Perforce, to install this trigger edit your Perforce Triggers list (see Perforce manual for details) and add a line like the following (except supply your installation directory for the ccollab application, replace <values> as appropriate, and put everything on one line even though the following text is word-wrapping): ccollab content //depot/... "/usr/bin/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm perforce --p4port <p4port> --p4client %client% --p4user <p4user> --p4passwd <p4passwd> admin trigger ensure-content-reviewed %changelist%" On Unix systems the Perforce trigger system incorrectly splits up arguments by whitespace ignoring single quotes and other standard ways of indicating that data with spaces is actually a single argument. The solution is to use a separate bash script to call our trigger application. For Perforce, you must supply credentials for a Perforce user that has at least read-only access. For Perforce, changelists that result from creating a new branch are ignored. Creating a new branch does not involve a code change, so it does not require review. For Perforce, integrating changes from one branch into another branch does make code changes and can introduce bugs, so by default this type of change is handled by the trigger. However, because integration changes frequently involve a very large number of files and because often it is necessary to integrate changes to many branches, this would require cumbersome reviews to be performed many times. For this reason, the '--ignore-integrate' option can be used to ignore changelists consisting of only integration changes. In this case, enforcement of review happens externally to the system: for example, a review could be performed on one branch, but other branches could be just directly integrated. Allow integration changes to proceed without review Disallow keyword expansion Regular Expression that identifies Review ID in commit comment Changelist ID This trigger ensures that a Review has been completed before changes can be committed to version control. If a Review has not been completed, the commit will fail and the user will get an error message explaining that the changes need to be reviewed before commit. For Perforce, to install this trigger edit your Perforce Triggers list (see Perforce manual for details) and add a line like the following (except supply your installation directory for the ccollab application, replace <values> as appropriate, and put everything on one line even though the following text is word-wrapping): ccollab submit //depot/... "/usr/bin/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm perforce --p4port <p4port> --p4client %client% --p4user <p4user> --p4passwd <p4passwd> admin trigger ensure-reviewed %changelist%" On Unix systems the Perforce trigger system incorrectly splits up arguments by whitespace ignoring single quotes and other standard ways of indicating that data with spaces is actually a single argument. The solution is to use a separate bash script to call our trigger application. For Subversion, to install this trigger you will need to create a pre-commit hook. If you already have a pre-commit hook, you can add our tool wherever it is appropriate; otherwise you will need to create an executable hook as described in the Subversion documentation (typically a batch file under Windows or a shell script under Linux/Mac). Example Windows batch file: "C:\Program Files\Collaborator Client\ccollab.exe" --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm subversion --svn-repo-path %1 --svn-look-exe "C:\Program Files\Subversion\bin\svnlook.exe" admin trigger ensure-reviewed --review-id-regex "review:\s+(\d+)" %2 || exit 1 Example Linux/OSX shell script: /collab/install/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm subversion --svn-repo-path $1 --svn-look-exe /usr/bin/svnlook admin trigger ensure-reviewed --review-id-regex "review:\s+(\d+)" $2 || exit 1 Note our use of "exit 1" to ensure that the script terminates with a non-zero exit code if our trigger application fails. For Git, to install this trigger you will typically create an update hook. If you already have an update hook, you can add our tool wherever it is appropriate; otherwise you will need to create an executable hook as described in the Git documentation. The update hook should iterate over the commits being pushed and call this trigger for each one of them, and then exit with a non-zero exit code if any of the trigger invocations failed. Example shell script: #!/bin/sh refname="$1" oldrev="$2" newrev="$3" for commit in `git rev-list $oldrev..$newrev -- ''` do /collab/install/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm git admin trigger ensure-reviewed $commit exitcode=$(($exitcode + $?)) done exit $exitcode Note our use of "exit" to ensure that the hook script terminates with a non-zero exit code if our trigger rejects one of the commits. For Perforce, you must supply credentials for a Perforce user that has at least read-only access. For Perforce, changelists that result from creating a new branch are ignored. Creating a new branch does not involve a code change, so it does not require review. For Perforce, integrating changes from one branch into another branch does make code changes and can introduce bugs, so by default this type of change is handled by the trigger. However, because integration changes frequently involve a very large number of files and because often it is necessary to integrate changes to many branches, this would require cumbersome reviews to be performed many times. For this reason, the '--ignore-integrate' option can be used to ignore changelists consisting of only integration changes. In this case, enforcement of review happens externally to the system: for example, a review could be performed on one branch, but other branches could be just directly integrated. For Subversion, you must specify the --svn-repo-path and --svn-look-exe global options. For Subversion, you must require developers to put the review ID somewhere in the Subversion commit message. The format of this text is completely up to you; you must supply a Java-style regular expression that identifies this text and specifically calls out the review ID inside that text using the --review-id-regex command option. Allow integration changes to proceed without review Regular Expression that identifies Review ID in commit comment Changelist ID This trigger ensures that a Review has been started before changes can be committed to version control. If a Review has not been started, the commit will fail and the user will get an error message explaining that the changes need to be reviewed before commit. For Perforce, to install this trigger edit your Perforce Triggers list (see Perforce manual for details) and add a line like the following (except supply your installation directory for the ccollab application, replace <values> as appropriate, and put everything on one line even though the following text is word-wrapping): ccollab submit //depot/... "/usr/bin/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm perforce --p4port <p4port> --p4client %client% --p4user <p4user> --p4passwd <p4passwd> admin trigger ensure-review-started %changelist%" On Unix systems the Perforce trigger system incorrectly splits up arguments by whitespace ignoring single quotes and other standard ways of indicating that data with spaces is actually a single argument. The solution is to use a separate bash script to call our trigger application. For Subversion, to install this trigger you will need to create a pre-commit hook. If you already have a pre-commit hook, you can add our tool wherever it is appropriate; otherwise you will need to create an executable hook as described in the Subversion documentation (typically a batch file under Windows or a shell script under Linux/Mac). Example Windows batch file: "C:\Program Files\Collaborator Client\ccollab.exe" --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm subversion --svn-repo-path %1 --svn-look-exe "C:\Program Files\Subversion\bin\svnlook.exe" admin trigger ensure-review-started --review-id-regex "review:\s+(\d+)" %2 || exit 1 Example Linux/OSX shell script: /collab/install/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm subversion --svn-repo-path $1 --svn-look-exe /usr/bin/svnlook admin trigger ensure-review-started --review-id-regex "review:\s+(\d+)" $2 || exit 1 Note our use of "exit 1" to ensure that the script terminates with a non-zero exit code if our trigger application fails. For Git, to install this trigger you will typically create an update hook. If you already have an update hook, you can add our tool wherever it is appropriate; otherwise you will need to create an executable hook as described in the Git documentation. The update hook should iterate over the commits being pushed and call this trigger for each one of them, and then exit with a non-zero exit code if any of the trigger invocations failed. Example shell script: #!/bin/sh refname="$1" oldrev="$2" newrev="$3" for commit in `git rev-list $oldrev..$newrev -- ''` do /collab/install/ccollab --url <collabUrl> --user <collabUser> --password <collabPasswd> --scm git admin trigger ensure-review-started $commit exitcode=$(($exitcode + $?)) done exit $exitcode Note our use of "exit" to ensure that the hook script terminates with a non-zero exit code if our trigger rejects one of the commits. For Perforce, you must supply credentials for a Perforce user that has at least read-only access. For Perforce, changelists that result from creating a new branch are ignored. Creating a new branch does not involve a code change, so it does not require review. For Perforce, integrating changes from one branch into another branch does make code changes and can introduce bugs, so by default this type of change is handled by the trigger. However, because integration changes frequently involve a very large number of files and because often it is necessary to integrate changes to many branches, this would require cumbersome reviews to be performed many times. For this reason, the '--ignore-integrate' option can be used to ignore changelists consisting of only integration changes. In this case, enforcement of review happens externally to the system: for example, a review could be performed on one branch, but other branches could be just directly integrated. For Subversion, you must specify the --svn-repo-path and --svn-look-exe global options. For Subversion, you must require developers to put the review ID somewhere in the Subversion commit message. The format of this text is completely up to you; you must supply a Java-style regular expression that identifies this text and specifically calls out the review ID inside that text using the --review-id-regex command option. Allow integration changes to proceed without review Regular Expression that identifies Review ID in commit comment Changelist ID Login or username of the user File pattern to match New file pattern to match Role in Review Login or username of the user File pattern to match Login or username of the user File pattern to match Role in Review Login or username of the user Login or username of the Author Login or username of the user Login or username of the Author Role in Review Login or username of the user Login or username of the Author Role in Review Edit the information of an existing user. You must be an Administrator to disable users or edit the information of another user. Administrator status (y/n/yes/no/true/false/on/off) Email address Enablement status (y/n/yes/no/true/false/on/off) Full name (enclose value in quotes if full name includes spaces) New login / username for the user Password Phone number Login or username of the user Create a new user. You must be an Administrator to execute this command. Examples: ccollab admin user create alice ccollab admin user create bob --phone-number 867-5309 Administrator status (y/n/yes/no/true/false/on/off) Email address Enablement status (y/n/yes/no/true/false/on/off) Full name (enclose value in quotes if full name includes spaces) New login / username for the user Password Phone number Login or username of the user You can specify various options to identify the conversation that should be marked accepted. Overall: (default - no extra options necessary) Label: --label <label> Line: --line-number <number> Coordinate: --page <number> --x <number> --y <number> Cell: --cell <cell reference> To specify an existing Conversation in a file, it's best to specify --conversation-id <id> to disambiguate situations where there's more than one Conversation at a particular location. Only one of 'file' or 'version' may be specified. Example: ccollab admin review conversation accept 123 ccollab admin review conversation accept 567 --version 789 --line-number 36 ccollab admin review conversation accept 567 --file "bizbaz.java" Cell reference in A1 format ID of the first Comment in an existing Conversation Label Line number in file Page number Path of file in Review Version ID of file in Review X coordinate Y coordinate Must be either an integer review-id, 'ask', or 'last' You can specify various options to identify the conversation that should be marked read. Overall: (default - no extra options necessary) Label: --label <label> Line: --line-number <number> Coordinate: --page <number> --x <number> --y <number> Cell: --cell <cell reference> To specify an existing Conversation in a file, it's best to specify --conversation-id <id> to disambiguate situations where there's more than one Conversation at a particular location. Only one of 'file' or 'version' may be specified. Example: ccollab admin review conversation mark-read 123 ccollab admin review conversation mark-read 567 --version 789 --line-number 36 ccollab admin review conversation mark-read 567 --file "bizbaz.java" Cell reference in A1 format ID of the first Comment in an existing Conversation Label Line number in file Page number Path of file in Review Version ID of file in Review X coordinate Y coordinate Must be either an integer review-id, 'ask', or 'last' Must be either an integer defect-id or 'last' Must be either an integer defect-id or 'last' Must be either an integer defect-id or 'last' Must be either an integer defect-id or 'last' External name to refer to externally tracked Defect Must be either an integer defect-id or 'last' Setting for custom fields, in the form field-name=field-value (e.g. "Severity=Major") Must be either an integer defect-id or 'last' You can specify various options to control the location where the defect is created. Overall: (default - no extra options necessary) Label: --label <label> Line: --line-number <number> Coordinate: --page <number> --x <number> --y <number> Cell: --cell <cell reference> To specify an existing Conversation in a file, it's best to specify --conversation-id <id> to disambiguate situations where there's more than one Conversation at a particular location. Only one of 'file' or 'version' may be specified. Example: ccollab admin review defect create 123 "overall review defect" ccollab admin review defect create 567 --file "bizbaz.java" "overall file defect" ccollab admin review defect create 567 --version 789 --line-number 36 "defect on a line" Cell reference in A1 format ID of the first Comment in an existing Conversation Setting for custom fields, in the form field-name=field-value (e.g. "Severity=Major") Label Line number in file Page number Path of file in Review Version ID of file in Review X coordinate Y coordinate Must be either an integer review-id, 'ask', or 'last' Mark a Comment 'Redacted'. Note the ID of a Comment can be obtained from 'ccollab admin review-xml'. Comment ID to redact You can specify various options to control the location where the comment is created. Annotation: --annotation Overall: (default - no extra options necessary) Label: --label <label> Line: --line-number <number> Coordinate: --page <number> --x <number> --y <number> Cell: --cell <cell reference> To specify an existing Conversation in a file, it's best to specify --conversation-id <id> to disambiguate situations where there's more than one Conversation at a particular location. Only one of 'file' or 'version' may be specified. Examples: ccollab admin review comment create 123 "overall review comment" ccollab admin review comment create 345 --file "foobar.c" --annotation "ignore this file" ccollab admin review comment create 567 --file "picture.png" --page 1 --x 35 --y 56 "at this point" ccollab admin review comment create 789 --file "results.xls" --cell "'Sheet 1'!G17" "This data seems unlikely" ccollab admin review comment create 1000 --version 789 --line-number 36 "I like this line" File annotation (overwrites any existing annotation) Cell reference in A1 format ID of the first Comment in an existing Conversation Label Line number in file Page number Path of file in Review Version ID of file in Review X coordinate Y coordinate Must be either an integer review-id, 'ask', or 'last' Example: ccollab admin review pool remove Reviewer=poolGroupGuid Must be either an integer review-id, 'ask', or 'last' Review Pool assignment (system-role-name=group-guid) Example: ccollab admin review pool take Reviewer=poolGroupGuid Must be either an integer review-id, 'ask', or 'last' Review Pool assignment (system-role-name=group-guid) Example: ccollab admin review pool create Reviewer=poolGroupGuid Must be either an integer review-id, 'ask', or 'last' Review Pool assignment (system-role-name=group-guid) Must be either an integer review-id, 'ask', or 'last' Username of participant Must be either an integer review-id, 'ask', or 'last' Username of participant Must be either an integer review-id, 'ask', or 'last' Username of participant Role of participant in Review Participants are added or removed as necessary to make the Review match the options of this command. Example: ccollab admin review set-participants 12345 --participant author=roy --participant reviewer=brandon --pool-participant reviewer=groupGuid Participants, in the form 'role=user' Pool participants, in the form 'role=groupGuid' Must be either an integer review-id, 'ask', or 'last' The Participants specified in 'from-review' are added to 'to-review' in the same Roles. Existing Participants in the 'to' Review are not removed. For example, to create a new Review and initialize it with Participants used in the last Review, run 'ccollab admin review copy-participants last new' Review to copy Participants from. Must be either an integer review-id, 'ask', or 'last' Review to copy Participants to. Must be either an integer review-id, 'new', 'ask', or 'last' Must be either an integer review-id, 'ask', or 'last' Finish the current phase of the Review for the logged in user. For example: If the Review is in the 'Planning' phase and the logged in user is the Creator of the Review, this command will move the Review to the 'Inspection' phase. For a Review in the 'Inspection' phase where the logged in user is a Reviewer in that Review, if the Review has outstanding defects this command will cause the Review to move in to the 'Rework' phase. If the Review has no defects then the Review will be 'Completed' (unless there are other Reviewers who have not finished yet). Activity to finish until ('Any', 'Author', 'File', or 'Poke') Must be either an integer review-id, 'ask', or 'last' Indicate that you are waiting until the specified action. You will be notified when the action occurs. Defaults to any type of activity. Activity to wait until ('Any', 'Author', 'File', or 'Poke') Must be either an integer review-id, 'ask', or 'last' Must be either an integer review-id, 'ask', or 'last' Reason for rejecting. Required if Reject Review Reasons are defined by an administrator Must be either an integer review-id, 'ask', or 'last' Must be either an integer review-id, 'ask', or 'last' Reviews can only be deleted in the planning phase. Must be either an integer review-id, 'ask', or 'last' Note when setting custom fields you have to specify the review first. For example: ccollab admin review edit "last" --custom-field "Overview=this is the overview" Setting for custom fields, in the form field-name=field-value (e.g. "Overview=this is the overview") Deadline in the format 'yyyy-MM-dd' Default to showing changelists rolled up('single') or individually('distinct') Guid of the group to specify Setting for participant custom fields, in the form field-name=field-value Restrict Access (anyone/group/participants/group-and-participants/group-or-participants) Must be either an integer review-id, 'ask', or 'last' The login of the creator of the Review, defaults to logged-in user if not specified Setting for custom fields, in the form field-name=field-value (e.g. "Overview=this is the overview") Deadline in the format 'yyyy-MM-dd' Default to showing changelists rolled up('single') or individually('distinct') Guid of the group to specify Setting for participant custom fields, in the form field-name=field-value Restrict Access (anyone/group/participants/group-and-participants/group-or-participants) Custom field ID's are displayed in the administration screens in the Collaborator web interface. Warning: The 'edit' overwrites all existing data. Drop-down items for a 'Drop-down List' Type custom field ID of the custom field to edit Gets the contents of a URL on the Collaborator server, taking care of authentication. Note this command will effectively cause a license to be consumed if the URL requires a licensed user. URL relative to the server Running multiple commands in batch form ensures that the 'last' review and defect variables stay consistent, even if there are multiple concurrent invocations of the client. It's also easier to encode non-ascii characters in XML. Global Options specified in the XML override the current Global Options. Command options should be given without the leading double-dash. Both option and argument values are given as text values inside elements. For option and argument elements that can accept multiple values, specify a new element for each value. Example XML file: <batch-commands> <global-options> <no-browser/> <non-interactive/> </global-options> <addchanges> <upload-comment>These are my latest changes!</upload-comment> <review>new</review> <file-spec>.</file-spec> </addchanges> <addfiles> <review>last</review> <file-path>checklist.txt</file-path> <file-path>foo/bar.java</file-path> <file-path>biz/buzz.java</file-path> </addfiles> <browse> <review>last</review> </browse> </batch-commands> Run 'ccollab help batch-xml' for the full XML Schema accepted by this command. File containing commands in XML format, or "-" to read from STDIN You may specify an XPath expression to evaluate against the resulting XML. Examples: Get ID of 'last' review: ccollab admin review-xml last --xpath string(//reviews/review/@reviewId) Get title of review 1354: ccollab admin review-xml 1354 --xpath //reviews/review/general/title/text() Get number of defects in review 2478 with 'Major' severity: ccollab admin review-xml 2478 --xpath count(//reviews/review/defects/defect[custom-defect-fields/severity='Major']) You may alternately specify an XSL file to post-process the XML. XPath expression to evaluate against XML XSL file to use to post-process XML, or '-' to read XSL from STDIN Reviews to dump to XML Causes all users from Perforce to be mirrored into Collaborator. The algorithm is smart enough not to overwrite existing users, only adding new users, so this can be run periodically by a script to keep the lists in sync. This is not necessary -- or desirable -- if you are using LDAP authentication. You must be logged in as an administrator to execute this command. Adds URLs to a review in the Collaborator server. The content of the URLs are not attached to the review and remain on the origin server. URLs are not reviewed with differences, so adding the same URL more than once will have no practical effect. For example, to review the contents of a wiki page in a brand new review: ccollab addurls new http://wiki/Topic_Page To review the contents of a wiki page in review #62: ccollab addurls 62 http://wiki/Topic_Page Comment used to attach URLs (default is "Attached URLs") Must be either an integer review-id, 'new', 'ask', or 'last' URLs to attach Must be either an integer review-id, 'new', 'ask', or 'last' Perforce changes that fix this job will be added to the review Commit the changes from a pre-commit review to sourcecontrol. Be sure to include a relevant comment. Comment for reviewed changes Just dismiss the Action Item Ignore potential problems Must be either an integer review-id, 'ask', or 'last' Must be either an integer review-id, 'ask', or 'last' Attaches differences pending promotion in an AccuRev stream. Comment used to upload files Must be either an integer review-id, 'new', 'ask', or 'last' Specify an AccuRev stream by name, or leave blank to use the current workspace Upload files that are Parts in a CMVC Track to a review. If the root path is not specified, file content is extracted from CMVC, comparing the latest version in the Track to its predecessor version. If the root path is specified, the root path is used to resolve the file parts of the Track to the local files on disk, and these are compared against the file versions in the Track. For example, to upload files that are already checked into CMVC: ccollab addtrack review defect release If you have a local snapshot directory with local modifications and the CMVC files exist and are part of a Track: ccollab addtrack review defect release rootpath rootpath specifies the root of the local sandbox that the file path names in the Track are relative to. Comment used to upload files (default is "Local changes") Must be either an integer review-id, 'new', 'ask', or 'last' Associated CMVC defect Associated CMVC release Path to local source files (CMVC top directory) Attaches file versions from one or more activities to a review. For each file in the activity, the latest version in the activity and the predecessor of the earliest version in the activity are uploaded to the review. You can specify multiple activity names on the command line. You can also use the word 'all' as the activity name to include all activities in the current view. If multiple activities are given, the changeset uploaded is the union of all changes in each of the activities. You can use the --diffintegration option to include the default integration stream in determining version content for review. For the most recent version, this option will scan the versions of each file in the given activity as well as the versions of those files in any associated rebase activities, to determine the most recent version. For the previous version for each file in the activity, this option will use the LATEST version in the default integration branch (if available) as the previous version. Use LATEST version from default integration stream, if available, as the predecessor version Comment used to upload files (default is "Local changes") Must be either an integer review-id, 'new', 'ask', or 'last' Specify one or more ClearCase activities by name, or use 'all' to include all activities in the current view Uploads specific versions of a file or files to a review. A version-spec is given by a file path followed by a version, and optionally, a predecessor version: file-path version [predecessor-version] If no predecessor version is explicity given, diffs will be generated using the predecessor version as determined from the SCM system. Adding versions for a single file can be done with command line arguments given after the review number. To upload versions for multiple files, the file and versions may be submitted on lines read from standard input. If the path and versions are not given on the command line, the client will expect to read them from stdin. Each line read should be in the format shown for the version-spec option. Some example command lines for reading versions from stdin: ccollab addversions 86753 ccollab addversions last < versionlist.txt cat versionlist.txt | ccollab addversions new When supplying the version list on the command line or in an input file, the keyword 'local' can be used to denote the version corresponding to the local version of the file. The 'local' keyword can only be used for the first version argument, not the predecessor version. Comment used to upload files (default is "Local changes") A version to be reviewed can be specified by a version-spec. A version-spec is given by <path> <version> [<previous-version>], where <path> is the filename or server path of the file, <version> is the version to be reviewed, and <previous-version> is an optional version that <version> should be diff'ed against. Each argument must be quoted if any embedded spaces exist in an argument. Typically a version-spec is not used on the commandline. Instead, specify the parts using the <file-path>, <version> and optionally the <predecessor-version> arguments Must be either an integer review-id, 'new', 'ask', or 'last' Path of the file whose versions are to be added to the review. Requires a value for <version> Version of the file to be added to the review. Required if <file-path> is given Predecessor version to be added to the review Upload differences between arbitrary versions of files in Visual SourceSafe using 'ss diff'. Do not use diff arguments that affect the diff output such as '-o', '-b', '-h', '-?', '-du<width> where width is less than 128', or '-dx<context> where context is less than 10'. The Collaborator command-line client will automatically select an output format that ensures you will get all the data you need on the server. Examples: ccollab addvssdiffs 698 HelloWorld.java -yusername,password ccollab addvssdiffs new HelloWorld.java -v2 ccollab addvssdiffs 698 HelloWorld.java -v4~1 ccollab addvssdiffs 698 $/Project/Status.java c:\project\Status.java Comment used to upload files (defaults to command-line arguments) Must be either an integer review-id, 'new', 'ask', or 'last' Command-line arguments to pass directly to the diff command Upload differences between arbitrary versions of files in StarTeam using 'stcmd diff'. Do not use diff arguments that affect the diff output such as '-c' or '-e'. The Collaborator command-line client will automatically select an output format that ensures you will get all the data you need on the server. Examples: ccollab addstdiffs 698 -p "project" -vl LABEL1 -vl LABEL2 ccollab addstdiffs new -p "project" -vd "2007-01-01" *.cpp Comment used to upload files (defaults to command-line arguments) Must be either an integer review-id, 'new', 'ask', or 'last' Command-line arguments to pass directly to the diff command Upload differences between arbitrary versions of files in Perforce using 'p4 diff2'. Do not use diff arguments that affect the diff output such as '-q', '-t', '-d<flag>', or '-s<flag>'. The Collaborator command-line client will automatically select an output format that ensures you will get all the data you need on the server. Examples: ccollab addp4diffs 698 //depot/file1 //depot/file2 ccollab addp4diffs new //depot/...@1523 //depot/... ccollab addp4diffs 698 -b my-branch Comment used to upload files (defaults to command-line arguments) Must be either an integer review-id, 'new', 'ask', or 'last' Options which should be passed to the p4 diff2 command Upload differences between arbitrary versions of files in Mercurial using 'hg diff'. Do not use diff arguments that affect the diff output such as '-U unified'. The Collaborator command-line client will automatically select an output format that ensures you will get all the data you need on the server. For example, to upload all changes between revisions 4 and 8: ccollab addhgdiffs review -r 4 -r 8 To upload all changes in your local working directory: ccollab addhgdiffs review . Comment used to upload files (defaults to command-line arguments) Must be either an integer review-id, 'new', 'ask', or 'last' Command-line arguments to pass directly to the diff command Upload differences between arbitrary versions of files in Git using 'git diff'. Do not use diff arguments that affect the diff output such as '-U unified'. The Collaborator command-line client will automatically select an output format that ensures you will get all the data you need on the server. For example, to upload all changes between the revision 8 revisions ago and the revision 4 revisions ago: ccollab addgitdiffs review main~8 main~4 To upload all changes in your local working directory: ccollab addgitdiffs review Comment used to upload files (defaults to command-line arguments) Must be either an integer review-id, 'new', 'ask', or 'last' Options which should be passed to the git diff command Upload differences between arbitrary versions of files in CVS using 'cvs diff'. Do not use diff arguments that affect the diff output such as '-N --new-file', '-u -U --unified', '-c -C --context', '--brief', '-e -ed', '-f --forward-ed', '-n --rcs', or '-y --side-by-side'. The Collaborator command-line client will automatically select an output format that ensures you will get all the data you need on the server. For example, to upload all changes between labels build-391 and build-401: ccollab addcvsdiffs review -r build-391 -r build-401 To upload all changes between dates 2006-01-01 and 2006-02-01: ccollab addcvsdiffs review -D 2006-01-01 -D 2006-02-01 To upload all changes in the last 7 days: ccollab addcvsdiffs review -D "7 days ago" Comment used to upload files (defaults to command-line arguments) Must be either an integer review-id, 'new', 'ask', or 'last' Command-line arguments to pass directly to the diff command Upload differences between arbitrary versions of files in AccuRev using 'accurev diff'. Do not use diff arguments that affect the diff output such as '-c' or '-G'. The Collaborator command-line client will automatically select an output format that ensures you will get all the data you need on the server. Note: This does not upload added or deleted files due to AccuRev limitations. Examples: ccollab addardiffs 698 -a -b -v "My Stream" Comment used to upload files (defaults to command-line arguments) Must be either an integer review-id, 'new', 'ask', or 'last' Command-line arguments to pass directly to the diff command Upload differences between arbitrary versions of files in Subversion using 'svn diff'. Do not use diff arguments that affect the diff output such as '--diff-cmd', '-x [--extensions]', '--summarize', or '--non-interactive'. The Collaborator command-line client will automatically select an output format that ensures you will get all the data you need on the server. Examples: ccollab addsvndiffs 698 -r 2:16 ccollab addsvndiffs new -r PREV http://my.svn.server/svn/repo ccollab addsvndiffs 698 -c 10534 src/java ccollab addsvndiffs new OLDURL[@OLDREV] NEWURL[@NEWREV] Comment used to upload files (defaults to command-line arguments) Must be either an integer review-id, 'new', 'ask', or 'last' Command-line arguments to pass directly to the diff command Upload as paths relative to the before or after directory Comment used to upload files Must be either an integer review-id, 'new', 'ask', or 'last' If `after` is also given, a directory of files to treat as base files or file to use as base file (before changes were made). If no `after` argument is given, this is a file containing multi-file textual diffs, or '-' to read diffs from stdin Directory of files to scan for differences or file to use as modified file(after changes have been made) Uploads changelists from an SCM to the Collaborator server. The first argument is the review specifier, subsequent arguments are the IDs of the changelists to upload. For example, to upload changelist 4321 and 7568 to a new review: ccollab addchangelist new 4321 7568 For example, to upload changelist 5432 and 12654 to review 111: ccollab addchangelist 111 5432 12654 Must be either an integer review-id, 'new', 'ask', or 'last' SCM-specific ID of an atomic set of changes Uploads local files to the Collaborator server. Files are uploaded without a "previous version" so the entire file will be shown without differences. If you upload the same file path on more than one occasion, the server will start making diffs of each version against the previous. The server displays the full file system path of the files, unless you specify the --relative-to option. It is an error to specify a directory or a file that does not exist. For example, to upload files foo.txt and c:\dev\bar.txt into a brand new review: ccollab addfiles new foo.txt c:\dev\bar.txt To upload file c:\dev\bar.txt into review #62: ccollab addfiles 62 c:\dev\bar.txt Absolute parent path to calculate file-paths relative to if no SCM system Comment used to upload files (default is "Local changes") Must be either an integer review-id, 'new', 'ask', or 'last' Local files to upload Uploads locally modified files controlled by an SCM to the Collaborator server. The first argument is the review specifier, then any number of files or directories can be given. Files are selected as-is; directories are scanned recursively for locally-modified files, which might include edits, additions, deletions, branches, integrations, moves, copies, and so on. After the scan is complete, a file list is presented in a graphical editor so you can review the files about to be uploaded and make any corrections you wish. For example, to create a new review and add all changes in the current directory and below, plus the file foo.txt, you would use: ccollab addchanges new . foo.txt To upload modified files from the current working directory and all subdirectories to review 123: ccollab addchanges 123 . To upload file foo.txt and modified files from c:\dev\project into a brand new review: ccollab addchanges new foo.txt c:\dev\project (ClearCase only) specify either branch-name or "predecessor" to determine the earlier version for upload Comment used to upload files (default is "Local changes") Must be either an integer review-id, 'new', 'ask', or 'last' Local files or directories to scan for modified files Save a global option setting in a config file, so it will be set upon subsequent invocations of 'ccollab'. To clear a global option setting, set it to "". Global options saved by 'ccollab set' are overridden by options specified on the command-line. With the exception of 'password', any global option can be saved using this command. For the list of global options run 'ccollab help global-options'. Examples: ccollab set url http://collab.mycompany.com ccollab set user myusername If the <value> argument is not supplied on the command-line, 'ccollab set' will prompt for it. If no arguments are supplied on the command-line, 'ccollab set' will print the current values of all the global options. Note that the user should run 'ccollab login' in order to save the global option 'password'. Key to save Value to save If no arguments are specified, this command will first try to use the existing configuration to connect to the Collaborator Server. If the url, user, or password arguments are not specified, the user will be prompted to supply the necessary configuration information. If the new configuration settings result in a valid connection to a Collaborator Server, they will be saved to the configuration file. New URL to server New username New password New proxy server URL New proxy server port Uses the configured global options to validate the connection to the Collaborator Server. Also validates the SCM configuration. If the 'scm' global option is not set, tries to automatically detect the SCM configuration for the current working directory. If the topic is not specified, displays help on all commands. Examples: ccollab help ccollab help global-options ccollab help addchanges ccollab help admin review-xml ccollab help batch-xml Display all commands, including those not recommended for the current SCM system A specific command to display help for, or 'global-options' to display help on global options Must be either an integer review-id, 'new', 'ask', or 'last' - note some commands may not allow 'new' Existing Review id Create a new Review The last review accessed with this client Interactively prompt for a review Must be either an integer defect-id or 'last' Existing Defect id The last defect accessed with this client Boolean value (empty implies true) true true true true true true true true true