Introducción al uso del modelo de objetos de cliente con datos externos en SharePoint

Artículo
03/21/2023

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

¿Qué es el modelo de objetos de cliente de SharePoint?

El modelo de objetos de cliente para SharePoint es un conjunto de bibliotecas basadas en cliente que representan el modelo de objetos de servidor. Se empaquetan en tres archivos DLL diferentes para dar cabida a una variedad de tipos de desarrollo. El modelo de objetos de cliente incluye la mayoría de las funciones principales de la API de servidor. Esto permite el acceso a los mismos tipos de funcionalidad desde el scripting del explorador y también a las aplicaciones web de .NET y las aplicaciones de Silverlight.
Para mejorar y ampliar las funciones para trabajar con datos externos, Servicios de conectividad empresarial (BCS) ha ampliado el modelo de objetos de cliente para incluir funcionalidad adicional.

Get to work )

Introducción al uso del modelo de objetos de cliente de SharePoint con datos externos

Para desarrollar soluciones mediante el modelo de objetos de cliente de SharePoint (CSOM), necesita lo siguiente:

SharePoint
Visual Studio 2012
Office Developer Tools para Visual Studio 2012

Para obtener información sobre cómo configurar el entorno de desarrollo, vea Configuración de un entorno de desarrollo para BCS en SharePoint.

Para acceder a las funciones proporcionadas por el modelo de objetos de cliente, solo debe agregar referencias a los archivos Microsoft.SharePoint.Client.Runtime.dll y Microsoft.SharePoint.Client.dll en sus proyectos. También puede usar el modelo de objetos de cliente si hace referencia a los siguientes archivos DLL en la caché global de ensamblados:

\\Program Files\\Common Files\\Microsoft Shared\\Web Server Extensions\\15\\isapi\\Microsoft.SharePoint.Client.Runtime.dll
\\Program Files\\Common Files\\Microsoft Shared\\Web Server Extensions\\15\\isapi\\Microsoft.SharePoint.Client.dll

Conceptos básicos del modelo de objetos de cliente de SharePoint

Los siguientes artículos le ayudarán a comprender mejor el modelo de objetos de cliente de SharePoint.

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

Artículo	Descripción
Tipos de contenido externo en SharePoint	Aprenda lo que puede hacer con tipos de contenido externo y lo que necesita para comenzar a crearlos en SharePoint.
Uso de orígenes OData con Servicios de conectividad empresarial en SharePoint	Proporciona información para ayudar a comenzar a crear tipos de contenido externo basados en orígenes OData y a usar esos datos en componentes de SharePoint o Office 2013.
Elegir el conjunto de API correcto en SharePoint	Obtenga información sobre los distintos conjuntos de API proporcionados en SharePoint, lo que incluye el modelo de objetos de servidor, los distintos modelos de objetos de cliente y el servicio web REST/OData.
Referencia a API de cliente .NET para SharePoint	Busque información sobre las bibliotecas de clases de clientes de .NET en SharePoint.
Referencia a API de JavaScript para SharePoint	Busque información sobre las bibliotecas de objetos de JavaScript en SharePoint.

¿Qué se puede hacer con el modelo de objetos de cliente?

Puede usar el modelo de objetos de cliente de SharePoint para recuperar, actualizar y administrar los datos incluidos en SharePoint. SharePoint ofrece bibliotecas de cliente en diferentes formatos para adaptarse a la mayoría de los desarrolladores. En el caso de los desarrolladores web que usan lenguajes de scripting, la biblioteca de cliente se ofrece en JavaScript. En el caso de los desarrolladores .NET, se ofrece como un archivo DLL administrado de cliente de .NET. En el caso de los desarrolladores de aplicaciones de Silverlight, la biblioteca de cliente es proporcionada por un archivo DLL de Silverlight.

Consulte los artículos de la tabla 2 para obtener más información sobre lo que se puede hacer con el modelo de objetos de cliente de SharePoint.

Tabla 2. Tareas básicas para usar el modelo de objetos de cliente con datos externos

Tarea	Descripción
Realizar operaciones básicas con código de biblioteca de cliente de SharePoint	Aprenda a escribir código para ejecutar operaciones básicas con el modelo de objetos de cliente de SharePoint.
Cómo usar la biblioteca de códigos de cliente para obtener acceso a datos externos en SharePoint	Aprenda a usar el modelo de objetos de cliente de SharePoint para que funcione con objetos de BCS de SharePoint mediante scripts basados en el explorador.

A continuación se ofrecen algunos ejemplos básicos de tareas que se pueden realizar con CSOM.

Obtener una entidad específica

En este ejemplo se muestra cómo obtener contexto de SharePoint y luego recuperar una entidad de origen de datos dada.


ClientContext ctx = new ClientContext("http://sharepointservername"); 
Web web = ctx.Web; 
ctx.Load(web); 
Entity entity = ctx.Web.GetEntity("http://sharepointservername", "EntityName"); 
ctx.Load(entity); 
ctx.ExecuteQuery();

Crear un invocador genérico

En este ejemplo se muestra cómo escribir un invocador genérico para poder crear un objeto de entidad para trabajar en el código.

LobSystem lobSystem = entity.GetLobSystem();
ctx.Load(lobSystem);

LobSystemInstanceCollection lobInstances = lobSystem.GetLobSystemInstances();
ctx.Load(lobInstances);
ctx.ExecuteQuery();

LobSystemInstance lsi;
foreach(LobSystemInstance lobInstance in lobInstances)
{
  if (lobInstance.Name.CompareTo("MyLOBSystemInstance") == 0)
  {
    lsi = lobInstance;
  }
}

if (null != lsi)
{
  entity.Execute("MethodInstanceName", lsi, Array.Empty<object>()); 
  ctx.Load(myObj); 
  ctx.ExecuteQuery();
}

Recuperar conjuntos de resultados paginados

En el siguiente ejemplo se muestra cómo recuperar un conjunto de datos filtrado paginado. En este caso, el valor de página es 50.


// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 

fCollection.SetFilterValue("X.Y.Z.Country", 0, "India")
// Assuming that the "RowLimit" filter has the Limit filter type
fCollection.SetFilterValue("RowLimit", 0, 50)

EntityInstanceCollection eCollection = entity.FindFiltered(fCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery();

Consultar información filtrada

En el ejemplo siguiente se muestra cómo devolver un conjunto de resultados filtrados. En este caso, la columna de datos filtrada es el campo X.Y.Z.Country. El código busca algo con el valor "India" y luego lo coloca en una colección.


// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 

fCollection.SetFilterValue("X.Y.Z.Country", 0, "India")

EntityInstanceCollection eCollection = entity.FindFiltered(fCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery();

Más allá de los aspectos básicos: Obtenga más información sobre el modelo de objetos de cliente

Para obtener más información sobre el uso del modelo de objetos de cliente de SharePoint, consulte la información de la tabla 3.

Tabla 3. Conceptos avanzados del modelo de objetos de cliente

Artículo	Descripción
Referencia al modelo de objetos del cliente BCS para SharePoint	Resume los objetos disponibles para crear scripts de cliente con el modelo de objetos de cliente de SharePoint para acceder a los datos externos expuestos por BCS.

Compartir a través de