Posted Jun 08 by Edmund Clayton.
Updated Oct 31.

Learn how to upgrade the OpenText AppWorks Gateway to version 16.2.1

Last activity Oct 31 by Edmund Clayton.
701 views. 0 comments.

Chapter 2 – Upgrading the OpenText AppWorks Gateway

You can upgrade the AppWorks Gateway to 16.2.1 from all previous 16.x versions

If your AppWorks Gateway installation is prior to 16.0, for example, 1.2.1, there is no migration procedure to preserve your current environment. You need to remove AppWorks Gateway 1.2.x, then install AppWorks Gateway 16.2.1. For further details, see 2.2 – Removing AppWorks Gateway 1.2.x.

After upgrading to 16.2.1 from AppWorks Gateway 1.2.x, you may want to ensure that users continue to access any configured services with the URL they used prior to the upgrade. For further details, see 2.3 – Adding a URL Rewrite to AppWorks Gateway 16.2.1.

2.1 – Upgrading AppWorks Gateway 16.x

Use this procedure to upgrade from an AppWorks Gateway 16.x version to AppWorks Gateway 16.2.1.

To upgrade AppWorks Gateway:

  1. Stop the Apache Tomcat service that hosts the AppWorks Gateway installation.

  2. Back up the database that is associated with the AppWorks Gateway installation.

  3. Back up the Apache Tomcat directory where AppWorks is installed.

  4. Navigate to the <Tomcat_Home>/conf directory, and rename the server.xml file to, for example, server.bak.

    This step is only required if you have made custom changes to the server.xmlfile. The upgrade overwrites the server.xml file in the <Tomcat_Home> /confdirectory.

  5. Navigate to the <Tomcat_Home> directory and do the following:

    a. Delete the gateway folder.

    b. Delete the contents of the following folders:

    • work\Catalina\localhost

    • temp

    • tmp

    • logs

  6. Extract the contents of the otag-gateway-16.2.1.zip file into the root of the Apache Tomcat folder. For example, <C:\\Program Files\Apache Software Foundation\Tomcat 8.0>.

  7. If you have made custom changes to the server.xml file, use the server.bak back up file to retain those changes in your upgraded installation.

  8. Start the Apache Tomcat service.

  9. In a browser, type <https://Tomcat_Host:port>/gateway to view the AppWorks Gateway. After signing in, all of your applications and settings should be present.

2.2 – Removing AppWorks Gateway 1.2.x

Use this procedure as part of the process to upgrade to AppWorks Gateway 16.2.1 from a release prior to 16.0.0, for example, 1.2.1.

Note: If you are upgrading from AppWorks Gateway 1.2.x, there is no migration procedure to preserve your current environment. Follow the steps below to remove AppWorks Gateway 1.2.x, then install AppWorks Gateway 16.2.1.

To remove AppWorks Gateway 1.2.x:

  1. Sign into the Directory Services Web Client at https://Tomcat_Host:port/otds-admin/. In the left pane, click Resources and rename the OTAG resource. When you have completed the installation you can delete the renamed resource.

  2. Sign into your database management tool and create a new database scheme for AppWorks Gateway 16.2.1 to use.

    Note: If you created a database scheme for AppWorks Gateway 1.2.x, do not delete the scheme until your 16.2.1 installation is complete and you have confirmed that it works as expected.

  3. Stop the Apache Tomcat service.

  4. The safest way to uninstall the AppWorks Gateway 1.2.x is to reinstall Apache Tomcat. If you reinstall Apache Tomcat, make sure you reconfigure Tomcat for the AppWorks Gateway 16.2.1. For details, see Chapter 1 - Installing the OpenText AppWorks Gateway. However, if you have other software installed in Tomcat and you would prefer not to uninstall it, do the following:

    a. Make sure you have a backup of the following files:

    • gateway.war that is located in the <Tomcat_Home>/webapps folder.

    • opentext.properties that is located in the <Tomcat_Home>/conf folder.

    b. Navigate to the <Tomcat_Home>/conf folder and delete the existing opentext.properties file.

    c. Navigate to the <Tomcat_Home>/webapps folder and delete the existing gateway.war file and gateway folder.

    d. Navigate to the <Tomcat_Home>/temp folder and delete all of the files in the folder.

    e. Navigate to the <Tomcat_Home>/tmp folder and delete all of the files in the folder.

    f. Navigate to the <Tomcat_Home>/lib folder and delete delete any AppWorks Gateway 1.2.x libraries.

    g. Navigate to the <Tomcat_Home>/work/Catalina/localhost folder and delete all of the files in the folder.

  5. You can now install AppWorks Gateway 16.2.1. For details, see Chapter 1 - Installing the OpenText AppWorks Gateway.

2.3 – Adding a URL Rewrite to AppWorks Gateway 16.2.1

In AppWorks Gateway 16.x both the Gateway and the Administration Console are accessed via the root context of the Apache Tomcat installation.

This is a change from AppWorks Gateway 1.2.x, where users were taken to /webaccess from https://[appworksurl]/, from where they could access the services that were configured there, for example, Tempo Box or Tempo Social.

When upgrading to 16.x, you may want to ensure that users continue to access any configured services with the URL they used prior to the upgrade.

To do this, you can use URL rewriting to perform a URL redirect to the /content folder.

The following steps describe how to redirect your users from http://host.opentext.com to http://host.opentext.com/content by downloading and configuring a Java Web filter for the Apache Tomcat installation.

  1. Stop the Apache Tomcat service.

  2. Go to the UrlRewriteFilter web site.

  3. Click the urlrewritefilter-4.0.3.jar link in Step 1 of the Install process. To review the documentation for the Web Filter, click Documentation at the top of the page, then click the link to the 4.0 User Manual.

  4. Save the .jar file to <Tomcat_Home>/gateway/WEB-INF/lib.

  5. Add the following to the <Tomcat_Home>/gateway/WEB-INF/lib/web.xml file:

    <filter>
        <filter-name>UrlRewriteFilter</filter-name>
        <filter-class>org.tuckey.web.filters.urlrewrite.UrlRewriteFilter</filter-class>
        <async-supported>true</async-supported>
    </filter>
    <filter-mapping>
        <filter-name>UrlRewriteFilter</filter-name>
           <url-pattern>/*</url-pattern>
        <dispatcher>REQUEST</dispatcher>
        <dispatcher>FORWARD</dispatcher>
    </filter-mapping>
    

    Note: The UrlRewriteFilter must be the first filter in the web.xml file.

  6. Create a urlrewrite.xml file in <Tomcat_Home>/gateway/WEB-INF/, with the following contents:

    <urlrewrite>
    <rule>
        <name>redirect from root</name>
        <condition name="host" operator="equal">host.opentext.com</condition>
        <from>^/$</from>
        <to type="permanent-redirect" last="true">http://host.opentext.com/content/</to>
    </rule> </urlrewrite>
    
  7. Start the Apache Tomcat service.

    Note: This configuration will redirect from http://host.opentext.com to http://host.opentext.com/content, which will mask the Gateway Administration Console. To access the console, the host's IP address, or some other alias must be entered into the browser address bar.

Top of page



Table of Contents

Your comment

To leave a comment, please sign in.