Quick Windows Install - OHDomino
This page last changed on 2008-03-25 by olibraga.

Version 5.4.0

For further details please refer to the "Administration Guide - OHDomino" document.

1. Prepare Lotus Domino Server.

This section contains a list of steps to be done on the Lotus Domino server before starting the OpenHand Server for Lotus Domino install.

Domino users connecting to OpenHand Server must have permission to access the server and have an Internet password (same as iNotes users).

For details on Domino tasks see the Lotus Domino Administrator help.

1.1 Enable the Lotus Domino built-in DIIOP task.

Go to the Domino Server Console using one of:

  1. Lotus Domino Administrator (Server.../Status/Server Console)
  2. Console window on Domino Server
  3. jconsole

Type the following commands into the console:

  • SHOW TASKS - If "DIIOP Server" appears in the resulting list the next command is unnecessary.
  • LOAD DIIOP - (Optional) To start the DIIOP task.
  • TELL DIIOP SHOW CONFIG - To list the current DIIOP configuration
  • RESTART TASK DIIOP - (Optional) To re-read configuration after change

Make a note of the values of the "Public Host Name/Address" DIIOP configuration line (IP-address or DNS-name) and the following "TCP Port" line (usually 63148).
These values will be used by the OpenHand Server (through the Lotus NCSO.jar library) to connect to the Domino server. If the first value is not an IP-address or DNS-name of the Domino server as seen from the OpenHand Server, the DIIOP service will need to be reconfigured to use a port at this address.

DIIOP must also be added to the "ServerTasks" line of Domino server notes.ini file so the DIIOP task will be loaded on Domino server restart.

1.2 Create an OpenHand Administrator account on the Domino server.

You should create a new Domino account for the OpenHand administrator (usermaster). You can use any account for this purpose but we recommend you create a new one.

The OpenHand administrator user needs to have read access the Domino Domain Directory (names.nsf) but it needs full read/write access to the OpenHand Users Database created below.

The OpenHand administrator user should have a mail file as the OpenHand Server will on occasion send a problem report by email, by default to its own account.

1.3 Copy Lotus NCSO.jar library from Domino server.

The OpenHand Server for Lotus Domino uses the Lotus NCSO.jar library to communicate with the Domino server. The NCSO.jar library must be copied from the Lotus Domino servers "data\domino\java" directory to the OpenHand Server for Lotus Domino installation directory.

Make a copy of the NCSO.jar library to the OpenHand server machine (or a USB-key).

The OpenHand Server for Lotus Domino installer will copy the NCSO.jar library to the installation jlib subdirectory.

1.4 Change Lotus Domino server security settings (optional).

If you want OpenHand users to see whether emails are read or unread in OpenHand clients, an OpenHand Agents Database must be created on the Domino server. This database must either be signed with the Active Domino servers ID, in which case nothing more needs to be done in this section, or it can be signed with the Active users ID, in which case the Domino servers security settings must be changed in the following way.

  • Log into the Lotus Domino Administrator.
  • Select "Configuration/Server/Current Server Document".
  • Select the "Security" tab.
  • Add the user that will sign the agent database to the following settings in "Programmability Restrictions/Who can -".
    • Run unrestricted methods and operations.
    • Sign agents to run on behalf of the invoker of the agent.
    • Run Simple and Formula agents.

This must be done because OpenHand can not see whether an email is read or unread through the DIIOP service so an agent needs to be installed into the Lotus Domino server. For the agent to be able to run on behalf of the user logged in, the Lotus Domino server security settings must be changed.

1.5 Create OpenHand sub-directory (optional).

It is good practice to create an "OpenHand" sub-directory of the the Lotus Domino server "data" directory to keep the OpenHand templates and databases separate from other files.

2. Prepare OpenHand Server Machine

2.1 Install Java 2 Runtime Environment (optional).

The OpenHand Server for Lotus Domino installer contains a bundled Java 2 Runtime Environment which OpenHand can use.

If you do not want to use the bundled JRE, e.g. if there are other programs on that machine that will be using the JRE, you can install another JRE (Sun, IBM, BEA, ...).

NOTE

The Java runtime must be at least version 1.6

2.2 Configure Firewalls.

  • Port 10622 (by default) must be open into the OpenHand server machine from the Internet.
  • Port 63148 (by default) must be open from the OpenHand server machine into the Lotus Domino machine.

If the OpenHand Server is split up:

  • Port 10623 (by default) must be open from the OpenHand Frontend to the OpenHand Usermaster.
  • Port 10624 (by default) must be open from the OpenHand Frontend to all _OpenHand Backends.

3. Run OpenHand Server for Lotus Domino Installation program.

Run the OpenHandDomino_5-4-x.exe program on the OpenHand server machine.

3.1 Installer First steps.

The first steps are mostly self explanatory.

3.2 Lotus Domino database templates.

If the Lotus Domino server "data" directory is accessible from the OpenHand server machine, select that directory or the optionally created "data\OpenHand" directory.

Otherwise select any temporary directory, e.g. on a USB key, you will have to copy the template files manually to the Lotus Domino server.

Two files will be copied to the specified directory:

  • OHUsers_0803.ntf - Domino Template for the OpenHand User Database
  • OHAgentsXxx_0611.ntf - Domino Template for the OpenHand Agent Database, where Xxx is one of Win, Lnx or OS4 depending on the Domino server platform (Windows, Linux or OS/400).

3.3 Install OpenHand server as NT service.

If you check this option the OpenHand Server for Lotus Domino server will be installed as a Windows (NT) service with automatic startup.

You will have to start the service the first time from the Services control panel or Windows Management console, but it will be started automatically on Windows restart.

