Share via

Transformar soluções de área restrita para o modelo de suplemento do SharePoint

  • Artigo

Transformar suas soluções de área restrita no modelo de Suplementos do SharePoint envolve a análise de suas extensões existentes, o design e o desenvolvimento de seus novos Suplementos do SharePoint e, em seguida, o teste e a implantação de seu suplemento em seu ambiente de produção.

Observação

As soluções de área restrita baseadas em código foram preteridas em 2014, e o SharePoint Online iniciou o processo para remover completamente esse recurso. As soluções de área restrita baseadas em código também foram preteridas no SharePoint 2013 e no SharePoint 2016.

Soluções de área restrita baseadas em código no SharePoint

As soluções de área restrita são pacotes de personalização que podem ser usados para implantar personalizações no SharePoint no nível do conjunto de sites. Se uma solução de área restrita contiver código, ela será executada em um processo isolado especial com um conjunto limitado de APIs para acessar serviços e conteúdo do SharePoint.

Existem dois tipos de soluções de área restrita:

  • Soluções de área restrita baseadas em código, que contêm um assembly personalizado no pacote.
  • Soluções declarativas de área restrita, que contêm apenas configurações baseadas em XML e ativos relacionados.

As soluções de área restrita declarativas (baseadas em XML) podem ser divididas nos seguintes tipos com base em seus casos de uso:

  • Modelo de site - gerado usando a funcionalidade "Salvar site como modelo" de sites existentes.
  • Pacote design - gerado usando o Gerenciador design no site de publicação.
  • Soluções de área restrita personalizadas - criadas no Visual Studio, por exemplo, para ativos de identidade visual, e não contêm assemblies.

As soluções de área restrita baseadas em código podem ser divididas nos seguintes tipos com base em seus casos de uso:

  • Solução declarativa de área restrita com assembly vazia
  • Solução de área restrita contendo o formulário do InfoPath com código
  • Soluções de área restrita baseadas em código com personalizações como web parts, receptores de eventos e/ou receptores de recursos
  • Soluções de área restrita com ação personalizada de fluxo de trabalho

Quando você planejar se afastar das soluções de área restrita, avalie os requisitos funcionais e comerciais de uma solução específica e determine a direção futura do design com base nisso.

Planejando o processo de transformação

Quando você transforma suas soluções de área restrita para o modelo de Suplemento do SharePoint, você quer garantir que o impacto sobre seus usuários seja mínimo. Analise com cuidado suas soluções de área restrita atuais e, em seguida, projete seu novo Suplemento do SharePoint para atender às necessidades de sua organização. Recomendamos o seguinte processo para garantir uma transformação bem-sucedida.

Preparação

Saiba mais:

Avaliação da solução

Analise os requisitos comerciais e funcionais por meio de:

  • Identificação soluções de área restrita implantadas em seu ambiente atual, para as quais você pode usar uma das seguintes ferramentas fornecidas como código aberto pela equipe de PnP do SharePoint:

  • Analisando requisitos com seus usuários. Considere pedir a seus usuários que demonstrem como usam as soluções de área restrita existentes para realizar seu trabalho diário.

  • Identificar, documentar e projetar novas funcionalidades para incluir no novo Suplemento do SharePoint. Considere analisar sua lista de novas solicitações de recursos de seus usuários para ter ideias adicionais.

  • Identificar recursos não utilizados e concordar com seus usuários para omitir essa funcionalidade do novo Suplemento do SharePoint.

  • Para cada solução, determinando se deve substituí-la por um Suplemento do SharePoint ou implementá-la usando recursos fora da caixa ou uma solução alternativa.

Planejamento de soluções

Projetar o novo aplicativo usando o modelo de Suplemento do SharePoint com base em:

  • Os requisitos reunidos na etapa de Avaliação de soluções.

  • Sua análise do código existente. Durante sua análise de código, considere identificar de partes do código que podem ser descartadas (por exemplo, o código não está mais sendo usado ou os requisitos foram alterados).

Desenvolver e testar a versão de modelo do Suplemento do SharePoint do seu aplicativo

Esta é geralmente a etapa mais demorada no processo de transformação.

Implante seu novo suplemento

Certifique-se de que sua implantação esteja estável e envie um aviso apropriado para seus usuários.

