Machine Notes for Windows


                      =================================
                            MACHINE SPECIFIC NOTES
                                    FOR
                HCL OneDB Server 2.0.1.3 PRODUCT RELEASE
                               ON Windows x64
                               DATE: 01 May 2023
                      =================================

OS Information : Built on Windows 2016 x64..
                 Certified on Windows 2019.

System Requirements
===================

1.  This product is built on Windows 2016 using the following compiler from
    Microsoft Visual Studio 2017:

        Microsoft Visual C++ 2017

2.  OneDB Server uninstallation

    Due to an issue in installer tool, the registry entries created by
    installer will not be automatically removed after
    OneDB Server uninstall. The work around is to
    cleanup existing registry entries under HKLM->Software->OneDB->DBMS.

3.  Installation Prerequisite on Windows 2016 or Later Versions

    User may need to temporarily turn off User Account Control(UAC) security
    before you install OneDB Server.

    For information about how to create groups, add users to groups, and
    turn off User Account Control, see your Windows documentation.

4.  OneDB Server uses the libraries and utilities provided by
    OpenSSL, for data encryption and Secure Sockets Layer (SSL) communication.
    The OpenSSL library is not included with this product and must be
    installed separately.

    More information about OpenSSL can be found at https://www.openssl.org.


System Configuration
====================

1.  Location of Shared Memory

    The ONCONFIG variable SHMBASE is recommended to be set to the following:

        SHMBASE 0x80000000L

2.  Administrator permission for running server utilities

    On Windows, you must run any server utility commands with administrator
    permission: for example, the 'oninit -iy' command to initialize the server.

    To run OneDB utility commands as an administrator,
    from the Start menu, choose the OneDB server name and
    then choose "Run as administrator". A command prompt with administrator
    permissions opens.


Feature Notes
=============

1.  OneDB Server Interface for TSM

    The OneDB Server Interface DLL for TSM is installed as

        %ONEDB_HOME%\bin\libtxbsa.dll

    This interface is built with TSM API version 5.3.2.

    To use Tivoli Storage Manager with OneDB databases,
    refer to the HCL OneDB Backup and Restore Guide.

2.  IPv6 Support

    The OneDB Server supports Internet Protocol Version 6
    (128 Bit Internet Addresses) as well as IPv4 (32 Bit Addresses).

    In order for the machine name that is specified in the SQLHOSTS registry
    to resolve to the correct IP address, the name services files on the
    Operating System should be correctly configured.

    For compatibility with earlier version of OneDB client
    and server products, assign each host name with both an IPv4 address
    and an IPv6 address. If the listener needs to be bound to an IPv4
    address, and the name services resolve the name in the order of the
    IPv6 address followed by the IPv4 address, then an explicit IPv4
    address needs to be put in the nodename field of server registry.

3.  J/Foundation (Java in the Server)

    The IBM Runtime Environment, Java(TM) Technology Edition, Version 8.0
    release is installed in $ONEDB_HOME/extend/krakatoa/jre and should be
    used with the J/Foundation component.

    A Java user-defined routine (UDR) runs in a Java virtual processor. Use
    the VPCLASS configuration parameter to specify the number of virtual
    processors for the server. You configure Java virtual processors in
    the "Java configuration parameters" section of the onconfig configuration
    file. The default onconfig.std file is in the $ONEDB_HOME/etc directory.

    To develop Java UDRs for the server on this platform, use Java Platform,
    Standard Edition Development Kit (JDK) 8 or an earlier version according
    to Java compatibility guidelines. That kit can be downloaded from
    https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html.

