SharePoint 4 Developers

Guia de referência adicional em desenvolvimento .NET / SharePoint

Business Connectivity Services – Parte III

23. setembro 2010 Marcel Medina Lições de SharePoint (0)
Nessa abordagem aprenda a integrar serviços WCF no SharePoint 2010 pelo Business Connectivity Services. Essa é uma abordagem bem interessante, pois permite que diferentes serviços (inclusive da nuvem) possam ser integrados no SharePoint 2010.

Oi pessoal, tudo bem?

Depois de umas mini-férias trago mais uma parte da série sobre o BCS, onde abordo como conectar a diferentes fontes de dados externos.

Nessa abordagem aprenda a integrar serviços WCF no SharePoint 2010 pelo Business Connectivity Services. Essa é uma abordagem bem interessante, pois permite que diferentes serviços (inclusive da nuvem) possam ser integrados no SharePoint 2010.

Para a apresentação desse artigo criaremos um serviço WCF, que servirá para a criação de um External Content Type (ECT).

Criação de ECTs via Web Service (WCF)

Para a criação de ECTs via Web Service necessitamos da utilização do SPD2010 e nesse caso, como iremos criar um Web Service, necessitamos do VS2010.

Esse tipo de abordagem é aplicado em ambientes que:

  • Façam integração com uma fonte de dados externos (ex: outros sistemas), quer seja em sua Intranet ou Internet;
  • Haja a necessidade de criação de regras de negócio, o que pode ser implementado durante a criação do Web Service;
  • Utilizem bancos de dados diferentes do SQL Server, o que pode ser implementado na camada de acesso a dados durante a criação do Web Service;

Caso você tenha esse cenário, essa implementação tem um nível maior de dificuldade pela criação do Web Service, que é demonstrado a seguir. Inicialmente trabalharemos com o VS2010 e em seguida finalizaremos a configuração com o SPD2010.

Trabalhando com o Visual Studio 2010

A criação do ECT em questão só é possível com a existência de um Web Service, para tal criaremos uma solução no VS2010. Conforme já mencionado no Bloco 1 da Arquitetura do BCS (Parte I), ambas as extensões .asmx (ASP.NET Web Service Application) e .svc (WCF Service Application) podem ser utilizadas na criação de ECTs e nessa demonstração vou utilizar um WCF Service Application.

Inicie o VS2010, crie uma Blank Solution e adicione 3 projetos conforme a Figura 1:

solution

Figura 1 - Criação da Solução

OBS: Com relação aos arquivos *.cs e App.config disponibilizados por padrão quando da criação de novos projetos, favor excluí-los.

A solução foi separada em projetos que refletem as camadas de acesso a dados e negócio que veremos a seguir. É necessário antes que as seguintes referências sejam adicionadas entre os projetos conforme a Tabela 1:

Projeto Referência
ContactServices.Business ContactServices.Data
ContactServices.Host ContactServices.Business
Tabela 1 - Referências

OBS: Em todos os exemplos de código, meu objetivo é de mostrar apenas a funcionalidade na criação de um ECT no SharePoint 2010, portanto utilize o código como base e implemente os tratamentos que toda aplicação necessita possuir (ex: Logs, Exceções, Segurança, etc...). Recomendo a utilização do Enterprise Library.

Camada de Acesso a Dados

Para a criação do projeto ContactServices.Data precisamos adicionar alguns objetos que manipulem o banco de dados, e para fins de demonstração utilizo o LINQ to SQL por ser mais simples de implementar. Adicione esse objeto ao projeto e o nomeie de Dev.dbml, em seguida crie pelo Server Explorer uma nova conexão que utilize Windows Authentication, abra o database e arraste a tabela Contact (Parte II) conforme demonstrado na Figura 2:

LINQtoSQL

Figura 2 - Adição da tabela Contact

Para manipularmos os dados do objeto Contact é necessário criarmos uma classe que disponibilize métodos de um CRUD, para isso crie uma classe chamada ContactManager e adicione o código abaixo, cujos comentários são bem explicativos:

