View source for Upgrade Guide v1.6

== 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_Guide_v1.5.2|1.5.2 Upgrade Guide]]
* [[Upgrade_Guide_v1.5.1|1.5.1 Upgrade Guide]]
* [[Upgrade_Guide_v1.5|1.5.0 Upgrade Guide]]

== Upgrade ==
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].
# On your server, rename the "/ADF/" directory to "/ADF-1.5/".
# Create a new "/ADF/" directory.  Setup any neccessary security or permissions for the new "/ADF/" 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:
## ?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 ===
# Reset the ADF through the web browser with the following URL parameter:
## ?resetADF=1
# The reset command will add text to the top line of the page.  If you see the following text with the date/time stamp:
## ADF v1.6 has been reset successfully!
# Upgrade was successful and you are running the ADF v1.6.

=== ADF Version Output ===
# In the browser, add the following URL parameter:
## ?ADFDumpVar=application.ADF.version
# This command with output the ADF version at the top of the page.  If you see the following text:
## 1.6
# 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: 
<source lang="java">
<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>
</source>

For example, the following code will work: 

<source lang="java">
<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>
</source>

Thanks for upgrading and start enjoying the ADF!