Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
Domino®
This library provides access to the HCL Domino® back-end.
NotesDatabase (JavaScript™)
Represents a Notes® database.
getDB2Schema (NotesDatabase - JavaScript™)
Gets the DB2® Schema of the current database.

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript™)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the HCL Domino® back-end.
  - NotesACL (JavaScript™)
    Represents the access control list (ACL) of a database.
  - NotesACLEntry (JavaScript™)
    Represents a single entry in an access control list. An entry may be for a person, a group, or a server.
  - NotesAdministrationProcess (JavaScript™)
    Represents the administration process. Note This class is new with Release 6.5.
  - NotesAgent (JavaScript™)
    Represents an agent.
  - NotesAgentContext (JavaScript™)
    Represents the agent environment of the current program, if an agent is running it.
  - NotesBase (JavaScript™)
    Defines methods that are common to all the classes.
  - NotesCalendar (JavaScript™)
    Represents a Domino® calendar.
  - NotesCalendarEntry (JavaScript™)
    Represents a Domino® calendar entry.
  - NotesCalendarNotice (JavaScript™)
    Represents a Domino® calendar notice.
  - NotesColorObject (JavaScript™)
    Represents a color.
  - NotesDatabase (JavaScript™)
    Represents a Notes® database.
    - ACL (NotesDatabase - JavaScript™)
      Read-only. The access control list for a database.
    - ACLActivityLog (NotesDatabase - JavaScript™)
      Read-only. The log from the access control list for a database.
    - Agents (NotesDatabase - JavaScript™)
      Read-only. All of the agents in a database.
    - AllDocuments (NotesDatabase - JavaScript™)
      Read-only. An unsorted collection containing all the documents in a database.
    - Categories (NotesDatabase - JavaScript™)
      Read-Write. The categories under which a database appears in the Database Library.
    - Created (NotesDatabase - JavaScript™)
      Read-only. The date/time a database was created.
    - CurrentAccessLevel (NotesDatabase - JavaScript™)
      Read-only. The current user's access level to a database.
    - DesignTemplateName (NotesDatabase - JavaScript™)
      Read-only. The name of the design template from which a database inherits its design. If the database does not inherit its design from a design template, returns an empty string.
    - FileFormat (NotesDatabase - JavaScript™)
      Read-only. The ODS (on-disk structure) version of a database.
    - FileName (NotesDatabase - JavaScript™)
      Read-only. The file name of a database, excluding the path.
    - FilePath (NotesDatabase - JavaScript™)
      Read-only. The path and file name of a database.
    - FolderReferencesEnabled (NotesDatabase - JavaScript™)
      Read-write. Indicates whether this database maintains folder references for documents.
    - Forms (NotesDatabase - JavaScript™)
      Read-only. All the forms in a database.
    - FTIndexFrequency (NotesDatabase - JavaScript™)
      Read-write. Update frequency of a database's full-text index.
    - HttpURL (NotesDatabase - JavaScript™)
      Read-only. The Domino® URL of a database when HTTP protocols are in effect.
    - IsAllowOpenSoftDeleted (NotesDatabase - JavaScript™)
      Read-write. Indicates whether documents that are soft deleted can be opened.
    - IsClusterReplication (NotesDatabase - JavaScript™)
      Read-write. Indicates whether cluster replication is in effect for a database on a server in a cluster.
    - IsConfigurationDirectory (NotesDatabase - JavaScript™)
      Read-only. Indicates whether a database is a Configuration Directory database.
    - IsCurrentAccessPublicReader (NotesDatabase - JavaScript™)
      Read-only. Indicates whether the current user has public reader access in a database.
    - IsCurrentAccessPublicWriter (NotesDatabase - JavaScript™)
      Read-only. Indicates whether the current user has public writer access in a database.
    - IsDB2 (NotesDatabase - JavaScript™)
      Read-only. Indicates whether the current database is backed by DB2®.
    - IsDelayUpdates (NotesDatabase - JavaScript™)
      Read-write. Indicates whether updates to a server are delayed (batched) for better performance.
    - IsDesignLockingEnabled (NotesDatabase - JavaScript™)
      Read-write. Indicates whether design locking is enabled for a database.
    - IsDirectoryCatalog (NotesDatabase - JavaScript™)
      Read-only. Indicates whether a database is a Directory Catalog database, also known as the Light Weight NAB, or the Enterprise Address Book.
    - IsDocumentLockingEnabled (NotesDatabase - JavaScript™)
      Read-write. Indicates whether document locking is enabled for a database.
    - IsFTIndexed (NotesDatabase - JavaScript™)
      Read-only. Indicates whether or not a database has a full-text index.
    - IsInMultiDbIndexing (NotesDatabase - JavaScript™)
      Read-write. Indicates whether a database can be included in multi-database indexing.
    - IsInService (NotesDatabase - JavaScript™)
      Read-write. Indicates whether a database on a server in a cluster is accessible.
    - IsLink (NotesDatabase - JavaScript™)
      Read-only. Indicates whether a database is the target of a link.
    - IsMultiDbSearch (NotesDatabase - JavaScript™)
      Read-only. Indicates whether a database is of type "Multi DB Search."
    - IsOpen (NotesDatabase - JavaScript™)
      Read-only. Indicates whether a database is open.
    - IsPendingDelete (NotesDatabase - JavaScript™)
      Read-only. Indicates whether a database on a server in a cluster is marked for deletion.
    - IsPrivateAddressBook (NotesDatabase - JavaScript™)
      Read-only. Indicates if a database is a Personal Address Book.
    - IsPublicAddressBook (NotesDatabase - JavaScript™)
      Read-only. Indicates if a database is a Domino® Directory.
    - LastFixup (NotesDatabase - JavaScript™)
      Read-only. The date that a database was last checked by the Fixup task.
    - LastFTIndexed (NotesDatabase - JavaScript™)
      Read-only. The date that a database's full-text index was last updated.
    - LastModified (NotesDatabase - JavaScript™)
      Read-only. The date/time that a database was last modified.
    - LimitRevisions (NotesDatabase - JavaScript™)
      Read-write. The maximum number of entries allowed in the $Revisions field.
    - LimitUpdatedBy (NotesDatabase - JavaScript™)
      Read-write. The maximum number of entries allowed in the $UpdatedBy field.
    - ListInDbCatalog (NotesDatabase - JavaScript™)
      Read-write. Indicates whether a database appears in database catalogs.
    - Managers (NotesDatabase - JavaScript™)
      Read-only. People, servers, and groups that have Manager access to a database.
    - MaxSize (NotesDatabase - JavaScript™)
      Read-only. The maximum size of a database in bytes.
    - NotesURL (NotesDatabase - JavaScript™)
      Read-only. The Domino® URL of a database when Notes® protocols are in effect.
    - Parent (NotesDatabase - JavaScript™)
      Read-only. The Notes® session that contains a database.
    - PercentUsed (NotesDatabase - JavaScript™)
      Read-only. The percent of a database's total size that is occupied by real data (and not empty space).
    - ReplicaID (NotesDatabase - JavaScript™)
      Read-only. A 16-digit hexadecimal number that represents the replica ID of a Notes® database. Databases with the same replica ID are replicas of one another.
    - ReplicationInfo (NotesDatabase - JavaScript™)
      Read-only. The replication object associated with this database.
    - Server (NotesDatabase - JavaScript™)
      Read-only. The name of the server where a database resides.
    - Size (NotesDatabase - JavaScript™)
      Read-only. The size of a database in bytes.
    - SizeQuota (NotesDatabase - JavaScript™)
      Read-Write. The size quota of a database in kilobytes.
    - SizeWarning (NotesDatabase - JavaScript™)
      Read-write. The size warning threshold of a database, in kilobytes.
    - TemplateName (NotesDatabase - JavaScript™)
      Read-only. The template name of a database, if the database is a template. If the database is not a template, returns an empty string.
    - Title (NotesDatabase - JavaScript™)
      Read-Write. The title of a database.
    - Type (NotesDatabase - JavaScript™)
      Read-only. Database type.
    - UndeleteExpireTime (NotesDatabase - JavaScript™)
      Read-write. The number of hours before soft deletions become hard deletions.
    - Views (NotesDatabase - JavaScript™)
      Read-only. The views and folders in a database.
    - compact (NotesDatabase - JavaScript™)
      Compacts a local database.
    - compactWithOptions (NotesDatabase - JavaScript™)
      Compacts a local database allowing the submission of options.
    - createCopy (NotesDatabase - JavaScript™)
      Creates an empty copy of the current database.
    - createDocument (NotesDatabase - JavaScript™)
      Creates a document in a database and returns a NotesDocument object that represents the new document.
    - createDocumentCollection (NotesDatabase - JavaScript™)
      Creates a document collection in a database and returns a NotesDocumentCollection object that represents the new collection.
    - createFromTemplate (NotesDatabase - JavaScript™)
      Creates a new database from an existing database.
    - createFTIndex (NotesDatabase - JavaScript™)
      Creates a full-text index for a database.
    - createNoteCollection (NotesDatabase - JavaScript™)
      Creates a note collection based on the current database and returns a NotesNoteCollection object that represents the note collection.
    - createOutline (NotesDatabase - JavaScript™)
      Creates an outline in the current database.
    - createQueryView (NotesDatabase - JavaScript™)
      Creates a query view.
    - createReplica (NotesDatabase - JavaScript™)
      Creates a replica of the current database at a new location.
    - createView (NotesDatabase - JavaScript™)
      Creates a view.
    - enableFolder (NotesDatabase - JavaScript™)
      Ensures that a folder exists, creating it if necessary.
    - fixup (NotesDatabase - JavaScript™)
      Runs the Fixup task on a database.
    - FTDomainSearch (NotesDatabase - JavaScript™)
      Conducts a Domain Search, that is, a full-text search of all databases listed in a Domain Catalog and marked as included for multi-database indexing.
    - FTSearch (NotesDatabase - JavaScript™)
      Conducts a full-text search of all the documents in a database.
    - FTSearchRange (NotesDatabase - JavaScript™)
      Conducts a full-text search of all the documents in a database.
    - getAgent (NotesDatabase - JavaScript™)
      Finds an agent in a database, given the agent name.
    - getAllReadDocuments (NotesDatabase - JavaScript™)
      Creates a document collection of all read documents in the database.
    - getAllUnreadDocuments (NotesDatabase - JavaScript™)
      Creates a document collection of all unread documents in the database.
    - getDB2Schema (NotesDatabase - JavaScript™)
      Gets the DB2® Schema of the current database.
    - getDocumentByID (NotesDatabase - JavaScript™)
      Finds a document in a database, given the document note ID.
    - getDocumentByUNID (NotesDatabase - JavaScript™)
      Finds a document in a database, given the document universal ID (UNID).
    - getDocumentByURL (NotesDatabase - JavaScript™)
      Instantiates a document in the database on which it is called and returns a NotesDocument object for it.
    - getForm (NotesDatabase - JavaScript™)
      Finds a form in a database, given the form name.
    - getModifiedDocuments (NotesDatabase - JavaScript™)
      Gets the documents in a database that are modified since a specified time.
    - getModifiedDocumentsWithOptions (NotesDatabase - JavaScript™)
      Lets you retrieve all modified documents meeting matches for specified options.
    - getOption (NotesDatabase - JavaScript™)
      Gets the value of a database option.
    - getOutline (NotesDatabase - JavaScript™)
      Gets an outline in the current database.
    - getProfileDocCollection (NotesDatabase - JavaScript™)
      Retrieves the profile documents associated with a profile form.
    - getProfileDocument (NotesDatabase - JavaScript™)
      Retrieves or creates a profile document.
    - getURL (NotesDatabase - JavaScript™)
      Returns the Domino® URL of the parent object.
    - getURLHeaderInfo (NotesDatabase - JavaScript™)
      Gets specific Hypertext Transfer Protocol (HTTP) header information from the Uniform Resource Locator (URL). A URL is a text string used for identifying and addressing a Web resource.
    - getView (NotesDatabase - JavaScript™)
      Finds a view or folder in a database, given the name or alias of the view or folder.
    - grantAccess (NotesDatabase - JavaScript™)
      Modifies a database access control list to provide a specified level of access to a person, group, or server.
    - markForDelete (NotesDatabase - JavaScript™)
      Marks a database for deletion from a server in a cluster.
    - open (NotesDatabase - JavaScript™)
      Opens a database.
    - openByReplicaID (NotesDatabase - JavaScript™)
      Given a server name and a replica ID, opens the specified database, if it exists.
    - openIfModified (NotesDatabase - JavaScript™)
      Given a date, opens the specified database if it has been modified since that date.
    - openWithFailover (NotesDatabase - JavaScript™)
      Opens a database on a server.
    - queryAccess (NotesDatabase - JavaScript™)
      Returns a person's, group's, or server's current access level to a database.
    - queryAccessPrivileges (NotesDatabase - JavaScript™)
      Returns the privileges of a person, group, or server in a database.
    - queryAccessRoles (NotesDatabase - JavaScript™)
      Returns the roles of a person, group, or server in a database.
    - remove (NotesDatabase - JavaScript™)
      Permanently deletes a database.
    - removeFTIndex (NotesDatabase - JavaScript™)
      Removes a full-text index from a database.
    - replicate (NotesDatabase - JavaScript™)
      Replicates a local database with its replica(s) on a server.
    - revokeAccess (NotesDatabase - JavaScript™)
      Removes a person, group, or server from a database access control list.
    - search (NotesDatabase - JavaScript™)
      Given selection criteria for a document, returns all documents in a database that meet the criteria.
    - setOption (NotesDatabase - JavaScript™)
      Sets the value of a database option.
    - setUserIDForDecrypt (NotesDatabase - JavaScript™)
      After calling this method on a database, any document that is opened within the database is decrypted using the encryption keys within the userID object, as specified in the document SecretEncryptionKeys field.
    - sign (NotesDatabase - JavaScript™)
      Signs elements in a database with the signature of the current user.
    - updateFTIndex (NotesDatabase - JavaScript™)
      Updates the full-text index of a database.
  - NotesDateRange (JavaScript™)
    Represents a range of dates and times.
  - NotesDateTime (JavaScript™)
    Represents a date and time.
  - NotesDbDirectory (JavaScript™)
    Represents the Domino® databases on a server or the local computer.
  - NotesDirectory (JavaScript™)
    Represents the Notes® directories on a specific server or local computer, each of which is associated with one or more directory navigators to allow directory lookups.
  - NotesDirectoryNavigator (JavaScript™)
    Allows lookups of a specific associated Notes® directory on a specific server or local computer.
  - NotesDocument (JavaScript™)
    Represents a document in a database.
  - NotesDocumentCollection (JavaScript™)
    Represents a collection of documents from a database.
  - NotesDxlExporter (JavaScript™)
    Represents the conversion of Domino® data to DXL (Domino XML). Note This class is new with Release 6.5.
  - NotesDxlImporter (JavaScript™)
    Represents the conversion of DXL (Domino® XML) to Domino data. Note This class is new with Release 6.5.
  - NotesEmbeddedObject (JavaScript™)
    Represents any one of the following: An embedded object An object link A file attachment Note Embedded objects and object links are not supported for OS/2, UNIX™, and the Macintosh. File attachments are supported.
  - NotesForm (JavaScript™)
    Represents a form in a database.
  - NotesIDVault (JavaScript™)
    The NotesIDVault class is a representation of the secure storage facility for UserIDs that may be configured for Domino by policy. IDs are stored there to allow for easier management by administrators and users. IDs from more than one server may be stored within an IDVault. The NotesIDVault class provides methods to access UserID files, UserID objects, query the presence of an ID in the vault, sycnronise copies of IDs, and reset passwords. The NotesIDVault class can be used to access UserID objects or files. These can be used to accomplish the encryption or decryption of Documents while running on the server.
  - NotesInternational (JavaScript™)
    Represents the international settings in the operating environment, for example, the Regional Settings in the Windows™ Control Panel. When settings change in the operating environment, Notes® recognizes the new settings immediately. For remote (IIOP) operations, these settings represent the session's server.
  - NotesItem (JavaScript™)
    Represents a discrete value or set of values in a document. The client interface displays items in a document through fields on a form. When a field on a form and an item in a document have the same name, the field displays the item (for example, the Subject field displays the Subject item). All items in a document are accessible programmatically, regardless of what form is used to display the document in the user interface.
  - NotesLog (JavaScript™)
    Enables you to record actions and errors that take place during a program's execution. You can record actions and errors in: A Domino® database A mail memo A file (for programs that run locally) An agent log (for agents)
  - NotesMIMEEntity (JavaScript™)
    Represents an item of type MIME (Multipurpose Internet Mail Extensions).
  - NotesMIMEHeader (JavaScript™)
    Represents a header in a MIME (Multipurpose Internet Mail Extensions) document.
  - NotesName (JavaScript™)
    Represents a user or server name.
  - NotesNewsletter (JavaScript™)
    Document or set of documents that contains information from, or links to, several other documents.
  - NotesNoteCollection (JavaScript™)
    Represents a collection of Domino® design and data elements in a database.
  - NotesOutline (JavaScript™)
    Represents an outline in a database.
  - NotesOutlineEntry (JavaScript™)
    Represents an entry in an outline.
  - NotesProperty (JavaScript™)
    Represents a single property in the Composite Applications properties of a Domino® application. Properties are data transmitted to or from the Property Broker, which routes your application's communication with other components in a composite application. Properties are defined in a Wiring Properties design element.
  - NotesPropertyBroker (JavaScript™)
    Mediates communication between components of a composite application, allowing communication between multiple Java™ components, or between Notes® and Java components.
  - NotesRegistration (JavaScript™)
    Represents the creation or administration of an ID file.
  - NotesReplication (JavaScript™)
    Represents the replication settings of a database.
  - NotesReplicationEntry (JavaScript™)
    Represents the replication settings for a pair of servers in a database.
  - NotesRichTextDoclink (JavaScript™)
    Represents a doclink in a rich text item.
  - NotesRichTextItem (JavaScript™)
    Represents an item of type rich text.
  - NotesRichTextNavigator (JavaScript™)
    Represents a means of navigation in a rich text item.
  - NotesRichTextParagraphStyle (JavaScript™)
    Represents rich text paragraph attributes.
  - NotesRichTextRange (JavaScript™)
    Represents a range of elements in a rich text item.
  - NotesRichTextSection (JavaScript™)
    Represents a collapsible section in a rich text item.
  - NotesRichTextStyle (JavaScript™)
    Represents rich-text attributes.
  - NotesRichTextTab (JavaScript™)
    Represents a tab in a rich text paragraph style.
  - NotesRichTextTable (JavaScript™)
    Represents a table in a rich text item.
  - NotesSession (JavaScript™)
    This class is the root of the Domino® Objects containment hierarchy, providing access to the other Domino objects, and represents the Domino server or Notes® client environment of the current program.
  - NotesStream (JavaScript™)
    Represents a stream of binary or character data. The stream can be associated with a file.
  - NotesUserID (JavaScript™)
    The NotesUserID class represents the Notes ID file or a Notes ID when it resides within the Domino IDVault. This object is primarily used to obtain the names of the private encryption keys which are available for use within the UserID object.
  - NotesView (JavaScript™)
    Represents a view or folder of a database and provides access to documents within it.
  - NotesViewColumn (JavaScript™)
    Represents a column in a view or folder.
  - NotesViewEntry (JavaScript™)
    Represents a view entry.
  - NotesViewEntryCollection (JavaScript™)
    Represents a collection of view entries of type document sorted in view order.
  - NotesViewNavigator (JavaScript™)
    Represents a view navigator. A view navigator provides access to all or a subset of the entries in a view.
  - NotesXSLTResultTarget (JavaScript™)
    Contains the result of a transformation by the XSL processor.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.

getDB2Schema (NotesDatabase - JavaScript™)

Gets the DB2® Schema of the current database.

Defined in

Syntax

getDB2Schema() : string


Return value	Description
`string`	The DB2® schema of the current database. The empty string (`""`) is returned if the database is a non-DB2 database.