Code Snippet
  1. public class ContactManager
  2. {
  3.     /// <summary>
  4.     /// Obtem todos os Contatos
  5.     /// </summary>
  6.     /// <returns>Array de Contatos</returns>
  7.     public Contact[] GetContacts()
  8.     {
  9.         var contacts = new List<Contact>();
  10.  
  11.         using (DevDataContext dev = new DevDataContext())
  12.         {
  13.             contacts = (from cont in dev.Contacts
  14.                         select cont).ToList();
  15.         }
  16.         return contacts.ToArray();
  17.     }
  18.  
  19.     /// <summary>
  20.     /// Obtem um Contato especifico
  21.     /// </summary>
  22.     /// <param name="contactId">Id do Contato</param>
  23.     /// <returns>Retorna o Contato</returns>
  24.     public Contact GetContactById(int contactId)
  25.     {
  26.         var contact = new Contact();
  27.  
  28.         using (DevDataContext dev = new DevDataContext())
  29.         {
  30.             contact = (from cont in dev.Contacts
  31.                         where cont.ContactID == contactId
  32.                         select cont).First();
  33.         }
  34.         return contact;
  35.     }
  36.  
  37.     /// <summary>
  38.     /// Atualiza um Contato especifico
  39.     /// </summary>
  40.     /// <param name="contact">Contato para atualizacao</param>
  41.     public void UpdateContact(Contact contact)
  42.     {
  43.         var contactDB = new Contact();
  44.  
  45.         using (DevDataContext dev = new DevDataContext())
  46.         {
  47.             contactDB = (from cont in dev.Contacts
  48.                             where cont.ContactID == contact.ContactID
  49.                             select cont).First();
  50.  
  51.             // Alterando o objeto
  52.             contactDB.Address = contact.Address;
  53.             contactDB.City = contact.City;
  54.             contactDB.CompanyName = contact.CompanyName;
  55.             contactDB.ContactName = contact.ContactName;
  56.             contactDB.ContactTitle = contact.ContactTitle;
  57.             contactDB.Country = contact.Country;
  58.             contactDB.Email = contact.Email;
  59.             contactDB.Fax = contact.Fax;
  60.             contactDB.Phone = contact.Phone;
  61.             contactDB.PostalCode = contact.PostalCode;
  62.             contactDB.Region = contact.Region;
  63.  
  64.             dev.Refresh(System.Data.Linq.RefreshMode.KeepChanges, contactDB);
  65.             dev.SubmitChanges();
  66.         }
  67.     }
  68.  
  69.     /// <summary>
  70.     /// Adiciona um Contato
  71.     /// </summary>
  72.     /// <param name="contact">Novo Contato</param>
  73.     public void AddContact(Contact contact)
  74.     {
  75.         using (DevDataContext dev = new DevDataContext())
  76.         {
  77.             dev.Contacts.InsertOnSubmit(contact);
  78.             dev.SubmitChanges();
  79.         }
  80.     }
  81.  
  82.     /// <summary>
  83.     /// Apaga um Contato
  84.     /// </summary>
  85.     /// <param name="contactId">Id do Contato</param>
  86.     public void DeleteContact(int contactId)
  87.     {
  88.         using (DevDataContext dev = new DevDataContext())
  89.         {
  90.             var contact = (from cont in dev.Contacts
  91.                             where cont.ContactID == contactId
  92.                             select cont).First();
  93.             dev.Contacts.DeleteOnSubmit(contact);
  94.             dev.SubmitChanges();
  95.         }
  96.     }
  97. }

Camada de Negócio

No projeto ContactServices.Business devemos disponibilizar Interfaces e Classes que façam chamadas aos métodos do projeto ContactServices.Data. A criação de Interfaces é importante por 3 motivos na solução:

  • Definição de um contrato para os métodos;
  • Determina um comportamento nas classes que a implementam;
  • Utilização pelo WCF Service Application (projeto ContactServices.Host);

Para implementação do projeto, crie a interface IContactServices e a classe que a implementa chamada ContactServices, conforme os códigos abaixo respectivamente:

Code Snippet
  1. [ServiceContract]
  2. public interface IContactServices
  3. {
  4.     [OperationContract]
  5.     Contact[] GetContacts();
  6.  
  7.     [OperationContract]
  8.     Contact GetContactById(int contactId);
  9.  
  10.     [OperationContract]
  11.     void UpdateContact(Contact contact);
  12.  
  13.     [OperationContract]
  14.     void AddContact(Contact contact);
  15.  
  16.     [OperationContract]
  17.     void DeleteContact(int contactId);
  18. }

 

Code Snippet
  1. public class ContactServices : IContactServices
  2. {
  3.     #region IContactServices Members
  4.  
  5.     public Contact[] GetContacts()
  6.     {
  7.         // Implemente sua propria regra de negocio
  8.         return new ContactManager().GetContacts();
  9.     }
  10.  
  11.     public Contact GetContactById(int contactId)
  12.     {
  13.         // Implemente sua propria regra de negocio
  14.         return new ContactManager().GetContactById(contactId);
  15.     }
  16.  
  17.     public void UpdateContact(Contact contact)
  18.     {
  19.         // Implemente sua propria regra de negocio
  20.         new ContactManager().UpdateContact(contact);
  21.     }
  22.  
  23.     public void AddContact(Contact contact)
  24.     {
  25.         // Implemente sua propria regra de negocio
  26.         new ContactManager().AddContact(contact);
  27.     }
  28.  
  29.     public void DeleteContact(int contactId)
  30.     {
  31.         // Implemente sua propria regra de negocio
  32.         new ContactManager().DeleteContact(contactId);
  33.     }
  34.  
  35.     #endregion
  36. }

 

A classe ContactServices disponibiliza métodos de um CRUD que serão utilizados no BCS e falam por si só. Servem como uma “casquinha” para a manipulação de dados, pois chamam diretamente os métodos da classe ContactManager do projeto ContactServices.Data.

Nesse caso não foram implementadas regras de negócio, mas se você tiver necessidade faça a implementação nesses métodos.

Host do Serviço

