Applies to Collaborator 12.3, last modified on December 06, 2019

Description

Use this command to create a new comment on a review. You can specify various options to control the type and 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 is best to specify --conversation-id <id> to disambiguate situations where there is more than one conversation at a particular location.

To learn about different types of comments, see Types of Review Comments and Defects.

Command Line Syntax

ccollab [global-options] admin review comment create [--annotation --cell <value>] [--conversation-id <value>] [--label <value>] [--line-number <value>] [--page <value> --x <value> --y <value>] [--file <value>] [--version <value>] <review> <comment>

Command Options

Option

Required?

Description

--annotation

No

File annotation (overwrites any existing annotation)

--cell <value>

No

Cell reference in a "Sheet1!A1" format

--conversation-id <value>

No

ID of the first Comment in an existing Conversation

--label <value>

No

Label

--line-number <value>

No

Line number in file

--file <value>

No

Path of file in Review

Either --file or --version option can be specified.

--version <value>

No

Version ID of file in Review

Either --file or --version option can be specified.

--page <value>

No

Page number

Use with the --x and --y options.

--x <value>

No

X coordinate

Use with the --page and --y options.

--y <value>

No

Y coordinate

Use with the --page and --x options.

<review>

Yes

Must be either an integer review-id, 'ask', or 'last'

<comment>

Yes

A text of the comment

Examples

To create a comment in the overall section of review #123:

ccollab admin review comment create 123 "overall review comment"

To create an annotation comment for the foobar.c file in review #345:

ccollab admin review comment create 345 --file "foobar.c" --annotation "ignore this file"

To create a comment at certain coordinates on first page of the picture.png file in review #567:

ccollab admin review comment create 567 --file "picture.png" --page 1 --x 35 --y 56 "at this point"

To create a comment at certain cell of the results.xls file in review #789:

ccollab admin review comment create 789 --file "results.xls" --cell "'Sheet 1'!G17" "This data seems unlikely"

To create a comment on line 36 of a file version with ID 789 in review #1000:

ccollab admin review comment create 1000 --version 789 --line-number 36 "I like this line"

See Also

ccollab admin review comment
Review Chats, Comments, and Defects
Types of Review Comments and Defects

Highlight search results