LotusScript Programming

Here are my notes and comments about programming Domino server using the LotusScript language.

Take the Brainbench certification test on LotusScript R5 Programming Lotus Domino R5 Programming

Topics this page:

Database Elements

Access Control Lists

Replication

Agents

Tools

Views & Folders

Forms

Formulas

LotusScript

Get Yourself Certified

Resources

Your comments???

Site Map

About this site

Database Design Elements

Dim session As New NotesSession
Dim dbCur As NotesDatabase
Set dbCur = session.CurrentDatabase

LotusScript to obtain a reference to the current database:

sServer = dbCur.Server

LotusScript to identify the directory path to the current database (by stripping out the database name at the end):

Dim sDirectoryPath As String sDirectoryPath = Left( dbCur.FilePath, Len(dbCur.FilePath) - Len(dbCur.FileName) )

LotusScript to open a new database:

Dim dbOther As New NotesDatabase( sServer, sDirectoryPath & "otherdatabase.nsf" )

Database Metadata In Domain Catalog

Field Name	Field value describes
$Type	Type of document.
$Title	Title of the document. This field may already be populated for you by Notes.
$Creator	Name of the person who created the document. This field may already be populated for you by Notes.
$Categories	Keywords specified on the Meta tab; the keywords help in categorizing the documents.
$Description	Additional information about the document.

Download

NotesPeek 1.52 for R5

Database information,
Access Control List,
Design Elements,
Documents, and
Deletion Stubs

Vance Jochim's List of "Super-Human" Skills Requirements for Lotus Notes & Domino Professionals

Perry Smith's Lotus Notes Questions And Answers

Sample chapters from Special Edition Using Lotus Notes and Domino R5

Developer's Guide to Lotus Notes and Domino R5 by Brett Molotsky and Curt Holmer author's page

IBM Developerworks articles on Lotus (requires registration)

Internal Notes Fields

Field Name	Description
Form	Contains the name of the form that was used to create the document or the most recent form used to save the document.
Posted Date	Displays the date and time the document was mailed.
$Anonymous	Indicates that the form has been set as an Anonymous form (the Anonymous Form property has been selected on the Basics tab of the Form Properties InfoBox). A value of 1 indicates that the form is anonymous and will not contain an $UpdatedBy field.
$File	Indicates that an attachment is contained in the document (each $File field represents one attachment).
$Links	Indicates that the document contains links (each link is stored as an individual entry in one $Links field).
$Readers	Contains a list of authorized readers. This field is typically created by setting security for authorized readers on the form.
$Revisions	Contains the date and time of each editing session.
$Title, $Info, $WindowTitle, $Body	Identify a document in which a form is stored. The form is stored in the document by setting the Store Form in Document property on the Basics tab of the Form Properties InfoBox.
$UpdatedBy	Contains the document authors and editors from each editing session.

Be aware that the document could become corrupted by changes to the value of these internal fields.

LotusScript to change ACLs ???

Predefined Fields

Field Name Description Comment

$VersionOpt Controls version tracking for the document. The field can contain the following values:
0 No versioning.
1 New versions become responses when saved with File > Save as New Version.
2 New versions automatically become responses when saved.
3 Prior versions become responses when saved with File > Save as New Version.
4 Prior versions automatically become responses when saved.
5 New versions become siblings when saved with File > Save as New Version.
6 New versions automatically become siblings when saved.

FolderOption Puts new documents in a folder. A value of 1 prompts the user to select a folder; a value of 2 saves the document to the current folder.

BlindCopyTo Sends a blind copy to those listed in the field, which can be a person, group, or mail-in database.

CopyTo Sends a copy to those listed in the field, which can be a person, group, or mail-in database.

SendTo Sends mail to those listed in the field, which can be a person, group, or mail-in database. This is required for all forms that mail documents.

MailOptions Automatically mails the document when a value of 1 is specified.

$AutoSpell Automatically spell-checks the document before it is mailed when a value of 1 is specified.

Encrypt Encrypts mailed documents when a value of 1 is specified.

Sign Adds an electronic signature of the creator to the document when a value of 1 is specified.

DeliveryPriority Delivers mail as high (H), normal (N), or low (L) priority.

DeliveryReport Returns a report when mail is delivered to the mail recipient.

ReturnReceipt Returns a receipt when the user reads the mail message.

SaveOptions Controls whether or not a document is saved. When a value of 1 is specified, the document is saved; when a value of 0 is specified, the document is not saved.

$$ViewBody Contains the name of a view to embed (this is for backward compatibility); only applicable in Web applications.

$$ViewList Displays a Folder pane (this is for backward compatibility); only applicable in Web applications.

$$NavigatorBody Contains the name of a Navigator to embed (this is for backward compatibility); only applicable in Web applications.

$GroupScheduleRefreshMode Contains a numeric value specifying the frequency for refreshing an embedded group scheduling control.

$GroupScheduleShowLegend Displays the color legend for an embedded group scheduling control when a value of 1 is specified.

$ChargeRead Creates a billing record whenever a user opens a document.

$ChargeWrite Creates a billing record whenever a user creates, copies, edits, or saves a document.

Categories Contains the list of categories for a document.

HTML Passes HTML directly to the server.

$$HTMLHead Passes HTML information that is to be placed between the <html> and </html> head tags.

$$Return After a Web user submits a document, overrides the default confirmation when a customized confirmation is specified in this computed field.

Agents

Tools

Team Studio

Domino Files — The Ultimate Download Site for Notes Professionals

IntelliPRINTPLUS from Cybernet Software integrates with the Notes Workspace to allow the end user to design reports and produce sophisticated output based on Notes data. It enables easy and accurate printing of labels, envelopes, calendars, bar codes, pre-formatted documents, forms and reports.

Netwell doclib

Bakbone Application Plugin Module for online backup and recovery automatic, unattended backups for local or remote domino servers across the network — administered via a central location,

Create a B2B Web Presence with Domino tutorial includes sample databases.

Forms

Put into a Script Library file the functions used by several forms within a database. In the Options event of each form's Globals area, declare (if “mylib” is the name of the script library):

Use "mylib

To call “my_function” from the library