July 2013 – EdinKapic.com

SPSiteDataQuery and Managed Navigation Filtering

In this post I’ll highlight my recent "battle" with SPSiteDataQuery and Managed Metadata used for cross-site navigation, with the hope that someone will find it useful and avoid banging your head against a wall.

The Requirements

The site I was working on has a whole hierarchy of subsites and every subsite has different document libraries. The libraries use a single content type for the documents that are uploaded to them. I also use Content Organizer to automatically classify the uploaded document to the right site and document library. (I wrote about that few weeks ago).

What I wanted to achieve is to use the top navigation in SharePoint to navigate the subsites (the "physical" navigation) and to use the current navigation (left navigation area) to do cross-site queries against a specific tag. The documents were tagged with a Managed Metadata term, with its own hierarchy.

I also enabled Managed Metadata Navigation, using the same term set that I use for tagging the documents. The managed navigation is displayed correctly but what I could not achieve is to use the managed metadata value as a filter in a Content Query web part, so that when the user clicks on a managed navigation term the page it navigates to (the same page for all the terms) will automatically filter and show only the documents that have been tagged with that term (or its descendants). The CQWP does not allow you to use managed navigation values as a filter, as it doesn’t recognize them.

I had to code my idea in Visual Studio.

The Solution

What I ended up doing is crafting a web part that parses the managed navigation term, queries all the sites in the site collection for documents tagged with that term and then fills a SPGridView with the results.

The tricky parts were:

Finding the Metadata Navigation Value

As the user clicked on a managed navigation term, SharePoint would create a SEO-friendly URL and internally it would invoke a single page. The managed metadata framework has the ability to "look up" the friendly URL and retrieve the corresponding term that has been used in the navigation.

In C#, the code that does that is as follows:

TaxonomyNavigationContext tnx = TaxonomyNavigationContext.Current;
if (tnx.HasFriendlyUrl)
{
Guid termId = tnx.FriendlyUrlTerm.Id;
}

The TaxonomyNavigationContext defined in Microsoft.SharePoint.Publishing.dll assembly will give us the Term ID (a Guid) that corresponds to the term that was clicked in a managed navigation menu.

Filtering the SPSiteDataQuery with the managed metadata value

In order to filter a SPSiteDataQuery (or any CAML query) with a managed metadata value, you have to know the local lookup value for the metadata. What is this "local lookup" about?

When you add a metadata column in SharePoint, it goes to the root site for that site collection and creates a hidden list. It then uses that list as the source for a lookup field that will represent the managed metadata. When you tag an item with a term, SharePoint will add that term as a list item in the hidden list and update the tagged item accordingly.

So, if you want to filter a list or a library for tagged values, you have to know their local IDs in the lookup fields. Fortunately, there is a method that does just that: GetWssIdsOfTerm.

As we already have the TaxonomyNavigationContext and the term ID, we will collect two more IDs: Term Store ID (usually only one in whole deployment) and a Term Set ID. These IDs are already available in the FriendlyUrlTerm property of TaxonomyNavigationContext.

Guid termStoreId = tnx.FriendlyUrlTerm.TermSet.TermStoreId;
Guid termSetId = tnx.FriendlyUrlTerm.TermSet.Id;
int[] wssIds = TaxonomyField.GetWssIdsOfTerm(SPContext.Current.Site, termStoreId, termSetId, termId, true, 100);

In the wssIds array we now have the corresponding values for the term set and its descendants (that’s what the boolean parameter in the method does).

The only thing missing is to convert that IDs into a CAML query "<Where>" condition to filter against the column named "Section". For that we use CAML <In> clause and a list of values created dynamically from the lookup ID array wssIds:

StringBuilder values = new StringBuilder();
for (int i = 0; i < wssIds.Length; i++)
{
      values.Append("<Value Type="Integer">");
      values.Append(wssIds[i].ToString());
    values.Append("</Value>");
}
string where = String.Format("<Where><In><FieldRef Name=’Section’ LookupId=’TRUE’/><Values>{0}</Values></In></Where>", values);

Caveat

One strange issue that happens with this approach is that when you click a term that hasn’t been used for tagging, the hidden list does not contain the lookup ID and the GetWssIdsOfTerm method returns an empty string. You have to manage this condition and return an empty result without trying to build a CAML query as you already know that there are no tagged items in the site collection.

This behaviour is very similar to the SPUser object when the user hasn’t entered the SharePoint site collection yet, where we use SPWeb.EnsureUser method to fill the user object into the site.