O projeto ContactServices.Host servirá para fazer o host do serviço WCF, que vai disponibilizar os métodos para o BCS. Para isso renomeie o arquivo criado por padrão Service1.svc para ContactServices.svc e altere a referência do serviço na diretiva de página para:

Code Snippet
  1. <%@ ServiceHost Language="C#" Debug="true" Service="ContactServices.Business.ContactServices" %>

 

Essa alteração é necessária para o mapeamento da classe ContactServices implementada no projeto ContactServices.Business. Para que o serviço seja disponibilizado também é necessária a alteração do Web.config, que pode ser editado pelo WCF Service Configuration Editor (disponível no VS2010) ou diretamente no arquivo na seção system.serviceModel conforme o código abaixo:

Code Snippet
  1. <system.serviceModel>
  2.     <services>
  3.       <service behaviorConfiguration="ContactServicesBehavior" name="ContactServices.Business.ContactServices">
  4.         <endpoint binding="wsHttpBinding" bindingConfiguration="" contract="ContactServices.Business.IContactServices" />
  5.         <endpoint address="mex" binding="mexHttpBinding" bindingConfiguration="" contract="ContactServices.Business.IContactServices" />
  6.       </service>
  7.     </services>
  8.     <behaviors>
  9.       <serviceBehaviors>
  10.         <behavior name="ContactServicesBehavior">
  11.           <serviceMetadata httpGetEnabled="true" />
  12.           <serviceDebug includeExceptionDetailInFaults="true" />
  13.         </behavior>
  14.       </serviceBehaviors>
  15.     </behaviors>
  16.   </system.serviceModel>

OBS: O behavior serviceDebug contém o atributo includeExceptionDetailInFaults para listar em detalhes qualquer problema do Web Service no Log do SharePoint, o que é bastante útil durante os testes na integração do serviço WCF.

Ao final essa solução deve estar semelhante à exibida na Figura 3:

vstudio

Figura 3 - Solução Final

Faça o deploy da solução no IIS para que utilizemos um endereço fixo na criação do ECT, que veremos a seguir.

Trabalhando com o SharePoint Designer 2010

Nessa etapa já temos a solução criada e precisamos apenas criar o ECT, mapeando os métodos e parâmetros do Web Service. A Figura 1 (Parte II) nos mostra a etapa inicial de criação do ECT, em seguida adicione uma nova conexão (1) ao Web Service pela seleção do tipo do External Data Source (2), conforme Figura 4:

conexao

Figura 4 - Criação de uma nova conexão

Defina os parâmetros de conexão conforme a Figura 5:

WCF

Figura 5 - Detalhes da conexão

OBS: Algumas considerações importantes:

  • Os metadados do WCF podem ser obtidos pelo WSDL ou utilizando o endpoint Mex. Ambos podem ser informados em Service Metadata URL / Metadata Connection Mode e estão disponíveis na solução criada.
  • A identidade do usuário (User’s Identity) será utilizada para conectar no serviço do WCF e consequentemente no banco de dados, por isso utilizamos Windows Authentication na conexão.

Após a criação da conexão é necessário criarmos as operações do CRUD para o ECT, etapa essa onde os métodos e parâmetros do Web Service serão mapeados. Para cada figura que mapeia um método temos tabelas que definem seus parâmetros de entrada e retorno (quando aplicados):

addcontact

Figura 6 - Operação AddContact

A operação AddContact da Figura 6 possui os seguintes parâmetros de entrada exibidos nas Tabelas 2 e 3:

Element .NET Type Map to Identifier Identifier Field Display Name Foreign Identifier
ContactID System.Int32 TRUE ContactID ContactID ID  
Address System.String FALSE   Address Address  
City System.String FALSE   City City  
CompanyName System.String FALSE   CompanyName Company Name  
ContactName System.String FALSE   ContactName Contact Name  
ContactTitle System.String FALSE   ContactTitle Contact Title  
Country System.String FALSE   Country Country  
Email System.String FALSE   Email E-mail  
Fax System.String FALSE   Fax Fax  
Phone System.String FALSE   Phone Phone  
PostalCode System.String FALSE   PostalCode Postal Code  
Region System.String FALSE   Region Region  
Tabela 2 - Parâmetros de Entrada da Operação AddContact

Element Default Value Filter Element Path
ContactID <<None>>   contact.ContactID
Address <<None>>   contact.Address
City <<None>>   contact.City
CompanyName <<None>>   contact.CompanyName
ContactName <<None>>   contact.ContactName
ContactTitle <<None>>   contact.ContactTitle
Country <<None>>   contact.Country
Email <<None>>   contact.Email
Fax <<None>>   contact.Fax
Phone <<None>>   contact.Phone
PostalCode <<None>>   contact.PostalCode
Region <<None>>   contact.Region
Tabela 3 - Parâmetros de Entrada da Operação AddContact (Continuação)

Vale lembrar que nenhum parâmetro de retorno se aplica na operação AddContact, portanto simplesmente ignore a tela de configuração e finalize a criação do mapeamento.

deletecontact

Figura 7 - Operação DeleteContact

A operação DeleteContact da Figura 7 possui o seguinte parâmetro de entrada exibido na Tabela 4:

