CreateCommentThread

Created: June 09, 2022 | Updated: September 15, 2022

The following pre-packaged resource, derived from this base command, is available:

Applied Parameters: None

Summary

This command is used to add a new comment thread to a BOM row in an ActiveBOM document. Comments are a feature associated with Workspace projects and allow all users working on a document to comment and review the design (or part thereof) in real-time without actual modification of the document itself.

The commenting feature facilitates strong review and collaboration processes. Due to the Workspace nature of comments (they are stored on the Workspace and do not touch the design document in any way) they become invaluable when:

You want to point out some issues in the document without physically merging and getting conflicts.
You want to add a comment that will become visible to everybody instantly prior to committing your working copy.
You want to have a list of notes for your current design that is attached to areas of the document and could be closed as the design matures (similar to a to-do list).

Access

Before you can start using the comment feature, ensure that you have opened a Workspace project and are working on one of its source schematic documents. This is done using the File » Open Project command and selecting the Workspace location in the subsequent Open Project dialog. Only those projects currently shared with you will be available for selection.

This command can be accessed from ActiveBOM by:

Choosing the Tools » Comment command from the main menus.
Using the Ctrl+Alt+C keyboard shortcut.

Use

After launching the command, click on a row in the document to add a comment. A comment entry dialog will open to enter the comment text where you can also include a 'mention' reference to a specific user or group (using the '@' character) and assign a task to a user. Click to confirm the comment creation, which will associate the comment with a numbered pin marker on the document and also add a comment summary entry to the Comments and Tasks panel.

See the Project Commenting page to learn more about the commenting functionality.

Note

When a comment is added, it is seen instantly by all other users that have that same project and document open in their respective design spaces, and also will be available in the browser-based project view of the connected Workspace.