Академический Документы
Профессиональный Документы
Культура Документы
Version 7.0
for Windows, AIX, Solaris, and i5/OS
Administrator’s Guide
G210-1999-00
Lotus QuickPlace
®
Version 7.0
for Windows, AIX, Solaris, and i5/OS
Administrator’s Guide
G210-1999-00
Note
Before using this information and the product it supports, read the information in “Notices” on page 149.
Contents v
Users are unable to sign in offline . . . . . 137 Offline users can’t send e-mail from a place . . 140
User installing offline using Sun ONE Portal Database authorization failures occur during
Server is prompted to reauthenticate . . . . 138 Domain Catalog indexing when server is set up
Users can’t install places offline in a Netegrity for Search Places and offline use . . . . . . 140
SiteMinder environment . . . . . . . . . 138 Troubleshooting Sametime problems. . . . . . 140
Users see ERROR 500 message when installing Users can’t schedule meetings from a place . . 141
offline . . . . . . . . . . . . . . . 138 Sametime is not working for local users . . . 141
A PlaceBot does not run offline . . . . . . 139 Online awareness not working for users whose
Offline users can’t edit their member profiles names contain accented characters . . . . . 141
when Sametime is enabled and the place name External users with flat names cannot join
begins with ″QuickPlace″ . . . . . . . . 139 online meetings that they publish . . . . . 141
Users with flat names can’t take places offline 139
Users who install offline to Windows 2000 client Appendix A Lotus QuickPlace
are prompted for Web Application password . . 139 notes.ini Settings. . . . . . . . . . 143
Offline not working for external users after
Web page cache settings . . . . . . . . . . 143
changemember or changehierarchy commands
Offline settings . . . . . . . . . . . . . 143
used . . . . . . . . . . . . . . . 139
Server logging settings . . . . . . . . . . 143
Offline is not working for a super user . . . . 139
Client logging settings . . . . . . . . . . 145
Offline users can’t use places and rooms
Attachment and file import logging . . . . . 146
accessed through group membership . . . . 139
Other settings . . . . . . . . . . . . . 146
Offline authors or readers see synchronization
errors . . . . . . . . . . . . . . . 139
Problem installing places offline on Windows 140 Notices . . . . . . . . . . . . . . 149
Cannot install places with the same name from Trademarks . . . . . . . . . . . . . . 150
two different servers . . . . . . . . . . 140
Users who do not fill in offline passwords Index . . . . . . . . . . . . . . . 151
cannot install places offline . . . . . . . . 140
Administration overview
Lotus QuickPlace is a self-service Web tool for team collaboration that you can use
to publish, share, and track all information relevant to a project. Teams can use
Lotus QuickPlace to store resources (such as files, discussions, and schedules)
related to a project in a common place where everyone can access the latest
information.
Note: The e-mail notification features of Lotus QuickPlace rely on the mail routing
configuration of the local IBM® Lotus® Domino® server. For information on
configuring mail routing with Domino, see Domino Administrator Help. For
additional information on customizing Lotus QuickPlace e-mail notifications,
see the chapter ″Completing Additional Server Configuration Tasks.″
If you upgrade from an earlier version of Lotus QuickPlace, the upgrade process
preserves the existing external LDAP directory connection managed by Lotus
QuickPlace. If you want to switch to Domino management of user directory
lookups, you can make this change at any time.
CAUTION:
Once you have switched to Domino management of user directory lookups,
reverting back to the Lotus QuickPlace management of LDAP directory lookups
is not supported.
For more information on this new supported configuration, see the chapter
″Connecting to a User Directory.″
For more information, see the appendix ″Lotus QuickPlace notes.ini Settings.″
For more information, see the Lotus QuickPlace Installation and Upgrade Guide.
i5/OS documentation
The Lotus QuickPlace Administrator’s Guide, the Lotus QuickPlace Installation and
Upgrade Guide, the Lotus QuickPlace Developer’s Guide, and the Lotus QuickPlace
Release Notes now incorporate information for IBM® iSeries™ (i5/OS™). The
installing and managing guide and the Readme files specifically for iSeries no
longer exist for Lotus QuickPlace 7.0.
Access control in Lotus QuickPlace has been changed in the following ways to be
more like Domino access control:
v Managers can edit and delete all documents in a place, even if access has been
restricted by the document author.
v Default and Anonymous users are now assigned distinct levels of access to a
place. Anonymous users -- users who are not members of a place through
individual or group membership and who access places without authenticating
-- are assigned the Anonymous level of access, instead of the Default level.
Authenticated non-members are assigned the Default access level. You specify
these two access levels by adding Anonymous and Default as place members.
Anonymous can have only reader access, whereas Default can have reader,
author or editor access.
Nested folders
In previous versions of Lotus QuickPlace, folders could contain only documents.
Now folders can contain other folders (subfolders). If you the new themes, you can
access these subfolders through the table of contents. If you use any of the themes
previously available in Lotus QuickPlace, you can access these subfolders through
the folder list.
Offline passwords
Users can now use their Lotus QuickPlace sign in passwords for offline places.
Users are no longer required to set or remember a password for each offline place
to which they belong.
Offline encryption
Offline Lotus QuickPlaces can be encrypted whenever an offline place is created or
synchronized. An administrator can set the encryption server-wide, while a place
manager can set the encryption for a specific place.
Improved My Places
In earlier versions of Lotus QuickPlace, when a user displayed the places of which
he or she was a member, the performance was poor if a user belonged to a large
number of places. In Lotus QuickPlace 7.0, the performance has improved. In
addition, a Last Update column has been added, and the places may be sorted by
any of the columns (size, title, last updated date, last modified date, name, or title).
In addition to these tools, you can use tools available in Domino, for example,
settings in the Domino Directory or directory assistance database.
QPTool commands
QPTool is a server task that you run with arguments to complete adminstration
tasks. You use QPTool commands to complete many administrative tasks, for
example, locking and unlocking places, changing user names, and registering
places.
qpconfig.xml file
You can specify many Lotus QuickPlace configuration settings by creating a file
called qpconfig.xml and using XML to specify the desired settings in the file. Lotus
QuickPlace comes with a sample template file called qpconfig_sample.xml, which
is installed in the server data directory. The file includes all of the settings you can
specify in the qpconfig.xml file, descriptions of the settings, the default values, and
sample values.
Note: All Lotus QuickPlace servers in a cluster should use the same qpconfig.xml
settings.
1. Create a file called qpconfig.xml and save it as a text file in the data directory.
2. Open the qpconfig.xml file using a text file editor.
3. Open the qpconfig_sample.xml and copy the following lines to the
qpconfig.xml file.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!--
IBM Lotus QuickPlace Server Settings configuration
==================================================
If you modify this file, please restart the http server. The values are only
read during server startup.
-->
<server_settings>
</server_settings>
4. Between the two server_settings statements, copy the sample section from the
qpconfig_sample.xml file that contains the settings you want to modify and
paste the section into the qpconfig.xml file. For example, to modify super_user
settings, copy the text noted in bold below from qpconfig_sample.xml to
qpconfig.xml:
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!--
IBM Lotus QuickPlace Server Settings configuration
==================================================
If you modify this file, please restart the http server. The values are only
read during server startup.
-->
<server_settings>
<super_user enabled="true">
<dn>cn=QuickPlace Admin,o=ibm</dn>
</super_user>
</server_settings>
Note: To change a child setting under a parent setting, make sure to copy the
parent setting, too.
5. Modify the values for copied settings as desired, for example, the distinguished
name of a super user, and then save the qpconfig.xml file.
6. Type the following command to restart the HTTP task so that Lotus QuickPlace
recognizes the changes:
restart task http
Tip: You can also perform this task using iSeries Navigator. For more information,
see Installing and Managing Domino 7 for i5/OS.
1. On any i5/OS command line, type the following command and press Enter:
wrkdomsvr
2. On the Work with Domino Servers display, type a 1 in the Opt column next to
the Lotus QuickPlace server you wish to start and press Enter.
3. If the server is password protected, type 8 next to the Lotus QuickPlace server
to work with the console, and press Enter.
4. Enter the password at the appropriate prompt.
5. Press F3 to exit the console.
Tip: You can also start a Lotus QuickPlace server by entering the following
command:
STRDOMSVR SERVER(servername)
where servername is the name of the Lotus QuickPlace server.
6. Periodically press F5 to refresh your screen and wait for the server status to be
*STARTED.
Note: Starting the Lotus QuickPlace server may take a few minutes. You can
verify that the HTTP task and the Lotus QuickPlace task have started by
displaying the console, which is option 5 from the Work with Domino
Servers display.
7. You can verify that the Lotus QuickPlace server has started by using a Web
browser to access the Lotus QuickPlace home page at the following URL:
http://DominoServerName:port/QuickPlace
Note: Specifying a port number is only required if the port defined for Lotus
QuickPlace is not the default port 80.
Tip: You can also perform this task using iSeries Navigator. For more information,
see Installing and Managing Domino 7 for i5/OS.
1. On any i5/OS command line, type the following command and press Enter:
WRKDOMSVR
2. On the Work with Domino Servers display, type a 6 in the Opt column next to
the Lotus QuickPlace server and press Enter.
Tip: You can also stop a Lotus QuickPlace server by entering the following
command:
ENDDOMSVR SERVER(servername)
where servername is the name of the Lotus QuickPlace server.
4. Periodically press F5 to refresh your screen and wait for the server status to be
*ENDED.
Note: Stopping the Lotus QuickPlace server may take a few minutes. You can
verify that all server jobs have ended by viewing the Work with Active
Jobs display, which is option 9 from the Work with Domino Servers
display.
5. From the Work with Domino Servers display, record the subsystem that is used
by the Lotus QuickPlace server.
6. On the command line, type the following command and press Enter:
WRKSBS
7. In the Opt column next to the subsystem you recorded in step 5, type a 4 and
press Enter to end the subsystem.
8. Press Enter to confirm your subsystem selection.
To sign in as an administrator:
1. Open a browser and enter the server’s host name appended by /QuickPlace.
For example:
http://servername.enterprise.com/QuickPlace
2. Click Sign In.
3. Enter a Lotus QuickPlace administrator user name and password.
4. Click Server Settings.
Use the backup and recovery commands and procedures for a Domino server to
back up your Lotus QuickPlace data. For more information, see Domino
Administrator Help.
Note: You can also remove Lotus QuickPlace from a Domino server on i5/OS
using commands. For more information, see the Lotus QuickPlace Installation
and Upgrade Guide.
Tip: You can also perform this task using iSeries Navigator. For more information,
see Installing and Managing Domino 7 for i5/OS.
1. On any i5/OS command line, type the following command and press Enter:
wrkdomsvr
2. The Work with Domino Servers display lists all the Domino servers configured
on your system. The Domino Status column indicates the status of the Lotus
QuickPlace server:
Status Meaning
*ENDED All server tasks have ended. The server is not active.
*ENDING The primary server tasks are ending.
*STARTED The server is running.
*STARTING The primary server tasks are starting.
*UNKNOWN The system cannot determine the status of the server.
Note: To confirm that all components have started, type a 5 in the Opt column to
display the Domino console. On the Display Domino Console display, look
for the message, ″QuickPlace Server started″ which indicates that all Lotus
QuickPlace components have started. You may need to press F5 periodically
to refresh the screen.
To change the dictionary that the spelling checker program uses, follow these
steps. You must have *JOBCTL special authority to perform this task.
Additional documentation
Refer to the following documentation in addition to this guide. This
documentation is available on the Web at http://www.lotus.com/ldd/doc. Under
″Documentation Links,″ click ″by product,″ and then click the appropriate product.
IBM Lotus QuickPlace Installation and Upgrade Guide -- Describes how to install
Lotus QuickPlace, how to set up a server so that users can take places offline using
Domino Off-Line Services, how to set up Lotus QuickPlace to work with IBM®
Lotus® Sametime®, and how to upgrade your existing servers.
IBM Lotus QuickPlace Developer’s Guide -- Describes the Lotus QuickPlace design
architecture, and describes how to create and customize place objects, how to
access the Java™ API using XML, how to automate tasks with PlaceBots, and how
to customize the look and layout of a place.
IBM Lotus QuickPlace Release Notes -- Describes system requirements, support for
backward compatibility with earlier versions, new features, workarounds for
known problems, and documentation updates for Lotus QuickPlace.
IBM Lotus Domino Administrator Help -- Describes how to install, configure, and
administer Lotus Domino.
IBM Lotus Notes, Domino, and Domino Designer Release Notes -- Describes software
requirements, new features and enhancements, troubleshooting tips, and
documentation updates for Lotus Notes, Domino Designer®, and Lotus Domino.
IBM Lotus Sametime Installation Guide -- Describes how to install Lotus Sametime on
each supported platform. You must install Lotus Sametime if you want to integrate
Lotus Sametime features with Lotus QuickPlace. For information on integration
Lotus Sametime with Lotus QuickPlace see the Lotus QuickPlace Installation and
Upgrade Guide.
In addition to the documentation listed above, the Help that comes with Lotus
QuickPlace describes end-user features. To access the Help, from any place, click
the Help button.
http://www.lotus.com/products/qplace.nsf
v The IBM eServer iSeries Information Center has details about installing, setting
up, and using TCP/IP. It also includes an overview of Client Access Express and
iSeries Navigator. The IBM eServer iSeries Information Center is available on the
Web at
http://publib.boulder.ibm.com/pubs/html/as400/infocenter.html
v The Lotus book Installing and Managing Domino for i5/OS has details on setting
up and managing Domino servers. It includes instructions on how to verify that
TCP/IP is set up and running on your server. It also has a basic introduction to
i5/OS for new users. You can view or download this book and the latest release
notes from the Lotus developerWorks Documentation Library at
http://www.ibm.com/lotus/ldd/doc
You can find other Domino for i5/OS information on the IBM Domino for i5/OS
Web site at
http://www.ibm.com/eserver/iseries/domino
v If you plan to also use Lotus Sametime, review the Lotus Sametime for i5/OS
Web site at
http://www.ibm.com/eserver/iseries/sametime
User directories
There are two types of place members: local members and external members. Local
members are registered in the membership database (Contacts1.nsf) of each place
of which they are a member. External members are registered in a user directory
on a server.
There are several advantages to using external members that are registered in a
user directory:
v Authentication information is managed in a central directory rather than in each
place.
v Place managers add members to places by selecting users and groups from the
directory, rather than typing information for each member.
v A user can be a member of many places and use the same user name and
password to access any of the places. Local members of many places might have
different user names and passwords in each place.
v Users can use single sign-on authentication to sign in to one place, and then
access other places they are members of without re-entering their user names
and passwords.
v If a member’s name or other information such as e-mail address changes in the
directory, you can use QPTool commands to automatically update places to
reflect the change. For example, if John Smith’s e-mail address changes in a user
directory, you can use the QPTool updatemember command to update his e-mail
address in all places.
v Lotus Sametime integration features are supported for external members only.
CAUTION:
Once you set up Domino management of user directory lookups, switching to
Lotus QuickPlace management of user directory lookups is not supported.
Note: When Domino manages user directory lookups, Lotus QuickPlace expanded
membership is not supported and Lotus Sametime integration with Lotus
QuickPlace is not supported.
CAUTION:
After you make this change, reverting to managing lookups through Lotus
QuickPlace is not supported.
1. Perform all of the steps described in the topic ″Setting up Domino to manage
user directory lookups.″ To use the same LDAP directory, set up directory
assistance for the LDAP directory.
Note: The distinguished names of users and groups should be unique. If there are
two identical distinguished names in the directory, only one of the names
can be added to a place as a member. If two distinguished names are
identical, add a middle initial or other distinguishing character to one of the
names to make each name unique.
1. Make sure the LDAP directory server is running.
2. Open a browser and enter the server’s host name appended by /QuickPlace.
For example:
http://servername.enterprise.com/QuickPlace
3. Click Sign In.
4. Enter a Lotus QuickPlace administrator user name and password.
5. Click Server Settings.
6. Click User Directory.
7. Click Change Directory.
8. In the Type field, select ″LDAP Server.″
9. In the Name field, type the host name of the directory server. For example,
elvis.acme.com.
10. In the Port number field, type the port number that the LDAP server uses to
communicate with other servers. The default is 389.
11. (Optional) Check ″Check for SSL connection with LDAP user directory.″ If you
select this option and SSL is configured correctly on the Lotus QuickPlace
server and the LDAP server, the Lotus QuickPlace server will initiate all
requests to the LDAP user directory as SSL encrypted requests.
12. (Optional) In the Search base field type a distinguished name that represents
the location at which to begin searches, for example, o=acme,
ou=sales,o=acme, or dc=acme,dc=com.
By default the Search base you specify applies to both user and group
searches. However, you can use the qpconfig.xml file to specify a different
search base for group searches.
For more information, see the topic ″Specifying a search base for group
searches.″
13. (Optional) Click ″Narrow searches to the place name″ to confine searches
launched from a place to user directory names that include the name of that
place.
Note: The LDAP server might also have time-out limits configured. In this
case, the effective time-out limits are whichever are lowest between the
Lotus QuickPlace server and the LDAP server.
16. Specify whether to allow place managers to add local members:
v To allow managers to register local members who are not listed in the user
directory, click ″Allow managers to create new users in each place.″
v To limit the members of places on the server to users who are listed in the
user directory, click ″Disallow new users.″
17. Click Next. Make sure to click Next, or your settings will not take effect.
To configure which attributes the Lotus QuickPlace server retrieves from the LDAP
directory to display information about users and groups, use the following
qpconfig.xml settings. When you are done making changes to the qpconfig.xml file,
save the file and then restart the HTTP task. The values in bold are ones that you
customize. The LDAP directory server must give the Lotus QuickPlace server
access to the attributes you specify. For information on testing access to attributes,
see the topic ″Access to the LDAP directory server″ later in this chapter.
For information on creating and specifying settings in the qpconfig.xml file, see the
chapter ″Lotus QuickPlace Administration Overview.″
<server_settings>
<user_directory>
<ldap>
<schema>
<object_class>objectClass</object_class>
<user>
<object_class_value>person</object_class_value>
<common_name>cn</common_name>
<display_name>cn</display_name>
<first_name>givenname</first_name>
<last_name>sn</last_name>
<email>mail</email>
<phone>telephone</phone>
</user>
<group>
<object_class_value>groupOfNames</object_class_value>
<common_name>cn</common_name>
<display_name>cn</display_name>
<member>member</member>
</group>
</schema>
</ldap>
</user_directory>
</server_settings>
For more information on creating and using the qpconfig.xml file, see the chapter
″Lotus QuickPlace Administration Overview.″
<server_settings>
<user_directory>
<ldap>
<search_filters>
<authentication>
<![CDATA[(I(cn={0})(uid={0})(shortname={0}))]]>
</authentication>
<user_lookup>
<![CDATA[(&(objectclass=person)(sn={0})(givenname={1}))]]>
</user_lookup>
<group_lookup>
<![CDATA [(&(objectclass=groupOfNames)(cn={0}))]]>
</group_lookup>
<group_membership>
<![CDATA [(&(objectclass=groupOfNames)(member={0}))]]>
</group_membership>
</search_filters>
</ldap>
</user_directory>
</server_settings>
For more information about LDAP search filters, see Domino Administrator Help.
For the matches that result from the search, each distinguished name and
password is passed to the user directory for verification. The first successful
verification sets the current user to that distinguished name.
Edit this line to customize the search filter used for authentication. For example, to
look for the name specified by the user first as a cn attribute value or a mail
attribute value, change the line as follows:
<authentication><![CDATA[(| (cn={0})(mail={0}))] ]></authentication>
Note that the zero (0) indicates that Lotus QuickPlace accepts only one name as
input for authentication. You cannot specify a different value to accept more than
one name for input.
This filter indicates that when a user searches for the name of an external user,
Lotus QuickPlace searches for the objectclass attribute value, person. It also
indicates that it accepts two, comma-separated values from a user who is searching
If you customize the user search filter, you should also customize the hint the
interface provides for searching and possibly other directory lookup user interface
settings.
For more information, see the topic ″Customizing the directory lookup user
interface″ later in this chapter.
Note that zero (0) and one (1) indicate the first and second, comma-separated input
values, respectively. Lotus QuickPlace does not accept more than two input values
from a user when searching for names to add to places.
Note: When a user adds an external user name to a place, the user can type the
name in the text area directly without clicking the Directory button and
searching for the name. To find the specified name in this case, the user
must specify a unique name in the directory. This unique name can be the
distinguished name or another form of the name, for example, Smith or
Smith, J. If the distinguished name is not specified, then the user lookup
search filter described above is used to search for the name.
This filter indicates that when a user searches for an external group, the Lotus
QuickPlace server searches for the objectclass attribute value groupOfNames. It also
indicates that the Lotus QuickPlace server accepts one name as input from a user
and that it searches for the group name as the cn attribute value. Edit this line to
customize the search filter. For example, to search for the objectclass value
groupOfUniqueNames and search for the grouptitle attribute, change the line as
follows:
<group_lookup><![CDATA [(&(objectclass=groupOfUniqueNames)(grouptitle={0}))]]></group_lookup>
The zero (0) indicates that Lotus QuickPlace accepts only one name as input for a
group name. You cannot specify another value and accept more than one group
name for input.
The zero (0) indicates that Lotus QuickPlace accepts only one name as input for
the group members. You cannot configure Lotus QuickPlace to accept more than
one.
The following table describes the search filter that Lotus QuickPlace uses when a
user searches for one value and for two comma-separated values, depending on
the Exact Match setting.
mail=* mail=@acme
Not selected sn=smi* sn=smi*
mail=* mail=@acme*
These settings apply only when you connect to an LDAP directory through Lotus
QuickPlace.
<server_settings>
<user_directory>
<ldap>
<member_lookup_ui>
<column_name>
<person>sn, givenname</person>
</column_name>
<column_disambiguate>
<person>dn</person>
</column_disambiguate>
</member_lookup_ui>
<search_ui_hint>
Note: These customizations apply only to user lookups and not to group lookups.
For example, if you specify the following in the <search filters> section of
qpconfig.xml:
<user_lookup><![CDATA[(&(objectclass=person)(sn={0})(mail={1}))]]></user_lookup>
you might then specify the following for in the <search_ui_hint> section:
<![CDATA[( enter <B>last name, email</B>)]]>
For example, to display the sn and mail attribute values in the first column, specify:
<person>sn, mail</person>
Any attributes you specify should be valid ones defined in the schema map.
For more information, see the topic ″Mapping to the Lotus QuickPlace schema″
earlier in this chapter.
You can also use the <search_ui_index> section to customize the attribute value
that shows in the range field in the results box. By default the value for the sn
attribute shows in the range.
For example, if the name in a user directory is cn=john doe, ou=sales, o=acme
(comma space delimiter), the name becomes cn=john doe/ ou=sales/ o=acme in a
place (slash space delimiter), but Netegrity SiteMinder passes the name cn=john
doe/ou=sales/o=acme to Lotus QuickPlace (slash delimiter).
If names in the directory do not use the same delimiter, use the following
dn_delimiter setting instead to enable Lotus QuickPlace to replace any single- or
multi-delimiter character with a forward slash, if the delimiter conforms to LDAP
RFC 3377.
<server_settings>
<user_directory>
<ldap>
<schema>
<dn_delimiter robust_compare="true"/>
</schema>
</ldap>
</user_directory>
</server_settings>
dn_incoming_is_native setting
When a third-party authentication application such as Netegrity SiteMinder finds a
distinguished name that contains components other than the cn, ou, and o
components familiar to Domino, it sends the name to Lotus QuickPlace without
adding the Domino-style forward slash delimiters. For example, if Netegrity
SiteMinder finds the name uid=sblake,o=acme in the directory, it passes that name
to Lotus QuickPlace rather than uid=sblake/o=acme. Because Lotus QuickPlace
uses the forward slash delimiters in the names in places, the naming inconsistency
causes authentication failures. This problem is indicated if there are authentication
failures and the Netegrity (or other application ) log shows that the names pulled
from the directory are in the same format as the ones sent to Lotus QuickPlace.
To correct the problem, use the following setting to indicate that Lotus QuickPlace
should convert ″native″ names to the Domino format:
<server_settings>
<user_directory>
<ldap>
<schema>
<dn_incoming_is_native enabled="true"/>
</schema>
</ldap>
</user_directory>
</server_settings>
secondary_cn_component setting
When the second component of a distinguished user name in a user directory is
cn, Lotus QuickPlace converts the component to ou by default. For example, if the
distinguished name of a user in an external directory is
uid=abrown,cn=users,dc=acme,dc=com, Lotus QuickPlace uses this name instead:
uid=abrown,ou=users,dc=acme,dc=com (and the Domino-formatted version,
uid=abrown/ou=users/dc=acme/dc=com). If you experience authentication
failures because of this behavior, correct the problem by specifying the following
setting to retain second cn components found in names:
<server_settings>
<user_directory>
<ldap>
<schema>
<secondary_cn_component enabled="true"/>
</schema>
</ldap>
</user_directory>
</server_settings>
To specify a search base for group searches, use the following setting in
qpconfig.xml, substituting the search base value in bold for the search base
desired. Restart the HTTP task when you are done making changes.
<server_settings>
<user_directory>
<ldap>
<base_dn>
<group>ou=groups,o=acme</group>
</base_dn>
</ldap>
</user_directory>
</server_settings>
For more information on creating and using the qpconfig.xml file, see the chapter
″Lotus QuickPlace Administration Overview.″
0 - Negotiated (default)
Note: To change to managing directory lookups through Domino, instead see the
topic ″Switching to managing user directory lookups through Domino.″
In this case, the Lotus QuickPlace server also must be configured to use these
credentials for LDAP searches in the Server Settings - User Directory room of the
administration place.
Note: This information does not apply to groups used for the expanded
membership feature.
The Place Catalog has two audiences: administrators and users. Administrators can
use the QPTool report command or an XML interface to the Lotus QuickPlace Java
XML API to access the Place Catalog to query information. Users access the Place
Catalog indirectly, through features such as My Places, which allows them to see
the places they belong to, and Search Places, which allows them to search in places
across the enterprise.
For information on how to access the Place Catalog with the Lotus QuickPlace Java
XML API, see the Lotus QuickPlace Developer’s Guide. For more information on the
QPTool report command, see the chapter ″Using QPTool Commands.″
For example, if your enterprise has several Lotus QuickPlace servers and you want
more than one to share a Place Catalog on a remote server, each Lotus QuickPlace
server must have its own qpconfig.xml which specifies the server and file name of
the Place Catalog. After you have set qpconfig.xml to point to the correct Place
Catalog server, you can delete the local Place Catalog database on the Lotus
QuickPlace server.
After you set up Place Catalog you must register any previously existing places.
You can set up one Place Catalog to service your enterprise, or set up several Place
Catalogs to service different areas of your enterprise. It is recommended that an
enterprise have a designated Place Catalog server (or servers) whose only purpose
is to contain the Place Catalog. Each Place Catalog server should be part of a
cluster with at least one failover server.
Note: Because the Place Catalog must uniquely identify a place by its name, two
different places cannot have the same name. When upgrading an existing
QuickPlace installation where two different places might have the same
name on two different servers, the administrator must first resolve the
conflict by unregistering one of the places, renaming its directory, and then
registering the place with the new name. For more information on the
QPTool register command, see the chapter ″Using QPTool Commands.″ For
more information on upgrading to a Lotus QuickPlace 7 enterprise, see the
Lotus QuickPlace Installation and Upgrade Guide.
Note: If a server is registered in the Place Catalog and you change the port,
protocol settings, or a URL prefix for the server, use ″qptool unregister
-server″ to unregister the server, then use ″qptool register -server″ to register
the server with the Place Catalog again so that place URLs are constructed
correctly. Or update the appropriate fields in the server’s PlaceServer
document manually in the Place Catalog.
To populate the Catalog with entries for servers, and for places that existed before
the Catalog was enabled, enter the following in the Domino server console:
For more information on registering places and servers with QPTool commands,
see the chapter ″Using QPTool commands.″
The following figure shows an example of a Catalog entry for a place titled ″Place
One.″
The following figure shows a Catalog entry for a Lotus QuickPlace server called
″server1.acme.com.″
It is essential that certain data be sent in real time to avoid conflicts. For example,
in a Lotus QuickPlace service there cannot be two places with the same name. The
creation of a new place is an event that creates a new Catalog entry in real time.
The following events create or update Place Catalog entries in real time:
Event Description
A Lotus QuickPlace server is registered in, A server becomes part of the service when
or unregistered from, the Lotus QuickPlace qptool register -server command is issued, or
service. 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.
Removal of a place from the service by The server’s place entry is removed. If the
qptool unregister. place is part of a Lotus QuickPlace server
cluster with a virtual server, the virtual
server place entry is also removed.
The following data can be updated using the QPTool placecatalog -push command
or on a schedule on the Lotus QuickPlace server.
Event Description
Place size. The PlaceSize field is updated.
Dates and times the place was last modified. The PlaceLastModified field is updated.
To update the PlaceSize and PlaceLastModified data on a particular place, enter the
following commands from the server console:
Or to update the the PlaceSize and PlaceLastModified fields at 2 AM, add the
appropriate command line entry from the preceding table to the ServerTasksAt2=
line in the server’s NOTES.INI file. Or, if you want multiple servers in the Lotus
QuickPlace/Domino domain to share the schedule, create a server program
document in the Domino Directory of the Lotus QuickPlace domain. For more
information on creating a server program document, see Domino Administrator
Help. For more information on QPTool commands, see the chapter ″Using QPTool
Commands.″
CollationName Code
Japanese ja
Korean ko
Simplified Chinese zh-cn
Traditional Chinese zh-tw
You must restart the server. Then open the Place Catalog database in Notes and
press CTRL+SHIFT+F9 to re-index the views.
When the Place Catalog server starts again, use the QPTool placecatalog -push -p
command on the Lotus QuickPlace server to update these fields:
v PlaceSize
v PlaceLastAccessed
v PlaceLastModified
Note: It’s important to keep Place Catalog servers highly available. For
information on creating a cluster of Place Catalog servers, see the chapter
″Administering Lotus QuickPlace Servers in a Cluster.″ No places should be
included in a cluster of Place Catalog servers.
PlaceTypes
As you set up a place to meet the needs of your team or organization, you may
want to preserve your customizations for use in other places. For example, if a
manager has created a theme that gives a particular place the look and feel of your
corporate Web site, you may want to make that design available for the creation of
other places in your organization.
You can preserve the design and content of a place by creating a PlaceType. A
PlaceType is a blueprint from which users can create places. You can take a
snapshot of a place and make it a PlaceType. Also, you can control the design and
content of a child place by refreshing it with updates from the PlaceType.
Creating a PlaceType
To create a PlaceType:
1. Sign in to the Lotus QuickPlace home page as an administrator.
2. Click PlaceTypes in the table of contents.
3. Click Create PlaceType.
4. Type a name for the PlaceType. The name you type appears in the list of
PlaceTypes a users see when they create places.
5. Select the name of the place you want to use as a PlaceType.
The manager of the place must have allowed the place to be a PlaceType and
specified the design elements that are preserved in the PlaceType. For more
information, see the Help.
6. Click Next.
Note: Users cannot create a PlaceType from a place that uses expanded
membership.
For example, a Lotus QuickPlace developer creates a new place called ″Sales″ and
gives it the look and feel you want to appear in places created by the Sales team.
The developer allows it to be a PlaceType, and you create a PlaceType from it
called ″Sales PlaceType.″ To test it, you create a place called ″Sales Test″ from
″Sales PlaceType.″ If you want to change some design elements, you can ask the
developer to change the elements in ″Sales,″ then refresh ″Sales PlaceType,″ then
refresh ″Sales Test.″ ″Sales PlaceType″ inherits from ″Sales,″ and ″Sales Test″
inherits from ″Sales PlaceType.″
The QPTool refresh command refreshes places and PlaceTypes. By default, QPTool
refresh runs daily at 4 AM to refresh all child places (not including PlaceTypes) on
the server. The place manager can control whether QPTool refreshes a place. To
refresh a PlaceType, administrators can initiate the refresh command from the
administration PlaceTypes room or use the traditional method for running QPTool
commands.
Note: When you refresh a place or PlaceType in a cluster, do the refresh on one
server only and then let the changes replicate to the other servers.
For more information on the QPTool refresh command, see the chapter ″Using
QPTool Commands.″
Place membership
If the place manager allows it, membership of a place can be passed to a PlaceType
when the PlaceType is created. That membership is then passed to new places
created from the PlaceType. For example, if Annie was a member of ″Sales″ with
Author access, she became an Author in ″Sales PlaceType″ and ″Sales Test″ when
they were created.
However, changes to members and membership are not inherited when you
refresh. For example, if the manager of ″Sales″ changes Annie’s access to Reader in
″Sales,″ when you refresh ″Sales PlaceType″ and ″Sales Test,″ Annie still has Author
access in ″Sales PlaceType″ and ″Sales Test.″
CAUTION:
When a new room is inherited, membership to the room is not inherited, but
instead is determined by the room’s parent room in the place. For example, to
continue the preceding example, assume that the manager of ″Sales″ adds a new
room called ″Finances″ and gives only herself access to read sensitive
information in it. When ″Sales PlaceType″ and then ″Sales Test″ are refreshed,
″Sales Test″ inherits the room ″Finances″ but all ″Sales Test″ members with
Reader access or above can read ″Finances″ unless the ″Sales Test″ manager
changes access.
A replace occurs only when you use QPTool refresh command with the -r
argument. Use replace with extreme caution because it causes all elements in a
place that originated from a PlaceType to be updated, even elements modified
directly in the place.
Neither basic refresh nor replace modifies elements that were created directly in a
place rather than originating from a PlaceType.
Because changes to a PlaceType are never made directly in a PlaceType but instead
can occur only through a refresh, it makes no difference which level of refresh you
use to refresh PlaceTypes.
Refresh effect
on element in Refresh effect on
Element place if element element in place if Refresh effect on element
modified in not changed in element changed in in place if element
PlaceType place place deleted in place
Page Updated No change No change
Folder Updated No change No change
Room Updated No change No change
Form Updated No change No change
Field Updated No change No change
Theme Updated No change No change
PlaceBot Updated No change No change
Room Setting Updated No change No change
Aesthetic Settings Updated No change No change
Member No change No change No change
Local group No change No change No change
**Rooms that contain elements originating from a PlaceType but modified directly
in the place, or that contain elements created in the place rather than originating
from a PlaceType, are not deleted.
Note: In a place that is derived from a PlaceType, all task pages display
[h_Managers] in ″Who can edit this task″. Since membership is not
refreshed, members removed from the place will not be added back during
refresh. The [h_Managers] entry ensures that managers of the place can edit
the page if all other editors are removed from the place.
Replace effect
on element in Replace effect on
Element not place if element element in place if Replace effect on element
changed in not changed in element changed in in place if element
PlaceType place place deleted in place
Page No change Replaced Copied back
Folder No change Replaced Copied back
Room No change Replaced Copied back
Form No change Replaced Copied back
Field No change Replaced Copied back
Replace effect
on element in Replace effect on
Element place if element element in place if Replace effect on element
modified in not changed in element changed in in place if element
PlaceType place place deleted in place
Page Updated Replaced Copied back
Folder Updated Replaced Copied back
Room Updated Replaced Copied back
Form Updated Replaced Copied back
Field Updated Replaced Copied back
Theme Updated Replaced Copied back
PlaceBot Updated Replaced Copied back
Room Setting Updated Replaced Copied back
Aesthetic Settings Updated Replaced Copied back
Member No change No change No change
Local group No change No change No change
Replace effect
on element in Replace effect on
place if element element in place if Replace effect on element
Element deleted not changed in element changed in in place if element
in PlaceType place place deleted in place
Page Deleted Deleted No change
Folder Deleted* Deleted* No change
Room Deleted** Deleted** No change
Form Deleted Deleted No change
Field Deleted Deleted No change
*Folders that contain pages created directly in the place rather than originating
from the PlaceType are not deleted.
**Rooms that contain any element created directly in the place rather than
originating in the PlaceType are not deleted.
You can also refresh a PlaceType by running the QPTool refresh command from the
server console or command line. For more information, see the chapter ″Using
QPTool Commands.″
Copying a PlaceType
You can use operating system commands to copy a PlaceType from one Lotus
QuickPlace server to another.
A PlaceType consists of a set of Notes database files (NSF files) in the AreaTypes
subdirectory on the Lotus QuickPlace server. For example, if you create a
PlaceType called Rapid Response, and your Domino and Lotus QuickPlace servers
are installed in the c://lotus/domino directory, the NSF files for Rapid Response
would be stored in the following location:
c:\Lotus\Domino\data\QuickPlace\AreaTypes\Rapid Response\
To copy a PlaceType from one Lotus QuickPlace server (server A) to another Lotus
QuickPlace server (server B):
1. On server B, create a subdirectory for the PlaceType in
x:\Lotus\Domino\data\QuickPlace\AreaTypes, where x is the drive on which
Domino and Lotus QuickPlace are installed.
2. Copy the PlaceType files from server A to the subdirectory you created on
server B.
3. If the PlaceType has PlaceBots, you must sign the agents in the database using
the server ID of the current server, that is, server B. For more information on
signing a database, see Domino Designer Help.
4. Use the following procedure to add the copied PlaceType to the list of
PlaceTypes on server B.
To add a PlaceType copied from another server to the list of PlaceTypes on the
current server, do the following:
1. Sign in to the Lotus QuickPlace home page as an administrator.
2. Click PlaceTypes in the table of contents.
3. Click Refresh List.
Deleting a PlaceType
When you follow the steps below or when you use the QPTool remove command
without the -now argument, to mark a PlaceType for deletion on the current server,
it is no longer available to users. However, the file and directory are not actually
deleted until the QPTool remove -cleanup command runs on the server at 2 AM.
You can remove the PlaceType immediately by running the QPTool remove -now
command.
For more information on the remove command, see the chapter ″Using QPTool
Commands.″
Clusters provide high availability of important databases, and clustered servers can
redirect database open requests to other servers in the clusters, allowing users
uninterrupted access to their databases. You can use clustering to provide high
availability of a Lotus QuickPlace service, or group of servers. You can administer
servers in a cluster by adding, removing, or upgrading them.
Domino Enterprise Server software is used to set up and manage the cluster. The
servers in the cluster are sometimes referred to as cluster nodes. Lotus QuickPlace
is installed on each of these nodes.
There are several solutions available for distributing HTTP traffic among a number
of servers. The Lotus QuickPlace application requires that HTTP requests sent to
one node are continuously sent to that node for a predetermined amount of time.
This time period is sometimes known as ″sticky time.″
For more information on moving places, see the chapter ″Using QPTool
Commands.″
For information on upgrading a Lotus QuickPlace server in a cluster, see the book
Lotus QuickPlace Installation and Upgrade Guide.
Planning capacity
Before you set up a Lotus QuickPlace cluster, you must first decide:
v How many concurrent users need to be supported.
v The type of clustering solution to be implemented.
These decisions determine how many servers of a given specification are required
to support the user population for a given rate of Lotus QuickPlace usage.
Note: If a server belongs to a different cluster, you do not have to remove the
server from that cluster before you add it to the new cluster. The Cluster
Administration Process removes the server from the original cluster and
then adds it to the new cluster.
1. From the Domino Administrator, make sure the administration server or
another server is current.
2. Click the Configuration tab.
3. Expand Server, and click All Server Documents.
4. In the Results pane, select the servers that you want to add to the cluster.
5. Click Add to Cluster.
6. When asked to choose the cluster you want to add the servers to, choose
Create New Cluster, and then click OK.
7. Type the name of the new cluster, and click OK.
8. Choose Yes to add the servers to the cluster immediately, or choose No to
submit a request to the administration process to add the servers to the
cluster.
9. (Optional) If you chose No in Step 8 and you did not add the servers on the
administration server, force replication between this server you used and the
administration server so that the administration server receives the requested
changes sooner.
10. (Optional) If you chose No in Step 8, force replication between the
administration server and the cluster servers so the cluster servers receive all
the changes sooner.
11. (Optional) If you chose Yes in Step 8, the cluster information is added
immediately to the Domino Directory of the server you used to create the
cluster. If this server is not part of the new cluster, replicate the changes to one
of the servers you added to the cluster.
Note: Because each server in the cluster has independent server settings, you
must update the settings (for example, User Directory) in the Lotus
QuickPlace Administration room.
To ensure that the Place Catalog works properly for Lotus QuickPlace servers in a
cluster, you must configure the Lotus QuickPlace server’s qpconfig.xml file with
details of the cluster environment. All Lotus QuickPlace servers in a cluster should
use the same qpconfig.xml settings.
If the Lotus QuickPlace server is part of a cluster, copy the following XML content
from qpconfig_sample.xml to your qpconfig.xml file. Replace the sample values in
bold with your own values.
<?xml version="1.0" standalone="yes"?>
<server_settings>
<cluster>
<master virtual="true" ssl="false">
<port>80</port>
<hostname>servername.enterprise.com</hostname>
<path_prefix><path_prefix />
</master>
</cluster>
</server_settings>
The following table describes the values you specify for the cluster setting.
Attribute Description
virtual=″value″ The master server in a cluster acts as a user’s
entry point to places on other servers in the
cluster.
When the cluster has a virtual server, real-time updates to the Place Catalog (such
as place creation, locking of a place, and place membership changes) are made in
the place entries corresponding to the virtual server. The non-real time updates
(such as place size, time last accessed, and time last modified) are made to the
place entries corresponding to the physical servers in the cluster. This information
allows the administrator to know the differences in access and size for the places
in each of the physical servers in the cluster.
The QPTool placecatalog command with the -update flag synchronizes the place
entries that correspond to the physical servers, and the place entries that
correspond to the virtual server.
For more information on the placecatalog command, see the chapter ″Using
QPTool Commands.″
To set up a virtual server for a Lotus QuickPlace cluster, you must configure a
network dispatcher, such as IBM Network Dispatcher. Then you must configure
the proper settings in the qpconfig.xml file on each server in the cluster. For
information on setting up a network dispatcher, see your server documentation.
Note: Run the Domino command dbcache flush at the server console before
running the remove command to remove from the database cache any
databases that are marked for deletion.
For more information on the remove command, see the chapter ″Using QPTool
Commands.″
7. Shut down the server.
If Domino manages lookups to the user directory, you can authenticate Lotus
QuickPlace users using any type of client authentication that is set up on the
Domino server, for example, X.509 certificate authentication. For more information,
see the Security section of Domino Administrator Help.
Note: To use SSL to encrypt the data transferred between Web browsers and a
Lotus QuickPlace server, enable SSL on the Domino Web server. For more
information, see Domino Administrator Help.
To set up multi-server single sign-on for a Lotus QuickPlace server, first create a
Web SSO Configuration document, if there isn’t one already. If there is already a
Web SSO Configuration document, add the Domino server names of the Lotus
QuickPlace servers to the document.
Field Action
Configuration Name Accept the default entry, LtpaToken.
Organization Leave this field blank so the document appears in the Web
Configurations view.
7. Click Save & Close to save the Web SSO Configuration document in the Web -
Web Configurations view. A message on the status bar indicates the number of
servers or people for whom the document is encrypted.
If you receive messages on the client indicating that a particular key was not
found for encrypting the document, you might have to change your client’s
location document to point to a different mail or directory server that has all
the public keys included in Server and Person documents.
8. Follow the steps in the topic, ″Completing single sign-on setup.″
QuickPlaceMaxCachedUsers=number
When the cache reaches the specified number, older entries are removed to make
room for new ones that are needed. By default, 64 user entries are allowed in the
cache.
QuickPlaceExpireCachedUsers=interval
where interval is the length of time in seconds. By default, the interval is 120
seconds.
Modifying the information of a local user who can create places: To modify
information for a local user who can create places, do the following:
1. Sign in to the Lotus QuickPlace home page as an administrator.
2. Click Server Settings in the table of contents.
3. Click Security in the table of contents.
4. Under ″Who can create new places on this server?″ select ″Only specific users
(or groups) who provide a name and password.″
5. Select the local user whose information you want to modify.
6. Click Modify.
7. Change the user’s name, password, and (optionally) e-mail address as desired.
8. Click Next.
Removing a local user from the list of users who can create places: To remove a
local user from the list of users who can create places, do the following:
1. Sign in to the Lotus QuickPlace home page as an administrator.
2. Click Server Settings in the table of contents.
3. Click Security in the table of contents.
4. Under ″Who can create new places on this server?″ click Remove.
5. Select the local user name to remove.
6. Click Next.
Removing the name of an external user from the list of users who can create
places: To remove the name of an external user or group from the list of users
who can create places:
By default no super user is defined. You can give super user access to a user or
group in a user directory but not to a local user or group.
For information on creating and using the qpconfig.xml file, see the chapter ″Lotus
QuickPlace Administration Overview.″
where name is the distinguished name of a user or group in the external user
directory. The distinguished name must appear exactly as it does in the external
directory. For example, if there are spaces after the component delimiters, there
must be spaces in the super user entry as well.
To disable super user access from a browser, remove or comment out the
super_user setting in qpconfig.xml.
You can specify two different names for super user access, one name for access
from the browser set in qpconfig.xml, and another name for access from a Notes
user specified using the QuickPlaceAdministratorsSUGroup.
If you want to give the same user or users super user access through the browser
and Notes, and the Notes client Domino Directory is also the Lotus QuickPlace
user directory, you can use the QuickPlaceAdministratorsSUGroup to manage both
types of super user access. Create the QuickPlaceAdministratorsSUGroup as
described above, and also specify cn=QuickPlaceAdministratorsSUGroup as the
distinguished name for the super_user setting.
For example, if a user with super user access is also a member of a place with
Reader access and the place uses standard membership, the user has Reader access
to the place. However, if the place uses expanded membership, the user has super
user access to the place.
Expanded membership
Lotus QuickPlace by default lists the names of place members in the database
access control lists (ACLs) of the rooms in a place. The combined names in an ACL
cannot exceed 32K in size, which limits a place to approximately 300 to 900
members, depending on the length of the members’ distinguished names.
Expanded membership removes this limitation by generating groups in an LDAP
directory to store the names of individual members, and then uses these groups,
rather than the individual user names, in room ACLs. Currently expanded
membership is certified for a maximum of 4000 external user members in a place.
Expanded membership pertains to individual external user place members and not
to local or to external group place members.
Lotus QuickPlace creates the following groups in this LDAP directory for the main
room (Main.nsf) of a place and adds them to the main room database ACL:
cn=h_Managers,ou=placename,base_dn
cn=h_Editors,ou=placename,base_dn
cn=h_Readers,ou=placename,base_dn
where
base_dn is a base distinguished name for the expanded membership groups that is
configured through the qpconfig.xml file.
When an external user member is added to the place, Lotus QuickPlace adds the
user’s name to one of these groups, according to the access assigned to the user.
For example, Lotus QuickPlace adds an external user member with Reader access
to the place’s ″cn=h_Readers....″ group.
cn=h_Managers,ou=uniquenumber,ou=placename,base_dn
cn=h_Editors,ou=uniquenumber,ou=placename,base_dn
cn=h_Authors,ou=uniquenumber,ou=placename,base_dn
cn=h_Readers,ou=uniquenumber,ou=placename,base_dn
where
base_dn is the base distinguished name configured for the expanded membership
groups.
Removing an external user member from a place removes the user’s name from the
expanded membership groups associated with the place. Removing an external
user member from a subroom, removes the user’s name from the appropriate
Lotus QuickPlace group associated with the subroom. Removing a place or a
subroom removes the expanded membership groups associated with the place or
subroom.
After you have modified and save the qpconfig.xml file, restart the HTTP task on
the server.
For more information on creating and using the qpconfig.xml file, see the chapter
″Lotus QuickPlace Administration Overview.″
expanded_membership_model setting
To enable expanded membership, specify enabled= ″true.″ Note that after places
are set up to use expanded membership you cannot revert them to the standard
membership model.
Note: Do not use ″ou=qp″ as part of the base distinguished name because qp is a
reserved organizational unit in Lotus QuickPlace.
If the directory server that stores the expanded membership groups is the same
one that Lotus QuickPlace uses for other purposes, specify a base distinguished
name for the expanded membership groups that is outside the base specified on
the server for group lookups generally. For example, if the base distinguished
names specified for group lookups generally is ou=groups,o=acme, use a different
base for the expanded membership groups, for example
ou=teamworkplace,o=twgroups or ou=twgroups,o=acme. Using separate base
distinguished names for the two types of groups optimizes performance by
preventing unnecessary searches of all the expanded membership groups during
the process of user authentication.
Perform the following steps to configure the name and password when you
connect to a user directory through Lotus QuickPlace. If you connect to a user
directory through Domino, configure the name and password in a Directory
Assistance document for the LDAP directory instead.
1. Sign in to the Quickplace/quickplace on the server as an administrator.
2. Click Server Settings in the table of contents.
3. Click User Directory in the table of contents.
4. Click Change Directory.
5. Under Expanded Membership Model:
v Enter the user name in distinguished name format (for example,
cn=qpadmin,o=acme)
Note: You see the Expanded Membership Model option only if you’ve enabled
expanded membership on the server through the qpconfig.xml file, and if
you’ve selected LDAP for the Lotus QuickPlace user directory in the Lotus
QuickPlace Server Settings room.
where place(s) is the name of a place or places to convert. Separate places with a
space.
If there are replicas of a place, run the command on one replica only.
For more information on the QPTool membershipmodel command, see the chapter
″Using QPTool Commands.″
Note: After you’ve set up places to use expanded membership, you cannot revert
them to standard membership.
Attribute Description
enabled When set to ″true,″ prevents Lotus QuickPlace from publishing
pages with link URLs that reference protocols designated as
blocked.
allowed When enabled is set to ″true,″ specifies the protocols in URL
links to allow.
blocked When enabled is set to ″true,″ specifies the protocols in URL
links to block.
For example:
<server_settings>
<security>
<URLfield_protocol_filter enabled="true">
<allowed>"http:","https:"</allowed>
<blocked>"javascript:","View-source:",
"about:","file:","ftp:","news:",
"mailto:"</blocked>
</URLfield_protocol_filter>
</security>
</server_settings>
To clear the browser cache when a user signs out, add the following setting to the
qpconfig.xml file, and then restart the HTTP task.
<server settings>
<authentication>
<sign_out enabled="true"/>
<clear_browser_cache enabled="true"/>
</sign_out>
</authentication>
</server settings>
The browser cache is cleared only if the Sign Out link is enabled, ActiveX controls
are enabled in Lotus QuickPlace, and ActiveX is enabled on the browser. Internet
Explorer enables ActiveX by default.
The Sign Out link is never available to anonymous users, and to users who access
places in accessibility mode on a server that is not enabled for single sign-on. The
Sign Out link is unavailable to all users if you configure the server to hide the Sign
Out link as described previously. If the Sign Out link is unavailable for any of
these reasons, you can configure the server to prevent caching of Lotus QuickPlace
pages on browsers.
Any Lotus QuickPlace pages containing data that users access after you have
added this setting are not cached. Pages that do not contain user data continue to
be cached for better performance. This feature is available for all supported
browsers.
To use the Server Settings - Other Options to configure the options described
above:
1. Open a browser and enter the server’s host name appended by /QuickPlace.
For example:
http://servername.enterprise.com/QuickPlace
2. Click Sign In.
3. Enter a Lotus QuickPlace server administrator user name and password.
4. Click Server Settings in the table of contents.
5. Click Other Options in the table of contents.
6. Click Edit Options.
7. Do any of the following:
ActiveX controls
When you enable ActiveX controls in the Server Settings - Other Options room of
the administration place, users with ActiveX-enabled browsers have additional file
attachment and import features available to them. Internet Explorer is the browser
that typically is ActiveX-enabled. When ActiveX controls are disabled through the
Server Settings - Other Options room or are unsupported by browsers, users have
a more limited set of features available to them.
The following table describes the features available when ActiveX is enabled
compared to when it is disabled.
For information on how to enable ActiveX controls, see the previous topic, ″Using
the Server Settings - Other Options room in the administration place.″
For information on enabling advanced search for a place, see the Help.
Before you set up the Search Places feature, note the following points:
v The Search Places feature respects all access permissions on content, and so
users must retain a single identity to be able to search across places. To search
across places, authenticated users must be registered in a user directory. Local
users can search only within a place.
v If room access is controlled by a local group, even if the user has access through
the local group, Search Places won’t be able to find the document from the
room. Restrict room access using groups from an external user directory.
v If the Lotus QuickPlace service consists of more than two Lotus QuickPlace
servers, including the Domain Catalog server, to use the Search Places feature
you must configure multi-server session-based authentication (single sign-on).
For more information, see the chapter ″Setting Up Security.″
v To remove places when the Search Places feature is used, use the QPTool remove
command with the -cleanup argument rather than with the -now argument. The
For more information on creating and using the qpconfig.xml file, see the chapter
″Lotus QuickPlace Administration Overview.″
Setting Description
enabled When set to true (default):
v Enables users to see and use the All Places advanced search
option on the server.
v Allows users to use Search Places on the Domain Catalog
server.
*Use these settings on any Lotus QuickPlace server that is not the Domain Catalog
server. Do not use them on the Domain Catalog server.
The following example displays the places whose name starts with ″xyz″ when My
Places is sorted by the default sort key, place name:
http://serverName/QuickPlace/quickplace/Main.nsf/h_Toc/
22049553D70E00EF85256BB60054A7CB/?OpenDocument&StartKey=xyz
The following example displays the places whose titles start with ″Acme″ when
My Places is sorted by title:
http://serverName/QuickPlace/quickplace/Main.nsf/h_Toc/
22049553D70E00EF85256BB60054A7CB/?OpenDocument&StartKey=Acme
Certain actions cause the cache for a page to become invalid. Once a cached paged
is invalid, the next time the page is accessed it is re-cached. Following are some
examples of how the entire cache or specific pages within the cache can become
invalid:
v A change to the Lotus QuickPlace Server Settings, for example a change to the
default maximum attachment size allowed, invalidates all places on the server
(the entire cache).
v If the Place Catalog is enabled, a change in the Place Catalog database
invalidates the entire cache.
v A change in qpconfig.xml invalidates the entire cache.
v A change to place membership -- a member is added, modified, or deleted --
invalidates the cache for all databases associated with that place -- main.nsf and
all the inner rooms. A change to inner room membership invalidates the cache
for that particular room and its child rooms.
v A change in rooms -- a room is created or deleted -- invalidates the cache for all
databases associated with that place.
v A page published in the Main room (main.nsf) invalidates the cache for all
databases associated with that place.
v A page published in a parent room invalidates the cache for the parent room
and the child rooms below it.
v A page published in a child room invalidates the cache for the child room and
for any rooms below it. The cache for the parent room pages remain valid.
v A customization to a parent room, for example a theme change or a custom
form, invalidates the cache for the parent room and the child rooms below it.
If this variable is not set in the notes.ini file, then it is automatically set to the
default directory: (<NOTESPROGRAM>\data\domino\quickplace\cache).
If this variable is not set in the notes.ini file or if the size given is not a positive
number, then the variable is automatically set to the default size of 50MB.
If this variable is not set in the notes.ini file, or if the value given is not a positive
number, then it is automatically set to the default value of 60 minutes.
The default value for this setting allows server caching for all users when the
cache is enabled. Changing this setting disables caching for all other users.
The logging setting has three levels: 1, 2, or 3, where 1 is the least detailed and 3 is
the most detailed. Logging is written to log.nsf.
To enable the display of CGI variables, use the following setting in the
qpconfig.xml file on the server, and then restart the HTTP task:
<server_settings>
<cgi_variables enabled="true"/>
</server_settings>
For more information on creating and specifying settings in the qpconfig.xml file,
see the chapter ″Lotus QuickPlace Administration Overview.″
Note: You configure the underlying Lotus QuickPlace mail routing through
Domino. For more information, see Domino Administrator Help.
For information on creating the qpconfig.xml, see the chapter ″Lotus QuickPlace
Administration Overview.″
<server_settings>
<notifications>
<place_invitation>
<password_message>Your intranet password.</password_message>
</place_invitation>
<calendar>
<client_types>
<notes5 enabled="true"/>
<msoutlook enabled="true"/>
</client_types>
</calendar>
<recipient_rules>
<expand_external_groups enabled="true"/>
<allow_ambiguous_sendto enabled="false"/>
</recipient_rules>
</notifications>
</server_settings>
Setting Description
password_message Specifies the password prompt that appears in
external users’ invitations to visit places
notes5 enabled When set to true (default), enables Lotus Notes 5
support for calendar notifications. When set to false,
disables this support.
msoutlook enabled When set to true (default), enables Microsoft
Outlook support for calendar notifications using
icalendar standards specified in RFC 2445. When
set to false, disables this support.
expand_external_groups enabled When set to true (default), when mail is addressed
to an external group, the place expands the group
and lists each member’s e-mail address in the
notification.
To instead route these types of replies as well as delivery failure notifications to the
default mail location of the places from which the e-mails come, delete the
following setting from the notes.ini file on the server:
h_UndelivMail
Or, to send these types of replies as well as delivery failure notifications to the
default mail location of one specified place, modify these notes.ini settings:
h_UndelivMail=placename
$h_MailDomain=domainname
where placename is the name of the place to route the mail, and domainname is the
fully qualified domain name of the server that hosts the place.
For more information on creating and specifying settings in the qpconfig.xml file,
see the chapter ″Lotus QuickPlace Administration Overview.″
For example, to display Acme Corporation in bold text in page footers, specify the
following, and then restart the HTTP task:
<server_settings>
<server_messages>
<footer>
<![CDATA[<b>Acme Corporation</b>]]>
</footer>
</server_messages>
</server_settings>
To insert an image in the footer, put the image file in the data\domino\html
directory and reference it in the footer setting as <img src=″/[filename].gif″>. Or
put the image file in the data\domino\icons directory and reference it as <img
src=″/icons/[filename].gif″>.
When you set up the HTTP task to log user access information to text files, the
HTTP task creates one log file a day that contains information about each user
session with the Lotus QuickPlace server. The default name format for the log files
is access<date>.log, where <date> is the date the log file is created in the format
MMDDYYYY.
For more information on Web server logging and other log settings in the Server
document, see Domino Administrator Help.
The following Korn shell commands process all the log files generated by one
server in the month of May to produce the unique user list.
do
done
On server X run:
do
done
On server Y run:
for f in `access*.log`
do
done
Then use the following command to sort and generate the final list of names:
If there are many servers and log files to process, you can automate the steps by
programming them in a cmd file (Windows) or a script file (UNIX).
On server X run:
On server Y run:
Then use the following command to sort and generate the final list of names:
QPTool
QPTool is a server task that you run with arguments to do administrative tasks.
You can use the QPTool command to complete the following tasks:
v Add external members to places
v Change user and group names in places
v Change the hierarchy of names in places
v Update external member information in places
v Manage expanded membership
v Reset local user passwords
v Remove members from places
v Send newsletters to subscribers
v Send mail to managers and members of places
v Register and unregister places and servers
v Automate replica stub creation
v Upgrade places and PlaceTypes
For information on upgrading places and PlaceTypes, see the Lotus QuickPlace
Installation and Upgrade Guide.
v Refresh places and PlaceTypes
v Lock and unlock places
v Archive places
v Remove places or PlaceTypes
v Update statistics in the Place Catalog
v Generate reports about places and servers
v Repair places
v Clean up dead mail
v Add and remove graphic text fonts
v Execute an XML API file
Running QPTool
QPTool commands are designed to be used while the Lotus QuickPlace server is
running.
For example, to lock a place called place1 from the Domino server console, enter
the following command:
You can also run QPTool from a batch file or other program.
The Place Catalog reflects changes that result from QPTool commands.
For more information on the Place Catalog, see the chapter ″Setting Up the Place
Catalog.″
Typically you specify an XML input file that a previous QPTool command
generated as output. For example, suppose you use the QPTool report command to
report on all places last accessed before a specified date. You could then use the
XML output file generated by the report command as input to a QPTool sendmail
command that notifies place managers of these inactive places.
The QPTool report command can gather information from all servers in a cluster.
However, if the results of the report command are supplied as input to another
qptool command, the other qptool command only acts immediately on the places
on the server from which you issue the command.
If you use the Lotus QuickPlace user interface to change an existing external
member’s access to the main room in a place, subrooms do not inherit the access
change. To change an existing member’s access to all rooms in a place, you can use
the QPTool removemember command to delete the member from the place, and
then use QPTool addmember with the -allrooms argument to add the member
again with the new access.
Note: You can’t use the addmember command to add local members. You can’t
use addmember to add external members to the QuickPlace/quickplace.
Argument Description
-? Prints help on the command.
-dn name Specifies the name of an external user or group to
add as a member. If the name contains at least one
space, include quotation marks (″ ″) around it.
Specify the name exactly as it is defined in the
directory (including spaces), for example:
″cn=Connor Jones,ou=Sales,o=Acme″
Note: Lotus QuickPlace does not look up the name
in the user directory to verify the name you specify.
Be sure the name you specify is valid.
-g Indicates that a name specified for the -dn
argument is the name of a group.
Task Command
Add the user cn=Connor load qptool addmember -dn ″cn=Connor
Jones,ou=Sales,o=Acme as an author Jones,ou=Sales,o=Acme″ -author -allrooms -p Place1
of all rooms in Place1
Add the group load qptool addmember -dn cn=Salesgroup,o=Acme
cn=Salesgroup,o=Acme as a reader of -g -reader -a
the main room in all places
Note: If an external user is not listed explicitly as a member of a place, but instead
accesses the place through membership in an external group, the user’s
name is not listed as a member in the place’s Contacts1.nsf database, but is
included in security fields within the place. For example, if the user creates
Argument Description
-? Prints help on the command.
-sourcedn name Specifies the original distinguished name of an
external user or external group exactly as the name
is defined in the external directory, for example,
″cn=Connor Jones, ou=Sales,o=Acme.″
″cn=Representatives,ou=Sales,o=Acme″
Task Command
Change the name of local user name >load qptool changemember -p PlaceName -sourceu
to an external user name. localuser -targetdn
″CN=ExternalUser,O=[Organization]″
Change an external user name to an >load qptool changemember -p PlaceName
external user name. -sourcedn ″CN=External User,O=[Organization]″
-targetdn ″CN=New External
User,O=[Organization]″
Change an external group name in >load qptool changemember -p PlaceName1
multiple places. PlaceName2 -sourceg -sourcedn ″CN=External
Group,O=[Organization]″ -targetg -targetdn
″CN=New External Group,O=[Organization]″
The following table describes the arguments you can use with the command.
Argument Description
-? Prints help on the command.
-sourceh hierarchy Specifies the original name hierarchy to change, for
example, ou=people,o=group. If the hierarchy
includes spaces, place quotation marks around it.
-targeth hierarchy Specifies the new name hierarchy, for example,
ou=people2,o=group. The name hierarchy you
specify should correspond to a valid name
hierarchy in the external directory. If the hierarchy
includes spaces, place quotation marks around it.
-a Changes the names of external users and groups
that use the original name hierarchy to the new
name hierarchy in all places.
-p place(s) Changes the names of external users and groups
that use the original name hierarchy to the new
name hierarchy in a place or a space-separated list
of places.
Note: If an external user is not listed explicitly as a member of a place, but instead
accesses the place through membership in an external group, the user’s
name is not listed as a member in the place’s Contacts1.nsf database, but is
included in security fields within the place. For example, if the user creates
a page, the user’s name is listed in the page’s h_Authors field. If you use the
changehierarchy command and the name hierarchy you are changing
applies to the user’s name in a place, the user’s name is changed in these
security fields and the user’s access to the place continues.
Task Command
Change the names of users and >load qptool changehierarchy -sourceh
groups within the hierarchy ou=boston,o=acme -targeth ou=detroit,o=acme -p
ou=boston,o=acme to the hierarchy P1
ou=detroit,o=acme in the place P1
Changes the names of users and >load qptool changehierarchy -sourceh
groups with the hierarchy ou=boston,o=acme -targeth ou=detroit,o=acme -a
ou=boston,o=acme to the hierarchy
ou=detroit,o=acme in all places
Argument Description
-? Prints help on the command.
Task Command
Update the member information for load qptool updatemember -dn ″cn=Connor
the user cn=Connor Jones,ou=Sales,o=Acme″ -a
Jones,ou=Sales,o=Acme in all places
Use the notes.ini file to update all ServerTasksAt3=qptool updatemember -allmembers
member information in all places -a
daily at 3 AM.
Update the member information for load qptool updatemember -dn
the group cn=Adminstrators,o=Acme cn=Administrators,o=Acme -g -a
in all places
CAUTION:
Do not use the membershipmodel command until you have read about
expanded membership and how to set it up. For information, see the chapter
″Setting Up Security.″
Argument Description
-? Prints help on the command.
-toexpanded Converts places to expanded membership.
-rmgroups Removes existing expanded membership groups
from the directory server that currently stores them.
-basedn If you’ve changed the base distinguished name
configured in the expanded membership model
section of the qpconfig.xml file, use this command
to change the names of the groups in place ACLs to
reflect the change. For complete instructions, see the
chapter ″Setting Up Security.
-addgroups If you’ve used the -rmgroups argument, use this
argument to re-create the groups.
-a When used with the -toexpanded argument, runs
the command on all places that do not use
expanded membership.
Task Command
Enable ″placeofmanymembers″ to use >load qptool membershipmodel -toexpanded -p
expanded membership. placeofmanymembers
Enable all places that do not >load qptool membershipmodel -toexpanded -a
currently use expanded membership
to use expanded membership.
The expanded membership groups >load qptool membershipmodel -rmgroups -p
for ″placeofmanymembers″ are not placeofmanymembers
synchronized correctly with the
place. To correct the problem, remove >load qptool membershipmodel -addgroups -p
the groups for placeofmanymembers
″placeofmanymembers″ from the
directory, then re-create them.
Change the directory server or base For information, see the chapter ″Setting Up
distinguished name used for the Security.″
expanded membership groups.
Note: To change the password for an external user, change the entry for the user
in the external directory.
Argument Description
-? Prints help on the command.
-u name Specifies of the name of the local user whose
password you are changing. If the name has spaces,
include quotations marks around the name, for
example:
″Joe Smith.″
-pw password Specifies the new password.
-p place (s) Specifies a place or a space-separated list of places
on which to change the user’s password.
-i inputfilename XML input file located in the server program
directory that specifies places on which to change
the user’s password.
Task Command
Change the password for a local user >load qptool password -p placename -u joeuser -pw
whose name has no spaces newpassword
Change the password for a local user >load qptool password -p placename -u ″joe user″
whose name includes spaces -pw newpassword
The following table describes the arguments you can use with the command.
Argument Description
-? Prints help on the command.
-dn name Name of an external user or group to remove. If the
name contains a space, include quotation marks
around it. Specify the name exactly as it is defined
in the external directory, for example:
″cn=connor jones,ou=sales,o=acme″
″Jonathan Carter″
-a Removes the specified name from all places.
-p place(s) Removes the specified name from a place or a
space-separated list of places.
-i inputfilename XML input file located in the server program
directory that specifies the places from which to
remove the specified name.
-o outputfilename XML output file that logs the results of the
command. By default the command logs results to
qptool.removemember.xml in the server program
directory.
Task Command
Remove the external user cn=connor >load qptool removemember -dn ″cn=connor
jones,ou=sales,o=acme from the place jones,ou=sales,o=acme″ -p P1
P1
Remove the external group >load qptool removemember -g -dn
cn=managers,ou=groups,o=acme ″cn=managers,ou=groups,o=acme″ -p P1
from the place P1
Remove the local user Jonathan >load qptool removemember -u ″Jonathan Carter″
Carter from the places P1 and P2 -p P1 P2
Remove the external user cn=connor >load qptool removemember -dn ″cn=connor
jones,ou=sales,o=acme from all places jones,ou=sales,o=acme″ -a
Remove the external group >load qptool removemember -i
cn=managers,ou=groups,o=acme qptool.myremmem.xml -g -dn ″cn=managers,ou-
from places specified in the XML groups,o-acme″
input file qptool.myremmem.xml
Remove the external user cn=connor >load qptool removemember -dn ″cn=connor
jones,ou=sales,o=acme from the place jones,ou=sales,o=acme″ -p P1 -o
P1 and log the command output to qptool.myoutfile.xml
the non-default XML output file
qptool.myoutfile.xml
Note: Lotus QuickPlace cannot mail newsletters to groups. If you want to mail a
newsletter to a user who is a member of a group, add the user as a member
of the place.
Argument Description
-? Prints help on the command.
-daily Sends newsletters in daily format. By default the
NOTES.INI file includes the setting
ServerTasksAt1=qptool newsletter -daily -a so that
daily newsletters are sent at 1 AM for all places.
You can change the time when daily newsletters are
sent by modifying the NOTES.INI file or scheduling
the command through a Program document.
The following table describes the arguments available for the command.
Argument Description
-? Prints help on the command.
-template template XSL template file that specifies the message.
-managers Sends mail to managers only. Without this
argument, sends mail to all members, including the
managers.
Note: You can include information about each place in the e-mail to managers or
members of that place. The tags used in the template look like:
’<xsl:value-of select=″./fieldname″/>’
Use the QPTool unregister command to remove a place’s document from the Place
Catalog. For example, if the Place Catalog is down for any period of time,
unregister all places and then use the register command to register the place again
so that the Place Catalog contains up-to-date place information. Note that when
you use the remove command to remove a place, you do not have to use the
unregister command because the remove command automatically removes the
place document.
For more information on the Place Catalog, see the chapter ″Setting Up the Place
Catalog.″
Argument Description
-? Prints help on the command.
-placecatalog Registers/unregisters specified place(s) or server in
the Place Catalog.
-server Registers/unregisters the server on which the
command is run in the Place Catalog. The first time
you create a place on a server, the server is
registered in the Place Catalog automatically if the
Place Catalog is set up.
-install Installs and resets server-specific information for
places that have been:
v Moved to this server from another server
v Renamed on this server
v Restored from archive .
-a Registers/unregisters all places.
-p place(s) Specifies a place or a space-separated list of places
to register/unregister.
-i inputfilename XML input file located in the server program
directory that specifies the places to
register/unregister.
-o outputfilename XML output file that logs the results of the
command. By default the command logs results to
qptool.register.xml or qptool.unregister.xml in the
server program directory.
Task Command
Register a server with the Place >load qptool register -server
Catalog
Unregister a server with the Place >load qptool unregister -server
Catalog
Register a place that has been moved >load qptool register -p placename -install
from another server, renamed on the
current server, or restored from
archive
Unregister a place >load qptool unregister -p placename
Register a place in the Place Catalog >load qptool register -p placename -placecatalog
only
Register multiple places that have >load qptool register -p place1 place2 place3 -install
been moved from another server
Unregister multiple places >load qptool unregister -p place1 place2 place3
Register all places on the server in >load qptool register -a -placecatalog
the Place Catalog after upgrading to
version 7.0 and enabling the Place
Catalog
Unregister all places on the server >load qptool unregister -a
(that is, remove from place catalog)
Register places specified in an input >load qptool register -i qptool.myinput.xml
file
Unregister places specified in an >load qptool unregister -i qptool.myinput.xml
input file
Register a place and log results in a >load qptool register -p placename -o
non-default output file qptool.myout.xml
Unregister a place and log results in >load qptool unregister -p placename -o
a non-default output file qptool.myout.xml
Note: PlaceTypes replicate and the replicamaker command creates replica stubs for
PlaceTypes the same way it creates replica stubs for places.
The following table describes the arguments you can use with the command.
Argument Description
-? Prints help on the command.
-s sourceserver The name of one server involved with the
replication. If not specified, default is the local
server. If you don’t use -s, you must use -t.
-t targetserver The name of another server involved with the
replication. If not specified, default is the local
server. If you don’t use -t, you must use -s.
-a Creates replica stubs for all new places, rooms, and
PlaceTypes.
-p place(s) Creates replica stubs for a specific new place or
stubs for a space-separated list of new places.
-pt placetype(s) Creates replica stubs for a specified PlaceType or
stubs for a space-separated list of PlaceTypes.
Note: You cannot use XML input and output files with this command.
You can also refresh PlaceTypes using the PlaceTypes view in the administration
place.
For more detailed information on PlaceTypes and refreshing with them, see the
chapter ″Managing PlaceTypes.″
The following table describes the arguments you can use with the command.
Argument Description
-? Prints help on the command.
For information on the two levels of refresh, see the chapter ″Managing Place
Types.″
Task Command
Refresh the elements of child >load qptool refresh -pt PT1 PT2
PlaceTypes PT1 and PT2 with the
design of their parent PlaceTypes
Refresh the elements of child places >load qptool refresh -p P1 P2
P1 and P2 with the design of their
parent PlaceTypes
Refresh the elements of all places on >load qptool refresh -a
the server created from PlaceTypes
Replace the elements of child place >load qptool refresh -p P1 -r
P1 with the design of its parent
PlaceType and delete any design
changes made directly to P1
When a place is locked, the only QPTool command you can run on it is unlock.
Argument Description
-? Prints help on the command.
-a Locks/unlocks all places.
-p place(s) Specifies a place or a space-separated list of places
to lock/unlock.
-message message Specifies a message to display to users who visit a
locked place. Use quotes if the message contains
spaces.
-i inputfile XML input file located in the server program
directory that specifies the places to lock/unlock.
-o outputfile XML output file that logs the results of the
command. By default the command logs results to
qptool.lock.xml or qptool.unlock.xml in the server
program directory.
Note: To receive even more information during the
lock/unlock process, you can set
QuickPlaceLockLogging=1 in the NOTES.INI file.
The following table provides examples of using the QPTool lock/unlock command.
Task Command
Lock a place. > load qptool lock -p placename -message ″Place is
undergoing membership changes. Please try back
after 4 pm.″ (where placename is the name of the
place being locked).
Unlock a place. > load qptool unlock -p placename
Argument Description
-? Prints help on the command.
-dir path directory Directory in which to archive places. If you specify
an archive directory without an explicit path, the
specified archive directory is put in the server data
directory. If the specified directory does not already
exist, it is created.
Note: The archive command does not archive a
place that already exists in the archive directory.
-a Archive all places.
-p place(s) Specifies a place or a space-separated list of places
to archive.
-i inputfilename XML input file located in the server program
directory that specifies the places to archive.
-o outputfilename XML output file that logs the results of the
command. By default the command logs results to
qptool.archive.xml in the server program directory.
Task Command
Back up all places on the server >load qptool archive -dir x:\qpbackup -a
Archive more than one place to a >load qptool archive -dir c:\threeplaces -p placeone
target directory below c:\ placetwo placethree
Archive places specified in an XML >load qptool archive -i qptool.archive.xml -dir
input file to a directory below c:\ c:\threeplaces
Archive a place to a directory below >load qptool archive -p placename -dir
c:\ and log output to a non-default c:\placenameback -o c:\qptool.archive.xml
XML file location.
For example, suppose you use these QPTool commands to archive a place and then
remove it from the data directory:
To later restore the archived place so that users can access it again from a browser,
you would do the following:
1. Copy d:\archivedir\placename back to the program\data\QuickPlace directory.
2. Specify these QPTool commands:
>load qptool unlock -p placename
>load qptool register -p placename -install
Renaming places
To rename a place:
1. Run the following QPTool command:
load qptool unregister -p placename
Where placename is the current name of the place to be renamed.
2. Type the following command to shut down the Domino server:
exit
3. Through the file system, rename the place’s folder in the ...\Data\QuickPlace
directory.
4. Type the following command to restart the server:
restart server
5. Run the following QPTool command:
load qptool register -p placename -install
where placename is the new name of the place.
For more information on the QPTool register command, see the topic ″Registering
and unregistering places and servers on the server″ earlier in the chapter.
The following steps describe how to move one place, but you can also move
multiple places at the same time.
Argument Description
-? Prints help on the command.
-now Deletes places or PlaceTypes immediately. If you do
not use this argument, places or PlaceTypes are
only marked for removal. A place or PlaceType that
is marked for removal is inaccessible from a
browser but still exists in the file system.
-cleanup Deletes places or PlaceTypes that were previously
marked for removal through the remove command
or that were deleted through the Lotus QuickPlace
user interface. The ServerTasksAt2 NOTES.INI
setting includes qptool remove -cleanup, so that the
command runs by default at 2 AM.
Note: If you use Search Places on the server, do not use the -now argument to
remove places. Instead use the remove command without the -now
argument and mark the places for removal. After you mark the places for
removal, run the Catalog and Domidx tasks on the Domain Catalog server.
After the Domidx task has completed, use the remove command with the
-cleanup argument to remove the places. Follow this removal procedure to
ensure that information in documents from the deleted places is also
removed from the search index.
For more information on Search Places, see the chapter ″Completing Additional
Server Configuration Tasks.″
Task Command
Mark the place P1 for removal >load qptool remove -p P1
Mark all places on the server for >load qptool remove -a
removal
Mark PlaceType PT1 for removal >load qptool remove -pt PT1
Mark places P1, P2, and P3 for >load qptool remove -p P1 P2 P3
removal
Mark places for removal that are >load qptool remove -i qptool.removeinput.xml
specified in the XML input file
qptool.removeinput.xml
Mark the place P1 for removal and >load qptool remove -p P1 -o
log output to the non-default XML qptool.removeoutput.xml
file qptool.removeoutput.xml
Remove the place P1 immediately >load qptool remove -p P1 -now
Remove all PlaceTypes on the server >load qptool remove -pt PT1 PT2 PT3 PT4 PT5
immediately. Note that you cannot -now
use the -a argument to remove all
PlaceTypes.
Changes to the PlaceLastModified or the PlaceSize statistic are not updated in the
Place Catalog automatically however. To update these statistics in the Place Catalog
you use the placecatalog command with the -push argument on the place server.
By default the NOTES.INI file on a Lotus QuickPlace server includes the following
setting so that this command runs nightly at 3 AM to update the Place Catalog
with these two statistics for all places:
ServerTasksAt3=qptool placecatalog -push -a
Run the command manually, for example, before using the report command so that
you report up-to-date statistics.
Argument Description
-? Prints help on the command.
For more information on registering a server with the Place Catalog, see the topic
″Registering and unregistering places and servers on the server″ earlier in this
chapter, and the chapter ″Setting Up the Place Catalog.″
Using the report command, you can retrieve the following information from the
Place Catalog about places:
v Name
v Title
v Server name
v Size
v Date last accessed
v Date last modified
v Locked state
Note that although the Place Catalog lists the Readers, Authors, and Managers of
places you cannot use the report command to generate this information in a report.
Using the report command, you can retrieve the following information from the
Place Catalog about servers that use the Lotus QuickPlace service:
v Name
v Access Protocol
v Access TCP Port
v Access URL Prefix
If more than one server shares a Place Catalog, a report specifies data for all
servers in the service.
Argument Description
-? Prints help on the command.
-a Generates a report for all places.
-q query Generates a report on places that match the criteria
specified in a full-text query. In a query, you refine
a search by using operators in conjunction with any
of the following fields:
v PlaceName
v PlaceTitle
v PlaceServerName
v PlaceSize
v PlaceLastAccessed
v PlaceLastModified
Task Command
Report on a specific place >load qptool report -p placename
The repair command is intended to get place up and running as soon as possible,
but it does not necessarily fix the source of the problem; rather, it renormalizes
data that is no longer synchronized. That is, until the source of the problem is
addressed, or until Lotus QuickPlace source code is fixed, the repair command will
work as a temporary solution. Use the Repair command for the following
problems.
Note: The Lotus QuickPlace Release Notes may describe additional situtations in
which to use QPTool repair.
The problem occurs either when 1) the field contains a UNID but the draft
document itself does not exist, which generates the ″Document has been deleted″
error, or 2) when the field contains a wrong UNID, which generates the ″Entry not
found in index″ error. This problem could be caused by abruptly ending a server
or client process (that is, if there is no transaction rollback).
Argument Description
-? Prints help on the command.
-a Repairs all places on the server.
-p place(s) Repairs the specified place or space-separated list of
places.
-i inputfile Repairs places specified in an XML input file
located in the server program directory.
-o outputfile Logs results to a specified XML output file. By
default logs results to QPTOOL.REPAIR.XML.
Argument Description
-? Prints help on the command.
-cleanup Cleans up Lotus QuickPlace dead mail.
-o outputfile Logs results to the qptool.deadmail.xml file by
default, or to an XML file that you specify.
Note: For offline places to display graphic fonts added to the server, the fonts
must already be installed in the fonts directory of the client machine.
The following table shows the default location of the fonts directory for each
operating system Lotus QuickPlace supports.
Argument Description
-? Prints help on the command.
-name typefacename Specifies a typeface name to add or remove, or a
space-separated list of typeface names to add or
remove. If a typeface name contains spaces, enclose
the name in quotation marks (″″).
-i inputfile Adds or removes typeface names specified in an
XML input file located in the server program
directory.
-o outputfile Logs results to a specified XML output file. By
default logs results to the file
qptool.addgraphicfront[removegraphicfont].xml.
Task Command
Add the Comic Sans MS typeface. > load qptool addgraphicfront -name ″Comic Sans
MS″
Add the Comic Sans MS typeface > load qptool addgraphicfront -name ″Comic Sans
and the BordeauxLight typeface. MS″ BordeauxLight
Argument Description
-? Prints help on the command.
-i inputfile Specifies the XML API file to execute. If you do not
specify a path, the default location is the Domino
program directory.
-o outputfile Logs results to a specified XML output file. By
default logs results to qptool.execute.xml in the
Domino program directory.
Make sure the attributes you configure for the qpconfig.xml member_lookup_ui
setting exist in the schema of the external user directory.
Currently when you use the type-in method to search for a name to add, you can
specify only the first attribute of the user_lookup filter but not the second attribute.
You cannot add new users with automatic lookup if more than
one match is found
The automatic lookup feature in Lotus QuickPlace takes the input string entered
and does a wildcard search for all matches in the directory. For example, a search
on Joan Smith finds Joan Smith and Joan Smithe. If more than one match is found,
the name is not added because Lotus QuickPlace doesn’t know which name is the
correct one to add. In this situation, use the directory lookup interface to find the
name to add.
If place member and super user have same name, the super
user gets member access
When you create a super user, they have manager access to places on the server.
But if you then open a place and add the super user (or someone with the same
name) as a place member with reader access, the Super User will only have Reader
access to the place.
Conversely, if a place has a member with reader access, and you then make the
member (or someone with the same name) a Super User, the Super User will only
have Reader access to that place.
In most instances, forcing a flush of the cache is not needed since QPTool remove
-cleanup runs off hours after the cache has already been cleared.
Users should do the following to download the new rooms to the offline place:
1. Open the place offline.
2. Click ″Work Offline″ in the table of contents.
3. Click ″Offline Options.″
4. Select the rooms you want to synchronize offline.
5. Re-run synchronization to replicate the rooms offline.
Note: Make sure there is a blank line at the end of the notes.ini file.
NoWebFileSystemACLS=1
Note: The recommended order of the three DSAPI filters (DOLS, Netegrity
SiteMinder, and QuickPlace) in the ″DSAPI filter file names″ field is:
To work around this problem, temporarily disable the chat functionality and use
the qptool register -install command to rename the place to begin with something
other than ″QuickPlace.″ Or, leave chat active and add the offline password by
clicking on the author link of a page and then clicking the View Profile menu link
to bring up the member profile.
Reader sees this error: Last sync status: Sections:2 - Errors:2 - Docs Received:0 -
Docs Sent:0
These errors are expected behavior and are due to the fact that authors and readers
have limited write access or no write access to the server. Managers of places do
not see these errors because they have full access.
Cannot install places with the same name from two different
servers
If a user installs two offline places from two different servers and the places have
the same name, only the most recently installed place will open offline; the other
offline place is unusable. This is a known DOLS limitation.
For more information on the name_translation setting, see the chapter ″Connecting
to a User Directory.″
For more information on these settings, see the chapter ″Completing Additional
Server Configuration Tasks.″
Offline settings
The following table lists and briefly describes notes.ini settings used to set up
Lotus QuickPlace for users to take places offline.
For more information on these settings, see the Lotus QuickPlace Installation and
Upgrade Guide.
Setting Description
$DOLS_TCPIPAddress Used to configure a Lotus QuickPlace server
cluster that uses the IBM Network Dispatcher
to work with Domino Off-Line Services.
CheckCacheBeforeDSAPI Enables authentication to work for offline
users.
EXTMGR_ADDINS Enables Domino Off-Line Services to work
with Lotus QuickPlace.
NoWebFileSystemACLS Used to configure a Lotus QuickPlace server
and Sun ONE Portal Server to work with
Domino Off-Line Services.
To enable a specific type of logging, add the following line to the notes.ini file on
the Lotus QuickPlace server:
where setting is a logging setting listed in the following table and level is the
desired level of logging.
For example:
QuickPlaceAuthenticationLogging=5
The following table describes the logging settings and the highest level of logging
available for each. The higher the level of logging you specify, the more verbose
the output. The default and lowest logging level, 0, logs only errors.
Setting=level
The table shows the highest level of logging available for each setting. The higher
the level of logging you specify, the more verbose the output. The default and
lowest logging level, 0, logs only errors.
Other settings
The following table lists and briefly describes a variety of notes.ini settings not
included in the previous tables.
Setting Description
$h_MailDomain Specifies the domain of the server that hosts
the place to which Lotus QuickPlace routes
replies to e-mail generated from places. For
more information, see the chapter ″Completing
Additional Server Configuration Tasks.″
h_ScopeURLinQP Enables image caching in environments that do
not use single sign-on authentication. For more
information, see the chapter ″Completing
Additional Server Configuration Tasks.″
h_UndelivMail Specifies the place to which Lotus QuickPlace
routes replies to e-mail generated from places.
For more information, see the chapter
″Completing Additional Server Configuration
Tasks.″
NoWebFileSystemACLs Prevents anonymous access to files in the html
directory and is part of setting up single
sign-on authentication. For more information
see the chapter ″Setting Up Security.″
PLATFORM_CSID Required on UNIX servers to support names in
a user directory that contain accented
characters. For more information, see the
chapter ″Connecting to a User Directory.″
QuickPlaceExpireCachedUsers Specifies the length of time user entries remain
in the user cache. For more information, see the
chapter ″Setting Up Security.″
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user’s responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
Office 4360
The licensed program described in this information and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement, or any equivalent agreement
between us.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
Trademarks
The following terms are trademarks of International Business Machines
Corporation in the United States, other countries, or both:
AIX
Domino
Domino Designer
IBM
i5/OS
iSeries
Lotus
Lotus Notes
Notes
OS/400
QuickPlace
Sametime
Secure-Way
WebSphere
Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the
United States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Index 153
QPTool deadmail command Refresh levels Servers, virtual
cleaning up dead mail 128 inheritance and 50 setting up 61
QPTool execute command Registration Set QuickPlaceWebCacheLogging setting
XML API file 129 changing port/protocol settings 112 described 90
QPTool lock/unlock command places 37, 112 Sign In link
Place Catalog and 41 servers 37, 112 hiding 91
places 118 Replica stubs Sign Out link
QPTool membershipmodel command 79 automating 114 hiding 91
using expanded membership 107 Replication sign_in setting
QPTool newsletter command scheduling 114 described 91
sending newsletters 110 Reports sign_out setting
QPTool password command Place Catalog 125 described 81, 91
resetting passwords 108 Rooms Single sign-on
QPTool placecatalog command inheritance and 51 logging 143
updating statistics 41, 124 refreshing 50 setting up 65, 66, 67
QPTool refresh command replacing 51 support for 65
-r (replace) argument 50, 51 Spelling checker
controlling 53 i5/OS 10
logging 143
places and PlaceTypes 49, 50, 116
S SSL
logging 143
Sametime
replication and 49 LDAP directories and 27
enabling 83
QPTool register command 41 setting up 65
troubleshooting 140
QPTool register/unregister Starting
Search
command 112 Lotus QuickPlace 6
Advanced Search feature 85
QPTool remove command Statistics
Search base
Place Catalog and 41 Place Catalog 124
LDAP directories and 26
places and PlaceTypes 122 Stopping
LDAP servers and 16
QPTool removegraphicfont command Lotus QuickPlace 8
Search filters
described 128 Style sheet
customizing 20
QPTool removemember command logging 143
exact match option 20
removing place members 109 Sun Java System Directory Server
Search hint
QPTool repair command directory settings for 28
customizing 23
places 127 Super users
Search Places
QPTool replicamaker command described 73
logging 143
Place Catalog and 41 super_user setting
Off-Line Services 85
replica stubs 114 described 73
removing places 122
verbose mode 114
setting up 85, 87
QPTool report command
Search results
Place Catalog reports 125
QPTool sendmail command
customizing 23 T
search_places setting Time-out settings
mail 111
described 87 for authentication 18
QPTool update member command
search_ui_hint setting Tools
schema mapping changes 19
described 23 administration 5
QPTool updatemember command
search_ui_index setting Troubleshooting
updating member information 105
described 23 authentication 143
QPTool upgrade command 99
secondary_cn_component setting calendar events 143
QuickPlaceAdministratorsSUGroup group
described 24 DOLS 143
described 73
SecureWay. See IBM Directory Server 28 DSAPI 143
QuickPlaceExpireCachedUsers setting
Security expanded membership 107
described 68, 146
blocking HTML scripts 81 Java 143
QuickPlaceWebCacheDir setting
blocking protocols in link URLs 80 large uploads 143
described 90
clearing browser cache 81 locked places 143
QuickPlaceWebCacheEnabled setting
controlling server access 69 logging activity 114
described 90
hidden CGI variables 92 mail 143
QuickPlaceWebCacheGCIntervalInMIN
page caching and 81 My Places 143
setting
Server commands offline access 137
described 90
performance logging 143 offline installs 143
QuickPlaceWebCacheLimitInMB setting
Server Settings room page cache 143
described 90
described 5 page compression 143
QuickPlaceWebCacheUsers setting
expanded membership 78 performance 143
described 90
specifying settings 83 place archiving 143
Servers Place Catalog 143
changing properties on i5/OS 10 place upgrades 143
R clustering 57 QPTool 143
Refresh command registration 112 QPTool commands 135
places and PlaceTypes 50, 53, 116 reports on 125 refreshing PlaceTypes 143
replication and 49 status on i5/OS 10 repairing places 127
Index 155
156 QuickPlace Administrator’s Guide
Printed in USA
G210-1999-00