Migrando aplicativos de conexão de dados para usar contas de serviço gerenciadas pelo desenvolvedor
Objetivo
Migrar um aplicativo existente de conexão de dados que usa uma conta de serviço tradicional para uma nova versão que usa uma conta de serviço gerenciada pelo desenvolvedor.
Fundo
Com a descontinuação das contas de serviço tradicionais e o lançamento das contas de serviço gerenciadas pelo desenvolvedor (DMSA), os clientes que atualmente usam aplicativos de conexão de dados que dependem de contas de serviço tradicionais devem planejar passar a usar aplicativos que usam DMSAs antes da data de encerramento. Desenvolvedores e integradores terceirizados atualizarão seus aplicativos para usar DMSAs e disponibilizar novas versões aos clientes do Procore com o tempo. Este tutorial fornece algumas sugestões para preparar um plano de migração e descreve os procedimentos para trabalhar em uma migração.
Sobre o Portal do desenvolvedor Procore
O Procore Developer Portal é um recurso abrangente desenvolvido para que os desenvolvedores aprimorem a compreensão e o uso das APIs do Procore e de outras ferramentas de desenvolvimento. O portal fornece documentação, guias e recursos aprofundados para incentivar os desenvolvedores a criar aplicativos que tenham integração com a plataforma do Procore. Facilita a interação contínuo com o software de gestão de construção do Procore, permitindo que os desenvolvedores criem soluções personalizadas que ampliem as funcionalidades do Procore.
Inscrição, registro e criação de um aplicativo no Portal
Os clientes do Procore interessados em criar seus próprios aplicativos que tenham integração com a plataforma Procore podem seguir estas etapas para iniciar sua jornada de desenvolvimento:
- Inscrever-se: crie uma conta no Portal do desenvolvedor Procore.
- Inscreva-se: registre-se e crie um novo aplicativo no portal.
- Criar: use as APIs e a documentação de API do Procore para desenvolver e integrar seu aplicativo com a plataforma do Procore.
Para obter mais informações, consulte Criar aplicativos de conexão de dados do Procore com o DMSA .
Coisas a considerar
- Permissões de usuário necessárias:
- Administrador da empresa
Preparação para migração
A compreensão de suas contas de serviço tradicionais existentes pode ajudar você a planejar com eficiência uma migração bem-sucedida de um aplicativo. Antes de migrar para um aplicativo DMSA, você precisará revisar as definições de cada uma de suas contas de serviço existentes para verificar se as informações estão precisas e atualizar todas as contas de serviço nas quais as definições estejam ausentes ou incorretas.
As contas de serviço são categorizadas em dois tipos de aplicativos: "Marketplace" e "Personalizado".
- Marketplace: para contas de serviço mapeadas com aplicativos instalados ou listados na App Marketplace do Procore. É possível selecionar aplicativos em uma lista suspensa.
- Personalizado: para aplicativos personalizados que foram desenvolvidos internamente ou por terceiro integradores especificamente para sua empresa.
Observe que talvez algumas contas de serviço em sua empresa não tenham um tipo de aplicativo definido. Você precisará atualizar essas contas de serviço com o tipo correto de aplicativo antes de migrar para DMSAs. Também é uma boa oportunidade para revisar e verificar as definições existentes do tipo de aplicativo para garantir que suas contas de serviço sejam mapeadas corretamente.
Etapa 1: definir tipo de aplicativo para contas de serviço não definidas
Use as etapas a seguir para atualizar suas contas de serviço existentes nas quais o tipo de aplicativo não esteja definido.
- Acesse a ferramenta Administrador da empresa.
- Em "Definições da empresa", clique em Contas de serviço. A página Contas de serviço mostra uma lista das contas de serviço existentes em sua empresa.
Ao examinar suas contas de serviço, talvez você veja uma ou mais contas sem valor na coluna Nome do aplicativo, conforme apresentado na primeira conta no exemplo acima. Isso indica que o tipo de aplicativo desse conta de serviço está indefinido. Antes de migrar para o DMSA, você precisará atualizar essas contas.
- Localize um conta de serviço no qual o valor da coluna Nome do aplicativo está ausente e clique em Editar.
- Para a definição tipo de aplicativo, escolha uma das seguintes opções:
- Marketplace: escolha essa definição se o conta de serviço for mapeado para um aplicativo no App Marketplace do Procore. Use o menu suspenso para selecionar o aplicativo. Verifique se o aplicativo selecionado corresponde ao aplicativo que você tem na produção.
- Personalizado: escolha essa definição se o conta de serviço for usado por um aplicativo que você desenvolveu internamente ou por um aplicativo criado especificamente por um integrador de terceiro para sua empresa. Insira uma descrição para a conta, bem como o nome do desenvolvedor e endereço de e-mail.
- Clique em Atualizar.
- Repita as etapas 3 a 5 acima para todas as contas de serviço existentes em sua empresa nas quais o valor da coluna Nome do aplicativo estiver ausente.
Etapa 2: revisar e verificar mapeamentos de contas de serviço existentes
Agora que você definiu o tipo de aplicativo para todas as suas contas de serviço existentes, demorou alguns minutos para revisar cada conta e verificar se o mapeamento do tipo de aplicativo está correto e que todos os campos obrigatórios e são preenchidos conforme necessário.
Revisar contas de serviço personalizadas
- Certifique-se de que todas as contas de serviço marcadas como "Personalizado" sejam realmente usadas por integrações personalizadas e não por aplicativos do Marketplace. Se você encontrar uma conta de serviço personalizada que deve ser alterada para uma conta do Marketplace, atualize a definição Tipo de aplicativo conforme descrito na seção anterior.
- Verifique se todas as contas de serviço personalizados em sua empresa estão sendo usadas ativamente. Remova todas as contas inativas.
- Verifique se todas as contas de serviço personalizadas em sua empresa têm os campos Descrição, Nome da empresa/desenvolvedor e E-mail da empresa/desenvolvedor preenchidos com precisão. (veja acima)
Revisar contas de serviço do Marketplace
- Certifique-se de que todas as contas de serviço marcadas como "Marketplace" sejam realmente usadas por aplicativos do Procore App Marketplace que você esteja executando na produção. Se você encontrar um conta de serviço "Marketplace" que deve ser alterado para "Personalizado", atualize a configuração do Tipo de aplicativo conforme descrito na seção anterior.
- Verifique se todas as contas de serviço do Marketplace têm o aplicativo correto do Marketplace selecionado no menu suspenso. (veja acima)
Migrar aplicativos para DMSA
As etapas para migrar um aplicativo do conta de serviço tradicional para o DMSA variam de acordo com o tipo de aplicativo.
Aplicativos do Marketplace
- Entre em contato com os desenvolvedores de seus aplicativos existentes do Marketplace baseados em conta de serviço para entender quando eles esperam ter versões habilitadas para DMSA disponíveis para seus clientes. Localize a listagem do aplicativo em marketplace.procore.com e use o e-mail do desenvolvedor ou as informações de suporte para entrar em contato com o desenvolvedor.
- Formular um plano interno de comunicação com base nas datas de versão fornecidas pelo desenvolvedor, para que seus usuários finais sejam informados sobre qualquer migração pendente do aplicativo. Inclua cronogramas para mover todos os usuários para novos aplicativos e para aposentar as versões antigas.
- Assim que a versão do aplicativo habilitada para DMSA estiver disponível, siga as etapas descritas em Instalar um aplicativo de conexão de dados do Marketplace. Se não estiver claro como instalar a nova versão habilitada para DMSA de um determinado aplicativo, entre em contato com o desenvolvedor para obter informações adicionais.
- Após instalar com sucesso o novo aplicativo do Marketplace, instrua seus usuários finais a começar a usar o novo aplicativo e não a versão mais antiga.
- Depois que todos os usuários tiverem sido transferidos com êxito para o novo aplicativo, você poderá remover a conta de serviço antiga conforme descrito em Excluir uma conta de serviço e desinstalar a versão antiga do aplicativo.
Aplicativos personalizados
- Se um aplicativo personalizado tiver sido desenvolvido e mantido internamente por sua empresa, você precisará desenvolver uma nova versão do aplicativo habilitada para DMSA, conforme descrito no anúncio de descontinuação da conta de serviço. Para obter detalhes, consulte Contas de serviço gerenciadas pelo desenvolvedor . Entre em contato com apisupport@procore.com se precisar de orientação adicional.
- Se um aplicativo personalizado tiver sido criado por um desenvolvedor terceiro especificamente para sua empresa, entre em contato com eles para entender quando uma nova versão do aplicativo habilitada para DMSA estará disponível e certifique-se de que ele preencha as informações do aplicativo personalizado na interface do usuário da Conta de serviço.
- Assim que a versão habilitada para DMSA do aplicativo personalizado estiver disponível, siga as etapas descritas em Instalar um aplicativo personalizado. Se não estiver claro como instalar a nova versão habilitada para DMSA de um determinado aplicativo, entre em contato com o desenvolvedor para obter informações adicionais.
- Após instalar com sucesso o novo aplicativo personalizado, instrua seus usuários finais a começar a usar o novo aplicativo em vez da versão mais antiga.
- Depois que todos os usuários tiverem sido transferidos com êxito para o novo aplicativo, você poderá remover a conta de serviço antiga conforme descrito em Excluir uma conta de serviço e desinstalar a versão antiga do aplicativo.