robocaml Wiki Rss Feed

Updated Wiki: Boolean

iOnline247 — Wed, 10 Oct 2012 18:06:19 GMT

This property uses a Boolean value. An example would be:

{

LookupId: true

}

Updated Wiki: QueryOptions

iOnline247 — Mon, 27 Aug 2012 13:01:43 GMT

Function
roboCAML.QueryOptions();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
DateInUtc	No
Folder	No
IncludeMandatoryColumns	No
MeetingInstanceID	No
Paging	No ~ *See notes below*
RowLimit	No
ViewAttributes	No

Examples

roboCAML.QueryOptions({
	MeetingID: 5,
	Paging: {
		ListItemCollectionPositionNext: "something"
	},
	ViewAttributes: true,
	RowLimit: 5,
	folder: "/SomethingURL/Like",
	DateInUtc: true,
	IncludeMandatoryColumns: true
});

The method call above will generate this string:

<QueryOptions>
	<MeetingInstanceID>5</MeetingInstanceID>
	<Paging ListItemCollectionPositionNext='something' />
	<ViewAttributes Scope='Recursive' />
	<Folder>/SomethingURL/Like</Folder>
	<DateInUtc>True</DateInUtc>
	<IncludeMandatoryColumns>True</IncludeMandatoryColumns>
</QueryOptions>

***QueryOption Notes***

This method assumes SPServices usage by default. If QueryOptions are needed for a Client OM query, use roboCAML.Query() and pass in the QueryOptions.

Updated Wiki: String

iOnline247 — Fri, 15 Jun 2012 20:02:34 GMT

This property requires a string for a value. An example usage:

{
	closeCaml: "SPServices"
}

{
	closeCaml: "ClientOM"
}

Note***

XML & CAML is string based so some values can be passed into these methods as a number primitive.

Updated Wiki: String

iOnline247 — Fri, 15 Jun 2012 20:02:18 GMT

This property requires a string for a value. An example usage:

{
	closeCaml: "SPServices"
}

{
	closeCaml: "ClientOM"
}

Note***

XML & CAML is string based so some values can be passed into these methods as a number primitive.

Updated Wiki: roboCAML.Query();

iOnline247 — Fri, 11 May 2012 12:06:32 GMT

Function
roboCAML.Query();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
webURL	No
listName (Display Name)	Yes
closeCaml	No
config	Yes
OrderBy	No
QueryOptions	No
ViewFields	No

config Properties

Property Name	Required	Implementation
filter	Yes ~ see notes below	correctCAML
op (operator)	Yes	correctCAML
staticName	Yes
value	Yes ~ see notes below
LookupId	No

config Property notes***

filter - This is only required if more than one "op" is needed. Look at the examples below for clarity.
value - IsNull or IsNotNull does not require a value. Also value can be passed as a number or string.
LookupId - Only used when interacting with lookup fields and would like to use the ID instead of text within your value property.

Examples

roboCAML.Query({ 
	listName: "scripts", 
	config: [
		{ 
			op: "!=", 
			staticName: "ID", 
			value: 3 
		} 
	]
});

will generate this CAML fragment:

<Neq>
	<FieldRef Name='ID' />
	<Value Type='Counter'>3</Value>
</Neq>

Adding closeCaml to the call, will close the CAML correctly. Since the CAML strings work differently for SPServices and ClientOM, you'll need to pass that in as your value. Here's an example of that:

roboCAML.Query({ 
	listName: "scripts", 
	closeCaml: "ClientOM", 
	config: [ 
		{ 
			op: "!=", 
			staticName: "ID", 
			value: 3 
		} 
	]
});

This will generate this CAML string:

<View>
	<Query>
		<Where>
			<Neq>
				<FieldRef Name='ID' />
				<Value Type='Counter'>3</Value>
			</Neq>
		</Where>
	</Query>
</View>

If closeCaml: "SPServices" were to be passed into this method, the resulting CAML would look like this:

