Diseño de un modelo de conectividad a datos profesionales

  • Artículo

Puede desarrollar un modelo para el servicio de conectividad a datos profesionales (BDC) agregando entidades y métodos a un archivo de modelo. Una entidad describe una colección de campos de datos. Por ejemplo, una entidad puede representar una tabla de una base de datos. Un método realiza una tarea como agregar, eliminar o actualizar datos representados por las entidades. Para más información, vea Integración de datos empresariales en SharePoint.

agregar entidades

Puede agregar una entidad arrastrando o copiando una entidad desde el cuadro de herramientas de Visual Studio al Diseñador de BDC. Para más información, vea Adición de una entidad a un modelo.

Defina los campos de la entidad en una clase. Por ejemplo, puede agregar un campo denominado Address a una clase Customer. Puede agregar una nueva clase al proyecto o usar una clase existente creada mediante otras herramientas como Object Relational Designer (O/R Designer). El nombre de la entidad y el nombre de la clase que representa la entidad no tienen que coincidir. La clase se relaciona con la entidad al definir los métodos del modelo.

Agregar métodos

El servicio BDC llama a métodos del modelo cuando los usuarios ven, agregan, actualizan o eliminan información en una lista o elemento web basado en el modelo. Debe agregar un método al modelo para cada tarea que el usuario pueda realizar. Para crear métodos, seleccione cualquiera de los cinco tipos de método básicos en la ventana Detalles del método BDC. En la tabla siguiente se describen los cinco métodos básicos de un modelo BDC.

Método Descripción
Finder Devuelve una colección de instancias de entidad. Se le llama cuando el usuario abre la lista o el elemento web. Para obtener más información, vea Adición de un método Finder.
método Finder específico Devuelve una instancia de entidad específica. Se le llama cuando un usuario ve los detalles de un elemento específico de una lista. Para obtener más información, vea Adición de un método Finder específico.
Creador Agrega nuevos datos al origen de datos de una entidad. Se le llama cuando los usuarios eligen el botón Nuevo elemento en la barra de herramientas de una lista basada en el modelo. Para obtener más información, vea Adición de un método Creator.
Updater Modifica los datos de una lista. Se le llama cuando los usuarios actualizan la información de una lista. Para obtener más información, vea Adición de un método Updater.
Deleter Quita los datos. Se le llama cuando los usuarios eliminan un elemento de la lista. Para obtener más información, vea Adición de un método Deleter.

Definición de parámetros de método

Al crear un método, Visual Studio agrega los parámetros de entrada y salida adecuados para el tipo de método. Estos parámetros son solo marcadores de posición. En la mayoría de los casos, debe modificar los parámetros para que pasen o devuelvan el tipo correcto de datos. Por ejemplo, de forma predeterminada, un método Finder devuelve una cadena. En la mayoría de los casos, desea modificar el parámetro return del método Finder para que devuelva una colección de entidades. Para ello, puede modificar el descriptor de tipo del parámetro. Un descriptor de tipo es una colección de atributos que describe el tipo de datos de un parámetro. Para obtener más información, vea Definición del descriptor de tipo de un parámetro.

Visual Studio permite copiar descriptores de tipo entre parámetros del modelo. Por ejemplo, puede definir un descriptor de tipo denominado CustomerTD para el parámetro return del método GetCustomer. Puede copiar el descriptor de tipo CustomerTD en el Explorador de BDC y, a continuación, pegar ese descriptor de tipo en el parámetro de entrada del método CreateCustomer. Así, no tendrá que definir el mismo descriptor de tipo más de una vez.

Instancias de método

Al crear un método, Visual Studio agrega una instancia de método predeterminada. Una instancia de método es una referencia a un método, más los valores predeterminados para los parámetros. Un único método puede tener varias instancias de método. Cada instancia es una combinación de la firma del método y un conjunto de valores predeterminados. Para obtener más información, vea Definición del descriptor de tipo de un parámetro.

Al ejecutar el proyecto, las instancias de método aparecen en una lista desplegable situada encima de la lista de SharePoint. Los usuarios pueden elegir instancias de método para ver los datos.

Para agregar valores predeterminados a la instancia del método, debe modificar directamente el XML del modelo. Para obtener más información, consulte DefaultValue.

Adición de descriptores de filtro

Es posible que los consumidores del modelo quieran recuperar instancias de una entidad que coincidan con algunos criterios. Para habilitar esta funcionalidad, puede agregar un descriptor de filtro a un método. Los descriptores de filtro permiten a los consumidores del modelo filtrar los conjuntos de resultados del método pasando valores a métodos antes de ejecutarlos. Para obtener más información, vea Procedimiento para agregar parámetros de filtro a operaciones para limitar instancias del sistema externo.