Element .NET Type Map to Identifier Identifier Display Name Default Value Filter Element Path
contactId System.Int32 TRUE ContactID ID <<None>>   contactId
Tabela 4 - Parâmetro de Entrada da Operação DeleteContact

getcontactbyid

Figura 8 - Operação GetContactById

A operação GetContactById da Figura 8 possui os seguintes parâmetros de entrada e retorno exibidos nas Tabelas 5, 6 e 7:

Element .NET Type Map to Identifier Identifier Display Name Default Value Filter Element Path
contactId System.Int32 TRUE ContactID ID <<None>>   contactId
Tabela 5 - Parâmetro de Entrada da Operação GetContactById

Data Source Element .NET Type Map to Identifier Identifier Field Display Name Foreign Identifier
ContactID System.Int32 TRUE ContactID ContactID ID  
Address System.String FALSE   Address Address  
City System.String FALSE   City City  
CompanyName System.String FALSE   CompanyName Company Name  
ContactName System.String FALSE   ContactName Contact Name  
ContactTitle System.String FALSE   ContactTitle Contact Title  
Country System.String FALSE   Country Country  
Email System.String FALSE   Email E-mail  
Fax System.String FALSE   Fax Fax  
Phone System.String FALSE   Phone Phone  
PostalCode System.String FALSE   PostalCode Postal Code  
Region System.String FALSE   Region Region  
Tabela 6 - Parâmetro de Retorno da Operação GetContactById

Data Source Element Element Path Required Read-Only Office Property
ContactID GetContactById.ContactID FALSE TRUE Custom Property
Address GetContactById.Address FALSE FALSE Business Address (BusinessAddress)
City GetContactById.City FALSE FALSE Business Address City (BusinessAddressCity)
CompanyName GetContactById.CompanyName FALSE FALSE Company Name (CompanyName)
ContactName GetContactById.ContactName TRUE FALSE Full Name (FullName)
ContactTitle GetContactById.ContactTitle FALSE FALSE Title (Title)
Country GetContactById.Country FALSE FALSE Business Address Country/Region (BusinessAddressCountry)
Email GetContactById.Email TRUE FALSE Email 1 Address (Email1Address)
Fax GetContactById.Fax FALSE FALSE Business Fax Number (BusinessFaxNumber)
Phone GetContactById.Phone TRUE FALSE Business Telephone Number (BusinessTelephoneNumber)
PostalCode GetContactById.PostalCode FALSE FALSE Business Address Postal Code (BusinessAddressPostalCode)
Region GetContactById.Region FALSE FALSE Business Address State (BusinessAddressState)
Tabela 7 - Parâmetro de Retorno da Operação GetContactById (Continuação)

getcontacts

Figura 9 - Operação GetContacts

A operação GetContacts da Figura 9 não possui parâmetros de entrada a serem configurados, porém possui os seguintes parâmetros de retorno exibidos nas Tabelas 8 e 9:

Element .NET Type Map to Identifier Identifier Field Display Name Foreign Identifier
ContactID System.Int32 TRUE ContactID ContactID ID  
Address System.String FALSE   Address Address  
City System.String FALSE   City City  
CompanyName System.String FALSE   CompanyName Company Name  
ContactName System.String FALSE   ContactName Contact Name  
ContactTitle System.String FALSE   ContactTitle Contact Title  
Country System.String FALSE   Country Country  
Email System.String FALSE   Email E-mail  
Fax System.String FALSE   Fax Fax  
Phone System.String FALSE   Phone Phone  
PostalCode System.String FALSE   PostalCode Postal Code  
Region System.String FALSE   Region Region  
Tabela 8 - Parâmetro de Retorno da Operação GetContacts

Element Element Path Required Read-Only Show in Picker Timestamp Field
ContactID GetContacts.GetContactsElement.ContactID FALSE TRUE FALSE FALSE
Address GetContacts.GetContactsElement.Address FALSE FALSE FALSE FALSE
City GetContacts.GetContactsElement.City FALSE FALSE FALSE FALSE
CompanyName GetContacts.GetContactsElement.CompanyName FALSE FALSE FALSE FALSE
ContactName GetContacts.GetContactsElement.ContactName TRUE FALSE FALSE FALSE
ContactTitle GetContacts.GetContactsElement.ContactTitle FALSE FALSE FALSE FALSE
Country GetContacts.GetContactsElement.Country FALSE FALSE FALSE FALSE
Email GetContacts.GetContactsElement.Email TRUE FALSE FALSE FALSE
Fax GetContacts.GetContactsElement.Fax FALSE FALSE FALSE FALSE
Phone GetContacts.GetContactsElement.Phone TRUE FALSE FALSE FALSE
PostalCode GetContacts.GetContactsElement.PostalCode FALSE FALSE FALSE FALSE
Region GetContacts.GetContactsElement.Region FALSE FALSE FALSE FALSE
Tabela 9 - Parâmetro de Retorno da Operação GetContacts (Continuação)

updatecontact

Figura 10 - Operação UpdateContact

A operação UpdateContact da Figura 10 possui os seguintes parâmetros de entrada exibidos nas Tabelas 10 e 11:

