Installation and Uninstallation

This chapter describes how to install and uninstall OpenFrame GW.

1. Installation

This section describes how to install OpenFrame GW on Unix or Linux in console mode.

  1. It is assumed that JEUS 7 Fix#4 is already installed and running. It is recommended to install OpenFrame GW on a separate server rather than on the adminServer. For information about creating a JEUS server, refer to the "2.2. Adding a Server" section in the JEUS Server Guide.

  2. If OpenFrame GW is already installed, it must be uninstalled and then reinstalled. Otherwise, the new installation will not install properly.

To install OpenFrame GW, use the appropriate binary file for the target system. The installation process is the same for all systems. To return to the previous step during installation, type 'back' and then press the <Enter> key. To quit the installation, type 'quit' and then press the <Enter> key.

The OpenFrame GW installation process is described using a text-based shell as follows:

  1. Copy the OpenFrame GW installer binary file, OpenFrame_GW7_1_Generic.bin, to the desired installation location.

  2. If execute permission for the installer binary file does not exist, execute the chmod a+x command in the console to grant the permission as follows:

    $tmaxh9@oframe1:/data3/oframe1>chmod a+x OpenFrame_GW7_1_Generic.bin

  3. Select one of the following installer execution methods and then press the <Enter> key.

    • Method 1

      ./OpenFrame_GW7_1_Generic.bin

    • Method 2

      sh OpenFrame_GW7_1_Generic.bin

  4. Review the installation introduction, and then press the <Enter> key.

    [tmaxh4@kkh/EMC01/kkh]sh OpenFrame_GW7_1_Generic.bin
Preparing to install...
Extracting the installation resources from the installer archive...
Configuring the installer for this system's environment...

Launching installer...

Preparing CONSOLE Mode Installation...

===============================================================================
OpenFrame_GW_7_1                (created with InstallAnywhere by Macrovision)
-------------------------------------------------------------------------------
===============================================================================
Introduction
------------

InstallAnywhere will guide you through the installation of OpenFrame_GW_7_1

It is strongly recommended that you quit all programs before continuing with
this installation.

Respond to each prompt to proceed to the next step in the installation.  If you
want to change something on a previous step, type 'back'.

You may cancel this installation at any time by typing 'quit'.

PRESS <ENTER> TO CONTINUE:

  5. Review the license agreement.

    Type 'Y' to accept the license agreement or 'N' to decline it, and then press the <Enter> key. If the license agreement is not accepted, the installation exits

    ===========================================================
License Agreement
---------------------------
Installation and Use of OpenFrame_GW_7_1 Requires Acceptance of the Following
License Agreement:

TmaxSoft  Release
TmaxSoft Co., Ltd. (hereafter, TmaxSoft) End-User License Agreement

Product :  OpenFrame GW 7_1
This is a legal agreement between you (either an individual or an company) and
TmaxSoft, Incorporated.  By opening the sealed software package and/or by using
the software, you agree to be bound by the terms of this agreement.

TmaxSoft License
1.  Grant of License:  This TmaxSoft License Agreement ("License") permits you
to use one copy of the TmaxSoft product OpenFrame GW, on any single computer,
provided the software is in use on only one computer at any one time.  If this
package is a license pack, you may make and use additional copies of the
software up to the number of licensed copies authorized.  If you have multiple
licenses for the software, then at any time you may have as many copies of the
software in use as you have licenses.
  The software is "in use" on a computer when it is loaded into the temporary
memory (i.e., RAM) or installed into the permanent memory (e.g., hard disk,
CD-ROM, or other storage devices) of that computer, except that a copy
installed on a network server for the sole purpose of distribution to other
computers is not "in use".  If the anticipated number of users of the software
will exceed the number of applicable licenses, then you must have a reasonable

PRESS <ENTER> TO CONTINUE:

mechanism or process in place to ensure that the number of persons using the
software concurrently does not exceed the number of licenses.

