Validar a instalação do aplicativo do cliente

Aplica-se a: ISV

Use este artigo depois que um cliente instalar um aplicativo Embedded do SharePoint. A validação confirma se o registro do tipo de contêiner, o consentimento, a cobrança, a visibilidade da administração e as operações básicas de contêiner estão funcionando. Execute essas verificações com o administrador do cliente antes de anunciar o aplicativo aos usuários.

Metas de validação

Conclua estas metas antes de fechar a integração do cliente:

1. Confirme se o aplicativo e o tipo de contêiner estão registrados no locatário do cliente.
2. Confirme se as permissões esperadas foram concedidas.
3. Confirme se a cobrança é válida para aplicativos de passagem.
4. Confirme se o aplicativo pode criar ou acessar um contêiner.
5. Confirme se o administrador do cliente pode exibir o aplicativo e o contêiner.
6. Confirme se as operações de conteúdo funcionam para um usuário de teste.
7. Confirme se os modos de falha comuns foram descartados.

Para obter as etapas de configuração do cliente, consulte Orientar os clientes pela configuração do locatário.

People involved

A validação geralmente precisa de funções de ISV e de cliente.

Antes de começar

Colete estes valores:

• ID ou nome do locatário do cliente.
• ID do aplicativo proprietário.
• ID do aplicativo para aplicativos convidados, se o seu aplicativo os usar.
• ID do tipo de contêiner.
• Nome do tipo de contêiner.
• Modelo de cobrança.
• Comportamento de compartilhamento esperado.
• Tíquete de suporte ou registro de integração.

Etapa 1: confirmar o registro do tipo de contêiner

Confirme se o tipo de contêiner está registrado no locatário consumidor. Um aplicativo não pode criar ou interagir com contêineres até que seu tipo de contêiner seja registrado nesse locatário. Use o portal de configuração do produto ou o fluxo de registro para mostrar o estado do registro.

Peça ao administrador do cliente para abrir o centro de administração do SharePoint, vá paraAplicativos> ativos incorporados> do SharePointAplicativos instalados e verifique se o aplicativo incorporado do SharePoint está listado. O administrador do cliente pode verificar detalhes do seu aplicativo incorporado do SharePoint, como:

• A ID do aplicativo proprietário.
• A ID do tipo de contêiner.

Se o registro não for concluído, volte para Orientar os clientes pela configuração do locatário.

Etapa 2: verificar permissões

Para verificar se o aplicativo está instalado corretamente no locatário do cliente:

1. Usando o aplicativo proprietário, solicite um token de acesso para o escopo do Microsoft Graph .default no locatário consumidor.
2. Verifique se o token de acesso inclui FileStorageContainer.Selected e FileStorageContainerTypeReg.Selected na declaração (para acesso em nome de um usuário) ou roles na scp declaração (para acesso sem um usuário).
3. Use o token para obter o registro do tipo de contêiner no locatário. Se um registro for retornado, isso significa que seu aplicativo SharePoint Embedded está instalado corretamente.

Confirme se o cliente concedeu as permissões esperadas e se nenhuma ID de aplicativo inesperada foi usada.

Para a maioria das instalações do cliente, valide pelo menos estas permissões:

Valide os seguintes itens:

• Administração consentimento foi concedido por um administrador autorizado do cliente para permissões de aplicativo quando necessário.
• A ID do aplicativo consentido corresponde ao pacote de instalação do ISV.
• O conjunto de permissões inclui as permissões de registro e conteúdo esperadas para o modelo de aplicativo.
• As permissões de aplicativo convidado estão presentes quando necessário.
• O comportamento delegado e somente aplicativo corresponde ao seu design.
• Os usuários de teste estão presentes no Microsoft Entra ID como membros ou convidados.

Se o aplicativo proprietário ou qualquer aplicativo convidado não tiver permissões, retorne para Orientar os clientes por meio da configuração do locatário.

Etapa 3: verificar o status de cobrança

A validação de cobrança depende do modelo de cobrança selecionado.

Cobrança Standard

Para cobrança padrão, confirme internamente se a relação de cobrança do locatário do desenvolvedor está ativa. O cliente não precisa configurar um perfil de cobrança incorporado do SharePoint para seu aplicativo. Ainda assim, informe ao cliente como o consumo do SharePoint Embedded é tratado para seu aplicativo.

Verificar:

• O aplicativo é documentado como cobrado padrão.
• Sua equipe de operações pode monitorar o consumo.
• A entrega do cliente não solicita que ele configure a cobrança de passagem.

