Explorar a estrutura de manifesto de aplicativo e o pacote de um Suplemento do SharePoint

Estrutura de pacote de Suplementos do SharePoint

Um pacote de Suplemento do SharePoint é um arquivo que possui uma extensão ".app" e está em conformidade com o Open Packaging Conventions (OPC). O pacote contém os seguintes itens:

• Manifesto do suplemento: Este é um arquivo obrigatório chamado appmanifest.xml. Ele informa ao Microsoft Office SharePoint Online sobre algumas propriedades importantes do suplemento, como o seu título e as permissões necessárias para a execução. Para obter mais informações sobre o conteúdo desse arquivo, confira Arquivo de manifesto de Suplemento para Microsoft Office SharePoint Online.

• Pacotes de soluções do Microsoft Office SharePoint Online: Opcionalmente, o suplemento pode incluir um pacote de soluções do Microsoft Office SharePoint Online (arquivo .wsp) que contém os componentes da Web do suplemento. Esses componentes podem incluir páginas, instâncias de lista, exibições, documentos, recursos com escopo da Web e outros componentes do Microsoft Office SharePoint Online. (Para obter mais informações sobre quais componentes do SharePoint podem ser incluídos em um Suplemento do SharePoint, consulte Tipos de componentes do SharePoint que podem estar em um Suplemento do SharePoint.) O arquivo .wsp também pode conter suplementos do Office. Os componentes no arquivo .wsp são implantados na Web de suplemento. Para obter um exemplo de um pacote de suplemento que inclui um pacote de solução do Microsoft Office SharePoint Online, confira Criar um suplemento hospedado pelo provedor que inclua uma lista e um tipo de conteúdo do Microsoft Office SharePoint Online personalizados.

• Hospedar recursos da Web com Ações Personalizadas ou partes de suplemento: Além dos componentes do Microsoft Office SharePoint Online implantados na Web de suplemento, um Suplemento do SharePoint também pode implantar uma ou mais ações personalizadas (itens de menu de atalho ou extensões da faixa de opções) na Web do host. Isso é feito incluindo no pacote de suplementos um recurso que não está dentro do arquivo .wsp do pacote e que implanta os componentes que vão para a Web do host. Esse recurso "solto" é chamado de recurso da Web do host.

  As partes de suplemento são implantadas na Web do host da mesma maneira. O recurso da Web do host consiste em um arquivo feature.xml padrão do Microsoft Office SharePoint Online e um ou mais arquivos elements.xml associados. Um arquivo elements.xml para uma ação personalizada, por exemplo, contém a marcação CustomAction para a ação personalizada. Ele também pode incluir marcação para partes de suplemento. Somente esses dois tipos de componentes podem estar no recurso da Web do host. Esses recursos da Web do host não são discriminados no manifesto do suplemento. No entanto, eles são "partes" no sentido do OPC, e há um relacionamento explícito do OPC entre o manifesto do suplemento e cada um desses arquivos. Para obter um exemplo de um pacote de suplemento que inclui um recurso da Web do host, confira Criar ações personalizadas para implantar com os Suplementos do SharePoint.

  Observação

  Os administradores de locatários têm a opção de instalar em lote um Suplemento do SharePoint em vários sites. Diz-se que um suplemento que foi instalado dessa maneira possui escopo de Locatário. Caso o suplemento não tenha sido instalado em lote e, em vez disso, tenha sido instalado em cada site da Web separadamente, ele possui escopo da Web. Se o recurso da Web do host incluir extensões da faixa de opções ou partes de suplemento, ele não será implantado nas Web do host se o suplemento estiver instalado em lote; portanto, apenas itens de menu de atalho serão implantados com suplementos com escopo do locatário.

  O escopo do suplemento não deve ser confundido com o escopo do recurso. O escopo do recurso determina onde os elementos em um recurso são implantados. As possibilidades são Farm, WebApplication, Site (ou seja, conjunto de sites) e Web. Somente a opção da Web é permitida para recursos nos Suplementos do SharePoint (recursos da Web do host e dentro de um .wsp em um pacote de suplementos).

  O escopo do suplemento refere-se ao escopo no qual um suplemento está instalado. As possibilidades são Web, caso em que o suplemento foi instalado em um ou mais sites, site a site, e Locatário, caso em que o suplemento foi instalado em lote para todos ou alguns subconjuntos dos sites em uma locação do cliente.

  Para obter mais informações sobre o escopo de Locatário e da Web, confira Locações e escopos de implantação dos Suplementos do SharePoint.

• Arquivos de recursos de localização (.resx): Servem para localizar aspectos do manifesto do suplemento que incluem o título do suplemento e os aspectos dos recursos da Web do host no pacote de suplementos. (Partes individuais do pacote de suplementos que estão dentro de seu próprio pacote, como arquivos .wsp, pacotes de sites do Azure e manifestos de suplemento, possuem seus próprios processos de localização que são aplicados exatamente como seriam se os itens em questão não fossem parte de um Suplemento do SharePoint.) Para ver um exemplo de pacote de suplementos que inclui arquivos .resx para um recurso da Web do host, confira Localizar Suplementos do SharePoint.

• Manifestos de Suplementos do Office: Opcionalmente, pode haver um ou mais manifestos de Suplementos do Office que cada pacote um Suplemento do Office. Esta parte pode ser incluída no pacote de suplementos apenas se o suplemento for destinado a ser carregado em um catálogo de suplementos corporativos do Microsoft Office SharePoint Online, não no marketplace público. Para mais informações, confira Publicar Suplementos do SharePoint.

Arquivo de manifesto de Suplemento do SharePoint

