Applies to Collaborator 13.0, last modified on June 26, 2020

Description

Use this command to create a new defect on a review. You can specify various options to control the type and 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 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 defects, see Types of Review Comments and Defects.

Command Line Syntax

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

Command Options

Option

Required?

Description

--cell <value>

No

Cell reference in a "Sheet1!A1" format

--conversation-id <value>

No

ID of the first Comment in an existing Conversation

--custom-field <value> [<value> ...]

Yes

Setting for custom fields, in the form field-name=field-value. (for example, "Severity=Major" "Type=Text")

The "Severity" and "Type" custom fields are mandatory, other custom fields (if any) are optional.

--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

Identifier of the desired review (an integer number), or an ask, or last keyword. Where keywords define the following behaviour:

  • ask - the command will pause execution and prompt for the identifier of the desired review,
  • last - the command will use the last review that was created on the current machine via Command-Line Client (that is, it does not know about reviews created elsewhere).

<comment>

Yes

The description of the defect.

Examples

To create a defect in overall section of review #123:

ccollab admin review defect create 123 "overall review defect" --custom-field "Severity=Major" "Type=Text"

To create a defect in overall section of the bizbaz.java file in review #567:

ccollab admin review defect create 567 --file "bizbaz.java" "overall file defect" --custom-field "Severity=Major" "Type=Text"

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

ccollab admin review defect create 567 --version 789 --line-number 36 "defect on a line" --custom-field "Severity=Major" "Type=Text"

See Also

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

Highlight search results