Orientar os clientes durante a configuração do locatário

Aplica-se a: ISV

Use este artigo para criar o guia de configuração que você fornece aos clientes que instalam seu aplicativo multilocatário do SharePoint Embedded. O administrador do cliente é o administrador do locatário consumidor que gerencia os aplicativos incorporados do SharePoint registrados no locatário do Microsoft 365 e os contêineres que contêm o conteúdo do cliente.

Importante

Não envie aos clientes apenas um link de aplicativo. A integração do SharePoint Embedded pode exigir consentimento do administrador, registro de tipo de contêiner, atribuição de função e configuração de cobrança. Oriente o administrador do cliente em cada etapa abaixo.

Função de administrador do cliente

Informe os clientes quem deve executar a configuração. Um administrador de locatário consumidor é um Administrador Global ou um usuário atribuído à função de Administrador Integrado do SharePoint . A função está disponível no Microsoft Entra ID e no Centro de administração do Microsoft 365. Os Administradores Globais já têm essas permissões.

Para obter detalhes sobre a função, confira Instalar um aplicativo Embedded do SharePoint.

Pré-requisitos do cliente

Peça ao cliente para confirmar esses pré-requisitos antes da reunião de configuração ou da janela de instalação.

Área Requisito do cliente
Microsoft 365 Um locatário ativo do Microsoft 365 com pelo menos uma licença do SharePoint.
Função do administrador Um Administrador Global ou Administrador do SharePoint Embedded pode concluir a instalação.
Usuários Os usuários que se autenticam em contêineres incorporados do SharePoint existem no Microsoft Entra ID como membros ou convidados.
Consentimento O cliente pode examinar e conceder às permissões do Microsoft Entra que seu aplicativo solicitar.
Cobrança Uma assinatura do Azure e um grupo de recursos estarão disponíveis se o aplicativo usar a cobrança de passagem.
Suporte O cliente tem sua ID do aplicativo, contato de suporte e lista de verificação de validação.

Os usuários não precisam de uma licença do Office para colaborar em documentos do Microsoft Office armazenados em um contêiner, exceto para experiências excepcionais documentadas, como menções.

Informações a fornecer ao cliente

Forneça estes valores em seu guia de configuração:

  • Nome do produto.
  • Nome do editor.
  • ID do aplicativo proprietário.
  • ID do tipo de contêiner.
  • Nome do tipo de contêiner.
  • Modelo de cobrança.
  • Permissões do Microsoft Entra suas solicitações de aplicativo.
  • Instruções de consentimento para seu aplicativo.
  • URL de redirecionamento ou de entrada que o aplicativo usa.
  • Contato de suporte.
  • Duração de configuração esperada.
  • Etapas de validação.

Para obter diretrizes de preparação para ISV, consulte Preparar seu aplicativo para instalação do cliente.

Permissões que seu aplicativo solicita

Diga aos clientes exatamente quais permissões do Microsoft Graph seu aplicativo precisa e por quê. Os aplicativos incorporados do SharePoint são instalados com duas permissões.

Permissão Objetivo Autorização de administrador
FileStorageContainerTypeReg.Selected Registre o tipo de contêiner no locatário consumidor. A permissão do aplicativo requer o consentimento do administrador. A permissão delegada não requer consentimento do administrador, mas o usuário que registra o tipo de contêiner deve ser um Administrador do SharePoint Embedded ou um Administrador Global.
FileStorageContainer.Selected Leia e grave o conteúdo do contêiner do SharePoint Embedded para o tipo de contêiner. A permissão do aplicativo requer o consentimento do administrador. A permissão delegada não requer o consentimento do administrador.

Visão geral da configuração para clientes

Use esta sequência de alto nível em seu guia do cliente:

  1. Atribua a função de administrador correta.
  2. Examine o editor do aplicativo, as IDs dos aplicativos e as permissões solicitadas.
  3. Conceda consentimento do administrador quando necessário.
  4. Registre o tipo de contêiner incorporado do SharePoint no locatário consumidor por meio do fluxo de configuração do seu aplicativo.
  5. Configure a cobrança de passagem quando necessário.
  6. Valide se o aplicativo aparece para o administrador do cliente.
  7. Crie ou acesse um contêiner de teste.
  8. Confirme se o aplicativo pode executar as operações de arquivo esperadas.
  9. Remova ou mantenha o conteúdo de teste de acordo com a política de validação do cliente.

Etapa 1: atribuir o administrador

Peça ao cliente para escolher um administrador que possa concluir a configuração completa. Se o cliente não quiser usar um Administrador Global, ele poderá atribuir a função de Administrador Integrado do SharePoint.

Diga ao cliente para concluir a atribuição de função antes da janela de instalação. Isso evita atrasos quando a cobrança ou a validação precisa de acesso elevado.

Etapa 2: examinar o aplicativo

Peça ao administrador do cliente para revisar:

  • Identidade do publicador.
  • ID do aplicativo.
  • ID do tipo de contêiner.
  • Permissões solicitadas (consulte Permissões que seu aplicativo solicita).
  • Dados armazenados em contêineres do SharePoint Embedded.
  • Se o aplicativo permite o acesso de convidado.
  • Compromissos de suporte e resposta a incidentes.
  • Modelo de cobrança.

Se o fluxo de instalação estiver hospedado no portal de administração de SaaS, inclua capturas de tela ou valores específicos do locatário em sua entrega e mantenha os links estáveis para que os administradores do cliente possam reutilizar o guia para produção e recuperação de desastre.