<Query>
	<Where>
		<Neq>
			<FieldRef Name='ID' />
			<Value Type='Counter'>3</Value>
		</Neq>
	</Where>
</Query>

roboCAML.Query Notes

Post your favorite queries made with roboCAML in this discussion thread.

Updated Wiki: Home

iOnline247 — Sun, 15 Apr 2012 10:01:55 GMT

Project Description

roboCAML is a jQuery based module that will create dynamic CAML for you. It works entirely client side and requires no server install. This module compliments SPServices as well as any Client Object Model (JSOM) code you may be scripting.

If you have any questions or ideas on how to improve roboCAML, let's have a chat...

Updated Wiki: Home

iOnline247 — Wed, 22 Feb 2012 19:36:14 GMT

Project Description

So you can easily learn how to incorporate this into your projects, feel free to use the live demo.

If you have any questions or ideas on how to improve roboCAML, let's have a chat...

Updated Wiki: roboCAML.BatchCMD();

iOnline247 — Wed, 15 Feb 2012 18:08:17 GMT

Function
roboCAML.BatchCMD();

Functionality

This method will generate XML for CRUD operations within SharePoint.

Parameters (Properties)

Parameter Name	Required
batchCMD	Yes ~See notes***
IDs	Yes ~See Delete example***
updates	Yes ~See Update example***
valuePairs	Yes ~See New/Update example***

Examples

Deleting Items

roboCAML.BatchCMD({
	//Required parameter *in this scenario*
	batchCMD: "Delete",

	//Required parameter *in this scenario*
	IDs: [1,2,3]
});

The resulting string will look like:

<Batch OnError='Continue'>
	<Method ID='3' Cmd='Delete'>
		<Field Name='ID'>3</Field>
	</Method>
	<Method ID='2' Cmd='Delete'>
		<Field Name='ID'>2</Field>
	</Method>
	<Method ID='1' Cmd='Delete'>
		<Field Name='ID'>1</Field>
	</Method>
</Batch>

New Items

roboCAML.BatchCMD({
	//Required parameter *in this scenario*
	batchCMD: "New",

	//Required parameter *in this scenario*
	valuePairs: [["PersonnelNameLookup", 1, "ModuleNotes", "ModuleNotes", "Description", "Googly Glop"], ["ListUID", 3]] //Static Column Name, Value
});

The resulting string will look like:

<Batch OnError='Continue'>
	<Method ID='1' Cmd='New'>
		<Field Name='PersonnelNameLookup'>1</Field>
		<Field Name='ModuleNotes'>ModuleNotes</Field>
		<Field Name='Description'>Googly Glop</Field>
	</Method>
	<Method ID='2' Cmd='New'>
		<Field Name='ListUID'>3</Field>
	</Method>
</Batch>

Update Items
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

// ~ Recommended way to use BatchCMD

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

roboCAML.BatchCMD({
	//batchCMD is optional ~ Update is the default value.

	//batchCMD: "Update",
	//If batchCMD isn't set, it can be passed in individually for each method.

	updates: [
		{
			//Notice batchCMD isn't present...
			//Static Column Name, Value
			valuePairs: ["Title", "Numero Tres", "PercentComplete", 1, "Boolean", 0, "ID", 3]
		},
		{
			//Defaults to Update anyway. No need to pass it.
			batchCMD: "Update",
			valuePairs: ["ID", 4, "Title", "Item4", "Boolean", 0]
		},
		{
			batchCMD: "New",
			valuePairs: ["Title", "Something New", "PercentComplete", 1]
		},
		{
			batchCMD: "Delete",
			ID: 6
		}
	]
});

This will result in:

<Batch OnError='Continue'>
	<Method ID='1' Cmd='Update'>
		<Field Name='Title'>Numero Tres</Field>
		<Field Name='PercentComplete'>1</Field>
		<Field Name='Boolean'>0</Field>
		<Field Name='ID'>3</Field>
	</Method>
	<Method ID='2' Cmd='Update'>
		<Field Name='ID'>4</Field>
		<Field Name='Title'>Item4</Field>
		<Field Name='Boolean'>0</Field>
	</Method>
	<Method ID='3' Cmd='New'>
		<Field Name='Title'>Something New</Field>
		<Field Name='PercentComplete'>1</Field>
	</Method>
	<Method ID='4' Cmd='Delete'>
		<Field Name='ID'>6</Field>
	</Method>
