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

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 launcher.properties file from ...<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc location. This file will help you to update the launcher.properties file for manual changes, if you have done any.
• Take backup of web.xml file from …<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\web\WEB-INF location. This file will help you to update the web.xml file for manual changes, if you have done any.
• Take backup of securityContext.xml file from …<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc\saml location. This file will help you to update the securityContext.xml file for manual changes, if you have done any.
• 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. 1. 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.
  
  

  Note

  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

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. 

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.
   
   

Post Patch Deployment Steps

Log File Changes

After you have applied the patch, PatchApplicationLog_<Date>.log file is 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.

Patch application may take some time, in case there are a large number of records in the backend and log database.

The patch will automatically rollback, in case of any error during the deployment.

Changes in launcher.properties File

In case, you have done custom changes in the launcher.properties file then follow the below step:

1. Go to ...<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc.
2. Open launcher.properties file.
3. Comment out the line that mentions JAR:SAXON:saxon9pe.jar by adding a pound (#) sign before the line starts.
4. Ensure that the manual changes which you have done in previous launcher.properties file is available in this file or not.
5. If not then do the same manual changes in file that you have done in your previous launcher.properties file (that you had saved as backup).

Changes in jetty.xml File

1. Go to ...<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc\jetty location.
2. Take backup of jetty.xml file from the above-mentioned location.
3. Go to the downloaded Adeptia Suite zip folder and copy jetty.xml file.
4. Replace the existing file with the copied file at the following location:  ...<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc\jetty.
5. In case, you have configured SSL certificate then update the jetty.xml file to configure the SSL certificate.

Changes in web.xml File

1. Go to …<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\web\WEB-INF location.
2. Open web.xml file.
3. Do the same manual changes in the file that you have done in your previous web.xml file (that you had saved as backup).
4. Save the file.

Changes in securityContext.xml File

1. Go to …<AdeptiaInstallFolder>\AdeptiaServer\ServerKernel\etc\saml location.
2. Open securityContext.xml file.
3. Do the same manual changes that you have done in your previous securityContext.xml file (that you had saved as backup).
4. Save the file.

In case you are using SAML authentication then 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:
   
   
   
   
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:

   scheme	Name of the scheme (http or https).
   serverName	Name of the server.
   serverPort	Port number of the server.
   includeServerPortInRequestURL	To include server port number in the URL or not. It must be false.
   contextPath	Prefix 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.
7. Restart the Server.
   
   

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