Substituindo personalizações da solução de área restrita

A seguir estão personalizações típicas incluídas nas soluções de área restrita, bem como possíveis opções de transformação. Estamos pensando em adicionar mais informações para cada um dos tipos de personalização, para que você possa ter exemplos realistas sobre as opções de transformação.

Personalização Opções de transformação
Solução declarativa com assembly vazia

Você pode controlar a criação de assemblies a partir das propriedades do projeto de solução do Visual Studio. Para mais informações, consulte Remover a referência de assembly da sua solução de área restrita criada no Visual Studio.



Importante: Quando você usa o scanner do SharePoint de Solução de Área Restrita, a saída de verificação lista quais soluções têm um conjunto vazio e a ferramenta cria pacotes de solução de área restrita atualizados para você nos quais a assembly é descartada. Você pode então simplesmente substituir a solução de área restrita existente pela atualizada.
Formulário do InfoPath com códigos

Se você publicou um formulário do InfoPath a partir do cliente InfoPath que contém código, ele será publicado no SharePoint como uma solução de área restrita. Isso significa que o código do formulário é realmente executado pelo mecanismo de área restrita no SharePoint.

Afastar-se dos formulários do InfoPath baseados em código depende do caso de uso de negócios real. Existem várias opções, desde gerar uma interface do usuário personalizada como suplementos até utilizar outras técnicas de formulário.

Para obter mais informações, consulte Corrigir o InfoPath em soluções de área restrita.
Web Part

Geralmente, as Web parts são convertidas em partes complementares ou implementadas com tecnologias totalmente do lado do cliente, usando o padrão embed do JavaScript.

Para saber mais, veja:
Web part visual

Web parts visuais são transformadas de maneiras semelhantes às web parts comuns. Os controles de usuário usados em web parts visuais devem ser substituídos porque, nos casos de solução de área restrita, estão incluídos dentro da assembly.
Receptor de eventos

Os receptores de eventos podem, em muitos casos, ser substituídos pela implementação do receptor de eventos remotos. No entanto, os receptores de eventos remotos precisam ser hospedados em alguma plataforma, geralmente em suplementos hospedados por provedores específicos.

Para saber mais, veja:
Receptor de recurso

Geralmente, os receptores de recursos são substituídos por uma operação remota baseada em API, como o uso de CSOM ou REST para aplicar a personalização ou a configuração necessária no nível do site. Se uma API necessária estiver ausente das APIs remotas (CSOM/REST), relate essa lacuna usando o UserVoice do SharePoint.

Receptores de recursos são usados, por exemplo, para definir uma página mestra ou tema personalizado para um site quando eles são ativados. Esses tipos de operações podem ser facilmente substituídos por soluções baseadas em código remoto ou usando o PnP do PowerShell, que fornece comandos fáceis para controlar a configuração do site.
Ação personalizada do fluxo de trabalho

O caminho de migração de código típico para esses tipos de personalizações é usar fluxos de trabalho do SharePoint ou soluções alternativas, como o Microsoft Flow ou soluções de terceiros.

Removendo o código de área restrita do seu site

Quando você desativa sua solução de área restrita existente em sites, todos os ativos ou arquivos implantados usando opções declarativas não serão removidos. Se você usou soluções de área restrita para introduzir novas web parts baseadas em código, essas funcionalidades serão desativadas nos sites. Isso significa que as páginas ainda estão processando normalmente, portanto, não há impacto direto do usuário final quando a solução é desativada, exceto a remoção das funcionalidades baseadas em código, como web parts.

Removendo o suporte para soluções de área restrita baseadas em código

O suporte a soluções de área restrita baseadas em código será removido do SharePoint Online, desabilitando operações baseadas em código que são executadas a partir de um código baseado em solução de área restrita. Isso significa que suas soluções de área restrita não são desativadas explicitamente no repositório de soluções, mas qualquer operação baseada em código não será mais executada. As soluções de área restrita permanecerão com status ativado na galeria de soluções. Os recursos implantados com o uso de soluções de área restrita não serão desativados automaticamente, o que significa que um possível código associado à desativação de recursos ou desinstalação dos manipuladores não será executado.

Todas as definições declarativas na solução de área restrita continuarão funcionando depois que essa alteração for aplicada no SharePoint Online.

Nesta seção

Confira também