SharePoint proporciona varias características que permiten a los usuarios proporcionar valores de filtro. Por ejemplo, los elementos web de datos profesionales proporcionan un cuadro de texto de filtro. Los usuarios pueden limitar los datos de una lista escribiendo un valor en el cuadro de texto. Para obtener más información sobre cómo agregar un descriptor de filtro a un método, vea Adición de un descriptor de filtro para un método Finder.

Propiedades del descriptor de filtro

Debe establecer el valor de las propiedades Descriptor de tipo asociado, Nombre y Tipo de un descriptor de filtro. Todas las demás propiedades son opcionales.

La propiedad Descriptor de tipo asociado relaciona el descriptor de filtro con un parámetro de entrada. Cuando un usuario proporciona un valor de filtro, el servicio BDC pasa ese valor al método mediante el parámetro de entrada.

La propiedad Tipo describe el patrón de filtrado que desea usar. En SharePoint, el patrón de filtrado que seleccione afecta al texto que aparece en la interfaz de usuario (IU). Por ejemplo, para un patrón de filtrado de comparador, el texto es igual a aparece como un control encima de un elemento web de datos profesionales. Para más información sobre cada patrón de filtrado, consulte Tipos de filtros admitidos por el BDC.

Para obtener más información sobre las propiedades de un descriptor de filtro, vea FilterDescriptor.

Proporcionar valores predeterminados

En algunos casos, es posible que el usuario no proporcione un valor de filtro. Puede proporcionar un valor predeterminado agregando un valor predeterminado a la instancia del método o estableciendo el valor predeterminado en el código del método. Para obtener más información sobre cómo agregar un valor predeterminado a la instancia de método, vea MethodInstance. Para obtener un ejemplo de cómo establecer el valor predeterminado de un parámetro de entrada en el código del método, vea Adición de un descriptor de filtro a un método Finder.

Validación del modelo

Puede validar el modelo durante el desarrollo. Visual Studio identifica los problemas que pueden impedir que el modelo se comporte según lo previsto. Estos problemas aparecen en la lista de errores de Visual Studio.

Para validar un modelo, abra el menú contextual del Diseñador de BDC y, a continuación, elija Validar. Si el modelo contiene errores, aparecen en la lista de errores. Puede mover rápidamente el cursor al código que contiene un error haciendo doble clic en el error de la lista. Como alternativa, puede elegir las teclas F8 o Mayús+F8 repetidamente para avanzar o retroceder a través de los errores de la lista.

Los errores de validación pueden producirse cuando se infringen las reglas del modelo de alguna manera. Por ejemplo, si la propiedad IsCollection de un descriptor de tipo se establece en true, pero no existe ningún descriptor de tipo secundario, aparecerá un error de validación. Es posible que tenga que hacer referencia a las reglas de un modelo BDC para comprender algunos errores que aparecen en la lista de errores de Visual Studio. Para obtener más información sobre las reglas de un modelo BDC, vea Esquema BDCMetadata.

Depuración de la solución que contiene el modelo

Puede depurar el código como depuraría cualquier código en Visual Studio. Para depurar el código, establezca puntos de interrupción en cualquier lugar del código y, a continuación, inicie el depurador. Visual Studio abre el sitio de SharePoint. En SharePoint, cree una lista o un elemento web que use los datos profesionales. Luego, recorra el código. Para obtener más información sobre la depuración de proyectos de SharePoint, vea Solución de problemas de soluciones de SharePoint.

También puede depurar código en ensamblados personalizados que agregue al proyecto. Sin embargo, para depurar código en un ensamblado personalizado, debe agregar el ensamblado al paquete de solución. Para obtener más información, vea Adición y eliminación de ensamblados adicionales.

Para obtener más información sobre cómo agregar un ensamblado personalizado al proyecto, vea Inclusión de un ensamblado personalizado en una característica de BDC.

Configuración de la seguridad de BDC

Es posible que tenga que modificar la configuración de seguridad en SharePoint para poder depurar la solución. Para modificar esta configuración, abra la aplicación de servicio de conectividad a datos profesionales en el sitio web Administración central de SharePoint 2010. En el cuadro de diálogo Establecer permisos del almacén de metadatos, agregue la cuenta de usuario y, a continuación, seleccione cualquiera de las opciones siguientes:

Tarea Opción
Para implementar modelos en el servicio BDC. Editar
Para crear listas y elementos web mediante tipos de contenido externo (entidades) en el modelo. Seleccionable en clientes
Para crear, leer, actualizar y eliminar datos de entidades. Execute

