IBM Lotus Quickr Templates for Domino

Installation and Configuration

Rev: 8.1.0.9 & 8.2.0.0 -- Date: June 8, 2009 -- Author: Rob Novak

Congratulations on your download of the IBM Lotus Quickr FREE templates created by SNAPPS, the
official IBM Design Partner for Lotus Quickr.

These instructions will help you install and configure the templates on your own Lotus Quickr
services for Domino server. The audience for this document is the Lotus Quickr server
administrator. You should have some experience with IBM Lotus Domino and the Domino
Administrator client, have administrative and file-system access to the Lotus Quickr server, and
have permission to create places, install files, and run agents.

Prerequisites: IBM Lotus Quickr 8.0, 8.0.0.2, 8.1 or 8.2 server for Domino, any supported
platform
Lotus Domino Administrator Client

There are two main scenarios for deploying templates either you are installing them for the first
time, or you are upgrading (from Quickr 8.0x to 8.1 for instance). If you are upgrading, you
have already followed the bulk of these instructions. Skip to the section on Upgrading to
Quickr 8.1/8.2.

Special Instruction: Quickr 8.2 server setting

On a new Quickr 8.2 server, in the qpconfig.xml file, you must modify the new setting for xsrf
protection in the security section as follows:

<xsrf_protection enabled="false" />

If you do not modify this setting, you will receive the error message:

Warning
Problem: You can not take this action from this URL, Please go back to the previous page and try again
Solution:Try Again

Prerequisite Files:
You must download and install the prerequisite files after Lotus Quickr is installed, configured for
a directory, and running. Ensure that Quickr is running normally before starting these
instructions.

The templates have three prerequisite file sets. QEngine.nsf is required for six of the templates to
run workflow, projects, and logging agents. QContacts.nsf is required for collecting and
processing contact records for the QContacts template or any application using its code. The
qcommon directory is required for ALL templates.

1. Download QEngine.nsf and QContacts.nsf from the download site. QContacts.nsf is listed
with the QContacts application, while QEngine.nsf is shared among several applications so
it is in the prerequisite files. Place them on the server in the Domino data directory (not a
subdirectory). Open each with a Lotus Notes client and open the Help-About document
for important information on setting the ACL and Roles.
2. Using Domino Administrator, you must Sign the two databases with the current server ID.
An administrators ID may work, however some notification emails will appear to come
from that address. Ensure that the signature process was completed successfully by
launching each database in Domino Designer and inspecting the design elements.
(Optional) For more information on how to Sign databases, consult the Lotus Domino
Administration documentation - but here are the basic steps.
a. Open Lotus Domino Administrator
b. File Open Server
c. Choose the Lotus Quickr server
d. Navigate to the Files tab
e. Right-click the QEngine.nsf and/or the QContacts.nsf database, choose Sign
 f. Select Server ID then sign the database
3. You must enter QEngine.nsf with a Lotus Notes client using an ID that has the [Admin]
role, navigate to the Configuration view, and click New to create a configuration
document. Replace the value of the host name with that of your Lotus Quickr server.
Ensure that the Domino server name is correct, or correct it. To enable integration with
Lotus Connections, enter a Connections server URL.
4. Download the qcommon_files81.zip file (regardless of the version of Quickr) and unzip to
the following location, which is critical:

<domino>\<dominodata>\domino\html\qphtml\html\qcommon

The files in the archive do not have a folder structure, rather they all unzip to this
directory directly. If you are starting with a new Quickr 8.1 server, you will have to
create this directory. The IBM installation no longer creates it (it did in 8.0x). You will
already have this directory if you have Lotus Quickr 8.0x installed. Allow the files to
overwrite any that already exist. Verify that the files have installed to this directory. There
should be at least 76 files.

Instructions for Installing a Single Template for Standalone Use

These instructions are generic to all templates you download using the Download Place link. A
Place is a combination of three files, and possibly the full text index. When you download a place,
you are downloading an entire application that has been assembled and tested, and is ready for
use on your server.

