database (Domino DTD)

For more details on database settings, see Database Properties box - Advanced tab.

Containment Hierarchy

Contains: <databaseinfo>, <acl>, <fulltextsettings>, <launchsettings>, %note.types;

Syntax

<!ELEMENT database ( databaseinfo?, acl?, fulltextsettings?, launchsettings?, (%note.types;)* )>

Content

databaseinfo?, acl?, fulltextsettings?, launchsettings?, (%note.types;)*)

Contains an optional <databaseinfo> element, followed by optional <acl>, <fulltextsettings>, and <launchsettings> elements, then any number of the contents of the %note.types; entity.

Attributes

<!ATTLIST database

>

advancedtemplate

If true, lists the database as an advanced template in the New Database dialog box. Advanced templates are displayed when you click the Show advanced templates check box in the New Database dialog box at the time of database creation.

allowbackgroundagents

If true, allows agents that are scheduled or triggered by an event to run. Domino checks the security restrictions of all agents that run in the background before running them. Set this attribute to false if you are doubtful of the security authorizations that users of your database might have.

allowdesignlocking

If true, enables designers working on a team to lock a design element, such as a view or form, so that no other designers can edit it. The designer locks an element by highlighting it in the work pane, right-clicking it, and choosing Lock from the pop-up menu.

allowdocumentlocking

If true, locks any documents that users are editing and unlocks it when they save and close it. Also enables you to explicitly lock and unlock documents to prevent duplicate work, unauthorized design changes and other conflicts.

allowexternalconnections

If true, allows a field on a form to interact with an external data source. This setting does not appear on the Database Properties box unless a Data Connection Resource has been created.

allowheadlinemonitors

If true, allows subscription databases to monitor new postings in this database. Subscription databases are created by users who want to be informed of updates, changes, or news associated with specific databases. Users create subscription profiles that outline those databases and topics which are of interest to them. Several users monitoring a database negatively affects its performance.

allowsoftdeletion

If true, retains deleted documents in the database for a specified number of hours before permanently deleting them. Specify the number of hours to wait before permanently deleting a document in the softdeletionsexpirein attribute.

allowspecialhierarchy

If true, enables the @AllChildren and @AllDescendants formula language @functions to use specially stored hierarchical information to access documents in selection and replication formulas. Storing and maintaining this hierarchy information negatively affects database performance. Disabling this attribute does not affect the hierarchical structure of views that do not use the aforementioned @functions to display their entries.

allowstoredforms

If true, allows a designer to store the form that creates a document in that document. This setting can require up to 20 times more disk space, having a negative effect on database performance. Set this attribute to true if the resulting documents will be mailed to databases that do not contain the form or the alias for the form necessary to view it, or if the form contains an OLE object or subscription that you want to capture any updates to, or if you want the form's static text to be searchable.

categories

Name of the category under which the database appears in the Database Catalog.

copyprofiledocswithdesign

If true, propagates to databases created from the template specified on the Design tab of the Database Properties box any profile documents within the template.

defaultlanguage

For multiple language databases, indicates the default language to display the database contents in. This attribute is only evaluated if the multilingual attribute equals true.

defaultregion

Further specifies the language based on the region that the database targets. For example, English is the default language, you can specify the default language from among: England, United States, New Zealand, Ireland, and others. This attribute is only evaluated if the multilingual attribute equals true.

fromtemplate

Name of the template that the database inherits its design from.

imageloadsdeferred

If true, displays a document's text before displaying its images, when viewed through the Notes client. By default, Notes displays the first item it encounters on the document; if that item is a large image, the document can be slow to display. Display setting for images in documents accessed by the Web are determined by the Web browser used to view them.

increasemaxfields

If true, increases the number of fields the database can contain from the standard of having a maximum total length for all field names of approximately 64K to allowing for up to 64K of uniquely-named fields.

logtransactions

If true, keeps a log of all transactions that occur in your back-end database. Logging is important because it enables you to recover databases after a system failure. You might want to disable logging for a database that stores only attachment files, for instance, since changes to those files are not recorded as transactions.

maintainunread

If true, maintains unread marks. Maintaining unread marks uses up substantial system resources. You might want to disable unread marks in databases that are continually updated, such as a log or directory database.

markmodifiedunread

If true, continually marks documents that have been updated since last viewed as unread.

maxrevisionentries

Maximum number of edit sessions to archive in the $Revisions field on a form. The $Revisions field stores the date and time of each document editing session and is used to resolve replication or save conflicts. By default, the field stores up to 500 edit sessions, each of which requires 8 bytes of disk space. You can set this field to store fewer sessions in order to conserve disk space. Once the limit is met, Domino deletes the oldest entry and adds the newest entry.

maxupdatedbyentries

Maximum number of edit sessions to archive in the $UpdatedBy field on a form. The $Updatedby field stores the name of the user or server associated with each document editing session. You can conserve disk space by decreasing the maximum number of edit sessions stored in this field.

multidbindexed

If true, indicates that the current database is included in the multiple database index for searching purposes.

multilingual

If true, indicates that this database is available in more than one language. Specify the default language, region, and sorting order in the defaultlanguage, defaultregion, and defaultsortorder attributes respectively.

nourlopen

If true, prohibits users from using URL commands in the browser to self-navigate your Web application.

optimizetablebitmaps