En breve se abrirá el registro para la Iberian SharePoint Conference

Desde la organización de la Iberian SharePoint Conference 2013 la semana pasada cerramos el preregistro con 250 personas apuntadas. A estas personas se les enviará un código de descuento para que la entrada a la conferencia les cueste 50 €.

El precio regular para asistir a la conferencia será de 75 €. Podéis ver más detalles en la web. La ubicación de la conferencia este año será en las instalaciones de la Fundación Tajamar (C/Pío Felipe 12) en Madrid.

La compra de la entrara se podrá realizar en breve. En cuanto esté todo listo anunciaremos en enlace en la web de la conferencia y en nuestros canales sociales.

Hemos optado por reducir el precio de asistencia al máximo pero manteniendo al mismo tiempo la calidad de la conferencia. Las asociaciones de usuarios de SharePoint que la estamos organizando somos entidades sin ánimo de lucro, pero hay que entender que existen ciertos costes que nos es imposible cubrir sin repercutir una parte al asistente. Sólo con los patrocinadores no llegamos a cubrir todo, al menos en esta primera edición.

[Reciclaje JavaScript] Encapsulamiento

Continuando con la serie de posts sobre como programar bien en JavaScript, en este post vamos a ver el tema de encapsulamiento. Como sabéis, la programación orientada a objetos introduce el encapsulamiento como herramienta para ocultar las partes privadas de un objeto de los consumidores de su parte pública. Es decir, el encapsulamiento nos sirve para proteger la implementación interna de las funcionalidades del objeto.

Los ámbitos de variables

En JavaScript conviene saber una cosa antes de enseñar el encapsulamiento y es nada menos que saber como funcionan los ámbitos de variables.

En C# tenemos los siguientes ámbitos de variables

de bloque (dentro de un if, o dentro de un for)
de método (dentro de un método)
de clase (variables disponibles a todo el código dentro de una clase)

En JavaScript tenemos sólo un ámbito de variable

de función

En JavaScript, la variable "sube" hasta la función más cercana y allí se queda. No estará disponible para el código JavaScript fuera de esa función pero sí al código que haya dentro de la función. Para que la cosa sea aún peor, la variable hace el "hoisting" y puede machacar las variables con el mismo nombre, como se recoge en el siguiente ejemplo:

var miVariable = 42;
function foo() {
    alert("Espero 42: " + miVariable);
    miVariable = 123;
    if (true) {
        var miVariable = 21;
    }
}
foo();

Aquí podemos ver que la variable miVariable dentro del bloque if "sube" hasta la función foo() y se queda como "interna". Sin embargo, en el primer alert el valor de la variable será "undefined". La variable externa miVariable se quedará con el valor 42.

Es importante entender el comportamiento de este trozo de código. Si necesitáis refrescar conceptos, repasad el artículo anterior de la serie de posts.

Variables "globales" y el objeto Window

¿Qué pasa con la variable externa miVariable? Esta variable no tiene ninguna función a la que subir, ¿verdad? Pues resulta que en JavaScript toda variable no asignada dentro de una función sube hasta el objeto window que está disponible en todo el runtime de JavaScript.

Podemos decir que declarar una variable "global" y una variable dentro de window es equivalente. Podéis comprobar este comportamiento en este enlace.

Cierres (Closures)

En muchos lenguajes de programación existe el concepto de cierre (closure). Un cierre es básicamente el mantenimiento del valor de una variable después de que el proceso en el que se ha usado esa variable haya acabado. Es como si el valor de esa variable esté "cerrado" dentro del proceso.

Para explicar este concepto, nada mejor que un ejemplo.

var FactoriaSaludos = function (nombre) {
    var miPrefijo = ‘Hola, ‘;
    return function() {
        return miPrefijo + nombre;
    };
}

var saludador = FactoriaSaludos(‘Edin’);
alert(saludador());

En este ejemplo tenemos una función FactoriaSaludos que toma un parámetro nombre. Dentro de ella, devolvemos otro objeto función. Lo que pasa es que esa función anónima interna usa variables que están fuera de su ámbito (miPrefijo y nombre). En este caso, el objeto devuelto (saludador) de tipo función tendrá "cerradas" dentro de él esas dos variables.

Por eso, al invocar la función saludador, nos devuelve un saludo con los valores "cerrados" en el closure de la función interna.

Si este primer ejemplo no te ha parecido muy complejo, prueba con el segundo.