The prerequisite files MUST be in place, the ACLs correct, and the qcommon files in place before
any of the templates will work.

1. Download a place from the download site.

2. Unzip the place to a directory on the server, or locally and copy to the server, to the
directory where your Quickr places are located. This may be:

<domino>\<dominodata>\quickplace\or
<domino>\<dominodata>\lotusquickr\

For instance, if you have downloaded QActivities and use the quickplace subdirectory, you
will unzip it to:

<domino>\<dominodata>\quickplace\qactivities

You will see three main files unzip to this directory, main.nsf, contacts1.nsf, and
search.nsf.

3. From the Domino console, or from a remote console using Domino Administrator, issue
the following commands to register the place(s):

>loadqptoolupgradefp<placename>

>loadqptoolregisterinstallp<placename>

NOTE:YoumustTYPEthesecommands,donotcopyandpastethem.Pastingfroman
AcrobatPDFresultsinextracharactersandthecommandwillnotwork.

4. Log into the place on the server. The initial user name and password are the same as the
place name, but in lower case. For instance, the QProject place has a user name of
qproject and password of qproject.
NOTE: If you are unable to log in using these combinations, then step #3 was not
successful, or you are not using LDAP. In the latter case, add a Super User to the server
and use this ID to log in.
 5. Add new members to the place from your directory. Add at least one Manager before
removing the initial user.
6. IMPORTANT: Log back into the place with a Manager ID capable of running PlaceBots with
restricted access. Navigate to Customize in the place, and click on PlaceBots. For each
PlaceBot, select it and click Sign PlaceBot. Ensure that each PlaceBot is signed.
NOTE: If you experience behavior in a place such as fields not found, unable to comment,
not seeing revisions of a wiki, etc., then a) this step was not taken or b) your ID does not
have rights to run PlaceBots. See your administrator first, then report issues on the online
forums.
7. Read the Quick Start page for each template before using it (not available on new 8.1
templates refer to demos). Consult the Flash demos created by SNAPPS for a more
complete walk-through. These demos are linked from the following blogs:
http://www.LotusRockStar.com
http://viktr.com
http://nsftools.com

Special Instructions: QPhotos

QPhotos is an image management template that has unique requirements for access to the file
system to create and attach image thumbnails. Following is the additional setup for QPhotos.

Create a working temporary directory on the file system where the Domino server has -R-W-D
rights. This could be within the Domino data directory or on a different drive. Create the
properties file qphoto.properties in the Domino program directory with two entries of
"ImageDirectory" and "DefaultMaxThumbnailSize". It should have values something like the
example below (you may change the working directory):

ImageDirectory=c:\\temp\\qphotos\\
DefaultMaxThumbnailSize=160

Java requires a double black-slash. (A single forward slash works for Windows as well.) The file
path must end with a \\ or / character. You can change the DefaultMaxThumbnailSize value to a
different size. This size is in pixels. 160 is recommended, but you may choose another nonzero
number. All images will scale to this size for the thumbnail. Be sure to place this file into the
Domino program directory. For iSeries and AIX deployments, you also need to modify
permissions on this file to qnotes.

Special Instructions: QActivities

QActivities allows for integration with the IBM Lotus Connections server, specifically the Activities
server. In order to activate this integration, you must modify the QEngine.nsf configuration
document with the URL of your Lotus Connections server. Once you do this, the Add to an
Activity button will appear in QActivities.

Instructions for Using the Templates as Lotus Quickr PlaceTypes

Lotus Quickr has a mechanism for allowing places to be used as a master place, creating a
PlaceType from it, then inheriting design and design changes to places created from the
PlaceType. This topic is covered in full in the Lotus Quickr Infocenter, but basic instructions are
located here:

1. Follow all the instructions for using a place as a standalone place, ensuring that the
PlaceBots are signed and the place is working as expected.
2. Navigate to Customize and click PlaceType Settings.
3. Check the box to Allow this place to be used as a placetype, add a description and if you
wish, an icon.
4. Navigate out of the place, to the My Places interface. You must be logged in as an
Administrator capable of working with Templates.
a. Click the link on the right titled Work with Templates. A list of available
templates will appear.
 b. Click Create PlaceType at the bottom of the list.
