Adding HCL Traveler to an IBM® i Domino® server

There are several steps to setting up a HCL Traveler server to run on IBM® i.

Follow the following procedure to set up the HCL Traveler server.
  1. Sign on to the system with a user profile that has *ALLOBJ, *IOSYSCFG, and *SECADM authority.
  2. Stop the HCL Domino server.
  3. On any IBM® i command line, type the command ADDNTSDOM and press F4.
  4. In the Domino® server name field, type the name of the Domino® server where you will add HCL Traveler.
  5. In the External Access URL field, specify the complete URL, including https://, the server name, the port number (if not the default), and the servlet path (/traveler) that the device uses to get to the server. This can be a proxy or redirected address and is used by the server so that links are correctly formatted for the device to get to the server in the same way it does for syncing. This is also in the server document and is overridden by notes.ini if specified. There are two valid values for this field:
    • *BLANK: Default value
    • Character-value: Specify an effective URL that devices can access
  6. In the HCL Traveler deployment mode field, specify HCL Traveler server deployment mode, then complete the following fields:
    Table 1. Setup parameters of HCL Traveler deployment mode
    Field Description
    Traveler deployment mode

    Specifies HCL Traveler server deployment mode. The standard HCL Traveler server configuration deploys as a single instance.

    An internal database is used to store sync state data. Administration data (for example, security compliance) is stored in the HCL Traveler Domino database. All of this data is known only to this instance of the server. This configuration is referred to as a stand alone server. It is possible to deploy multiple stand alone servers, however, each server operates independently and does not share information. This means that if a user syncs a device with one stand alone server and then switches to another, the device is treated like a new device and must re-sync with the server. In a multi-server standalone environment, the users are load balanced administratively, assigning different URLs to different groups of users. It is now possible to set up multiple HCL Traveler servers using a shared enterprise database. This configuration is referred to as a High Availability (HA) pool. In this configuration, all of the sync history and administration information for a device is stored in the enterprise database. This allows any server in the HA pool to be able to service requests from any user/device.

    *STANDALONE: The server is deployed in stand alone mode.

    *HA: The server is deployed in High Availability (HA) mode.

    IBM i DB2 server

    Specifies IBM i DB2 server information.

    The default DB2SVR value is the single value of *NONE, as the default deployment mode (DPYMOD) is *STANDALONE. You must specify this parameter when you specify the deployment mode of *HA, and it only takes effect when the deployment mode is *HA.

    Since DB2 for IBM i is fully integrated on the IBM i system, the DB2 server information is actually IBM i system information.

    *NONE: The server is deployed in stand alone mode. This must be specified when DPYMOD (*STANDALONE) is specified.

    Element 1: Server Address: Specify the IBM i system name or IP.

    Element 2: User profile: Specify the user profile used to sign on to the IBM i system.
    Note: The user profile should have *ALLOBJ and *SECADM authority.

    Element 3: User password: Specify the password for the user profile used to sign on to the IBM i system.

  7. Press F10 for additional parameters, then complete the following fields:
    Table 2. Additional parameters
    Field Description

    Traveler HOST IP address

    Specifies the IP address of the HOST on which HCL Traveler is running. It must be in the form nnn.nnn.nnn.nnn, where nnn is a decimal number between 0 and 255; for example, 199.4.191.76.

    An IPv4 address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address. This property can be used to override the selection if the wrong IP address is chosen. This could happen if the server has multiple active network interfaces and it is desirable for the server to use an interface other than the one that was selected. The following list contains the values for this field:
    • *FIRSTACTIVE: The IP address of the first active network interface. This is default value.
    • character-value: Specify the IP address that the HCL Traveler server will use.

    Traveler server port

    Specifies the interprocess socket connection used between the HCL Travel server and its HTTP server servlet. It is also used for inter-server communication between servers in a high availability (HA) pool. This is the port the HCL Traveler server accesses for incoming requests from the web servlet or commands from other servers. Add this Notes.ini setting to override the default port number. Values for this field are:
    • 50125: The default port.
    • 1-65535: Specify the port on which the Traveler server will be listening.

    Traveler servlet port

    Specifies the interprocess socket connection used between the HCL Travel server and its HTTP server servlet. This is the servlet listening port number. Add this Notes.ini setting to override the default port number. Values for this field are:
    • 50126: The default port.
    • 1-65535: Specify the port on which the HCL Traveler servlet will be listening.

    Traveler push port

    Specifies the TCP port used for Auto Sync communications between version 8.5.1 and earlier HCL Traveler servers and clients. If you are using an 8.5.2 version or later client, this port is not used and can be disabled. If you are using a version earlier than 8.5.2, this port must not be used by other applications on this server. If the HCL Traveler server is behind a firewall, this port must be open on the firewall or the HCL Traveler client must use a VPN to tunnel through the external firewalls. To disable the Auto Sync TCP port, set the port value to 0. If this server is configured for High Availability, the Auto Sync TCP port should be disabled as this is not a supported option in this mode. Values for this field are:
    • 8642: The default port.
    • 0-65535: Specify the port that the HCL Traveler push service will use. Use a value of zero to disable this service.
    HTTP active threads

    Specifies the number of active HTTP threads needed for HCL Traveler.

    The number of active HTTP threads needed for HCL Traveler is calculated by multiplying the number of registered devices by 1.2.

    HCL Traveler ensures a minimum number of active HTTP threads are defined on first start up. For Domino on IBM i installations, HCL Traveler will ensure at least 400 HTTP threads are allocated. This only happens on first startup to ensure out of the box run-time capability. If the calculated number of active HTTP threads is more than 400, consider changing this value.

    CAUTION: Allocating too many active HTTP threads will result in unnecessary server memory consumption, so it is recommended to only allocate the necessary number of HTTP threads needed for proper HCL Traveler operation, as described here. If other HTTP applications are running on the HCL Traveler server (for example, iNotes or Sametime), the number of threads needed for HCL Traveler must be added to the threads used by these applications.

    400: The default number of HTTP threads.

    400-5000: Specifies the number of active HTTP threads needed for HCL Traveler.

  8. Press Enter to run the command.

When HCL Traveler is added to the Domino® server, you will see the message Command ADDNTSDOM ended successfully on the console screen.

Note: You can set up multiple HCL Traveler servers on one IBM® i system, with the following requirements:
  • Multiple existing Domino® server instances exist on the systems.
  • Multiple instances of HCL Traveler must use different network addresses or different ports on the same address. See the preceding table for more information.