3.4 "OHD Administration Guide".

The "OpenHand Server for Lotus Domino Administration Guide" PDF file is installed in the Documentation directory of the OpenHand installation directory.

4. Post installer Lotus Domino preparations.

If the installer was not able to copy the OpenHand Domino templates directly to the Lotus Domino server, move them now from the directory you specified to the Lotus Domino "data" directory (or the "data\OpenHand" sub-directory).

The installer and this description assume you are only connecting to one Lotus Domino server, if you have more than one OpenHand Backend you only have to install the OpenHand User Database on the Lotus Domino server the OpenHand Usermaster uses, but the OpenHand Agent Database to all Lotus Domino mail servers any OpenHand Backend uses.

4.1 Fixup, Sign and change ACL of OpenHand Domino templates.

Log into the Lotus Domino Administrator as the user you gave signing privileges in section 1.3 or Domino administrator.

  • Select the directory where you copied the OpenHand templates to.
  • Select (top right) "Show me: Templates only".
  • Select "OHUsers_0803.ntf".
  • Select (far right) "Tools/Database/Fixup...".
  • Select "OK".
  • Select (far right) "Tools/Database/Sign...".
  • Select "OK".
  • Select "OHAgentsXxx_0611.ntf", Xxx depending on Domino server platform.
  • Select (far right) "Tools/Database/Fixup...".
  • Select "OK".
  • Select (far right) "Tools/Database/Sign...".
  • Select "OK" if you selected to change the Domino servers security settings in section 1.4.
  • Select "Active Server's ID" otherwise and then "OK".
  • Answer Yes to question on "Cross Certificate" for Organization "OpenHand" and Public key id "112B2 UMU7X PFJP5 Y562P NH3AA 38416".

4.2 Create OpenHand Agent Database (optional).

If you do not want to install agents into the Domino server, skip this step.

Remain logged into the Lotus Domino Administrator.

The OpenHand Agents Database is used to query read/unread status of emails.

The OpenHand agent is a short LotusScript that calls some C API functions built into Lotus Domino, you can see the code in the Lotus Domino Designer.

  • Select menu "File/Database/New...".
  • Select server for the new database (not Local!).
  • Enter Title, e.g. "OpenHand Agents"
  • Enter File name, e.g. "OHAgents.nsf" or "OpenHand\OHAgent.nsf"
  • Select same server for template.
  • Select template "OHAgentsXxx_0611.ntf", Xxx depending on Domino server platform
  • Select "OK".
  • Close the new OpenHand Agent Database.

4.3 Create OpenHand User Database.

Remain logged into the Lotus Domino Administrator.

  • Select menu "File/Database/New...".
  • Select server for the new database (not Local!).
  • Enter Title, e.g. "OpenHand Users"
  • Enter File name, e.g. "OHUsers.nsf" or "OpenHand\OHUsers.nsf"
  • Select same server for template.
  • Select template "OHUsers_0803.ntf"
  • Select "OK".
  • Select menu "File/Database/Access Control...".
  • Add the OpenHand Administrator account from section 1.2 to the access control list as Person/Manager with "Delete documents" access.
  • Select "OK".

For help on filling in the OpenHand User Database see the "OpenHand Server for Lotus Domino Administration Guide".

5. Post installer OpenHand checks.

5.1 The OpenHand Primer Tool.

You should use the OpenHand Primer Tool to check the Lotus Domino DIIOP and CORBA setup and the OpenHand configuration.

If these tests do NOT work the OpenHand server will NOT work !!!

To start the tool select "Start/Programs/OpenHand/OpenHand Server for Lotus Domino/Primer Tool".

See the "OpenHand Server for Lotus Domino Administration Guide" for further details.

5.2 The OpenHand Configuration Tool.

You can use the OpenHand Configuration Tool to modify the OpenHand configuration files.

To start the tool select "Start/Programs/OpenHand/OpenHand Server for Lotus Domino/Configuration Tool".

The installer will automatically start the OpenHand Configuration Wizard upon exiting. 

See the "OpenHand Server for Lotus Domino Administration Guide" for further details.

5.3 Download an OpenHandWindows client for testing (optional).

It is a good idea to download and install an OpenHand Windows client and install it on the OpenHand server machine for testing.

If you can not install the client on the OpenHand server machine (it works in WINE too), install it on some machine on the same local area network.

Testing the server setup from a mobile device can be difficult as there are so many things that can go wrong on the device, mobile network, firewalls, etc.

You can download the clients from http://www.openhand.info.

The Windows client is small and mostly self-contained.

5.4 Install the OpenHand Server for Lotus Domino license.

To get a new license start the server, it will generate a file 'InfoSendToOpenHand.txt' send that file to license@openhand-mobile.com. Alternatively send a MAC-address of the machine you will be running the OpenHand Server on (ipconfig or ifconfig).

Copy the "OpenHandServer.license" you got from OpenHand hf./OpenHand Software Ltd. to the root of the OpenHand Server for Lotus Domino installation.

5.5 Test the OpenHand Server for Lotus Domino setup.

It is a good idea to start the OpenHand server in console mode while testing the setup and configuration as you can see all server messages on the console.

Select "Start/Programs/OpenHand/OpenHand Server for Lotus Domino/Start server in console mode".

See the Logging section in the OpenHand Configuration Tool to control the logging level, you can change the log generation, console and file logging levels separately.

Log files are created in the installations LOGS subdirectory, OpenHandServer.0.log is the newest log file, console.log is the newest console log file when the server runs as a service.

6. Further information.

For further details see the "Administration Guide - OHDomino" document or email support@openhand-mobile.com
Document generated by Confluence on 2008-03-25 15:04