SoftSlate Commerce
Home » Get Support » Documentation » HTML Documentation

7 Simple Rules for Making Customizations

For any customization you make to SoftSlate Commerce, at all times try to follow these rules. It will save you work and spare you from issues that may occur when upgrading to a future version.

  1. Custom Java Classes. 

    Override existing Java classes by subclassing the appropriate class from the com.softslate.commerce package with your own new class. Then, change the setting under the Settings -> Components screen of the Administrator or manually in the /WEB-INF/classes/appComponents.properties file to tell the application to use your new class instead of the default one. (Requires application reload.) Do not modify any of the existing classes as they may change with an upgrade.

    For more information, refer to SoftSlate Commerce's Java API documentation available at http://www.softslate.com .

    For information on extending the built-in business objects, refer to the section on Extending Built-In Business Objects .

  2. Custom HQL and SQL Queries. 

    Override existing Hibernate queries (HQL) or create new ones in the appropriate queries-custom.hbm.xml file found under the subdirectories of the /WEB-INF/classes/resources directory. (Requires application reload.) Queries defined in the queries-custom.hbm.xml files will override the queries defined in the regular queries.hbm.xml files. Do not modify any of the queries.hbm.xml files as they may change with an upgrade.

  3. Custom Struts Configurations. 

    Override existing Struts action mappings and form bean definitions, or create new ones, in /WEB-INF/conf/core/struts-config-custom.xml . (Requires application reload.) Since this is the last file read into memory, it will override the mappings and form beans defined in the other Struts XML files. Do not modify any of the other Struts XML files as they may change with an upgrade.

  4. Custom Tiles Definitions. 

    Override existing Tiles definitions or create new ones in /WEB-INF/conf/core/tiles-defs-custom.xml . (Requires application reload.) Since this is the last file read into memory, it will override the definitions defined in the other Tiles XML files. Do not modify any of the other Tiles definition XML files as they may change with an upgrade.

    For more information, refer to the section on Working with the Tiles Framework

  5. Custom JSP Templates. 

    Override existing JSP templates by copying them from the /WEB-INF/layouts/default directory over to the /WEB-INF/layouts/custom directory and modifying them there. Create any new JSP templates in the custom directory as well. Do not modify the templates in the default directory as they may change with an upgrade. (In a similar way, to customize templates used in the Administrator, copy templates from /WEB-INF/templates/administrator/default to /WEB-INF/templates/administrator/custom .)

    For more information, refer to the section on Creating a Custom Layout.

  6. Custom Application Messages. 

    Override existing application messages or create new ones in the appropriate application-custom.properties file found under the subdirectories of the /WEB-INF/classes/resources directory. (Requires application reload.) Do not modify any of the other application*.properties files as they may change with an upgrade.

  7. Custom CSS Styles. 

    Override existing CSS styles or create new ones in /css//custom/custom.css. Do not modify any of the other files in /css as they may change with an upgrade.

    For more information, refer to the section on CSS Themes .

Copyright © 2008 SoftSlate, LLC. All Rights Reserved.

Powered by SoftSlate Commerce

Foraker Design