Site Studio Naming Best Practices

Now that Site Studio 10gR4 has come out, there are a lot more sites assets to manage then there were before. Previously, you generally had layouts and fragments that you worked on in Designer. Now you have Element Definitions, Region Definitions, Region Templates, Placeholder Definitions, and Conversion Definitions. They all make 10gR4 much more flexible and extensible, but a bit trickier to navigate.

Since Designer has always been heavily reliant on the Content ID for identification, it's best practice to try and name them with something meaningful. By default, UCM installs with auto-numbering not enabled (not sure why). But for almost every implementation, it gets turned on. As a side note, it's always best practice to provide a unique prefix for the ID as well. If you have more then one instance, you won't run into conflicts if you transfer content. Also, be aware that the prefix you provide in a QA or Stage instance would carry over with the content to Production. So for content contributed outside of Designer, like in Contribution Mode on the site for instance, go ahead and let UCM auto-number Content ID.

So back to Site Studio Designer specifically... what I (and some other here at Oracle) have started to do is use a two letter acronym as the prefix of the Content ID. So for Element Definitions, it's EL_ (e.g. EL_WYSIWYG_GENERAL), for Region Definitions it's RD_ (e.g. RD_TITLE_BODY), for Region Template it's RT_ (RT_TITLE_ONLY), etc...I think you get the idea. Now when you have these open in tabs in Designer, you quickly know what you're dealing with. And it just seems to make things easier to identify in the Site Assets panel.

site_assets.jpg

One other best practice is in regards to the Site ID. NEVER use an underscore as part of the Site ID. Because of the way that field is indexed for searching (using CONTAINS), the underscore is treated as a wildcard and causes numerous issues. So while the dialog doesn't prevent you from adding the underscore, try to avoid it.

Comments:

You wrote "NEVER use an underscore as part of the Site ID. Because of the way that field is indexed for searching (using CONTAINS), the underscore is treated as a wildcard and causes numerous issues. So while the dialog doesn't prevent you from adding the underscore, try to avoid it." What if you have an existing site on 10gr3 which uses an underscore and you upgrade to 10gr4? Isn't there some sort of environment variable somewhere that lets you override the usage of the underscore as the wildcard in db searches using contains? One area this bug will become apparent is that Site Studio won't load element definitions, region templates, etc, into the IDE or dropdowns, etc. All the data are there in UCM and you can "add" them to site studio but as soon as you navigate away from the list and back again, the underscore prevents SS from re-loading the objects. So... assuming you do have a site with an ID containing underscores - how do you go about fixing it?

Posted by Chris on November 25, 2009 at 03:40 PM CST #

Hey Chris, take a look at knowledge article #469946.1 on Metalink for instructions.

Posted by kyle.hatlestad on November 29, 2009 at 11:34 PM CST #

Post a Comment:
  • HTML Syntax: NOT allowed
About

Kyle Hatlestad is a Solution Architect in the WebCenter Architecture group (A-Team) who works with WebCenter Content and other products in the WebCenter & Fusion Middleware portfolios. The WebCenter A-Team blog can be found at: https://blogs.oracle.com/ ateam_webcenter/

Search

Archives
« July 2014
SunMonTueWedThuFriSat
  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
  
       
Today