- Created by Akash Kumar Jaiswal (Unlicensed) , last modified on Jul 23, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 27 Next »
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
Ensure that you have:
- 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 file will help you to update the securityContext.xml file for manual changes, if you have done any.
- Take backup of web.xml file from …<ConnectServerInstallFolder>\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 cacert file from …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\etc\truststore location. This file will help you to update the cacert file for manual changes, if you have done any.
- No process flow or transaction should be in running, waiting or queued state.
- Latest License details of Adeptia Connect. You can contact Adeptia Support for more details.
Applying the patch
- Download the latest patch from the provided URL.
- Extract the downloaded zip file in a 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 “<Path where Adeptia Suite/Connect Server is installed till AdeptiaServer folder>”
For example:
Apply-Patch.bat
"C:/Program Files/AdeptiaConnect/AdeptiaSuite-x.x/ConnectServer/AdeptiaServer"
or
Apply-Patch.bat
"C:/Program Files/AdeptiaSuite/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.
Before you apply this patch on Linux, ensure that you take back up of your existing startup.sh and stop.sh files.
- Open the Terminal.
- Download the latest patch from the provided URL.
- 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 <Path where Adeptia Suite/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
Changes in securityContext.xml File
- Go to the downloaded Adeptia Connect zip folder and rename the securityContext.xml_Server file to securityContext.xml.
- Copy the renamed securityContext.xml file.
- Replace the existing file with the copied file at the following location: …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\etc\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 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 Server.
- 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 updated securityContext.xml file.
- Save the file.
- Restart Connect Server.
Changes in web.xml File
- Go to …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\web\WEB-INF location.
- Go to the downloaded Adeptia Connect zip folder and rename the web.xml_Server file to web.xml.
- Copy the renamed web.xml file.
- Replace the existing file with the copied file at the following location: …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\web\WEB-INF.
- Open web.xml file.
- 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).
- Save the file.
Adding certificates in cacerts file
This patch introduces two new certificates to be added to the cacerts file in the application. Follow the steps below to add the certificates:
- Stop the Connect Server.
- Download the following two certificates from this link.
- 1199354.crt
- 1720081.crt
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'.- Restart the Connect Server.
Adding .dll files in System32 folder
If NTEvent Logging property in server-configure.properties file is enabled then copy the following .dll files in System32 folder.
- NTEventLogAppender.amd64.dll
- NTEventLogAppender.x86.dll
Follow the steps below to place these files in System32 folder:
- Go to …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\etc location.
- Copy the .dll files form this location.
- Paste the files in C:\Windows\System32 folder.
Changes in server-configure.properties File
In case you are using MySQL as Backend and Log database then do the following manual changes.
- Go to …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\etc location.
- Take backup of server-configure.properties file from the above-mentioned location.
- Open server-configure.properties file.
- Go to Database Configuration section and do the following changes:
- Update the property 'abpm.jdo.driver' value as com.mysql.cj.jdbc.Driver.
Update the property 'abpm.jdo.url' by appending the value ?useSSL=false&serverTimezone=<time zone> at the end of the URL.
- Append the value ?useSSL=false at the end of the URL. However, this argument is not required if SSL is configured on your MySQL database server.
- Append the value &serverTimezone=<time zone> at the end of the URL. For example, &serverTimezone=UTC+3:00. This argument is required only when an error related to the time zone is displayed while starting the Connect Kernel.
Here, <time zone> is the time zone of your MySQL server.
Save the file.
- Go to Database Appender section and do the following changes:
- Update the property 'log4j.appender.jdbc.dbclass' value as com.mysql.cj.jdbc.Driver.
Update the property 'abpm.jdo.url' by appending the value ?useSSL=false&serverTimezone=<time zone> at the end of the URL.
- Append the value ?useSSL=false at the end of the URL. However, this argument is not required if SSL is configured on your MySQL database server.
- Append the value &serverTimezone=<time zone> at the end of the URL. For example, &serverTimezone=UTC+3:00. This argument is required only when an error related to the time zone is displayed while starting the Connect Kernel.
Here, <time zone> is the time zone of your MySQL server.
Save the file.
Restoring user-defined jars
With the new patch the launcher.properties file is updated and no longer has the list of jars in it. If you have defined your own jars in previous version of launcher.properties file, you need to move them to the ext folder to load them at the time of Kernel and WebRunner start up. Follow the steps below:
- Go to …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\etc location.
- Open launcher-bak.properties file.
- Identify your jars and move those jars from their current location to the following location: …<ConnectServerInstallFolder>\AdeptiaServer\ServerKernel\ext.
Update window services
If you have upgraded from Adeptia Connect v2.9.2 or earlier to the higher versions, you need to remove the existing windows services i.e. Adeptia Suite Kernel and Adeptia Suite WebRunner and add two new windows services (Connect Kernel and Connect WebRunner).
Follow the steps below to remove the older services:
- Open the Terminal as an administrator.
- Go to the …<ConnectServerInstallFolder>\jre\bin.
Run the following command to remove the old Windows services:
jsl -remove "…<ConnectServerInstallFolder>\ServerKernel\jsl-Kernel_Unregister.ini"
jsl -remove "…<ConnectServerInstallFolder>\ServerKernel\jsl-WebRunner_Unregister.ini"
Follow the steps below to add the new services:
- Open the Terminal as an administrator.
- Go to the …<ConnectServerInstallFolder>\jre\bin.
Run the following command to add the new Windows services:
jsl -install "…<ConnectServerInstallFolder>\ServerKernel\jsl-Kernel.ini"
jsl -install "…<ConnectServerInstallFolder>\ServerKernel\jsl-WebRunner.ini"
Go to windows services to check if these services have been added successfully. To start Adeptia Connect server, you need to start these two services.
Once the post patch deployment steps are done, start the services, i.e. Kernel, WebRunner, and AIMap.
- If you are using Database/Advanced Database Event, Source/Target activity with MySQL Database Server using an older version of MySQL JDBC jars then it is recommended to upgrade the jars to mitigate the vulnerability associated with the older jars.
Click here to download the recommended version of MySQL jars (mysql-connector-java-8.0.18.jar) and follow the steps to upgrade it. - If you are using Spazio Listener, Spazio Source, and Spazio Target then you have to copy active MQ jars in ext folder. Click here for detailed information.
Updating database info for CDATA drivers
If you are using any CDATA JDBC driver to connect with any business application such as salesforce, etc. then follow the steps below to update the database info:
- Login into Adeptia application.
- Edit the database info which is using CDATA driver.
- Save it.
Verifying Connect Server patch
To verify whether the patch is applied successfully:
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.
- Type the username and password in the User Id and Password text boxes respectively.
- Click Login.
- Click Help > About.
- Check the Build Tag. If it is the same you applied, indicates patch is deployed successfully.
Next Step
- No labels