Development Conventions

MoReese

I want to know if Interwoven has any documentation around naming conventions and best practices to follow when configuring Teamsite/OpenDeploy/DataDeploy. i.e. conventions to follow when creating workflows/dct's/perl scripts.

Adam Stoller

I'm not sure what you're looking for - but my general naming convention is:

• Don't use white-space or punctuation characters other than ('.', '_', and '-') within file names and directory paths (for directory paths I generally try to avoid '.' too - especially ".com" on Windows)
  
  
• WFT filename should be at least somewhat descriptive and end with ".wft" - If I'm doing work for a customer I create a separate directory for them (iw-home/local/config/wft/****) and prefix all wfts with the same "****_" (where "****" is some simple abbreviation of the customer's name - like "iwov_" or "iw_" would be for "Interwoven")
  
  
• For DCTs - they have to be named "datacapture.cfg"
  
  
• For DCRs - (which is what I think you were really asking about) I usually end them with ".xml" because that's what they are - and because ".dcr" is already used by, I believe, Flash - and can cause problems when trying to view the files within TeamSite. The basename of the file and/or sub-directory under data/ depends on the situation. Some folks like descriptive names, some folks like codified names (e.g. 20030128_212805.xml) or something some variant thereof. It's really a question of what makes sense at the time - and document it!
  
  
• Presentation Templates I believe should end with .tpl, the live in the templatedata/category/data-type/presentation/ directory and should probably have reasonably descriptive names. You probably don't need to prefix them specifically for the customer since the entire category/data-type structure is already customer specific
  
  
• Perl scripts - if they are intended to be run by iwperl - should end in ".ipl" - and the names should be reasonably descriptive and again, I usually preface them with a customer identification ("****_"). This is particularly useful for CGI scripts which go into iw-home/httpd/iw-bin/, but also useful for things you place in iw-home/local/bin/ or anywhere else - helping to identify it as something which was developed specifically for the customer.
  
  
• OpenDeploy configuration files again should be reasonably descriptive, begin with ****_ and end with .xml These currently have to exist within od-home/conf/
  
  
• I haven't done much work with DataDeploy recently, so I don't have any quick ideas for it - I imagine if the filenames aren't mandated, then a convention similar to the ones specified above for some of the other files would apply.
  

Hope that helps - above all, remember to document whatever you do.

--fish
(Interwoven Senior Technical Consultant)