2.  Copyright:  The software (including any images, "applets," photographs,
animations, video, audio, music and text incorporated into the software) is
owned by TmaxSoft or its suppliers and international treaty provisions.
Therefore, you must treat the software like any other copyrighted materials
(e.g., a book or musical recording) except that you may either (a) make one
copy of the software solely for backup or archival purposes, or (b) transfer
the software to a single hard disk provided you keep the original solely for
backup or archival purposes.  You may not copy the printed materials
accompanying the software, nor print copies of any user documentation provided
in "online" or electronic form.

3.  Other restrictions: This license is your proof of license to exercise the
rights granted herein and must be retained by you. You may not rent, lease, or
transfer your rights under this license on a permanent basis provided you
transfer this license, the software, and all accompanying printed materials,
retain no copies, and the recipient agrees to the terms of this license. You
may not reverse engine, decompile, or disassemble the software, except to the
extent that the foregoing restriction is expressly prohibited by applicable
law.

PRESS <ENTER> TO CONTINUE:

DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N):

  6. Specify the JEUS HOME directory.

    Enter the JEUS root directory with an absolute path, and then press the <Enter> key. The default directory is $HOME/jeus7.

    ===============================================================================
Choose JEUS Folder
------------------

Please Enter JEUS HOME

  Default Install Folder: /data3/oframe1/jeus7

ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT
      : /data3/oframe1/jeus

INSTALL FOLDER IS: /data3/oframe1/jeus
   IS THIS CORRECT? (Y/N): y

    If the specified JEUS HOME directory does not exist, the installer prompts you to change the JEUS HOME directory or quit the installation.

    Type '1' to change or '2' to quit, and then press the <Enter> key.

    ===============================================================================
JEUS Application Server Folder Not Found
----------------------------------------

Installer couldn’t find JEUS Application Server folder

Chosen folder is not a JEUS_HOME. To choose a different folder, click 'Change'.
To cancel the installation, click 'Quit'.

  ->1- Change
    2- Quit

ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS <ENTER> TO ACCEPT THE
   DEFAULT:

    If a version of JEUS earlier than 7 is selected, the installer prompts you to change the JEUS HOME directory or to quit the installation. Type '1' to change or '2' to quit, and then press the <Enter> key.

    ===============================================================================
Invalid Version of JEUS Application Server
----------------------------------------

OpenFrame GW 7_1 does not support the currently specified version.
OpenFrame GW 7_1 supports JEUS 7.

Specify a correct version. To choose a different folder, click 'Change'. To
cancel the installation, click 'Quit'.

  ->1- Change
    2- Quit

ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS <ENTER> TO ACCEPT THE
   DEFAULT:

  7. Enter the domain name and server name of JEUS.

    ===============================================================================
Get Jeus Infomation
-------------------

Plase Enter the Domain Name and the Server name
(Installation Server Folder)

JEUS Domain Name (DEFAULT: jeus_domain):

JEUS Server Name (DEFAULT: server1):

JEUS Administrator Password (DEFAULT: ):

JEUS DAS IP (DEFAULT: 192.168.37.12):

JEUS DAS Base Port (DEFAULT: 9736):

    The following describes each item:

    Item Description

    Domain Name

    JEUS domain name.

    Enter a <domain_name> that exists under $JEUS_HOME/domains/.

    Default value: Domain name specified when installing JEUS

    Server Name

    JEUS server name.

    Enter a <server_name> that exists under $JEUS_HOME/domains/<domain_name>/servers/.

    Default value: server1

    Administrator Password

    JEUS administrator password.

    DAS IP

    IP of DAS (Domain Administration Server) in JEUS.

    Default value: Local IP

    DAS Base Port

    Base port number of DAS in JEUS.

    Default value: 9736

    The domain and server must be created with the specified name. Otherwise, a new folder is created in the specified name which can cause unexpected problems.

  8. Check whether AIM exists among OpenFrame online products to be linked with OpenFrame GW.

    If it is an MVS type OpenFrame environment (interworking with OSC and OSI), select NO, and select YES only when linking with AIM.

    If you select YES, sosi=false is set in webterminal.properties.

    ===============================================================================
Get Engine information
----------------------

Check whether to use AIM in the OpenFrame environment connected to this GW.
(default : NO)

  ->1- NO
    2- YES

ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:
   :