Todo Suplemento do SharePoint inclui um arquivo appmanifest.xml. O appmanifest.xml informa ao Microsoft Office SharePoint Online o que ele deve saber sobre o suplemento, e define as propriedades mais importantes do suplemento. Veja a seguir alguns dos itens especificados no manifesto:

• O nome interno, a ID do produto e a versão do suplemento.

• A URL da página inicial, que é a página que é aberta quando o suplemento é iniciado. Pode ser uma página na Web do suplemento, uma página baseada em nuvem ou uma página em um servidor da Web do ISV.

  Observação

  Em determinadas circunstâncias, pode haver restrições sobre o tipo de arquivo que pode ser especificado no elemento StartPage. Para obter detalhes, confira Elemento StartPage (PropertiesDefinition complexType) (Manifesto do Suplemento do SharePoint). Para combinar mais de um parâmetro de consulta no valor StartPage, você deve usar o E comercial codificado & em vez de & ou um ponto e vírgula.

• Outras propriedades do suplemento. Isso inclui o título e as localidades compatíveis com o suplemento (ambos são obrigatórios), as URLs dos serviços que lidam com os eventos de pós-instalação, pós-atualização e pré-desinstalação, e o modelo da Web a ser usado quando o suplemento da Web é criado.

• Solicitações de permissões que o suplemento precisa para recursos do Microsoft Office SharePoint Online fora da Web do suplemento.

• Uma identificação, para fins de autenticação e autorização, da entidade de segurança do suplemento. É essa entidade de segurança que recebe as permissões. Isso não é necessário para um suplemento hospedado pelo Microsoft Office SharePoint Online.

• Uma lista dos pré-requisitos, se houver, que devem estar disponíveis para o suplemento para que o suplemento seja instalado. Por exemplo, certos recursos podem precisar ser instalados e ativados, e certos serviços podem precisar ser licenciados e instalados.

Para obter informações detalhadas sobre a marcação de manifestos de suplementos, confira Esquema de referência para manifestos de Suplementos do SharePoint. Este tópico não substitui as informações nesse nó, incluindo informações sobre os elementos e atributos necessários. Além disso, observe que os manifestos de Suplementos do SharePoint têm um esquema diferente dos manifestos de Suplementos do Office. Você pode encontrar informações sobre este último em Esquema de referência para manifestos de Suplementos do Office (v1.1).

Veja a seguir um exemplo de arquivo appmanifest.xml. Observe que, neste exemplo, a página inicial do suplemento é uma página ASP.NET que está em um servidor remoto, não uma página no site do Microsoft Office SharePoint Online. A URL da página inclui uma cadeia de caracteres de consulta que transmite a URL da Web do host ao aplicativo Web remoto. A parte {HostUrl} da cadeia de caracteres é um token que é resolvido quando o suplemento é iniciado. O suplemento está solicitando permissão de Gravação para todas as listas na Web do host. A entidade de segurança do suplemento que deve receber essa permissão é o aplicativo Web remoto.

Você deve usar o elemento SupportedLocales ou SupportedLanguages no manifesto do suplemento. O elemento SupportedLanguages está sendo descontinuado em favor do SupportedLocales. O elemento SupportedLanguages continuará a funcionar mesmo após o lançamento, mas você deve evitar usá-lo. Para obter mais informações sobre esses elementos, confira o elemento SupportedLocales (PropertiesDefinition complexType) (Manifesto de Suplemento do SharePoint) e o elemento SupportedLanguages (PropertiesDefinition complexType) (Manifesto de Suplemento do SharePoint).

<?xml version="1.0" encoding="utf-8" ?>
<App xmlns="http://schemas.microsoft.com/sharepoint/2012/app/manifest"
     ProductID="{4a07f3bd-803d-45f2-a710-b9e944c3396e}"
     Version="1.0.0.0"
     SharePointMinVersion="15.0.0.0"
     Name="MySampleApp"
>
  <Properties>
    <Title>My Sample App</Title>
    <StartPage>http://MyRemoteWebApplicationServer/default.aspx/?SPHostUrl={HostUrl}</StartPage>
    <SupportedLocales>
      <SupportedLocale CultureName="en-US" />
    </SupportedLocales>        
  </Properties>

  <AppPermissionRequests>
    <AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web/list" Right="Write"/>
  </AppPermissionRequests>

  <AppPrincipal>
    <RemoteWebApplication ClientId="1ee82b34-7c1b-471b-b27e-ff272accd564" />
  </AppPrincipal>
</App>

Tokens de URL no manifesto do suplemento

O SharePoint fornece vários tokens que podem ser usados no elemento StartPage e em outros locais em suplementos e componentes de suplementos para representar informações que não são conhecidas até que o suplemento seja executado. A infraestrutura do Microsoft Office SharePoint Online resolve esses tokens. Alguns são usados no início da URL, e outros podem ser usados em uma URL, como o valor de um parâmetro de consulta. Esses tokens e vários outros também podem ser usados em vários contextos de desenvolvimento do Microsoft Office SharePoint Online.

Para obter informações detalhadas sobre todos os tokens e onde eles podem ser usados, confira Cadeias de caracteres e tokens de URL nos Suplementos do SharePoint. Para obter informações gerais sobre outros tokens e URLs no Microsoft Office SharePoint Online, confira URLs e tokens no Microsoft Office SharePoint Online.

Confira também

• Desenvolver suplementos do SharePoint
• Aspectos importantes do cenário de desenvolvimento e da arquitetura dos Suplementos do SharePoint
• Conexão de Aplicativo da Camada de Dados (DAC)
• Web Deploy 2.0