Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

This section lists the prerequisites and explains how to apply the patch on Windows-based and Linux-based operating systems.

Table of Contents
maxLevel3

Prerequisites

Before applying the patch, ensure that you have:

  • Read and Write permissions on all sub-folders and files of ../AdeptiaSuite-<Version>.
  • Stopped Kernel and Webrunner.
  • Stopped process flows that are in Running or Queued state.
  • Deactivated any running Mail Event.
  • Take backup of jettysecurityContext.xml file from .../<AdeptiaInstallFolder>/AdeptiaServer/ServerKernel/etc/jetty location. This file will help you to update the jetty.xml file for manual changes, if you have done any. file from <AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc\saml location. This backup file will help you replicate the manual changes in case you have done earlier in the securityContext.xml file before applying this patch.  
  • Take backup of web.xml file from <AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\web\WEB-INF location. This backup file will help you replicate the manual changes in case you have done earlier in the web.xml file before applying this patch. 
  • Taken the backup of a backend database. 
    • In case, the embedded database is used as the backend database, follow the below steps to take the backup:
      1. Stop Kernel and WebRunner.
      2. Go to .../ <AdeptiaInstallFolder>/AdeptiaServer/ServerKernel folder.
      3. Copy the embeddedDB folder and keep it into a separate folder.
    • In case, any other database is used as the backend database, you need to follow the backup instructions given by that Database Server. To know, which database is used as the back end database, refer to Appendix A: Identify Backend Database.
  • In case you have updated export.xml (during Migration of objects), and you wish to keep changes after applying the patch, keep a backup of this file from the path: ...\<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\MigrationUtility. After the patch application is complete, merge the changes done in the backed up file with the new file (export.xml) generated.

    Info
    titleNote

    Do not replace the backup of export.xml to the newly created export.xml. Only merge the changes from the old file to the new one.


Applying the patch

...

titleApplying patch on v6.9.7

...

For Windows

  1. Download the latest patch from the provided URL.
  2. Extract the downloaded zip file in a folder.
  3. Open the Command Prompt.
  4. Go to the folder where you have extracted the zip file.
  5. Run the following command to apply the patch:
    Apply-Patch.bat "<Path where Adeptia Suite is installed till AdeptiaServer folder>" 

    For example:

    Apply-Patch.bat "C:/Program Files/AdeptiaSuite/AdeptiaSuite-x.x/AdeptiaServer"

    Once the patch is applied, a confirmation message will be displayed.

  6. Start Kernel and WebRunner. 

...

titleFor Linux

For Linux  

  1. Open the Terminal.
  2. Download the latest patch from the provided URL.
  3. Extract the downloaded zip file in a directory.
  4. Go to the directory where you have extracted the zip file.
  5. Run the following command to apply the patch:

    ./Apply-Patch.sh <Path where Adeptia Suite is installed till Adeptia Server folder> 

    For example:

    ./Apply-Patch.sh /mnt/AdeptiaSuite-x.x/AdeptiaServer

    Once the patch is applied, a confirmation message will be displayed.

  6. Start Kernel and WebRunner.

Info
  • Patch application may take some time, in case there are a large number of records in the backend and log database.
  • PatchApplicationLog<Date>.log
file
  •  file is also created inside the logs folder. The logs folder is available in the same folder from where you have applied the patch. PatchApplicationLog_<Date>.log file contains the logs generated during patch application and can be used to troubleshoot any issue related to the patch application.
  • After applying the patch, clear the browser history before login to Adeptia Suite.
  • Clear the Java cache and the previous certificate of Adeptia from Java Control Panel.
Click to
  •  to know how to clear Java cache and delete Adeptia certificates.
  • If any error occurs during patch deployment then the patch will be
recovered automatically
  • recovered automatically.

After applying this patch, refer to post patch deployment section for manual changes.

...

  • Update the property 'abpm.jdo.driver' value as com.mysql.jdbc.Driver.
  • Update the property 'abpm.jdo.url' by removing the value ?useSSL=false&serverTimezone=<time zone> at the end of the URL.

...

  • Update the property 'log4j.appender.jdbc.dbclass' value as com.mysql.jdbc.Driver.
  • Update the property 'log4j.appender.jdbc.url' by removing the value ?useSSL=false&amp;serverTimezone=<time zone> at the end of the URL.

...

