PT Blog Version 3.2 Upgrade

From ADF Docs
Jump to: navigation, search

Back to PT Blogs

IMPORTANT: v3.2 of this application requires ADF 1.7.0 or greater 


This guide is to upgrade the PT Blog v3.2 application. If upgrading from a lower version than v3.1, please follow the PT Blog Upgrade v3 Guide to validate your installation.

Application Code

  1. Rename directory "/ADF/apps/pt_blog" to "/ADF/apps/pt_blog_v3_1".
  2. Rename file "/ADF/apps/pt_blog_v3_1/appBeanConfig.cfm" to "/ADF/apps/pt_blog_v3_1/appBeanConfig.cfm.old".
  3. Download the PT Blog v3.2 and exported into the "/ADF/apps/pt_blog/" directory.

Custom Element Updates

PTBlog2 Configuration

Add the following field to the Blog Configuration tab of the ptBlog2 Configuration element:

  1. a Blog Configuration URL CommonSpot Page URL field
    1. Field Name: blogConfigurationURL
    2. Field Label: Blog Configuration URL
    3. Type: CommonSpot Extended URL
    4. Properties:
      1. Enabled Types: Page


IMPORTANT: It is a good idea to backup your CommonSpot Site Database before running the BlogAppUpdater script

Due to a new incompatibility with the ADF's getCEData "formid" is no longer a valid Field Name in the custom elements. Use these steps to update the FormID field in the Comments2 Global Custom element:

  1. Copy the following updater file to your site and place it in your 'customcf' directiry:
    1. '/ADF/apps/pt_blog/site-files/customcf/BlogAppUpdater.cfm'
  2. View the PT Blog App Update menu page by going to the URL:
    1. http://{your-site}/customcf/BlogAppUpdater.cfm
  3. The following updater script with be displayed with [PREVIEW] and [RUN] options
    1. schema-update-for-3.2
  4. First, click on the [PREVIEW] option
  5. If the message reads "No Fields need to be updated at this time!" you are done!
  6. If the message displays the "Old Field" and the "New Field" update info, go back to the updater menu.
  7. Once back at the updater menu, click the [RUN] option.
  8. When the script has finished running and displays the message:
    1. The field "FieldID" in the Comments2 element was updated!
    2. Go to the CommonSpot Site Admin.
    3. Go to the "Elements" menu item under "Elements & Forms".
    4. From the list of elements in the "Manage Elements" dialog find the "Comments2" custom element.
    5. Select the "Field Definitions" menu option for the Comments2 element under the pencil icon.
    6. When the "Custom Element Field Definitions" dialog click on the pencil icon to edit the updated field
    7. Without making any other changes hit the "save" option to save the field.
    8. The field should then reflect the changes.
  9. Close the "Manage Elements" windows.

Your Fields should now be updated!

IMPORTANT: Using CommonSpot reserved words as field names in Custom Element is not recommended!
(eg. subsiteid, pageid, formid)

App Configuration Page

After the new blogConfigurationURL field has been added to the PTBlog2 Configuration element and the new App files are in place a Blog Configuration Page will be used to manage the ptBlog2 Configuration custom element.

  1. Create a new page called 'Configuration Manager' in the /webadmin/blogs/ subsite from the webadmin template.
  2. In the main content of the page, add a Custom Script element.
  3. Enter the explicit module path for:
    • /ADF/apps/pt_blog/customcf/manage_configuration_header.cfm
  4. Publish the page.

App Configuration Update

After the new App Configuration page has been created:

  1. Go to the Blog App Configuration Manager and click the "Edit Configuration" button.
  2. When the configuration form opens, go to the Blog Configuration tab, then update the following field with the new value:
    1. Blog Configuration URL:: {browse to your newly created Blog App Configuration page}
  3. Then click "Submit".

Reset the ADF

Reset the ADF for the server and site.

Site Level Customizations Review

This is only for reviewing the site level customizations in the "/_cs_apps/pt_blog/" directory, not in the ADF directory.

  1. Analyze the updated app code compared to the app customization code on your server.
    1. Identify any customizations that you have made to the application code to make sure these are updated with any functionality.
    2. Again, Beyond Compare is a good tool to compare the new and current file to identify the exact lines of code that have been changed.
    3. This is important for components that have customized functions to the site level "/_cs_apps/". The best practice is to identify the function that have been customized and compare with the new app function to identify any updates. A good help is to check the function comment header to see if any updates have been made.
  2. Once completed, Reset the ADF.