
Lotus
Quickr 8.5.1 for Domino


Second Edition
December 2010

© Copyright IBM Corporation 2007, 2010
In keeping with IBM's commitment to accessibility, this edition of the product documentation is accessible.
You can save a local copy of this document from your browser. Each browser has different menus and menu options. Consult the browser help if you need assistance saving the document locally.
If you would like to provide feedback about this document, see the Lotus Documentation Feedback Web site.
Learn about new features in this version, supported hardware and software, and accessibility features.
IBM® Lotus® Quickr® 8.5 for Lotus Domino® has a number of new features and functionality.
IBM® Lotus® Quickr™ 8.5.1 for Lotus Domino® delivers the following new features and functionality:
See this topic for a complete list of new features in Lotus Quickr 8.5.
Accessibility features help users who have a disability, such as restricted mobility or limited vision, to use information technology products successfully.
The Lotus Quickr Information Center, and its related publications, are accessibility-enabled.
See the IBM Human Ability and Accessibility Center for more information about the commitment that IBM has to accessibility:
The IBM® Lotus® Quickr™ 8.5 for Lotus Domino® preview guide is available for you to distribute to your users for new installations and upgrades to Lotus Quickr 8.5. This guide is designed to help your users become productive on the new software quickly, and to provide them with links to documentation resources for further help.
It is recommended that you distribute the guide to your users before their new Lotus Quickr software is installed or updated.
Before installing IBM Lotus Quickr services for Lotus Domino or using the expanded membership feature, planning and requirement information must be considered.
IBM Lotus Quickr runs as a Web application on an IBM Lotus Domino server and leverages several of the server features.
Lotus Quickr for Lotus Domino administration involves using a combination of Lotus Domino and Lotus Quickr tools: Domino Administrator client, configuration through the Domino Directory (names.nsf), and notes.ini file on the Domino side, and qptool commands entered at the server console, the qpconfig.xml configuration file, and the Site Administration link on the server home page on the Lotus Quickr side.
Place membership lists can be created locally in places (in CONTACTS1.NSF), so that specifying place members from a user directory is not required. However, connecting to a user directory maximizes the features that are available to you.
Local membership is supported, even when a user directory is used. The local Lotus Quickr administrator specified during installation is a local member of the server's Site Administration place.
To connect to a user directory, you have a choice of two directory services configurations. You can set up Lotus Quickr to control directory services, or you can set up the underlying Lotus Domino server to control directory services. When Lotus Quickr controls directory services, you connect to a single external LDAP directory server, and configure the LDAP directory connection through the Site Administration link and the qpconfig.xml file. When the underlying Lotus Domino server controls directory services, Lotus Quickr uses any of the directories that Lotus Domino does, for example, multiple directories accessed through directory assistance, and you use the directory services configuration procedures of Lotus Domino.
Decide whether users will authenticate anonymously or be required to use name-and-password authentication and whether to limit who can create places individually or by group.
By default, users can connect to a Lotus Quickr server anonymously or through basic name-and-password authentication. Server access is controlled through the tab in the Server document in the Domino Directory.
By default, any user who can connect to the server can create places. The local Lotus Quickr administrator, created at the end of Lotus Quickr installation, can use the link on the home page to limit the ability to create places to specific authenticated users or groups. The local administrator can also designate additional administrators, who then have the ability to create and delete places, use the Site Administration link, and create and delete PlaceTypes.
Users who create places have "owner" access to their places, meaning they can see and edit all place content, as well as control all access to place content. The available places access levels are: Author, Reader, Editor, Manager, and Owner. An administrator can use the qpconfig.xml file to specify the name of a user or group in a user directory with owner access to all places on the server.
If you use any IBM Lotus Quickr server that stores non-English content, you must set up the server to generate output using UTF-8 encoding so that page content displays correctly in non-English languages.
The Installation section of this documentation contains more detail on how to set up a server to generate output using UTF-8 encoding.
To enable people who use double-byte character set (DBCS) languages, such as Japanese or Chinese, to use My Places, you must enable single sign-on authentication on the server. In addition, you must use the notes.ini file to configure the DBCS language to use. See the Configuring section of this documentation for more information.
Users and administrators (using Site Administration) can select their preferred language when using Lotus Quickr.
You can download and use a different language version of the installed online help files (Main.nsf).
Before installing IBM Lotus Quickr, review the hardware and software requirements.
http://www.ibm.com/support/docview.wss?rs=3264&uid=swg27009740
Lotus Quickr 8.5 is available. Compatibility, installation, and other getting-started issues are addressed.
IBM Lotus Quickr combined with IBM enterprise content management capability addresses a broad spectrum of collaboration, document sharing, and content management needs. Users can leverage the intuitive user interface of Lotus Quickr to work on projects together and then easily move the final product of their collaboration to the organization's Enterprise Content Management (ECM) repository.
Users can use the IBM Lotus Quickr Web interface or the Quickr connectors for a consolidated view of content in Quickr places and content in their ECM repository. This integration combines the flexibility and ease of use of IBM Lotus Quickr with the structure, discipline, and business-process capabilities of IBM ECM offerings.
IBM Lotus Quickr integrated with Lotus Connections combines social networking for business with the structure of Quickr places for sharing content and ideas. In addition, the results of a collaboration that begins with a Connections Activity can be published to a more formal Quickr place and combined with other work efforts.
For information about hardware and software compatibility, see the detailed system requirements document at http://www.ibm.com/support/docview.wss?rs=3264&uid=swg27009740.
Known problems are documented in the form of individual technotes in the Support knowledge base at http://www.ibm.com/software/lotus/products/quickr/support/. As problems are discovered and resolved, the IBM Support team updates the knowledge base. By searching the knowledge base, you can quickly find workarounds or solutions to problems.
The following link launches a customized query of the live Support knowledge base: View all known problems for Lotus Quickr 8.5.
This section describes installing and upgrading IBM Lotus Quickr services for Lotus Domino.
To install IBM Lotus Quickr on a Microsoft Windows system, you must prepare for the installation, perform any necessary configuration changes, and enable the Lotus Domino servlet engine.
Perform the following steps to install Lotus Quickr on a Windows system.
IBM Lotus Domino series must be dedicated for use with IBM Lotus Quickr. Steps must be taken during Lotus Domino installation and server setup before Lotus Quickr can be installed.
Review the detailed hardware and software requirements on the IBM Support site.
Review the known issues that are described on the IBM Support Site. To see only installation issues, select Installation in the Product Category list.
Before installing IBM Lotus Quickr on a Microsoft Windows system, you must first install IBM Lotus Domino using these options. Then configure the server setup using the procedure in the next topic.
If you install partitioned Lotus Domino servers so that you can install Lotus Quickr on each partition, when you configure the server for TCP/IP, assign a separate IP address to each partition rather than using port mapping. For more information, see the topic Partitioned servers and IP addresses in the Lotus Domino Information Center.
For information about installing the Lotus Domino 8.5.1 server, see the topic Installing Domino on Windows systems in the Lotus Domino Information Center. After installing Lotus Domino, you need to update it with Fix Pack 3.
Perform the following steps to install IBM Lotus Domino on a Microsoft Windows system.
After IBM Lotus Domino is installed on a Microsoft Windows system, it must be configured before IBM Lotus Quickr can be installed.
Run the Lotus Domino server setup program by clicking the Domino server icon located on the desktop.
Perform the following steps to configure Lotus Domino on a Microsoft Windows system.
You must install IBM Lotus Domino and configure it for IBM Lotus Quickr. Lotus Domino servers must be dedicated for use with Lotus Quickr. If you use a Lotus Domino for anything, such as mail, then configure a new Lotus Domino server that is dedicated to Lotus Quickr.
After you have installed or upgraded to IBM Lotus Quickr, you must enable the Lotus Domino servlet engine. The servlet engine must be enabled to use Lotus Quickr place administration and to ensure that the Lotus Quickr home page does not display empty.
Perform the following steps:
With multi-server single sign-on, users can log in to a server once and during that session access servers enabled for single sign-on in the DNS domain without providing names and passwords again.
Keep the following points in mind:
Perform the following steps to configure multi-server single sign-on authentication. These steps apply regardless of whether Lotus Quickr or IBM Lotus Domino controls directory services.
Create a Web SSO Configuration document if there is not one already.
A Web SSO Configuration document may already exist for the domain. This might be the case, for example, if a IBM Lotus Sametime server is also installed in the domain. In this case, add the Lotus Domino names of the IBM Lotus Quickr servers to the existing Web SSO Configuration document.
If you use any IBM Lotus Quickr server that stores content other than English, you must set up the server to generate output using UTF-8 encoding so that page content displays correctly in other languages.
Perform the following steps:
IBM Lotus Quickr is installed on a Microsoft Windows system using a wizard.
Perform the following steps to install Lotus Quickr on a Microsoft Windows system.
If your IBM Lotus Quickr server runs on Microsoft Windows, you must modify specific TCP/IP registry parameters to ensure good performance.
For detailed information about these parameters, see the section "TCP/IP registry optimizations" in the IBM Redbooks publication, Tuning Windows Server 2003 on IBM System x Servers at http://www.redbooks.ibm.com/redpapers/pdfs/redp3943.pdf.
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters] "TcpTimedWaitDelay"=dword:0000001e "MaxUserPort"=dword:0000fffe "TcpWindowSize"=dword:0000ffff "MaxFreeTcbs"=dword:00011940 "MaxHashTableSize"=dword:0000ffff
You can optionally install IBM Lotus Quickr in silent mode by specifying the installation settings in a script file, then running that file at a command prompt. You can install the Lotus Quickr server to one or more Microsoft Windows systems, each with a different installation configuration as necessary.
This topic describes how to install Lotus Quickr on a Windows system using a command prompt. To install using a wizard, see the previous topic.
If Lotus Quickr has been installed on this server previously, you need to purge the server notes.ini file of all Lotus Quickr variables.
Use the following guidelines when using command options:
To install Lotus Quickr at a command prompt, you create system-generated setup files, then run the files.
You can install IBM Lotus Quickr on a AIX® system using an installation wizard or command interface.
Before installing IBM Lotus Quickr on an IBM AIX system, review hardware requirements, software requirements, and known issues.
After you have installed or upgraded to IBM Lotus Quickr, you must enable the Lotus Domino servlet engine. The servlet engine must be enabled to use Lotus Quickr place administration and to ensure that the Lotus Quickr home page does not display empty.
Perform the following steps:
With multi-server single sign-on, users can log in to a server once and during that session access servers enabled for single sign-on in the DNS domain without providing names and passwords again.
Keep the following points in mind:
Perform the following steps to configure multi-server single sign-on authentication. These steps apply regardless of whether Lotus Quickr or IBM Lotus Domino controls directory services.
Create a Web SSO Configuration document if there is not one already.
A Web SSO Configuration document may already exist for the domain. This might be the case, for example, if a IBM Lotus Sametime server is also installed in the domain. In this case, add the Lotus Domino names of the IBM Lotus Quickr servers to the existing Web SSO Configuration document.
IBM Lotus Quickr can be installed on an IBM AIX system using a wizard. To install using a command line interface, see the next topic Performing a silent installation of Lotus Quickr on AIX.
Perform the following steps to install Lotus Quickr on an AIX system.
You can optionally installIBM Lotus Quickr in silently mode by specifying the installation settings in a script file, then running that script file from the command line. You can install the Lotus Quickr server to one or more IBM AIX systems, each with a different installation configuration as necessary.
To install using a wizard, see the previous topic Installing Lotus Quickr on AIX.
This procedure uses a copy of the Lotus Quickr script.dat file to use as your installation script file. Make a copy of the original file with the default configuration settings before you begin.
To install Lotus Quickr from a script file, follow these steps.
If you use any IBM Lotus Quickr server that stores content other than English, you must set up the server to generate output using UTF-8 encoding so that page content displays correctly in other languages.
Perform the following steps:
You can install IBM Lotus Quickr on a SUSE Linux system using an installation wizard or command interface. After installation, you must enable the IBM Lotus Domino servlet engine.
Before installing IBM Lotus Quickr on a Linux system, review hardware requirements, software requirements, and known issues.
After you have installed or upgraded to IBM Lotus Quickr, you must enable the Lotus Domino servlet engine. The servlet engine must be enabled to use Lotus Quickr place administration and to ensure that the Lotus Quickr home page does not display empty.
Perform the following steps:
With multi-server single sign-on, users can log in to a server once and during that session access servers enabled for single sign-on in the DNS domain without providing names and passwords again.
Keep the following points in mind:
Perform the following steps to configure multi-server single sign-on authentication. These steps apply regardless of whether Lotus Quickr or IBM Lotus Domino controls directory services.
Create a Web SSO Configuration document if there is not one already.
A Web SSO Configuration document may already exist for the domain. This might be the case, for example, if a IBM Lotus Sametime server is also installed in the domain. In this case, add the Lotus Domino names of the IBM Lotus Quickr servers to the existing Web SSO Configuration document.
IBM Lotus Quickr can be installed using a wizard on a Lotus Domino server running aLinux operating system. To install using a command line interface, see the next topic "Performing a silent installation of Lotus Quickr on a Linux operating system."
Perform the following steps to install Lotus Quickr on a Linux system.
You can optionally install IBM Lotus Quickr in silent mode on a Lotus Domino server running aLinux operating system by specifying the installation settings in a script file, then running that script file from the command line. You can install the Lotus Quickr server to one or more Linux systems, each with a different installation configuration as necessary.
To install using a wizard, see the previous topic Installing Lotus Quickr on AIX.
This procedure uses a copy of the Lotus Quickr script.dat file to use as your installation script file.
To install Lotus Quickr from a script file, follow these steps.
If you use any IBM Lotus Quickr server that stores content other than English, you must set up the server to generate output using UTF-8 encoding so that page content displays correctly in other languages.
Perform the following steps:
To install IBM Lotus Quickr on an IBM i system, you must first install and configure a compatible release of IBM Lotus Domino. Add Lotus Quickr to the server, then enable the Lotus Dominoservlet engine and, if necessary, UTF-8 encoding for non-English content.
To perform a new installation of Lotus Quickr on IBM i, complete the following tasks as appropriate:
IBM Lotus Domino version 8.5.1 Fix Pack 3 Interim Fix 2 (if you need ECM integration) must be installed on the same system as IBM Lotus Quickr 8.5.
Review Lotus Quickr version 8.5 detailed system requirements to verify that the components in your environment meet minimum product levels. Upgrade all hardware and software as needed.
Review the known issues that are described on the IBM Support site. To see only upgrade issues, select Upgrade in the Product Category list.
Before installing Lotus Quickr on IBM i, review these limitations.
For more information about Lotus Domino 8.5.1 on IBM i, see Domino 8.5 for i: Getting started.
Assign TCP/IP addresses exclusively to the IBM Lotus Quickr, IBM Lotus Domino, IBM Lotus Sametimeand HTTP servers, add a TCP/IP interface and host name, and verify the server configurations.
Your system must have enough TCP/IP addresses defined so that you can that you can assign at least one for the exclusive use of each of the following servers:
Each of these servers must use a unique host name or TCP/IP address to avoid port conflicts between the servers. Do not attempt to use Lotus Domino port mapping.
Contact your network administrator to assign additional TCP/IP addresses and host names, if needed. Ensure that the new host names are also added to your Domain Name System (DNS) Server.
Complete the following tasks, as appropriate for your system:
Add a TCP/IP interface and host name to your system if your network administrator has assigned an additional TCP/IP interface for your use.
If your network administrator has assigned an additional TCP/IP interface for your use, follow these steps to add the interface to your system:
Each IBM Lotus Domino server in your system must use a unique host name or TCP/IP address to avoid port conflicts between servers.
Complete the following steps to verify the configuration for each Lotus Domino server:
For more information about configuring a Lotus Domino server, see the Lotus Domino documentation.
See the IBM Lotus Sametime Information Center for information about correctly configuring your Lotus Sametime server to use a unique host name and TCP/IP address.
The Sametime Information Center is available on the Web at: http://www.lotus.com/ldd/doc.
If the IBM Tivoli® Directory Server is used on the same system as IBM Lotus Quickr, it must use a unique host name or TCP/IP address to avoid port conflicts between servers. If you are not using Tivoli Directory Server with Lotus Quickr, it must be disabled.
If you are not using Tivoli Directory Server on the same system as your Lotus Quickr server, disable it by completing these steps:
If you are using it, complete these steps to force the Tivoli Directory Server to use a specific IP address:
Your IBM Lotus Quickr server uses the IBM Lotus Domino HTTP server. It is possible that you might have already configured IBM HTTP Server on your system for other applications. If so, then you must verify that each instance of the IBM HTTP Server is bound to a specific TCP/IP address.
To change the IBM HTTP Server settings, follow these steps:
For more information about managing IBM HTTP Server, see the IBM System i and i5/OS Information Center at:
http://www.ibm.com/eserver/iseries/infocenter
Before installing IBM Lotus Quickr, you must install a compatible release of IBM Lotus Domino and configure it for IBM Lotus Quickr.
For complete instructions about configuring a Lotus Domino server, see the Domino documentation available on the Web at http://www.ibm.com/developerworks/lotus/.
When installing and configuring Lotus Domino, be aware of the following limitations:
To bind the Lotus Domino server to the IP address set aside for Lotus Quickr, follow these steps:
After you have installed or upgraded to IBM Lotus Quickr, you must enable the Lotus Domino servlet engine. The servlet engine must be enabled to use Lotus Quickr place administration and to ensure that the Lotus Quickr home page does not display empty.
Perform the following steps:
With multi-server single sign-on, users can log in to a server once and during that session access servers enabled for single sign-on in the DNS domain without providing names and passwords again.
Keep the following points in mind:
Perform the following steps to configure multi-server single sign-on authentication. These steps apply regardless of whether Lotus Quickr or IBM Lotus Domino controls directory services.
Create a Web SSO Configuration document if there is not one already.
A Web SSO Configuration document may already exist for the domain. This might be the case, for example, if a IBM Lotus Sametime server is also installed in the domain. In this case, add the Lotus Domino names of the IBM Lotus Quickr servers to the existing Web SSO Configuration document.
When installing IBM Lotus Quickr for IBM i from a downloaded image instead of from physical media, you run a series of IBM i commands to prepare the downloaded files for installation.
To speed up installation on IBM i, you can "pre-accept" the IBM Lotus Quickr software agreements before starting installation.
To accept the Lotus Quickr software agreements before installing:
IBM Lotus Quickr can be installed on an IBM i system by running the RSTLICPGM command.
To install Lotus Quickr, follow these steps:
While a single version of IBM® Lotus® Quickr supports multiple languages, the Lotus Quickr language feature for the Quickr licensed program is packaged using the English language feature code.
You can add IBM Lotus Quickr to an existing IBM Lotus Domino server for IBM i.
To add Lotus Quickr to a Lotus Domino server:
If you use any IBM Lotus Quickr server that stores content other than English, you must set up the server to generate output using UTF-8 encoding so that page content displays correctly in other languages.
Perform the following steps:
Configure clustering to provide high availability of servers in an IBM Lotus Quickr service. There are two aspects to clustering: configuring IBM Lotus Domino clustering to replicate data across the servers, and configuring a solution for distributing HTTP requests to the servers in the cluster.
When you run a qptool command on a server in a cluster, Lotus Quickr applies the command only to the server on which you run it. The results of the command then replicate to the other servers in the cluster. For example, if you lock a place on one server in a cluster, the place is locked immediately only on that server. The place is locked on the other servers after replication replicates the lock property on the place's databases to the other servers.
Perform the following steps to configure clustered servers:
A Lotus Domino cluster is a group of two to six Lotus Domino servers that provides users with constant access to data, balances the workload between servers, improves server performance, and maintains performance when the size of your enterprise increases. The servers in a cluster contain replicas of databases that you want to be readily available to users at all times. If a user tries to access a database on a cluster server that is unavailable, Domino opens a replica of that database on a different cluster server, if a replica is available. Domino continuously synchronizes databases so that whichever replica a user opens, the information is always identical.
To create a cluster, you must have at least Author access, Delete Documents rights, and the ServerModifier and ServerCreator roles in the Lotus Domino Directory, and at least Author access to the Administration Requests database.
If possible, use the Lotus Domino administration server when creating a cluster. The administration server does not have to be part of the cluster.
See Domino Administration Help for detailed information on creating Lotus Domino clusters and managing cluster replication.
To create a cluster of IBM Lotus Quickr servers, perform the following steps:
You can choose between two methods of distributing HTTP requests to servers in the cluster: load balancing or failover to a "hot-spare." Note that IBM Lotus Quickr requires that HTTP requests sent to one node are continuously sent to that node for a predetermined amount of time known, sometimes referred to as "sticky time."
The typical method is installing and setting up load balancing software. With load balancing, a virtual server is used to distribute HTTP requests so that the physical servers share the user load.
The maximum capacity of the cluster is approximately the sum of the capacities of the servers in the cluster. For example, a cluster of three servers that each support 1,000 users has approximately a maximum capacity of 3,000 concurrent users. However, if one server goes offline, the capacity of the cluster is reduced correspondingly (to 2,000 users in the example).
Therefore, the average capacity of a load-balanced cluster is less than the maximum possible, and allowance should be made for server downtime so that response times do not significantly decrease when a single server becomes unavailable. Having more than two servers in a cluster provides greater flexibility and reliability because when a server is taken offline for scheduled maintenance, failover can still occur among the remaining available servers.
You purchase a load balancing product separately, and set it up following the product documentation.
When you use load balancing, each physical server and place has an entry in the Place Catalog. In addition, there is an entry for the virtual server that represents the combination of all physical servers, and an entry for each place in the cluster that represents all the replicas of the place in the cluster.
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 that correspond 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 that correspond 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.
Use the qptool placecatalog -update command to synchronize the place entries that correspond to the physical servers and the place entries that correspond to the virtual server.
When using the Edge components Load Balancer for IBM® WebSphere® Application Server, the Websphere documentation provides instructions for configuring the load-balanced servers so they will accept a packet that was addressed to the cluster address. For most platforms, this is done by setting or aliasing the loopback device to the cluster address. If the Lotus Quickr servers in the cluster are running on Microsoft Windows 2008 or IBM i, special instructions are needed to properly complete the configuration for the load balanced servers as described in the following topics:
Microsoft® Windows® 2008: See How to configure the loopback adapter on Microsoft Windows 2008
IBM i: See Load Balancing IBM i servers: configuring the loopback device
A less common method for distributing HTTP requests is failover to a hot spare, in which a primary server and a secondary server are clustered. The primary server handles user requests, and the secondary server is held in reserve in case the primary server fails or requires a scheduled stoppage. When the primary server is taken offline, user requests fail over to the hot spare until the primary server comes back online. In this type of cluster, the resources of the hot spare are not utilized while the primary server is active: the capacity of the cluster is the capacity of the primary server. Therefore, if a given server specification supports 1,000 concurrent users, two such servers are required to support 1,000 users. If the hot spare is identical to the primary server, the capacity remains the same after the primary server fails over.
With the hot-spare solution data is maintained in separate entries in the Place Catalog for each physical server, and for each place on a physical server.
You must modify scheduled qptool commands in server notes.ini files.
To ensure that a shared Place Catalog works properly for servers in a cluster, replicate the Place Catalog on the Place Catalog server to the other IBM Lotus Quickr servers in the cluster, and specify the details of the cluster environment in the qpconfig.xml file of each server in the cluster. All servers in a cluster should use the same qpconfig.xml settings.
Perform the following steps:
| Setting |
Description |
|---|---|
| virtual="value" |
The primary (master) server for a cluster acts as a user's entry point to places on other servers in the cluster. If you use the failover to a "hot-spare" clustering solution in which the primary (master) server is a physical IBM Lotus Quickr server, specify virtual="false." If you use the load balancing clustering solution, in which the primary server is an IP sprayer that acts as a "virtual" server, specify virtual="true." |
| ssl="value" |
If SSL is enabled on the primary server, specify ssl="true," otherwise specify ssl="false." Note: Regardless
if you use clustering, setting this to "true" populates the My Places
list with URLs that begin with https rather than http.
|
| <port>value</port> |
Specify the TCP port used to access requests by browsers, depending on whether SSL is enabled on the primary server. The default port is 80 for non-SSL connections and 443 for SSL connections. |
| <hostname>value</hostname> |
Specify the DNS hostname of the primary (master) server (for example, master.acme.com). |
| <path_prefix> value</path_prefix> |
If the Place Catalog (PlaceCatalog.nsf) is located in a subdirectory of the Lotus Domino data directory, type the subdirectory as the path_prefix. This information is used to create URLs to the primary server. For example, on Microsoft Windows, if you put the Place Catalog in the directory C:\domino\data\catalog, type catalog as the path_prefix value. Or if you put the Place Catalog in the directory C:\domino\data\other\catalog, type other\catalog. |
You can install IBM Lotus Quickr 8.5 without an upgrade (no previous version installed), or you can upgrade to Lotus Quickr 8.5 only from Lotus Quickr version 8.2.
The supported upgrade path is from Lotus Quickr 8.2 to Lotus Quickr 8.5. All deployments prior to 8.2 need to upgrade to Quickr 8.2 before upgrading to version 8.5.
The upgrade process ensures the preservation of: data, forms, themes, custom code (such as placebots, views, and other design elements), event hooks or agents, and placetypes.
| Form in 8.5 | Description |
|---|---|
| Upload | Single file upload. This form supports the upload action previously provided the Upload forms for single, multiple, and no attachments in Quickr 8.2. |
| Page | Create a web document with rich text and optional attachments (similar to 8.2) |
| Event | Calendar event (similar to 8.2) |
| Task | Simple task (similar to 8.2) |
| Link | Link page (similar to 8.2) |
| Imported Page | Single file upload with preview on the web. This form supports the import action previously provided by the Microsoft Word, Excel, and Multiple Imported forms in Quickr 8.2. |
| List | Create a list by defining fields or by importing a file |
| Custom Library | To point to an ECM library (only available when ECM is enabled on the server) |
You upgrade to Lotus Quickr version 8.5 from an implementation of Lotus Quickr 8.2.
If you are using IBM Lotus QuickPlace® Version 7.0, you must first upgrade to Lotus Quickr Version 8.0 or 8.0.0.2, and then upgrade to Version 8.1. Once you have upgraded to Quickr 8.1, follow the steps in this section to upgrade to 8.2. Refer to the appropriate instructions for upgrading to Quickr 8.0 or 8.0.0.2 in the Lotus Quickr Version 8.0 information center
Before implementing Lotus Quickr in a production environment, you should consider setting up a staging environment that enables you to perform a side-by-side upgrade to test how well the upgrade process handles any custom themes and placetypes from your Lotus Quickr 8.2 implementation.
You should perform a side-by-side upgrade and migration for a Microsoft Windows 2008 environment. You can run a side-by-side upgrade as follows:
You are ready to upgrade IBM Lotus Quickr servers for your platform on Microsoft Windows, IBM i, or IBM AIX after completing the preparatory steps.
Administrators should upgrade Lotus Quickr places using themes based on the Lotus Quickr 8.2 or older theme to the Quickr Standard Theme (8.5) base to take advantage of the many new theme features and benefit from the added functionality not available in the older themes. When upgrading to 8.5, any place that does not use the Quickr 8.2 Standard theme will not be updated with new features such as the Trash folder, Lists, the Notes calendar overlay, and several other new features. For a given place to display these features, its theme must be changed to the Quickr 8.5 Standard theme, at which point further customizations can be made.
You can use the setTheme qptool command to set the theme for all migrated places to be the standard Lotus Quickr 8.5 theme.
where arguments can be any of those detailed in the following table:
| Argument | Description |
|---|---|
| -? | Prints help on the command |
| -p | Updates the theme for a place or for a comma-delimited list of places. |
| -a | Updates themes for all places. |
You can modify theme attributes in the qpconfig.xml file to enable or prevent certain themes from displaying on the Customize page when users are in the process of creating a new place or customizing an existing place.
The following sample (enclosed within the Start/End of Sample section) shows only the Quickr Standard Theme selected to appear on the Choose a Theme page.
<!-- themes ============= This setting controls Theme-related settings. attribute value default description ========= ===== ======= =========== restrict_choices true Only "allowed" and custom themes may be selected on the "Choose a Theme" page. false yes ALL themes may be selected on the "Choose a Theme" page. <allowed>: quoted comma separated list of themes allowed IF restrict_choices="true", specified by name. <themes restrict_choices="true"> <allowed>"Quickr Standard Theme"</allowed> </themes>
Upgrading the Lotus Quickr server requires upgrading the Lotus Domino server for your appropriate operating system and also requires that you have completed the preliminary steps to prepare your environment for upgrade.
After you have upgraded the Lotus Quickr and Lotus Domino servers for your appropriate operating system, you need to perform several tasks to complete the upgrade process.
Before you upgrade places and PlaceTypes, use the qptool upgrade command to upgrade the design of all databases on the IBM Lotus Quickr server.
To upgrade the design of databases:
load qptool upgrade -f -server
When the upgrade is finished, the qptool.upgrade.xml file is created in the Domino program directory. This file indicates if the upgrade was successful. The qptool.upgrade.xml contains the following xml:
<?xml version="1.0"?>
<service>
<servers>
<server>
<hostname>servername</hostname>
<placetypes/>
<places/>
<action_status action="upgrade">
<code>code number(0 if successful)</code>
<message>error message(if there's an error)</message>
</action_status>
</server>
</servers>
</service>
You need to migrate place catalog statistics for places and rooms from an existing Place Catalog database to the new Place Statistics database by manually refreshing the designs of each database
After you upgrade the design of databases on the server, you can use the qptool server task to upgrade places and PlaceTypes to enable the new features in them. You can upgrade them all at once or incrementally.
Keep the following points in mind about upgrading:
<?xml version="1.0"?>
<service>
<servers>
<server>
<hostname>servername/hostname>
<placetypes/>
<places>
<place>
<name>placename</name>
<action_status action="upgrade">
<code>code number(0 if successful)/code>
<message>error message(if there's an error)/message>
</action_status>
</place>
</places
</server>
</servers>
</service>
You can upgrade individual places and PlaceTypes incrementally, for example, if you have many of them to upgrade.
To upgrade places and PlaceTypes incrementally, enter one of the commands described in the following table:
Task |
Command |
|---|---|
Upgrade one place |
load qptool upgrade -f -p place |
Upgrade multiple places |
load qptool upgrade -f -p place place place |
Upgrade one PlaceType |
load qptool upgrade -f -pt PlaceType |
Upgrade multiple PlaceTypes |
load qptool upgrade -f -pt PlaceType PlaceType PlaceType |
<?xml version="1.0"?>
<service>
<servers>
<server>
<hostname>servername</hostname>
<placetypes/>
<places/>
<action_status action="upgrade">
<code>code number(0 if successful)</code>
<message>error message(if there's an error)</message>
</action_status>
</server>
</servers>
</service>
After you have upgraded places and PlaceTypes, unregister and then re-register the places with the Place Catalog. These steps add place fields to the Place Catalog that might be new in a release. You can unregister and re-register all places at once or do it incrementally. For places that were moved from another server, you only would need to reregister the places.
Use the qptool register command to add place documents in the Place Catalog for places created prior to enabling the Place Catalog or for places added from another server, to adjust server-specific information for a place that has been moved from another server or renamed on the same server, or to restore a place that was previously archived.
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.
To register places, enter the following command at the server console:
load qptool register arguments
where arguments are arguments described in Table 6
| Argument |
Description |
|---|---|
| -? |
Prints help on the command. |
| -placecatalog |
Registers specified place(s) or this server in the Place Catalog. |
-server |
Registers
this server in the Place Catalog.
Note: Requires use of the -placecatalog
argument
|
| -install |
Installs and resets server-specific information for places that have been:
Note: Before you run qptool register -install -a, run qptool
remove -cleanup to avoid creating partial entries in the Place
Catalog associated with places marked for removal.
|
| -a |
Registers all places. |
| -p place(s) |
Specifies a place or a space-separated list of places to register. |
| -pt place(s) |
Specifies a place type or a space-separated list of place types to register. |
-pts |
Registers all place types. |
| -i inputfilename |
XML input file located in the server program directory that specifies the places to register. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.register.xml in the server program directory. |
Table 7 provides examples of using the qptool register command for places.
| Task |
Command |
|---|---|
| Register a place that has been moved from another server, renamed on the current server, or restored from archive |
>load qptool register -p placename -install |
| Register a place in the Place Catalog only |
>load qptool register -p placename -placecatalog |
| Register multiple places that have been moved from another server |
>load qptool register -p place1 place2 place3 -install |
| Register all places on the server in the Place Catalog after upgrading to the current release and enabling the Place Catalog |
>load qptool register -a -placecatalog |
| Register places specified in an input file |
>load qptool register -i qptool.myinput.xml |
| Register a place and log results in a non-default output file |
>load qptool register -p placename -o qptool.myout.xml |
Enable Domino Attachment and Object Service (DAOS) to consolidate attachments in databases in a separate repository on the server so that they can be retrievable by reference.
To enable Domino Attachment and Object Service (DAOS), an administrator needs to mark multiple selected databases for attachment consolidation as follows:
Users can upgrade their connectors without having uninstall their previous versions.
Before upgrading connectors on client workstations, make sure users have the required versions of the applications already installed on the client workstations. The application requirements of the latest Lotus Quickr Connectors are as follows:
The following upgrade paths have been tested and are supported:
If you use Lotus Quickr Entry places on an IBM Lotus Quickr 8.2 server, and want to keep using them, you need to keep that Quickr 8.2 server running. Lotus Quickr Entry is not supported on a Lotus Quickr 8.5 server. Lotus Quickr Entry places should remain on a Lotus Quickr 8.2 server.
Uninstall the product for supported platforms.
Uninstall IBM Lotus Quickr on IBM AIX or Linux.
Uninstalling IBM Lotus Quickr on IBM i involves removing Lotus Quickr from all of the Lotus Quickr servers before uninstalling it.
Use the Remove IBM Lotus Quickr from a Domino Server command to remove IBM Lotus Quickr from a Lotus Domino server on IBM i.
The Remove Lotus Quickr from a Domino Server command makes the following changes to a Domino server:
To perform this task, you must have *ALLOBJ, *IOSYSCFG, *JOBCTL, and *SECADM special authorities. To remove Lotus Quickr from a Domino server, follow these steps.
Configure services for Lotus Domino to suit the needs of your organization and environment.
You use an XML configuration file, qpconfig.xml file, to perform many server configuration tasks. The server comes with a sample file, qpconfig_sample.xml, which is installed in the server data directory and which you use as a template.
To create and use the qpconfig.xml file, perform the following steps:
IBM Lotus Quickr for IBM i provides additional functions that enable you to change server properties and to change language dictionaries.
Connecting to a user directory, although optional, maximizes the features available to you.
If a IBM Lotus Quickr server that runs on IBM i is behind a firewall and you plan to do user lookups in an LDAP directory that is outside the firewall, your system administrator must configure Client Socks support using IBM i Navigator.
For details of how to configure Client Socks support, see one of the following:
http://www.ibm.com/eserver/iseries/infocenter
http://www.ibm.com/redbooks
When you set up directory services to connect the server to a user directory, administrators and place managers can add members to places by selecting names from the directory. Without a user directory, they must instead register local members in the membership database (Contacts1.nsf) of individual places.
Connecting to a user directory maximizes the features that are available to you. The following features are supported only when a user directory is in use:
You can set up IBM Lotus Quickr to control directory services or set up the underlying Lotus Domino server to control directory services.
Table 8 highlights some of the benefits and limitations of these directory services configurations.
Feature support |
Lotus Quickr control of directory services |
Lotus Domino control of directory services |
|---|---|---|
User Authentication |
Supports only Domino basic name-and-password authentication or multi-server session-based (single sign-on) authentication. |
Supports any user authentication method configured on the Lotus Domino server |
Domino Internet Site documents |
Not supported and Domino server cannot use |
Supported |
Directory |
Supports one LDAP directory, and an optional additional LDAP directory for Lotus Quickr expanded membership use |
Supports access to any directory that Lotus Domino server can access, including multiple directories accessed through Domino directory assistance |
Lotus Quickr expanded membership |
Supported |
Not supported |
Each supported directory services configuration has its own method and options for connecting to an LDAP directory.
Both directory services configurations support connections to an LDAP directory, a directory accessed through the Lightweight Directory Access Protocol (LDAP). Table 9 describes where to find the LDAP directory connection options, depending on which directory services configuration you use.
| Option | Location when Lotus Quickr controls directory services | Location when Lotus Domino controls directory services |
|---|---|---|
| LDAP directory server port |
Site Administration - User Directory page |
Domino Directory and Directory Assistance document |
| Secure Sockets Layer (SSL) connections |
Site Administration - User Directory page |
Domino Directory and Directory Assistance document |
| SSL protocol to use |
qpconfig.xml |
Directory Assistance document |
| Whether expired SSL certificates accepted |
qpconfig.xml |
Directory Assistance document |
| Whether server certificate must include host name |
qpconfig.xml |
Directory Assistance document |
| Different search bases for groups and users |
qpconfig.xml |
Naming rules in Directory Assistance document |
| Control of attributes that display in Lotus Quickr interface |
qpconfig.xml |
None |
| Control of attributes that display in Lotus Quickr directory lookup interface |
qpconfig.xml |
None |
| Searches narrowed to names that are part of place name |
Site Administration - User Directory page |
None |
| Distinguished names that do not conform to the Domino naming convention |
qpconfig.xml |
Directory Assistance document with all-asterisk naming rule |
| Custom search filter for user authentication |
qpconfig.xml |
Directory Assistance document |
| Custom search filter for group authorization |
qpconfig.xml |
Directory Assistance document |
| Custom search filter for adding group members to places |
qpconfig.xml |
None |
| Custom search filter for adding user members to places |
qpconfig.xml |
None |
| Control whether nested groups are searched |
qpconfig.xml |
Directory Assistance document |
| Control levels of nested group searches |
notes.ini |
None |
| Search timeout |
Site Administration - User Directory page |
Directory Assistance document |
| Maximum entries returned |
None |
Directory Assistance document |
| Attribute to be used as name in SSO token |
None |
Directory Assistance document |
| Control over alias dereferencing |
None |
Directory Assistance document |
| Support of directory change detection |
None |
Directory Assistance document |
The behavior that users see when accessing places through membership in an external group can be different than when accessing places through individual membership.
Table 10 summarizes the differences users see when accessing places through external group membership.
Feature |
User experience when accessed through external group membership |
|---|---|
Current user link |
Link shows the member's name rather than the group name. There is no member profile available through the link. |
Editor access |
When a member of a group edits a page, other members of the group do not see the status of the page as checked out. |
Members list |
Members list shows the group name rather than the names of the members. |
Member profile |
Member profile for the group shows the group name. Members of the group do not have profiles, unless they also have access through individual membership. |
Page author |
Page author shows the members of a group rather than the group name. |
Search pages by author |
You can search by member of a group, not by group name. |
Place invitations |
A place invitation is sent to each member of a group. |
Notifications |
A page notification shows the e-mail address of the member of the group who sent it. The sender can send to the group name or can select specific members to send to. Ability to select specific members is controlled through the qpconfig.xml file. |
What's new e-mails and calendar event subscriptions |
Members of a group cannot receive what's new e-mails or calendar event subscriptions because they do not have profiles in which to set the preferences to receive them. |
Form workflow: editor-in-chief approval cycle |
Members of groups cannot submit or approve workflow pages because they don't have a required Member profile. |
Custom member lookup interface controlled through the qpconfig.xml file (when IBM Lotus Quickr controls directory services) |
Customizations to the member lookup interface do not apply to groups. |
IBM Lotus Sametime awareness |
Awareness is not available for members of a group from the Members Online window, but is available elsewhere in the context of a place. |
Work offline |
Members of groups cannot work offline. |
IBM Lotus Quickr supports some special characters in user and group names.
Special character |
Allowed for local users |
Allowed for local groups |
Allowed for external users and groups |
|---|---|---|---|
@ |
Yes |
No |
No |
< |
No |
No |
No |
> |
No |
No |
No |
& |
No |
No |
No |
: |
No |
No |
No |
; |
No |
No |
No |
^ |
No |
No |
Yes |
, (comma) |
No |
No |
Yes |
= |
No |
No |
Yes |
( |
No |
No |
Yes |
) |
No |
No |
Yes |
# |
No |
No |
Yes |
\ |
No |
No |
Yes |
/ |
No |
No |
Yes |
| |
No |
No |
No |
* |
No |
No |
No |
+ |
No |
No |
Yes |
" |
No |
No |
No |
' (apostrophe) |
Yes |
Yes |
Yes |
Setting up the underlying IBM Lotus Domino to control directory services enables you to take advantage of the directory services and authentication methods that Lotus Domino supports.
Perform the following steps to set up Lotus Domino to control directory services.
When you set up IBM Lotus Quickr to control directory services, you specify an LDAP directory server to connect to.
If in the future you want to change the LDAP directory that Lotus Quickr uses, repeat these steps. If there are distinguished names in the new directory that are different from the names in the original directory, use the qptool changehierarchy or changemember command to update the names in places.
Use qpconfig.xml and notes.ini settings to customize IBM Lotus Quickr control of directory services.
Users and groups in an LDAP directory are described by a variety of attributes. For example, the value for a user's first name is often stored as the givenname attribute and the last name as the sn (surname) attribute. Not all LDAP directories define attributes in the same way.
To display accurate information about users and groups in the IBM Lotus Quickr user interface, such as names, phone numbers, and e-mail addresses when Lotus Quickr controls directory services, you might need to change some of the default attributes. For example, by default the Lotus Quickr assumes an LDAP directory uses the sn attribute to define a user's last name. However, if your LDAP directory uses the lastname attribute instead, you must use the qpconfig.xml file to specify the correct attribute.
Perform the following steps to customize the attributes displayed for users and groups:
If IBM Lotus Quickr control directory services, you can use the qpconfig.xml file to customize the attributes it looks for during various types of searches.
When an external member logs in to a place, by default the server searches the cn, uid, and shortname attributes in the LDAP directory for matches to the login name. You can use the qpconfig.xml file to specify other attributes for which to search.
Perform the following steps:
For example, to look for a login name in the cn attribute or in the mail attribute, change the authentication element in qpconfig.xml to: <authentication><![CDATA[(| (cn={0})(mail={0}))] ]></authentication>
Note that the zero {0} is required. The authentication filter looks for only one name value in an attribute.
When someone types a name in the directory lookup interface to search for name to add as a place member, by default the server expects a last name, optionally followed by a comma (,) and first name, and searches for the last name in the sn attribute and the first name in the givenname attribute. By default the server also assumes that names are found in entries defined as objectclass=person. You can use the qpconfig.xml file to specify other attributes for which to search and a different object class definition.
Perform the following steps:
For example, to search for the second specified name as a value for the mail attribute rather than the givename attribute, change the line as follows:
<![CDATA[(&(objectclass=person)(sn={0})(mail={1}))]]>
Note that zero {0} and one {1} indicate the first and second, comma-separated input values, respectively. Lotus Quickr does not accept more than two input values for the name.
If you customize this search filter, you should also customize the hint the interface provides for searching and possibly other directory lookup user interface settings.
When someone types the name of a group in the directory lookup interface to search for a group name to add as a place member, by default the server searches for the group name in the cn attribute of groups defined as objectclass=groupOfNames You can use the qpconfig.xml file to specify a different attribute for which to search and a different group object class definition.
Perform the following steps:
For example, to search for the objectclass value groupOfUniqueNames and search for the name in the grouptitle attribute, change the line as follows, where the zero {0} indicates that Lotus Quickr looks for only one name as input for a group name. :
<group_lookup><![CDATA [(&(objectclass=groupOfUniqueNames)(grouptitle={0}))]]></group_lookup>
After the server authenticates a user, it searches for all the groups of which the user is a member, in order to determine user access to places through group membership. By default the server searches for the users' names in the member attribute of groups defined as as objectclass=groupOfNames You can use the qpconfig.xml file to specify a different attribute for which to search and a different group object class definition.
Perform the following steps:
For example, to search for the objectclass attribute value groupOfUniqueNames and the uniquemember attribute value, change the line as follows, where the zero {0} indicates that Lotus Quickr looks for only one name as input for a group name.:
<group_membership><![CDATA[(&(objectclass=groupOfUniqueNames)(uniquemember={0}))]]></group_membership>
When a user searches the directory for a user or group to add to a place, whether or not the user selects the Exact Match search option has an effect on the search filters that is used.
For example, Table 12 describes the search filter used for user name lookups when one value and two comma-separated values are entered, depending on the Exact Match setting.
<user_lookup><![CDATA[(&(objectclass=person)(sn={0})(mail={1}))]]></user_lookup>
If IBM Lotus Quickr controls directory services, use the qpconfig.xml file to customize the user interface that users see when looking up users in the directory to add as place members. You can customize the search hint and also customize how the user interface displays the results of user searches.
By default the directory lookup interface prompts users to search for user names by typing last name, first name. If you have customized the user lookup search, also customize the search hint to reflect the change.
Perform the following steps:
For example, if you specified the following line in the <user_lookup> element of qpconfig.xml:
<user_lookup><![CDATA[(&(objectclass=person)(sn={0})(mail={1}))]]></user_lookup>
you might then specify the following line in the <search_ui_hint> element:
<![CDATA[( enter <B>last name, email</B>)]]>
By default, when a user searches for users in the directory, the search results show the values for the sn and givename attributes in the first column, distinguished names in the second column, and the sn attribute in the range field at the top of the search results box. To display different attribute values, change the values for the member_lookup_ui and search_ui_index elements in the qpconfig.xml file.
Perform the following steps:
For example, display the sn and mail attribute values in the first results column, specify:
<column_name> <person>sn, mail</person> </column_name>
If IBM Lotus Quickr controls directory services, the qpconfig.xml must be customized. Sample qpconfig.xml files are provided for Sun Java System Directory Server or IBM Tivoli Directory Server.
Because each directory can have a custom configuration, it is important to verify these with the LDAP directory administrator. The default values are assumed for omitted settings.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<server_settings>
<user_directory>
<ldap>
<schema>
<group>
<object_class_value>groupOfUniqueNames</object_class_value>
<member>uniquemember</member>
</group>
</schema>
<search_filters>
<group_lookup><![CDATA[(&(objectclass=groupOfUniqueNames)(cn={0}))]]>
</group_lookup>
<group_membership><![CDATA[(&(objectclass=groupOfUniqueNames)(uniquemember={0}))]]>
</group_membership>
</search_filters>
</ldap>
</user_directory>
</server_settings>
By default, the search base you specify when you connect to an LDAP directory server is used for both user and group searches. You can use the qpconfig.xml file to specify a search base specifically for group searches.
For example, if the names of the groups you want to search are under ou=groups,o=acme in the directory name hierarchy, you could specify ou=groups,o=acme as the search base for groups so that only that branch of the directory is used for group searches.
Perform the following steps:
If your directory has nested groups -- groups within groups -- that contain the names of IBM Lotus Quickr users, use a notes.ini file setting to allow searches of the nested groups.
If you selected the option Check for SSL connection with LDAP user directory when you set up the connection to the LDAP directory server, optionally use qpconfig.xml settings to customize the Secure Sockets Layer (SSL) connection.
Setting |
Description |
|---|---|
protocol="number" |
Type one of the following numbers to specify the SSL protocol used for the connection to the LDAP server: 0 - Negotiated (default) 1 - LDAP V2.0 only 2 - LDAP V3.0 handshake 3 - LDAP V3.0 only 4 - LDAP V3.0 with V2.0 handshake |
accept_expired_certs="value" |
Type "false" to prevent Lotus Quickr from accepting a certificate from the LDAP server if the certificate has expired. Type "true" (the default) to accept a certificate that has expired. |
verify_servername="value" |
Type "false" to prevent Lotus Quickr from verifying whether the LDAP server host name matches the host name in the SSL certificate. Type "true" (the default) to require that the host name matches the host name in the certificate. Note: If the value is set to "true"
but the host name does not match the host name in the certificate,
then LDAP authentications fail.
|
If IBM Lotus Quickr runs on IBM AIX use a notes.ini file setting to allow the use of accented characters in LDAP directory user names.
If the connection is done to the LDAP directory server anonymously (that is, without supplying credentials), the LDAP directory server must allow anonymous access to the attributes used by Lotus Quickr. You can use the Lotus Domino ldapsearch tool to test the server access to LDAP attributes.
To test access to attributes, from the program directory on the Lotus Quickr server, enter a command such as the following one:
ldapsearch -h ldap.acme.com cn=arch*
In this example, ldap.acme.com is the LDAP directory server. The command returns the list of accessible users with common names that begin with the string "arch". If your LDAP directory server is configured to allow access only with specific credentials, you can use the same search, supplying the credentials on the command line:
ldapsearch -h ldap.acme.com -D [username] -w [password] cn=arch*
Using the ldapsearch tool is one of the first steps to take when troubleshooting LDAP directory problems. If you cannot do lookups using ldapsearch there is an underlying network or directory server problem. For more information on ldapsearch, see Domino Administrator Help.
If you use the Domino Directory as your LDAP directory, fields in the Domino Directory are mapped to LDAP attributes. To view the mapping, open the Domino LDAP Schema database (schema.nsf) on the server. Lotus Quickr and ldapsearch use the attribute names rather than field names. For example, the field OfficePhoneNumber in the Domino Person document is mapped to the LDAP attribute telephonenumber. Telephonenumber is the name used in ldapsearch and in Lotus Quickr.
If Domino is your LDAP directory and Lotus Quickr connects to it anonymously, you can edit the Domain Configuration Settings document in the Domino Directory to update the list of attributes allowed for anonymous access. For more information on setting access to a Domino LDAP directory, see Domino Administrator Help.
If you disconnect from a user directory, place managers can specify only local members. Any existing external place members no longer have access to the places.
The Place Catalog is a database that collects information about IBM Lotus Quickr places and servers. A local Place Catalog is enabled by default on each Lotus Quickr server.
| Element or attribute |
Description |
|---|---|
| place_catalog enabled |
The place_catalog section contains settings to enable the server to use a Place Catalog. Set the "enabled" attribute to "true" to tell the server to search for an existing Place Catalog. The default setting is enabled="true." To prevent the server from looking for a Place Catalog, change the enabled attribute to enabled="false" or remove the entire <place_catalog> section. |
| log_level |
You can log operations related to the Place Catalog in the Domino server console as follows: Level 1 - Logs all Catalog database open and close operations Level 2 - Logs all server registration operations Level 3 - Logs all place registration operations Level 4 - Logs all member registration operations Each level also includes the information in the levels below it. |
| connection_pool size |
For efficiency, the Lotus Quickr server creates a pool of connections to the Place Catalog that can be shared by the different requests the server receives. This number should reflect the number of simultaneous requests that could result in a query or update to the Place Catalog. These types of requests include creation of places, the addition of or changes to place membership, and administration requests made by qptoo1. You may want to start with a number representing a third of the maximum HTTP threads. For example, if the server uses 90 threads, then set this value to 30. |
| domino_server_name |
Type the Domino hierarchical name of the Place Catalog server, for example, PlaceCatalog/Acme. If this server will use a Place Catalog on a different server, specify the name of that server. |
| nsf_filename |
Specify the name of the Place Catalog database, for example, PlaceCatalog.nsf. If this server will use a Place Catalog on a different server, specify the database name of that Place Catalog on that server. |
The Place Catalog contains data on IBM Lotus Quickr servers, and the places, rooms, and members on those servers. Each server, place, and room has a separate entry in the Place Catalog. An entry is implemented as an IBM Lotus Notes document.
The Place Catalog enables administrators to use the qptool report command, or an XML interface to the Lotus Quickr Java XML API, to report statistics on places and servers. It enables place members to use My Places to see a list of places they belong to and statistics about those places, as well as to search content across places and servers.
The following figure shows an example of a Catalog entry for a place named "place1:"

The following figure shows a Place Catalog entry for a Lotus Quickr server called "server1.acme.com."

Some events cause immediate updates to the Place Catalog, while others cause updates only after the qptool placecatalog -push command is run. By default, a server notes.ini file includes the setting ServerTasksAt3=qptool placecatalog -push -a so that the command runs daily at 3 A.M.
The following table describes the events that cause immediate updates to the Place Catalog:
| Event |
Description |
|---|---|
| Server registration or unregistration |
A server becomes part of the service when qptool register -server command is issued, or when a place is created on the server. When a place is created, an entry for the server is immediately created in the Catalog if one does not already exist. Similarly, when qptool unregister -server is issued, the entry for the server is immediately removed from the Catalog. |
| Place removal by qptool unregister |
The server's place entry is removed. If the place is part of a Lotus Quickr server cluster with a virtual server, the virtual server place entry is also removed. |
| Place creation from a browser or by qptool register |
A new entry is created. The Place Catalog server must be running for users to create new places in the service. If the place is created on one server in a cluster, an entry for the virtual server is also created. |
| Place creation on a cluster server node by qptool replicamaker |
A place entry for that server cluster node is created. |
| Place deletion from a browser or by qptool remove |
The place's entry is deleted. Its name cannot be used for a new place until the qptool remove -cleanup command has run, either automatically overnight, or manually by the administrator. In a cluster environment, this would have to be done on all cluster nodes. |
| Place deletion in a cluster server node by qptool remove -cleanup |
The place's entry for that server node is deleted from the catalog. |
| Member creation |
The new member is added to the place entry with the proper access level. |
| Member removal |
The member is removed from the place entry. |
| Member access change |
The member moves to the field appropriate to their new access level. |
| Place accessed |
The PlaceLastAccessed field is updated, which can take up to a minute. |
Place login |
The LoginCounts field value is incremented. |
Document read |
The DocReadCounts field value is incremented. |
Posting |
The PostingCounts field value is incremented. |
| Place locking by qptool lock |
The PlaceIsLocked field of the Place Catalog entry is set to 1. If the place is in a cluster with a virtual server, the PlaceIsLocked field in the virtual server entry is also set to 1. |
| Place unlocking by qptool unlock |
The PlaceIsLocked field of the Place Catalog entry is set to 0. If the place is in a cluster with a virtual server, the PlaceIsLocked field in the virtual server entry is also set to 0. |
In the event that the Place Catalog becomes corrupt or if the server names or have changed, a rebuild of the placecatalog.nsf database using the placecatalog.ntf template may be required. This also requires a re-register of all servers and places to populate the placecatalog.nsf database with the required documents. This procedure should be performed when there is no user activity on the server as this will affect the My Places and other features of Quickr Domino.
Configuring security for the IBM Lotus Quickr involves configuring user authentication, configuring user access to the server, as well as performing other miscellaneous security configuration tasks.
By default, the server uses basic name-and-password authentication to authenticate place members that connect through Web browsers or Lotus Quickr connectors. If you configure the server to connect to a user directory, there are additional methods available for authentication of external members, with the methods available dependent on whether IBM Lotus Quickr or IBM Lotus Domino controls directory services.
If Lotus Quickr controls directory services, you can use the default basic name-and-password authentication or multi-server session-based name-and-password authentication (single sign-on). With single sign-on, users can log in to a server once and during that session automatically access any server enabled for single sign-on in the DNS domain without providing names and passwords again.
If Lotus Domino controls directory services, you can use multi-server single sign-on internet client authentication, or SSL certificate authentication. For information on configuring user authentication when Lotus Domino controls directory services, see Domino Administrator Help.
In addition to these authentication methods, Lotus Quickr supports the use of custom authentication applications through the Domino Server API (DSAPI). This interface allows some third-party vendors to design a DLL to support authentication for access to Lotus Quickr place databases.
After a IBM Lotus Quickr server successfully authenticates a user, it adds the user's name, password, and the groups of which the user is a member to its user cache. The next time the user attempts to authenticate, the server can quickly access the information in the cache to speed up authentication. You can modify the maximum number of user entries allowed in the cache and the length of time the entries remain in the cache.
A user with administrator access can control who has administrator access to the IBM Lotus Quickr server, who can create places on the server, and who has super user access to the server.
A user with administrator access can use the Site Administration link to perform a variety of administrative tasks, can create and delete places and PlaceTypes, and can control which users can create places. You created a local administrator as part of server installation. You can give additional users administrator access.
Use the Site Administration link to add or remove administrator access for external users.
Perform the following steps:
You can use the Site Administration link to add and remove local administrators, and to modify local administrator names, passwords, and e-mail addresses. Note that you cannot remove or modify the local administrator account that you created during server installation.
Perform the following steps:
If IBM Lotus Quickr controls directory services and the second component of a user's distinguished name in an external directory is cn, by default the server converts the cn component to ou in the access control lists of places. You can fix this by specifying a qpconfig.xml file setting.
If you experience authentication failures because of this behavior, correct the problem by specifying the following setting in the qpconfig.xml file to retain second cn components found in names:
<user_directory>
<ldap>
<schema>
<secondary_cn_component enabled="true"/>
</schema>
</ldap>
</user_directory>
As administrator, you can allow only specific users to create places or you can allow all users who have access to the server to create places. Someone with super user access to the server can create places without being given this access explicitly.
If the server is connected to a user directory, use the Site Administration link to specify the names of external users who you want to allow to create places.
Perform the following steps:
Use the Site Administration link to specify the names of any local users who you want to allow to create places.
Perform the following steps:
You can allow all users who can access the server to create places on it. This access is not allowed by default.
Perform the following steps:
A user granted owner (formerly known as super user) access to the server can read and edit every page in every place, customize every place, control the membership of every place, create places, and use the Site Administration link to perform administration tasks. By default, no owner is defined.
Use the qpconfig.xml file to specify who has super user access to the server when accessing it from a browser. You can specify only one name as a super user, either an external user or an external group name.
Create a group in the Lotus Domino Directory to specify who has super user access when accessing the server from a IBM Lotus Notes client.
You can set up expanded membership, use the qpconfig.xml file to enable the feature on the server, use the Site Administration link to configure the name and password to use to connect to the LDAP directory, and use qptool to enable expanded membership in a place or places.
To enable the Expanded Membership Model (EMM) on the server, use the qpconfig.xml file.
| Setting | Description |
|---|---|
expanded_membership_model enabled=value |
Type "true" to enable expanded membership or "false" to disable it. Do not type "false" if any places are set up to use expanded membership. |
ldap_server ssl=value |
Specify "true" to use SSL encryption when connecting to the LDAP directory server that will store the expanded membership groups. Otherwise, specify "false." |
ldap_server port value |
Type the port number for the LDAP directory server that will store the expanded membership groups. Typically an LDAP server uses port 389 for unencrypted connections and port 636 for SSL connections. |
ldap_server hostname value |
Type the host name of the LDAP directory server that will store the expanded membership groups. The host name can be the LDAP server that IBM Lotus Quickr already uses, or a different one. You must specify a host name, regardless. The directory must allow write access. |
ldap_server base_dn value |
Type the base distinguished name (directory
node) under which to create the groups. The base distinguished name
must already exist in the directory - the server does not create it.
The components of the base distinguished name do not have to be O
and OU. Do not use "OU=QP" as part of the base distinguished name
because that is a reserved organizational unit in Lotus Quickr. If
the directory server that stores the expanded membership groups is
the same one that Lotus Quickr uses for other purposes, for better
performance, specify a base distinguished name for the expanded membership
groups that is outside the base used for group lookups generally.
For example, if the base specified for group lookups generally is
OU=groups,O=acme, use a different base for the expanded membership
groups, for example OU=emmgroups,O=acme. Using separate base distinguished
names for the two types of groups optimizes performance by preventing
unnecessary searches of the expanded membership groups during the
process of user authentication.
Note: If you use Microsoft Active
Directory, you must create
a user entry in the directory that begins with CN=h_VirtualMember
at the specified base_dn. For example, if you specify OU=emmGroups,DC=acme,DC=com
as the base_dn, in Active Directory create the following user entry:
CN=h_VirtualMember,OU=emmGroups,DC=acme,DC=com.
|
Configure a user name and password for the IBM Lotus Quickr server to provide when connecting to the LDAP directory server that stores the expanded membership groups. The name and password must correspond to a valid user record in the directory, and the name must have write access to the base distinguished name used for the expanded membership groups.
If the directory allows anonymous write access to the base distinguished name (not a typical configuration), this step is unnecessary.
Perform the following steps:
If you have enabled expanded membership on the server, use the qptool membershipmodel command to enable expanded membership in one place, specific places, or all places. The effective use of groups in the LDAP directory is the best approach to handling large member access lists.
After you have enabled expanded membership in a place, reverting the place to standard membership is not supported. If there are replicas of a place, run the command on one replica only.
load qptool membershipmodel argumentswhere arguments are arguments described in the following table:
| Argument |
Description |
|---|---|
| -? |
Prints help on the command. |
| -toexpanded |
Converts places to expanded membership. |
| -a |
Runs the command on all places that do not currently use expanded membership |
| -p places |
Runs the command on a place or a space-separated list of places. |
| -i inputfilename |
Runs on places specified in an XML input file. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.membershipmodel.xml in the server program directory. |
Table 18 provides examples of using the membershipmodel command to enable expanded membership in places.
| Task |
Command |
|---|---|
| Enable "placeofmanymembers" to use expanded membership. |
>load qptool membershipmodel -toexpanded -p placeofmanymembers |
| Enable all places that do not currently use expanded membership to use expanded membership. |
>load qptool membershipmodel -toexpanded -a |
After a user logs in to a place, the interface displays the Log Out link, and when the user logs out, the Log In link. You can hide the Log In and Log Out links after a user logs in. You might want to do this if single sign-on is enabled on the server, or if the server is running on a public pedestal, for example, at a trade show.
Perform the following steps to hide the Log In and Log Out links after initial log in:
For additional security, configure the server to clear the Internet Explorer browser cache on user logout, and to prevent caching of IBM Lotus Quickr pages in browsers.
This feature is supported for Internet Explorer only and only applies to blogs or wikis still using the ActiveX control. In Lotus Quickr 8.5, standard places no longer use the ActiveX control, so this setting is not applicable for them.
As a security measure, configure the server to clear the IBM Lotus Quickr files (files from any URL that contains "/quickplace/" or "/quickr/" ) from the browser cache when users click Log Out from places. The browser cache is cleared only if the sign_out element in the qpconfig.xml file is set to true, if ActiveX controls are enabled on the server, and if ActiveX is enabled on the browser. Internet Explorer enables ActiveX by default.
The Log 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 Log Out link is unavailable to all users if you configure the server to hide the Log Out link. If the Log Out link is unavailable for any of these reasons, you can configure the server to prevent caching of Lotus Quickr pages on browsers.
To configure the server to clear Lotus Quickr files from the Internet Explorer cache, perform the following steps:
By default, the server caches on browsers all IBM Lotus Quickr pages that users access. As a security measure, use the qpconfig.xml file to allow the server to cache only pages that do not contain data.
Any IBM Lotus Quickr 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.
Perform the following steps to prevent caching pages that contain data:
As an administrator, you can configure several security settings for your system in the qpconfig.xml file. You can configure settings to guard your server against cross-site scripting attacks. Additionally, you can predefine a set of uploadable file types and create a set of privileged users that can upload files of file types in addition to the predefined file types.
Perform the following steps:
The following example describes the required security settings in qpconfig.xml for a system that provides protection against cross site scripting attacks, restricts users to upload files of file types, .txt,.pdf,.doc,.ppt,.xls,.docx,.pptx,.xlsx,.png,.jpg,. and gif only, and does not allow upload of files that contain link fields with schemes other than http, https, ftp and linkto.
Further, the following settings grant privileges to users, Lotus Quickr Admin and Lotus Domino Admin, to upload files of additional file types, .html,.htm,.css,.java,.lss.
<security>
<xss_protection enabled="true" />
<urilink_field_protection enabled="true">
<allowed_schemes>ftp,mailto</allowed_schemes>
</urilink_field_protection>
<uploadable_filetypes enabled="true">.txt,.pdf,.doc,.ppt,.xls,.docx,.pptx,.xlsx,.png,.jpg,.gif</uploadable_filetypes>
<privileged enabled="true">
<users>
<dn>cn=Lotus Quickr Admin,o=ibm</dn>
<dn>cn=Lotus Domino Admin,o=ibm</dn>
</users>
<uploadable_filetypes enabled="true">.html,.htm,.css,.java,.lss</uploadable_filetypes>
</privileged>
</security>
To make your implementation of IBM Lotus Quickr services for Lotus Domino FIPS compliant (which provides stronger protection for ID files, mail and documents, and single sign-on (SSO) configurations), you need to enable FIPS on a reverse proxy server that uses the Caching Proxy and Load Balancer Edge components included with the WebSphere Application Server. The reverse proxy server must be enabled for SSL and FIPS so that all requests to Lotus Quickr services for Domino go through the proxy.
Your users can use connectors to work with documents on a IBM Lotus Quickr server from their desktop applications. Users can use IBM Lotus Sametime features within places, if you enable that capability on the server.
IBM Lotus Quickr supports several features in Lotus Connections and is correspondingly supported by them.
The following features are available:
The following steps provide an overview of the process of integrating Lotus Connections and IBM Lotus Quickr.
The Lotus Quickr server, Lotus Connections server, and Lotus Domino server must use the same LDAP server and be in the same domain.
The Lotus Quickr, Lotus Connections server, and WebSphere® Application Server must use the same LDAP server and be in the same domain.
Refer to the Lotus Quickr wiki for the most recent deployment details for Siteminder, the HTTP server, proxy servers, and Tivoli Access Manager.
The first two steps (and associated substeps) need to be performed on the Lotus Connections server and are fully documented in the Lotus Connections information center (which is linked-to from these steps). The instructions pointed out here are provided to reinforce certain important tasks for integration.
The attribute values that initially appear in the communities-quickr-config.xml file are dictated by choices you make during the installation process. If you need to change your default configuration, refer to this sample of the communities-quickr-config.xml file.
Each enabled placetype template shows up as a separate associated application on the Edit Community form. A maximum of five associated applications can appear. For the Standard placetypes, administrators typically change just the enabled attribute and perhaps the role assignments, but they can also add custom placetypes.
| Attribute | Description |
|---|---|
| comm:QuickrPlaceType, | For each place type, the name attribute must be unique. |
| comm:managedApplicationTypeID | The ID must be unique, never change, and be 24 bytes or less. |
| comm:placeTemplate | The template name to be used when creating a place, such as Team Place and Team Wiki for a Lotus Quickr services for WebSphere Portal implementation. |
| comm:server | This value must match the name in the comm:QuickrServer element described in Table 2. |
| comm:resourceBundleName | The name of a property file on the Communities
application classpath for strings presented in the user interfaces.
The file must have the following keys:
|
| comm:ownersRole comm:membersRole comm:publicRole | Role names can be either the role title in English or the id field returned for the roles feed. If anonymous access is not allowed, the comm:publicRole element should be omitted or left empty. |
| comm:contentFeedLink | Optional. Name of the link field in a place
entry to be used for the place's feed.
|
<comm:QuickrPlaceType name="DominoWiki" enabled="true"> <comm:managedApplicationTypeID>QuickrDominoWiki</comm:managedApplicationTypeID> <comm:placeTemplate>Wiki</comm:placeTemplate> <comm:server>DefaultServer</comm:server> <comm:resourceBundleName>com.acme.lconn.comm.quickr.resources.QuickrWikiResources</comm:resourceBundleName> <comm:ownersRole>Manager</comm:ownersRole> <comm:membersRole>Editor</comm:membersRole> <comm:publicRole>Reader</comm:publicRole> <comm:contentFeedLink>content</comm:contentFeedLink> </comm:QuickrPlaceType> <comm:QuickrPlaceType name="DominoTeamPlace" enabled="true"> <comm:managedApplicationTypeID>QuickrDominoTeamspace</comm:managedApplicationTypeID> <comm:placeTemplate>h_StdPlaceType</comm:placeTemplate> <comm:server>DefaultServer</comm:server> <comm:resourceBundleName>com.acme.lconn.comm.quickr.resources.QuickrTeamspaceResources</comm:resourceBundleName> <comm:ownersRole>Manager</comm:ownersRole> <comm:membersRole>Editor</comm:membersRole> <comm:publicRole>Reader</comm:publicRole> <comm:contentFeedLink>content</comm:contentFeedLink> </comm:QuickrPlaceType> <comm:QuickrPlaceType name="PortalWiki" enabled="false"> <comm:managedApplicationTypeID>QuickrPortalWiki</comm:managedApplicationTypeID> <comm:placeTemplate>Team Wiki</comm:placeTemplate> <comm:server>DefaultServer</comm:server> <comm:resourceBundleName>com.acme.lconn.comm.quickr.resources.QuickrWikiResources</comm:resourceBundleName> <comm:ownersRole>Managers</comm:ownersRole> <comm:membersRole>Editors</comm:membersRole> <comm:publicRole>Readers</comm:publicRole> <comm:contentFeedLink>wikis</comm:contentFeedLink> </comm:QuickrPlaceType> <comm:QuickrPlaceType name="PortalTeamPlace" enabled="false"> <comm:managedApplicationTypeID>QuickrPortalTeamspace</comm:managedApplicationTypeID> <comm:placeTemplate>Team Place</comm:placeTemplate> <comm:server>DefaultServer</comm:server> <comm:resourceBundleName>com.acme.lconn.comm.quickr.resources.QuickrTeamspaceResources</comm:resourceBundleName> <comm:ownersRole>Managers</comm:ownersRole> <comm:membersRole>Editors</comm:membersRole> <comm:publicRole>Readers</comm:publicRole> <comm:contentFeedLink>documentLibraries</comm:contentFeedLink> </comm:QuickrPlaceType>
| Attribute | Description |
|---|---|
| comm:QuickrServer | Multiple QuickrServer entries are allowed but each name attribute must be unique. |
| comm:host | Server hostname. |
| comm:port | The http port number. |
| comm:sslPort | The https port number. |
| comm:authentry | Name of the authentication alias resource (J2C) created within the WebSphere Application Server administrative console. The J2C alias is automatically created by the Quickr Connector Installer during installation and does not have to be created manually using the WebSphere Application Server administrative console. Once installation is complete, this value can be changed. |
| comm:serverType | Value must match the name of a QuickrServerType such as Domino or Portal. |
<comm:QuickrServer name="DefaultServer"> <comm:host>myserver.domain.com</comm:host> <comm:port>80</comm:port> <comm:sslPort>443</comm:sslPort> <comm:authentry>Myserver/Alias</comm:authentry> <comm:serverType>Domino</comm:serverType> </comm:QuickrServer>
| Attribute | Description |
|---|---|
| QuickrServerType | Values should not be changed. |
| comm:contextPath | Can be found in place feeds as http://<server>:<port>/<contextPath>/places/feed. |
| comm:publicEntryTitle, comm:publicEntryId, comm:publicEntryContent | Correspond to the fields of the Atom entry added to a members feed (for a role) when public access is granted. |
<comm:QuickrServerType name="Domino"> <comm:contextPath>dm/atom/</comm:contextPath> <comm:publicEntryTitle>Anonymous</comm:publicEntryTitle> <comm:publicEntryId>oid:null</comm:publicEntryId> <comm:publicEntryContent><member type="user" dn="Anonymous"/></comm:publicEntryContent> </comm:QuickrServerType> <comm:QuickrServerType name="Portal"> <comm:contextPath>myqcs/rest/</comm:contextPath> <comm:publicEntryTitle>All Authenticated Users</comm:publicEntryTitle> <comm:publicEntryId>all-authenticated-users</comm:publicEntryId> <comm:publicEntryContent /> </comm:QuickrServerType> </comm:config>
| Attribute | Description |
|---|---|
| comm:startDelay | The delay in minutes before the task starts. |
| comm:taskInterval | The delay in minutes between consecutive tasks. |
| comm:daysBackToScan | Limits the search for communities changes. The default value of 14 means that only communities that have been modified in the past two weeks (14 days) will be checked for missed propagations. |
<comm:QuickrDelayedSync enabled="true"> <comm:startDelay value="60" /> <!-- minutes --> <comm:taskInterval value="60" /> <!-- minutes --> <comm:daysBackToScan>14</comm:daysBackToScan> </comm:QuickrDelayedSync> </comm:config>
This section describes how to configure IBM Lotus Quickr for integration with Enterprise Content Management (ECM) systems, IBM FileNet P8 and IBM Content Manager.
This integration helps you manage and control content created by shared workgroups across your organization. Using these services, you can manage content to address your archiving and regulatory requirements and corporate governance mandates, as well as integrate the content into your business process.
The Lotus Quickr for Domino qpconfig.xml file contains a number of ecm-specific settings in an ecm integration section.
<metaDataMapping>
<form_1D5BA335D8D4DC33482576350021326F formName="TestForm">
<mappingInfo docType = "kdoctype">
<mapping field = "c_char" propertySheetType = "kevinps1" property = "kevinps1.kchar"/>
<mapping field = "c_date" propertySheetType = "kevinps2" property = "keivnps2.kdate"/>
</mappingInfo>
</form_1D5BA335D8D4DC33482576350021326F>
......
</metaDataMapping>
The following shows a sample qpconfig.xml file with ecm integration settings enabled:
=============== START OF SAMPLE ================= <ecm_integration enabled="true"> <targetHost> http://server_name.website.com:9080 </targetHost> <targetLibrary> /QuickrRoot/QKSmokeApplication/QKSmokeLibrary </targetLibrary> <targetFolder> /Test/ </targetFolder> <setDefaultOperation> link </setDefaultOperation> <allowHostEdit enabled ="true"> </allowHostEdit> <forceDefaultPublishLocation enabled ="false"> </forceDefaultPublishLocation > <forceDefaultOperation enabled = "false"> </forceDefaultOperation> <metaDataMapping> <form_4CF46B0FFCD3EE67482576E7003D0266 formName="MappingTestG"> <mappingInfo docType="CM_Briefing"> </mappingInfo> </form_4CF46B0FFCD3EE67482576E7003D0266> </metaDataMapping> <ECM_Search_Target name="sample02" url="http://sample02.website.com:9080"/> </ecm_integration> =============== END OF SAMPLE ===================
Configure Single Sign-On (SSO) for your ECM services setup to enable a seamless user experience.
Configure Single Sign-On (SSO) between the servers of your ECM setup so that a user logged into Lotus Quickr does not have to enter additional credentials for authentication to the ECM server and at the same time, security is not compromised across the servers.
SSO can be configured using the IBM WebSphere Application Server's Lightweight Third Party Authentication (LTPA) mechanism or any of the third-party products supported by the Lotus Quickr server and the ECM server, such as Tivoli Access Manager and Computer Associates eTrust SiteMinder.
If, for any reason, SSO is impossible, you must set up global credentials for accessing the ECM server. Setting up global credentials is also required to enable part of the link resolution. You can configure global credentials using the IBM WebSphere Portal Credential Vault.
You must configure the iNotes® proxy to enable Enterprise Content Management.
IBM Lotus Quickr users can link to ECM documents from a Lotus Quickr library or the rich text areas of pages.
Lotus Quickr users can create links to ECM documents in their Lotus Quickr libraries and in the rich text areas of blogs, wikis, lists, forums, and comments. This enables them to always view and download the latest content of the linked ECM documents from Lotus Quickr. Additionally, Lotus Quickr users can copy, move, rename, and delete these ECM document links.
To enable linking to ECM documents, specify values for the custom properties of the QuickrWhitelistProvider and QuickrPublishConfig resource environment providers.QuickrWhitelistProvider
The QuickrWhitelistProvider resource environment provider enables you to specify a list of allowed domains that can be accessed from your Lotus Quickr environment. Configuring this resource environment provider is important to prevent access to external servers with malicious content. Use this resource environment provider to specify the web address of the ECM system that is to be accessed for creating the document links.
QuickrPublishConfig
Use the QuickrPublishConfig resource environment provider to enable linking to ECM documents and to specify the name of the credential vault slot that you create if it is impossible to configure Single Sign-On (SSO) between Lotus Quickr and the ECM server.
To specify values for the properties of the two resource environment providers:
Configure your Lotus Quickr server to enable publishing Lotus Quickr documents to an ECM repository.
Additionally, you need to configure the QuickrWhitelistProvider resource environment provider enables you to specify a list of allowed domains that can be accessed from your Lotus Quickr environment. Configuring this resource environment provider is important to prevent access to external servers with malicious content. Use this resource environment provider to specify the web address of the ECM system that is to be accessed for creating the document links.
To specify the values for the custom properties of the two resource environment provider:
You can customize the Publish Wizard to make adding Lotus Quickr documents to an ECM repository easier FOR USERS.
If the publish operations within a team are fairly uniform, you can customize the Publish Wizard to assume values for some of the fields and display minimum data entry screens. This makes adding Lotus Quickr documents to an ECM repository easier.
By customizing the Publish Wizard, you assign a default behavior to the Publish Wizard every time a Lotus Quickr user tries to publish a document. Depending on the extent of customization, it is possible that the wizard does not show up at all and the publish operation is performed automatically, using the predefined values for several publish options.
You can customize the Publish Wizard by configuring the following two properties of the QuickrPublishConfig resource environment provider from the administrative console for WebSphere Application Server in a standalone environment or the administrative console for deployment manager, in a clustered environment.
These two properties will work in conjunction with the Boolean property forceDefaultPublishLocation to determine the behavior of the Publish Wizard. There will be four possible behaviors of the wizard, depending on the values of these properties:
| qkrPublishConfig.forceDefaultPublishLocation | qkrPublishConfig.forceDefaultOperation | Outcome |
|---|---|---|
| true | true | The Publish Wizard never displays. When the
user clicks Publish to from the context menu
of a document, pre-configured default publish location and default
operation are assumed for the publish operation. Note: In this case,
the user cannot input any required properties the document may need.
|
| true | false | The Publish Wizard does display, but the Select Location screen is skipped, and the required properties screen is displayed, followed by the Publish Options screen. In the Publish Options screen, the publish operation as set by the value of the setDefaultOperation property will selected, but it can be changed. |
| false | true | The Publish Wizard does display, but the Publish Options screen is skipped. Thus, the wizard starts with the Select Location screen, the user specifies the target server and the target folder, enters any required properties in the next screen, and is presented with a Publish button instead of Next button, with the value of setDefaultOperation determining the publish option to be used. |
| false | false | The Publish Wizard displays and exhibits its default behavior. The user can enter any location and choose any publish option, although the value of setDefaultOperation will determine which publish option is the default publish operation. |
Scenario 1: Configuring a default publish location
In this scenario, the Publish wizard does not provide the option to select an ECM location.| Property name | Property value |
|---|---|
| qkrPublishConfig.publishEnabled | true |
| qkrPublishConfig.targetHost | http://<hostname>:9080 |
| qkrPublishConfig.targetLibrary | For IBM FileNet Services for Lotus Quickr: /QuickrRoot/DefaultPlace/DefaultLibrary For IBM Content Manager Services for Lotus Quickr: /cmRoot/defaultApp/defaultLib |
| qkrPublishConfig.targetFolder | /<foldername> |
| qkrPublishConfig.forceDefaultPublishLocation | true |
| qkrPublishConfig.publishVaultSlot | Specifies the name of the credential vault slot
where the global publishing credentials are stored, in case SSO has
not been configured. Remember: If you have configured
SSO between the Lotus Quickr server and the ECM server and still specify
a slot name for this property, the credentials stored in the credential
vault slot will be used for publishing to the ECM server rather than
the SSO credentials.
|
Scenario 2: Configuring a default publishing operation to a default ECM location
In this scenario, the Publish wizard does not provide the option to select an ECM location or a publish operation. In fact, the Publish wizard is not displayed at all when Publish to is selected from the context menu of a Lotus Quickr document. Pre-configured default publish location and default operation are assumed for the publish operation.| Property name | Property value |
|---|---|
| qkrPublishConfig.publishEnabled | true |
| qkrPublishConfig.targetHost | http://<hostname>:9080 |
| qkrPublishConfig.targetLibrary | For IBM FileNet Services for Lotus Quickr: /QuickrRoot/DefaultPlace/DefaultLibrary For IBM Content Manager Services for Lotus Quickr: /cmRoot/defaultApp/defaultLib |
| qkrPublishConfig.targetFolder | /<foldername> |
| qkrPublishConfig.forceDefaultPublishLocation | true |
| qkrPublishConfig.forceDefaultOperation | true |
| qkrPblishConfig.setDefaultOperation | copy, move, or link |
| qkrPublishConfig.publishVaultSlot | Specifies the name of the credential vault slot
where the global publishing credentials are stored, in case SSO has
not been configured. Remember: If you have configured
SSO between the Lotus Quickr server and the ECM server and still specify
a slot name for this property, the credentials stored in the credential
vault slot will be used for publishing to the ECM server rather than
the SSO credentials.
|
You can publish a document or page from Quickr to the ECM server.
The default Publishing Web user interface (Publish Wizard) has two windows.
By using qpconfig.xml, you can customize the Publish Web user interface as shown in the following table:
| Element | Description |
|---|---|
| <targetHost>http://lwptsthink47.cn.ibm.com:9080</targetHost> | URL of default ECM server. |
| <targetLibrary> /QuickrRoot/QKSmokeApplication/QKSmokeLibrary </targetLibrary> | Path of default library in default ECM server. |
| <targetFolder> /Test/</targetFolder> | Default doc publish target folder in default ECM server. |
| <setDefaultOperation>link </setDefaultOperation> | Default publish action (copy, move, link). |
| <allowHostEdit enabled ="true"> </allowHostEdit> | If the value of the attribute “enabled” is false, then users cannot type the server URL in the publish wizard. The Server field will be read only, and its value is the URL of the default ECM server (targetHost ) |
| <forceDefaultPublishLocation enabled ="false"> </forceDefaultPublishLocation > | If the value of the attribute “enabled” is true, then the Select Location window will be skipped. Documents will be published to the default folder (targetFolder) in the default library (targetLibrary) of the default ECM server (targetHost). |
| <forceDefaultOperation enabled = "false"> </forceDefaultOperation> | If the value of the attribute “enabled” is true, then the Select Publish Option window will be skipped. Document publish will get default the publish action (setDefaultOperation) as its parameter. |
The forceDefaultPublishLocation and forceDefaultOperation parameters can be combined to achieve different Publish Web user interfaces, as shown in the following table:
| forceDefaultPublishLocation | forceDefaultOperation | Output |
|---|---|---|
| true | true | The Publish Wizard never displays. When you click Publish To from the context menu of a document, a pre-configured default publish location and default operation are used for the publish operation. |
| true | false | The Publish Wizard does display, but the Select Location window is skipped. The Required Properties window displays, followed by the Publish Options window, in which the publish operation is set by the value of the setDefaultOperation parameter. |
| false | true | The Publish Wizard does display, but the Publish Options window is skipped. Thus the wizard starts with the Select Location window, the user specifies the target server and the target folder, enters any required properties in the next window, and is presented with a Publish button instead of a Next button, with the value of setDefaultOperation determining the publish option to be used |
| false | false | The Publish Wizard displays and exhibits its default behavior. The user can enter any location and choose any publish option, although the value of setDefaultOperation determines which publish option is the default publish operation. |
Configure a basic mapping between the metadata associated with IBM Lotus Quickr documents to the metadata required for storing the documents published from Lotus Quickr to an ECM repository.
You need to map the properties associated with Lotus Quickr documents with the equivalent properties available in the ECM repositories. These properties are aggregated as Forms in Lotus Quickr, classes in IBM FileNet P8, and as attribute groups in IBM Content Manager. This mapping ensures that the field values associated with the Lotus Quickr documents are retained and transferred along with the document during a publish operation to an ECM repository.
Similarly, you can map the Lotus Quickr document types with the ECM document types. Document types help in associating Forms with a document. When you map Lotus Quickr document types with the ECM document types, document publishing stores Lotus Quickr documents as instances of the configured item types (as in IBM Content Manager) or classes (as in IBM FileNet P8) in the target ECM systems.
The configuration of mappings displays the Edit Properties page in the Publish wizard. The fields shown on this page are the properties that make up the target ECM document type. The page displays values pre-filled in the fields that have been mapped from Lotus Quickr to the ECM system. If you expect a field to have a value because the Lotus Quickr document has that field, check that the mapping is correct and that the corresponding datatypes of the fields can be mapped.
Understand the Forms and recommendations for mapping Forms of IBM Lotus Quickr with their ECM equivalents.
Forms are a way of associating some relevant information or metadata with a document. This metadata is in the form of several user-defined and system-defined properties that describe a document.
Forms in Lotus Quickr
In Lotus Quickr, a Form contains fields of information that can be associated with a document type. For example, a date or a person field can be added to a Form.
In Lotus Quickr there are two kinds of documents, Page and Document. Before working with metadata mapping, you should understand the difference between a Page and a Document. When a document has a Single Attachment field but no Rich Text field, it is a Document; otherwise, it is a Page. So, when customizing a form, if you add a Single Attachment field but do not add a Rich Text field, the document created from that form is a Document.
When you upload or import a file, it is a Document. Other contents like page, link, Forum Topic and response, comments and list items are all pages. On the ECM server side, you can create a Page from some—but not all—document types in the ECM repository. Not all document types support Pages, but all document types supporting Pages also support Documents. It is OK to map a Document Form to a document type supporting a Page, but if you try to map a Page Form to a document type that doesn't support Page, it will fail.
Not all ECM document types support the Lotus Quickr Page document type. But all document types that support a Page also support a Document. Therefore, you can map a Document Form to a document type that supports a Page Form. If you map a Page Form to an ECM document type that does not support a Page Form a mapping failure occurs.
Property templates in IBM FileNet P8
In IBM FileNet P8, property templates define properties that can be associated with an object.
A property template in IBM FileNet P8 provides the Lotus Quickr equivalent of a Form.
For more information about properties and property templates in FileNet P8, see the IBM FileNet P8 help topic Content Engine Administration > Properties.
Attribute groups in IBM Content Manager
In IBM Content Manager, properties are referred to as attributes. An attribute stores units of data (metadata) or values that describe a certain characteristic or property (for example, first name, surname, age, city, and so forth) of an item.
For more information about attributes in IBM Content Manager, see Creating an attribute.
Similar to Forms of Lotus Quickr, attribute groups are available in IBM Content Manager. An attribute group is a convenient way to group one or more attributes together.
For more information about attribute groups in IBM Content Manager, see Creating attribute groups.
Recommendations for property type mappings
| Lotus Quickr | IBM FileNet P8 | IBM Content Manager |
|---|---|---|
| Plain Text | String | Variable character/Char |
| Text Area | String | Variable character/Char |
| Plain Text | Integer | Short integer/Long integer |
| Plain Text | Float | Decimal/Double |
| Rich Text | Object | CLOB |
| Name Pop-up | String | Variable character/Char |
| Pop-up List | String | Not applicable |
| Date Pop-up | DateTime | Date |
| Time Pop-up | DateTime | Time |
| Calandar Date-Time | DateTime | Timestamp |
| Task | String | Variable character/Char |
Use the following methods to map the Lotus Quickr fields to those on your ECM repository.
Make appropriate configuration settings from the WebSphere Application Server administrative console to map the existing IBM Lotus Quickr property sheets to their ECM equivalents.
In Lotus Quickr you can customize a form to include different fields. Here a form is treated as a kind of document type, and you can then create a document from that customized form.
When metadata mapping between Quickr and ECM is enabled you can map a form to a document type. Then, when you publish a Quickr document created from that form, Lotus Quickr uses the mapped document type to create an ECM document, and the property's value will be the mapped field's value.
Perform the following steps to use metadata mappings:
Configure your ECM setup to enable search across ECM repositories.
IBM Lotus Quickr users can perform a search over documents stored in an ECM repository using the Lotus Quickr search. The scope of this search, however, depends on the ECM repository that you have configured for integration with Lotus Quickr. The scope of a search from Lotus Quickr across IBM Content Manager is the subset of IBM Content Manager that comprises documents added from Lotus Quickr to IBM Content Manager using IBM Content Manager Services for Lotus Quickr, for example, by a publish operation or by using Lotus Quickr Connectors. If you have configured an IBM FileNet P8 repository, the search scope covers all the documents of the repository.
Search queries are submitted by using the Search box that is available at the side of Place Actions. With appropriate configuration settings, a Lotus Quickr user can view and use the Enterprise Content search scope from the search. Lotus Quickr users can download and view summary pages of the ECM documents returned in the result set.
Enterprise Content search scope
Restart the server for the changes to take effect.
Only one ECM server can be added for an ECM search. The ECM search field is located next to Place Actions.
Validate your search service configuration.
After you catalog the search service to the Lotus Quickr server, you must validate the search service configuration to ensure you can search directly from the Lotus Quickr search.
If you have already updated the index frequency or satisfied with the default frequency, simply add a sample document to the default ECM library using either Lotus Quickr Connectors (desktop integration) or by publishing a Lotus Quickr document to the default ECM library, provided you have configured the appropriate settings for publishing documents to the ECM repository. Next, make sure that the document is indexed on the remote server before you try to search it. Lastly, conduct a text search using the Lotus Quickr search.
To validate the search service configuration:Get familiar with the terms used in the subsequent topics for configuring IBM Lotus Quickr integration with ECM systems.
Terms shown in italics are defined elsewhere in this topic.
A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z
A query for objects that is based on the properties of the objects.
Know the limitations and workarounds for problems when configuring IBM Lotus Quickr for ECM integration.
Access the following links to troubleshoot problems with IBM FileNet Services for Lotus Quickr
Access the following links to troubleshoot problems with IBM Content Manager Services for Lotus Quickr
You can enable the awareness, instant messaging, and Web conferencing (meeting) features of IBM Lotus Sametime in places. Then members of a place can see when other members are online, chat with other members, and schedule and participate in online meetings with other members all from within the place.
Perform the following steps:
Before you enable IBM Lotus Sametime features in places you must prepare the servers.
Perform the following steps:
Enable online awareness and instant messaging so that place members can see when other members are online and can chat with them from places.
To prepare to enable instant messaging and awareness in places, copy required Java files to the IBM Lotus Sametime server.
After you have enabled awareness and instant messaging in places, you can enable online meetings so that members can participate in online meetings from places.
Configure a meeting user on the IBM Lotus Sametime server for integration with IBM Lotus Quickr.
Copy and configure files on the Lotus Quickr server.
JavaUserClassesExt=QPJC1,QPJC2,QPJC3,QPJC4
QPJC1=C:\PROGRAM FILES\LOTUS\DOMINO\quickplace.jar
QPJC2=C:\PROGRAM FILES\LOTUS\DOMINO\log4j-118compat.jar
QPJC3=C:\PROGRAM FILES\LOTUS\DOMINO\STCore.jar
QPJC4=C:\PROGRAM FILES\LOTUS\DOMINO\STMtgManagement.jar
JavaUserClassesExt=QPJC1,QPJC2,QPJC3,QPJC4
QPJC1=/opt/lotus/notes/<latest>/ibmpow/quickplace.jar
QPJC2=/opt/lotus/notes/<latest>/ibmpow/log4j-118compat.jar
QPJC3=/opt/lotus/notes/< latest >/ibmpow/STCore.jar
QPJC4=/opt/lotus/notes/< latest >/ibmpow/STMtgManagement.jar
JavaUserClassesExt=LQPJava1,LQPJava2,LQPJava3,LQPJava4
LQPJava1=/QIBM/ProdData/Lotus/QuickPlace/quickplace.jar
LQPJava2=/QIBM/ProdData/Lotus/QuickPlace/log4j-118compat.jar
LQPJava3=/QIBM/UserData/Lotus/QuickPlace/STCore.jar
LQPJava4=/QIBM/UserData/Lotus/QuickPlace/STMtgManagement.jar
Specify online meeting settings in the qpconfig.xml file on the Lotus Quickr server.
Use the Site Administration link on the IBM Lotus Quickr server to specify the IBM Lotus Sametime meeting server to use.
To test the online meeting configuration, verify that members of places can use online meetings.
Users who subscribe to calendar events should receive an invitation in their mail, with a link to the meeting. For more information on subscribing to calendar events, click Help in a place.
Domino Off-Line Services provides the means for users to take places offline, make changes to the places, and then synchronize the changes with the online version on the server. A user must be an individual member of a place to take it offline; users who access a place through group membership cannot take places offline.
Offline use is supported only for Microsoft Windows users. The IBM Lotus Quickr for Domino offline feature is not enabled in the initial eGA version of 8.5 but will be delivered in a subsequent interim fix soon after eGA.
To set up IBM Lotus Quickr for offline use, perform the following steps:
The first step in setting up IBM Lotus Quickr for offline use is enabling Domino Off-Line Services.
To enable Domino Off-Line Services if your server runs on the Microsoft Windows or IBM AIX operating system, edit the Domino Directory and the notes.ini file.
To set up authentication for offline members, you create one or more certifier IDs that can authenticate the members, and then attach each certifier ID to an Offline Security Policy document in the Offline Services database (doladmin.nsf). When members install places offline, the Domino server uses the certifier ID to generate new user IDs, and downloads the IDs to the members' computers. These IDs are used to authenticate the members when they synchronize the offline and online versions of places.
Certifier IDs are required to ensure offline user authentication works when users are in different organizational hierarchies from the IBM Lotus Quickr server, when users are at different levels of organizational hierarchy, or for other security and organizational situations.
The following points about certifier IDs are important to keep in mind to ensure offline user authentication works properly. For more information on certifier IDs, see Domino Administrator Help.
If external offline users are in a different organization hierarchy from the IBM Lotus Domino server on which IBM Lotus Quickr runs, you must create an organization certifier ID for their organization, cross-certify that certifier ID with the Domino server's organization certifier ID, and then attach the cross-certified ID to an Offline Security Policy document. For example, if the Domino server is within the /Org organization, but there are external users within the /Acme organization, create an /Acme organization certifier ID, cross-certify it with the /Org certifier ID, and then create an Offline Security Policy document and attach the cross-certified /Acme certifier ID to it.
A certifier ID authenticates only users with names at its level and one organizational unit level down in the name hierarchy. For example, the /Acme organization certifier authenticates Alice Brown/Acme, Lee Moutal/Marketing/Acme, and Maryane Burns/Sales/Acme, but not Claudia Basso/East/Sales/Acme. To authenticate Claudia Basso/East/Sales/Acme, you must create an organizational unit certifier ID for /Sales/Acme, and then create an Offline Security Policy document and attach the ID to it.
If offline users are within the organization hierarchy of the Domino server on which Lotus Quickr runs, put them under their own organizational unit certifier as a security measure to limit their access to the Domino server.
Domino recognizes only the following delimiters in a distinguished name: "CN,"OU," "O," and (optionally) "C". If the distinguished names of external member use different delimiters, you must use the name_translation setting in the offline section of the qpconfig.xml file on the server to translate them to the Domino format. When you create an Offline Security Policy document, you use the Domino format when specifying the certifier name.
For local offline users, create the organizational unit certifier /QP from the Domino server's certifier. For example if the Domino server's certifier is the organization certifier /Org, use the /Org certifier ID to create the organizational unit certifier /QP/Org, and then attach the /QP/Org certifier ID to an Offline Security Policy document. Or if the Domino server's certifier is the organizational unit certifier /Sales/Org, use the /Sales/Org certifier ID to create the organizational unit certifier /QP/Sales/Org, and then attachthe/QP/Sales/Orgcertifier to an Offline Security Policy document.
You must create separate Security Policy documents and IDs for local users (users registered in places) and external users (users registered in a directory). You can attach only one certifier ID to each Security Policy document.
Certifier IDs are required to ensure offline user authentication works when users are in different organizational hierarchies from the IBM Lotus Quickr server.
If external offline members are in a different organization hierarchy than the IBM Lotus Domino server on which IBM Lotus Quickr runs, create an organization certifier ID for that organization and then cross-certify that certifier ID with the Domino server's certifier ID. For example, if the Domino server certifier is the /Org certifier, but external users are within the /Acme organization, create an /Acme organization certifier ID and then cross-certify /Acme with /Org.
To create the organization certifier:
If external members are in a different organization from the Lotus Domino server, create an organizational unit certifier ID for these members if their names are more than one organizational unit level down in the name hierarchy from the organization certifier you created in the previous step.
For example, to authenticate Claudia Basso/East/Sales/Acme, you must create an organizational unit certifier for /Sales/Acme from the /Acme certifier. However, for the users Alice Brown/Acme, Lee Moutal/Marketing/Acme, and Maryane Burns/Sales/Acme, there is no need to create an organizational unit certifier because the /Acme certifier will authenticate them.
If members are in the same organization as the Domino server, creating an organizational unit certifier ID from the server certifier specifically for them is recommended as a way to restrict their access to the server.
To create the organizational unit certifier:
For local offline members, use the Lotus Domino server's certifier to create the organizational unit certifier /QP. For example, if the Domino server's certifier is the organization certifier /Org, use the /Org certifier to create the organizational unit certifier /QP/Org. Or if the Domino server's certifier is /West/Org, use the /West/Org certifier to create the organizational unit certifier /QP/West/Org.
To create the /QP organizational unit certifier:
Create an Offline Security Policy document for each certifier you created for offline users. Offline Security Policy documents are stored in the doladmin.nsf database on the Lotus Domino server.
Domino recognizes only distinguished names that contain the traditional Domino "CN,"OU," "O," and (optionally) "C" components. If the distinguished names of external members in an LDAP directory do not follow this model and you use Domino Off-Line Services with IBM Lotus Quickr, you must use qpconfig.xml settings to translate users' names into a format that Domino recognizes, and then translate those names back into their original LDAP format.
For example, the distinguished name "CN=James Moore, OU=East, O=Acme, C=US" does not require translation, but the name UID=James Moore/C=US/OU=East/O=acme.com does.
To translate distinguished names, you use the name_translation element in the offline element of the qpconfig.xml file to create name translation rules. Translation rules typically contain text strings with symbols that are used to match text patterns. Translation rules are specified in the <translate> element. The following example of translation rules in the qpconfig.xml file translate distinguished names that follow this pattern "uid=value/c=value/ou=bluepages/o=ibm.com" into the Domino-style name "CN=value/OU=bluepages_value/O=ibm_com." The two <translate> elements contain the rules. The "from" and "to" attributes within the <translate> elements contain regular expressions, for example, "uid=(.+)/c=(.+)/ou=bluepages/o=ibm\.com." The regular expressions contain symbols, for example, (.+) and \:
<server_settings>
<offline enabled="true">
<name_translation enabled="true">
<from_directory_name>
<translate from="uid=(.+)/c=(.+)/ou=bluepages/o=ibm\.com" to="CN=\1/OU=bluepages_\2/O=ibm_com" />
</from_directory_name>
<to_directory_name>
<translate from="CN=(.+)/OU=bluepages_(.+)/O=ibm_com" to="uid=\1/c=\2/ou=bluepages/o=ibm.com" />
</to_directory_name>
</name_translation>
</offline>
</server_settings>
You create rules for translating LDAP names to Domino names within the <from_directory_name> elment. You specify each LDAP name attribute in the "from" attribute, using symbols to account for any possible value the attribute might have. For example, the (.+) symbol means "one or more occurrences of any character." In the preceding sample, this accounts for any value the "uid" and "c" attributes might have. You also use symbols to translate syntax that otherwise might be interpreted as a special character. For example, the \ symbol turns off the special meaning of the character which follows. Without this symbol in "o=ibm\.com," the dot (".") would be interpreted by its special character meaning, which is "match any single character."
The "to" attribute specifies Domino attributes using symbols to match values from the LDAP attributes and to arrange them in a way Domino recognizes. For example, the symbol \1 means "whatever matched the first regular expression." So, the CN attribute's value will match the first regular expression (.+) found in the "from" attribute. In the same way, the symbol \2 means "whatever matched the second regular expression." So, the OU value will be the explicitly stated "bluepages_" plus the second regular expression (.+), which in this case is the value of the country, or "c", attribute. The O attribute is explicitly stated. You can have up to nine regular expressions in one rule.
You create rules for translating Domino names back to LDAP names within the <to_directory_name> element using the same method.
The preceding translation rules result in the following example translations:
LDAP directory name |
Domino name |
|---|---|
uid=Joe User/c=us/ou=bluepages/o=ibm.com |
CN=Joe User/OU=bluepages_us/O=ibm_com |
uid=Nils Nilsen/c=dk/ou=bluepages/o=ibm.com |
CN= Nils Nilsen/OU=bluepages_dk/O=ibm_com |
Notice that the regular expressions accommodate the country, or "c," code. There is no need to have a separate translation rule for each country code because they can be captured by a (.+) expression, and then inserted anywhere in the translated name with a \[number] expression.
There are many symbols that can be used in regular expressions, but only a few are useful for the purpose of translating a non-conforming LDAP name to a Domino name. The following table lists of these symbols, with examples that show how they match a particular LDAP name. All of the examples shown here will match the LDAP distinguished name "uid=Joe User/c=us/ou=People1/o=org.com." The symbols described are in bold text in the examples:
| Symbol | Description | Example |
|---|---|---|
(.+) |
Represents one or more occurrences of any character. |
uid=(.+)/c=(.+)/ou=bluepages/o=ibm\.com |
\1, \2, \3, etc. |
\1 represents a match with the first regular expression; \2 represents a match with the second regular expression, and so on. Up to 9 regular expressions may be used in one rule. |
CN=\1/OU=bluepages_\2/O=ibm_com |
\c |
Turns off the meaning of any special character 'c'. |
uid=Joe User/c=us/ou=People1/o=org\.com |
. |
Matches any single character. |
uid=Joe User/c=us/ou=People./o=org |
[...] |
Matches any of the enclosed characters. |
uid=Joe User/c=us/ou=People[123456789]/o=org |
[^...] |
Matches any character that is not enclosed. |
uid=Joe User/c=us/ou=People[^2-9]/o=org |
n-n |
Matches any character in this range. |
uid=Joe User/c=us/ou=People[0-9]/o=org[._]com |
| * |
Matches any number (zero or more) of the preceding character or bracketed expression. |
uid=Joe U.*/c=us/ou=People1/o=org\.com |
+ |
Matches one or more of the preceding character or bracketed expression. |
uid=Joe [A-Za-z]+/c=us/ou=People1/o=org\.com |
(regexp) |
Delineates a regular expression so that it can be used in the replacement string (the "to" string in <translate>). |
uid=Joe User/c=(.+)/ou=People1/o=org\.com |
If the distinguished names of external members in an LDAP directory do not follow the traditional Domino model and you use Domino Off-Line Services with IBM Lotus Quickr, you must use qpconfig.xml settings to translate users' names into a format that Domino recognizes, and then translate those names back into their original LDAP format.
The following settings provide an example of translating names that appear in the LDAP user directory as cn=name,ou=People1,dc=acme,dc=com.
<server_settings>
<offline enabled="true">
<name_translation enabled="true">
<from_directory_name>
<translate from="cn=(.+)/ou=People1/dc=acme/dc=com" to="CN=\1/OU=People1/O=acme_com" />
</from_directory_name>
<to_directory_name>
<translate from="CN=(.+)/OU=People1/O=acme_com" to="cn=\1/ou=People1/dc=acme/dc=com" />
</to_directory_name>
</name_translation>
</offline>
</server_settings>
Specific configuration steps are required if you use IBM Network Dispatcher, Sun Java System Portal Server, or CA SiteMinder in your IBM Lotus Quickr environment.
If you use IBM Network Dispatcher to distribute HTTP requests to clustered IBM Lotus Quickr servers, use the notes.ini setting $DOLS_TCPIPAddress to enable users to take places offline from any server in the cluster.
$DOLS_TCPIPAddress=hostnamewhere hostname is the fully-qualified host name or IP address of one Lotus Quickr server in the cluster.
$DOLS_TCPIPAddress=blue.enterprise.com
If you use Sun Java System Portal Server with IBM Lotus Quickr as a reverse proxy, use the notes.ini setting NoWebFileSystemACLS to prevent users from having to re-authenticate after installing places offline.
NoWebFileSystemACLS=1
If your environment uses CA SiteMinder for authentication, you must list the Domino Server API (DSAPI) filter for Domino Off-Line Services before the CA SiteMinder filter in the list of DSAPI filters in the server's Server document in the Domino Directory.
If you want users to connect to a IBM Lotus Quickr server through an intermediary passthru server when installing places offline, use the Site Administration link to specify the name of the passthru server.
Perform the following steps:
Optionally you can use an alternate Web server for offline software installation, enable offline place encryption, enable IBM Lotus Quickr sign in passwords for offline use, or hide the work offline link.
You can copy the Domino Off-Line Services client software to a directory on an alternate Web server, and then use the Site Administration link on the IBM Lotus Quickr server to specify a URL that points to that directory. Then the client software is installed from the alternate server.
Perform the following steps:
Use the qpconfig.xml file to enable users to use their IBM Lotus Quickr login passwords when they log in to any offline places so they do not have to remember a separate password for each offline place.
By default, offline users must specify an offline password in the Member Profile for each offline place of which they are a member. Use the use_login_passwords setting and the password_synchronization setting in the offline section of the qpconfig.xml file to enable offline users to use their Lotus Quickr login passwords when they log in to any offline place. This feature is supported for both external and local members. These settings apply to all places on the server, although users still can specify place-specific offline passwords through their Member Profiles. If you do not enable this setting server-wide through the qpconfig.xml file, managers of places can enable the feature for places they manage through the Customize > Basics page.
Perform the following steps:
<offline enabled="true" use_login_passwords="true"> <password_synchronization enabled="true"> .... .... </password_synchronization> </offline>
The My Places feature enables external place members to see a list of links to all the places they belong to, and users with super-user server access to see links to all places on the server. Super users and place managers use My Places to see place statistics and administer places using qptool commands. You can customize the My Places feature.
To enable people who use double-byte character set (DBCS) languages, such as Japanese or Chinese, to use My Places, you must enable single sign-on authentication on the server. In addition, you must use the notes.ini file to configure the DBCS language to use and then re-index the views in the Place Catalog.
Perform the following steps to modify the notes.ini file and to re-index the views in the Place Catalog:
If a reverse proxy mediates connections to IBM Lotus Quickr, specify proxy rules for Lotus Quickr.
Specify the following rules:
Proxy /qphtml/* <protocol>://<servername>/qphtml/* Proxy /<label>/* <protocol>://<servername>/* Proxy /<quickrroot>/* <protocol>://<servername>/<quickrroot>/*where:
<protocol> is http or https
<servername> is the fully-qualified host name of a load balancing server or a Lotus Quickr server
<quickrroot> is the Lotus Quickr URL root. This value is lotusquickr unless you have upgraded from Lotus QuickPlace and did not change the URL root, in which case the value is quickplace.
In addition, perform the following steps:
Proxy /qphtml/* https://qk.acme.com/qphtml/* Proxy /quickr_services_for_LD/* https://qk.acme.com/* Proxy /lotusquickr/* https://qk.acme.com/lotusquickr/*
Web page caching greatly improves the response time of the IBM Lotus Quickr server. Use the notes.ini file to customize Web page cache settings.
Without a cached copy of a Web page, the HTTP server must access the database upon every HTTP request, which results in a slower response time for the Lotus Quickr server. If a Web page is cached, the server only has to pick up the page from the database one time, and then create a user-specific, cached copy of the page at that time. Upon subsequent requests for the page, the server retrieves and provides the cached copy, as long as it is still valid. If the server is brought down, the existing cache is maintained after the server is brought back up.
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:
Perform the following steps to adjust Web page cache settings:
| Setting | Description |
|---|---|
QuickPlaceWebCacheEnabled=value |
Enables or disables Web page caching. When set to 1 or omitted, enables Web page caching. When set to 0, disables Web page caching. |
QuickPlaceWebCacheDir= path |
Specifies the full path to the cache directory on the server. If omitted, the default path is domino_data_root/domino/lotusquickr/cache. |
QuickPlaceWebCacheLimitInMB=size |
Specifies a maximum size, in MB, for the cache. If omitted, or if a negative value is specified, the maximum size is 50 MB. |
QuickPlaceWebCacheGCIntervalInMIN=interval |
Specifies the time interval, in minutes, for cache cleaning. If omitted, or if a negative value is specified, then the interval is 60 minutes. |
QuickPlaceWebCacheUsers=anonymous |
Enables caching for anonymous users only. If omitted, and by default, caching is enabled for all users. |
QuickPlaceWebCacheLogging=level |
Specifies the level (1, 2, 3), for cache logging. Level 1 is the least detailed and 3 is the most detailed. Logging is written to domino_data_root/log.nsf. |
Configure cross-place searching to enable external place members to use the advanced search feature to search multiple places.
A manager of a place enables or disables advanced search within a place. IBM Lotus Quickr provides two types of advanced search features, one of which enables users to search across multiple places. Cross-place searching requires you to configure Domino Domain Search and a Domain Catalog server, a server that has a Domain Catalog and that builds a domain index. The Lotus Quickr server running on the Domain Catalog server handles all cross-place search requests.
For more information on advanced search and cross-place searching, see the Help. For more information on Domino Domain Search, see Domino Administrator Help.
Note the following points about cross-placing searching:
To configure cross-place searching, perform the following steps:
| Setting |
Description |
|---|---|
| enabled |
When set to "true" enables cross-place searches. When set to "false," prevents cross-place searching. |
| anonymous |
When set to "true" allows anonymous users to search across places. When set to "false" returns an error when anonymous users issue cross-place searches. If you allow anonymous users to search across places, and the manager of a particular place does not want to expose the contents of the place to anonymous users through cross-place searching, the manager should make sure that anonymous access to the place is disabled, and limit the place membership to specified users and groups in the directory. If you allow anonymous access, make sure that anonymous users have the same access as the -Default- access in the ACL for CATALOG.NSF on the Domain Catalog server. |
| SSL* |
When set to "true" defines that SSL generates the URL for the domain catalog server (HTTPS). When set to "false" defines that HTTP generates the URL. |
| port* |
Defines the port used in the URL for the Domain Catalog server. |
| path_prefix* |
Defines a path prefix for the URL for the Domain Catalog server. |
| hostname* |
Specifies the hostname of the Domain Catalog server. |
| domino_server_name* |
Specifies the Domino server name of the Domain Catalog server for example, ServerCatalog/Acme. Before removing places from this server, the server does a lookup to the Domain Catalog server to verify if the search index is cleared. |
By default, place managers and owners can create rooms in their places. As an Administrator, you can prohibit these users from creating rooms by configuring appropriate settings in the qpconfig.xml file.
Perform the following steps:
<rooms> <create enabled = "false"> </create> </rooms>
Administer a server, manage places and PlaceTypes, maintain the server, and use PlaceBots to automate tasks.
You start IBM Lotus Quickr by starting the IBM Lotus Domino server on which it is installed.
Follow these steps to start or stop your server.
To start IBM Lotus Domino and IBM Lotus Quickr on Microsoft Windows, double click the Lotus Domino Server icon on the Desktop.
Start IBM Lotus Quickr by entering a command at the command prompt.
Perform the following steps:
For example, if you used the default Domino program directory and want to run the server console in the background, enter:
/opt/ibm/lotus/bin/server &
Enter a command at the command line to start IBM Lotus Quickr.You must have *JOBCTL special authority to perform this task.
Perform the following steps:
Use a server console command to stop the server.
Enter either of the following commands at the IBM Lotus Dominoserver console:
exit
or
quit
Enter a command at the command line to stop the server. You must have *JOBCTL special authority to perform this task.
Perform the following steps:
To configure and administer the server, use qpconfig.xml file settings, qptool commands, the Site Administration link on the server home page, and notes.ini file settings specific to IBM Lotus Quickr. In addition to these, you may need to perform IBM Lotus Domino server configuration tasks, for example, to set up mail routing.
qptool is a server task that you run with commands and associated arguments to perform a variety of administration tasks related to managing places and place membership. You can run qptool from the IBM Lotus Quickr server console or from an operating system command prompt. Use qptool while the server is running.
The Place Catalog reflects changes that result from qptool commands. You can also run qptool from a batch file or other program.
Perform the following steps to run qptool from the server console:
load qptool [command] [arguments]
Perform the following steps to run qptool from the command prompt:
qptool is a server task that you run with commands and associated arguments to perform a variety of administration tasks related to managing places and place membership. The following table lists the available qptools and provides general description of its function. Use qptool while the server is running.
| qptool command | Description |
|---|---|
| addgraphicfont | Add one or more Graphic Text fonts to the server. |
| addmember | Add a directory user to places. |
| archive | Archive (copy) specified places to a backup directory in the file system. |
| changehierarchy | Rename the hierarchy of all members. |
| changemember | Rename a member and/or transfer access permissions from one member to another. |
| deadmail | Cleanup Lotus Quickr dead mail. |
| execute | Execute an XML API file. |
| lock | Lock specified places. |
| membershipmodel | Convert membership model or move LDAP Lotus Quickr groups. |
| newsletter | Send personalized newsletters to subscribing members |
| password | Change the password of a local user. |
| placecatalog | Push statistics to the place catalog and update cluster statistics |
| refresh | Refresh places or PlaceTypes |
| register | Register places or this server with the Lotus Quickr service and make them ready for use. |
| remove | Remove or mark for removal specified places and placetypes. |
| removegraphicfont | Remove one or more Graphic Text fonts from the server. |
| removemember: | Remove a member from places. |
| repair | Detect and add orphaned rooms to the table of contents of the room. It also removes any room documents that do not point to room files. |
| replicamaker | Automate the creation and deletion of replication stubs for specified places or placetypes between two servers. |
| report | Generate a report from data stored in the place catalog. |
| sendmail | Send a broadcast e-mail message to the managers, or all members, of specified places. |
| setTheme | Set the theme of place or places. |
| unlock | Unlock specified places. |
| unregister | Unregister places or this server with the Lotus Quickr server, and make the names no longer reserved. |
| updatemember | Update directory user's member record with directory information. |
| upgrade | Upgrade places and PlaceTypes. |
load qptool lock -p place1
When you log in to the server as an IBM Lotus Quickr administrator, you have access to the Site Administration link on the home page. From there you can set up a connection to a user directory, control access to the server, as well as specify other configuration options.
You can configure AdminP to make managing Rename and Delete activities in the user directory easier.
Refer to your Lotus Domino documentation for more help using the AdminP process.
Use the notes.ini file, automatically installed in the server program directory, to configure Web page cache settings, offline settings, temporary logging settings to aid in troubleshooting, and miscellaneous other settings.
Use the following notes.ini settings on the IBM Lotus Quickr server to enable client logging.
To use a specific setting, add the following line to the notes.ini file:
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.
| Logging setting |
Levels |
Description |
|---|---|---|
| $h_Debug |
1 |
Enables the browser to display detailed messages about JavaScript errors that occur on the client, rather than the general Lotus Quickr message, "Unable to process your request at this time." |
| $h_ClientDebugConsole |
5 |
Displays a console log on all clients that access the Lotus Quickr server. For Internet Explorer, the console log is an additional browser window, and for other browsers the console log is the JRE Java log console. Use this setting on a temporary basis to help IBM Support troubleshoot specific client-side problems. |
| h_ExceptionDetail=1 |
1 |
Adds the source code name and line number from which errors and warnings are generated to the error and warning messages that the server sends to the browser. Use this setting on a temporary basis to help IBM Support troubleshoot a problem. |
Logging degrades performance, so enable it on a temporary basis only.
If you encounter attachment or file import problems from the client, you can enable upload control logging on the client to help troubleshoot the problem. Create an environment variable called QPCTRLLOG whose value is the path and filename of the log file to use. Whenever the browser engages the upload control, the upload control appends a log sequence to the log file. Do not leave logging enabled because the log file will continue to grow and can cause the client to run out of disk space.
For complete information about notes.ini settings, refer to the developerWorks notes.ini glossary.The following table briefly describes notes.ini settings used to set up IBM Lotus Quickr for users to take places offline.
| Setting |
Description |
|---|---|
| $DOLS_TCPIPAddress=1 |
Used to configure a cluster that uses the IBM Network Dispatcher to work with Domino Off-Line Services. A value of 0 (zero) disables this setting. |
| CheckCacheBeforeDSAPI=1 |
Enables authentication to work for offline users. A value of 0 (zero) disables this setting. |
| EXTMGR_ADDINS= dependent on operating system On Windows: ndolextn On AIX: libdolextn |
Enables Domino Off-Line Services to work with Lotus Quickr |
| NoWebFileSystemACLS=1 |
If you use Sun Java System Portal Server with IBM Lotus Quickr as a reverse proxy, use this notes.ini setting to prevent users from having to re-authenticate after installing places offline. A value of 0 (zero) disables this setting. |
For complete information about notes.ini settings, refer to the developerWorks notes.ini glossary.
The following table lists miscellaneous notes.ini settings that pertain to Lotus Quickr for Domino.
| Setting |
Description |
|---|---|
| $h_MailDomain=mydomain.com |
Specifies the domain of the server that hosts the place to which IBM Lotus Quickr routes replies to e-mail generated from places. Combined with the next setting "h_Undelivmail" defines the name used for Quickr place generated e-mails for newsletters. |
| h_UndelivMail=QuickrPlacename |
Specifies the place to which Lotus Quickr routes replies to e-mail generated from places. Combined with the previous setting $h_MailDomain defines the name used for Quickr place generated e-mails for newsletters. |
| h_ScopeURLinQP=1 |
Enables image caching in environments that do not use single sign-on authentication. A value of 0 (zero) disables this setting. |
| NoWebFileSystemACLs |
Prevents anonymous access to files in the html directory and is part of setting up single sign-on authentication. Also, if you use Sun Java System Portal Server with IBM Lotus Quickr as a reverse proxy, use this notes.ini setting to prevent users from having to re-authenticate after installing places offline. A value of 0 (zero) disables this setting. |
| PLATFORM_CSID=hhh where hhh is a hex number that represents the codepage ... 0CEE 1258 0CC8 1381 001B 1383 001B 1386 |
Required on UNIX servers to support names in a user directory that contain accented characters. For example: PLATFORM_CSID=CA5 would set Notes to use Code Page 256. |
| QuickPlaceExpireCachedUsers=<time interval in seconds> |
Specifies the length of time user entries remain in the user cache. |
| QuickPlaceExtensionManagerAllowServers=1 |
Gives a Domain Catalog server the access to index the places on a Lotus Quickr server that uses the Search Places feature and Off-Line Services. A value of 0 (zero) disables this setting. |
| QuickPlaceMaxCachedUsers=<n> |
Specifies the maximum number of users allowed in the user cache. |
| QuickPlaceNestedGroupLimit=<n> |
Controls how deep LDAP queries are performed to return groups nested in other groups. For example QuickPlaceNestedGroupLimit=1 limits lookups to 1 nested group instead of the default 8. |
| QuickPlaceUpgradeServerOnStartup=1 |
Controls whether a server is upgraded on startup. A value of 0 (zero) disables this setting. |
| HTTPAllowDecodedUrlPercent=1 | Ensures
that an uploaded document or a page attachment whose name includes
a special character can be previewed. A name that includes a special
character has to be encoded, which introduces the percent sign (%)
in the url. Special characters that need to be encoded can include
but are not limited to:
|
| Windows: extmgr_addins=nqpcmextmgr AIX: extmgr_addins=libqpcmextmgr_r.a Linux: extmgr_addins=libqpcmextmgr.so |
Enables AdminP task to work on the Quickr for Domino server. Needs to be added manually to the notes.ini file. |
For complete information about notes.ini settings, refer to the developerWorks notes.ini glossary.
You can use notes.ini settings to log a variety of IBM Lotus Quickr server activities. Output is logged to the server console and to the log file (log.nsf). Logging can be useful for troubleshooting problems. Since logging degrades server performance, enable it on a temporary basis only.
To enable a specific type of logging, add the following line to the notes.ini file on the IBM Lotus Quickr server:
setting=level
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.
| Logging setting |
Levels |
Description |
|---|---|---|
| QuickPlaceArchiveLogging |
1 |
Archive tool logging. |
| QuickPlaceAuthenticationLogging |
5 |
Authentication logging for authentication events, failures, successes, group expansion, and names list generation. |
| QuickPlaceCalendarSubscriptionLogging |
2 |
Calendar event logging. |
| QuickPlaceCompressionLogging |
1 |
Page compression logging. |
| QuickPlaceDbCommandPerformanceLogging |
3 |
Server command performance logging. |
| QuickPlaceExtensionManagerIfLogging |
2 |
Offline place installation logging. |
| QuickPlaceHTTPInterfaceLogging |
2 |
Lotus Quickr and IBM Lotus Domino HTTP interaction logging. It is useful primarily as a first step toward isolating user authentication problems or problems related to the interaction between Lotus Quickr and Lotus Domino. Use with other logging settings, for example, QuickPlaceAuthenticationLogging, it provides a clearer picture of URL processing. |
| QuickPlaceJavaLogging |
5 |
Java Debug logging. |
| QuickPlaceJavaServerLogging |
3 |
Java Server logging. |
| QuickPlaceJniLogging |
1 |
Java Native Interface (JNI) to C++ layer logging. |
| QuickPlaceJvmLogging |
1 |
Java Virtual Machine logging. |
| QuickPlaceLargePOSTLogging |
1 |
Large uploads logging. |
| QuickPlaceLockLogging |
1 |
Place Lock tool logging. |
| QuickpPlaceLtpaLogging |
1 |
LTPA logging when Lotus Domino controls directory services. |
| QuickPlaceMailLogging |
4 |
Lotus Quickr e-mail process logging. |
| QuickPlaceMembershipModelLogging |
2 |
Expanded membership logging. |
| QuickPlaceMyPlacesLogging |
3 |
My Places logging. |
| QuickPlaceQOMLogging |
4 |
Object model logging. |
| QuickPlaceObjectPoolLogging |
2 |
ObjectPool Memory management for PlaceCatalog logging. |
| QuickPlacePerformanceLogging |
1 |
Performance data collector logging. |
| QuickPlacePlaceCatalogLogging |
4 |
Place Catalog logging. |
| QuickPlacePlaceCatalogQueryLogging |
4 |
Queries into Place Catalog logging; use level 4 to include more details on My Places queries and qptool report command queries. |
| QuickPlacePlaceTypeCentralRefreshLogging |
4 |
Place type refresh logging. |
| QuickPlaceSearchPlacesLogging |
2 |
Search across places logging. |
| QuickPlaceSpellCheckEngineLogging |
1 |
Spell checker engine logging. |
| QuickPlaceStyleSheetAttributeCmdLogging |
2 |
Style sheet processing logging. |
| QuickPlaceStubMakerLogging |
3 |
Stub creator logging for Lotus Quickr cluster support. |
| QuickPlaceToolLogging |
1 |
qptool logging. |
| QuickPlaceUpgradeLogging |
4 |
Upgrade logging (upgrade places). |
| QuickPlaceUserCacheLogging |
1 |
User cache parameter logging. |
| QuickPlaceUserDirectoryLogging |
1 |
User directory logging (applicable only when Lotus Quickr controls directory services) . |
| QuickPlaceWebCacheLogging |
3 |
Web caching logging (caches pages sent to browser). |
| QuickPlacePlaceStatisticsLogging | 4 | Place statistics logging |
| QuickPlaceNSFLogging, | 5 | NSF database logging |
| QuickPlaceDocumentLogging | 5 | Document-level logging |
| QuickPlaceLDAPLogging | 5 | LDAP logging |
| QuickPlacePreviewLogging | 1 | Document preview generation logging |
The following table describes notes.ini settings used to customize the Web page cache.
| Setting |
Description |
|---|---|
| QuickPlaceWebCacheDir==<pathname> |
Sets the cache directory. where <pathname> is the full file path name of the directory. If this variable is omitted from your server's notes.ini, the server cache is automatically set to the default directory (<NOTESPROGRAM>\data\cache. |
| QuickPlaceWebCacheEnabled=1 |
Disables or enables the cache. A value of 0 (zero) disables this setting. |
| QuickPlaceWebCacheGCIntervalInMIN=<minutes> |
Sets the time interval for cache cleaning |
| QuickPlaceWebCacheLimitInMB=<MB> |
Sets the cache size limit. This variable sets the cache size limit in megabytes. If you enter a number of zero or less (or omit the variable from your notes.ini file), the cache size limit defaults to 50 MB. |
| QuickPlaceWebCacheLogging=<n> |
Sets the cache logging level, which determines how detailed log messages will be. Acceptable values are 1, 2, or 3; where 1 is the least detailed and 3 is the most detailed. |
| QuickPlaceWebCacheUsers=<value> |
Defines which users will be affected by caching. By default, server caching applies to all users when the cache is enabled. To set the cache for anonymous users only, enter QuickPlaceWebCacheUsers= Anonymous. |
For complete information about notes.ini settings, refer to the developerWorks notes.ini glossary.
Use qptool commands to manage place membership.
You can use the qptool addmember command to add a name from a user directory as a member of a place or places. When you use qptool addmember rather than the user interface, you can add a member to multiple places at once.
Keep the following points in mind:
Enter the following command at the server console to add external members to places:
load qptool addmember arguments
where arguments are arguments described in
| 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, for example: "cn=Connor Jones,ou=Sales,o=Acme" Include any spaces in the name. Specify the character case (uppercase or lowercase) correctly. Note: The
server 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. You must use this argument to add an external group. If you use qptool addmember without the -g argument to add an external group as a member of a place, users who are members of the group can't access the place through the group membership, and the group may not show up in the user interface in some places. |
| -reader |
Adds the specified name as a Reader of a place. |
| -author |
Adds the specified name as an Author of a place. |
| -editor |
Adds the specified name as an Editor of a place. |
| -manager |
Adds the specified name as a Manager of a place. |
-owner |
Adds the specified name as an Owner of a place. |
| -allrooms |
Applies the place access specified for the name to all rooms in a place. If you omit this argument, the name's specified access applies only to a place's main room. |
| -a |
Adds the specified name as a member of all places on the server. |
| -p place(s) |
Adds the specified name as a member of a specific place or space-separated list of places. |
| -i inputfilename |
XML input file located in the server program directory that specifies the places in which to add an external member. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.addmember.xml in the server program directory. |
Table 40 provides examples of the qptool addmember command.
| Task |
Command |
|---|---|
| Add the user cn=Connor Jones,ou=Sales,o=Acme as an author of all rooms in Place1 |
load qptool addmember -dn "cn=Connor Jones,ou=Sales,o=Acme" -author -allrooms -p Place1 |
| Add the group cn=Salesgroup,o=Acme as a reader of the main room in all places |
load qptool addmember -dn cn=Salesgroup,o=Acme -g -reader -a |
Add a local member when you want to grant access to an individual who is not currenlty registered on an existing local database, or when you want a member of a group to have access to one or more rooms, without granting access to all the rooms of a place.
Use the qptool changemember command to change the name of a local user member, external user member, or external group member in specified places. For example, if you have changed the name of an external user in the user directory, use qptool changemember to make the change in the places to which the user belongs.
The changemember command changes a single user or group name. If you need to change a large number of user or group names, see Renaming of users and groups.
The original name is referred to as the source name and the name to which you change, the target name.
Using qptool changemember, you can do the following tasks:
You can make these combinations of name changes:
You cannot make these combinations of name changes:
Enter the following command at the server console to rename members in places:
load qptool changemember arguments
where arguments are described in Table 41.
| Argument |
Description |
|---|---|
| -? |
Prints help on the command. |
| -sourcedn name |
Specifies the distinguished name of an external user or group member as it currently appears in places, for example, "cn=Connor Jones, ou=Sales,o=Acme." |
| -sourceu name |
Specifies the current name of a local user member, for example, "Joe Smith." |
| -sourceg |
Indicates that the specified source name is that of an external group. |
| -targetdn name |
Specifies the new distinguished name of an external user or group member. for example: "cn=Representatives,ou=Sales,o=Acme" Note: IBM Lotus Quickr does not look up the
target name in the user directory to verify it, so be sure that the
name is valid.
|
| -targetu name |
Specifies the new name of a local user, for example, "Joe Smith." |
| -targetg |
Indicates that the specified target name is that of an external group. |
| -p place(s) |
Specifies a place or a space-separated list of places in which to rename the user or group. |
| -i inputfilename |
XML input file located in the server program directory that specifies the places in which to rename the user or group. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.changemember.xml in the server program directory. |
Table 42 provides examples of using the qptool changemember command.
| Task |
Command |
|---|---|
| Change the name of local user name to an external user name. |
>load qptool changemember -p PlaceName -sourceu localuser -targetdn "CN=ExternalUser,O=[Organization]" |
| Change an external user name to an external user name. |
>load qptool changemember -p PlaceName -sourcedn "CN=External User,O=[Organization]" -targetdn "CN=New External User,O=[Organization]" |
| Change an external group name in multiple places. |
>load qptool changemember -p PlaceName1 PlaceName2 -sourceg -sourcedn "CN=External Group,O=[Organization]" -targetg -targetdn "CN=New External Group,O=[Organization]" |
Use the qptool changemember command to rename users and groups from one value into another and to perform batch renames of large numbers of users and groups. The name values are generally entered as command line arguments.
load qptool changemember -p PlaceName -sourcedn "CN=External User,O=IBM" -targetdn "CN=New External User,O=IBM"This command renames the user in a place called PlaceName from CN=External User to CN=New External User.
To make a large number of changes, it would be much easier to batch-process all user/group name changes at a place level and execute them using the qptool execute command.
load qptool execute -i xmlfile.xml -o xmlfile_out.xmlYou also can rely on adminP to rename users and groups if you have enabled it. Refer to Enabling AdminP to work on the Lotus Quickr server.
The actions to be executed are as follows:
<?xml version='1.0'?>
<service>
<servers>
<server local='true'>
<places>
<place>
<name>qp_innovation</name>
<members>
<person action='add' id='newuser'>
<dn>CN=newuser,ou=users,dc=corp,dc=ibm,dc=com</dn>
</person>
<person action='remove'>
<dn>CN=Old User,OU=NA,O=IBM</dn>
</person>
<person action='rename'>
<dn>CN=Corp User,OU=NA,O=IBM</dn>
<new_dn person='true'>CN=corpuser,ou=users,dc=corp,dc=ibm,dc=com</new_dn>
</person>
<person action='rename'>
<dn>CN=Corp A User,OU=NA,O=IBM</dn>
<new_dn person='true'>CN=corpauser,ou=users,dc=corp,dc=ibm,dc=com</new_dn>
</person>
<person action='rename'>
<dn>CN=Corp B User,OU=NA,O=IBM</dn>
<new_dn person='true'>CN=corpbuser,ou=users,dc=corp,dc=ibm,dc=com</new_dn>
</person>
</members>
<rooms>
<room>
<name>main.nsf</name>
<access>
<readers>
<member action='add'>
<link idref='newuser'/>
</member>
</readers>
</access>
</room>
</rooms>
</place>
</places>
</server>
</servers>
</service>
You can use the qptool changehierarchy command to change the hierarchy of external user and group member names in places. For example, if your company name changes, and as a result you change the name hierarchy in the user directory, use qptool changehierarchy to change the names in places.
Or if you create a new group with a new hierarchy in your external directory to encompass what was previously two groups, you can change the names of the original group members in places to the name of the new group.
The changehierarchy command does not operate on local users.
To change the hierarchy of names in places, enter the following command at the server console:
load qptool changehierarchy arguments
where arguments are described in Table 43
| Argument |
Description |
|---|---|
| -? |
Prints help on the command. |
| -sourceh hierarchy |
Specifies the original name hierarchy to change, for example, OU=people,O=group |
| -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. |
| -a |
Changes the hierarchy of member names in all places that have member names with the original name hierarchy. |
| -p place(s) |
Changes the hierarchy of member names in a place or space-separated list of places. |
| -i inputfilename |
Changes the hierarchy of member names in places specified in an XML input file located in the server program directory. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.changehierarchy.xml in the server program directory. |
Table 44 provides examples of qptool changehierarchy.
| Task |
Command |
|---|---|
| Change the names of users and groups within the hierarchy OU=boston,O=acme to the hierarchy OU=detroit,O=acme in the place P1 |
>load qptool changehierarchy -sourceh OU=boston,O=acme -targeth OU=detroit,O=acme -p P1 |
| Changes the names of users and groups with the hierarchy OU=boston,O=acme to the hierarchy OU=detroit,O=acme in all places |
>load qptool changehierarchy -sourceh OU=boston,O=acme -targeth OU=detroit,O=acme -a |
When information about an external member, such as an e-mail address, changes in the user directory, use the qptool updatemember command to update the information in places.
qptool updatemember updates the following information:
qptool updatemember does not operate on local members.
To update external member information in places, enter the following command at the server console:
load qptool updatemember arguments
where arguments are described in Table 45.
| Argument |
Description |
|---|---|
| -? |
Prints help on the command. |
| -dn name |
Specifies the name of an external user or group whose member information has changed in the user directory, for example:. "cn=Connor Jones,ou=Sales,o=Acme" If you use this argument, do not use -allmembers. |
| -allmembers |
Updates all external member information in the specified place(s). If you use this argument, do not use -dn name. You can run qptool updatemember -allmembers -a on a schedule. How often you should run it depends on how often the contents of your user directory changes. |
| -g |
Indicates that a name specified for the -dn argument is the name of a group. |
| -a |
Updates external member information in all places |
| -p place(s) |
Updates external member information in a specific place or space-separated list of places. |
| -i inputfilename |
XML input file located in the server program directory that specifies the places in which to update external member information. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.updatemember.xml in the server program directory. |
Table 46 provides examples of the qptool updatemember command.
| Task |
Command |
|---|---|
| Update the member information for the user cn=Connor Jones,ou=Sales,o=Acme in all places |
load qptool updatemember -dn "cn=Connor Jones,ou=Sales,o=Acme" -a |
| Use the notes.ini file to update all member information in all places daily at 3 AM. |
ServerTasksAt3=qptool updatemember -allmembers -a |
| Update the member information for the group cn=Adminstrators,o=Acme in all places |
load qptool updatemember -dn cn=Administrators,o=Acme -g -a |
Use the qptool removemember command to remove local or external members from places.
Enter the following command at the server console::
load qptool removemember arguments
where arguments are arguments described in Table 47
| 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" Include any spaces in the name. Specify the character case (uppercase or lowercase) correctly. |
| -g |
Indicates that a specified distinguished name is that of a group. |
| -u name |
Name of a local user to remove. If the name contains a space, include quotation marks around it, for example: "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. |
Table 48 provides examples of the command.
| Task |
Command |
|---|---|
| Remove the external user cn=connor jones,ou=sales,o=acme from the place P1 |
>load qptool removemember -dn "cn=connor jones,ou=sales,o=acme" -p P1 |
| Remove the external group cn=managers,ou=groups,o=acme from the place P1 |
>load qptool removemember -g -dn "cn=managers,ou=groups,o=acme" -p P1 |
| Remove the local user Jonathan Carter from the places P1 and P2 |
>load qptool removemember -u "Jonathan Carter" -p P1 P2 |
| Remove the external user cn=connor jones,ou=sales,o=acme from all places |
>load qptool removemember -dn "cn=connor jones,ou=sales,o=acme" -a |
| Remove the external group cn=managers,ou=groups,o=acme from places specified in the XML input file qptool.myremmem.xml |
>load qptool removemember -i qptool.myremmem.xml -g -dn "cn=managers,ou-groups,o-acme" |
| Remove the external user cn=connor jones,ou=sales,o=acme from the place P1 and log the command output to the non-default XML output file qptool.myoutfile.xml |
>load qptool removemember -dn "cn=connor jones,ou=sales,o=acme" -p P1 -o qptool.myoutfile.xml |
Use the qptool password command to change passwords for local members.
To change local member passwords, enter the following command at the server console:
load qptool password arguments
where arguments are described in Table 49
| Argument |
Description |
|---|---|
| -? |
Prints help on the command. |
| -u name |
Specifies of the name of the local member 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. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.password.xml in the server program directory. |
Table 50 provides examples of the command.
| Task |
Command |
|---|---|
| Change the password for a local user whose name has no spaces |
>load qptool password -p placename -u joeuser -pw newpassword |
| Change the password for a local user whose name includes spaces |
>load qptool password -p placename -u "joe user" -pw newpassword |
Use the qptool membershipmodel to enable expanded membership in places, to recreate expanded membership groups if you change the LDAP directory or base distinguished name used for them, or to resolve problems with expanded membership groups.
Expanded membership increases the maximum number of place members from 900 to 4000. Since a place set up to use expanded membership cannot revert to standard membership, consider the implications for directory services, access control and user interfaces before using this feature.
IBM Lotus Quickr 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 access control lists 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 using these groups, rather than the individual user names, in room access control lists.
Consider the following points before you use the expanded membership model (EMM):
When a place uses expanded membership, Lotus Quickr creates room-specific access control groups in an LDAP directory. The LDAP directory can be one that Lotus Quickr uses generally, or a different directory.
Lotus Quickr 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_Authors,ou=placename,base_dn
cn=h_Readers,ou=placename,base_dn
where
placename is the name of the place.
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 Quickr adds the user's name to one of these groups, according to the access assigned to the user. For example, Lotus Quickr adds an external user member with Reader access to the place's "cn=h_Readers...." group.
If someone creates a subroom, Lotus Quickr creates the following groups in the directory, and adds the groups to the subroom ACL:
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
uniquenumber is the unique number XXXXXXXX in the room name "PageLibraryXXXXXXXX.nsf" that identifies the room.
placename is the name of the place that contains the room.
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 Quickr group associated with the subroom. Removing a place or a subroom removes the expanded membership groups associated with the place or subroom.
Suppose a place named salestrends uses expanded membership and the base distinguished name specified in the qpconfig.xml file for the expanded membership groups is ou=groups,o=teamworkplace. If someone adds an external user member to salestrends with Author access, Lotus Quickr adds the user's name to a group created in the LDAP directory called cn=h_Authors,ou=salestrends,ou=groups,o=teamworkplace. The group is included in salestrends' Main.nsf room ACL.
Suppose someone creates a subroom named PageLibrary85256CD200797D7B.nsf within salestrends and adds an external user member to the subroom with Reader access. Then Lotus Quickr adds the user's name to a group generated in the LDAP directory called cn=h_Readers,ou=85256CD200797D7B,ou=salestrends,ou=groups,o=teamworkplace. The group is included in the subroom ACL.
Expanded membership uses group names in room ACLs rather than individual user names to control the access of individual external user members. As a result, the access given to an individual external user member no longer takes precedence over the access assigned to groups the user belongs to, or over super user access. The access control behavior for expanded membership differs from standard membership in the following ways:
If you enable expanded membership for a place, users see the following changes:
If you have enabled expanded membership on the server, use the qptool membershipmodel command to enable expanded membership in one place, specific places, or all places. The effective use of groups in the LDAP directory is the best approach to handling large member access lists.
After you have enabled expanded membership in a place, reverting the place to standard membership is not supported. If there are replicas of a place, run the command on one replica only.
load qptool membershipmodel argumentswhere arguments are arguments described in the following table:
| Argument |
Description |
|---|---|
| -? |
Prints help on the command. |
| -toexpanded |
Converts places to expanded membership. |
| -a |
Runs the command on all places that do not currently use expanded membership |
| -p places |
Runs the command on a place or a space-separated list of places. |
| -i inputfilename |
Runs on places specified in an XML input file. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.membershipmodel.xml in the server program directory. |
Table 18 provides examples of using the membershipmodel command to enable expanded membership in places.
| Task |
Command |
|---|---|
| Enable "placeofmanymembers" to use expanded membership. |
>load qptool membershipmodel -toexpanded -p placeofmanymembers |
| Enable all places that do not currently use expanded membership to use expanded membership. |
>load qptool membershipmodel -toexpanded -a |
Use the qptool membershipmodel to change the LDAP directory server or base distinguished name used for expanded membership groups.
Perform the following steps in the exact order given:
If expanded membership is used and My Places or cross-place searching does not work, the expanded membership groups may be corrupt or out of synchronization with their places. Remove and then recreate the groups to correct the problem.
Enter the following commands at the server console:
load qptool membershipmodel -rmgroups -p place load qptool membershipmodel -addgroups -p place
where place is the name of one place or a space-separated list of places.
Use My Places and qptool commands to manage places.
External members who have at least reader access to places can use My Places to display statistics about the places. External members with manager access can use My Places to perform place administration tasks.
Use My Places to display a variety of statistics about the places that you have access to.
Use the qptool sendmail command to broadcast an e-mail message to place managers or to all members of a place. The sendmail command is useful for communicating administration issues. For example, you could send a broadcast e-mail to the managers of places if the places have exceeded a predetermined size limit and will be archived.
Enter the following command at the server console to send mail to place members:
load qptool sendmail arguments
where arguments are described in the following table Table 54:
| 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. |
| -i inputfile |
A required argument that specifies the places and other data in an XML input file located in the server program directory. If you are using tags for title, size, last_accessed or last_modified, values for those fields must exist in the input file. The qptool sendmail command only looks to the input file for its data; it does not query the places for the tag values. |
| -o outputfile |
Logs results to a specified XML output file. By default logs results to qptool.sendmail.xml in the program directory. |
Customize the following sample template to suit your needs:
<?xml version="1.0"?> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0" xmlns:lsxlt="http://xml.apache.org/xslt" xmlns:java="http://xml.apache.org/xslt/java"> <xsl:template match="place"> <mail> <from>E-mail address here</from> <cc>List of e-mail addresses here</cc> <bcc>List of e-mail addresses here</bcc> <subject>Subject string here</subject> <body>
This mail is sent to members of place '<xsl:value-of select="./name"/>' by qptool sendmail using xsl as a mail template. Some other fields you might want to use are:
TITLE: '<xsl:value-of select="./title"/>', SIZE: '<xsl:value-of select="./size"/>', LAST_ACCESSED: '<xsl:value-of select="./last_accessed"/>', LAST_MODIFIED: '<xsl:value-of select="./last_modified"/>' </body> </mail> </xsl:template> </xsl:stylesheet>
'<xsl:value-of select="./fieldname"/>'
where fieldname is the name of a field in the input XML.
Use the qptool newsletter command to send daily and weekly newsletters to members of places. Members of a place can receive daily newsletters if daily newsletters are enabled for the place in and can receive weekly newsletters if weekly newsletters are enabled in . To receive a newsletter, a member must subscribe to newsletters in the member information page and must have a valid e-mail address.
To send newsletters, enter the following command from the server console:
load qptool newsletter arguments
where arguments are described in Table 55
A place will not send out a newsletter unless the following requirements are met:
| 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. |
| -weekly |
Sends newsletters in weekly format. Using a Program document to schedule the mailing of weekly newsletters for all places is recommended. Weekly newsletters typically take longer to process then daily newsletters, especially if there are many members and places. Server performance can slow during processing. Therefore, schedule the newsletter -weekly command to run during non-business hours, for example Friday evenings or Saturdays. Note: Place
members who sign up to receive weekly newsletters only receive them
if you create a Program document in the Domino Directory with qptool
newsletter -weekly -a and set a time and day for the server to collect
and send weekly newsletters.
|
| -a |
Sends newsletters for all places. |
| -p place(s) |
Sends newsletters for a place or a space-separated list of places. |
| -i inputfile |
Sends newsletters for 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.newsletter.xml in the program directory. |
Use the qptool lock and qptool unlock commands to take places in and out of service without stopping the server. Use the lock command to put places temporarily out of service during maintenance operations and then use the unlock command when the maintenance operations are complete.
When you have locked a place, a user trying to access that place receives a message that you specify.
Other qptool commands lock places specified in the command automatically before running and then unlock the places when the operations are complete. However, you might want to lock a place before running multiple qptool commands to prevent users from accessing the place until you have finished running the commands. For example, you might want to lock a place while using the qptool changemember command to change several member names within the place to prevent members from accessing the place until all the name changes are complete.
When a place is locked, the only qptool command you can run on it is qptool unlock.
Enter the following command the server console to lock or unlock a place:
load qptool lock[unlock] arguments
where arguments are described in Table 56
| 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 to indicate it is unavailable. 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.
|
Table 57 provides examples of the commands.
| 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 |
Use the qptool archive command to copy place directories and their contents to a specified archive directory.
Use the archive command when you want to:
To archive places, enter the following command from the server console:
load qptool archive arguments
where arguments are described in Table 58.
| 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. |
Table 59 provides examples of using the archive command.
| Task |
Command |
|---|---|
| Back up all places on the server |
>load qptool archive -dir x:\qpbackup -a |
| Archive more than one place to a target directory below c:\ |
>load qptool archive -dir c:\threeplaces -p placeone placetwo placethree |
| Archive places specified in an XML input file to a directory below c:\ |
>load qptool archive -i qptool.archive.xml -dir c:\threeplaces |
| Archive a place to a directory below c:\ and log output to a non-default XML file location. |
>load qptool archive -p placename -dir c:\placenameback -o c:\qptool.archive.xml |
If you archived a place and removed it from the server but now want to restore the place, use the qptool unlock and qptool register commands.
Perform the following steps:
For example, suppose you used the following commands to archive placeone and remove it from the server data directory:
load qptool archive -p placeone -dir d:\archivedir load qptool remove -p placeone -now
To restore placeone, perform the following steps:
load qptool unlock -p placeone load qptool register -p placeone -install
Use the qptool unregister and register commands to rename a place.
Perform the following steps:
You can move a place from one current-release server to another.
Perform the following steps:
Use the qptool remove command to remove places or PlaceTypes from the IBM Lotus Quickr server. You might want to remove a place or PlaceType that is no longer used or that hasn't been used for a long time.
To remove places or PlaceTypes, enter the following command from the server console:
load qptool remove arguments
The following table describes the arguments for the command.
| 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. Note: Do not use this argument
to remove a place in a cluster, as the deletion may not replicate.
|
| -cleanup |
Deletes places or PlaceTypes that were previously marked for removal through the remove command or that were deleted through the Lotus Quickr user interface. The ServerTasksAt2 NOTES.INI setting includes qptool remove -cleanup, so that the command runs by default at 2 AM. Note that the -cleanup argument does not work on places that are in the database cache. Since QPTool -cleanup typically runs off-hours, places are not in the database cache when the command is run. If you run qptool remove -cleanup at other times, use the dbcache flush command to flush databases from the cache before using -cleanup. For more information on the database cache, see Domino Administrator Help. |
| -a |
Marks for removal or deletes all places on the server. This argument does not run on PlaceTypes. |
| -p place(s) |
Specifies a place or a space-separated list of places to mark for removal or to delete. |
| -pt PlaceTypes |
Specifies a PlaceType or a space-separated list of PlaceTypes to mark for removal or to delete. |
| -i inputfilename |
XML input file located in the server program directory that specifies places or PlaceTypes to mark for removal or to delete. |
| -o outputfilename |
XML output file that logs the results of the command. By default the command logs results to qptool.remove.xml in the server program directory. |
The following table provides examples of using the remove command.
| Task |
Command |
|---|---|
| Mark the place P1 for removal |
>load qptool remove -p P1 |
| Mark all places on the server for removal |
>load qptool remove -a |
| Mark PlaceType PT1 for removal |
>load qptool remove -pt PT1 |
| Mark places P1, P2, and P3 for removal |
>load qptool remove -p P1 P2 P3 |
| Mark places for removal that are specified in the XML input file qptool.removeinput.xml |
>load qptool remove -i qptool.removeinput.xml |
| Mark the place P1 for removal and log output to the non-default XML file qptool.removeoutput.xml |
>load qptool remove -p P1 -o qptool.removeoutput.xml |
| Remove the place P1 immediately |
>load qptool remove -p P1 -now |
| Remove all PlaceTypes on the server immediately. Note that you cannot use the -a argument to remove all PlaceTypes. |
>load qptool remove -pt PT1 PT2 PT3 PT4 PT5 -now |