4.  Large Memory Addressability (LMA)

    HCL OneDB LMA provides the ability to support system configurations
    with greater than 4GB of RAM.

    The values for the following ONCONFIG parameters are increased from
    32-bit limit by LMA support:

        - The maximum number of buffers in BUFFERPOOL is 2147483647.

        - The maximum of LRU queues for lrus field in BUFFERPOOL is 512.

        - The DS_TOTAL_MEMORY, which is the total memory available for
          decision support memory, is only limited by the amount of virtual
          memory available. The sort memory comes out of the DS_TOTAL_MEMORY
          memory and hence there is no explicit limit on the amount of sort
          memory.

        - The read ahead parameter RA_PAGES is only limited by the number of
          buffers and therefore can be any value less than 2147483647. The
          "chunk" write algorithm is not dependent on the amount of buffers
          or shared memory and can write as many pages in a single I/O as
          possible.

        - The maximum size of any shared memory segment is 4398046511104 bytes.

        - The maximum value for SHMADD is 4294967296 kilobytes.

    Refer to HCL OneDB Administrator's Reference manual for the information
    about the related configuration parameters setting.

5.  LDAP Authentication

    This feature is set up and configured like the Pluggable Authentication
    Module (PAM) that is used on UNIX and Linux. Use the LDAP Authentication
    Support module when you want to use an LDAP server to authenticate your
    system users.

    The authentication module is a dynamic link library that resides in the
    %ONEDB_HOME%\dbssodir\lib\security directory. The parameters of the module
    are listed in the %ONEDB_HOME%\dbssodir\pam.conf file.

    The source code for a fully functional LDAP Authentication Module and
    samples of the required configuration files are included in the
    %ONEDB_HOME%\demo\authentication directory. You can modify the code for
    your specific LDAP Authentication Support module.

6.  Network Protocols

    The following protocol(s)/interface(s) are supported on this platform:

      SOCKETS using TCP/IP
      IPC using named pipe

      To use SOCKETS with TCP/IP:

          a. The NETTYPE entry in the ONCONFIG file and the value data of
             PROTOCOL in the SQLHOSTS registry entry must contain "onsoctcp"

          b. To enable an IBM Data Server Client to connect to the database
             server, the NETTYPE entry in the ONCONFIG file and the value
             data of PROTOCOL in the SQLHOSTS registry entry must contain
             "drsoctcp"

             If a CLI or JCC client wants to connect to the database server
             through DRDA while supporting SQLI connections, you must add a
             DBSERVERALIASES entry to the configuration file that corresponds
             to the SQLHOSTS registry entry.

      To use IPC (interprocess communication) with named pipe:

          a. The NETTYPE entry in the ONCONFIG file and the value data of
             PROTOCOL in the SQLHOSTS registry entry must contain "onipcnmp".

    Remote 32-bit or 64-bit applications and tools (example: ESQL/C, 4GL, ISQL)
    can only connect to the OneDB Server using the TCP/IP
    protocol.

    Local 32-bit applications and tools can connect to the 64-bit server using
    either the TCP/IP or the IPC named pipe protocols.

7.  OnLine Backup and Restore (ON-Bar)

    ON-Bar uses the XBSA interface. Some of the functions invoked by ON-Bar
    are in a dynamic link library supplied by third party storage management
    vendors. For ON-Bar to access these functions, you must specify the library
    name and location in the BAR_BSALIB_PATH parameter in the ONCONFIG file.

    For example, if you are using PSM:

         Set BAR_BSALIB_PATH to %ONEDB_HOME%\bin\libbsapsm.dll

    For example, if you are using TSM:

         Set BAR_BSALIB_PATH to %ONEDB_HOME%\bin\libtxbsa.dll

8.  XML User-Defined Routines

    You cannot run XML UDRs at large memory segments (VX class) on this
    platform.

    To avoid XML UDR execution failure, configue and adjust the following
    OneDB Server configuration parameters in the configuration
    file:

        PRELOAD_DLL_FILE -
             Specify the path name for a shared library file that is
             pre-loaded when the server is started.

        BUFFERPOOL -
             Adjust the memory field to a lower value.

        SHMVIRTSIZE -
             Adjust it to a lower value.


Features not supported
======================

1.  Web Feature Service Database Extension

2.  Mapped users


(C) Copyright IBM Corp. 2002, 2017
(C) Copyright HCL Technologies Ltd. 2017, 2023. All Rights Reserved.