How to retrieve the template name for a Lotus Notes database

The Lotus Notes NotesDatabase class provides a method to determine a template name, but it only works for the template file itself -- template.ntf. While there's no prescribed method to grab the true template name for a Lotus Notes database, SearchDomino.com Hall of Famer Ulrich Krause has figured out a way to do it using LotusScript.

VIEW MEMBER FEEDACK TO THIS TIP

The Lotus Notes NotesDatabase class provides a method to determine a template name, but it only works for the template file itself -- template.ntf.

As far I could find out, there is no prescribed method to grab the true template name for a Lotus Notes database.

Upon further research, I found out that the name is stored in the NotesDatabase icon. The icon can be accessed as any other Lotus Notes document.

From Lotus Notes/Domino R6 on, there is a new class -- called NotesNoteCollection. The NotesNoteCollection class represents a collection of Lotus Domino design and data elements in a Lotus Notes database.

I did a quick debug to find the proper place to look for the template name value. Below, you will find LotusScript code that will retrieve the name of a template used for a specific Lotus Notes database.

 Function getTemplate
( db As NotesDatabase ) As String
       
Dim template As String, aux As String
Dim nc As NotesNoteCollection
Dim icon As notesdocument
Dim noteid As String
       
getTemplate = "No Template"
Set nc = db.CreateNoteCollection( False )
nc.SelectIcon = True
Call nc.BuildCollection
   
Set icon = db.GetDocumentByID
( nc.GetFirstNoteId )
       
If not icon Is Nothing Then
getTemplate = 
icon.Parentdatabase.DesigntemplateName
End If

End Function

MEMBER FEEDBACK TO THIS TIP

How about using the DesignTemplateName property of the NotesDatabase object. This gives direct access to the template name that a database inherits it from.
—Thierry S.

******************************************

Why not just use the database property: DesignTemplateName?

Dim db As New NotesDatabase
(<server name>, <path\file name>)
template$ = db.DesignTemplateName

—Steen H.

******************************************

The "Icon" design document has a fixed NoteID, therefore you do not need to skip through design elements to get this design document. Just simply use the following:

set doc = db.GetDocumentByID("FFFF8010")
 
where:

FFFF is NOTE_ID_SPECIAL which can be 
used instead of using API call NSFDbGetSpecialNoteID.
8000 is NOTE_CLASS_DEFAULT
0010 is NOTE_CLASS_ICON

Using this method, you can, easily get the following design documents, for example:

set doc = db.GetDocumentByID("FFFF8004") 
'DEFAULT FORM -> 0004 is NOTE_CLASS_FORM
set doc = db.GetDocumentByID("FFFF8008") 
'DEFAULT VIEW -> 0008 is NOTE_CLASS_VIEW

—Dennis F..

Do you have comments on this tip? Let us know.

Related information from SearchDomino.com:

  • Tip: Finding files and directories with LotusScript
  • FAQ: LotusScript advice
  • Learning Guide: LotusScript development

    This tip was submitted to the SearchDomino.com tip library by member Ulrich Krause. Please let others know how useful it is via the rating scale below. Do you have a useful Lotus Notes, Domino, Workplace or WebSphere tip or code snippet to share? Submit it to our monthly tip contest and you could win a prize.

  • This was first published in August 2006

    Dig deeper on LotusScript

    0 comments

    Oldest 

    Forgot Password?

    No problem! Submit your e-mail address below. We'll send you an email containing your password.

    Your password has been sent to:

    -ADS BY GOOGLE

    SearchWindowsServer

    Search400

    • iSeries tutorials

      Search400.com's tutorials provide in-depth information on the iSeries. Our iSeries tutorials address areas you need to know about...

    • V6R1 upgrade planning checklist

      When upgrading to V6R1, make sure your software will be supported, your programs will function and the correct PTFs have been ...

    • Connecting multiple iSeries systems through DDM

      Working with databases over multiple iSeries systems can be simple when remotely connecting logical partitions with distributed ...

    SearchEnterpriseLinux

    SearchDataCenter

    SearchExchange

    SearchContentManagement

    Close