Comments
Comments provide a vehicle for submitting, storing, and retrieving text commentary associated with report data cells. This allows you to annotate data so other users can view supporting information associated with a particular piece of data.
Features
You can use comments in the following ways:
-
You can add comments to a report.
-
You can view (manage) all comments in a data region.
-
You can edit comments.
-
You can retrieve comments added to a report. Within the report, comments are displayed as tooltips.
-
You can see a history of the comments for a specific cell in a report.
-
You can delete a comment.
Adding Comments
You can add comments to a specific cell in a report.
You add a comment in run mode by selecting a cell, then choosing Comments and then Add comment. You enter the comment in the Add Comment dialog box. The default length for a comment is 255 characters.
Administrators can change the comment length using the environment parameter COMMENT_MAX_LENGTH. The default value is 255 and the maximum length is 1,332 characters.
When adding a comment, you can select More and then specify the following items:
|
Item |
Description |
|---|---|
|
Priority |
Specifies the desired priority level or None. The report shows comments in order of their priority level. |
|
Keywords |
Specifies keywords to organize and search for comments in the database. This field takes blanks and empty strings. |
|
Modify Context |
Allows you to select specific members for the context using the Member Selector. See Member Selector. You cannot modify the context of a comment using the View History dialog box of a report or an input form. |
Viewing Comments
You can view individual comments in a report, as well as all of the comments associated with a report. You view a comment in a selected cell in a report by placing the cursor on a cell to which a comment has been added. The comment, originator and modification date are displayed.
You view all comments in a report by selecting Comments and then Manage comments. The Manage comments workspace is displayed showing details of all comments. The following details are displayed:
|
Item |
Description |
|---|---|
|
Comment |
Displays the entire comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the cell. When you finish modifying the text, choose Update Comment. |
|
Keyword |
Displays the keyword associated with the comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the field. |
|
Date and Time |
Displays the date that the comment was saved to the database. If the comment is updated by the originator or an administrator, the updated date appears in this cell. The value in this cell is display only. |
|
User |
Displays the comment originator's name. The value in this cell is display only. |
|
Priority |
Displays the priority for the comment. If you are the originator of the comment or if you have administrator rights, you can modify the value directly in the cell by selecting another option from the drop-down list. |
|
Dimension Members |
Displays the details of the cell of the report to which the comment was added. |
Filtering Comments
You can specify filter criteria for displaying the comments in the Manage comments workspace. To set filter criteria, choose Edit Criteria and select the following options:
-
Dimension Members - You can select the dimension members for which to display comments.
-
Modification Date - You can choose start and end dates for the comments, or display the full history of the selected comments ( Anytime).
-
Additional Criteria - You can specify a Priority, User ID and Keyword for which to display comments.
Deleting Comments
You can delete a comment associated with a cell. You delete a comment by selecting the cell, then Comments, and then Delete comment. You must click OK to confirm.
Activities
To work with comments in a report, open the report and select Comments. Choose one of the options as described above.