One of the key features of the ServiceNow platform is its flexibility. You can almost build anything on the platform OR modify and customize a number of existing features, like the Service Catalog. Sometimes the customization is really required to cater to a unique business requirement. Other times, it is about bringing a small change in the look and feel of a page or to accommodate a specific user behavior. Well, it all goes well and looks cool until some of these customizations start breaking the catalog interface; or bringing a new custom code breaks the functionality for a set of users.


It becomes a challenge to identify the root cause of the issue. Or in other words, it becomes hard to fix a broken catalog. While we work on bringing more features and enhancements to the product with every release, we also try to bring useful self diagnostic tools in the product. Not only can you troubleshoot the issues yourself and get them fixed faster, but also learn the product better and drive toward using best practices.


Debugging catalog customizations

ServiceNow has three diagnostic tools introduced in the Jakarta release to debug catalog customizations.

Troubleshooting the Catalog UI page

Debug UI customizations on Service Catalog UI page”: A catalog UI page consists of various UI macros, for example a shopping cart is a UI macro. There are many other UI macros that are developed out of the box and constitute a standard catalog page, however customers also tend to develop their own UI macros, or modify some of the out of the box macros to meet their needs. Understanding how to debug your catalog page is necessary if you are modifying it.

Watch the video to learn how this tool lists all the UI macros that are available on a UI page, and how you can easily compare and revert to a version that was working.



Troubleshooting with the Variable Action Logger

The other diagnostic tool that we brought in Jakarta is Variable Action Logger.

With the logger you can analyze the client-side actions affecting the state and values of all variables on a catalog form. Watch the video below to see how you can use it.




Troubleshooting with the Variable Watcher

You can also use a third tool for troubleshooting customizations: Variable Watcher. We enabled the platform field watcher feature on catalog variables so you can use the variable watcher to monitor changes in the state and the value of a Service Catalog variable due to catalog client scripts, catalog UI policies, and catalog data lookups.


Wait, that’s not all; we developed an Item Diagnostics Report back in the Istanbul release. See my demo for how to Troubleshoot a broken catalog item,