===============================================================================

  9. Select the database vendor of the JDBC driver to use for OpenFrame GW.

    If '4- other' is selected, the database information must be manually configured by the user after the installation.

    ===============================================================================
Get DataBase Information
------------------------

Choose vendor Name of JDBC driver

  ->1- tibero
    2- oracle
    3- mssql
    4- other

ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:
   :

    Copy the JDBC driver to the appropriate location according to the database version by each installation environment. In OFGW installer, tibero6-jdbc.jar and ojdbc7.jar are installed in the corresponding path by default. (Location: $JEUS_HOME/lib/datasource)

  10. Enter the database information.

    ===============================================================================
Get DataBase Information
------------------------

Please Enter Database Information

DataBase Server Name (DEFAULT: 192.168.37.12):

DataBase Port (DEFAULT: ):

DataBase SID (DEFAULT: ):

DataBase User ID (DEFAULT: ):

DataBase User PW (DEFAULT: ):

    The following describes each item:

    Item Description

    DataBase Server Name

    Database server name. (Default value: Local IP)

    DataBase Port

    Port number.

    DataBase SID

    Database name.

    If there is a setting value of the $TB_SID environment variable in the account to be installed, the value is set as the default value. If the environment variable does not exist, the default value is not set.

    DataBase User ID

    Database user ID.

    DataBase User PW

    Database user password.

  11. Enter the gateway information.

    ===============================================================================
Get Gateway Infomation
----------------------

Enter requested information

Gateway Name (DEFAULT: ofgw):

Gateway PORT (DEFAULT: 5556):

Datasource ID (DEFAULT: ofgw):

Application Name (DEFAULT: webterminal):

    The following describes each item:

    Item Description

    Gateway Name

    Gateway name for the database.

    Default value: ofgw

    Gateway Port

    Port number for the 3270 terminal. Enter a port that is currently not in use.

    Default value: 5556

    Datasource ID

    Data source name specified in the JEUS configuration file.

    Default value: ofgw

    JEUS configuration file, domain.xml, is located in $JEUS_HOME/domains/<domain_name>/config/.

    Application Name

    Application ID for the WebTerminal. It is used to deploy the application.

    Default value: webterminal

  12. Select the language to use for OpenFrame GW.

    ===============================================================================
Choose Language Set
-------------------

Please Enter WebTerminal Default Language
(Default : US)

  ->1- US
    2- JP
    3- KR
    4- FI
    5- FR
    6- TW

ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:
   :
===============================================================================

  13. Enter the Tmax node and connection information for OpenFrame GW to access.

    ===============================================================================
Get Tmax Information
-------------------

Enter requested information
($OPENFRAME_HOME/core/config/oframe.m)

Tmax NODE Name (DEFAULT: NODE1):

Tmax IP (DEFAULT: 192.168.37.12):

Tmax PORT (DEFAULT:6511):

    The following describes each item:

    Item Description

    Tmax NODE Name

    Tmax node name.

    Default value: NODE1

    Tmax IP

    Tmax IP.

    Default value: Local IP

    Tmax PORT

    Tmax port number. If there is a setting value of the $TMAX_HOST_PORT environment variable in the account to be installed, the value is set as the default value. If the environment variable does not exist, the default value is not set.

    Default value: $TMAX_HOST_PORT

  14. Enter the absolute path to copy the OpenFrame GW license file to.

    ===============================================================================
Get OpenFrame GW license Path
---------------------

Enter requested information
ex) /home/user/license/OFGWLicense

OpenFrame GW License Path (DEFAULT: ):

    The following describes each item:

    Item Description

    OpenFrame GW License Path

    License path (absolute) including the license name.

  15. Select whether or not to restart the JEUS server to complete the installation of OpenFrame GW. (Default value: 1- Yes)

    ===============================================================================
Restart Server
--------------