Element .NET Type Map to Identifier Identifier Field Display Name Foreign Identifier
ContactID System.Int32 TRUE ContactID ContactID ID  
Address System.String FALSE   Address Address  
City System.String FALSE   City City  
CompanyName System.String FALSE   CompanyName Company Name  
ContactName System.String FALSE   ContactName Contact Name  
ContactTitle System.String FALSE   ContactTitle Contact Title  
Country System.String FALSE   Country Country  
Email System.String FALSE   Email E-mail  
Fax System.String FALSE   Fax Fax  
Phone System.String FALSE   Phone Phone  
PostalCode System.String FALSE   PostalCode Postal Code  
Region System.String FALSE   Region Region  
Tabela 10 - Parâmetros de Entrada da Operação UpdateContact

Element Default Value Filter Element Path
ContactID <<None>>   contact.ContactID
Address <<None>>   contact.Address
City <<None>>   contact.City
CompanyName <<None>>   contact.CompanyName
ContactName <<None>>   contact.ContactName
ContactTitle <<None>>   contact.ContactTitle
Country <<None>>   contact.Country
Email <<None>>   contact.Email
Fax <<None>>   contact.Fax
Phone <<None>>   contact.Phone
PostalCode <<None>>   contact.PostalCode
Region <<None>>   contact.Region
Tabela 11 - Parâmetros de Entrada da Operação UpdateContact (Continuação)

OBS: Reparem que na maior parte dos casos apenas a nomenclatura dos parâmetros de configuração (colunas) muda, porém os dados são os mesmos. Resolvi criar tabelas de configuração para cada operação no intuito de facilitar o mapeamento com operações separadas.

Uma vez que todas as colunas foram definidas, salve o ECT (1) e observe as operações criadas (2), as quais podem ser editadas a qualquer momento, conforme Figura 11:

savingECT

Figura 11 - Salvando o ECT

Nesse momento já é possível a criação de um External List que fará a interface visual com os dados externos no SharePoint 2010. Na mesma tela de External Content Types, visualize o menu de contexto (botão direito) e selecione a opção External List. Nomeie para “Contacts”, conforme Figura 12:

createECT

Figura 12 - Criação de um External List

Com a finalização da External List, chegamos ao propósito desse artigo. Cabe a você agora testar a External List, o que já foi explicado na Parte II do BCS. Reaproveite o mesmo teste e aplique aqui, pois ele foi criado para esse fim.

O fato de podermos utilizar um Web Service para a integração no SharePoint 2010 mostra que podemos conectar dados de qualquer sistema que disponibilize essa interface. Unifique os dados de diferentes sistemas no SharePoint 2010! Agora você sabe como fazê-lo!

Referência:
http://msdn.microsoft.com/en-us/library/ee556826(v=office.14).aspx

[]’s

Marcel Medina

Clique aqui para ler o mesmo conteúdo em Inglês.

Artigo publicado na Revista Codificando .Net e-Magazine

4. setembro 2010 Marcel Medina News (0)
Na edi&#231;&#227;o 17 da Revista Codificando .Net e-Magazine meu artigo sobre o SharePoint 2010 Developer Dashboard foi publicado.
Edicao17

Oi pessoal, gostaria de informar que nesta edição da Revista Codificando .Net e-Magazine meu artigo sobre o SharePoint 2010 Developer Dashboard foi publicado!

Essa revista foi dedicada exclusivamente ao SharePoint 2010, onde diversos especialistas abordam diferentes temas. Este é um resultado entre a parceria das comunidades Codificando .Net e CanalSharePoint.

Meu artigo em específico fala sobre o Developer Dashboard e seus modos de ativação. Também demonstro como desenvolver uma feature para facilitar a utilização do recurso, além de mostrar como visualizar os dados do dashboard graficamente.

Confira agora mesmo!

Link para a revista: http://www.codificandomagazine.com.br/revista/post/Edicao-17.aspx

[]’s

Marcel Medina

Clique aqui para ler o mesmo conteúdo em Inglês.

SharePoint 2010 Content Type Hub

1. agosto 2010 Marcel Medina Dicas e Truques (0)

Oi pessoal, tudo bem?

Nesse artigo veremos uma novidade no SharePoint Server 2010 chamada Content Type Hub, que permite a centralização e o compartilhamento de Content Types através do Metadata Service Application. Entenderemos seu funcionamento, configuração, maneiras de publicação e consumo de Content Types e, ao final, localização de erros de publicação.

Funcionamento

Bastante discutido na versão 2007, o compartilhamento de Content Types sempre foi uma questão problemática, pois uma vez que os Content Types são criados em um determinado Site Collection não podem ser compartilhados em outros Site Collections (não existe nenhum recurso OOTB disponível para isso).

Esse novo recurso é disponibilizado pelo Metadata Services Application, que mapeia o Site Collection em que compartilharemos os Content Types, o qual irá funcionar como um Hub.

A Figura 1 abaixo mostra o esquema de funcionamento do Content Type Hub:

 MSA
Figura 1 – Funcionamento (Publisher x Subscribers)

