Home
IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
LotusScript/COM/OLE Classes
LotusScript® Classes Coding Guidelines
The following topics cover some general guidelines for writing LotusScript® code using Domino® objects:
Accessing sessions
Accessing session properties
The following table lists the NotesSession properties.

IBM Domino Designer Basic User Guide and Reference
Basic product usage information and programming language reference information.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino Query Language (DQL) is a facility running in Domino core allowing for a terse shorthand syntax for finding documents according to a wide variety of complexity of terms. It leverages existing design elements without the need to write detailed code to access them.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
  - LotusScript® Classes Coding Guidelines
    The following topics cover some general guidelines for writing LotusScript® code using Domino® objects:
    - Using the Domino® classes
      Domino® Designer defines LotusScript® classes that allow you to access Domino structures on two levels:
    - Using LotusScript® features in Domino®
      All LotusScript® features work in Domino® exactly as specified in generic LotusScript, with the following exceptions and clarifications:
    - Accessing Domino® databases
    - Accessing views and folders
    - Accessing documents in LotusScript® classes
    - Accessing items in LotusScript® classes
    - Accessing rich text items in LotusScript® classes
    - Accessing sessions
      - Accessing session properties
        The following table lists the NotesSession properties.
        Examples: Accessing session properties
      - Using environment variables
      - Accessing agents
      - Accessing international settings
      - Hashing passwords using LotusScript®
        Passwords can be hidden for display, for example, by using a field of type Password, or a prompt of type PROMPT_PASSWORD in NotesUIWorkspace.Prompt. However, passwords saved as field or other values (such as environment variables) are not secure. The following methods provide a means to secure passwords:
      - Locking documents and design elements (LotusScript®)
        Locks permit you to synchronize multi-user access to documents and the following design elements: agents, forms, and views.
    - Accessing supporting Domino® objects
    - Handling run-time errors
    - Accessing the Domino® Objects through COM
    - Using OLE
      The Notes® client is an OLE automation controller and server.
    - Using OLE custom controls
      You can embed OLE custom controls in Domino® Designer forms and write scripts for them just as you can for a native object. When a control is active (has focus), the menu is a combination of Domino Designer (File, Applet, and Window) and control items. The control menu items may include one for itself (for example, "Spreadsheet" for a spreadsheet control) and Help--the control help is substituted for Domino Designer help.
  - LotusScript® Classes A-Z
    This documentation lists each class, property, and method in the Domino® class library. Each class is followed by an alphabetical listing of the properties for that class and an alphabetical listing of the methods for that class. To find the property or method you want, turn to the class to which the property or method belongs.
  - LotusScript® Classes Tutorial
    Welcome to LotusScript® and Domino®. "LotusScript Classes Tutorial" consists of three lessons designed to introduce you to using the LotusScript language in Domino. Each lesson includes:
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Lotus® Connectors
  Lotus® Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

Accessing session properties

The following table lists the NotesSession properties.


Property	Data type	Description
AddressBooks	NotesDatabase array	(Read-only) Accessible Public and Personal Address books, both local and remote
CommonUserName	String	(Read-only) Common name of the current server or user
ConvertMIME	Boolean	(Read-write) True if items of type MIME_PART are converted to rich text upon instantiation
CurrentAgent	NotesAgent	(Read-only) Agent in which the program is running
CurrentDatabase	NotesDatabase	(Read-only) Database in which the program is running
DocumentContext	DocumentContext	(Read-only) In-memory document created by an external program through the Notes® API
EffectiveUserName	String	(Read-only) User ID of the creator of the current script
HttpURL	String	(Read-only) The HTTP URL of a session.
International	NotesRichTextItem	(Read-only) The international (regional) settings for your operating environment
IsOnServer	Boolean	(Read-only) True if the program is running on a server
LastExitStatus	Integer	(Read-only) Status the last time the script ran, if an agent
LastRun	Date/Time	(Read-only) Date and time the script last ran, if an agent
NotesBuildVersion	String	(Read-only) Build version of Domino® Designer
NotesURL	String	(Read-only) The Notes® URL of a session. For COM only.
NotesVersion	String	(Read-only) Version of Domino® Designer
OrgDirectoryPath	String	(Read-only) Default directory of the current user in a hosted organization
Platform	String	(Read-only) Operating system platform
SavedData	NotesDocument	(Read-only) Document that stores data between agent invocations, if an agent
ServerName	String	(Read-only) The full name of the server. For COM only.
URLDatabase	NotesDatabase	(Read-only) Database object representing the default Web Navigator database.
UserGroupNameList	Array of NotesName	(Read-only) Returns the groups to which the current user belongs
UserName	String	(Read-only) User ID (hierarchical name) of the current server or user
UserNameList	Array of NotesName	(Read-only) Returns all the user names on a session, including primary and alternate names
UserNameObject	NotesName	(Read-only) The name of the user or server that created the session. For COM only.