c. Enter a name for the placetype, and choose the place you just configured as the
place to base the placetype on.
d. You will be returned to the list of available Templates, including your new one.
5. You may now create a place based on this Template and begin using it.

Instructions on Using the Template Applications

Each 8.0 Template ships with a high-level instruction as the Quick Start page, replacing the
standard Lotus Quickr welcome page. Follow these instructions. These pages are not in the 8.1
versions. Make sure to watch the Flash demos of the templates in use at the following blog
addresses:

http://www.LotusRockStar.com
http://viktr.com

Return to the http://QuickrTemplates.com site often for updates, new documentation, more
demos, and information on the limited support available for these templates. Support is available
on an as-available basis from the developers at SNAPPS.

Upgrading templates from Quickr 8.0x to Quickr 8.1 (template versions 8.1.0.9)

When you upgrade your Quickr server to 8.1, the templates that were working in 8.0x will have
various degrees of incompatibility due to major changes in the 8.1 themes, JavaScript variables,
and behavior. Therefore the 8.0x versions of the templates are NOT supported at all (even with
paid support) on an 8.1 Quickr server.

For All Scenarios: You MUST replace the contents of the following directory with the files in
qcommon_files81.zip, which is listed as a Prerequisite file:

<domino>\<dominodata>\domino\html\qphtml\html\qcommon

Take special care to ensure that the path is correct, and that you have (at least) 76 files in the
resultant directory. The zip file is flat and contains no folders.

As of the release date of the 8.1 templates, you do not need to upgrade/update qengine.nsf.

You must then update the templates using one of these methods.

If you created placetypes in Quickr 8.0x using the 8.0x templates:

After a complete backup, remove the master place from the server. For instance, if you
used the names of the places as-is, you would remove the places called qissues,
qmeeting, qphotos, etc. Use the qptool command:
Loadqptoolremovenowp<placename>
Next, go to the administration area of the Quickr server where placetypes are maintained.
Make note of the name you gave the placetype (important), then remove it.
Now, place the new 8.1 template onto the server, using the same name as before. Follow
the instructions above Instructions for Using the Templates as Lotus Quickr
PlaceTypes for each place. Once the master place is ready, you may create a new
placetype using the same name as before. Finally, to push changes into dependent child
places, you must run the qptool command:
Loadqptoolrefreshd<placetypename>
If you are unable to run this command, you may run refresh against individual places as
follows:
Loadqptoolrefreshp<placename>

If you created a standalone application, or used the download as a single place (no placetype):
In this instance, in order to avoid losing data, you must update the design elements in the target
place by downloading the source files from the QuickrTemplates.com site, and applying them
individually to the place design. Note that for QSite, you use design elements from the individual
source files for each place.

If you added source design elements to your own exiting Quickr applications:
Identify the source files required from the QuickrTemplates.com website, and upload them.
Special Instruction: Upgrading templates to 8.1.0.9 (from any version below 8.1.0.3)

Template version 8.1.0.9 - as signified in the file names as you download them - includes several
bug fixes and a new feature in one of the core forms used in several templates, the Enhanced View
Form. Since a new field has been added to the Enhanced View Form and Quickr has an inelegant
way of dealing with new fields on HTML forms, there are special instructions to follow when
upgrading to template version 8.1.0.9.

1. Follow all of the upgrade instructions in the section Upgrading templates from Quickr 8.0x
to Quickr 8.1 (template versions 8.1 or 8.1.0.9).
2. Once all places have been refreshed, you must open each place that uses one of the templates
below, and navigate to each Enhanced View Form, put it in Edit mode, and save it again. The
Enhanced View Form pages you need to refresh are the ones that look like folders but are not
Quickr standard folders - they are pages that compute the contents from a back-end Domino
view and display them in a special format.
a. QAnnounce
b. QIssues
c. QIdeas
d. QPresent
e. QPhotos
f. QProject
g. QSite
3. Step #2 above can be a distributed activity - you can instruct the managers of the sites on how
to do this. Until the pages have been re-saved, an error will be thrown in the browser - in IE,
the Error on Page icon will show in the bottom left corner, and in Firefox with Firebug, 1
Error will show in the bottom right corner. In our testing, neither browser threw a dialog box
error.

