ADF Release Notes v2.0
Overview
The Application Development Framework (ADF) version 2.0 release contains minor enhancements and bug fixes to core ADF 1.8 functionality, but also has been greatly enhanced to work with the new features of the CommonSpot 10 release, including the new required CFC format for Custom Field Types and the use of the Resource Loader Framework API.
ADF Applications
In addition to changes to the core ADF libraries, the following ADF applications have also been updated to be compatible with CommonSpot 10 and ADF 2.0:
- pt_blog
- pt_calendar
- pt_comments
- pt_news
- pt_photo_gallery
- pt_poll
- pt_page_rating
- pt_profile
- pt_tags
- pt_socialmedia
- Note that this application has been converted to ADF2,0, however the YouTube API has not yet been updated to support the current YouTube API, and as such does not render. The Facebook and Twitter streams are working.
- ohsu_nav
- Note the OHSU_NAV application is being deprecated. PaperThin strongly recommends that customers utilizing this application migrate to using the native CommonSpot Tree Navigation element, which was introduced in version 9 of CommonSpot. If you need help converting your existing OHSU navigation structure to the CommonSpot Tree Nav element, contact your Account Manager, as PaperThin has some pre-developed code that may be useful in this endeavor.
- While PaperThin has converted the Custom Field Types for this application to be CFC based, the current state of the application is that it will render using the existing data but editing is broken.
Version Compatibility
Simply put, CommonSpot 10.0 required ADF 2.0, and ADF2.0 requires CommonSpot 10.0.
If your site is running CommonSpot 10 and is using a pre-release build of ADF v2.0, please upgrade to the ADF 2.0 release version! If you are upgrading to CommonSpot 10 and have ADF 1.8.x or older installed, ADF 2.0 is required. ADF 1.8.x and older will not work with CommonSpot 10. Please note if your site is running CommonSpot 9 or older you will need to use the ADF 1.8.1 release or 1.8.2 development builds.
Field Type CFCs
CommonSpot 10 requires that all Custom Field Type Render modules be converted to be a CFC versus a CFM module. For the custom field types in the ADF, and for the ADF applications listed above, PaperThin has performed the conversion. If you are utilizing any of the ADF custom field types, you will need to re-point the registered field types to the CFC versions. If you are utilizing any of the applications listed above, and if they include custom field types, you will need to download the 2.0 version of these applications and update their Render Module references to point to the CFCs.
Resource Loading
CommonSpot 10 introduces a new Resource Loading Framework to help efficiently load JavaScript and CSS resources. The ADF’s script component has been update to utilize this new capability. However, in order for the resources to be loaded, you must first register them with CommonSpot. The ADF ships with a script, /ADF/lib/scripts/registerAllScripts.cfm, to automatically register all of the resources used by the ADF. View and follow the instructions at the start of the file.
Custom modules such as Custom Field Types Render and Property modules, Render Handlers and Custom Scripts should also declare the resources that it might load, so that when viewing the properties of the module or when exporting CommonSpot can report on the resource dependencies correctly. For the custom field types that ship with the ADF, the Render Modules and Properties modules have been updated appropriately. Also for the ADF applications listed above, a best effort was made to update their Field Types, Render handler and Custom Scripts appropriately, however some resources might not have been properly declared.
For any custom field types, render handlers or custom scripts that you have written, you should make updates to use the resource loading framework as well. Refer to the custom field types that are included with the ADF 2.0 as a code reference.
For detailed information about the Resource Loading Framework, see the CommonSpot Developer’s Guide.
Installation/Upgrade
For detailed instructions for installing the ADF, see the ADF Installation Guide.
For detailed instructions for upgrading from a previous version of the ADF, see the ADF v2.0 Upgrade Guide.
If you are upgrading from an earlier release, we strongly recommend that you also read the following:
Supported ColdFusion Versions
All supported Adobe ColdFusion and Lucee versions supported by CommonSpot 10.
Note that CommonSpot 10 no longer supports Railo.
Notable Enhancements
The ADF 2.0 release contains the following significant enhancements and updates.
ADF General
- Updated major part of the ADF work with and be compatible with the new CommonSpot 10 JavaScript and CSS Resource Loading.
- Rebuilt the core ADF custom fields type render files to be compatible with the new CommonSpot 10 Custom Field Type render.cfc's.
- Updated the core ADF custom fields type property modules to follow CommonSpot 10 best practices for loading any required Javascript and CSS libraries.
- Added a tool to quickly register all ADF scripts as CommonSpot resources.
Custom Field Types
- All ADF custom field types now use the _render.cfc components instead of the old _render.cfm render files.
- The ADF custom field render.cfc components extend a base class that hooks into CommonSpot's Custom Field Type base class.
- ADF custom fields that have their own custom configuration base component, now extend a common base class in the ADF extensions root directory.
- Added the Bootstrap Glyphicon Select field.
Custom Scripts
- Added to the ceManagement.cfm to be an updated and enhanced version of the genericElementManagement.cfm.
Library Components
- Reorganized the lib components extends hierarchy to allow the component in the root lib directory to act as base class for all lib components.
Third Party
- Updated several of the Third Party scripts libraries to the latest versions.
Notable Updates
The following notable updates were in this release:
ADF General
- Updates for ADF lightbox to work with CKEditor
Custom Fields Types
Removed obsolete Custom Field Types:
- customScriptSelector
- date_time_builder (replaced by custom_element_datamanager)
- element_selector
- element_selector_by_cs_url
- hidden_list (replaced by custom_hidden_field)
- link_builder (replaced by Data Manager)
- site_list (replaced by cs_site_select)
Fixed several issues with the
- Custom Element Data Manager
- Object Hierarchy
Library Components
- Fixed several outstanding issues with library components