roboCAML

Reopened Issue: List Caching doesn't work cross site [921]

iOnline247 — Fri, 14 Jun 2013 07:13:53 GMT

If another site is used and the same list name has already been queried previously, the caching mechanism does not query the correct list and pulls from the cache instead.

Closed Issue: List Caching doesn't work cross site [921]

iOnline247 — Thu, 16 May 2013 02:43:57 GMT

If another site is used and the same list name has already been queried previously, the caching mechanism does not query the correct list and pulls from the cache instead.

Updated Wiki: Boolean

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

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

{

LookupId: true

}

New Post: I think this is what I need...

PirateEric — Thu, 04 Oct 2012 15:37:19 GMT

I'll keep playing around with it and see if it can get me what I want.

As a suggestion, perhaps it could be constructed so that we could define the nesting in a "mathematical" way, like (A && B) && (C || D) where A, B, C, and D would be object references. Not sure if something like that would help in the construction of the nesting. That's where the CAML builders like BIWUG and Strammit fail in that yes they generate CAML, but it isn't the intended CAML based on the right logic.

New Post: I think this is what I need...

iOnline247 — Thu, 04 Oct 2012 01:17:08 GMT

I see it in the source here:

http://robocaml.codeplex.com/SourceControl/changeset/view/19629#186715

You are right about the nested query and the output of roboCAML. It's not easy, CAML gives me a headache... I am working on it though, just not sure when it'll be done.

Cheers,
Matt

New Post: I think this is what I need...

PirateEric — Thu, 04 Oct 2012 00:45:29 GMT

It only showed recursive in the options and in the source so I wasn't sure.

Thinking about this more though, a mix of hard coded and dynamic built would result in invalid CAML would it not? The nesting of the Ands and such would get out of whack depending on how many contains operators get passed through.

New Post: I think this is what I need...

iOnline247 — Thu, 04 Oct 2012 00:16:15 GMT

Sure is. Pass it in as a QueryOption property of your .Query() call. Looking at the docs, it appears I need to update them. I only offer a RecursiveAll option.

Cheers,
Matt

New Post: I think this is what I need...

PirateEric — Wed, 03 Oct 2012 23:49:39 GMT

Yes, that part would be static.

Is RecursiveAll an option? If not, I can keep those hard coded too.

I'll give it a try.

New Post: I think this is what I need...

iOnline247 — Wed, 03 Oct 2012 23:29:09 GMT

I've been working on nested queries in the background. I haven't had much time to invest in getting them working right, although it's definitely in the works.

roboCAML will handle your N number of <Contains> however. If this portion isn't dynamic:

           "<And><And>"+
              "<Or>"+
                  "<IsNull><FieldRef Name='StickyDate' /></IsNull>"+
                  "<Lt><FieldRef Name='StickyDate' /><Value Type='DateTime'><Today /></Value></Lt>"+
              "</Or>"+
              "<Leq><FieldRef Name='PubDate' /><Value Type='DateTime'><Today /></Value></Leq>"+
           "</And>"+

then you should be able to use the library and make your life easier. You could use the library to handle the <Contains> and then concat the other portion of this query.

Hope that helps!

Cheers,
Matt

New Post: I think this is what I need...

PirateEric — Wed, 03 Oct 2012 23:01:21 GMT

I'm working on something where I think I can make use of the roboCAML library. I haven't used it before and I'm not sure if it'll do what I want. I'll give you the backstory. I'm working on a page library with audience targetting. I need to be able to do a GetListItems call to this page library to fetch the items that are targetted to the user.

I do have some server side code that will be sending me the audiences of the current user, which I'm storing in an array. My thought is instead of fetching a slew of items, looping through them to see if the audience guids match which will add a lot of extra data being returned, make it a dynamic CAML query with roboCAML.

My CAML is already getting pretty hairy and I'm wondering if this will help or hurt.

One of my CAML queries is below, I'd need to add N number of contains clauses for the dynamic number of GUIDs I get back from the server to properly fetch the proper items.

iquery = "<Query><Where>"+
           "<And><And>"+
              "<Or>"+
                  "<IsNull><FieldRef Name='StickyDate' /></IsNull>"+
                  "<Lt><FieldRef Name='StickyDate' /><Value Type='DateTime'><Today /></Value></Lt>"+
              "</Or>"+
              "<Leq><FieldRef Name='PubDate' /><Value Type='DateTime'><Today /></Value></Leq>"+
           "</And>"+
           "<Contains><FieldRef Name='ArticleTages' /><Value Type='TaxonomyFieldTypeMulti'>"+value+"</Value></Contains>"+
        "</And></Where><OrderBy><FieldRef Name='PubDate' Ascending='FALSE' /></OrderBy></Query>"