Para obtener más información sobre esta configuración, consulte Administración del servicio de conectividad a datos profesionales.

También puede establecer permisos de seguridad para modelos individuales o tipos de contenido externo. Para obtener más información sobre cómo establecer los permisos de seguridad de un modelo, consulte Administración de modelos BDC. Para obtener más información sobre cómo establecer los permisos de seguridad de un tipo de contenido externo, vea Administración de tipos de contenido externo.

Nota

Use esta configuración para depurar una solución en su instancia local de SharePoint Server. Para obtener más información sobre cómo configurar las opciones de seguridad relacionadas con BDC en el servidor de SharePoint de producción, vea Información general sobre la seguridad de los servicios de conectividad a datos profesionales.

Retirada de modelos que se dañan

La primera vez que inicie el depurador, Visual Studio implementa todo el modelo en SharePoint. A partir de ese momento, Visual Studio actualiza el modelo en SharePoint con los cambios realizados entre implementaciones.

Puede haber situaciones en las que quiera que Visual Studio retire completamente el modelo de SharePoint. Por ejemplo, un modelo que se haya dañado. Para volver a implementar el modelo en SharePoint, establezca la propiedad Actualización incremental del modelo en False y, a continuación, inicie el depurador. La propiedad Actualización incremental aparece en la ventana Propiedades al seleccionar el nodo que representa el modelo en el Explorador de BDC. De forma predeterminada, el nombre del modelo es BdcModel1.

Cambio de los nombres de identificador de las entidades en el modelo

Si cambia el nombre de un identificador después de implementar el modelo, es posible que reciba un error de implementación. No se puede resolver este error estableciendo la propiedad Actualización incremental del modelo en False. Debe retirar el modelo manualmente y, a continuación, volver a implementar la solución. Para obtener más información, consulte Solución de problemas de soluciones de SharePoint. Para evitar este error, establezca la propiedad Actualización incremental en False antes de implementar inicialmente el modelo.

Búsqueda de documentación para los elementos del modelo BDC

Visual Studio agrega un elemento XML al modelo para cada entidad, método u otro elemento que cree. Los atributos de elemento aparecen como propiedades en la ventana Propiedades. Para obtener información sobre los elementos y atributos que Visual Studio genera al diseñar el modelo, consulte Esquema BDCMetadata.

Title Descripción
Información general sobre las herramientas de diseño del modelo BDC Describe las herramientas que puede usar para diseñar visualmente un modelo para el BDC.
Adición de una entidad a un modelo Muestra cómo agregar tipos de contenido externo, o entidades, al modelo.
Adición de un método Finder Muestra cómo agregar un método que permite a los usuarios ver una lista de entidades en una lista o elemento web.
Adición de un método Finder específico Muestra cómo agregar un método que permite a los usuarios ver los detalles de una entidad específica.
Adición de un método Creator Muestra cómo agregar un método que permite a los usuarios agregar registros a un origen de datos directamente desde una lista o elemento web.
Adición de un método Deleter Muestra cómo agregar un método que permite a los usuarios quitar datos de un origen de datos mediante las opciones de la interfaz de usuario de una lista o elemento web.
Adición de un método Updater Muestra cómo agregar un método que permite a los usuarios cambiar los registros de datos en un origen de datos directamente desde una lista o elemento web.
Adición de un parámetro a un método Muestra cómo usar la ventana Detalles del método en Visual Studio para agregar parámetros de entrada y devolución a un método.
Definición del descriptor de tipo de un parámetro Muestra cómo definir tipos de datos de parámetros en el modelo.
Definición de la instancia de un método Muestra cómo crear una instancia de un método que ejecuta BDC.
Adición de un descriptor de filtro a un método Finder Muestra cómo permitir que los usuarios limiten el número de instancias devueltas por un método Finder.
Crear una asociación entre entidades Describe cómo puede definir relaciones entre entidades en el modelo. Los elementos web de datos profesionales, las listas externas y las aplicaciones personalizadas pueden mostrar estas relaciones de datos en una interfaz de usuario (IU).
Creación de una asociación entre entidades Muestra cómo definir relaciones entre entidades en el modelo.
Tutorial: Creación de una lista externa en SharePoint mediante datos empresariales Proporciona instrucciones paso a paso que muestran cómo crear y probar un modelo que muestra los contactos en una lista externa de SharePoint.
Integración de datos profesionales en SharePoint Proporciona información general sobre cómo crear y diseñar modelos para el servicio BDC.