Customizing Existing Properties in SuiteCommerce Advanced

TL;DR Opening

This article covers best practices for customizing existing properties in SuiteCommerce Advanced (SCA) while maintaining future compatibility. It emphasizes the importance of organizing your source code effectively and utilizing specific methods for extending and modifying configurations.

Why Customize Properties?

Customizing existing properties in SuiteCommerce Advanced (SCA) allows developers to enhance functionality, improve user experience, and tailor applications to specific business needs. Following best practices during this process ensures ongoing compatibility with newer versions of SCA.

Best Practices for Customization

When modifying existing properties within SCA, several key practices should be adhered to:

• Use the Extensibility API: Innovations in SCA post-Aconcagua should primarily employ themes and extensions to customize functionality, unless direct access to an object is required.
• Follow SCA Update Protocol: Customizations need to be carefully designed to allow seamless upgrades to future versions of SCA without breaking existing functionality.

Organizing Custom Source Code

It is essential to structure your custom modules effectively:

• For implementations of 2020.1 and later, create an extensions directory within the SC_<version> folder:
  noneCopy

  1SC_20.1
  2      Advanced
  3      Backend
  4      Commons
  5      extensions
  6      gulp

• For implementations of 2019.2, the extensions directory should reside inside the SC_<version>_Live folder:
  noneCopy

  1SC_19.2_Live
  2      Advanced
  3      Backend
  4      Commons
  5      extensions
  6      gulp

• For 2019.1 and earlier, place all customizations within an extensions directory in the Modules folder:
  noneCopy

  SuiteCommerce Advanced
        Modules
           extensions
           suitecommerce
           third_parties

Module Naming Convention
Use the format module_name@x.y.z for organizing your modules, helping developers identify versions of customizations clearly.

Customizing Existing Properties in Configuration Files

To modify existing properties and their metadata, you need to follow the Configuration Modification method:

• This involves customizing the individual source JSON configuration files for the properties you wish to change.
• Changes can involve adding, replacing, or removing metadata stored in the Configuration subdirectory of custom modules.
• Organize changes consistently across multiple modules when necessary.

Conclusion

By following these best practices, developers can ensure that their customizations in SCA are scalable, maintainable, and compatible with ongoing upgrades. This approach minimizes the risk of losing modifications during version transitions, promoting a more robust development environment.

Key Takeaways

• Use the Extensibility API for modern SCA implementations.
• Organize custom modules in a structured manner for easy identification.
• Apply the Configuration Modification method for customizing properties.
• Maintain compatibility by using JavaScript prototypes for changes.
• Ensure that customizations allow easy upgrades to future SCA versions.