Difference between revisions of "PT Photo Gallery Version 2.3 Upgrade"

From ADF Docs
Jump to: navigation, search
(Photo)
 
(6 intermediate revisions by one other user not shown)
Line 11: Line 11:
 
## A great tool to use is Beyond Compare to compare the new and current file to identify the exact lines of code that have been changed.
 
## A great tool to use is Beyond Compare to compare the new and current file to identify the exact lines of code that have been changed.
 
# Once this is complete, then move your app customizations into the new app code package.   
 
# Once this is complete, then move your app customizations into the new app code package.   
 +
 +
== Application Code ==
 +
# Rename directory "/ADF/apps/pt_photo_gallery" to "/ADF/apps/pt_photo_gallery_v2".
 +
# Rename file "/ADF/apps/pt_photo_gallery_v2/appBeanConfig.cfm" to "/ADF/apps/pt_photo_gallery_v2/appBeanConfig.cfm.old".
 +
# Move the PT Photo Gallery v2.3 and into the "/ADF/apps/pt_photo_gallery/" directory.
 +
# Reset the ADF.
  
 
== Custom Field Types ==
 
== Custom Field Types ==
Line 21: Line 27:
 
# Import the Photo Category custom field type.
 
# Import the Photo Category custom field type.
 
## /ADF/apps/pt_photo_gallery/exported-objects/Photo-Category-Custom-Field-Type.zip
 
## /ADF/apps/pt_photo_gallery/exported-objects/Photo-Category-Custom-Field-Type.zip
 
  
 
== Custom Element Updates ==
 
== Custom Element Updates ==
# Navigate to the Site Administrator and open the field definitions for the following custom element.
+
Navigate to the Site Administrator and open the field definitions for the following custom element.
  
 
=== Photo ===
 
=== Photo ===
Line 30: Line 35:
 
# Open the field definitions for the "Category" field.
 
# Open the field definitions for the "Category" field.
 
## Look at the current properties  
 
## Look at the current properties  
## Change the field type to "Photo Category".
 
 
## Open the properties and make note of the values in the "Field Name" and "Field Display Type" fields.
 
## Open the properties and make note of the values in the "Field Name" and "Field Display Type" fields.
 
# Change the field type to "Photo Category".
 
# Change the field type to "Photo Category".
Line 36: Line 40:
 
### Note the new field for "JavaScript Field ID" uses the value of the "Field Name".
 
### Note the new field for "JavaScript Field ID" uses the value of the "Field Name".
  
 +
=== Photo Category ===
 +
# Open the field definitions for the "Photo Category" element.
 +
# Edit the "reqSizeIDList" field and open the properties tab.
 +
## Set the following values:
 +
### Load All Available Selections: Yes
 +
# Edit the "resizeSizeIDList" field and open the properties tab.
 +
## Set the following values:
 +
### Load All Available Selections: Yes
  
 
+
=== Custom Field Updates ===
== Application Code ==
+
Identify the custom elements within the site that are utilizing the "Photo Upload Link" custom field type.
# Renamed directory "/ADF/apps/pt_photo_gallery" to "/ADF/apps/pt_photo_gallery_v2".
+
# Open the element field definitions and edit the properties for the field.
# Renamed file "/ADF/apps/pt_photo_gallery_v2/appBeanConfig.cfm" to "/ADF/apps/pt_photo_gallery_v2/appBeanConfig.cfm.old".
+
## Set all the fields accordingly based on the element being used.
# Downloaded the PT Photo Gallery v2.3 and exported into the "/ADF/apps/pt_photo_gallery/" directory.
 
# Reset the ADF.
 
  
 
== Site Level Customizations Review ==
 
== Site Level Customizations Review ==

Latest revision as of 01:26, 28 March 2014

Overview

This guide is to upgrade the PT Photo Gallery v2.3 from v2.2. If you are updating from a version earlier than v2.2, please follow the v2.2 Upgrade Guide before upgrading.

ADF Application Code Review

This is only for reviewing the code that is in the "/ADF/apps/" directory, not at the site level.

  1. Download the application from the Community project page.
  2. Unzip the application zip folder.
  3. Analyze the updated app code compared to the current app code on your server.
    1. Identify any customizations that you have made to the application code to make sure these are not overwritten by the app update.
    2. A great tool to use is Beyond Compare to compare the new and current file to identify the exact lines of code that have been changed.
  4. Once this is complete, then move your app customizations into the new app code package.

Application Code

  1. Rename directory "/ADF/apps/pt_photo_gallery" to "/ADF/apps/pt_photo_gallery_v2".
  2. Rename file "/ADF/apps/pt_photo_gallery_v2/appBeanConfig.cfm" to "/ADF/apps/pt_photo_gallery_v2/appBeanConfig.cfm.old".
  3. Move the PT Photo Gallery v2.3 and into the "/ADF/apps/pt_photo_gallery/" directory.
  4. Reset the ADF.

Custom Field Types

Photo Upload Link

  1. In the site administration, check if you have the "Photo Upload Link" field registered.
    1. If yes, then identify the custom elements using the field. Open the field definition properties dialog and save.
    2. If no, then no further steps need to be taken.

Photo Category

  1. Import the Photo Category custom field type.
    1. /ADF/apps/pt_photo_gallery/exported-objects/Photo-Category-Custom-Field-Type.zip

Custom Element Updates

Navigate to the Site Administrator and open the field definitions for the following custom element.

Photo

Update the "Category" field.

  1. Open the field definitions for the "Category" field.
    1. Look at the current properties
    2. Open the properties and make note of the values in the "Field Name" and "Field Display Type" fields.
  2. Change the field type to "Photo Category".
    1. Open the properties and enter the values from the previous field type.
      1. Note the new field for "JavaScript Field ID" uses the value of the "Field Name".

Photo Category

  1. Open the field definitions for the "Photo Category" element.
  2. Edit the "reqSizeIDList" field and open the properties tab.
    1. Set the following values:
      1. Load All Available Selections: Yes
  3. Edit the "resizeSizeIDList" field and open the properties tab.
    1. Set the following values:
      1. Load All Available Selections: Yes

Custom Field Updates

Identify the custom elements within the site that are utilizing the "Photo Upload Link" custom field type.

  1. Open the element field definitions and edit the properties for the field.
    1. Set all the fields accordingly based on the element being used.

Site Level Customizations Review

This is only for reviewing the site level customizations in the "/_cs_apps/pt_photo_gallery/" 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.