Comments Report
This article describes the Comments Report and how it can be used. For information on accessing the Comments Report, refer to this article: How to Access Data Insights.
Article Topics
Report Overview
The Comments Report provides a report on comments across all content types in Documoto. This report includes the following table columns:
- Type: The type of content the comment is applied to (part, page, chapter or media)
- Identifier: Unique Identifier for the content
- Identifiers will be set as follows for different content types:
- Part: Part Number
- Page: Page Filename
- Chapter: Media Identifier that the chapter belongs to
- Media: Media Identifier
- Identifiers will be set as follows for different content types:
- Locale: Language code for the content translation name in the Name column
- Name: First available translated name for the content
- Username: The username associated to the user that created the comment
- Organization: The organization that the user that created the comment belongs to
- Visibility: Access controls or visibility settings for the comment
- For more details on the definition of each visibility setting, see this knowledge base article: How to Manage Comments in the Library
- Comment: Comment that was applied to the piece of content
- Created Date: Logged date in which the comment was created
- Last Updated Date: Logged date in which the comment was updated
NOTE: If unexpected HTML formatting syntax in
Comments appear in this report this is because the Classic
Publisher and Library supported limited comment formatting
(i.e. bold, italics, etc.). Formatting of comments was
deprecated when the Documoto Library was deflexed and
upgraded to Documoto Rocket. Comment formatting is no longer
supported, but the HTML formatting originally used in Classic
is retained in our database.
Report Use Cases
The Comments Report can be used to:
- Validation, review, and management of existing comments added to content over time.
- Need to open up the commenting capability to more users as a way to monitor and administer created comments.
Report Parameters
All Documoto reports are limited to 250,000 rows. If the report exceeds the 250,000 row limit, use the below filters to refine the report parameters.
| Parameter | Parameter Type | Notes |
| Username | Optional | Multi-select listbox of users that have created comments within your tenant |
| Type | Optional | Multi-select listbox of content types where comments may be applied |
| Visibility | Optional | Single-select drop-down of the access control or visibility setting applied to comments |
| Created Start and End | Optional | Date parameter range for created comment date(s) |
| Last Updated Start and End | Optional | Date parameter range for updated comment date(s) |
Report Export Options
- HTML
- Text / CSV
- XLSX / Excel
NOTE: Carriage returns included in the comment body will
cause the CSV export to create line breaks in the exported
file. If you use carriage returns in comments, we recommend
exporting in XLSX format to ensure the best possible report
output.