Best Practice for documenting Business Rules and BR-Scripts ?
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
12-04-2024 06:18 AM
Hi all,
I'm looking for best practice to document the logic of our Business Rules / Scripts!?
We have a high number of BR and it's almost impossible to understand what is going on.
How do you keep a overview of the logical functions for all the Business Rules in your organisation?
Any best practices are highly appreciated.
Thanks
Oliver
- Labels:
-
Architect
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
12-04-2024 06:30 AM
Hi Oliver,
Broadly speaking we follow this: ServiceNow Developers
We generally question the requirements to see why is it necessary. The second part is then HOW, which is always signed off by the architects.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
12-04-2024 10:48 PM - edited 12-04-2024 10:50 PM
Hello @Oliver Strein ,
Below are the few steps you can follow ,
1.Analyze the all BR and understand the functionality.
2. You can merge BR where same table and trigger condition matches.
3. Validate where you can build the script action , so that multiple action can be trigger via BR with respective scripted condition.
All these step need deep analyzations and understanding the currently working functionality. We can not comment on reduce number part as it depends on your use case.
Thanks & Regards ,
Supriya
.
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
12-04-2024 11:02 PM
Hi Anurag, thanks.
My point is: imagine you're joining a new company where ServiceNow is established for years. Many Architects and developers have created lots of BR over the years.
I'm at this point right now and wonder, how could they have documented each BR in a way that I don't have to go through every single script now to understand what these BR/scripts are doing (or not doing).
Oliver

- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
12-05-2024 02:10 AM
One strategy I have seen customers use is to add the description field to the business rule form and make it mandatory, so developers have to provide background to what the business rule is for.
Aside from this, the normal best practice rules around commenting and adding story references to application file script and description fields apply. It can be hard to go back in time and reverse-engineer this but if that task falls to you then it will help those that come after you if you do your best to document what you find.