quickr for domino administration: qpconfig.xml, notes.ini, connections and you

© 2011 Wellesley Information Services. All rights reserved.

Quickr for Domino Administration: Qpconfig.xml, Notes.ini, Connectors, and You

Keith BrooksVanessa BrooksSkype/Twitter: @lotusevangelist

Why a Session on Quickr?

• New admins do not understand Quickr at first• Domino.Doc customers were told to move to Quickr• Quickr integrates with Connections• Quickr for Domino has a planned future• I co-authored a book on Quickr Administration this year and the

items we will discuss are what were most important to people

2

You Are on Notice

3

In This Session …

• We will discuss: What the Notes.ini has to do with a Quickr server Why the qpconfig.xml is so important to Quickr How to push the connectors out to the users

4

What We’ll Cover …

• Quickr Administration Basics• The Notes.ini Influence• The Qpconfig.xml Customizations• Connectors Configurations• Wrap-up

5

Adventures in Quickr Administration

6

• Domino-based, but not your normal administration There are no IBM admin tools, however business partner tools

do exist: SNAPPS – Snappfiles, PandaBear, Flippr, Anyplace Quickr

Tools, SNAPPS Templates, SNAPP-On Modules for Quickr RPR Wyatt – Essential Place Catalog, Essential File

Extractor Opus Neo – Neo.Dashboard, Neo.Tracking,

Neo.RoomManager, Neo.AccessReporter, Neo.QPMailin

Adventures in Quickr Administration (cont.)

• A little more “babysitting” is required Set up site managers and train them like admins

• Nothing but the Web ... to users To the admin it’s Web, Domino, and OS quirks

• Even the pros don’t always get it right Too many “anyone ever do/see this type posts”

7

What Are the Basics a Quickr Admin Needs to Do

• Think ahead Cluster? Email addressing? External users? Attachment sizes?

Connectors? Disk space? FTI? Logging?• Think about archiving and how to manage dead or old sites• Constantly improve performance and tweak everything• Create a logic for site owners to follow• Backup the qpconfig.xml and notes.ini regularly• Stay on top of the HotFix updates• Seek out other Quickr admins

8



9

10

No, This Book Does Not Exist ... But It Should

Quickr Areas Covered by the Notes.ini

• Client logging settings• Offline settings• Other miscellaneous settings• Server logging settings• Web page cache settings

11

Performance Tuning Your Notes.ini

• Remove unnecessary tasks: Really only needs HTTP• Clustered should be:

ServerTasks=HTTP, AdminP, Replica,CLREPL,CLDBDIR• Remove: ServerTasksAt4=qptool refresh -a,qptool report –

policyexecute,qptool register -pts Set as a program document instead with your time preferences

• Remove: qptool placecatalog push -a Set as a program document instead with your time preferences

• Add: HTTPJVMMaxHeapSize=256M (Controls the max heap size of JVM)

• Add: QuickPlaceWebCacheEnabled=1 (if not there by default) Enables the cache 0 disables it

12

Performance Tuning Your Notes.ini (cont.)

• Add: UPDATE_SUPPRESSION_TIME=90 (or 120 if you can get away with it) The Update Task (indexer) maintains two work queues: An

immediate queue and a deferred queue Deferred update requests are held for 15 minutes before they

are processed so that requests to update the same database in that time are ignored as duplicate requests

Updater queues can grow if the server has a high update rate because of heavy database use

Use this variable to specify the length of time that deferred update requests are held in queue n - length of time in queue in minutes -n - (negative value) length of time in queue in seconds

• Add: UPDATERS=4 (or a number equal to or one less than your number of CPUs) 13

Notes.ini Settings — Cache Options

• QuickPlaceWebCacheDir=<pathname> Sets the cache directory Uses the full file path name of the directory If this variable is omitted, the server cache is automatically set

to the default directory NOTESPROGRAM>\data\cache• QuickPlaceWebCacheGCIntervalInMIN=<minutes>

