Difference between revisions of "Upgrade Guide v1.6"

From ADF Docs
Jump to: navigation, search
(→‎Forms Library)
 
(13 intermediate revisions by 2 users not shown)
Line 6: Line 6:
 
* [[Upgrade_Guide_v1.5.1|1.5.1 Upgrade Guide]]
 
* [[Upgrade_Guide_v1.5.1|1.5.1 Upgrade Guide]]
 
* [[Upgrade_Guide_v1.5|1.5.0 Upgrade Guide]]
 
* [[Upgrade_Guide_v1.5|1.5.0 Upgrade Guide]]
−
 
  
 
== Upgrade ==
 
== Upgrade ==
 
Follow the steps below to upgrade the ADF directory:
 
Follow the steps below to upgrade the ADF directory:
 
# Download the ADF v1.6 from the [http://community.paperthin.com/projects/ADF/ Community site project page].
 
# Download the ADF v1.6 from the [http://community.paperthin.com/projects/ADF/ Community site project page].
−
# On your server, rename the "ADF" directory to "ADF-1.5".
+
# On your server, rename the "/ADF/" directory to "/ADF-1.5.2/".
−
# Unzip the ADF v1.6 download and make sure is named as "ADF" on your server.
+
# Create a new "/ADF/" directory.  Setup any neccessary security or permissions for the new "/ADF/" directory.
−
# Copy all the applications from the "/ADF-1.5/apps/" directory to the "/ADF/apps" directory.
+
# Export the download ADF zip folder into the "/ADF/" directory.
 +
# Copy the contents of the "/ADF_1.5.2/apps/" directory into the "/ADF/apps/" directory.
 
# Reset the ADF through the web browser with the following URL parameter:
 
# Reset the ADF through the web browser with the following URL parameter:
 
## ?resetADF=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.
+
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 ==
 
== Validate Upgrade ==
Line 35: Line 35:
 
# Upgrade was successful and you are running the ADF v1.6.
 
# Upgrade was successful and you are running the ADF v1.6.
  
−
Thanks for upgrading and start enjoying the ADF!
+
 
 +
== Post Upgrade Steps ==
 +
 
 +
=== Library Updates ===
 +
The following library component functions were moved to the correct component version.  If you have custom code referencing these functions within the specific library component, then you'll need to update your library component reference.  If you are referencing these functions through the ADF application space, then no updates are needed.
 +
 
 +
Lib Components Updates:
 +
* CSData 1.1 functions moved to CSData 1.2:
 +
** getUserNameFromUserID
 +
** getCustomMetadataFieldParamValue
 +
** getCustomMetadatawithFieldLabelsKeys
 +
* CSSecurity 1.1 functions moved to CSSecurity 1.2:
 +
** isValidAuthToken
 +
* Scripts 1.1 functions moved to Scripts 1.2:
 +
** loadFileUploader
 +
** loadJSONJS
 +
** loadJQueryCapty
 +
** loadJQueryMultiselect
 +
** loadJQueryPlupload
 +
** loadJQuerySWFUpload
 +
** loadJQueryTemplates
 +
** loadJQueryUIForm
 +
** loadMathUUID
 +
** loadTipsy
 +
** loadJQueryEasing
 +
** loadJQueryFancyBox
 +
** loadJQueryMouseWheel
 +
* Utils 1.0 functions moved to Utils 1.2:
 +
** pageRedirect
 +
** buildPaginationStruct
 +
** fileLastModifiedDateTime
 +
 
 +
=== Forms Library ===
 +
If your site is running CommonSpot 8.0.1 or higher, then you'll need to make sure any custom code utilizing the Forms library calling the "renderAddEditForm" function has been updated for the 8.0.1 security enhancements.  The 8.0.1 security enhancements are documented in the [http://www.paperthin.com/support/knowledgebase/doclibrary/index.cfm Summer 2012 SP1 Release Notes].
 +
 
 +
This security updates prevents JavaScript "alert" or "confirm" commands to be passed into the Forms.renderAddEditForm "customizedFinalHtml" argument string. 
 +
 
 +
For example, the following code will '''not''' work:
 +
<pre>
 +
<cfsavecontent variable="returnHMTL">
 +
<cfoutput>
 +
