Step 2: Isolate Customizations to Delivered Code

SDL has several recommendations for making customizations to delivered CW user interfaces and code.

Specifically, SDL recommends the following:

  • Copy delivered files to the appropriate custom directory before making changes.
  • If any new files are needed as part of the customization, put these in the custom directory as well.
  • Design customizations so that changes to existing code are minimal and the majority of the custom code is in isolated functions in the existing file, or in separate jsp files. Put custom functions in a standard location in the file (e.g., at the end) to make comparing differences and merging easier.
  • Use the delivered code as examples when creating customizations. This can save development time and will help ensure a consistent approach for issues like error handling, synchronization, etc.
  • When copying CW delivered code to custom files or functions, be mindful that this code now becomes custom code and must be maintained by the customer.

Following these recommendations has the following benefits:

  • The developer’s concern moving forward will be the call from Contenta Web to the customization. This call will have to be reviewed with every release but the customization can be reviewed at the developer’s leisure.
  • The customization can be reviewed independently and may or may not change depending on the desires of the customer moving forward.