Compartilhar via

Projetar um modelo de conectividade de dados corporativos

  • Artigo

Você pode desenvolver um modelo para o serviço de BDC (Conectividade de Dados Corporativos) adicionando entidades e métodos a um arquivo de modelo. Uma entidade descreve uma coleção de campos de dados. Por exemplo, uma entidade pode representar uma tabela em um banco de dados. Um método executa uma tarefa como adicionar, excluir ou atualizar dados representados pelas entidades. Para obter mais informações, consulte Integrar dados corporativos ao SharePoint.

Adicionar entidades

Você pode adicionar uma entidade arrastando ou copiando uma Entidade da Caixa de Ferramentas do Visual Studio para o Designer de BDC. Para obter mais informações, consulte Como adicionar uma entidade a um modelo.

Defina os campos da entidade em uma classe. Por exemplo, você pode adicionar um campo chamado Address a uma classe Customer. Você pode adicionar uma nova classe ao projeto ou usar uma classe existente criada usando outras ferramentas, como o Designer Relacional de Objetos. O nome da entidade e o nome da classe que representa a entidade não precisam ser correspondentes. Você relaciona a classe à entidade quando define os métodos no modelo.

Adicionar métodos

O serviço de BDC chama métodos no modelo quando os usuários exibem, adicionam, atualizam ou excluem informações em uma lista ou Web Part baseada no modelo. Você precisa adicionar um método ao modelo para cada tarefa que o usuário pode executar. Crie métodos selecionando qualquer um dos cinco tipos de método básicos na janela Detalhes do Método de BDC. A tabela a seguir descreve os cinco métodos básicos de um modelo de BDC.

Método Descrição
Finder Retorna uma coleção de instâncias de entidade. Chamado quando o usuário abre a lista ou a Web Part. Para obter mais informações, consulte Como adicionar um método Finder.
Localizador Específico Retorna uma instância de entidade específica. Chamado quando um usuário exibe os detalhes de um item específico em uma lista. Para obter mais informações, consulte Como adicionar um método Finder específico.
Criador Adiciona novos dados à fonte de dados de uma entidade. Chamado quando os usuários escolhem o botão Novo Item na Faixa de Opções de uma lista baseada no modelo. Para obter mais informações, consulte Como adicionar um método Creator.
Atualizador Modifica os dados em uma lista. Chamado quando os usuários atualizam informações em uma lista. Para obter mais informações, consulte Como adicionar um método Updater.
Excluir Remove dados. Chamado quando os usuários excluem um item da lista. Para obter mais informações, consulte Como adicionar um método Deleter.

Definir parâmetros de método

Quando você cria um método, o Visual Studio adiciona os parâmetros de entrada e de saída apropriados para o tipo de método. Esses parâmetros são apenas espaços reservados. Na maioria dos casos, você precisa modificar os parâmetros para que eles passem ou retornem o tipo correto de dados. Por exemplo, por padrão, um método Finder retorna uma cadeia de caracteres. Na maioria dos casos, você deseja modificar o parâmetro de retorno do método Finder para que ele retorne uma coleção de entidades. É possível fazer isso modificando o descritor de tipo do parâmetro. Um descritor de tipo é uma coleção de atributos que descreve o tipo de dados de um parâmetro. Para obter mais informações, consulte Como definir o descritor de tipo de um parâmetro.

O Visual Studio permite copiar descritores de tipo entre parâmetros no modelo. Por exemplo, você pode definir um descritor de tipo chamado CustomerTD para o parâmetro de retorno do método GetCustomer. Você pode copiar o descritor de tipo CustomerTD no BDC Explorer e colá-lo no parâmetro de entrada do método CreateCustomer. Com isso, você não precisa definir o mesmo descritor de tipo mais de uma vez.

Instâncias de método

Quando você cria um método, o Visual Studio adiciona uma instância de método padrão. Uma instância de método é uma referência a um método, com conjunto com os valores padrão para os parâmetros. Um só método pode ter várias instâncias de método. Cada instância é uma combinação da assinatura do método e um conjunto de valores padrão. Para obter mais informações, consulte Como definir o descritor de tipo de um parâmetro.

Quando você executa o projeto, as instâncias de método aparecem em uma lista suspensa acima da lista do SharePoint. Os usuários podem escolher as instâncias de método para exibir os dados.

Para adicionar valores padrão à instância de método, você precisa modificar o XML do modelo diretamente. Para obter mais informações, consulte DefaultValue.

Adicionar descritores de filtro

