Pulse Documentation

Pulse Pulse Questions
1

Hello,

What is the underlying source for the Cube Description field in Pulse generated documentation?

Is this pulled from TM1 cube properties, an attribute, or another metadata source? I’m looking to standardise cube-level documentation (e.g. purpose and data source).

image
image987×235 17.3 KB

Thank you,

Maya

2

Hi @mkoleva,

That is user-driven either directly from the Pulse Web UI or through TI process via comments like below,

#Region @DOC
# This is a comment made inside a certain TI
#EndRegion @DOC

Cheers,

Paul

3

Thank you, Paul,

All TI processes have comments in the Prolog section, but they are not visible in the generated documentation for the cube loading/updating data.

4

I think he means that
(a) The documentation needs to be inside a region which is actually named @DOC. I just added it to a couple of TI processes and it (almost) immediately appeared in the Pulse documentation, though… {ahem}, I don’t recall ever having seen that feature documented anywhere. Including here.
(b) Putting the comments in a TI will add to the Pulse documentation of the TI Process… but not the cube that the TI process updates, which seems to be what you want. However, I note that if you put a region into the cube’s rules using the same syntax as above, it will appear in the Pulse documentation for that cube. Again, {cough}, apparently undocumented. But still very cool, because adding it through the GUI is painful.

5

Thank you very much, Alan,

I certainly will test your suggestion.

6

Yes indeed, this is a pretty cool feature, this was introduced in v6.3.0, you can find more information here: https://cubewisecare.atlassian.net/wiki/spaces/pulseusermanual/pages/878804995/Auto-Populating+Pulse+Documentation+Fields+from+Code

1 Like
7

Hi @Vincent, it’s good to see that it’s in the Pulse documentation… but since Arc is where you actually create the blocks, it wouldn’t be a bad idea to mention it in the documentation for that as well. (Since I went from Pulse 5.x to Pulse 7.x I have to confess to not having read the Pulse V6 documentation. But since we update Arc every version and Pulse only when we really have to, I always read the Arc release notes.)

8

Also… I’m guessing that there isn’t anything similar for dimensions / hierarchies? (Mainly because I can’t think how that may be implemented, and because I tend to document dimensions more, especially with instructions on when and how they need updating.)

9

Thanks @AlanKirk for your feedback, I’m glad to see that someone is reading the release notes :wink:

Regarding dimensions and hierarchies, we’re not able to store comments directly in TM1. However, we could add a panel in Arc to populate the Pulse field.

Would you mind creating an enhancement request for this? That way, you’ll be kept in the loop once it’s implemented: Jira Service Management