Steps to remove the manual changes from qaurtz.properties file:

  1. Go to .../<AdeptiaInstallFolder>/AdeptiaServer/ServerKernel/etc location.
  2. Open quartz.properties file.
  3. Go to Configure Datasources section and do the following changes:
    • Update the property 'org.quartz.dataSource.aBPM.driver' value as com.mysql.jdbc.Driver.
    • Update the property 'org.quartz.dataSource.aBPM.URL' by removing the value ?useSSL=false&serverTimezone=<time zone> at the end of the URL.

  4. Save the file.

Expand
titleFor Windows
  1. Download the latest patch from the provided URL.
  2. Extract the downloaded zip file in a folder.
  3. Open the Command Prompt.
  4. Go to the folder where you have extracted the zip file.
  5. Run the following command to apply the patch:
    Apply-Patch.bat "<Path where Adeptia Suite is installed till AdeptiaServer folder>" 

    For example:

    Apply-Patch.bat "C:/Program Files/AdeptiaSuite/AdeptiaSuite-x.x/AdeptiaServer"

    Once the patch is applied, a confirmation message will be displayed.

  6. Start Kernel and WebRunner. 

Expand
titleFor Linux
  1. Open the Terminal.
  2. Download the latest patch from the provided URL.
  3. Extract the downloaded zip file in a directory.
  4. Go to the directory where you have extracted the zip file.
  5. Run the following command to apply the patch:

    ./Apply-Patch.sh <Path where Adeptia Suite is installed till Adeptia Server folder> 

    For example:

    ./Apply-Patch.sh /mnt/AdeptiaSuite-x.x/AdeptiaServer

    Once the patch is applied, a confirmation message will be displayed.

  6. Start Kernel and WebRunner.
Info
  • Patch application may take some time, in case there are a large number of records in the backend and log database.
  • PatchApplicationLog<Date>.log file is also created inside the logs folder. The logs folder is available in the same folder from where you have applied the patch. PatchApplicationLog_<Date>.log file contains the logs generated during patch application and can be used to troubleshoot any issue related to the patch application.
  • After applying the patch, clear the browser history before login to Adeptia Suite.
  • Clear the Java cache and the previous certificate of Adeptia from Java Control Panel. Click here to know how to clear Java cache and delete Adeptia certificates.
  • If any error occurs during patch deployment then the patch will be recovered automatically.

...

Changes in jetty.xml File

...

Changes in web.xml File

...

Anchor

...

titleApplying patch on v6.9.8

...

Prerequisites for MySQL database

This section is applicable only when MySQL is being used as a backend or log database. In case you are using MS SQL or Oracle as backend or log database then you can skip this step.

If you are using MySQL as a backend/log database and applying the latest patch 'AdeptiaSuite_6_9_8_04_30April2020.zip' on the tags mentioned below then follow the steps below before applying the patch.

  • Release_AS_6_9_8_06March2020

Steps to remove the manual changes from server-configure.properties file:

Info

You need to perform the below steps for the backend and log database. If you have configured a separate database for archiving the logs then you need to perform the same steps for the Archival log database.

Patch Deployment Steps
Patch Deployment Steps
Post Patch Deployment Steps

In this release, some manual changes are required in Server.

Changes in securityContext.xml file

  1. Go to the downloaded Adeptia Suite zip folder and copy the securityContext.xml file.
  2. Replace the existing file with the copied file at the following location: <AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc\saml.
  3. In case you are using SAML authentication, open the updated securityContext.xml file and do the following changes:
    1. Uncomment the following property:

      <!-- <property name="entityBaseURL" value="http://localhost:8080/adeptia"/> -->
    2. Update the URL as required. Where localhost is the IP address and port of the Server.
    3. Uncomment the idp.xml property:

      Image Added

    4. If you are using Adeptia Suite with load balancer, follow these steps:
      • Remove or comment out the existing contextProvider bean
        <bean id="contextProvider" class="org.springframework.security.saml.context.SAMLContextProviderImpl"/>
      • Add the below contextProvider bean
        <bean id="contextProvider" class="org.springframework.security.saml.context.SAMLContextProviderLB">
        <property name="scheme" value="http"/>
        <property name="serverName" value="www.myserver.com"/>
        <property name="serverPort" value="8080"/>
        <property name="includeServerPortInRequestURL" value="false"/>
        <property name="contextPath" value="/adeptia"/>
        </bean>

      This table explains the each property of contextProvider bean:

      schemeName of the scheme (http or https).
      serverNameName of the server.
      serverPortPort number of the server.
      includeServerPortInRequestURLTo include server port number in the URL or not. It must be false.
      contextPathPrefix of a URL path used to select the context(s) to which an incoming request is passed. A URL is in the format: http://hostname.com/contextPath/, where each of the path elements can be zero or more separated elements. It must be /adeptia.

      Property Name

      Description

      It will look like:

      <bean id="contextProvider" class="org.springframework.security.saml.context.SAMLContextProviderLB">
      <property name="scheme" value="http"/>
      <property name="serverName" value="www.myserver.com"/>
      <property name="serverPort" value="8080"/>
      <property name="includeServerPortInRequestURL" value="false"/>
      <property name="contextPath" value="/adeptia"/>
      </bean>
    5. If there were any other changes in the old file, you have to do the same changes manually in the updated securityContext.xml file.
    6. Save the file.
  1. Restart the Server.