Os consumidores do modelo podem desejar recuperar instâncias de uma entidade que correspondam a alguns critérios. Para habilitar essa funcionalidade, você pode adicionar um descritor de filtro a um método. Os descritores de filtro permitem que os consumidores de modelos filtrem conjuntos de resultados de métodos passando valores para os métodos antes de serem executados. Para obter mais informações, consulte Como adicionar parâmetros de filtro a operações para limitar instâncias do sistema externo.

O SharePoint fornece vários recursos que permitem que os usuários forneçam valores de filtro. Por exemplo, Web Parts de Dados Corporativos fornecem uma caixa de texto de filtro. Os usuários podem limitar os dados em uma lista inserindo um valor na caixa de texto. Para obter mais informações sobre como adicionar um descritor de filtro a um método, consulte Como adicionar um descritor de filtro a um método Finder.

Propriedades do descritor de filtro

Você precisa definir o valor das propriedades Descritor de Tipo Associado, Nome e Tipo de um descritor de filtro. Todas as outras propriedades são opcionais.

A propriedade Descritor de Tipo Associado relaciona o descritor de filtro a um parâmetro de entrada. Quando um usuário fornece um valor de filtro, o serviço de BDC passa esse valor para o método usando o parâmetro de entrada.

A propriedade Tipo descreve o padrão de filtragem que você deseja usar. No SharePoint, o padrão de filtragem selecionado afeta o texto que aparece na interface do usuário. Por exemplo, para o padrão de filtragem Comparador, o texto é igual a aparece como um controle acima de uma Web Part de Dados Corporativos. Para obter mais informações sobre cada padrão de filtragem, consulte Tipos de filtros compatíveis com o BDC.

Para obter mais informações sobre as propriedades de um descritor de filtro, consulte FilterDescriptor.

Fornecer valores padrão

Em alguns casos, o usuário pode não fornecer um valor de filtro. Você pode fornecer um valor padrão adicionando-o à instância do método ou definindo-o no código do método. Para obter mais informações sobre como adicionar um valor padrão à instância do método, consulte MethodInstance. Para obter um exemplo de como definir o valor padrão de um parâmetro de entrada no código do método, consulte Como adicionar um descritor de filtro a um método Finder.

Validar o modelo

Você pode validar o modelo durante o desenvolvimento. O Visual Studio identifica problemas que podem impedir que o modelo se comporte conforme o esperado. Esses problemas aparecem na Lista de Erros do Visual Studio.

Você pode validar um modelo abrindo o menu de atalho do Designer de BDC e escolhendo Validar. Se o modelo contiver erros, eles aparecerão na Lista de Erros. Você pode mover rapidamente o cursor para o código que contém um erro clicando duas vezes no erro na lista. Como alternativa, você pode escolher as teclas F8 ou Shift+F8 repetidamente para avançar ou retroceder pelos erros na lista.

Erros de validação podem ocorrer quando as regras do modelo são violadas de alguma forma. Por exemplo, se a propriedade IsCollection de um descritor de tipo for definida como true, mas nenhum descritor de tipo filho existir, um erro de validação será exibido. Talvez seja necessário consultar as regras de um modelo de BDC para entender alguns erros que aparecem na Lista de Erros do Visual Studio. Para obter mais informações sobre as regras de um modelo de BDC, consulte Esquema BDCMetadata.

Depurar a solução que contém o modelo

Você pode depurar o código da mesma maneira como faria para depurar qualquer código no Visual Studio. Para depurar o código, defina pontos de interrupção em qualquer lugar dele e inicie o depurador. O Visual Studio abre o site do SharePoint. No SharePoint, crie uma lista ou Web Part que use seus dados corporativos. Em seguida, você pode percorrer o código. Para obter mais informações sobre como depurar projetos do SharePoint, consulte Solucionar problemas com soluções do SharePoint.

Você também pode depurar código em assemblies personalizados adicionados ao projeto. No entanto, para depurar código em um assembly personalizado, adicione o assembly ao pacote da solução. Para obter mais informações, consulte Como adicionar e remover assemblies adicionais.

Para obter mais informações sobre como adicionar um assembly personalizado ao projeto, consulte Como incluir um assembly personalizado em um recurso de BDC.

Configurar a segurança do BDC

Talvez seja necessário modificar as configurações de segurança no SharePoint antes de depurar a solução. Para modificar essas configurações, abra o Aplicativo de Serviço de Conectividade de Dados Corporativos no site de Administração Central do SharePoint 2010. Na caixa de diálogo Definir Permissões do Repositório de Metadados, adicione sua conta de usuário e selecione qualquer uma das seguintes opções:

Tarefa Opção
Para implantar modelos no serviço de BDC. Editar
Para criar listas e Web Parts usando tipos de conteúdo externos (entidades) no modelo. Selecionável em Clientes
Para criar, ler, atualizar e excluir dados de entidade. Execute (executar)