Created Issue: Approve Items with BatchCMD [1124]

iOnline247 — Tue, 02 Oct 2012 15:07:26 GMT

"" +
"" + projectID + "" +
"0" +
"";

Figure out a clean way of adding the Cmd='Moderate' to the foray.

Source code checked in, #19629

Project Collection Service Accounts — Mon, 01 Oct 2012 20:29:21 GMT

Upgrade: New Version of LabDefaultTemplate.xaml. To upgrade your build definitions, please visit the following link: http://go.microsoft.com/fwlink/?LinkId=254563

Source code checked in, #19628

Project Collection Service Accounts — Mon, 01 Oct 2012 20:27:32 GMT

Checked in by server upgrade

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.

New Post: Filtered config options based on variable value

iOnline247 — Tue, 19 Jun 2012 18:47:00 GMT

When creating something like this, I like to create my object initially instead of calling the function and passing the object as a parameter. This will allow you more flexibility with the "config" portion. An example of that would be:

if ($(boxesValues).contains("Company")){
	config.push({
		filter: "||",
		op: "=",
		staticName: "CorpCalCategory",
		value: "Company"
	});
}

With that said, I've updated your code and have totally *NOT* tested it. It should give you a good example of how to use this library in a dynamic way:

//Polyfill in case toISOString doesn't exist

//You may have to tweak this function to produce the correct result
//I've not tested this at all...
if ( !Date.prototype.toISOString ) {
	Date.prototype.toISOString = function ( d ) {
		function pad( n ) {
			return n < 10 ? 
				'0'+n : 
				n
			;
		}
		return d.getUTCFullYear()+'-'
			+ pad(d.getUTCMonth()+1)+'-'
			+ pad(d.getUTCDate())+'T'
			+ pad(d.getUTCHours())+':'
			+ pad(d.getUTCMinutes())+':'
			+ pad(d.getUTCSeconds())+'Z'
		;
	}
}

$(document).ready(function() {
	var config = [],
		camlOpts = {
			listName: "CEEP-CoporateCalendar",
			closeCaml: "SPServices",
			OrderBy: {
				EventDate: true
			}
		},
		currDate = new Date()
	;
	// go button functionality
	$("#calFilterGo").click(function(){
		var boxesChecked = $("input:checkbox:checked");
		// setup local array variable
		var boxesValues=[];
		boxesChecked.each(function(index){
			boxesValues[index]=boxesChecked[index].value;
		});
		
		//Build up config options
		config.push({
			filter: "&&",
			op: ">=",
			staticName: "EventDate",
			value: currDate.toISOString()
		});

		if ( $(boxesValues).contains("Company") ) {
			config.push({
				filter: "||",
				op: "=",
				staticName: "CorpCalCategory",
				value: "Company"
			});
		}
		
		config.push({
				filter: "||",
				op: "=",
				staticName: "CorpCalCategory",
				value: "Volunteer Opportunities"
			},
			{
				filter: "||",
				op: "=",
				staticName: "CorpCalCategory",
				value: "Customer"
			},
			{
				filter: "||",
				op: "=",
				staticName: "CorpCalCategory",
				value: "MAP"
			},
			{
				filter: "||",
				op: "=",
				staticName: "CorpCalCategory",
				value: "WAP"
			},
			{
				filter: "||",
				op: "=",
				staticName: "CorpCalCategory",
				value: "TEAM"
			}
		);
		
		//Stuff config array into camlOpts
		camlOpts.config = config;
		
		// generate CAML using roboCAML sending array along with it
		generateCAML(camlOpts);
	});
});

function generateCAML(camlOpts) {
	alert("into CAML builder");
	calFilterVar = roboCAML.Query( camlOpts );
	// clear previous items before loading new function
	$("#filteredCalendarView").empty();
	// load new function with correct caml variable
	getFilteredCalendar(calFilterVar);
}

When starting out with code, it's much easier to start small and then add complexities. It may be very helpful for you to try and get the CAML to generate first, then add the dynamic portion into your script.

Let me know how it goes and if you have specific questions about the syntax.

Cheers,

Matt

New Post: Filtered config options based on variable value

JoseyNeidhart — Tue, 19 Jun 2012 15:50:16 GMT

Hi Matt. I'm trying to implement your library into the solution I posted to SPServices' discussion board and I'm wondering how you can filter your CAML segments based on if another variable contains X. I'm sure I'm overlooking a javascript rule so any advice is welcome.

$(document).ready(function() {

// go button functionality
$("#calFilterGo").click(function(){
var boxesChecked = $("input:checkbox:checked");
// setup local array variable
var boxesValues=[];
boxesChecked.each(function(index){
boxesValues[index]=boxesChecked[index].value;
});
// generate CAML using roboCAML sending array along with it
generateCAML(boxesValues);
});

});

