Applying Connect Server patch

This section lists the prerequisites and steps for applying and verifying this patch.

Though every release of Adeptia comes with seamless upgrades and bug-free patches, for customer's complex use cases, we recommend applying the patch in a non-production environment first followed by testing. After the use cases run successfully without any errors or warnings, you can apply the patch in the production environment. 

Prerequisites

  • You have Read and Write permissions on all sub-folders and files of .../AdeptiaConnect-<Version>.
  • Services such as Kernel, WebRunner, and AIMap are stopped.
  • Take backup of securityContext.xml file from …<ConnectServerInstallFolder>\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 …<ConnectServerInstallFolder>\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.  
  • In case you have updated export.xml or connect_export.xml (during Migration of objects), and you wish to keep changes after applying the patch, keep a backup of these files from the path: <ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\MigrationUtility. After the patch application is complete, merge the changes done in the backed up file in the new file (export.xml or connect_export.xml) generated.
  • No process flow or transaction should be in running, waiting or queued state. 

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 Connect Server is installed till AdeptiaServer folder>” 

    For example:

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

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

    Note: While applying the patch you may come across following warning messages that you should ignore.

    Warning: Not deploying connect2.0 accelerator because no change list is present.
    Warning: Not deploying EDI accelerator because no change list is present.

 For Linux

 
Before you apply this patch on Linux, ensure that you take back up of your existing startup.sh and stop.sh files. 

  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 Connect Server is installed till AdeptiaServer folder> 

    For example:

    ./Apply-Patch.sh /mnt/AdeptiaConnect-x.x/ConnectServer/AdeptiaServer

    or

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

    Note: While applying the patch you may come across following warning messages that you should ignore.

    Warning: Not deploying connect2.0 accelerator because no change list is present.
    Warning: Not deploying EDI accelerator because no change list is present.

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

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.

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

Post patch deployment steps

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

Changes in securityContext.xml file

  1. Go to the downloaded Adeptia Connect zip folder and rename the securityContext.xml_Server file to securityContext.xml.
  2. Copy the renamed securityContext.xml file.
  3. Replace the existing file with the copied file at the following location: <ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\etc\saml.
  4. 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 Connect Server.
    3. Uncomment the idp.xml property:



    4. If you are using Adeptia Connect 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 Connect Server.

Changes in web.xml file

  1. Go to the downloaded Adeptia Connect zip folder and rename the web.xml_Server file to web.xml.
  2. Copy the renamed web.xml file.
  3. Replace the existing file with the copied file at the following location: …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\web\WEB-INF.
  4. Open web.xml file.
  5. 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).
  6. Save the file.

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 Connect Server.
  2. Take the backup of cacerts file from the …<ConnectServerInstallFolder>\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 Connect Server.

Installing Fontconfig Library on Linux

This section is applicable only if you are using Connect Server in Linux environment.

In view of using open source Amazon Coretto JRE with this release, it is mandatory for you to install the Fontconfig library on the machine where Connect Server is running.  

Ensure that you have Read, Write, and Execute permissions in Linux environment.

Follow the steps below to install the Fontconfig library:

  1. Run the following command to install the Fontconfig library:
           yum install fontconfig

    Command to install Fontconfig library may vary for different Linux editions.
  2. Restart the machine.  

Verifying Connect Server patch

To verify whether the patch is applied successfully:

  1. Open the browser and visit the URL:

    http://<hostname>:8080/adeptia/control

    where hostname is the name of the server on which Connect Server is running. Developer Studio home page appears.

  2. Type the username and password in the User Id and Password text boxes respectively.
  3. Click Login.
  4. Click Help > About.
  5. Check the Build Tag. If it is the same you applied, indicates patch is deployed successfully.


Next step

Applying Connect Portal patch