Seu funcionamento é bem simples, basicamente o Site Collection que serve como Content Type Hub publica os Content Types (Publisher) e através do Metadata Service Application os mesmos são distribuídos aos assinantes (Subscribers), podendo ser Site Collections que estão em diferentes Web Applications mesmo em diferentes Farms (se desejar).

O sincronismo dos Content Types é realizado por Timer Jobs que são executados no background. São eles:

  • Content Type Hub – Responsável pelo gerenciamento dos Content Types que serão publicados.
  • Content Type Subscriber – Responsável por publicar os Content Types do hub à Gallery de Content Types do Site Collection.

Configuração

Site Collection (Content Type Hub)

Para a criarmos o Content Type Hub é necessário que um Site Collection seja criado, para isso crie um novo Site Collection em Central Administration > Application Management > Create Site Collections, conforme Figura 2:

sitecol
Figura 2 – Criação do Site Collection

Na sequência habilite a Feature Content Type Syndication Hub em Site Actions > Site Settings > Site collection features, conforme Figura 3:

feature1
Figura 3 – Ativação da Feature Content Type Syndication Hub

OBS: Ao ativarmos essa Feature estamos provisionando o Site Collection para ser o nosso Hub.

Metadata Service Application

O Metadata Service Application é um serviço para compartilhamento de metadados, cuja principal característica é o armazenamento de keywords e term sets (o qual não abordaremos nesse artigo) e como característica opcional o de servir como Hub para Content Types.

Dentro do Farm é possível termos zero ou vários Metadata Service Application e esse critério depende totalmente do Design de sua solução. Nessa abordagem precisaremos apenas de um (1) serviço em execução, cuja connection consumirá um Content Type Hub apenas. Para consumir mais de um Content Type Hub, é necessário a criação de outro serviço para tal. Isso se aplica no caso em que você queira criar escopos diferentes de Content Types, por exemplo a separação de Content Type Hubs para consumo em uma Intranet e outro para Internet.

Aqui estamos abordando apenas o planejamento do Metadata Service Application como um Hub para Content Types, porém se você tiver interesse em explorar mais sobre esse serviço, acesse as referências deste artigo.

Podemos criar o Metadata Service Application acessando Central Administration > Application Management > Manage Service Applications > New > Managed Metadata Service. As Figuras 4 e 5 mostram os dados necessários para a criação do Service Application:

metadata3
Figura 4 – Criação de um novo Metadata Service Application (1/2)

metadata4
Figura 5 – Criação de um novo Metadata Service Application (2/2)

OBS: Um ponto importante a ser comentado é que uma vez criado o mapeamento da URL para o Content Type Hub, este não pode ser mudado via user interface. Se você quiser mudar a Url depois do Service Application estar criado, use essa abordagem para atualizar o Service Application.

Como não utilizaremos o Metadata Service Application para armazenamento de keywords e term sets, desabilite o default storage location desse serviço em Central Administration > Application Management > Manage Service Applications selecionando o Managed Metadata Service Connection e clicando em Properties, conforme a Figura 6:

metadataconn
Figura 6 – Configuração da Connection do Metadata Service Application (1/2)

E para finalizar desabilite os checkboxes conforme Figura 7:

metadataconn2
Figura 7 – Configuração da Connection do Metadata Service Application (2/2)

OBS: Apenas um (1) default storage location for keywords and term sets são permitidos em uma Web Application, portanto deixe essas opções disponíveis até que você decida realmente usá-la.

Publicação

Estou disponibilizando no Hub os Site Columns e Content Types referenciados nos posts Criando Site Columns Programaticamente via XML e Criando Content Types Programaticamente via XML, pois servirão de exemplo para publicação de Content Types.

OBS: Se você for utilizar os scripts já criados nos posts, faça o deploy apenas dos Site Columns. Para os Content Types utilize outra abordagem, conforme esse artigo Série Lições de Sharepoint – Lição 2 – Content Types – Parte I (conteúdo ainda não migrado. Favor solicitar pelo material caso tenha interesse).

Assim que esses objetos forem criados poderemos fazer a publicação dos Content Types, o que pode ser feito manualmente ou programaticamente. Irei mostrar ambos.

Cabe lembrar que, para efeito de conhecimento apenas, damos o nome de Content Type Syndication à maneira que os Content Types são organizados e compartilhados entre Listas e Libraries, o que é justamente que estamos fazendo com a publicação destes utilizando o Content Type Hub.

Manual

Nesse tipo de publicação acesse Site Actions > Site Settings > Site Content Types e para cada um dos Content Types criados acesse a opção de configuração Manage publishing for this content type conforme a Figura 8 abaixo:

publishing
Figura 8 – Publicação Manual de Content Types (1/2)

Na sequência já temos a opção de publicação, conforme a Figura 9:

publishing2 
Figura 9 – Publicação Manual de Content Types (2/2)

OBS: Pelo fato de estarmos publicando pela primeira vez, somente a opção Publish está disponível. Caso você já tenha publicado o Content Type, as outras duas opções estarão disponíveis e a atual desabilitada.

