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 steps for applying this patch.

Info
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

Ensure that you have:

  • Read and Write permissions on all subfolders and files of .../AdeptiaConnect-<Version>
  • Take backup of  shutdown.sh file from <ConnectPortalInstallFolder>\bin location. This file will help you to update the new stop.sh file for manual changes, if you have done any. This is applicable only for Linux environment.
  • Connect Server services are running.
  • Connect Portal service is stopped.

Steps to update the patch:

Expand
titleFor Windows
  1. Extract the Adeptia Connect zip file from the downloaded folder.
  2. Open the Command Prompt.
  3. Go to the folder where you have extracted the zip file.
  4. Run the following command to apply the patch:
    Apply-Patch.bat -portal “<Path where Adeptia Suite/Connect is installed till ConnectPortal folder>” 

    For example:

    Apply-Patch.bat -portal  "C:/Program Files/AdeptiaConnect/AdeptiaConnect-x.x/ConnectPortal"
     
    Once the patch is applied, a confirmation message will be displayed. 
  5. Start Connect Portal


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

    ./Apply-Patch.sh -portal <Path where Adeptia Connect is installed till ConnectPortal folder> 

    For example:

    ./Apply-Patch.sh -portal /mnt/AdeptiaConnect-x.x/ConnectPotal

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

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

  5. Start Connect Portal.

Post Patch Deployment Steps

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

Changes in Web.xml File

  1. Go to the folder path where Adeptia Connect is installed. For example, C:\Program Files\AdeptiaConnect\AdeptiaConnect-3.0\ConnectPortal\conf
  2. Take back up of web.xml file from the above-mentioned location.
  3. Go to the downloaded Adeptia Connect zip folder and copy web.xml.
  4. Replace the existing file with the copied file at the following location: C:\Program Files\AdeptiaConnect\AdeptiaConnect-3.0\ConnectPortal\conflocation …<ConnectPortalInstallFolder>\conf.
  5. Open the replaced file and do the following changes:
    1. If you had uncommented the following tag in the replaced file will comment it, therefore you need to uncomment it again:
       <!--<security-constraint>
              <web-resource-collection>
              <web-resource-name>Protected Context</web-resource-name>
              <url-pattern>/*</url-pattern>
              </web-resource-collection>
              <user-data-constraint>
              <transport-guarantee>CONFIDENTIAL</transport-guarantee>
              </user-data-constraint>
          </security-constraint>-->
  6. Save the file.

Changes in SecurityContext.xml File

  1. Go to …<ConnectPortalInstallFolder>\resources_config\saml location.
  2. Take backup of securityContext.xml file from the above-mentioned location.
  3. Go to the downloaded Adeptia Connect zip folder and copy securityContext.xml.
  4. Replace the existing file with the copied file at the following location: …<ConnectPortalInstallFolder>\resources_config\saml.
  5. Do the same manual changes that you have done in your previous securityContext.xml file (that you had saved as backup).

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

    Image Modified

  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 URL path used to select the contextthe 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 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 replaced securitycontext.xml file.
  6. Save the file.
  7. Restart Connect Portal.

Changes in catalina.properties File

...

  1. Go to …<ConnectPortalInstallFolder>\bin location.
  2. Type the command chmod +x stop.sh to get the execution permission on stop.sh file.

    Info
    For future updates, use stop.sh file only.


Once the post installation steps are done, start the Connect Portal.

Next Steps

Verifying Patch

...