Monday, January 30, 2012

Top 7 project-killing "Best Practices" - Part 3

Thanks for checking back! Here's the final post in the series and the last two Oracle UCM anti-patterns you gotta be aware of:

Component Hell

Just  as the name suggests, this is an all too common final destination of these dozens of Content Server installations maintained by Component Lovers. Whether for the love of java code, pride of craftsmanship or an old stupid belief that complexity creates job security, these folks package everything as java components.
A component for a custom check in form, when a simple HCSP page or a content profile can do the job... A component for duplicating the out of the box content expiry feature... A component for custom reporting instead of using the Content Tracker.... A component for custom Content Server User Interface and then putting it into an iFrame inside the Site Studio web site... Cheez! A 5 week project that was replaced by a simple HCSP Region Template, done by a junior developer in a day!
Reinventing the features that come ready to use with the Content Server, the Site Studio or any of these many supported and documented additional components from Oracle – for no good reason is a crime so when a business is asking for a few feature to be developed – make absolutely sure you’ve checked all the features and all supporting products in the UCM suite and building a custom component is justified.

Short Names

Or meaningless names used in the titles, content IDs and identifier names in your iDoc scripts better be avoided. When you check in a Page Template and Site Studio – be sure to specify a content id. If you don’t – the template will look funny in the Designer.
When creating a Region Template, I personally prefer to call it _RT_
There you have it. Not an exhaustive list by any means and not an earth-shattering revelation. I bet you were aware of many of these before... But hopefully, this article have stirred up some thoughts and you will “make 3 steps back” re-examine your UCM practices and your system from a new angle. It’s one of those “small things” that can reverse the trend and bring forth the big things you really want to see in your projects.

1 comment:

  1. very sensible advice and easily forgotten!

    one minor note, adding a site identifier into the content id for a Site Studio asset causes confusion down the line when you want to reuse that asset for another site.

    Sadly content id doesn't lend itself to refactoring so often it's better to pick a generic name that describes the type of asset (as you've mentioned) and the function/purpose/intent.