Apenas para clarificação, estou comentando as opções de publicação:

  • Publish – Disponibiliza o Content Type para ser consumido nos demais Site Collections que o referenciam.
  • Unpublish – Retrai a publicação do Content Type apenas. Sua cópia permanece nos demais Site Collections, porém seu status muda para não ser mais Read-Only.
  • Republish – Refaz a publicação do Content Type. Deve ser aplicado nos casos em houve alguma alteração no mesmo.

Código

Se preferir automatizar o processo de publicação (principalmente se você possui vários Content Types), utilize o código abaixo para tal tarefa.

Code Snippet
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using System.IO;
  6. using CommonLibrary;
  7. using Microsoft.SharePoint;
  8. using Microsoft.SharePoint.Taxonomy;
  9. using Microsoft.SharePoint.Taxonomy.ContentTypeSync;
  10. using System.Configuration;
  11.  
  12. namespace PublishingContentTypes
  13. {
  14.     public class Program
  15.     {
  16.         public static void Main()
  17.         {
  18.             try
  19.             {
  20.                 string url = ConfigurationManager.AppSettings["Url"].ToString();
  21.                 bool publish = bool.Parse(ConfigurationManager.AppSettings["Publish"].ToString());
  22.  
  23.                 using (SPSite site = new SPSite(url))
  24.                 {
  25.                     using (SPWeb web = site.RootWeb)
  26.                     {
  27.                         string contentTypeXml = Path.GetFullPath("ContentTypes.xml");
  28.  
  29.                         List<string> list = XMLHelper.ReadXML(contentTypeXml);
  30.  
  31.                         foreach (string item in list)
  32.                         {
  33.                             SPContentType ctype = web.ContentTypes[item];
  34.                             if (ctype != null)
  35.                             {
  36.                                 if (publish)
  37.                                 {
  38.                                     // Publishing
  39.                                     ContentTypeHelper.ContentTypePublish(site, ctype);
  40.                                 }
  41.                                 else
  42.                                 {
  43.                                     // Unpublishing
  44.                                     ContentTypeHelper.ContentTypeUnPublish(site, ctype);
  45.                                 }
  46.                             }
  47.                         }
  48.                     }
  49.                 }
  50.             }
  51.             catch (Exception ex)
  52.             {
  53.                 Console.WriteLine(ex.ToString());
  54.             }
  55.         }
  56.     }
  57. }

OBS: Atente-se para a utilização do namespace Microsoft.SharePoint.Taxonomy, que faz referência ao assembly Microsoft.SharePoint.Taxonomy.dll, que por sua vez só está disponível apenas no SharePoint Server 2010 (diretório 14\ISAPI).

Criei também algumas bibliotecas para facilitar o trabalho de publicação, conforme podemos ver na solução abaixo:

script
Figura 10 – Solução para publicação de Content Types

O código abaixo refere-se à classe ContentTypeHelper.cs e mostra os detalhes para publicação e retração dos Content Types:

Code Snippet
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using Microsoft.SharePoint;
  6. using Microsoft.SharePoint.Taxonomy;
  7. using Microsoft.SharePoint.Taxonomy.ContentTypeSync;
  8.  
  9. namespace CommonLibrary
  10. {
  11.     public static class ContentTypeHelper
  12.     {
  13.         public static void ContentTypePublish(SPSite hubSite, SPContentType ctype)
  14.         {
  15.             // Check to see whether the site is a valid hub site.
  16.             if (ContentTypePublisher.IsContentTypeSharingEnabled(hubSite))
  17.             {
  18.                 ContentTypePublisher publisher = new ContentTypePublisher(hubSite);
  19.  
  20.                 Console.WriteLine("Publishing the content type: " + ctype.Name);
  21.  
  22.                 // Check to see whether this content type has been published.
  23.                 if (publisher.IsPublished(ctype))
  24.                 {
  25.                     Console.WriteLine(ctype.Name + " is a published content type.");
  26.                 }
  27.  
  28.                 publisher.Publish(ctype);
  29.             }
  30.             else
  31.             {
  32.                 // The provided site is not a valid hub site.
  33.                 Console.WriteLine("This site is not a valid hub site");
  34.             }
  35.         }
  36.  
  37.         public static void ContentTypeUnPublish(SPSite hubSite, SPContentType ctype)
  38.         {
  39.             if (ContentTypePublisher.IsContentTypeSharingEnabled(hubSite))
  40.             {
  41.                 ContentTypePublisher publisher = new ContentTypePublisher(hubSite);
  42.  
  43.                 Console.WriteLine("Unpublishing the content type: " + ctype.Name);
  44.  
  45.                 // Check to see whether this content type has been published.
  46.                 if (!publisher.IsPublished(ctype))
  47.                 {
  48.                     Console.WriteLine(ctype.Name + " is not a published content type.");
  49.                 }
  50.                 else
  51.                 {
  52.                     publisher.Unpublish(ctype);
  53.                 }
  54.             }
  55.             else
  56.             {
  57.                 // The provided site is not a valid hub site.
  58.                 Console.WriteLine("This site is not a valid hub site");
  59.             }
  60.         }
  61.     }
  62. }

Faça o download da solução aqui.