<script type="text/javascript">
 +
alert("Form Submitted Alert Message");
 +
</script>
 +
<p>Thank You for submitting the form.</p>
 +
</cfoutput>
 +
</cfsavecontent>
 +
<cfoutput>
 +
#application.ADF.forms.renderAddEditForm(formID=myCEFormID,
 +
dataPageId=meCEDataPageID,
 +
customizedFinalHtml=returnHMTL)#
 +
</cfoutput>
 +
</pre>
 +
 
 +
For example, the following code will work:
 +
 
 +
<pre>
 +
<cfsavecontent variable="returnHMTL">
 +
<cfoutput>
 +
<p>Thank You for submitting the form.</p>
 +
</cfoutput>
 +
</cfsavecontent>
 +
<cfoutput>
 +
#application.ADF.forms.renderAddEditForm(formID=myCEFormID,
 +
dataPageId=meCEDataPageID,
 +
customizedFinalHtml=returnHMTL)#
 +
</cfoutput>
 +
</pre>
 +
 
 +
Please check your custom code and custom ADF applications to resolve any errors from this security enhancement.
 +
 
 +
The ADF v1.6 and the latest ADF application versions have been updated for this security enhancement.  You may need to upgrade your ADF applications.

Latest revision as of 21:25, 25 September 2014

Current Version

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

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

Upgrade

Follow the steps below to upgrade the ADF directory:

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

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


Post Upgrade Steps

Library Updates

The following library component functions were moved to the correct component version. If you have custom code referencing these functions within the specific library component, then you'll need to update your library component reference. If you are referencing these functions through the ADF application space, then no updates are needed.

Lib Components Updates:

  • CSData 1.1 functions moved to CSData 1.2:
    • getUserNameFromUserID
    • getCustomMetadataFieldParamValue
    • getCustomMetadatawithFieldLabelsKeys
  • CSSecurity 1.1 functions moved to CSSecurity 1.2:
    • isValidAuthToken
  • Scripts 1.1 functions moved to Scripts 1.2:
    • loadFileUploader
    • loadJSONJS
    • loadJQueryCapty
    • loadJQueryMultiselect
    • loadJQueryPlupload
    • loadJQuerySWFUpload
    • loadJQueryTemplates
    • loadJQueryUIForm
    • loadMathUUID
    • loadTipsy
    • loadJQueryEasing
    • loadJQueryFancyBox
    • loadJQueryMouseWheel
  • Utils 1.0 functions moved to Utils 1.2:
    • pageRedirect
    • buildPaginationStruct
    • fileLastModifiedDateTime

Forms Library

If your site is running CommonSpot 8.0.1 or higher, then you'll need to make sure any custom code utilizing the Forms library calling the "renderAddEditForm" function has been updated for the 8.0.1 security enhancements. The 8.0.1 security enhancements are documented in the Summer 2012 SP1 Release Notes.

This security updates prevents JavaScript "alert" or "confirm" commands to be passed into the Forms.renderAddEditForm "customizedFinalHtml" argument string.

For example, the following code will not work: 

<cfsavecontent variable="returnHMTL">
	<cfoutput>
		<script type="text/javascript">
			alert("Form Submitted Alert Message");
		</script>
		<p>Thank You for submitting the form.</p>
	</cfoutput>
</cfsavecontent>
<cfoutput>
	#application.ADF.forms.renderAddEditForm(formID=myCEFormID,
						 dataPageId=meCEDataPageID,
						 customizedFinalHtml=returnHMTL)#
</cfoutput>

For example, the following code will work: 

<cfsavecontent variable="returnHMTL">
	<cfoutput>
		<p>Thank You for submitting the form.</p>
	</cfoutput>
</cfsavecontent>
<cfoutput>
	#application.ADF.forms.renderAddEditForm(formID=myCEFormID,
						 dataPageId=meCEDataPageID,
						 customizedFinalHtml=returnHMTL)#
</cfoutput>

Please check your custom code and custom ADF applications to resolve any errors from this security enhancement.

The ADF v1.6 and the latest ADF application versions have been updated for this security enhancement. You may need to upgrade your ADF applications.

Retrieved from "http://community.paperthin.com/adf-docs/index.php?title=Upgrade_Guide_v1.6&oldid=6833"