for (var i = 0; i < 10; i++) {
document.getElementById(‘box’ + i).onclick = function() {
alert(‘You clicked on box #’ + i);
};
}

En este ejemplo, al clicar en un div con el nombre box1 esperamos obtener el mensaje de "You clicked on box #1". Sin embargo, podéis verificar que todos los divs devuelven el mismo valor: 5.

¿Qué ha pasado? Pues que la función anónima de onclick ha capturado la variable i. Al clicar, se invoca el valor de la i (es decir, el cierre tiene la variable capturada por referencia) que será siempre el último en actualizarse (es decir 5). Para prevenir esto tenemos que introducir una función interna más, que asegurará que el valor capturado será el del parámetro de entrada de la función externa, evitando la referencia directa a la variable i.

for (var i = 0; i < 10; i++) {
document.getElementById(‘box’ + i).onclick = function(index) {
    return function() {
      window.alert(‘You clicked on box #’ + index);
   }
}(i);
}

La función asignada al onclick toma como parámetro index el valor de la variable i y la función interna lo recoge como cierre . Si ahora clicamos en cada caja, muestra su valor correcto.

¿Todavía no tienes claro como funcionan los cierres? No te preocupes, los cierres parecen muy raros hasta que se prueban en el código. Juega con JSFiddle y prueba los ejemplos que hay en internet hasta que lo entiendas bien.

En la próxima entrega veremos como podemos jugar con cierres para simular encapsulamiento público y privado en JavaScript.

TechEd Europe 2013 en Madrid: Mis impresiones

La semana pasada estuve en TechEd Europe en el recinto firal de IFEMA en Madrid. Iba como staff voluntario para ayudar con los Hands-on Labs (HOL) que estuvieron disponibles para los asistentes al evento y también están disponibles algunos de ellos en la web de Channel 9.

El domingo previo al evento los trainers (MCT) hicimos el evento MCT Day Zero, donde tuvimos la ocasión de hablar con los responsables de Microsoft Learning e intercambiar conocimientos entre los trainers presentes. Fue un día muy bien aprovechado.

En cuanto al TechEd mismo, yo tenía muchas ilusiones pero volví bastante decepcionado. Me esperaba un evento de nivel técnico altísimo y unos con ponentes "cracks". En lugar de eso me encontré un evento pensado principalmente para administradores de sistemas (IT PROs) y donde el contenido de desarrolladores y arquitectos estaba un poco de comparsa. Supongo que el hecho de que la Build Conference en EEUU coincidía durante la misma semana tuvo mucho que ver con ello.

Salí de algunas charlas de desarrollo a media ponencia, bien por el contenido que se anunciaba como de nivel 300-400 y no pasaba de 100 en muchos casos, o bien por el ponente que sin dudar de su capacidad técnica convertía una sesión potencialmente interesante en una liturgia soporífera. Dejé mi feedback a la gente responsable de Microsoft para que lo tengan en cuenta, sobre todo porque no fui el único que se percató de estos temas.

La organización estuvo bastante bien, con el único fallo de la conectividad WiFi el primer día, que se solventó para los demás días. Hubo muchos expositores y ocasiones de conocer productos útiles y saber como está el mercado. La mejor parte para mí fue el espacio de la comunidad, donde pude saludar a algunos viejos conocidos y hacer muchos nuevos.

En cuanto a las novedades técnicas que me llamaron más la atención, estas fueron:

Windows 8.1, con sus novedades y el botón de inicio resucitado (pero que sospecho que no es lo que quería la gente)
Desired State Management (DSM) con PowerShell y Windows Server 2012 R2 que ya está disponible en Preview. El DSM permite de una manera descriptiva y fácil configurar máquinas desde PowerShell sin tener que hacer scripts que lo hagan.
Nuevos dispositivos que cruzan la barrera entre tablet y ordenador (Panasonic, Acer Iconia, Lenovo Yoga…)
Single-purpose-use (configurar Windows para que sólo corra un programa al arrancar, ideal para las máquinas en los puntos de venta, kioscos, expositores etc)
Azure IaaS para desarrollo (subir maquinas virtuales a Azure, configurar una VLAN virtual entre Azure y nuestra máquina de desarrollo, "cliente VPN Azure" para Windows)
Visual Studio 2013: novedades "pequeñas pero matonas" como CodeLens o soporte para repositorios Git en Team Explorer

En resumen, sabor agridulce del evento técnico insignia de Microsoft. Lo mejor, sin duda, socializar con otros ~~frikis~~ asistentes y conocer gente nueva.