New article
Recently updated
Using the review category settings
Who is this article for?
Please Review Administrators using the review category.
IT access will be required to implement these changes.
The Review category plays a pivotal role in defining the parameters and rules governing the review process, including review templates, criteria for document approval, and participant roles. This category empowers organizations to create standardised review workflows, ensuring consistency and efficiency in the document review and approval process.
Review category
| Configuration Name | Default Value | Default Override | Notes | Workgroup | Review Type |
|---|---|---|---|---|---|
| Accept Comment Reasons | Accepted; Review Meeting;<Blank> | List of values for the ‘accept’ reason drop-down list, separated by semicolons. <Blank> means a blank value. The top value is the default. | |||
| Add document after review started | PERMIT | Allows users to add a document after a review has started. | |||
| Agree/Disagree | PERMIT | Enables the Agree/Disagree feature. | |||
| Allow Comment attachment | PERMIT | Allows reviewer to attach a file to a comment. | |||
| Allow document download | PERMIT | Allows reviewers to download the original of a document under review (if enabled, this can be overridden by the review owner). | |||
| Allow offline | PERMIT | Enables the offline feature. | |||
| Allow proposed change | PERMIT | Enables the proposed change feature. | |||
| Allow sub-review | PERMIT | Enables the sub-review feature. | |||
| Capacity | Capacity allows for the capture of additional information to be recorded against a participant which relates to the capacity/role in which they participated in the review. To enable Capacity, enter a list of values, separated by semicolons. To disable Capacity, ensure Value is empty. Use <Blank> for a blank/null value, the first value is the default value. Example list: Legal; Clinical; QA; Publishing (see ‘Capacity set by’ setting to determine who sets the capacity). | ||||
| Capacity set by | Either | If ‘Capacity’ is enabled, ‘Capacity set by’ determines who can set this value, which is the review Owner, the participant or either. | |||
| Close Comment Reasons |
Closed;Rejected;Revised; Superseded;Noted; No Action Required;… |
List of values for the ‘close’ reason drop-down list, separated by semicolons. <Blank> means a blank value. The top value is the default. | |||
| Comment Categories | Minor;Typo;Major;Cosmetic;<Blank> | List of comment categories, separated by semicolons. <blank> means a blank value. The top value is the default. | |||
| Control set groups | Where multiple metrics configurations or other UI customizations are installed, selects the set to be used. | ||||
| Countdown timer | PERMIT | Show countdown timer in the review based on review due date. | |||
| Default reminder | 3 | Default reminder(s) when creating a new review. Multiple reminders are separated by commas, e.g. 3,5,7 will create reminders for 3 days, 5 days, and 7 days | |||
| Default review duration | 1 | Default review duration in day(s). 1 means the review will end at the end of tomorrow etc. | |||
| Mandatory Categorization | FALSE | Force review participants to select a comment category | |||
| Opinion | Opinion allows for the capture of additional information to be recorded against a participant when indicating they have completed a review. This is in addition to summary comment, and allows for structured responses from a drop down list. | ||||
| PDF annotation options | Annotation, Proposed Change, Redactions, Sticky Note | PDF annotations available within the review interface | |||
| Review Metrics | DENY | Select PERMIT to enable review metrics applicable to all workgroups. DENY disables it. If disabled, individual workgroups can still setup review metrics but only for use within their own workgroup. | |||
| Sub-Categorization Delimiter | / | N/A | The character used to define sub-categories for multiple levels of categorization, '<' and '>' cannot be used. |
Review advanced category settings
| Configuration Name | Default Value | Default Override | Notes | Workgroup | Review Type |
|---|---|---|---|---|---|
| Archive | PERMIT | Enables the archive feature. | |||
| Auto update changes from master review | TRUE | Update changes from master review automatically into any sub-review | |||
| Automatic Progress when due date reached | FALSE | Progress multi-phase review automatically to the next phase when the due date is reached. | |||
| Automatic Progress when reviewers complete | FALSE | Progress multi-phase review automatically to the next phase when all when all reviewers indicate they are complete. | |||
| Bookmark | PERMIT | Enables bookmark feature. | |||
| Clone as new review | PERMIT | Clone as new review. Enables the Clone as new review feature from existing review. When it is enabled, you can find the button in Review Control Panel. | |||
| Comment history | DENY | Enables comment history logging. Note there is no feature within Please Review to report on comment history; if you wish to enable this feature, please contact support. | |||
| Comment number | PERMIT | Enables display of comment number. | |||
| Default Accept Comment Reason | Accepted | Default reason for accepting a comment | |||
| Default Close Comment Reason | Closed | Default reason for closing a comment. (This is used if the default value in Close Comment Reason is set to <blank> and a reason isn't selected. | |||
| Default Merge Changes Reason | Created by merging other changes together | Default reason for merging changes | |||
| Default Merge Comment Reason | Merged: This change was merged into another one | Default reason for merging a comment | |||
| Default Revise Comment Reason | Revised | Default reason for revising comment | |||
| Default watch | 2 | Controls the default selection for notification emails when participants leave a review; 0 means do not generate notification emails, 1 means only notify about paragraphs where user has already made a comment, 2 means notify me if there is activity on any paragraph. | |||
| Default Withdraw Comment Reason | Withdrawn | Default reason for withdrawing a comment. | |||
| Delete comment | PERMIT | Enables comment deletion. | |||
| Disable Delegation | FALSE | Prevents the delegation of reviews. | |||
| Enable feedback documents | TRUE | Enables feedback documents in reviews. | |||
| Enable file formats for upload | List of file formats (extensions) enabled for document and attachment upload, separated by semicolons. Default value is empty. An empty list enable file upload for all file formats. When list is not empty, document upload is only enabled for those specified in the list. Example list: docx; doc; xlsx; xlt; pptx; pdf; txt; xml. | ||||
| Enable processing of Owner Password protected PDFs | DENY | Set to Deny to block upload and download of Owner Password (Permissions Password) protected PDFs. | |||
| Enable processing on Repeating Content Control | When it is enabled, render the same content to Repeating Content Control with same title (and prefix) Empty - Default option. Repeating Content Control is disabled *** - Repeating Content Control processing is enabled, grouping the Repeating Content Control using Title PREFIX: - Repeating Content Control processing is enabled, grouping the Repeating Content Control using Title matching with prefix "PREFIX:". For TransCelerate documents, the prefix is "CPT:" | ||||
| Hide review navigator for PDF | PERMIT | Hides the review navigator when using PDF plug-in. | |||
| Import Word comments and changes | PERMIT | Convert comments and tracked changes in uploaded Microsoft Word documents into Ideagen Please Review comments and proposed changes. | |||
| Independent Review and Subteams | FALSE | Select true to make reviews independent by default; False (default) for standard collaborative reviews. | |||
| NBSP Replacement Entity | ◦ | N/A | Character to show non-breaking space in review, use HTML Entity (decimal) as value e.g. White bullet ◦. | ||
| Paragraph level notification | PERMIT | Enables paragraph level notification feature. | |||
| Publish replies to sub-review comments | FALSE | Publish replies to sub-review comments. | |||
| Remove extra AUTONUMLGLTEXT | DENY | Automatically remove extra text associated with AUTONUMLGL fields (generally you should not set this unless advised by support). | |||
| Re-open comment | PERMIT | Controls whether a comment thread may be re-opened after it has been accepted or closed. | |||
| Re-open completed review | PERMIT | Controls whether the owner is allowed to re-open a review after it has completed. | |||
| Restore instructional text | FALSE | Enables the system to restore instructional text (when empty) in downloaded Word document. | |||
| Review failed documents | DENY | Enables review for documents that have failed preparation (they are treated the same as unknown formats and only allow general comments). | |||
| Review Template | N/A | To create a review template, paste the XML in here. See the Advanced Features Configuration Guide for details of how to construct a review template. | |||
| Review time | DENY | Enables the review time tracking. (Mandatory when enabled). | |||
| Show Import Pdf Annotations | PERMIT | Allow bulk import of PDF annotations from review control panel. | |||
| Show sub-review comment/reply's original author | TRUE | Show sub-review comment's original author when publishing the comment to the master review. | |||
| Sub-review owner read-only in master review | FALSE | Make sub-review owner read-only in master review. | |||
| Transfer comments in a multi-phase review to the next phase | None | Selects which comments to transfer from one phase to the next in a multi-phase review. | |||
| Use advanced Word preparation | FALSE | Select True to prepare Word documents in advanced mode by default; False (default) for manual selection at upload document screen. | |||
| User email notify | PERMIT | Enables the email notification feature. |