|This article refers to the latest XLCubed version. For other versions, see Cube Comments/Versions.|
Cube commentary allows authorised users to enter and view text commentary or analysis against specific data elements. Comments can be made for a specific data point, or at higher levels of the data, for example an entire month. Commentary was introduced in Version 8.1, and significantly extended in Version 9.1. It requires access to XLCubed Web Edition running in SQL Repository mode.
There are several levels of commenting allowed. These can be set at a group or user level in the XLCubed Web SQL Admin Tool. The levels are:
- (None) - Cannot see or enter comments
- Comment view - Can see existing comments but cannot enter new comments
- Comment Entry - Can see existing comments and can enter new comments, can edit and delete own comments
- Full control (admin) - Can see existing comments, enter new comments and edit and delete all comments
By default, comments are not displayed or enabled in Grids. They are enabled in the Commenting section of the Grid Properties ( XLCubed > Properties > Commenting ).
- Show comments: Show a red flag on data with a comment
- Include descendant's comments: Show flag on parent member if a child that is not visible has a comment
- Allow comments: Enable the right-click and ribbon comment menu
Once enabled, any users of the reports can view and enter comments depending on their level of access.
Viewing and entering comments
Comments are displayed in the same way as Excel comments as shown below. The comments are linked to specific data points rather than specific Excel cells.
For the fully formatted timeline view of the comment, click on the cell and select the "Comment" grid ribbon item (this is also on the right click menu). This dialog also allows new comments to be entered. Additional comments can be added to the same datapoint and will be shown in a timeline view, and users can also enter replies to specific comments to form a discussion thread.
Comments can be highly-formatted, and can include content pasted directly from Word. Comments can also incorporate file attachments or screenshots taken from the current Excel workbook using the icons highlighted below.
Comment History, Editing and Deleting
If you are set as a "Comment Admin" you can delete and edit any comments, otherwise with normal "Comment Entry" access you can only edit and delete comments created by yourself. These options appear when you hover over an existing comment, as shown below.
History shows the ownership and timing of any changes which have been made to the initial comment.
The Grid ribbon includes an option to search for comments based on a cube slice, user or comment contents
Reporting with Comment Frames
Within a report, comments will appear as a red indicator on the relevant cell(s). You can see the comment itself when hovering over the cell, and then choosing comment from the menu. In many cases it can be useful to have the relevant comments fully visible on the report. In other cases you may want to report purely on the comments themselves to see all comments entered for specific aspects of the data, for example all comments relating to a specific product, a specific time period, or in the last 24 hours.
This is achieved through Comment Frames. A Comment Frame allows for the display of comments within a report and can be used in 2 main ways:
1) Tied to a specified Grid, where they display all comments for the Grid, filtered by the current selections in place.
2) Tied to an Excel range containing uniquenames. Typically this approach would be used to display either higher level comments, or to build a report directly on the comments users have entered.
Comment frames are added from the Visualise menu. See Comment Frame for more details.
The following formula can be used to either display or enter comments:
- XL3GridComment - used to display the most recent comments for a given grid, this is useful for providing a "Printable" sheet with comments
- XL3CubeComment - Can display and allow comment entry for a particular cube slice. This can be combined with slicers to allow comments to be based on the "Current View" of a report, or without any Hierarchy/Members to provide a general workbook comment.
Comments can be viewed and entered in XLCubed Web Edition by right-clicking on a comment enabled grid or XL3CubeComment formula and selecting the "Comment" option
Scope of Comments
By default, comments are not specific to one workbook, but to the relevant data cell or slice. This means for example that if a comment is made for 'France', November 2017' this comment would be visible on all Grids which:
- Display data for 'France', 'November 2017'
- and have the display comments options set
It is possible to override this behaviour and restrict the comments visibility to either a specific workbook, or group of workbooks. This is the 'Limit Comments by Key' setting in XLCubed - Options - Workbook Options, and in the workbook group. Enabling this creates a custom key for the workbook, which you can override with a common key if you want the same comments to be shared across several reports, but not all report, e.g. 'Budget Q417'.