Using Helpers for Debugging in SuiteCommerce

TL;DR Opening

Helpers are invaluable for debugging in SuiteCommerce, allowing developers to log object contents directly to the console or page. This helps illuminate the context and model properties within templates.

How Do Helpers Aid Debugging?

In SuiteCommerce and SuiteCommerce Advanced (SCA), built-in helpers provide developers with the ability to print out information for easier debugging. The most commonly used helper for logging is the log helper, which you can utilize for inspecting the current context and model data.

Using the log Helper

To effectively employ the log helper:

• To log the view's context object, you would use:

  templateCopy

  {{log this}}

  Note: The this keyword is contextual and may change based on usage, such as in an iterator or block.

• To log the model data, you can use:

  templateCopy

  {{log model}}

Understanding Logged Properties

In recent iterations of SuiteCommerce templates, developers have access to a list of properties they can use and review. At the bottom of each template, the properties sent to it can be found, which helps in ensuring that the correct values are being utilized.

Who This Affects

• Developers: Primarily those creating or maintaining SuiteCommerce or SCA projects. Understanding how to use helpers is essential for efficient debugging.

Key Takeaways

• Utilize the log helper for efficient debugging of context and model objects in SuiteCommerce.
• Be aware of the contextual nature of the this keyword in templates.
• Check the bottom of templates for a list of properties sent for easier troubleshooting.