The Place Catalog contains data on IBM® Lotus® Quickr™ servers, and the places, rooms, and members on those servers. Each server, place, and room has a separate entry in the Place Catalog. An entry is implemented as an IBM Lotus Notes® document.
The Place Catalog enables administrators to use the qptool report
command, or an XML interface to the Lotus Quickr Java XML API, to report statistics on places and servers. It enables place members to use My Places to see a list of places they belong to and statistics about those places, as well as to search content across places and servers.
A room entry in the Place Catalog is labeled as a place entry. However, it shows statistics for the room only.
The following figure shows an example of a Catalog entry for a place named "place1:"
The following figure shows a Place Catalog entry for a Lotus Quickr server called "server1.acme.com."
How entries are updated
Some events cause immediate updates to the Place Catalog, while others cause updates only after the qptool placecatalog -push
command is run. By default, a server notes.ini file includes the setting ServerTasksAt3=qptool placecatalog -push -a
so that the command runs daily at 3 A.M.
The following place and room statistics are updated through qptool placecatalog -push
The following table describes the events that cause immediate updates to the Place Catalog:
Table 1. Events that are create or update Place Catalog entries in real time
|Server registration or unregistration||A server becomes part of the service when qptool register -server command is issued, or when a place is created on the server. When a place is created, an entry for the server is immediately created in the Catalog if one does not already exist. Similarly, when qptool unregister -server is issued, the entry for the server is immediately removed from the Catalog.|
|Place removal by qptool unregister||The server's place entry is removed. If the place is part of a Lotus Quickr server cluster with a virtual server, the virtual server place entry is also removed.|
|Place creation from a browser or by qptool register||A new entry is created. The Place Catalog server must be running for users to create new places in the service.|
If the place is created on one server in a cluster, an entry for the virtual server is also created.
|Place creation on a cluster server node by qptool replicamaker||A place entry for that server cluster node is created.|
|Place deletion from a browser or by qptool remove ||The place's entry is deleted. Its name cannot be used for a new place until the qptool remove -cleanup command has run, either automatically overnight, or manually by the administrator. In a cluster environment, this would have to be done on all cluster nodes.|
|Place deletion in a cluster server node by qptool remove -cleanup ||The place's entry for that server node is deleted from the catalog.|
|Member creation ||The new member is added to the place entry with the proper access level.|
|Member removal||The member is removed from the place entry.|
|Member access change||The member moves to the field appropriate to their new access level. |
|Place accessed||The PlaceLastAccessed field is updated, which can take up to a minute. |
|Place login||The LoginCounts field value is incremented. |
|Document read||The DocReadCounts field value is incremented. |
|Posting||The PostingCounts field value is incremented.|
|Place locking by qptool lock||The PlaceIsLocked field of the Place Catalog entry is set to 1. If the place is in a cluster with a virtual server, the PlaceIsLocked field in the virtual server entry is also set to 1.|
|Place unlocking by qptool unlock||The PlaceIsLocked field of the Place Catalog entry is set to 0. If the place is in a cluster with a virtual server, the PlaceIsLocked field in the virtual server entry is also set to 0.|
You can use the qptool placecatalog -reset
command to reset the place login, document read, and posting values to 0.
Parent topic: Configuring the Place Catalog