Upgrade Guide v1.8

From ADF Docs
Jump to: navigation, search

Current Version

Follow the guide below if you are upgrading to ADF v1.8.0.

Before upgrading, please review the v1.8.0 Release Notes

If you are upgrading from ADF v1.7.0 or earlier, then please follow the guides for previous ADF versions:

Upgrade

Follow the steps below to upgrade the ADF directory:

  1. Download the ADF v1.8 from the Community site project page.
  2. On your server, rename the "/ADF/" directory to "/ADF-1.7.x/".
  3. Create a new "/ADF/" directory. Setup 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-1.7.x/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 v1.8.0 has been reset successfully!
  3. Upgrade was successful and you are running the ADF v1.8.0.

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. 1.8.0
  3. Upgrade was successful and you are running the ADF v1.8.0.

Post-Upgrade Steps

Custom Element SQL View Default Names

A notable change for the v1.8.0 release of the ADF involves the default naming convention used for creating SQL Views from Custom Elements.

In versions 1.6.x and 1.7.x the default SQL View naming convention used a prefix “veiw_ce_” and the the Custom Element’s FormID ( ce_view_{FormID} ).

In the ADF 1.8 release this naming convention was changed to use a shorter prefix “vCE_” along with the Custom Element’s name with spaces removed ( vCE_{CustomElementName} ).

If your sites use Custom Elements SQL Views generated by the ADF functions buildView() and/or buildRealTypeView() and your code is set to use the default SQL naming convention, please rebuild your views and upgrade any custom code that would reference these Custom Elements SQL Views directly.

Also remember, after changes to Custom Elements via the CommonSpot UI (eg. modifications to fields and/or updating the name of the Custom Element) the Custom Element SQL Views have to be recreated for the changes to be reflected in the SQL View.

Note: Custom Element SQL Views that are created using these functions but pass in a custom View name will not be affected by this change. If you desire to keep the 1.6/1.7 SQL Custom Element SQL View naming convention update your custom code to pass in custom SQL view name.

ADF 1.6  and ADF 1.7
"ce_view_{CustomElementFormID}"
ADF 1.8
"vCE_{CustomElementName}"