O administrador do cliente concede consentimento para as permissões que seu aplicativo requer. Documente a experiência de consentimento exata do seu aplicativo em vez de enviar uma URL de consentimento bruta sem explicar o que ela faz.

Dê ao cliente esta orientação:

  1. Entre com a conta de administrador do cliente.
  2. Abra a configuração do aplicativo ou a experiência de consentimento que você fornece.
  3. Revise o editor e as permissões solicitadas.
  4. Conceda consentimento somente quando o editor e as permissões corresponderem à entrega do cliente.
  5. Registre a hora e o administrador que concluiu o consentimento.

Os administradores do cliente devem conceder consentimento apenas para a ID do aplicativo exata em seu pacote de instalação assinado. Consentir com uma ID de aplicativo diferente é um risco de segurança.

Etapa 4: Registrar o tipo de contêiner

Antes que o aplicativo possa criar e usar contêineres, o tipo de contêiner deve ser registrado no locatário consumidor. Como esse fluxo é específico do aplicativo, vincule os clientes à experiência de instalação do produto e à documentação de registro atual.

Peça ao cliente para confirmar que:

  • O fluxo de configuração usa a ID do aplicativo proprietário esperada.
  • O registro tem como destino a ID de tipo de contêiner esperada.
  • O registro é concluído no locatário do cliente.
  • Qualquer mensagem de erro é capturada com informações de tempo, locatário e correlação, quando disponíveis.

Etapa 5: configurar a cobrança quando necessário

Ignore esta etapa quando seu aplicativo usar a cobrança padrão. Se o aplicativo usar a cobrança de passagem, informe ao cliente que a cobrança incorporada do SharePoint deve ser configurada antes que os usuários possam acessar o aplicativo.

O cliente precisa de uma assinatura e um grupo de recursos válidos do Azure. Um Administrador Global configura a cobrança no Centro de administração do Microsoft 365, e o administrador que cria a relação de cobrança também precisa da função de Proprietário ou Colaborador na assinatura do Azure. Em seguida, configure a cobrança:

  1. Abra o Centro de administração do Microsoft 365.
  2. Acesse Configuração>Cobrança e licenças e selecione Ativar serviços pagos conforme o uso.
  3. Em Serviços Syntex para, selecione Aplicativos e, em seguida, selecione SharePoint Embedded.
  4. Siga as instruções na página Inserido do SharePoint para ativar os aplicativos Incorporados do SharePoint.

Aviso

Se a cobrança de repasse estiver desativada ou a assinatura vinculada do Azure for desconectada, os usuários não poderão mais criar novos contêineres. Os contêineres existentes e seu conteúdo permanecem acessíveis.

Etapa 6: validar a visibilidade da administração

Após a conclusão do consentimento, do registro e da cobrança, peça ao administrador do cliente para confirmar se o aplicativo pode ser gerenciado. Os administradores podem usar o Centro de administração do SharePoint e outras ferramentas administrativas para gerenciar aplicativos e contêineres incorporados do SharePoint.

Os administradores do cliente podem:

  • Enumerar aplicativos no locatário.
  • Enumerar contêineres de um aplicativo.
  • Exiba os detalhes do contêiner.
  • Exiba os contêineres ativos e excluídos nas experiências de administrador.
  • Gerencie rótulos de confidencialidade e configurações de compartilhamento quando houver suporte.
  • Examine o comportamento de segurança e conformidade.

Para obter etapas de validação mais detalhadas, consulte Validar instalação de aplicativo do cliente.

Lista de verificação de configuração do cliente

Dê aos clientes uma lista de verificação que eles possam assinar.

  • [ ] O administrador atribuído tem a função de Administrador Global ou Administrador Integrado do SharePoint.
  • [ ] A ID do aplicativo e o editor correspondem à entrega do ISV.
  • [ ] O consentimento do Administração é concedido para o aplicativo esperado.
  • [ ] O tipo de contêiner é registrado no locatário consumidor.
  • [ ] A cobrança de repasse está configurada, se necessário.
  • [ ] Um usuário de teste pode entrar no aplicativo.
  • [ ] Um contêiner de teste pode ser criado ou aberto.
  • [ ] Um documento de teste pode ser carregado, lido e excluído.
  • [ ] O administrador do cliente pode exibir o aplicativo ou os contêineres nas ferramentas de administração.
  • [ ] As notas de validação e os contatos de suporte são registrados.

Solução de problemas durante a instalação

Use esta tabela para rotear problemas de configuração antecipada.

Sintoma Área provável Ação
O cliente não pode conceder consentimento Permissões do Microsoft Entra Confirme a função de administrador e a ID do aplicativo.
O aplicativo não pode criar contêineres Registro ou permissões Confirme o registro e o consentimento do tipo de contêiner.
Os usuários não podem acessar um aplicativo de passagem Cobrança Confirme se a cobrança do SharePoint Embedded está ativada no locatário consumidor.
O Administração não pode gerenciar o aplicativo Função ou ferramentas Confirme a função de Administrador Incorporado do SharePoint e o acesso à ferramenta administrativa.
O aplicativo funciona para membros, mas não para convidados Identidade ou compartilhamento Confirme as identidades de convidados e as políticas de compartilhamento do cliente.

Próximas etapas

Após a instalação, valide a instalação com o administrador do cliente: Valide a instalação do aplicativo do cliente.