Sets the time interval for cache cleaning• QuickPlaceWebCacheLimitInMB=<MB>

Sets the cache size limit in MB If you enter a number of zero or leave it out, the cache size limit

defaults to 50MB

14

Notes.ini Settings — Cache Options (cont.)

• 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

15



16

Words to Live By ...

17

The Qpconfig.xml Customizations

• QP from Quickplace, never changed it• The file sits in the Domino\Data directory

Called qpconfig_sample.xml Make a copy, then edit it

• Be careful when editing the file, XML errors can occur Test the xml file by opening it up in IE It will report an error if any exists on the page

• The file includes remarks and provides what is the default setting

• So many options, easier to discuss inside the file, so let’s go to the file!

18

The Qpconfig.xml Performance Thoughts

• Use an extra place view, which was introduced in Quickr 8.5 on Domino, to speed up the openMyPlace transaction

• Locate the load_balance_places_view element in the place_catalog entry in the qpconfig.xml file and set its attribute enabled=“true” <place_catalog enabled="true" log_level="0">.... <load_balance_places_view enabled="true"/>

• Disable checking for whether Lotus Quickr Connector is installed on the users’ systems

• Locate the roundTripEdit element in the connectors entry in the qpconfig.xml file and set its attachment enabled=“never” <connectors> <roundTripEdit enabled="never" /> </connectors> 19



20

Connectors 101

21

Quickr Connectors 8.5.0.6 Is the Latest and Includes …

• The Lotus Symphony connector, standalone and embedded• Installing connectors on Windows Vista/Windows 7 when User

Account Control (UAC) is on• Installing connectors on Windows 7• Migrating connector preferences during an upgrade• Simple and Protected GSS-API Negotiation Mechanism

(SPNEGO)

22

From Fix Central latest version, April 28, 2011: Lotus Quickr Connectors 8.5 HF6, Quickr 8.5.1 FP4

Quickr Connectors 8.5.0.2 Included Support For ...

• Lotus Quickr for Domino 8.5• Lotus Notes 8.5.2• Lotus Sametime Standard 8.5• Backwards compatibility with Lotus Quickr for WebSphere Portal

8.1.1.1• Backwards compatibility with Lotus Quickr for Lotus Domino 8.2• Extensive additional testing and fixes against all server back ends

23

Connector Options for Installation

• There are two ways to install the connectors to the desktops Manual: Users can download the connector installer from the

Quickr server Silent: Administrators can “push” the install package to client

desktops using desktop management software to silently install the connectors BMC (Marimba) Tivoli Configuration Manager MS System Configuration

24

Configuring Silent Installation: Step 1

• Click Download from the IBM Lotus Quickr connectors section of the footer

• Save the install file qkrconn.exe to your computer• Open a command prompt and navigate to the directory where you

saved the qkrconn.exe file• Make sure all applications such as Lotus Notes, Lotus Sametime,

Microsoft Office/Outlook, and Lotus Symphony are closed before performing the following silent commands

25

Configuring Silent Installation: Step 2

• Type qkrconn.exe /Options(s) [Property settings] • The optional parameters are listed below:

26

Options Description

/install Installs connectors

/uninstall Uninstalls connectors

/quiet Establishes silent mode requiring no user interaction

/norestart Prevents restart after the installation is complete

/promptrestarat Prompts the user for restart if necessary

/forcerestart Always restarts the computer after installation

Configuring Silent Installation: Step 3, Parameter Options

• The optional parameters are listed below: Public property [PROPERTY=PropertyValue] Description INSTALLDIR Directory that connectors will be installed in

For example, INSTALLDIR=C:\\Progra~1\\IBM\\QuickrConnectors

ADDLOCAL Specify which connector to install By default, if you do not specify the ADDLOCAL property, all

connectors are installed except for the Notes Embedded Symphony

