Difference between revisions of "Upgrade Guide v2.6.3"

Latest revision as of 20:29, 10 October 2024

Current Version

Follow the guide below if you are upgrading to ADF v2.6.3.

IMPORTANT: ADF 2.6.3 and above requires CommonSpot 10.9.0, 10.8.2 or 10.7.3 or above.

Before upgrading, please review the v2.6.3 Release Notes

If you are upgrading from a version earlier than ADF v2.6.2, then please follow the guides for previous ADF versions:

• 2.6.2 Upgrade Guide
• 2.6.1 Upgrade Guide
• 2.6 Upgrade Guide
• 2.5 Upgrade Guide
• 2.4.1 Upgrade Guide
• 2.4 Upgrade Guide
• 2.3.1 Upgrade Guide
• 2.3 Upgrade Guide
• 2.2 Upgrade Guide
• 2.1 Upgrade Guide
• 2.0.1 Upgrade Guide
• 2.0 Upgrade Guide

Previous ADF Upgrade Guides

Upgrade

Follow the steps below to upgrade the ADF directory:

1. Download the ADF v2.6.3 from the Community site project page.
2. On your server, rename the "/ADF/" directory to "/ADF-2.6.2/".
3. Create a new "/ADF/" directory. Set up any necessary security or permissions for the new "/ADF/" directory.
4. Export the download ADF zip folder into the "/ADF/" directory.
5. Copy the contents of the "/ADF-2.6.2/apps/" directory into the "/ADF/apps/" directory.
6. Reset the ADF through the web browser with the following URL parameter:
   1.  ?resetADF=1

Note: If you have security permissions on the "/ADF/" directory make sure to set them up because the folder was renamed and then created new.

Validate Upgrade

There are 2 methods to validate the ADF upgrade.

ADF Reset

1. Reset the ADF through the web browser with the following URL parameter:
   1.  ?resetADF=1
2. The reset command will add text to the top line of the page. If you see the following text with the date/time stamp:
   1. ADF v2.6.3 has been reset successfully!
3. Upgrade was successful and you are running the ADF v2.6.3.

ADF Version Output

1. In the browser, add the following URL parameter:
   1.  ?ADFDumpVar=application.ADF.version
2. This command with output the ADF version at the top of the page. If you see the following text:
   1. 2.6.3
3. Upgrade was successful and you are running the ADF v2.6.3.

Post-Upgrade Steps

Update Site Level Override Components

• Any site level override ADF Lib components located in the "_cs_apps/lib/" folder will need to be renamed and the component "extends" updated to point to the latest version of the matching ADF Lib components.

Example: "_cs_apps/lib/scripts_1_1.cfc" needs to become "scripts_2_0.cfc" and the extends value in the component tag will need to point to "ADF.lib.scripts.scripts_2_0"

• Also make sure all CFPROPERTY "injectedBean" type="dependency" tags at the top of any other site level override ADF Lib components files are also updated to the latest versions of the ADF Lib components.

Example: <cfproperty name="data" injectedBean="data_1_2" type="dependency"> should be updated to be <cfproperty name="data" injectedBean="data_2_0" type="dependency">

Update Custom App Lib Component References

• Update any ADF Lib component references in your custom ADF Apps to the latest versions of the matching ADF 2.0 Lib components in the App's appBeanConfig.cfm file (in the root of the App directory).

Example: "addConstructorDependency(appBeanName, "scripts_1_2", "scripts"); " needs to become "addConstructorDependency(appBeanName, "scripts_2_0", "scripts");"

ADF Removed Resources

Options for resolving missing resources:

1. Update the Registered Resource (or your site's code) to use the latest available version*
2. Update the Registered Resource (or your site's code) to use the required version from a CDN*
3. Download the required resource files and install them locally in your site and update the Register Resource or your site's code
4. Copy in the missing resource files using the ADF 2.5 thirdParty folder (be careful not to overwrite newer versions)

Note: It is recommended to always use the latest available version of any third party/external resources

Register ADF Scripts as CommonSpot Resources

• Register the ADF Script Resources with CommonSpot (for ADF 2.0 and above only!)
  • Run the Register ALL Scripts tool.

IMPORTANT: The ADF thirdParty scripts libraries will not function when using ADF.scripts_2_0 loadScripts calls unless they are registered as Resources in CommonSpot 10.x. 

Enable the CSRF Safe Mode for local ajaxProxy requests

• Once your site is ready Enable ADF AjaxProxy CSRF Safe Mode (for ADF 2.5 and above only!)

WARNING: Enabling the "ADF CSRF Safe Mode" without installing ADF 2.5 and above compatible Apps or without updating all custom ajaxProxy local requests will greatly limit functionality!

Related Guides

CommonSpot Registered Resources

• ADF Scripts and CommonSpot Registered Resources
• Register ALL ADF Scripts as CommonSpot Resources