Annotating and commenting in formula code

[wallingfordce]

It's great that in the formula editor one can add as much empty space as one likes to make the code as readable as possible... spaces, returns, blank lines, etc. Also great that fields in the formula editor can be renamed from what they are in the data browser to detail, for example, how a field is filtered. We can also hack that feature to add in a [Value]*0 as a comment.

Still, revisiting big formulas is time consuming because of the lack of code comments. One can create an external repository that includes comments, but formulas cannot be copied and pasted from an external repository into the formula editor, making an external solution not much more helpful. So having a way of commenting in the formula editor, or a way to store formula code somewhere else that allows for commenting that also allows for easy update in Sisense when the code changes in the external repo.

[wallingfordce]

Possible to comment out in formula editor? - Sisense Community

[AssafHanina]

hey @wallingfordce ,

Sisense has a Shared Formula feature (Yet in Beta Version), which design to provide the requests. 

the shared formula provide the option to Reuse in different widgets (in the same data model), 
Update the formulas which affect the related widgets, and add description for the formula which can replace the comment within the formula. 

Best Regards

[wallingfordce]

If I read your response correctly…

…renaming a formula with a description, which we can do already with Favorited Forumlas, is yes, another level of “renaming” that’s available. It doesn’t address the needs for documenting what different parts of the formula are for and why. For example, a CASE statement with 10 WHEN… being able to comment the intent and logic behind each cannot be accomplished by saving/sharing the formula with a friendly name. 

if you mean that Shared Formula DO allow in-line formula commenting, then that’s great news. Is that what you mean and can you share an image of that feature?

[AssafHanina]

Hey @wallingfordce ,

The Starred formula as well as the Shared formula are currently not supporting adding a comment within the body of the formula. 

Using the Shared Formula (in Beta) is an advanced feature which has advantages over the Starred formula. 

1. It provide the ability to modify an existing formula without the need to replace the formula within any widget
2. It's recognize which Widgets and dashboards are affected 
3. Provide the ability to add and modify a description

Notes: Migration of existing favorite formulas to the new Shared Formulas feature is not included in the current Beta phase. Your favorite formulas are neither deleted nor lost; they remain accessible. However, they are only available when the Shared Formulas feature is disabled.

Once the feature toggled:

1. New tab added in the formula editor 
2. Starred formula icon is disabled

While Save the Formula:

After the Formula Saved, it's available in the Shared Formula tab with the following options:

1. Formula information
2. Share option 
3. Edit
4. Delete

Best Regards

Assaf

[wallingfordce]

Thanks for all this info about Shared Formulas. Nothing new here for me as I'm already familiar, but perhaps other readers will be helped by it. In the meantime, I don't want others to think that this Feedback post is "resolved" by Favorite or Shared Formulas. The feedback post is to meet the need for commentary either within the context of the formula editor in Sisense, or in an external location where formulas can be altered and copied and pasted in the Sisense formula editor.

[AssafHanina]

You are welcome! @wallingfordce 

fyi @DRay 

[daat]

Our experience working with Shared Formulas has not been very promising, particularly when deploying dashboards in different environments. Also, a change in a Shared Formula are not always cascaded down to the different widgets making use of them.