Para obter mais informações sobre essas configurações, consulte Gerenciamento de serviços de Conectividade de Dados Corporativos.

Você também pode definir permissões de segurança para modelos individuais ou tipos de conteúdo externos. Para obter mais informações sobre como definir as permissões de segurança de um modelo, consulte Gerenciamento de modelos de BDC. Para obter mais informações sobre como definir as permissões de segurança de um tipo de conteúdo externo, consulte Gerenciamento de tipos de conteúdo externos.

Observação

Use essas configurações para depurar uma solução no SharePoint Server local. Para obter mais informações sobre como definir configurações de segurança relacionadas ao BDC no servidor do SharePoint de produção, consulte Visão geral da segurança dos Serviços de Conectividade de Dados Corporativos.

Retirar modelos que se tornam corrompidos

Na primeira vez em que você inicia o depurador, o Visual Studio implanta todo o modelo no SharePoint. Para cada vez depois disso, o Visual Studio atualiza o modelo no SharePoint com as alterações feitas entre as implantações.

Pode haver situações em que você deseja que o Visual Studio retire completamente o modelo do SharePoint. Por exemplo, um modelo pode se tornar corrompido. Para reimplantar o modelo no SharePoint, defina a propriedade Atualização Incremental dele como Falso e inicie o depurador. A propriedade Atualização Incremental aparece na janela Propriedades quando você seleciona o nó que representa o modelo no BDC Explorer. Por padrão, o nome do modelo é BdcModel1.

Alterar os nomes de identificadores das entidades no modelo

Se você alterar o nome de um identificador depois de implantar o modelo, poderá receber um erro de implantação. Não é possível resolver esse erro definindo a propriedade Atualização Incremental do modelo como Falso. É necessário retirar o modelo manualmente e implantar a solução novamente. Para obter mais informações, consulte Solucionar problemas com soluções do SharePoint. Você pode evitar esse erro definindo a propriedade Atualização Incremental como Falso antes de implantar o modelo inicialmente.

Localizar a documentação de elementos de modelo de BDC

O Visual Studio adicionará um elemento XML ao modelo para cada entidade, método ou outro item que você criar. Os atributos de elemento aparecem como propriedades na janela Propriedades. Para obter informações sobre os elementos e os atributos gerados pelo Visual Studio quando você projeta o modelo, consulte Esquema BDCMetadata.

Título Descrição
Visão geral das ferramentas de design do modelo de BDC Descreve as ferramentas que você pode usar para projetar visualmente um modelo para o BDC.
Como adicionar uma entidade a um modelo Mostra como adicionar tipos de conteúdo externos, ou entidades, ao modelo.
Como adicionar um método Finder Mostra como adicionar um método que permite que os usuários vejam uma lista de entidades em uma lista ou Web Part.
Como adicionar um método Finder específico Mostra como adicionar um método que permite que os usuários vejam os detalhes de uma entidade específica.
Como adicionar um método Creator Mostra como adicionar um método que permite que os usuários adicionem registros a uma fonte de dados diretamente de uma lista ou Web Part.
Como adicionar um método Deleter Mostra como adicionar um método que permite que os usuários removam dados de uma fonte de dados usando opções na interface do usuário de uma lista ou Web Part.
Como adicionar um método Updater Mostra como adicionar um método que permite que os usuários alterem registros de dados em uma fonte de dados diretamente de uma lista ou Web Part.
Como adicionar um parâmetro a um método Mostra como usar a janela Detalhes do Método no Visual Studio para adicionar parâmetros de entrada e retorno a um método.
Como definir o descritor de tipo de um parâmetro Mostra como definir tipos de dados de parâmetro no modelo.
Como definir uma instância de método Mostra como criar uma instância de um método que o BDC executa.
Como adicionar um descritor de filtro a um método Finder Mostra como permitir que os usuários limitem o número de instâncias retornadas por um método Finder.
Criando uma associação entre entidades Descreve como você pode definir relações entre entidades no modelo. Web Parts de Dados Corporativos, Listas Externas e aplicativos personalizados podem exibir essas relações de dados em uma interface do usuário.
Como criar uma associação entre entidades Mostra como definir relações entre entidades no modelo.
Passo a passo: criar uma lista externa no SharePoint usando dados corporativos Fornece instruções passo a passo que mostram como criar e testar um modelo que exibe contatos em uma lista externa do SharePoint.
Integrar dados corporativos ao SharePoint Fornece uma visão geral da criação e da elaboração de modelos para o serviço de BDC.