Implantar elementos de site usando Recursos (SharePoint Server 2010)

Aplica-se a: SharePoint Server 2010

Tópico modificado em: 2016-11-30

Este artigo descreve como implantar personalizações de elementos de sites desenvolvidos usando Recursos. Usando Recursos, você pode controlar o escopo no qual a personalização de sites pode ser ativada e desativada, além de implantar personalizações facilmente entre vários farms de servidores.

Nesta seção:

• O que é um Recurso?

• Quando usar Recursos

• Criar um Recurso

• Instalar e ativar um Recurso usando o Windows PowerShell

O que é um Recurso?

Um Recurso é um contêiner de várias extensões definidas para o SharePoint Server 2010, sendo composto por um conjunto de arquivos XML que são implantados em servidores Web front-end e servidores de aplicativos. Você pode implantar um Recurso como parte de um pacote de solução e pode ativar um Recurso individualmente em sites do SharePoint Server.

Recursos reduzem a complexidade envolvida na criação de personalizações de sites simples. Além disso, como dispensam a necessidade de copiar extensos blocos de código para alterar uma funcionalidade simples, eles diminuem os problemas de controle de versão e as inconsistências que podem surgir entre servidores Web front-end.

Recursos tornam mais fácil ativar ou desativar a funcionalidade durante a implantação, e os administradores podem transformar facilmente o modelo ou a definição de um site ativando ou desativando um Recurso em particular na interface do usuário.

Um elemento é uma unidade atômica em um Recurso. O elemento Feature é usado em um arquivo Feature.xml para definir um Recurso e especificar o local de assemblies, arquivos, dependências ou propriedades que oferecem suporte ao Recurso. Um Recurso inclui um arquivo Feature.xml e qualquer número de arquivos que descrevam elementos individuais. Outro elemento Feature de um esquema diferente é usado em um arquivo Onet.xml para especificar que um Recurso seja ativado quando um site for criado a partir de uma definição de site.

Em geral, um arquivo Feature.xml aponta para um ou mais arquivos XML cuja marca <Elements> de nível superior contenha definições para elementos que oferecem suporte para o Recurso. Os elementos no SharePoint Server 2010 geralmente correspondem a nós discretos no arquivo Onet.xml ou Schema.xml do Microsoft Office SharePoint Portal Server 2003. Há vários tipos de elementos — por exemplo, um item de menu personalizado ou um manipulador de eventos.