ADDLOCAL=ALL installs all WindowsExplorer (required) MicrosoftOffice (for Microsoft Office) MicrosoftOutlook (for Microsoft Outlook)

27

Configuring Silent Installation: Step 3, Parameter Options (cont.)

• The optional parameters are listed below: (cont.) LotusSametime (for Lotus Sametime Standalone Edition) LotusNotes (for Lotus Notes and Sametime Embedded) LotusSymphonyStandalone (for Lotus Symphony Standalone

Edition) LotusSymphonyEmbedded (for Lotus Symphony embedded in

Lotus Notes)

28

Configuring Silent Installation Step 3, More Parameter Options

• QC_NOTES_TARGET_FOLDER When installing the place connector for Lotus Notes, specifies where Lotus Notes is installed This property is optional For example:

QC_NOTES_TARGET_FOLDER=C:\\Notes• QC_NOTES_NOTES_INI_PATH When installing the place

connector for Lotus Notes Single User Install (SUI), specifies where notes.ini is placed This property is optional For example, QC_NOTES_NOTES_INI_PATH=C:\Notes\notes.ini

29

Configuring Silent Installation Step 3, More Parameter Options (cont.)

• QC_SAMETIME_TARGET_FOLDER When installing connector for Lotus Sametime, specifies where Lotus Sametime is installed This property is optional For example: QC_SAMETIME_TARGET_FOLDER=C:\\progra~1\\

IBM\\Sametime• QC_SYMPHONY_TARGET_FOLDER When installing connector

for Lotus Symphony Standalone Edition, specifies where it is installed This property is optional For example: QC_SYMPHONY_TARGET_FOLDER=C:\\

progra~1\\IBM\\Lotus\\Symphony

30

Silent Install Syntax Examples

• Silent uninstall with no restart qkrconn.exe /uninstall /quiet /norestart

• Silent install with no restart and settings for Lotus Notes and Lotus Sametime qkrconn.exe /install /quiet /norestart QC_NOTES_TARGET_FOLDER=C:\\notes QC_SAMETIME_TARGET_FOLDER=C:\\progra~1\\IBM\\Sametime

The QC_ properties are required due to the user interface providing the option for changing any registry-discovered values first

31

Troubleshooting Silent Installations

• The installation will fail if you have installed one of the newer versions of the Quickr connectors, are unable to update the connectors via an unattended installation, and you are using the ADDLOCAL command, such as: qkrconn.exe /install /quiet

ADDLOCAL=WindowsExplorer,MicrosoftOffice• Use the following line instead:

qkrconn.exe /install /quiet REINSTALL=WindowsExplorer,MicrosoftOffice

• For a new installation, you still need to use ADDLOCAL instead of REINSTALL Your software distribution package should check if a connector

is already installed and use the correct parameter

32

Pre-Configuring Users’ Desktops with Connector Content

• Administrators can use the QuickrConfig tool to export and import a place list from one system to another

• The tool can be run by An end user Deployment script

• The tool can be used optionally to export and import user preferences as well as global defaults and policies so that users can run the tool to backup their configuration in the event that they need to run a clean install of the connectors

33

Pre-Configuring Users’ Desktops with Connector Content (cont.)

• The QuickrConfig tool is installed as part of the core code with the Lotus Quickr Connectors installation

• It consists of two files: QuickrCfg.exe and QKRCOM.dll• The QKRCOM.dll is a self-registering .dll file registered by the

installer If the .dll file is not registered, the tool will not work

• An administrator can deploy these files to a machine with an older version of the connectors, or without the connectors installed, and then just register QKRCOM.dll (regsvr32 QKRCOM.dll)

34

Configuring Connector Content Options

Command Description

-backup Creates a backup of the current configuration

-deletebackup Delete any backup configuration

-export Exports configuration to <filename>

-format Print xml syntax/format

-import Imports configuration from <filename>

-help / -? Print cmd syntax

-restore Restores a previous backup

-sample Print out sample xml

-validate Validates xml format in <filename>