If true, internally maintains a record of the forms associated with all documents in a view. If this form-document association is known to Domino when a view is updated, the update can occur much faster. There is some performance cost to maintaining this association, but the increased speed with which view can be updated, especially small views in large databases, make the cost worthwhile.

overwritefreespace

If true, overwrites deleted data with a pattern that prevents unauthorized users from using a utility to access the deleted data. You can set this attribute to false for databases that are already secure, that automatically reallocate deleted space, or in which security is not an issue, such as in an informal discussion database.

path

Full path showing the location of the database.

requiressl

If true, indicates that the database requires SSL certification to be accessed by a user. SSL stands for Secure Sockets Layer, which is a security protocol that protects data by encrypting it as it passes between servers and Web clients. Web users must have an SSL certificate in their browser configuration to be able to access SSL-protected databases.

savelastaccessed

If true, updates the Accessed property of a document, which indicates the date on which a document was last modified, even if the document was only read and not edited. This setting uses substantial system resources to maintain.

showinopendialog

If true, displays the database in the list of available databases for a given server in the Open Database dialog box which displays when a user selects File - Database - Open (or Ctrl+O) from the menu. If you want to deter users from accessing this database, set this attribute to false. The database can still be accessed by manually entering its file name in the Filename field of the Open Database dialog box.

singlecopytemplate

If true, databases created from this template reference the design elements within the template but do not get their own copies of the design elements. The template and the databases created from the template must be on the same server.

softdeletionsexpirein

Number of hours to retain deleted documents in the database before permanently deleting them. This attribute is only evaluated if the allowsoftdeletion attribute equals true.

templatename

Name of the template, if the database is used as a template.

title

Database title.

type

Type of database from the options defined in the Defined entities for <database> element entity.

unicodestandardsorting

If true, enables you to sort a multilingual database in Unicode standard format. For more information on Unicode sorting, go to http://oss.software.ibm.com/icu/.

usejavascriptinpages

If true, allows for pass-thru JavaScript to be included in design elements. Some of the benefits of this are that hotspot formulas are evaluated only when the hotspot is clicked, you can add multiple buttons to a page or form, and some of the formula language @commands that would not function on the Web otherwise are supported. For more details, see the topic Creating formulas and buttons for the Web.

uselz1

If true, specifies that database attachments should be compressed using the LZ1 algorithm instead of the Huffman algorithm. Huffman passes over the attachment twice, the first time to create an encoding tree, and the second time to encode the file. LZ1 handles a limited window of the file at a time, creating a dictionary of repeating byte patterns. It does not save the dictionary but, instead, uses it to encode the attachment on the fly.

Defined entities for <database> element

The %database.types; entity defines the types of databases that can exist on a Domino server.

Syntax:

<!ENTITY % database.types "standard | library | addressbook | lightaddressbook | multidbsearch | portfolio | imapproxy | subscriptions | mailbox | personaljournal | mailfile ">

addressbook

Functions as the personal address book for users, storing information about the people, companies, and server computers they communicate with.

imapproxy

Enables a user to access, read, and manipulate messages received or sent from a mailbox on an IMAP server. This database is automatically created when a user creates and saves an Internet Account document. The template name is imapcl5.ntf.

library

Functions as a document storage database that enables review workflow and archiving. The template name is doclbw6.ntf.

lightaddressbook

Represents the Domino Directory catalog, which is a directory of all the databases in an enterprise. The template name is dircat5.ntf.

mailbox

Holds mail that is in transit to other servers or users, as well as undeliverable mail. This database is automatically created on a server the first time the router task is run and is automatically created on a workstation when a user sets the location document to accept Workstation-based Mail. The template name is mailbox.ntf.

mailfile

Database that sends and receives electronic mail via Domino. Also has calendaring and scheduling features. The template name is mail6.ntf or mail6ex.ntf for the extended template.

multidbsearch

Search site database that you can use to search across multiple databases. The template name is srchsite.ntf.

personaljournal

Functions as an electronic diary, enabling users to write and organize private ideas and documents. The template name is journal6.ntf.

portfolio

Stores bookmarks to Notes databases. The template name is bookmark.ntf.

standard

Created from the "blank" database design template. A standard database contains all the standard design elements of a Notes database and can be built into any type of application using Domino Designer.

subscriptions

Updates a user on activity, news, and new postings created in databases of interest to the user, that reside on a server the user has access to, and that allow for subscriptions. Users define which databases and types of information they want to be updated on by creating a subscription profile. The template name is headline.ntf.

The %design.elements; entity maps to the various design elements in Domino Designer. This entity is used in the %note.types; entity.

Syntax:

<!ENTITY % design.elements "form | subform | page | frameset | view | folder | sharedfield | sharedactions | imageresource | appletresource | agent | agentdata | scriptlibrary | databasescript | helpusingdocument | helpaboutdocument | dataconnection ">

The %note.types; entity defines the basic types of notes or root elements in a Domino database. A %note.classes; entity differs from a %note.types; entity in that a note's class is determined by a value stored in the note's header; its type is determined first by its class and is then further specified by the presence or absence of a specific item within the note. For instance, agents and scripts both belong to the FILTER class; yet their note types differ based on the value of the item called $Flags, which they each contain.

Syntax:

<!ENTITY % note.types "note | document | profiledocument | %design.elements;">

Example