Upgrade Guide v1.5

Pre-Upgrade Steps

• Determine custom field types in use.
  • Run query to find all the custom field types from the ADF and the elements the fields are in use.

    SELECT     FormInputControlMap.FieldID, 
               FormInputControl.FieldName,
               FormInputControl.Type,
               FormControl.FormName,
               CustomFieldTypes.ID,
               CustomFieldTypes.RenderModule,
               CustomFieldTypes.PropertyModule
    FROM       FormInputControl INNER JOIN FormInputControlMap 
                  ON FormInputControl.ID = FormInputControlMap.FieldID INNER JOIN FormControl
                  ON FormInputControlMap.FormID = FormControl.ID INNER JOIN CustomFieldTypes 
                  ON FormInputControl.Type = CustomFieldTypes.Type
    WHERE      CustomFieldTypes.RenderModule LIKE '/ADF/%'
    ORDER BY FormControl.FormName

• Determine ADF applications running.
  • Add this URL parameter to any page to get a list of the ADF applications that are running on the site.
    •  ?adfdumpvar=application.ADF.siteAppList
• Determine differences w/in the ADF code
  • Best approach to this is to use the Beyond Compare application to get visual differences between the two versions of the files.

Updates

• Update the Core and Lib
  • Update "/ADF/core/" files
  • Under the site, rename the "/_cs_apps/ADF.cfc" to "ADF-old.cfc".
  • Update the site ADF files (from "/ADF/core/site-sample/" and not the "custom-application" file).
  • Update the new "ADF.cfc" with the "loadApp" commands in the "ADF-old.cfc".
  • Update "/ADF/lib/" files
  • Update "/Application.cfc" file
  • Reset the ADF
• Update the ThirdParty directory
  • Extensions
    • CustomCF
    • Datasheet Modules
      • Run query to find if any datasheet modules not in the current ADF are being used within your site.
    • Lightbox, lview, style
    • Custom Fields
      • Run query to find all the custom field types from the ADF and the elements the fields are in use.
      • Update each custom field type one at a time to test.
        • Update the custom field type files in the ADF directory.
        • Open the custom element through the CommonSpot administrator and edit the field definitions for the custom field. Check the properties tab is working correctly with no errors.
        • Locate the element in your site and edit the record data to make sure the form opens correctly and no errors. If you see any errors at this point, go into the site admin and edit the field and check the properties are correct and save the field.
• Reset the ADF

Custom Field Clean Up

• When ADF applications are installed and the custom elements are imported, they contain custom fields that are in the ADF. If the custom field is already installed within the site, then you'll get duplicates of the custom field installed that ends in "_import_xxxxxxxx".
• The duplicated custom fields do not need to be there because they are all connected to the same ADF custom field type. Follow the steps below to clean up these duplicated import custom fields.
  • Run query to find all the custom field types from the ADF and the elements the fields are in use.
  • In the query, identify any custom field names that end in "_import_xxxxxxxxx" (where the 'x' is a number). Verify that the same custom field name is in the site but without the "_import_xxxxxxxxx".
  • You cannot just delete the custom field for the admin if the field is still in use within a custom element. Locate the custom element that contains the duplicate imported field through the site admin element manager.
  • Open the field definitions for the custom field. Before changing the field type, open the properties and document the settings are stored. When the field type is changed, these settings will need to be re-entered.
  • After the property values are documented, change the field type to not duplicated version (does not contain the '_import_xxxxxxxx'). Open the properties tab and enter the values that were previously entered. If you run into problems, you can always 'cancel' the form and that will not save any changes.
  • Once completed, save the field definitions.
  • Repeat this process for all the custom fields that are duplicated.
  • After all the duplicates have been changed in the custom elements, go to the Field Type administrator and delete all the custom fields that were duplicated (contain the '_import_xxxxxxxx').

File Uploader Custom Field Type

• The ADF File Uploader custom field type has been updated to version 2. At this time v2 is not backwards compatible with v1. If you are using the File Uploader custom field within your site follow the steps below to make sure the field is using v1 after the ADF upgrade.
  • Open the Field Type administrator and locate the File Uploader custom field. Unlock the field if it is locked.
  • Edit the props explicit path to:
    • /ADF/extensions/customfields/file_uploader/v1/file_uploader_props.cfm
  • Edit the render explicit path to:
    • /ADF/extensions/customfields/file_uploader/v1/file_uploader_render.cfm
  • Save the custom field.

General Chooser

• The ADF General Chooser field has been updated to version 1.1. This field is backwards compatible with v1 provided the custom field is using the properties and render files within the ADF extensions.
• To properly update the general chooser property component (cfc) files that you have developed for your site (if needed), follow the steps below.
  • Open the sample GC property component in the ADF (/ADF/extensions/customfields/general_chooser/sample_gc.cfc)
  • Locate your local site GC components. These would be located within the "/_cs_apps/components/" directory.
  • Compare the "variables" that are defined at the top of the component. These variables were modified in the new version. You can remove any variables from your component that are not in the sample GC file.
  • New variables were added for v1.1. Make sure those settings are correct for your specific chooser.