Installing on UNIX

  • Review the system requirements. For more information, see Minimum Hardware and Software Requirements.
  • Make sure you have added firewall rules for inbound and outbound connections between Web Services and Connect Direct Server. Firewall rules must allow inbound connections to the specified Web Services port. Connect Direct server must also have its API port open for web service.

To install the Connect:Direct Web Services from command line on a UNIX Operating System follow the steps given below.

Note:
  • If you are installing as a root user, the product will be installed across system and therefore, it is recommended not to install as a root user. You should install it in a shared area with limited access so as not to disrupt any permission changes on the /root directory.
  • Ensure that you login to the same functional account to upgrade Connect:Direct Web Services.

  1. If you have downloaded the software from IBM Passport Advantage go to the download folder.
    Note: Passport Advantage provides access to your IBM software purchases, so you can download products directly to the computers where you want to install them. For information on the how to download software using Passport Advantage see, Passport Advantage.
  2. Untar the installer .tar.gz file and refer Installing, Uninstalling, and Upgrading IBM Connect:Direct Web Service table.
    % tar -zxvf $INSTALLER_FILENAME
  3. Run the remove/MFTWebServicesInstall.sh script. To check privileges, run the following command.
    [user@xxd]# ls -l MFTWebServicesInstall.sh
    -r-xr-x---. 1 <user> <user> <filesize> <date> MFTWebServicesInstall.sh
    
  4. The installation menu appears.

    Preparing to install

    Extracting the JRE from the installer archive...

    Unpacking the JRE...

    Extracting the installation resources from the installer archive...

    Configuring the installer for this system's environment...

    Launching installer...

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

    MFTWebServices (created with InstallAnywhere)

    -------------------------------------------------------------------------------

    Preparing CONSOLE Mode Installation...

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

    Introduction

    ------------

    Welcome to the installation wizard for MFTWebServices.

    This wizard guides you through the installation of MFTWebServices.

    You are strongly recommended to quit all programs before continuing with this

    installation.

    Respond to each prompt to proceed to the next step in the installation.

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

    Licensed Materials - Property of IBM Corp. © IBM Corporation and other(s).

    2022.

    PRESS <ENTER> TO CONTINUE:

  5. Enter the absolute installation path and press ENTER to confirm the location.
    Choose Install Folder

    ----------------------------

    Where would you like to install?

    Default Install Folder: $HOME/MFTWebServices

    ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT

  6. Enter Secure port number details that Connect:Direct Web Server uses to connect to the Web Service and press ENTER to continue.
    Port for Web Server

    --------------------------

    Enter the ConnectDirectWebServices secure sever port.

    eg. https://<hostname:port>/cdws-doc/signOn.html

    https://<hostname:port>/cdws-ui/index.html

    Secure Port (Default: 9443):

  7. Enter the PostgreSQL Database Server port number and press ENTER to continue.
    Attention: CDWS 6.2.0.10 onwards steps related to Postgres are not applicable
    Port for PostgreSQL

    ---------------------

    Enter PostgreSQL Port

    PostgreSQL Port (Default: 5432):

    Password for PostgreSQL

    ---------------------

    This installation requires a password to continue.

    Please Enter the password:

    PRESS <ENTER> TO CONTINUE:

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

    Re-Enter Password for PostgreSQL

    ---------------------

    This installation requires to re-enter the password to continue.

    Please Re-Enter the password:

    PRESS <ENTER> TO CONTINUE:

  8. Pre-Installation summary appears.
    Press ENTER to continue.
    Important: This table is applicable for CDWS v6.2.0.9 and below version releases.

    Pre-Installation Summary

    ------------------------

    Review the following information before you continue the installation:

    Product Name:

    $HOME/MFTWebServices

    Web Server Port

    9443

    PostgreSQL Port

    5432

    Version

    <$VERSION>

    Disk Space Information (for Installation Target):

    Required: 345 MegaBytes

    Available: 5,000.26 MegaBytes

    PRESS <ENTER> TO CONTINUE:

    Important: This table is applicable only from CDWS 6.2.0.10 release onwards.

    Pre-Installation summary appears.

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

    Pre-Installation Summary

    ------------------------

    Review the following information before you continue the installation:

    Product Name:

    MFTWebServices

    Install Folder:

    /root/MFTWebServices

    Web Server Port

    9443

    Version

    6.2.0.10

    Disk Space Information (for Installation Target):

    Required: 1,120.46 MegaBytes

    Available: 31,809.7 MegaBytes

    PRESS <ENTER> TO CONTINUE:

  9. User is prompted to set the Keystore password.

    Keystore Password

    ------------------------

    Enter a password for Connect:Direct Web Service's keystore. (Please retain this password as it will be required in the future.)

    Please Enter the Password:

    Note: Keystore password should not include any of these special characters, o "%^{}|<>~'!`.
  10. Enter the Keystore password again to confirm the user input in the previous step.
    Confirm Password

    ----------------------------

    Please Enter the Password again:

  11. Configure Cerificate information screen appears. Enter the Certificate option serial number for the certificate type that you would like to configure a Self Signed certificate and CA Signed certificate.
    Note: When installation is completed, users can add a CA Signed certificate or any other certificate in existing Keystore/Truststore. Users can also add a new Keystore/Truststore. For more information, see Configuring Keystore/Truststore.

    Configure Certificate

    ---------------------------

    1. Self Signed Certificate: A certificate is automatically generated from input provided by you.

    2. CA Signed Certificate: Import a CA Signed certificate, its private key, and the CA and intermediate certificates.

    Please note that certificate configuration can be updated after installation.

    Please refer IBM CDWS 6.2 documentation for more details.

    Enter Your Choice:

    1. Generate Self Signed Certificate

    2. Import CA Signed Certificate

    (Default: 1):

  12. If enter[1], answer the following prompts related to Self Signed Certificate details.

    Certificate Label

    -----------------

    Enter Certificate Label (Default: mftwebservices):

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

    Certificate Expiry Time

    -----------------------

    Enter Certificate expiry time(MAX value: 3649 days) (Default: 365):

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

    Common Name(CN)

    ---------------

    Enter Common Name(CN) (Default: <hostname>):

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

    Organization Name

    -----------------

    Enter name of the organization (Default: OrganizationName):

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

    Locality Name

    -------------

    Enter name of the locality (Default: Irving):

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

    State Name

    ----------

    Enter name of the State (Default: Texas):

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

    Country Name

    ------------

    Enter Country Name (Default: US):

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

    Enter E-mail Address

    --------------------

    Enter E-mail Address (Default: noreply@noreply.com):

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

    Enter DNS Name

    --------------

    Enter DNS Name (Default: <hostname>):

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

    Enter IP Address

    ----------------

    Enter IP Address (Default: <IPv4 address>):

    Table below describes Self Signed certificate field, descriptions, example, and default values.

    Table 1. Self Signed Certificate generation entries and descriptions
    Entry Description Example value Default Value
    Certificate label Any descriptive name to identify the certificate. mycertificatename mftwebservices
    Certificate Expiry Time Enter the certificate expiration time in days 278 days 365 days

    Max value: 3649 days

    Common Name (CN) Identifies the host name associated with the certificate yourdomain <hostname>
    Organization

    The legal name of your organization. This should not be abbreviated and should include suffixes such as Inc, Corp, or LLC.

    Note: Do not abbreviate or use any of these symbols: ! @ # $ % ^ * ( ) ~ ? > < / \.
    MyOrganizationName Inc. organizationname
    Locality

    The city where your organization is located.

    Irving Irving
    State The state/region where your organization is located.
    Note: Do not use abbreviations.
    Texas Texas
    Country

    The two-letter ISO code for the country where your organization is location.

    US US
    E-mail ID An email address used to contact your organization. support@mydomain.com noreply@noreply.com
    DNS Name Identifies the domain name associated with the certificate. localhost <hostname>
    IP Address Identifies the IP Address associated with the certificate 127.0.0.1 <IPv4 address>
  13. Self Signed certificate details display. Press ENTER to continue.
    The certificate will be generated with following details:

    EYSTORE NAME: ssl-server.jks

    KEYSIZE: 2048

    CERTIFICATE LABEL:"mftwebservices"

    CERTIFICATE EXPIRY TIME: "365"

    CN: <hostname>

    ORGANIZATION: "OrganizationName"

    LOCALITY: "Irving"

    STATE: "Texas"

    COUNTRY: "US"

    EMAIL ID: "noreply@noreply.com"

    ALGORITHM: SHA256withRSA

    FQDN: <hostname>

    IP ADDRESS: <IPv4 Address>

    PRESS <ENTER> TO CONTINUE:

  14. Self Signed certificate is generated successfully. Installation is completed. Press ENTER to exit the installation screen.
    Certificate Generated Successfully.

    Keystore NAME: ssl-server.jks

    CERTIFICATE LABEL: mftwebservices

    PATH: /$HOME/MFTWebServicesDoc/mftws/BOOT-INF/classes/ssl-server.jks

    ALGORITHM: SHA256withRSA

    PRESS <ENTER> TO CONTINUE:

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

    Please Wait

    -----------------------------------------------------------

    ...............................................................................

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

    Installation Completed

    ------------------------------------------------------------

    Installation and Certificate configuration is completed.

    ConnectDirectWebServices-<$VERSION> has been successfully installed to:

    /$HOME/MFTWebServices

    MFTWebServices User Interface is available at :

    https://<hostname:port>/cdws-ui/index.html

    MFTWebServices API reference is available at :

    https://<hostname:port>/cdws-doc/signOn.html

    PRESS <ENTER> TO EXIT THE INSTALLER

  15. If enter [2], user is prompted to set CA Signed certificate details

    CA Signed Certificate File

    --------------------------

    Please input a certificate file in PEM or PKCS12 format with full path.

    Note : The file must contain the private key, the CA Signed certificate, the

    CA certificate and all intermediate certificates.

    Ex. /root/certificates/caCert.pem

    :

    Then ask for the password as below:

    Enter CA Signed Certificate private key password

    ------------------------------------------------

    Importing CA Signed Certificate requires private key password.

    Please Enter the Password:

    After entering the password, certificate details window prompt as below:

    Certificate Details

    -------------------

    The certificate will be added of the following details:

    ________________________________________________________

    KEYSTORE NAME: ssl-server.jks

    KEYSIZE: 2048

    CERTIFICATE LABEL: mftwebservices

    PRESS <ENTER> TO CONTINUE:

    Installation completed message as below:

    Installation Completed

    ------------------------------------------------------------

    Installation and Certificate configuration is completed.

    ConnectDirectWebServices-<$VERSION> has been successfully installed to:

    /$HOME/MFTWebServices

    MFTWebServices User Interface is available at :

    https://<hostname:port>/cdws-ui/index.html

    MFTWebServices API reference is available at :

    https://<hostname:port>/cdws-doc/signOn.html

    PRESS <ENTER> TO EXIT THE INSTALLER

  16. Press ENTER to exit the installation screen.
    Note: This Note is not valid for CDWS 6.2.0.10.

    Postgresql is not installed with CDWS on AIX and zLinux Platforms. You must provide credential/port for already installed postgresql.