Before you customize a place, you should have a basic understanding of place architecture. Although IBM® Lotus® Quickr™ has its own metaphors and object model independent of IBM Lotus Domino®, places are implemented using core Lotus Domino technology and data structures.
A place is created using Lotus Notes® templates to structure data, and databases to store the data. Information in a place is stored in data notes -- the basic unit of information in an IBM Lotus Notes database. The structure of a place is further defined with objects such as rooms, folders, and pages that correspond to Lotus Domino objects. Because the place objects are based on Lotus Domino objects, you can use the Lotus Notes client and Domino Designer to view, customize, and create new objects in a place.
Lotus Quickr also uses a subset of the Lotus Domino and Lotus Notes security and authentication model to manage access to a place. It is helpful if you are familiar with the Lotus Notes security model, in particular with basic access control list (ACL) settings, and the use of Reader and Author fields. For up-to-date information on Lotus Notes application security, see the latest Domino Designer Help at http://www.ibm.com/developerworks/lotus/documentation/dominodesigner/.
Place building blocks
When you create a place, you are actually creating several Lotus Notes databases (NSF files). Databases are created from Lotus Notes templates (NTF files). Templates are like blueprints for databases. Templates contain the forms and fields that define a database built from that template. These forms and fields define the look of the database and how the database processes and stores data. Templates allow for a controlled development environment. A developer can change a template, then push these changes out to any databases on the server that were created from that template. In Lotus Quickr, a template is called a PlaceType.
The HaikuCommonForms.ntf template is a central repository for forms used by other templates. This reduces the overhead in a Lotus Quickr service, allowing for smaller databases, faster creation of a place, and better performance resulting from more efficient server caching.
For more information on Lotus Notes templates and databases, see the Domino Designer Help, available http://www.ibm.com/developerworks/lotus/documentation/dominodesigner/.
Table 1 describes the databases that are the building blocks of any place.
Table 1. Databases that make up places
|Place database (Main.nsf)||The parent database in any place, created from the Notes® templates, MeetingRoom.ntf. All other databases in the place are children of the place database. |
|Members Directory database (Contacts1.nsf)||Contains data on place members and their access levels and is created from the Notes template, Contacts.ntf. |
|Room database||Sructures the contents of a particular room in a place. The default room PlaceType is PageLibrary.ntf, which provides indexing infrastructure for maintaining the pages in a room. This PlaceType also provides security and authentication features so that access to a room can be limited to a subset of team members. The database created from the PageLibrary PlaceType is assigned a unique name by the system to allow for multiple rooms within a place. |
When administrators log in to the server and use the Site Administration
link, they are actually using a place to administer and secure the server. The administrator's place is created from the templates CreateHaiku.ntf and Admin.ntf.
Relationship between Lotus Quickr and Lotus Domino objects
Table 2 shows the relationship between Lotus Quickr objects and Lotus Domino objects.
Table 2. Relationship between Lotus Quickr and Lotus Domino objects
|Lotus Quickr Object||Lotus Domino Object||Description|
|Place||File system directory||Organizes pages in rooms and folders.|
|PlaceType||A collection of database (.nsf) or Notes template (.ntf) files derived from a parent place.||The structure and design used to create a particular type of place. For example, the default place is Main.nsf, which is created from the MeetingRoom.ntf template. MeetingRoom.ntf is a PlaceType.|
|Room||Notes database (.nsf)||A collection of pages with its own security and authentication protection.|
|RoomType||Notes template (.ntf)||The structure and design used to create a particular type of room.|
|Folder||Domino folder or view||An organizing structure for collecting and displaying related pages in a site.|
|Page||Domino form + subform + data note||The basic vehicle for content. You can create content using the Lotus Quickr editor or import content from an external source.|
|Member||Domino data note||A member note contains information about a team member of a place. |
|Form||Data note of type "h_Form"||Manages the display of data notes. A form can contain fields for containing data and employ scripts to process and compute data.|
|Field||Data note of type "h_Field"||Allow for user input of data into data notes.|
File directory structure
Lotus Quickr data is stored within the directory domino_data_root
\LotusQuickr. Table 3 describes the contents of the LotusQuickr subdirectory.
Table 3. Contents of LotusQuickr subdirectory
|domino_data_root\LotusQuickr\AreaTypes||Contains the templates used to create places and rooms.|
|domino_data_root\LotusQuickr\lotusquickr||Contains administrator place files. All places are created from the administrator's place.|
|domino_data_root\LotusQuickr\place||Contains the files of a particular place. place represents the name of the place.|
Parent topic: Customizing services for Lotus Domino