Do you want to restart the server(server1)?
(To apply the changes, restart the server.)

  ->1- Yes
    2- No

ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS <ENTER> TO ACCEPT THE
   DEFAULT:

    The following describes each item:

    Item Description

    1- Yes

    Restart the web application server (JEUS) to apply WebTerminal application deployment and configuration.

    2- No

    After the installation, user must execute the script and then restart the web application server (JEUS) to apply the changes. For more information, refer to Environment Configuration.

  16. A pre-installation summary is displayed.

    Review the installation summary, and then press the <ENTER> key. To modify the configuration, type 'quit' and then restart the installation, or type 'back' to return to the previous step.

    ===============================================================================
Pre-Installation Summary
------------------------


Please Review the Following Before Continuing:

Product Name:
    OpenFrame_GW_7_1

JEUS_HOME
    /home/oframe1/jeus7

Jeus Domain Name
    jeus_domain

Jeus Server Name
    server1

Gateway Name
    ofgw

Gateway PORT
    5556

Application Name
    webterminal

Datasource Name
    ofgw

Datasource Class Name
    com.tmax.tibero.jdbc.ext.TbConnectionPoolDataSource

Tmax NODE Name
    NODE1

Tmax NODE IP
    192.168.37.12

Tmax NODE PORT
    5511


PRESS <ENTER> TO CONTINUE:

  17. Installation progress is displayed.

    ===============================================================================