Consumindo Content Types

Para consumir os Content Types do Content Type Hub, assegure-se que você está referenciando o Metadata Service Application que disponibiliza o serviço. Isso se aplica apenas no caso em que você está utilizando outro Web Application como Hub, do contrário você já está habilitado para usá-lo dentro de seu Web Application.

Verifique se você referenciou o serviço em Central Administration > Application Management > Configure service application associations. A Figura 11 mostra o cenário que acabo de comentar:

association
Figura 11 – Configurando a associação de serviços

OBS: Repare que possuo 2 Web Applications, onde o 81 funciona como Publisher e o 80 funciona como Subscriber. Ambos utilizam o mesmo serviço Managed Metadata Service.

No começo do artigo comentei rapidamente sobre os Timer Jobs que fazem o sincronismo dos Content Types, agora indo um pouco mais a fundo, se desejar acioná-los após a publicação ou retração de Content Types para uma rápida verificação, acesse Central Administration > Monitoring > Check job status e selecione o job definition desejado conforme Figuras 12 e 13:

jobdefinition
Figura 12 – Forcando a execução de jobs (1/2)

 jobdefinition2
Figura 13 – Forcando a execução de jobs (2/2)

OBS: Ao forçar a execução dos jobs acima, sempre dispare o Content Type Hub (Publisher) primeiro e depois os Subscribers. A execução é assíncrona, portanto apesar do status mudar rapidamente após o disparo do job, provavelmente este ainda estará em execução.

Observe também que existem 2 Subscribers (porta 80 e 81) mesmo estando o Hub na porta 81, justamente pois outros Site Collections dentro do mesmo Web Application podem usufruir dos Content Types.

Após a execução assíncrona, você tem a opção de verificar nos Site Collections Subscribers se os Content Types foram replicados com sucesso. Uma maneira é acessar os Content Types através de Site Actions > Site Settings > Site content types (grupo Galleries) e verificar se o Content Type está lá, conforme Figura 14:

happyend
Figura 14 – Content Types publicado :)

Outra maneira é exemplificada na seção “Troubleshooting” logo abaixo.

Troubleshooting

Nem tudo são flores no jardim, para chegar no resultado esperado você vai ter que enfrentar problemas que aparecem no meio do caminho. Bem vindo ao Mundo Real!

Para verificar erros de publicação temos 2 opções de verificação, tanto no Publisher quanto no Subscriber, o primeiro deles está disponível no Site do Content Type Hub em Site Actions > Site Settings > Content type service application error log (grupo Site Collection Administration), conforme a Figura 15 abaixo:

errorpublisher
Figura 15 – Verificando erros no Publisher

A segunda opção está disponível nos Site Collections Subscribers em Site Actions > Site Settings > Content Type Publishing (grupo Site Collection Administration) conforme Figura 16:

errorsubscriber1
Figura 16 – Verificando erros no Subscriber (1/2)

OBS: A figura acima mostra um resultado com sucesso, pois os Content Types foram publicados corretamente (o que deve acontecer em seu ambiente). Apenas para exemplificação de onde localizar possíveis erros esta figura está sendo utilizada.

Um outro ponto a ser comentado é com relação ao Refresh dos Content Types publicados. Se você desejar forçar uma atualização do Subscriber que foi alterado por algum motivo, deixe essa opção selecionada. Isso sobrescreverá os Content Types atuais com a versão do Publisher.

Acesse o link para o log de erros e também poderemos ver os erros propagados na publicação (os mesmos do Publisher) conforme Figura 17:

errorsubscriber2
Figura 17 – Verificando erros no Subscriber (2/2)

Dica do dia

***ATUALIZADO em 29/08/2011***
Features podem ser utilizadas para fazer o deploy de content types no Hub. Sempre são melhores práticas. Apenas esteja atento que isso criará uma dependência nos content types com uma FeatureId, e ao fazer isso, quando você publicar os content types a mesma Feature nos Site Collections Subscribers será necessária, para que você obtenha os content types publicados.

Outra opção é utilisar um Powershell script ou Console Application. Nesse caso quando você publicar os content types, não há nenhuma necessidade de ativar qualquer feature nos Site Collections Subscribers.

Espero que isso clarifique as opções que você tem ao fazer o deploy e publicação de content types. :)

Conclusão

Na versão do SharePoint Server 2010, o Metadata Service Application possibilita o compartilhamento de Content Types, promovendo Content Type Syndication em diferentes Site Collections de diferentes Web Applications e até em diferentes Farms!

Aproveite esse recurso para criar um novo Design compartilhando Content Types!

Referências:
http://www.wictorwilen.se/Post/Plan-your-SharePoint-2010-Content-Type-Hub-carefully.aspx
http://www.chakkaradeep.com/post/SharePoint-2010-Content-Type-Hubs
http://msdn.microsoft.com/en-us/library/ff394469.aspx
http://technet.microsoft.com/en-us/library/ee424403.aspx
http://technet.microsoft.com/en-us/library/ee519603.aspx


[]’s,

Marcel Medina

Clique aqui para ler o mesmo conteúdo em Inglês.