Compartir a través de

Usar la biblioteca de códigos de cliente para acceder a datos externos en SharePoint

  • Artículo

Aprenda a usar el modelo de objetos de cliente de SharePoint para trabajar con objetos de Servicios de conectividad empresarial (BCS) en SharePoint mediante scripting basado en explorador.

En este artículo se muestra cómo configurar una lista externa que recupera datos de un origen del protocolo Open Data (OData) mediante el modelo de objetos de cliente en SharePoint.

Requisitos previos para acceder a datos externos mediante el modelo de objetos de cliente de SharePoint

A continuación se enumeran los requisitos que se deben cumplir para desarrollar aplicaciones con el modelo de objetos de cliente de SharePoint:

Conceptos básicos que se deben conocer al acceder a datos externos con el modelo de objetos de cliente de SharePoint

El modelo de objetos de cliente de SharePoint proporciona una manera de acceder a datos externos mediante llamadas del lado cliente que imitan las API del lado servidor. Para saber cómo funciona esto y cómo sacar partido de ello, vea los artículos de la tabla 1.

Tabla 1. Conceptos principales para usar el modelo de objetos de cliente

Artículo Descripción
Realizar operaciones básicas con código de biblioteca de cliente de SharePoint
Obtenga información sobre cómo escribir código para dar forma a operaciones básicas con el modelo de objetos de cliente (CSOM) de .NET Framework de SharePoint.

Crear una Complemento de SharePoint para obtener acceso a los datos externos mediante el modelo de objetos de cliente

En los siguientes procedimientos se explica cómo configurar una Complemento de SharePoint y una página web para realizar solicitudes, usando para ello métodos del modelo de objetos de cliente y objetos que recuperan datos de un origen de datos externo.

Para crear un complemento de SharePoint

  1. Abra Visual Studio 2012.

  2. Cree una Aplicación para un proyecto de SharePoint.

  3. Especifique la configuración de la aplicación, incluido su nombre, la dirección URL del sitio donde depurarla y el modo en que se va a hospedar (hospedada automáticamente, hospedada por el proveedor u hospedada por SharePoint). Para obtener más información sobre las opciones de hospedaje, vea Elegir patrones para desarrollar y hospedar el complemento de SharePoint.

  4. Haga clic en Finalizar para crear la aplicación.

Para generar el tipo de contenido externo

  1. En el Explorador de soluciones, abra el menú contextual del proyecto y elija Agregar, Tipos de contenido para origen de datos externo.

  2. En el Asistente para especificar origen de OData , escriba la dirección URL del servicio OData al que desea conectarse. En este caso, usará el origen OData de Northwind publicado en http://www.odata.org/ecosystem. Establezca la dirección URL del servicio OData en http://services.odata.org/Northwind/Northwind.svc/

    Indique un nombre para el origen de datos y seleccione Siguiente.

  3. Aparecerá una lista de entidades expuestas por el servicio OData. Elija la entidad Customers . Asegúrese de seleccionar la casilla de verificación crear instancias de la lista de las entidades de datos seleccionados (excepto las operaciones del servicio).

  4. Seleccione Finalizar.

Ejemplo de código: Agregar scripts y HTML a la página Default.aspx

Llegado este punto, tenemos un tipo de contenido externo y una lista externa que recoge los datos del origen OData Netflix.

Nuestra siguiente meta consiste en modificar la página default.aspx que se creó al crear la aplicación. Se agrega un contenedor donde se guardarán los resultados de la consulta que se ejecuta cuando la página se carga. Al ejecutar los scripts en el evento de carga de página, se garantiza que se van a ejecutar cada vez que alguien explore la página, y se realizarán las llamadas de modelo de objetos de cliente correspondientes al origen OData Netflix para agregar registros a la página.

Para agregar un contenedor a la página Default.aspx

  1. En el Explorador de soluciones, abra la página Default.aspx que está en el módulo Páginas.

  2. Agregue el siguiente elemento div a la página:

  
<div id="displayDiv"></div>
  1. Guarde la página.

Por último, se agrega código al archivo App.js que se ejecuta cuando la página se carga.

Para modificar el archivo App.js para realizar llamadas de modelo de objetos de cliente

  1. Abra el archivo App.js en el módulo Scripts del proyecto de SharePoint.

  2. Pegue el siguiente código al final del archivo.

  $(document).ready(function () {

    // Namespace
    window.AppLevelECT = window.AppLevelECT || {};

    // Constructor
    AppLevelECT.Grid = function (hostElement, surlWeb) {
        this.hostElement = hostElement;
        if (surlWeb.length > 0 &amp;&amp; surlWeb.substring(surlWeb.length - 1, surlWeb.length) != "/")
            surlWeb += "/";
        this.surlWeb = surlWeb;
    }

    // Prototype
    AppLevelECT.Grid.prototype = {

        init: function () {

            $.ajax({
                url: this.surlWeb + "_api/lists/getbytitle('Customer')/items?$select=BdcIdentity,CustomerID,ContactName",
                headers: {
                    "accept": "application/json",
                    "X-RequestDigest": $("#__REQUESTDIGEST").val()
                },
                success: this.showItems
            });
        },

        showItems: function (data) {
            var items = [];

            items.push("<table>");
            items.push('<tr><td>Customer ID</td><td>Customer Name</td></tr>');

            $.each(data.d.results, function (key, val) {
                items.push('<tr id="' + val.BdcIdentity + '"><td>' +
                    val.CustomerID + '</td><td>' +
                    val.ContactName + '</td></tr>');
            });

            items.push("</table>");

            $("#displayDiv").html(items.join(''));
        }
    }

    ExecuteOrDelayUntilScriptLoaded(getCustomers, "sp.js");
});

function getCustomers() {
    var grid = new AppLevelECT.Grid($("#displayDiv"), _spPageContextInfo.webServerRelativeUrl);
    grid.init();
}

Presione F5 para implementar la aplicación en SharePoint. Vaya a la página Default.aspx en la aplicación y verá que aparece una lista de clientes en ella.

Vea también