Criar um tipo de documento externo de uma fonte de OData no SharePoint

Artigo
03/21/2023

Saiba como usar o Visual Studio 2012 para descobrir uma fonte OData publicada e criar um tipo de conteúdo externo reutilizável para uso no BCS (Serviços Corporativos de Conectividade) no SharePoint.

Pré-requisitos para a criação de tipos de conteúdo externo baseado em OData

Para criar um tipo de conteúdo externo de uma fonte de dados aberta do protocolo OData, será necessário o seguinte:

Uma instância de SharePoint
Visual Studio 2012
Office Developer Tools para Visual Studio 2012
Um serviço OData publicado disponível através da Internet

Para obter informações sobre como configurar seu ambiente de desenvolvimento do SharePoint, consulte Configurar um ambiente de desenvolvimento geral para o SharePoint.

Observação

[!OBSERVAçãO] SharePoint Designer 2013 não pode ser usado para modelos BDC geração automática de uma fonte OData. Você pode usar Visual Studio 2012.

Conceitos principais para trabalhar com tipos de conteúdo externo do OData

Os seguintes artigos fornecem informações básicas sobre OData e o conector OData no SharePoint.

Tabela 1. Conceitos principais para tipos de conteúdo externo OData

Título do artigo	Descrição
Como usar fontes de OData com Serviços Corporativos de Conectividade do SharePoint	Comece a criar tipos de conteúdo externos com base em fontes OData e saiba como usar esses dados em componentes do SharePoint ou do Office.
Tipo de conteúdo externo no SharePoint	Saiba mais sobre os tipos de conteúdo externo BCS e o que você precisa para começar a criá-los no SharePoint.

Criar um tipo de conteúdo externo baseado em OData

As etapas a seguir mostram como usar Visual Studio 2012 para criar um tipo de conteúdo externo com base em uma fonte OData.

Para criar um novo Suplemento do SharePoint

Em Visual Studio 2012, crie um novo projeto de aplicativo para o SharePoint, que está localizado no nó do modelo do SharePoint.
Nomeie seu projeto e escolha OK.
Para especificar as configurações do SharePoint, insira um nome para o seu aplicativo e a URL do servidor SharePoint contra o qual você vai depurar.
Escolha Concluir.

Depois que o projeto é criado, use a nova geração automática ferramentas para fontes de OData e adicionar um modelo BDC para a fonte OData para seu aplicativo.

Para adicionar um novo modelo BDC

No Solution Explorer, abra o menu de atalho para o projeto e escolha Adicionar, tipos de conteúdo para a fonte de dados externa.

Isso iniciará um assistente que ajudarão você a descobrir a fonte de dados selecionada e criar um modelo BDC.
A primeira página do assistente é usada para coletar a URL do serviço de dados. Na página Especificar a fonte do OData, insira a URL do serviço OData que você deseja se conectar. A URL deve se parecer com o seguinte: http://services.odata.org/Northwind/Northwind.svc/.

Observação

Você mostrará o serviço Northwind que está disponível na lista de produtores encontrada no site do Protocolo de Dados Abertos.
Escolha um nome para sua fonte OData e escolha Avançar.
Aparecerá uma lista de entidades de dados que estão sendo expostos pelo OData Service. Selecione uma ou mais das entidades e escolha Concluir.

Para exibir a estrutura das entidades

Observe que Visual Studio criada uma nova pasta chamada tipos de conteúdo externo. Dentro dessa pasta, você encontrará uma subpasta com o nome da nova fonte de dados. Se você ainda mais expandir isso, você verá um item que representa a entidade que você selecionou. Para exibir uma lista de gráfica de entidades e seus tipos, abra o arquivo de ect que você deseja exibir.

Também é possível exibir o XML das entidades abrindo os arquivos ect em um editor de XML.

Usar um acessador de fluxo para a fonte de OData

Usando o código a seguir, você pode acessar um fluxo de dados que o conector OData pode usar.


/*Invoke  Stream Accessor Method */
        internal void ExecuteStreamAccessorMethod(IEntityInstance entityInstance, string streamAccessorName)
        {
            this.Log.Comment("ExecuteStreamAccessorMethod enter");
            this.Log.Comment("streamAccesor method" + streamAccessorName);
            IStreamableField isf = entityInstance.GetStreamableField(streamAccessorName);
            Stream resStream = isf.GetData();
            using (BinaryReader reader = new BinaryReader(resStream))
            {
                using (FileStream fs = File.Create(@"C:\\" + entityInstance.GetIdentity().GetIdentifierValues()[0] + ".jpg"))
                {
                    int bytesRead = 0;
                    do
                    {
                        int nrBytes = 80 * 1000 * 1000;
                        byte[] streamData = new byte[nrBytes];
                        bytesRead = reader.Read(streamData, 0, nrBytes);
                        this.Log.Comment("Total Bytes Read - " + bytesRead);
                        if (bytesRead > 0)
                        {
                            fs.Write(streamData, 0, bytesRead);
                        }
                    } while (bytesRead > 0);
                }
            }
            isf.Dispose();
            this.Log.Comment("ExecuteStreamAccessorMethod Exit" );
        }

Próximas etapas

Depois de criar um tipo de conteúdo externo, você pode usá-lo para apresentar dados dentro do SharePoint usando os objetos internos (listas externas, Web Parts de dados corporativos ou código personalizado).

Para obter mais informações, consulte Como criar uma lista externa usando uma fonte de dados OData no SharePoint.

Compartilhar via