| XLCubed is now FluenceXL. The new wiki can be found here: https://help.fluencexl.com/ |
XL3DoComment
Revision as of 12:09, 1 September 2021 by Antonio.remedios (talk | contribs) (Created page with "Allows a comment to be submitted on demand. It can be used in conjunction with XL3Link to trigger the execution. This setup is designed to allow comments for any number o...")
Allows a comment to be submitted on demand. It can be used in conjunction with XL3Link to trigger the execution.
This setup is designed to allow comments for any number of tuples to be submitted in one batch.
Syntax
XL3DoComment( PerformComment, CommentHtml, Connection, [Hierarchy1], [Member1],…, [Hierarchy100], [Member100] )
Parameters
| Parameter | Description |
|---|---|
| PerformComment | A boolean value (TRUE or FALSE) specifying whether to actually submit the comment. If this is an Excel Range then that cell's value will be reset to FALSE following the submission |
| CommentHtml | The comment to be submitted. Typically an Excel cell reference. This can contain HTML tags, if desired. |
| Connection | Connection number to use |
| Hierarchy1,…, HierarchyN | Name of the hierarchy that the following member applies to e.g. "Measures" or "[Customer].[Customer Geography]" |
| Member1,…, MemberN | Either a single member unique name or an XL3Member formula |
Example
This example shows an input template that could be achieved using XL3DoComment. While this template has a single column, and submits just 5 comments, the same concept could be applied to many comments. To use it:
- enter the new values in column C. These could be entered by:
- Directly typing the values
- Copy and paste from another document
- Formula calculations based on other values
- Click the XL3Link in cell A1, which updates B1 to be TRUE
- The XL3DoComment formulae in column E are triggered
- When the process is complete, cell B1 is automatically reset to FALSE
| A | B | C | D | E | |
|---|---|---|---|---|---|
| 1 | =XL3Link(,"Submit Comment",,XL3Address($B$1),TRUE) | FALSE | |||
| 2 | |||||
| 3 | =XL3Member(1,"[Department]","[Department].&[0001]") | Acceptable | =XL3DoComment($B$1,$C3,1,"[Measures]","[Measures].[Budget Amount]","[Date].[Calendar]","[Date].[Calendar].[Date].&[1128]","[Department]",$A3) | ||
| 4 | =XL3Member(1,"[Department]","[Department].&[0002]") | Excelling | =XL3DoComment($B$1,$C4,1,"[Measures]","[Measures].[Budget Amount]","[Date].[Calendar]","[Date].[Calendar].[Date].&[1128]","[Department]",$A4) | ||
| 5 | =XL3Member(1,"[Department]","[Department].&[0003]") | Acceptable | =XL3DoComment($B$1,$C5,1,"[Measures]","[Measures].[Budget Amount]","[Date].[Calendar]","[Date].[Calendar].[Date].&[1128]","[Department]",$A5) | ||
| 6 | =XL3Member(1,"[Department]","[Department].&[0004]") | Acceptable | =XL3DoComment($B$1,$C6,1,"[Measures]","[Measures].[Budget Amount]","[Date].[Calendar]","[Date].[Calendar].[Date].&[1128]","[Department]",$A6) | ||
| 7 | =XL3Member(1,"[Department]","[Department].&[0005]") | Underperforming | =XL3DoComment($B$1,$C7,1,"[Measures]","[Measures].[Budget Amount]","[Date].[Calendar]","[Date].[Calendar].[Date].&[1128]","[Department]",$A7) |
The finished input template:
Legend
- Control block: used to trigger the XL3DoComments' comment action.
- New comments: these cells contain the new comments to be submitted.
- XL3DoComment block: these XL3DoComment formulae control the cross-section of the cube against which the comments are submitted.
Web Restrictions
Web edition does not support using an XL3Lookup or other XLCubed formulae for the source values of the XL3DoComment - the XL3Lookups are run after the XL3DoComment.
