Applying Connect Portal 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
- Read and Write permissions on all sub-folders and files of .../AdeptiaConnect-<Version>.
- Take backup of launcher.properties file from …<ConnectPoratlInstallFolder>\conf location. This backup file will help you replicate the manual changes in case you have done earlier in the launcher.properties file before applying this patch.
- Take backup of server.xml file from …<ConnectPortalInstallFolder>\conf location. This backup file will help you replicate the manual changes in case you have done earlier in the server.xml file before applying this patch.
- Take backup of securityContext.xml file from …<ConnectPortalInstallFolder>\resources_config\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 apps.properties file from …<ConnectPortalInstallFolder>\resources_config location. This backup file will help you replicate the manual changes in case you have done earlier in the apps.properties file before applying this patch.
- Connect Server services are running.
- Connect Portal service is stopped.
Applying the patch
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 Portal.
Changes in launcher.properties file
- Go to …<ConnectPoratlInstallFolder>\conf location.
- Open launcher.properties file.
- Do the same manual changes in the file that you have done in your previous launcher.properties file (that you had saved as a backup). For example, you may need to update the JVM settings as they are there in the backup file.
- Save the file.
Changes in server.xml file
- Go to …<ConnectPortalInstallFolder>\conf location.
- Open server.xml file and do the following changes:
- Add parameter secretRequired="false" in Connector tag for AJP.
Expand the section below to copy the "ciphers" parameters with its values and paste it just after the "server="Adeptia" xpoweredby="false" clientauth="true" text in the <Connector> tag of server.xml file.
Expand the section below to copy the code and paste it just after the last </Service> tag in the server.xml file.
- Add parameter secretRequired="false" in Connector tag for AJP.
- Save the file.
Changes in securityContext.xml file
- Go to the downloaded Adeptia Connect zip folder and rename the securityContext.xml_Portal file to securityContext.xml.
- Copy the renamed securityContext.xml file.
- Replace the existing file with the copied file at the following location: …<ConnectPortalInstallFolder>\resources_config\saml.
- In case you are using SAML authentication, open the updated securityContext.xml file and do the following changes:
Uncomment the following property:
<!-- <property name="entityBaseURL" value="http://localhost:8080/adeptia"/> -->
- Update the URL as required. Where localhost is the IP address and port of the Connect Portal.
- Uncomment the idp.xml property:
- 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:
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> - Remove or comment out the existing contextProvider bean
- If there were any other changes in the old file, you have to do the same changes manually in the replaced securityContext.xml file.
- Save the file.
Restart the Connect Portal.
Changes in apps.properties file
- Go to …<ConnectPortalInstallFolder>\resources_config location.
- Open apps.properties file.
Replace the details for Microsoft SharePoint by the details given below:
microsoftsharepoint.oauthVersion=2.0 microsoftsharepoint.oauth20.authorize={baseUrl}/_layouts/15/OAuthAuthorize.aspx microsoftsharepoint.oauth20.accessToken=https://accounts.accesscontrol.windows.net/{realmId}/tokens/OAuth/2 microsoftsharepoint.scope=Site.Manage List.Manage Web.Manage Web.Write AllSites.Manage AllProfiles.Manage microsoftsharepoint.AccessTokenValueMap=resource$00000003-0000-0ff1-ce00-000000000000/{domain}.sharepoint.com@{realmId}
- Save the file.
Once the post installation steps are done, start the Connect Portal.
Verifying Connect Portal patch
Login to Adeptia Connect. If you log in successfully, indicates Connect Portal is updated successfully.