</Batch>

BatchCMD Notes***

The main reason I recommend the last example is for consistency. It's also more flexible and will allow you to do more than one type of Operation per Web Service call. If you look over the generated string, all allowed operations are within the generated string ~Update, New, Delete.

There is value in the other examples of this method. I suggest to use them and determine which you like best. If there is something you'd like to see here, feel free to post your thoughts in the Discussions.

Updated Wiki: Home

iOnline247 — Tue, 14 Feb 2012 19:09:28 GMT

Project Description

There will be a live demo built soon, so you can easily learn how to incorporate this into your projects.

If you have any questions or ideas on how to improve roboCAML, let's have a chat...

Updated Wiki: Documentation

iOnline247 — Tue, 14 Feb 2012 16:55:26 GMT

Core Methods

Function Name	Short Description	Introduced
roboCAML.BatchCMD();	This method is used to create the create the XML needed to Add/Update/Delete items via SharePoint's Web Services.	0.2.2
roboCAML.Query();	This method will create CAML strings to use with SharePoint's Client OM and Web Services.	0.2.2

Utilities

Function Name	Short Description	Introduced
roboCAML.AddCamlTags();	~~Useful for building CAML fragments manually. Used internally by roboCAML.Query() as well.~~ This method has been deprecated in v0.4+	0.3
roboCAML.OrderBy();	Useful for building an <OrderBy> CAML fragment.	0.2.2
roboCAML.QueryOptions();	Useful for building an <QueryOptions> CAML fragment. *Use roboCAML.Query() for compatibility w/ Client OM.*	0.3
roboCAML.ViewFields();	Useful for building an <ViewFields> CAML fragment.	0.2.2

Updated Wiki: OrderBy

iOnline247 — Mon, 13 Feb 2012 20:41:44 GMT

Function
roboCAML.OrderBy();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
*staticName(s)*	Yes

Example

roboCAML.OrderBy({
	MyColumn: false,
	ID: true
});

This method call will generate the CAML fragment below:

<OrderBy>
	<FieldRef Name='MyColumn' Ascending='False' />
	<FieldRef Name='ID' Ascending='True' />
</OrderBy>

roboCAML.OrderBy Notes***

The parameter name you'll use for this method is completely up to the list schema that is used. The value can also be passed in as a string as well: "True" or "False".

Updated Wiki: OrderBy

iOnline247 — Mon, 13 Feb 2012 20:41:30 GMT

Function
roboCAML.OrderBy();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
*staticName(s)*	Yes

Example

roboCAML.OrderBy({
	MyColumn: false,
	ID: true
});

This method call will generate the CAML fragment below:

<OrderBy>
	<FieldRef Name='MyColumn' Ascending='False' />
	<FieldRef Name='ID' Ascending='True' />
</OrderBy>

roboCAML.OrderBy Notes***

The parameter name you'll use for this method is completely up to the list schema that is used. The value can also be passed in as a string as well: "True" or "False".

Updated Wiki: OrderBy

iOnline247 — Mon, 13 Feb 2012 20:40:45 GMT

Function
roboCAML.OrderBy();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
*staticName(s)*	Yes

Example

roboCAML.OrderBy({
	MyColumn: false,

	ID: true

});

This method call will generate the CAML fragment below:

<OrderBy>
	<FieldRef Name='MyColumn' Ascending='False' />
	<FieldRef Name='ID' Ascending='True' />
</OrderBy>

roboCAML.OrderBy Notes***

The parameter name you'll use for this method is completely up to the list schema that is used. The value can also be passed in as a string as well: "True" or "False".

Updated Wiki: OrderBy

iOnline247 — Mon, 13 Feb 2012 20:40:08 GMT

