Differential Sync - Revision history

Rkahn at 14:38, 6 October 2011

2011-10-06T14:38:00Z

Rkahn at 14:29, 6 October 2011

2011-10-06T14:29:37Z

Rkahn at 14:18, 6 October 2011

2011-10-06T14:18:07Z

Rkahn: Created page with 'The differentialSync function will optimally update a large set of data based on a comparison of existing data. The function takes many arguments, most notably the newOverride, u…'

2011-10-06T14:17:15Z

Created page with 'The differentialSync function will optimally update a large set of data based on a comparison of existing data. The function takes many arguments, most notably the newOverride, u…'

New page

The differentialSync function will optimally update a large set of data based on a comparison of existing data. The function takes many arguments, most notably the newOverride, updateOverride and deleteOverride; those 3 parameters can allow you to write custom code that will handle new, updates or deletions.

Parameters
*elementName - String (Required)
**The element name that we are going to sync.
*newElements - Array (Required)
**The elements that you would like to have as the result after the sync is complete
*preformDelete - Boolean
**default: false
**This will call the delete function if set to true, otherwise deletions will not be processed. This can be helpful if you want old elements to remain.
*primaryKeys - String
**List of primary keys to use in the comparision
**_pageID is a reserved word and will compare the elements pageID if it exists in the source data
**Example: "links,title" or "_pageID,title"
*ignoreFields - String
**A list of fields to ignore in the comparison.
**Example: "id,title"
*newOverride - Structure
**default:
***newOverride.bean = "csContent_1_0"
***newOverride.method = "populateContent_1_0"
**You can override this to handle all new items with your own bean/method argument. It will get called with the parameter of "data" which is a structure of the element data
*updateOverride - Structure
**default:
***newOverride.bean = "csContent_1_0"
***newOverride.method = "populateContent_1_0"
**You can override this to handle all items that changed with your own bean/method argument. It will get called with the parameter of "data" which is a structure ot the element data
*deleteOverride
*syncSourceContent
*elementCCAPIName

← Older revision		Revision as of 14:38, 6 October 2011
Line 37:		Line 37:
	**Default: arguments.elementName		**Default: arguments.elementName
	**This is the CCAPI name for the element, this is used when calling the new and update methods		**This is the CCAPI name for the element, this is used when calling the new and update methods
		+
		+
		+	Sample Call
		+	<pre>
		+	myNewElements = ArrayNew(1);
		+	myNewElements[1].values = StructNew();
		+	myNewElements[1].values.id = "1234";
		+	myNewElements[1].values.title = "title";
		+	myNewElements[1].values.description = "This should be ignored";
		+
		+	myDeleteOverride = StructNew();
		+	myDeleteOverride.bean = "myCustomBean";
		+	myDeleteOverride.method = "myCustomMethod";
		+
		+	application.ADF.ceData.differentialSync(
		+	elementName="MyElementName",
		+	newElements=myNewElements,
		+	preformDelete=true,
		+	primaryKeys="id",
		+	ignoreFields="description",
		+	deleteOverride=myDeleteOverride,
		+	elementCCAPIName="myElementCCAPINAme"
		+	);
		+	</pre>
		+	Lets walk through that, firstly we create an array of ce_data
		+	<pre>
		+	myNewElements = ArrayNew(1);
		+	myNewElements[1].values = StructNew();
		+	myNewElements[1].values.id = "1234";
		+	myNewElements[1].values.title = "title";
		+	myNewElements[1].values.description = "This should be ignored";
		+	</pre>
		+	This data could be pulled from a database and built dynamically, it could be data extracted from virtually any datasource, including CommonSpot itself. It simply needs to be formatted as an array of CE data.
		+
		+	Then we define a deletion override:
		+	<pre>
		+	myDeleteOverride = StructNew();
		+	myDeleteOverride.bean = "myCustomBean";
		+	myDeleteOverride.method = "myCustomMethod";
		+	</pre>
		+	It will utilize the application.ADF.utils.runCommand function to execute this override.
		+
		+	Then we call the meat of the differential sync with our parameters:
		+	<pre>
		+	application.ADF.ceData.differentialSync(
		+	elementName="MyElementName",
		+	newElements=myNewElements,
		+	preformDelete=true,
		+	primaryKeys="id",
		+	ignoreFields="description",
		+	deleteOverride=myDeleteOverride,
		+	elementCCAPIName="myElementCCAPINAme"
		+	);
		+	</pre>
		+	This sync will sync on the element "MyElementName", it will process the deletions using our override method. It will align items for comparision using the ID field and it will not compare the description field. It will process new and updated items using the "myElementCCAPINAme" as the ccapi element name.

@@ Line 20: / Line 20: @@
 ***newOverride.bean = "csContent_1_0"
 ***newOverride.method = "populateContent_1_0"
-**You can override this to handle all new items with your own bean/method argument. It will get called with the parameter of "data" which is a structure of the element data
+**You can override this to handle all new items with your own bean/method argument. It will get called with the parameter of "data" which is a structure of the element data. It will also get a paremter of elementName which is the ccapiName of the element.
 *'''updateOverride''' - Structure
 **default:
-***newOverride.bean = "csContent_1_0"
+***updateOverride.bean = "csContent_1_0"
-***newOverride.method = "populateContent_1_0"
+***updateOverride.method = "populateContent_1_0"
-**You can override this to handle all items that changed with your own bean/method argument. It will get called with the parameter of "data" which is a structure ot the element data
+**You can override this to handle all items that changed with your own bean/method argument. It will get called with the parameter of "data" which is a structure ot the element data. It will also get a paremter of elementName which is the ccapiName of the element.
-*'''deleteOverride'''
+*'''deleteOverride''' - Structure
-*'''syncSourceContent'''
+**default:
 *'''elementCCAPIName'''

@@ Line 2: / Line 2: @@
 Parameters
-*elementName - String (Required)
+*'''elementName''' - String (Required)
 **The element name that we are going to sync.
-*newElements - Array (Required)
+*'''newElements''' - Array (Required)
 **The elements that you would like to have as the result after the sync is complete
-*preformDelete - Boolean
+*'''preformDelete''' - Boolean
 **default: false
 **This will call the delete function if set to true, otherwise deletions will not be processed. This can be helpful if you want old elements to remain.
-*primaryKeys - String
+*'''primaryKeys''' - String
 **List of primary keys to use in the comparision
 **_pageID is a reserved word and will compare the elements pageID if it exists in the source data
 **Example: "links,title" or "_pageID,title"
-*ignoreFields - String
+*'''ignoreFields''' - String
 **A list of fields to ignore in the comparison.
 **Example: "id,title"
-*newOverride - Structure
+*'''newOverride''' - Structure
 **default:
 ***newOverride.bean = "csContent_1_0"
 ***newOverride.method = "populateContent_1_0"
 **You can override this to handle all new items with your own bean/method argument. It will get called with the parameter of "data" which is a structure of the element data
-*updateOverride - Structure
+*'''updateOverride''' - Structure
 **default:
 ***newOverride.bean = "csContent_1_0"
 ***newOverride.method = "populateContent_1_0"
 **You can override this to handle all items that changed with your own bean/method argument. It will get called with the parameter of "data" which is a structure ot the element data
-*deleteOverride
+*'''deleteOverride'''
-*syncSourceContent
+*'''syncSourceContent'''
-*elementCCAPIName
+*'''elementCCAPIName'''