Rules Engine: Include a free text comments field within Tasks and Actions

  • 5
  • Idea
  • Updated 4 weeks ago
When creating complicated rules, it's not uncommon to go back to it months later and ask "why did I create that logic?" Or if someone has to come behind me and trying to understand what I did.

It would really help to have a comments section in each task/action to capture more detail than can be added in the Description.   Kind of like how programmers add comments to their code.



Photo of Jeff Kirkpatrick

Jeff Kirkpatrick, Champion

  • 26,596 Points 20k badge 2x thumb

Posted 4 weeks ago

  • 5
Photo of Samantha Braastad

Samantha Braastad, Champion

  • 7,768 Points 5k badge 2x thumb
Agreed! Any documentation added within the tool is helpful for when changes are made and help remove the need to document in multiple sources which quickly can become out-of-date.
Photo of Hitesh Sharma

Hitesh Sharma, Employee

  • 4,498 Points 4k badge 2x thumb
Hi Samantha / Jeff,

We do have Description field per Action for the same in Bionic Rules,


Also we have Description field per task beside task name,


Let me know in case of any further questions.
Photo of Jeff Kirkpatrick

Jeff Kirkpatrick, Champion

  • 26,596 Points 20k badge 2x thumb
Yes I know about the Description field.  Looking for something where more detail can be added and viewed within the action/task.
Photo of Dan Ahrens

Dan Ahrens, Official Rep

  • 25,920 Points 20k badge 2x thumb
@Hitesh - what are the character limits for those two description fields and how is text treated if it exceeds the small text box?

@Jeff - do you have a sample description that you could share or thoughts on what character count you'd anticipate needing?
Photo of Jeff Kirkpatrick

Jeff Kirkpatrick, Champion

  • 26,596 Points 20k badge 2x thumb
I don't have a sample description off hand, but where there is fairly complicated filter logic, it would help to be able to write it out in free text to help clarify the reasoning behind the logic. 

Also, to add a comment whenever logic is edited/modified.   Countless times I've come back to an action or a task and thought "when and why did I set the value to X"  I'd say the larger the character count the better.
Photo of Samantha Braastad

Samantha Braastad, Champion

  • 7,768 Points 5k badge 2x thumb
I don't have a specific example but agree that be able to add notes would be helpful. Ideally, filters would be visible from the view box based on what is currently set within the Task. The text back would be more to add context as to why that dataset is being used and any modifications. For example, a filter was adjusted to add another case type based on changes to the way the support team is logging cases. Having this in a text box would make it easy to see that an adjustment has been made and way.