• Para obter mais informações sobre as funcionalidades dos Recursos, consulte o artigo sobre o uso de Recursos (https://go.microsoft.com/fwlink/?linkid=183450&clcid=0x416).

• Para obter informações específicas sobre o formato de arquivo e os elementos XML usados no arquivo Feature.xml, consulte o artigo sobre os arquivos Feature.xml (https://go.microsoft.com/fwlink/?linkid=183451&clcid=0x416).

• Para obter informações sobre como os recursos afetam o formato do arquivo Onet.xml em uma definição de site, consulte o artigo sobre os arquivos de definição de site (Onet.xml) (https://go.microsoft.com/fwlink/?linkid=183454&clcid=0x416).

• Para obter mais informações sobre os tipos de elementos de Recurso, consulte o artigo sobre os tipos de elementos (https://go.microsoft.com/fwlink/?linkid=183455&clcid=0x416).

Quando usar Recursos

Recursos são o método recomendado de implantar partes de uma funcionalidade, personalizações ou alterações de configuração em servidores Web front-end. Também são uma maneira flexível de gerenciar o ciclo de vida de uma funcionalidade, incluindo os processos de ativação, atualização e consequente desativação.

Você pode usar Recursos para implantar elementos de sites desenvolvidos em um ou mais dos seguintes cenários:

• Necessidade de ativação e desativação Ao implantar personalizações de elementos de sites em um Recurso, você pode instalar, ativar e desativar esse Recurso usando o Windows PowerShell ou o modelo de objeto. Também pode ativar e desativar um Recurso usando o site de Administração Central.

• Flexibilidade de escopo Você pode ativar um Recurso para um único escopo, incluindo farm, aplicativo Web, conjunto de sites ou site.

• Facilidade de implantação distribuída É fácil implantar um Recurso em vários farms de servidores como parte de uma solução.

• Controle através do modelo de objeto de Recurso   O modelo de objeto de Recurso permite especificar a lista de recursos instalados em um determinado escopo e controlar se esses recursos estão habilitados nos níveis de farm e de site.

Use pacotes de solução para acondicionar Recursos para implantação em ambientes diferentes. Por exemplo, use um pacote de solução para implantar personalizações entre estações de trabalho de desenvolvedores e um farm de integração e também entre um farm de integração ou estações de trabalho cliente de criação e farms pilotos ou de produção.

Criar um Recurso

Quando você cria uma página da Web personalizada no SharePoint Server 2010 usando o navegador ou o SharePoint Designer, a página ASPX pode pertencer apenas ao conjunto de sites raiz do servidor que executa o SharePoint Server 2010. Para criar uma página em um conjunto de sites que esteja disponível para o farm inteiro e em todos os conjuntos de sites, use uma solução para implantar essa página na pasta \14\Template\Layouts (usando o elemento TemplateFiles no arquivo de manifesto da solução).

Uma prática recomendada em um farm é implantar Recursos usando um pacote de solução. Se for necessário reconstruir um servidor ou se outro servidor for adicionado ao farm, o Recurso não precisará ser manualmente adicionado a cada servidor Web front-end. Usando pacotes de solução, é possível implantar Recursos novos e atualizados por todo o farm e sincronizar um servidor Web front-end de modo que o seu estado seja consistente com o estado dos outros servidores no farm.

Para controlar a disponibilidade de uma página personalizada em um site ou conjunto de sites, implante a página da Web personalizada como um Recurso do SharePoint que seja parte de uma solução. Use o elemento Module no arquivo Feature.xml para implantar uma página da Web usando um escopo de site e um conjunto de sites. Módulos são frequentemente usados para implementar uma Página de Web Parts no site.

Um Recurso implantado como parte de uma solução é instalado automaticamente. Se você implantar um Recurso manualmente, precisará instalá-lo e ativá-lo. Consulte Install and activate a Feature by using Windows PowerShell, mais adiante neste artigo.

Para criar e implantar um Recurso personalizado

1. Crie um arquivo Feature.xml. Veja a seguir um exemplo de arquivo Feature.xml, que é necessário para conceder ao recurso uma ID exclusiva e apontar para o arquivo Module.xml.

   <?xml version="1.0"?>
   <Feature Id="8C4DD0CB-5A94-44da-9B7F-E9ED49C2B2DC" Title=
   "Custom Web page"
   Description="This simple example feature adds an ASPX page 
   with a hosted XmlFormView control" 
   Version="1.0.0.0" Scope="Web"
   xmlns="https://schemas.microsoft.com/sharepoint/">
   <ElementManifests>
       <ElementManifest Location="Module.xml"/>
   </ElementManifests>
   </Feature>
   

2. Crie um arquivo Module.xml. Veja a seguir um exemplo de arquivo Module.xml, que contém informações sobre a página (ou páginas) que faz parte da solução.

   <?xml version="1.0"?>
   <Elements xmlns="https://schemas.microsoft.com/sharepoint/">
       <module name="file" url="" path="">
           <file url="XmlFormViewPage.aspx" type="ghostable"> </file>
       </module>
   </Elements>
   

3. Substitua o valor url do arquivo pelo nome da sua página ASPX.

4. Adicione uma subpasta para a definição de Recurso ao diretório de instalação de Recursos no computador servidor, geralmente localizado em %COMMONPROGRAMFILES%\Microsoft shared\Web server extensions\14\TEMPLATE\FEATURES.

   Importante

   Uma prática recomendada é usar nomes detalhados e qualificados para as subpastas criadas para definições de Recursos. Essa prática diminui as chances de você adicionar vários Recursos com nomes idênticos e de substituir o arquivo Feature.xml de outro Recurso. Por exemplo, use Contrato_RH e Contrato_Finanças em vez de simplesmente Contrato.

5. Adicione sua página .aspx personalizada a essa subpasta para a definição de Recurso.

6. Adicione os arquivos Feature.xml e Module.xml ao mesmo local.

7. Adicione o Recurso a um pacote de solução.

   Você pode usar o Visual Studio 2010 para adicionar o Recurso a uma solução ou pode adicionar manualmente um elemento FeatureManifests ao arquivo Manifest.xml da solução.

8. Crie o pacote de solução.

   Você pode usar o Visual Studio 2010 ou a ferramenta Makecab.exe para criar o pacote de solução.

9. Importe e implante o pacote de solução.

   Adicione a solução ao repositório de soluções usando o cmdlet Add-SPSolution do Windows PowerShell e depois implante a solução do repositório usando o site da Administração Central ou o Windows PowerShell.

Para obter mais informações sobre o uso do Visual Studio 2010 para adicionar Recursos a pacotes de solução, consulte o artigo sobre criação de pacotes de solução do SharePoint (https://go.microsoft.com/fwlink/?linkid=187035&clcid=0x416). Para obter mais informações sobre como criar manualmente um pacote de solução ou sobre o uso da ferramenta Makecab.exe para criar o pacote, consulte o artigo sobre criação de uma solução (https://go.microsoft.com/fwlink/?linkid=187036&clcid=0x416). Para obter mais informações sobre a implantação de soluções, consulte Implantar pacotes de solução (SharePoint Server 2010).

Instalar e ativar um Recurso usando o Windows PowerShell

Você pode instalar e ativar um Recurso usando o Windows PowerShell ou o modelo de objeto. Também pode ativar um Recurso usando a página Gerenciar Recursos de Aplicativos Web ou a página Recursos do site ou conjunto de sites em que deseja ativar esse Recurso. A instalação de um Recurso torna a sua definição e os seus elementos conhecidos por todo um farm de servidores, enquanto sua ativação o torna disponível em um determinado escopo.

Você instala Recursos na pasta 14\Template\Features, com cada Recurso em sua própria subpasta. Na raiz dessa pasta, um arquivo Feature.xml define o conteúdo do Recurso. É necessário instalar Recursos individuais para poder usá-los e, a não ser que os seus escopos estejam definidos para o farm,  esses Recursos precisam ser ativados após a instalação. Se um Recurso tiver o escopo definido para o farm ou aplicativo Web, ele será automaticamente ativado.

Para desinstalar um Recurso de forma que a sua definição deixe de ficar disponível em um farm de servidores, primeiro é necessário desativá-lo usando o cmdlet Disable-SPFeature do Windows PowerShell, a não ser que esse Recurso tenha o escopo definido para aplicativos Web ou farms. Após a desativação do Recurso, você pode usar o cmdlet Uninstall-SPFeature para desinstalá-lo. Para obter mais informações, consulte Uninstall-SPFeature. Depois de desinstalar um Recurso, redefina o IIS (Serviços de Informações da Internet) para que as alterações possam ser efetivadas.

Para desativar um Recurso de forma que ele se torne inativo no seu escopo originalmente atribuído sem desinstalá-lo, você pode usar o cmdlet Disable-SPFeature. Para obter mais informações, consulte Disable-SPFeature.

Use os procedimentos a seguir para instalar e ativar um Recurso.

Para instalar um Recurso usando o Windows PowerShell

1. Verifique se você atende aos seguintes requisitos mínimos: Consulte Add-SPShellAdmin.

2. No menu Iniciar, clique em Todos os Programas.

3. Clique em Produtos do Microsoft SharePoint 2010.

4. Clique em Shell de Gerenciamento do SharePoint 2010.

5. No prompt de comando do Windows PowerShell, digite o seguinte comando:

   Install-SPFeature -path <Path> [-force]
   

   Em que:

   • <Path> é um caminho de arquivo válido, como MeuRecurso. O caminho para o recurso deve ser um caminho literal para o nome da pasta 14\Template\Features. O nome do arquivo Feature.xml está implícito e não precisa ser fornecido.

Para obter mais informações, consulte Install-SPFeature.

Para ativar um recurso usando o Windows PowerShell

1. Verifique se você atende aos seguintes requisitos mínimos: Consulte Add-SPShellAdmin.

2. No menu Iniciar, clique em Todos os Programas.

3. Clique em Produtos do Microsoft SharePoint 2010.

4. Clique em Shell de Gerenciamento do SharePoint 2010.

5. No prompt de comando do Windows PowerShell, digite o seguinte comando:

   Enable-SPFeature -Identity <FeatureID> [-url] <URLname> [-force]
   

   Em que:

   • <IDdoRecurso> é o nome da pasta de Recurso localizada na pasta 14\Template\Features e precisa ser um caminho de arquivo válido, como MeuPersonalizado.

   • <NomedaURL> é a URL pai de Recursos do aplicativo Web, site ou conjunto de sites para o qual o Recurso está sendo ativado, como http://algumsite.

Para obter mais informações, consulte Enable-SPFeature.