Installing...
-------------
 [==================|==================|==================|==================]
 [------------

  18. After the installation is complete, the following message is displayed:

    ===============================================================================
Installation Complete
---------------------

Congratulations! OpenFrame GW 7_1 has been successfully installed to:

/data3/oframe1/jeus7/domains/jeus_domain/servers/server1/lib/application

Press Done to quit the installer.

PRESS <ENTER> TO EXIT THE INSTALLER:

2. Environment Configuration

If the user has selected not to restart JEUS server during the installation, the user must manually execute the script and then restart the server.

Skip this section if the user has selected to restart the server during the installation.

2.1. Script Execution

Use jeusadmin to manually configure OpenFrame GW. The required scripts are in the following location:

$JEUS_HOME/domains/<domain_name>/servers/<server_name>/lib/application/scripts/*.sh

The following are the required scripts:

File Name Description

datasource.sh

Configures <database> and <data-source> items.

lifecycle.sh

Configures <lifecycle-invocation> for OpenFrame GW startup.

(supported in JEUS 7 Fix#4 or later)

deploy.sh

Deploys the WebTerminal application.

undeploy.sh

Undeploys the WebTerminal application.

If OpenFrame GW does not run properly, reinstall OpenFrame GW or check its configuration.

2.2. JEUS Environment Configuration

The following are the steps for manually configuring JEUS environment.

  1. Find domain.xml in the following path where JEUS is installed. (Sample file, domain_ofgw_sample.xml, is provided in the same path).

    $JEUS_HOME/domains/<domain_name>/config/

  2. In domain.xml, add the <lifecycle-invocation>, <data-sources>, and <data-source> tags for OpenFrame GW.

    If the following example, <lifecycle-invocation> and <data-sources> are configured for server1, where OpenFrame GW is installed, using the <server>…​</server> tags, and <data-source> is configured using the <domain>…​</domain> tags.

    <?xml version="1.0" encoding="UTF-8"?>
<domain xmlns="http://www.tmaxsoft.com/xml/ns/jeus" version="7.0">
...
   <servers>
      <server>
         <name>server1</name>
         <node-name>ofLinux64s</node-name>
         <listeners>
            <base>BASE</base>
            <listener>
               <name>BASE</name>
               <listen-port>9936</listen-port>
               <use-nio>true</use-nio>
               <selectors>1</selectors>
               <use-dual-selector>false</use-dual-selector>
               <backlog>128</backlog>
               <select-timeout>120000</select-timeout>
               <read-timeout>30000</read-timeout>
               <reserved-thread-num>0</reserved-thread-num>
            </listener>
            <listener>
               <name>http-server1</name>
               <listen-port>8088</listen-port>
               <use-nio>true</use-nio>
               <selectors>1</selectors>
               <use-dual-selector>false</use-dual-selector>
               <backlog>128</backlog>
               <select-timeout>120000</select-timeout>
               <read-timeout>30000</read-timeout>
               <reserved-thread-num>0</reserved-thread-num>
            </listener>
...
         <lifecycle-invocation>
            <class-name>com.tmax.ofgw.Main</class-name>
            <invocation id="0">
               <invocation-method>
                  <method-name>init</method-name>
               </invocation-method>
               <invocation-type>READY</invocation-type>
            </invocation>
         </lifecycle-invocation>
         <lifecycle-invocation>
            <class-name>com.tmax.ofgw.Main</class-name>
            <invocation id="0">
               <invocation-method>
                  <method-name>shutdown</method-name>
               </invocation-method>
               <invocation-type>BEFORE_UNDEPLOY</invocation-type>
            </invocation>
         </lifecycle-invocation>

         <data-sources>
            <data-source>ds1</data-source>
         </data-sources>

      </server>
   </servers>
...
   <resources>
      <data-source>
         <database>
            <!-- datasource ID -->
            <data-source-id>ds1</data-source-id>
            <export-name>ds1</export-name>
            <!--- OpenFrame GW datasource.name   -->
            <data-source-class-name>
              com.tmax.tibero.jdbc.ext.TbConnectionPoolDataSource
            </data-source-class-name>
            <data-source-type>ConnectionPoolDataSource</data-source-type>
            <vendor>tibero</vendor>
            <!--- tibero IP -->
            <server-name>192.168.37.11</server-name>
            <!--- tibero listener port -->
            <port-number>8200</port-number>
            <!--- tibero DB_Name -->
            <database-name>oframe4</database-name>
            <!--- tibero user -->
            <user>tibero</user>
            <!--- tibero password -->
            <password>tmax</password>
            <login-timeout>0</login-timeout>
            <auto-commit>DRIVER</auto-commit>
            <stmt-query-timeout>0</stmt-query-timeout>
            <pool-destroy-timeout>10000</pool-destroy-timeout>
            <support-xa-emulation>false</support-xa-emulation>
            <connection-pool>
               <pooling>
                  <min>2</min>
                  <max>30</max>
                  <step>1</step>
                  <period>3600000</period>
               </pooling>
               <wait-free-connection>
                  <enable-wait>false</enable-wait>
                  <wait-time>10000</wait-time>
               </wait-free-connection>
               <max-use-count>0</max-use-count>
               <dba-timeout>-1</dba-timeout>
               <stmt-caching-size>-1</stmt-caching-size>
               <stmt-fetch-size>-1</stmt-fetch-size>
               <connection-trace>
                  <enabled>false</enabled>
                  <get-connection-trace>true</get-connection-trace>
                  <auto-commit-trace>false</auto-commit-trace>
               </connection-trace>
               <use-sql-trace>false</use-sql-trace>
               <keep-connection-handle-open>false</keep-connection-handle-open>
            </connection-pool>
         </database>
      </data-source>
   </resources>
</domain>

    For more information about the configuration, refer to JEUS XML Reference or "Appendix A. JEUS Configuration File" in OpenFrame GW Administrator’s Guide.

  3. Restart JEUS to apply the configurations of the domain.xml file to the server.

3. Installation Verification

After installing OpenFrame GW, start JEUS to verify the installation.

3.1. Start JEUS

During JEUS startup, check that the DomainAdminServerBootstrapper and ServerBootstrapper are started successfully. OpenFrame GW is configured to start up with JEUS by using the <lifecyle-invocation> tag.

OpenFrame GW license is also verified at server startup.

Use the Java jps tool to check that the processes have been started successfully.

$jps
1642 Jps
4096 DomainAdminServerBootstrapper
33392 ServerBootstrapper

Check the startup and shutdown events of each server in the JEUS logs.

  • DomainAdminServerBootstrapper log

    $JEUS_HOME/domains/<domain_name>/servers/adminServer/logs/JeusServer.log

  • ServerBootstrapper log

    $JEUS_HOME/domains/<domain_name>/servers/<server_name>/logs/JeusServer.log

  • If using a custom log path, the path is specified in logback.xml. The following example uses the default path.

    $JEUS_HOME/domains/<domain_name>/servers/<server_name>/lib/application/logs/

For information about starting up and shutting down JEUS, refer to "2.3.1.Starting Up and Shutting Down OpenFrame GW" in OpenFrame GW Administrator’s Guide.

3.2. Environment Variables

The environment variables of OpenFrame GW added by the installer are as follows:

# New environment setting added by OpenFrame_GW_7_1 on Tue Apr 06 00:35:50 KST 2021 1.
# The unmodified version of this file is saved in /home/oframejeus1/.bash_profile1174334331.
# Do NOT modify these lines; they are used to uninstall.
OFGW_HOME=/home/oframejeus1/jeus7/domains/jeus_domain/servers/server4/lib/application
export OFGW_HOME
# End comments by InstallAnywhere on Tue Apr 06 00:35:50 KST 2021 1.

# New environment setting added by OpenFrame_GW_7_1 on Tue Apr 06 00:35:50 KST 2021 2.
# The unmodified version of this file is saved in /home/oframejeus1/.bash_profile1174334331.
# Do NOT modify these lines; they are used to uninstall.
CPM_FILE_DIR=/home/oframejeus1/jeus7/domains/jeus_domain/servers/server4/lib/application/ofgwconf/cpm
export CPM_FILE_DIR
# End comments by InstallAnywhere on Tue Apr 06 00:35:50 KST 2021 2.

# New environment setting added by OpenFrame_GW_7_1 on Tue Apr 06 00:35:50 KST 2021 3.
# The unmodified version of this file is saved in /home/oframejeus1/.bash_profile1174334331.
# Do NOT modify these lines; they are used to uninstall.
TB_EBC_TO_ASC=EBCASCUS.cpm
export TB_EBC_TO_ASC
# End comments by InstallAnywhere on Tue Apr 06 00:35:50 KST 2021 3.

# New environment setting added by OpenFrame_GW_7_1 on Tue Apr 06 00:35:50 KST 2021 4.
# The unmodified version of this file is saved in /home/oframejeus1/.bash_profile1174334331.
# Do NOT modify these lines; they are used to uninstall.
TB_ASC_TO_EBC=ASCEBCUS.cpm
export TB_ASC_TO_EBC
# End comments by InstallAnywhere on Tue Apr 06 00:35:50 KST 2021 4.

CPM_FILE_DIR, TB_EBC_TO_ASC, and TB_ASC_TO_EBC environment variables are required to convert the ChracterSet required when the NLS_NCHAR_CHARACTERSET of Tibero is EBCDIC_ in communicating between the GW and Tibero.

4. Uninstallation

This section describes the process of uninstalling OpenFrame GW and how to verify the uninstallation.

The following describes how to uninstall OpenFrame GW.

  1. Execute the OFGW_Uninstall file under the following path, or remove the installation folder through the console.

    $JEUS_HOME/domains/<domain_name>/servers/<server_name>/lib/application/UninstallerData

    Before uninstalling the installed OpenFrame GW, the adminServer of JEUS must be in the running state.

  2. The following shows the progress of uninstalling OpenFrame GW by using the uninstallation file.

    tmaxh9@oframe1:/data3/oframe1/jeus7/domains/jeus_domain/servers/server1/lib/application/UninstallerData> sh OFGW_Uninstall
Preparing CONSOLE Mode Installation...

===============================================================================
OpenFrame GW 7_1                    (created with InstallAnywhere by Macrovision)
-------------------------------------------------------------------------------


===============================================================================
Uninstall OpenFrame GW 7_1
------------------------

About to uninstall...

OpenFrame GW 7_1

This will remove features installed by InstallAnywhere.  It will not remove
files and folders created after the installation.

PRESS <ENTER> TO CONTINUE:

===============================================================================
Uninstalling...
---------------

...*
*
*************************
*************************
*************************
************************
...*
*
*************************
*************************
*************************
*************************

===============================================================================
Uninstall Complete
------------------

5. Uninstallation Verification

Check the following items to verify that OpenFrame GW has been uninstalled successfully.

  • Files and directories

    Check that the installation directories have been completely removed. Directories that were created after the installation must be manually deleted.