35

Configuring Connector Content via Exporting

1. Access the default location of the Lotus Quickr Connectors, typically:

C:\Program Files\IBM\Places Connectors

2. To export all servers, places, policies, preferences, and global defaults to a specified file, enter a command similar to the following:

QuickrCfg -export myQuickr.xml

1. To perform a full export to myQuickr.xml and overwrite the file (if it exists), enter:

QuickrCfg -export -overwrite myQuickr.xml 36

If no file is specified, the default file name QuickrCfg.xml is used. If the file specified already exists, the operation will abort. You can overwrite the file with the -overwrite option.

Configuring Connector Content via Importing

1. Access the default location of the Lotus Quickr Connectors, typically:

C:\Program Files\IBM\Places Connectors.2. To import everything in the specified file, enter a command

similar to the following example: QuickrCfg -import myQuickr.xml

3. To import servers and places from a pre-existing configuration file and merge the information into the existing configuration, as well as to have the tool provide full output, enter:

QuickrCfg -import -noprefs -nopolicies -nodefaults -merge -verbose myQuickr.xml

37

The default imports everything in the specified file. Server and place list entries will be added into the existing configuration. If duplicate servers/places exists, they will not be merged.

Demo

38



39

Resources

40

• RPR Wyatt’s Essential Quickr Tools www.rprwyatt.com/EssentialQuickrTools.html

• Opus Neo Neo.Dashboard for Quickr www.opusneo.com/neodashboard

• SNAPP-On Modules for Lotus Quickr from SNAPPS www.snapps.com/snaweb.nsf/0/8a8d710514c46a9b86256e8c007993c4

• How to install and Configure Quickr from Michael Urspringer http://wiki.urspringer.de/doku.php/qfaq/tutorials_howtos_etc/

installing_quickr85• Moving places and other items in IBM Lotus Quickr services for Domino

www.lotus.com/ldd/lqwiki.nsf/dx/moving-places-and-other-items-in-lotus-quickr-services-for-domino

• Performance Tuning Quickr 8.5 from Quickr Wiki www.lotus.com/ldd/lqwiki.nsf/dx/

Performance_Tuning_Guide_Lotus_Quickr_8.5_for_Domino

41

Resources (cont.)

• Quickr Clustering Wiki Page www.lotus.com/ldd/lqwiki.nsf/dx/

Best_Practices_for_setting_up_Quickr_Clustering• Fergal McKenna, “Connectors, Deployment & Troubleshooting

Document” (IBM). www.lotus.com/ldd/lqwiki.nsf/xsp/.ibmmodres/domino/

OpenAttachment/ldd/lqwiki.nsf/140F5540A196597485257654006BFB43/attach/Connectors-Deployment%2520and%2520Troubleshooting.odp

• Pre-configuring User Desktops with Connector Content www.lotus.com/ldd/lqwiki.nsf/dx/

Preconfiguring_users_desktops_with_connector_content_qc85

42

Resources (cont.)

• Notes.ini Settings www.lotus.com/ldd/lqwiki.nsf/dx/notes.ini_settings_qd851

• Keith Brooks, David Byrd, Mark Harper, Olusola Omosaiye, IBM Lotus Quickr 8.5 for Domino Administration (Packt Publishing, 2011). http://amzn.to/lU5WSs

7 Key Points to Take Home

• Quickr can be the greatest tool, but first learn what to do• Notes.ini controls the Domino-related functions• Qpconfgig.xml controls the core Quickr functions• Connectors can be controlled and automated, with a little effort• You control your environment, use the tools, buy some tools,

have developers write some tools• Quickr for Domino has a good few years ahead of it

Invest in it now to get the greatest benefits over time• RTFM, really, ok, the IBM Wiki sites

Your Turn!

How to contact me:Keith Brooks

Skype/Twitter: @[email protected] 44

quickr for domino administration: qpconfig.xml, notes.ini, connections and you

Technology