function generateCAML(boxesValues) {
alert("into CAML builder");
calFilterVar = (
roboCAML.Query({
listName: "CEEP-CoporateCalendar",
closeCaml: "SPServices",
OrderBy: {
EventDate: true
},
config: [
{
filter: "&&",
op: ">=",
staticName: "EventDate",
value: [Today]
},
if ($(boxesValues).contains("Company")){
{
filter: "||",
op: "=",
staticName: "CorpCalCategory",
value: "Company"
},
}
{
filter: "||",
op: "=",
staticName: "CorpCalCategory",
value: "Volunteer Opportunities"
},
{
filter: "||",
op: "=",
staticName: "CorpCalCategory",
value: "Customer"
},
{
filter: "||",
op: "=",
staticName: "CorpCalCategory",
value: "MAP"
},
{
filter: "||",
op: "=",
staticName: "CorpCalCategory",
value: "WAP"
},
{
filter: "||",
op: "=",
staticName: "CorpCalCategory",
value: "TEAM"
}
]
})
);
// clear previous items before loading new function
$("#filteredCalendarView").empty();
// load new function with correct caml variable
getFilteredCalendar(calFilterVar);
}

The variable is derived from some script generating some HTML checkboxes like so:

function AddFilterAreaHTML(){	
	// find the element with the ID below and append the following to its tag
	$("#CalFilter").append( "<h3 class='CalFilterHead'>Corporate Calendar</h3>"+
							"<input type='checkbox' name='CompanyFilter' id='CompCB' value='Company' checked='checked'/> Company<br/>" +
							"<input type='checkbox' name='VolunteerFilter' id='VolCB' value='Volunteer Opportunities' checked='checked'/> Volunteer Opportunities<br/>" +
							"<input type='checkbox' name='CustomerFilter' id='CustCB' value='Customer' checked='checked'/> Customer <br/>" +
							"<input type='checkbox' name='MAPFilter' id='MAPCB' value='MAP' checked='checked'/> MAP<br/>" +
							"<input type='checkbox' name='WAPFilter' id='WAPCB' value='WAP' checked='checked'/> WAP<br/>" +
							"<input type='checkbox' name='TEAMFilter' id=TEAMCB' value='TEAM' checked='checked'/> TEAM<br/>"+
							"<a class='GlobalButton3_GY' href='#' id='calFilterGo'><span>Go</span></a>"
	);
}

Closed Issue: ViewFields, OrderBy, QueryOptions can't be added to a closed query [916]

iOnline247 — Mon, 18 Jun 2012 19:54:06 GMT

Has to be added or roboCAML.Query would be severely handicapped.
Comments:

These items have been tested and verified to work.

Closed Task: Add more options to roboCAML.Query [912]

iOnline247 — Mon, 18 Jun 2012 19:54:05 GMT

Query method needs to handle <OrderBy>, <ViewFields>, <QueryOptions>.

Also need to investigate if '<View Scope=\'RecursiveAll\'>' is valid within CAML queries and JSOM as suggested here:
http://msdn.microsoft.com/de-de/library/hh372944.aspx
Comments:

These items have been tested and verified to work.

Closed Feature: Add caching for GetList() [550]

iOnline247 — Mon, 18 Jun 2012 19:54:04 GMT

Once this operation is complete, the list schema should stay in RAM for faster access.
Comments:

These items have been tested and verified to work.

Closed Issue: API change for roboCAML.Query [552]

iOnline247 — Mon, 18 Jun 2012 19:54:04 GMT

In it's current form, creating queries can be a bit convoluted. Here's an example:

camlQuery = "<Query><Where>" +
roboCAML.Query({
listName: "SomeListName",
config:
[
{
filter: "&&",
op: "=",
staticName: "ListUID",
value: ListID,
LookupId: true
},
{
filter: "||",
op: "=",
staticName: "Status",
value: Statuses[STATUS_SELECTED],
LookupId: true
},
{
filter: "||",
op: "=",
staticName: "Status",
value: Statuses[STATUS_EVAL],
LookupId: true
},
{
op: "=",
staticName: "Status",
value: 0, //Handles the none option
LookupId: true
}
]
}) +
"</Where></Query>";

With the Query working as is, it leaves a lot to be desired.

Proposed change:
Add defaults to roboCAML. These will default the query to be wrapped automatically with <Where> & <Query> tags. If default is set to Client OM, the query will be adjusted accordingly.

Add an OrderBy property. This should accept a simple array like you would normally use or the full roboCAML.OrderBy() call.
Comments:

These items have been tested and verified to work.