Note: this extra step does NOT need to be taken with new places. Also note, IBM has created an
SPR on the core issue of HTML form updates causing errors when new fields are present, and is
fixing it in an upcoming release.

Special Instructions for upgrading design of QContacts

If you have already deployed QContacts.nsf and have been using it, you will need to refresh the
design of the database instead of replacing the database file.

1. Download qcontacts_db.nsf, and install it on a Lotus Notes client (NOT the server, where it will
overwrite the current database).
2. Back up your copy of QContacts.nsf from the server
3. Once you have the database locally, sign it with an administrators ID file.
4. Modify the ACL to include your server name.
5. Modify the Database Properties to check the box Database is a master template, and give it
a name QContacts
6. In the Notes client, select the servers QContacts.nsf database and choose File->Application-
>Refresh Design
7. Choose the Local server, and your template name QContacts. Allow the refresh to complete.
8. Re-sign the server database with the Server ID, using Domino Administrator
9. Test adding an external user as a contact and manually running the Update Contacts agent
from the Notes client.

New Features / Fixes in Template Version 8.1.0.9 and 8.2

1. QMeeting has a revised user interface on the meeting agenda form, with the addition of
indented sub-items, zero-time items, and the ability to show/hide the time column.
2. QSurvey has an enhanced Delete function that removes the answers along with the survey.
QSurvey also has an advanced Copy Survey function to copy a built survey to a new, ready-to-
enable copy.
3. QIdeas and QPresent have enhanced Delete functions to remove comments when the main Idea
or Presentation are removed.
4. The advanced Workflow Setup and engine have been enhanced with a new UI to make workflow
setup more intuitive.
5. QSite inherits all of the above enhancements.

New Features / Fixes in Template Version 8.1.0.3

1. Cosmetic issue with Enhanced view form has been fixed in QIssues, QIdeas and QSite.
2. QContacts bug whereby external contacts that are entered and not a member of a place
disappear from places after the Update agent runs has been fixed.
3. New Gantt Chart Form fixes issue with missing New Enhanced Task in the tools area.
4. Several issues with QPresent on 8.1 are fixed.
5. Problem with Issue submission in QIssues fixed.
6. Problem with agenda item form in QMeeting fixed.

New Features / Fixes in Template Version 8.1.0.1

1. The Enhanced View Form has a selector to show a particular default form as a link - similar to
Quickr Folders. In 8.1.0.1, you can decide which level of access is required in order for a user to
see the link. For instance, in QSurvey, you may want only Editors to see the link to create a new
survey, while all Authors can complete the survey. This is now possible.
2. Various UI fixes in QSurvey and QIssues to align the preview of questions.
3. A fix to QProject - only Managers could see content in Firefox, IE threw an error. The link to
create a new Enhanced Task was in a section of the page that was not visible to Authors or
Editors, causing an error - and in Firefox, the error stopped processing of further JavaScript
(the Gantt chart). The link has been moved to use a standard Enhanced View Form.

Technical Support

SNAPPS offers technical support contracts for the Quickr Templates for small (incident-based) and
enterprise (support subscription) installations. For more information on our technical support
offerings, please visit QuickrTemplates.com.

For single issues while getting started, please post to the Quickr forum on the DeveloperWorks
Quickr site at http://lotus.com/ldd

Please understand that we cannot guarantee the ability to answer individual support requests
without a support contract, as the software is provided free of charge.

SNAPPS offers customization, development, consulting, implementation

and support services for Lotus Quickr. Please contact SNAPPS at
info@snapps.com for more information on our services.