Pre-installation Tasks

This chapter describes how to perform pre-installation tasks such as checking hard disk space and create an installation properties file.

1. Overview

Before installing OpenFrame/Base (hereafter Base), check the following:

  • System requirements are met.

  • There is sufficient disk space available.

  • Installation properties file is created.

  • Tablespace is created.

  • Unix ODBC environment is configured.

2. System Requirements

System requirements for installing Base are as follows:

Requirement

Platform

Solaris 11 (SunOS 5.11) or later (32-bit, 64-bit)

Linux x86 2.6 or later (32-bit, 64-bit)

Linux ia64 2.6 or later (32-bit, 64-bit)

Hardware

More than 5 GB hard disk space

More than 8 GB RAM

Database

Tibero 6 (DB 6 FixSet07)

Compiler

MF-COBOL, NET-COBOL or OpenFrame COBOL compiler

OpenFrame PL/I compiler

OpenFrame ASM compiler

Contact TmaxSoft Technical Support about IBM or HP-UX platform support.

3. Checking Available Disk Space

Before installing Base, you must check that there is at least 200 MB of free disk space available. For more information about hardware requirements, refer to System Requirements.

To check for free disk space, execute the df command at the Unix prompt.

The following example shows how to use the df command to check the free and used space of a disk that contains a specified directory. To display the results in units of KB, use the -h option. This example was performed by executing the df command on the Linux x86 operating system.

$ df -h /home/oframe

The following shows the result.

Filesystem                         Size  Used Avail Use% Mounted on
/dev/mapper/centos_oflinux64-home  144G   49G   96G  34% /home

It shows that the /home/oframe directory is located on the /dev/mapper/centos_oflinux64-home disk. 49 GB out of 144 GB is in use, and 96 GB or 66% of the total capacity is available for use.

4. Creating an Installation Properties File

To install Base, set variables for installation properties file then execute the installation script. After configuring the properties for Base installation in the file, run the installer; the installer reads the settings written in the property file to install Base.

This section describes the settings that must be configured in the Base installation properties file. A sample installation properties file can be found in Sample Installation Properties File.

  1. The name of a properties file must be base.properties. The file must be a standard text file. It is recommended to create a properties file by using the sample properties file, which is provided with the installer.

  2. In the installation properties file, set the option for automatically creating data set to either 'YES’ or ‘NO’.

4.1. OpenFrame’s Home Directory

Specify the directory to install Base in using absolute path. The directory set here is used as OpenFrame’s home directory for all configuration files. Other products running on Base must also be installed in the same directory.

The following is the item that sets the OpenFrame home directory.

OPENFRAME_HOME=<path>
Item Description

OPENFRAME_HOME

Unix directory or file path.

The following example sets the OpenFrame home directory to /home/oframe/OpenFrame.

OPENFRAME_HOME=/home/oframe/OpenFrame

4.2. Tmax Environment Variables

The following are the environment variables required to run Tmax on OpenFrame engine.

TP_HOST_NAME=<name>
TP_HOST_IP=<ip>
TP_SHMKEY=<key>
TP_TPORTNO=<port>
TP_UNBLOCK_PORT=<port>
TP_NODE_NAME=<node_name>
TP_NODE_LIST=<node_list>
TCACHE_SHMKEY=<key>
Item Description

TP_HOST_NAME

