Difference between revisions of "Upgrade Guide v2.0"
From ADF Docs
Gcronkright (talk | contribs) (→Register ADF Scripts as CommonSpot Resources) |
Gcronkright (talk | contribs) (→Post-Upgrade Steps) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== Current Version == | == Current Version == | ||
| − | Follow the guide below if you are upgrading to ADF | + | Follow the guide below if you are upgrading to ADF v2.0. |
Before upgrading, please review the [http://community.paperthin.com/projects/ADF/docs/release-notes/Release-Notes-v2-0.cfm v2.0 Release Notes] | Before upgrading, please review the [http://community.paperthin.com/projects/ADF/docs/release-notes/Release-Notes-v2-0.cfm v2.0 Release Notes] | ||
| − | If you are upgrading from ADF v1.8.1 | + | If you are upgrading from a version earlier than ADF v1.8.1, then please follow the guides for previous ADF versions: |
* [[Upgrade_Guide_v1.8.1|1.8.1 Upgrade Guide]] | * [[Upgrade_Guide_v1.8.1|1.8.1 Upgrade Guide]] | ||
* [[Upgrade_Guide_v1.8|1.8 Upgrade Guide]] | * [[Upgrade_Guide_v1.8|1.8 Upgrade Guide]] | ||
| Line 14: | Line 14: | ||
* [[Upgrade_Guide_v1.5.1|1.5.1 Upgrade Guide]] | * [[Upgrade_Guide_v1.5.1|1.5.1 Upgrade Guide]] | ||
* [[Upgrade_Guide_v1.5|1.5 Upgrade Guide]] | * [[Upgrade_Guide_v1.5|1.5 Upgrade Guide]] | ||
| + | |||
| + | '''IMPORTANT:''' ADF 2.x can only be used with CommonSpot 10 or above. For CommonSpot 9.x and below please use ADF 1.8.x. | ||
== Upgrade == | == Upgrade == | ||
| Line 46: | Line 48: | ||
== Post-Upgrade Steps == | == 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" | ||
| + | |||
| + | === 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");" | ||
| + | |||
=== Register ADF Scripts as CommonSpot 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|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. | ||
| + | |||
| + | <!-- | ||
To register ADF 2.0 ThirdParty Scripts as resources in CommonSpot 10 use these URL parameters. | To register ADF 2.0 ThirdParty Scripts as resources in CommonSpot 10 use these URL parameters. | ||
| − | * To register ALL of the ADF 2.0 ThirdParty Scripts for the first time use: | + | * To register ALL of the ADF 2.0 ThirdParty Scripts for the first time use: |
| − | ** http://{commonspot-site}/?configADF=1 | + | ** http://{commonspot-site}/?configADF=1 |
| + | ''(Any existing ADF scripts/resources will be skipped.)'' | ||
| − | * To update/re-register all the existing resources ADF 2.0 ThirdParty Scripts use: | + | * To update/re-register all the existing resources ADF 2.0 ThirdParty Scripts use: |
| − | ** http://{commonspot-site}/?reconfiglADF=1 | + | ** http://{commonspot-site}/?reconfiglADF=1 |
| + | ''(Any missing ADF scripts/resources will also be added.)'' | ||
* In the case you want to only register (or re-register) a minimal set ThirdParty Scripts use these: | * In the case you want to only register (or re-register) a minimal set ThirdParty Scripts use these: | ||
| Line 62: | Line 87: | ||
Remember: You must be logged in to the CommonSpot site for these parameters to run. | Remember: You must be logged in to the CommonSpot site for these parameters to run. | ||
| − | |||
For more information regarding the registration of ADF 2.0 ThirdParty Scripts as Resources in CommonSpot 10, please refer to the README information in the "/lib/scripts/scripts_2_0_READ_ME.txt" file. | For more information regarding the registration of ADF 2.0 ThirdParty Scripts as Resources in CommonSpot 10, please refer to the README information in the "/lib/scripts/scripts_2_0_READ_ME.txt" file. | ||
| + | --> | ||
| − | === | + | == Related Guides == |
| + | === CommonSpot Registered Resources === | ||
| + | * [[ADF Scripts and CommonSpot Registered Resources]] | ||
| + | * [[Register All Scripts|Register ALL ADF Scripts as CommonSpot Resources]] | ||
| − | + | [[Category: Upgrading the ADF]][[Category: How-to Guide]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 16:40, 24 January 2022
Contents
Current Version
Follow the guide below if you are upgrading to ADF v2.0.
Before upgrading, please review the v2.0 Release Notes
If you are upgrading from a version earlier than ADF v1.8.1, then please follow the guides for previous ADF versions:
- 1.8.1 Upgrade Guide
- 1.8 Upgrade Guide
- 1.7 Upgrade Guide
- 1.6.2 Upgrade Guide
- 1.6.1 Upgrade Guide
- 1.6 Upgrade Guide
- 1.5.2 Upgrade Guide
- 1.5.1 Upgrade Guide
- 1.5 Upgrade Guide
IMPORTANT: ADF 2.x can only be used with CommonSpot 10 or above. For CommonSpot 9.x and below please use ADF 1.8.x.
Upgrade
Follow the steps below to upgrade the ADF directory:
- Download the ADF v2.0 from the Community site project page.
- On your server, rename the "/ADF/" directory to "/ADF-1.8.x/".
- Create a new "/ADF/" directory. Setup any necessary security or permissions for the new "/ADF/" directory.
- Export the download ADF zip folder into the "/ADF/" directory.
- Copy the contents of the "/ADF-1.8.x/apps/" directory into the "/ADF/apps/" directory.
- Reset the ADF through the web browser with the following URL parameter:
- ?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
- Reset the ADF through the web browser with the following URL parameter:
- ?resetADF=1
- The reset command will add text to the top line of the page. If you see the following text with the date/time stamp:
- ADF v2.0.0 has been reset successfully!
- Upgrade was successful and you are running the ADF v2.0.
ADF Version Output
- In the browser, add the following URL parameter:
- ?ADFDumpVar=application.ADF.version
- This command with output the ADF version at the top of the page. If you see the following text:
- 2.0.0
- Upgrade was successful and you are running the ADF v2.0.
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"
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");"
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.
