This section lists the prerequisites and steps for applying and verifying 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. |
Anchor |
---|
| Prerequisites |
---|
| Prerequisites |
---|
|
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 server.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.
Anchor |
---|
| Applying the patch |
---|
| Applying the patch |
---|
|
Applying the patch
Expand |
---|
|
- Extract the Adeptia Connect zip file from the downloaded folder.
- Open the Command Prompt.
- Go to the folder where you have extracted the zip file.
Run the following command to apply the patch: Apply-Patch.bat -portal “<Path where Connect Portal 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.
|
Expand |
---|
|
- Open the Terminal.
- Extract the downloaded zip file in a directory.
- Go to the directory where you have extracted the zip file.
Run the following command to apply the patch: ./Apply-Patch.sh -portal <Path where Connect Portal is installed till ConnectPortal folder> For example: ./Apply-Patch.sh -portal /mnt/AdeptiaConnect-x.x/ConnectPortal Once the patch is applied, a confirmation message will be displayed.
|
After applying this patch, refer to post patch deployment section for manual changes.
Anchor |
---|
| Post Patch Deployment Steps |
---|
| Post Patch Deployment Steps |
---|
|
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 memory parameters 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 code and paste it just after the last </Service> tag in the server.xml file.
Code Block |
---|
theme | Midnight |
---|
collapse | true |
---|
|
<Service name="SoapService">
<!--
<Connector port="80" protocol="HTTP/1.1" connectionTimeout="20000"
redirectPort="443" compression="on" noCompressionUserAgents="gozilla,
traviata" compressableMimeType="text/html,text/xml,text/css,application/javascript,application/json"
useSendfile="false" server="Adeptia" xpoweredby="false" />
-->
<!--
<Connector port="443" protocol="HTTP/1.1" SSLEnabled="true" maxThreads="5000"
scheme="https" secure="true" compressionMinSize="128" connectionTimeout="20000"
maxConnections="10000" clientAuth="false" sslProtocol="TLSv1.2" sslEnabledProtocols="TLSv1.2" keystoreFile="./keystore/adeptiaBPM.keystore"
keystoreType="JKS" keystorePass="password" compression="on" noCompressionUserAgents="gozilla,
traviata" compressableMimeType="text/html,text/xml,text/css,application/javascript,application/json"
useSendfile="false" server="Adeptia" xpoweredby="false" />
-->
<Engine defaultHost="localhost" name="soapwebapps">
<Realm className="org.apache.catalina.realm.LockOutRealm">
<Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase"/>
</Realm>
<Host appBase="soapwebapps/wars" autoDeploy="true" name="localhost" unpackWARs="true">
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" pattern="%h %l %u %t "%r" %s %b" prefix="localhost_access_log" suffix=".txt"/>
<Valve className="org.apache.catalina.valves.ErrorReportValve" showReport="false" showServerInfo="false"/>
</Host>
</Engine>
</Service>
<Service name="RestService">
<!--
<Connector port="80" protocol="HTTP/1.1" connectionTimeout="20000"
redirectPort="443" compression="on" noCompressionUserAgents="gozilla,
traviata" compressableMimeType="text/html,text/xml,text/css,application/javascript,application/json"
useSendfile="false" server="Adeptia" xpoweredby="false" />
-->
<!--
<Connector port="443" protocol="HTTP/1.1" SSLEnabled="true" maxThreads="5000"
scheme="https" secure="true" compressionMinSize="128" connectionTimeout="20000"
maxConnections="10000" clientAuth="false" sslProtocol="TLSv1.2" sslEnabledProtocols="TLSv1.2" keystoreFile="./keystore/adeptiaBPM.keystore"
keystoreType="JKS" keystorePass="password" compression="on" noCompressionUserAgents="gozilla,
traviata" compressableMimeType="text/html,text/xml,text/css,application/javascript,application/json"
useSendfile="false" server="Adeptia" xpoweredby="false" />
-->
<Engine defaultHost="localhost" name="restwebapps">
<Realm className="org.apache.catalina.realm.LockOutRealm">
<Realm className="org.apache.catalina.realm.UserDatabaseRealm" resourceName="UserDatabase"/>
</Realm>
<Host appBase="restwebapps/wars" autoDeploy="true" name="localhost" unpackWARs="true">
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" pattern="%h %l %u %t "%r" %s %b" prefix="localhost_access_log" suffix=".txt"/>
<Valve className="org.apache.catalina.valves.ErrorReportValve" showReport="false" showServerInfo="false"/>
</Host>
</Engine>
</Service> |
- 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.
- Open securityContext.xml file.
- Do the same manual changes in the file in case you have done in your previous securityContext.xml file (that you had saved as a backup).
- Save the file.
In case you are using SAML authentication then open the replaced 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 Server.
- Uncomment the idp.xml property:
- If you are using Adeptia Connect with load balancer, follow these steps:
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>
- 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 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:
Code Block |
---|
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.
Anchor |
---|
| Verifying Connect Portal patch |
---|
| Verifying Connect Portal patch |
---|
|
Verifying Connect Portal patch
Login to Adeptia Connect. If you log in successfully, indicates Connect Portal is updated successfully.