Changes in web.xml file

  1. Go to the downloaded Adeptia Suite zip folder and copy the the web.xml file.
  2. Replace the existing file with the copied file at the following location: .../<AdeptiaInstallFolder>/AdeptiaServer/ServerKernel/web/<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\web\WEB-INF.
  3. Open web.xml file.
  4. Do the same manual changes in the file that you have done in your previous web.xml file (that you had saved as a backup).
  5. Save the file.

Changes in server-configure.properties File

In case you are using MySQL as Backend and Log database then do the following manual changes. These changes are required because JDBC driver has been updated for this release. 

...

Update the property 'abpm.jdo.url' by appending the value ?useSSL=false&amp;serverTimezone=<time zone> at the end of the URL.

...

Update the property 'log4j.appender.jdbc.url' by appending the value ?useSSL=false&amp;serverTimezone=<time zone> at the end of the URL.

...

Save the file.

Changes in quartz.properties File

In case you are using MySQL as Backend and Log database then do these manual changes. 

Info
This is required as MySQL JDBC jars have been upgraded to the latest version. 

...

Update the property 'org.quartz.dataSource.aBPM.URL' by appending the value ?useSSL=false&serverTimezone=<time zone> at the end of the URL.

...

Restoring user-defined jars

With the new patch the launcher.properties file is updated and no longer has the list of jars in it. If you have defined your own jars in previous version of launcher.properties file, you need to move them to the ext folder to load them at the time of Kernel and WebRunner start up. Follow the steps below:

...

Adding certificates in cacerts file

Two new certificates need to be added to the cacerts file in the application. This step is required to update the cacerts file with COMODO renewed certificates as the existing certificates of COMODO have expired.

Follow the steps below to add the certificates: 

  1. Stop the Server.
  2. Take the backup of cacerts file from the ...<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc\truststore location.
  3. Download the following two certificates from this link
    • 1199354.crt
    • 1720081.crt
  4. On the command prompt, run the following command to import the two new certificates to the cacerts file:

    keytool -import -file "<path_to_Certificate_file>" -keystore "<path_to_application_folder>\ServerKernel\etc\truststore\cacerts" - alias "<alias_name>" - storepass "<cacerts file password>"

    Where,
    path_to_Certificate_file: The location where you have downloaded the certificates. 
    path_to_application_folder: Location of the cacerts file in the Connect Server. 
    alias_name: Alias name for '1199354.crt' and '1720081.crt' are 'USERTrust RSA Certification Authority' and 'COMODO RSA Certification Authority' respectively.
    cacerts file password: Password for the cacerts file. By default, the password for the cacerts file is 'changeit'.

  5. Restart the Server.

Once the post patch deployment steps are done, start the services, i.e. Kernel and WebRunner.

...

If you are using Database/Advanced Database Event, Source/Target activity with MySQL Database Server using an older version of MySQL JDBC jars then it is recommended to upgrade the jars to mitigate the vulnerability associated with the older jars.

...

Updating database info for CDATA drivers

If you are using any CDATA JDBC driver to connect with salesforce application then follow the steps below to update the database info:

...

Info
This will update the license of upgraded CDATA driver into database info activity. 

Updating SQL jar

This section is applicable if you are using the Rich Form v7.3.2 in Adeptia Suite.

In case, you are using SQL as a backend database then it is recommended to change the jar. Click here to download the compatible version of SQL jar (mssql-jdbc-6.1.4.jre8-preview.jar) and follow the steps to update it.