Cobrança de repasse

Para cobrança de passagem, nenhum usuário pode acessar o aplicativo até que o cliente configure uma cobrança válida. Peça ao administrador do cliente para confirmar a cobrança no Centro de administração do Microsoft 365.

Verificar:

• Uma assinatura válida do Azure foi conectada.
• Um grupo de recursos válido é selecionado.
• A configuração foi concluída para aplicativos incorporados do SharePoint.
• O administrador de cobrança do cliente tem permissões de proprietário ou contribuidor quando necessário.
• O cliente entende que desabilitar a cobrança interrompe o acesso do usuário.

Para obter diretrizes sobre o modelo de cobrança, consulte Escolher um modelo de cobrança para seu aplicativo.

Etapa 4: Criar ou abrir um contêiner de teste

Use o fluxo de produto normal do seu aplicativo para criar ou abrir um contêiner de teste no locatário do cliente. Não use um caminho de validação oculto que ignore as mesmas permissões e registro de tipo de contêiner usados pelos usuários de produção.

Validar:

• O aplicativo pode criar um contêiner do tipo de contêiner esperado.
• O aplicativo pode abrir um contêiner de teste existente.
• O aplicativo pode carregar um pequeno documento de teste.
• O aplicativo pode ler o documento de teste.
• O aplicativo poderá atualizar ou excluir o documento de teste se essas ações fizerem parte do produto.
• O aplicativo relata erros de uma forma que o cliente e o suporte ISV possam solucionar problemas.

Etapa 5: Verificar a administração de contêineres

Os administradores do cliente podem usar o Centro de administração do SharePoint para administrar a instalação do seu aplicativo incorporado do SharePoint e seus contêineres:

• Obtenha detalhes de contêineres para o aplicativo SharePoint Embedded.
• Exibir detalhes de um contêiner específico.
• Exiba contêineres classificados por armazenamento.
• Defina um rótulo de confidencialidade quando aplicável.
• Gerenciar contêineres excluídos, quando aplicável.
• Restaure ou exclua permanentemente os contêineres de teste somente quando pretendido.

Para obter diretrizes de administração do cliente, consulte Gerenciar contêineres no Centro de administração do SharePoint.

Etapa 6: verificar as expectativas de compartilhamento e conformidade

O SharePoint Embedded usa os recursos de segurança e conformidade do Microsoft 365. Peça ao administrador do cliente para validar as configurações que são importantes para o aplicativo:

• Comportamento de compartilhamento externo.
• Acesso de usuário convidado.
• Expectativas do rótulo de confidencialidade.
• Expectativas de retenção ou exclusão.
• Requisitos de auditoria ou revisão de conformidade.
• Exceções de política do cliente, se houver.

Se o aplicativo exigir colaboração externa, confirme se as políticas de compartilhamento de locatário do cliente permitem o comportamento pretendido. Se o compartilhamento for restrito, documente o impacto no produto antes que os usuários comecem a usar o aplicativo.

Modos de falha comuns

Use esta tabela durante a integração.

Lista de verificação de validação

Use esta lista de verificação como a aprovação final do cliente.

• [ ] O administrador do cliente concedeu consentimento de administrador para seu aplicativo.
• [ ] O registro do tipo de contêiner foi concluído.
• [ ] O administrador do cliente vê seu aplicativo incorporado do SharePoint no centro de administração do SharePoint.
• [ ] A cobrança é válida ou não é necessária para o locatário do cliente.
• [ ] O usuário de teste pode entrar em seu aplicativo.
• [ ] O contêiner de teste pode ser criado ou aberto.
• [ ] As operações de arquivo de teste funcionam.
• [ ] O administrador do cliente pode exibir o aplicativo ou contêiner nas ferramentas de administração.
• [ ] As expectativas de compartilhamento e conformidade são documentadas.
• [ ] O conteúdo do teste é removido ou retido por acordo.
• [ ] A entrega do suporte está concluída.

Após a validação

Após a validação ser bem-sucedida:

1. Registre a data, o locatário, a ID do aplicativo e a ID do tipo de contêiner.
2. Salve o modelo de cobrança e o resultado da configuração do cliente.
3. Compartilhe o registro de validação com o cliente.
4. Mova o aplicativo para a próxima etapa de lançamento ou lançamento.

Se a validação falhar, mantenha o cliente na fase de configuração e resolva a falha antes de amplo acesso do usuário.

Próximas etapas

• Visão Geral do Administrador
• Instalar um aplicativo Embedded do SharePoint
• Solução de Problemas