Function
roboCAML.OrderBy();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
*staticName(s)*	Yes

Example

roboCAML.OrderBy({ MyColumn: false, ID: true });

This method call will generate the CAML fragment below:

<OrderBy>
	<FieldRef Name='MyColumn' Ascending='False' />
	<FieldRef Name='ID' Ascending='True' />
</OrderBy>

roboCAML.OrderBy Notes***

The parameter name you'll use for this method is completely up to the list schema that is used. The value can also be passed in as a string as well: "True" or "False".

Updated Wiki: OrderBy

iOnline247 — Mon, 13 Feb 2012 20:39:43 GMT

Function
roboCAML.OrderBy();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
*staticName(s)*	Yes

Example

roboCAML.OrderBy({ MyColumn: false, ID: true });

This method call will generate the CAML fragment below:

<OrderBy>
	<FieldRef Name='MyColumn' Ascending='False' />
	<FieldRef Name='ID' Ascending='True' />
</OrderBy>

roboCAML.OrderBy Notes***

The parameter name you'll use for this method is completely up to the list schema that is used. The value can also be passed in as a string as well: "True" or "False".

Updated Wiki: QueryOptions

iOnline247 — Mon, 13 Feb 2012 20:36:32 GMT

Function
roboCAML.QueryOptions();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
DateInUtc	No
Folder	No
IncludeMandatoryColumns	No
MeetingInstanceID	No
Paging	No ~ *See notes below*
RowLimit	No
ViewAttributes	No

Examples

roboCAML.QueryOptions({
	MeetingID: 5,
	Paging: {
		ListItemCollectionPositionNext: "something"
	},
	ViewAttributes: true,
	RowLimit: 5,
	folder: "/SomethingURL/Like",
	DateInUtc: true,
	IncludeMandatoryColumns: true
});

The method call above will generate this string:

<QueryOptions>
	<MeetingInstanceID>5</MeetingInstanceID>
	<Paging ListItemCollectionPositionNext='something' />
	<ViewAttributes Scope='Recursive' />
	<Folder>/SomethingURL/Like</Folder>
	<DateInUtc>True</DateInUtc>
	<IncludeMandatoryColumns>True</IncludeMandatoryColumns>
</QueryOptions>

***QueryOption Notes***

This method assumes SPServices usage by default. If QueryOptions are needed for a Client OM query, use roboCAML.Query() and pass in the QueryOptions.

The Paging parameter will accept a number or an object. This parameter doesn't do anything whatsoever unless used within a server-side control. I've added it to roboCAML, so the Online CAML Generator wil be more robust.

Updated Wiki: QueryOptions

iOnline247 — Mon, 13 Feb 2012 20:35:55 GMT

Function
roboCAML.QueryOptions();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
DateInUtc	No
Folder	No
IncludeMandatoryColumns	No
MeetingInstanceID	No
Paging	No ~ *See notes below*
RowLimit	No
ViewAttributes	No

Examples

roboCAML.QueryOptions({
	MeetingID: 5,
	Paging: {
		ListItemCollectionPositionNext: "something"
	},
	ViewAttributes: true,
	RowLimit: 5,
	folder: "/SomethingURL/Like",
	DateInUtc: true,
	IncludeMandatoryColumns: true
});

The method call above will generate this string:

<QueryOptions>
	<MeetingInstanceID>5</MeetingInstanceID>
	<Paging ListItemCollectionPositionNext='something' />
	<ViewAttributes Scope='Recursive' />
	<Folder>/SomethingURL/Like</Folder>
	<DateInUtc>True</DateInUtc>
	<IncludeMandatoryColumns>True</IncludeMandatoryColumns>
</QueryOptions>

QueryOption Notes***

This method assumes SPServices usage by default. If QueryOptions are needed for a Client OM query, use roboCAML.Query() and pass in the QueryOptions.

Updated Wiki: QueryOptions

iOnline247 — Mon, 13 Feb 2012 20:32:23 GMT

Function
roboCAML.QueryOptions();

Functionality