Host name of the computer where to install OpenFrame. Use alphanumeric and special characters (@, #, $, -).

TP_HOST_IP

IP address of the computer where to install OpenFrame. Use decimal values.

TP_SHMKEY

Shared memory key used in Tmax. Use decimal or hexadecimal values starting with 0x.

TP_TPORTNO

Default port number used in Tmax. Use decimal values.

TP_UNBLOCK_PORT

Unblock port number used in Tmax. Use decimal values.

TP_NODE_NAME

Default node name for OpenFrame or Tmax. Use a character string made up of 0-9, A-Z, a-z, @, #, $,or -.

TP_NODE_LIST

List of all nodes in the OpenFrame system. Each node name is delimited by a semicolon(;).

  • Single node: Uses TP_NODE_NAME.

  • Multi node: All node names in the system are enumerated.

TCACHE_SHMKEY

Shared memory key for Tmax TCache to manage configuration values of OpenFrame. Use decimal or hexadecimal values starting with 0x.

  1. During the initialization process, OpenFrame uses Tmax Call Block function to block all accesses from outside until the server is fully initialized. When completed, the system uses a port called TP_UNBLOCK_PORT to unblock accesses.

  2. In OpenFrame, all environment variable settings are saved to the database. During operation, they are loaded on Tmax TCache. For this purpose, OpenFrame Installer allocates the cache space by using the -c command of pfmtcacheadmin from the TCache administration program, and the shared memory key used in this process is called TCACHE_SHMKEY. For more information about pfmtcacheadmin, refer to Tmax TCache Guide.

The following is an example of Tmax environment variable settings.

TP_HOST_NAME=ofLinux64
TP_HOST_IP=192.168.105.61
TP_SHMKEY=52878
TP_TPORTNO=8989
TP_UNBLOCK_PORT=8199
TP_NODE_NAME=NODE1
TP_NODE_LIST=NODE1
TCACHE_SHMKEY=39101

4.3. Environment Variables for Storage Device

The following is an example of environment variables related to items, such as catalogue, storage, and data set.

MASCAT_NAME=<dataset>
MASCAT_CREATE=YES|NO
DEFAULT_VOLSER=<volume>
VOLADD_DEFINE=YES|NO
ODBC_USERNAME=<name>
ODBC_PASSWORD=<password>
ODBC_DATABASE=<name>
TSAM_DBTYPE=TIBERO
DATASET_SHMKEY=<key>
TSAM_INCLUDE1= <path>
TSAM_INCLUDE2= <path>
TSAM_INCLUDE3= <path>
Item Description

MASCAT_NAME

Data set name for the master catalog.

MASCAT_CREATE

Option to automatically create a master catalog during installation.

  • YES: Master catalog is automatically created.

  • NO: You must manually create a master catalogue after installation by running the create_mascat script under the ${OPENFRAME_HOME}/scripts directory.

DEFAULT_VOLSER

Default volume name for OpenFrame.

VOLADD_DEFINE

Option to automatically create a default volume during installation.

  • YES: Default volume is automatically created.

  • NO: You must manually create a default volume after installation by running the create_voladd script under the ${OPENFRAME_HOME}/scripts.

ODBC_USERNAME

User name to connect to the database using ODBC. Use alphanumeric and special characters (@, #, $, -).

ODBC_PASSWORD

User password to connect to the database using ODBC.

ODBC_DATABASE

Database name to connect to.

TSAM_DBTYPE

TSAM database type.

  • TIBERO: Uses a Tibero database for TSAM. During installation, the libtsam.so library is specified as a symbolic link in libtstbr.so.

DATASET_SHMKEY

Shared memory key for managing data set allocation information. Use decimal values.

TSAM_INCLUDE1, TSAM_INCLUDE2, TSAM_INCLUDE3

Compiled header file path for TSAM pre-compilation.

The following is an example of environment variable settings for storage.

MASCAT_NAME=SYS1.MASTER.ICFCAT
MASCAT_CREATE=YES
DEFAULT_VOLSER=DEFVOL
VOLADD_DEFINE=YES
ODBC_USERNAME=tibero
ODBC_PASSWORD=tmax
ODBC_DATABASE=oframe
TSAM_DBTYPE=TIBERO
DATASET_SHMKEY=50382
TSAM_INCLUDE1=/usr/include
TSAM_INCLUDE2=/usr/local/include
TSAM_INCLUDE3=/usr/lib/gcc/x86_64-redhat-linux/4.8.2/include

4.4. Compiler Configuration

A COBOL compiler can be configured for OpenFrame. The installer creates a symbolic link for the specified compiler library and the link can be changed as needed after the installation.

COBOL_COMPILER=MFCOBOL|OFCOBOL|NETCOBOL|DUMMY
Item Description

COBOL_COMPILER

Default COBOL compiler to use.

  • MFCOBOL: MF-COBOL (libcobsw.so library is specified as a symbolic link in libswmfcob.so during installation).

  • OFCOBOL: OFCOBOL (libcobsw.so library is specified as a symbolic link in libswofcob.so during installation).

  • NETCOBOL: NETCOBOL (libcobsw.so library is specified as a symbolic link in libswntcob.so during installation).

  • DUMMY: Does not use a COBOL compiler (libcobsw.so library is specified as a symbolic link in libswdummy.so during installation).

The following is an example of specifying OFCOBOL as the default compiler.

COBOL_COMPILER=OFCOBOL

4.5. OpenFrame Type Configuration

Specify which type to use in OpenFrame.

BATCH_OS_TYPE = <MVS|MSP> OpenFrame OS Type
CPM_PATH=Default CPM type <EBCASCUS|EBCASCJP|JEFASCK(MSP/XSP)>
Item Description

BATCH_OS_TYPE

Compatible OS type for running JCL in OpenFrame/Batch.

  • Default OS type: MVS

CPM_PATH

Default CPM type for converting double-byte character sets in the dsview and spfedit tools provided by OpenFrame.

  • Default CPM type is set as follows depending on the LANG environment variable if not specified.

    • ko_KR: EBCASCKR.cpm

    • ja_JP: EBCASCJP.cpm

    • Others: EBCASCUS.cpm

In the following example, the CPM type is set to EBCASCKR.cpm.

BATCH_OS_TYPE=MVS
CPM_PATH=EBCASCKR.cpm

4.6. Licensing Environment Variables

To start OpenFrame as intended, you must obtain a license and copy it into the license directory. If the license files are already in the specified directories during the installation, the installer will automatically copy them into each license directory. Note that the directories you specify in the following variables specify where to find the licenses and not the license directories where the licenses will be copied to.

OPENFRAME_LICENSE_PATH=<path>
TMAX_LICENSE_PATH=<path>
Item Description

OPENFRAME_LICENSE_PATH

Specifies an absolute path where the OpenFrame license files are located. The OpenFrame license is composed of multiple files. The license files of the specified directory are copied into the ${OPENFRAME_HOME}/license directory.

TMAX_LICENSE_PATH

Specifies an absolute path where the Tmax license files for OpenFrame are located. The license files in the specified directory are copied into the ${OPENFRAME_HOME}/core/license directory.

The following example shows how to set an absolute path for a license file.

OPENFRAME_LICENSE_PATH=/home/oframe/licenses/OPENFRAME
TMAX_LICENSE_PATH=/home/oframe/licenses/TMAX

Base, Batch, TACF, OSC, OSI, HiDB, and AIM are the modules for which license files are issued.

5. Creating Tablespaces

Create a tablespace that will be used as the default volume in the TSAM database.

The following creates a tablespace named DEFVOL with the size of 300 MB in Tibero for the default volume in OpenFrame.

SQL> CREATE TABLESPACE "DEFVOL" DATAFILE 'DEFVOL.dbf' SIZE 300M AUTOEXTEND ON;

The following creates a tablespace named OFM_REPOSITORY with the size of 300 MB for system data.

SQL> CREATE TABLESPACE "OFM_REPOSITORY" DATAFILE 'OFM_REPOSITORY.dbf' SIZE 300M AUTOEXTEND ON;

6. Configuring unixODBC Environment

Since Base uses the DBMS_LOCK package, you must install unixODBC.

The following are the steps for installing ODBC DriverManager and connecting to the unixODBC driver.

  1. Go to http://www.unixodbc.org, click the [Download] button on the left side of the page to download the DriverManager.

    The following is an example of installing unixODBC Manager.

    $ tar -zxvf unixODBC-2.3.4.tar.gz
    $ cd unixODBC-2.3.4
    $ ./configure --prefix=/home/oframe/unixODBC --sysconfdir=/home/oframe/unixODBC/etc
    $ make
    $ make install
    • unixODBC is installed in /usr/local, by default. Use the configure command with the prefix option to change this path.

    • Environment configuration file is installed in /etc, by default. To change the path, use the configure command with the sysconfdir option.

  2. Add ODBC environment variables to the user .profile file.

    The following is an example of adding environment variables.

    export ODBC_HOME=$HOME/unixODBC
    export PATH=$ODBC_HOME/bin:$PATH
    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ODBC_HOME/lib
    export LD_LIBRARY_PATH_64=$LD_LIBRARY_PATH_64:$ODBC_HOME/lib
    export ODBCINI=$HOME/unixODBC/etc/odbc.ini
    export ODBCSYSINI=$HOME
    Item Description

    ODBCINI

    odbc.ini path other than the default path (/etc).

    ODBCSYSINI

    odbcinst.ini path other than the default path (/etc).

  3. Modify the ODBC configuration files (odbc.ini and odbcinst.ini).

    odbc.ini ($HOME/odbc.ini) contains the ODBC driver connection information, and odbcinst.ini contains the ODBC driver settings. The driver section and in odbc.ini must match the driver section name in odbcinst.ini. The [ODBC_datasource_name] section name in odbc.ini must match its DSN.

    [ODBC_datasource_name]
        Description     = description_of_data_source
        Driver          = driver_name
        DSN             = ODBC_datasource_name
        attribute1      = value
        attribute2      = value
        .
        .
        attribute(n-1)  = value
        attributen      = value
    • odbc.ini

      The following is a sample odbc.ini that configures MS SQL and Tibero ODBC connections.

      [MSSQLSERVER]
      Description = MSSQL Server 2014 DSN
      Driver = ODBC Driver 11 for SQL Server
      DSN = MSSQLSERVER
      Server = 192.168.37.44
      Port = 1433
      UserID = tibero
      Password = tmax
      MARS_Connection = Yes
      
      [TIBEROSERVER]
      Description = Tibero ODBC driver for Tibero5
      Driver = Tibero
      DSN = TIBEROSERVER
      SID = oframe
      User = tibero
      Password = tmax
    • odbcinst.ini

      The following is a sample odbcinst.ini that configures MS SQL and Tibero ODBC drivers.

      [ODBC Driver 11 for SQL Server]
      Description=Microsoft ODBC Driver 11 for SQL Server
      Driver=/opt/microsoft/msodbcsql/lib64/libmsodbcsql-11.0.so.2270.0
      Threading=1
      UsageCount=1
      
      [Tibero]
      Description = Tibero ODBC driver for Tibero6
      Driver      = /home/oframe/tibero6/client/lib/libtbodbc.so
      Setup       =
      FileUsage   =
      CPTimeout   =
      CPReuse     =
      Driver Logging  = 7
      
      [ODBC]
      Trace       = NO
      TraceFile   = /home/oframe/odbc.log
      ForceTrace  = Yes
      Pooling     = No
      DEBUG       = 1

      Set MS SQL driver to the libmsodbcsql.so file below msodbcsql/lib64, and Tibero driver to the libtbodbc.so file below TIBERO_HOME/client/lib. The database section names must match their driver names specified in the odbc.ini file. The ODBC section configures logging. If Trace is set to YES, logs are recorded in the files specified by the TraceFile.

  4. Check the unixODBC version and configuration files.

    Execute odbcinst -j to check the unixODBC version and the odbc.ini and odbcinst.ini file paths shown for DRIVERS and SYSTEM DATA SOURCES respectively.

    $ odbcinst -j
    unixODBC 2.3.2
    DRIVERS............: /home/oframe/odbcinst.ini
    SYSTEM DATA SOURCES: /home/oframe/unixODBC/etc/odbc.ini
    FILE DATA SOURCES..: /home/oframe/ODBCDataSources
    USER DATA SOURCES..: /home/oframe/odbc.ini
    SQLULEN Size.......: 8
    SQLLEN Size........: 8
    SQLSETPOSIROW Size.: 8
  5. Test the unixODBC Driver connection. After configuring odbc.ini and odbcinst.in files, execute isql to connect to the database using ODBC.

    isql [DSN_NAME] [db_username] [db_password]

    The following shows the connection result.

    $ isql oframe tibero tmax
    +---------------------------------------+
    | Connected!                            |
    |                                       |
    | sql-statement                         |
    | help [tablename]                      |
    | quit                                  |
    |                                       |
    +---------------------------------------+
    SQL>

    A SQL prompt is displayed when a database connection is established successfully.