This method will generate CAML strings for use in retrieving data from SharePoint.

Parameters (Properties)

Parameter Name	Required
DateInUtc	No
Folder	No
IncludeMandatoryColumns	No
MeetingInstanceID	No
Paging	No ~ *See notes below*
RowLimit	No
ViewAttributes	No

Examples

roboCAML.QueryOptions({
	MeetingID: 5,
	Paging: {
		ListItemCollectionPositionNext: "something"
	},
	ViewAttributes: true,
	RowLimit: 5,
	folder: "/SomethingURL/Like",
	DateInUtc: true,
	IncludeMandatoryColumns: true
});

The method call above will generate this string:

<QueryOptions>
	<MeetingInstanceID>5</MeetingInstanceID>
	<Paging ListItemCollectionPositionNext='something' />
	<ViewAttributes Scope='Recursive' />
	<Folder>/SomethingURL/Like</Folder>
	<DateInUtc>True</DateInUtc>
	<IncludeMandatoryColumns>True</IncludeMandatoryColumns>
</QueryOptions>

If using roboCAML.QueryOptions() with Client OM, pass in the optional parameter of camlType. Here's an example:

roboCAML.QueryOptions({
	camlType: "ClientOM",
	MeetingID: 5,
	Paging: 100,
	ViewAttributes: true,
	RowLimit: 5,
	folder: "/SomethingURL/Like",
	DateInUtc: true,
	IncludeMandatoryColumns: true
});

The method call above will generate this string:

<Folder>/SomethingURL/Like</Folder><Paging>100</Paging><MeetingInstanceID>5</MeetingInstanceID><ViewAttributes Scope='Recursive' /><DateInUtc>True</DateInUtc><IncludeMandatoryColumns>True</IncludeMandatoryColumns>

QueryOption Notes***

This method assumes SPServices usage by default. The Paging parameter will accept a number or an object. This parameter doesn't do anything whatsoever unless used within a server-side control. I've added it to roboCAML, so the Online CAML Generator wil be more robust.

Updated Wiki: Documentation

iOnline247 — Mon, 13 Feb 2012 20:30:16 GMT

Core Methods

Function Name	Short Description	Introduced
roboCAML.BatchCMD();	This method is used to create the create the XML needed to Add/Update/Delete items via SharePoint's Web Services.	0.2.2
roboCAML.Query();	This method will create CAML strings to use with SharePoint's Client OM and Web Services.	0.2.2

Utilities

Function Name	Short Description	Introduced
roboCAML.AddCamlTags();	~~Useful for building CAML fragments manually. Used internally by roboCAML.Query() as well.~~ This method has been deprecated in v0.4+	0.3
roboCAML.OrderBy();	Useful for building an <OrderBy> CAML fragment.	0.2.2
roboCAML.QueryOptions();	Useful for building an <QueryOptions> CAML fragment. *Use roboCAML.Query for compatibility w/ Client OM.*	0.3
roboCAML.ViewFields();	Useful for building an <ViewFields> CAML fragment.	0.2.2

Updated Wiki: Documentation

iOnline247 — Mon, 13 Feb 2012 20:27:57 GMT

Core Methods

Function Name	Short Description	Introduced
roboCAML.BatchCMD();	This method is used to create the create the XML needed to Add/Update/Delete items via SharePoint's Web Services.	0.2.2
roboCAML.Query();	This method will create CAML strings to use with SharePoint's Client OM and Web Services.	0.2.2

Utilities

Function Name	Short Description	Introduced
roboCAML.AddCamlTags();	~~Useful for building CAML fragments manually. Used internally by roboCAML.Query() as well.~~ This method has been deprecated in v0.4+	0.3
roboCAML.OrderBy();	Useful for building an <OrderBy> CAML fragment.	0.2.2
roboCAML.QueryOptions();	Useful for building an <QueryOptions> CAML fragment. Compatible w/ Client OM.	0.3
roboCAML.ViewFields();	Useful for building an <ViewFields> CAML fragment.	0.2.2