Melhores práticas de uso do serviço de Relatórios Organizacionais do Microsoft Learn
Este artigo descreve as melhores práticas de uso do serviço de Relatórios Organizacionais do Learn.
Entender o Contrato de Compartilhamento e Acesso a Dados do Microsoft Learn
Ao usar esse serviço de compartilhamento de dados, você reconhece e aceita o Contrato de Acesso a Dados e Compartilhamento do Microsoft Learn para permitir que a Microsoft compartilhe dados do Learn com sua organização para usuários do Learn conectados com a ID de locatário da sua organização. Leia e entenda este contrato antes de usar o serviço de Relatórios Organizacionais do Microsoft Learn e incluir a saída em qualquer ambiente de produção.
Planejar qual solução de relatório você usará para visualizar os dados oferecidos neste serviço
O serviço de Relatórios Organizacionais do Microsoft Learn fornece dados de conclusão brutos para organizações e não tem nenhum dashboard por padrão. Você pode pegar os dados e exportá-los para CSV para exibir rapidamente os dados, mas eles precisam ser unidos para serem impactantes.
Foi fornecido um modelo do Power BI de relatórios organizacionais do Learn para armazenamento do BD SQL com muitas visualizações de dados padrão, mas também é possível usar qualquer solução de relatório de sua escolha. Planeje com antecedência o que deseja usar, para que você possa conectá-la ao armazenamento de dados como parte do processo de instalação.
Entender o modelo de conteúdo do Learn
Para usar a resposta efetiva do serviço de Relatórios Organizacionais do Microsoft Learn, é importante entender os tipos de conteúdo disponíveis no Microsoft Learn e as relações entre eles. Leia o artigo Tipos de conteúdo do Learn para obter mais informações.
Observação:
- UID significa "ID exclusiva" e é exclusiva para cada objeto de conteúdo. Se uma UID for alterada, mesmo que o título ou outros metadados permaneçam iguais, o conteúdo será considerado um novo objeto.
- Os módulos são o objeto principal no catálogo de treinamentos do Learn. Todos eles são autônomos, no sentido de ensinar um cenário ou conceito de ponta a ponta neles e não exigem a realização de módulos como pré-requisito. Para alguns deles, é assim, e eles não fazem parte de um roteiro de aprendizagem. Para outros, eles são agrupados em um ou mais roteiros de aprendizagem que levam um usuário a acompanhar a criação de conceitos mais avançados. Um módulo não precisa fazer parte de um roteiro de aprendizagem ou pode fazer parte de um ou mais.
- As unidades não são gravadas como conteúdo autônomo. Elas devem ser seguidas em uma ordem específica para o módulo. Por esse motivo, incluímos o link para a página de detalhes do módulo e a primeira unidade para que os usuários possam começar lá e prosseguir com o conteúdo.
Entender como a localização funciona no Learn e como o conteúdo localizado é refletido na saída dos Relatórios Organizacionais
O Microsoft Learn dá suporte a mais de 65 localidades no site e grande parte do conteúdo foi traduzido para elas. Nosso objetivo é disponibilizar o conteúdo em todos os idiomas nos quais os produtos que estão sendo ensinados no conteúdo estão disponíveis, mas nem todas as experiências de localidade têm conteúdo traduzido disponível.
Quando um registro de localidade não tem a tradução associada disponível, o conteúdo no site e a resposta à API fazer o "fallback" para o inglês como padrão. No caso da saída da API, você verá metadados em inglês em outras respostas de localidade quando ocorrer o fallback. No entanto, a URL do conteúdo ainda apontará para a localidade, mesmo que o conteúdo principal faça fallback e o motivo seja permitir que o usuário ainda navegue pelo site nessa localidade (que mostrará o cabeçalho/rodapé traduzido e qualquer outro link que tenha tradução disponível).
Quando as atualizações são publicadas no conteúdo em inglês, nossos pipelines de localização funcionam para que as versões localizadas sejam atualizadas o mais rápido possível, geralmente em poucos dias após a alteração original. Você pode ver uma lista completa de localidades com suporte no rodapé do site (selecione o link para o idioma no qual você está exibindo o site).
Nossos registros de conclusão de conteúdo de treinamento são independentes de localidade, ou seja, não consideramos as versões localizadas do conteúdo como objetos separados em nossos registros de conclusão de treinamentos do usuário. Não importa em qual idioma um usuário conclua um treinamento, ele receberá crédito pelo objeto geral, e não armazenaremos uma referência em qual idioma ele foi concluído. Isso significa que, se você implementar os dados do serviço de Relatórios Organizacionais do Learn em sua experiência de aprendizagem, precisará levar isso em conta e, se carregar os objetos de conteúdo como objetos separados, implemente uma equivalência entre eles para que, independentemente do idioma que o usuário concluir o treinamento, ele receba crédito por isso em outros idiomas e não precise refazê-lo.
Entender como o controle de versão de conteúdo funciona no Learn e como ele é refletido na saída dos Relatórios Organizacionais
É preciso ressaltar que o conteúdo está sendo atualizado o tempo todo. Publicamos atualizações normalmente duas vezes por dia. Elas podem ser menores, como pequenas alterações de texto ou grandes, como revisões, adições ou exclusões significativas. Em geral, o portfólio de conteúdo é gerenciado como um projeto de código aberto massivo e altamente controlado, com milhares de colaboradores e, como tal, as alterações acontecem o tempo todo. Se você usar os dados do serviço de Relatórios Organizacionais do Learn em seu sistema de produção, deverá estar ciente disso e seu sistema precisará lidar com isso.
Quando novos objetos de conteúdo forem adicionados, eles aparecerão como um novo objeto (identificado pela UID) na resposta. Quando o conteúdo é modificado, é possível saber com base no valor last_modified. Se o conteúdo for excluído, ele será removido da resposta. Embora às vezes haja um pequeno atraso no conteúdo que está sendo atualizado na resposta da API, quando um usuário segue a URL até o conteúdo, ele sempre verá as informações mais atuais. No caso de exclusões, a URL antiga será redirecionada para o novo conteúdo ou para a nova experiência.
Não há referências a versões de conteúdo no momento além da data last_modified.
Entender as limitações do serviço de Relatórios Organizacionais
Confira as limitações no artigo de visão geral do recurso do serviço de Relatórios Organizacionais do Learn.
Atualizar os dados regularmente
Se você estiver usando as informações de catálogo dos dados do serviço de Relatórios Organizacionais do Learn para dar suporte aos seus processos empresariais ou exibindo para clientes como parte da experiência do seu site, atualize o conteúdo pelo menos uma vez por dia.
É preciso ressaltar que o conteúdo está sendo atualizado o tempo todo. Publicamos atualizações normalmente duas vezes por dia. Elas podem ser menores, como pequenas alterações de texto ou grandes, como revisões, adições ou exclusões significativas. Em geral, o portfólio de conteúdo é gerenciado como um projeto de código aberto massivo e altamente controlado, com milhares de colaboradores e, como tal, as alterações acontecem o tempo todo. Se você usar os dados do serviço de Relatórios Organizacionais em seu sistema de produção, deverá estar ciente disso e seu sistema precisará lidar com isso.
Certifique-se de que as informações do Microsoft Entra associadas são atualizadas regularmente
Para saber a quem cada registro de conclusão está se referindo, você precisará unir os dados do conjunto de dados do Relatório Organizacional às suas informações do Microsoft Entra, para que os nomes apareçam junto com os registros de conclusão. Se você não atualizar seus dados ingressados no Microsoft Entra, poderá ter registros de conclusão contendo dados pessoais obsoletos ou dados de PII ausentes associados a eles.
Referenciar a documentação do desenvolvedor
A documentação para desenvolvedores do serviço de Relatórios Organizacionais do Learn tem uma lista completa dos dados fornecidos como parte da resposta, além de recomendações sobre o uso de cada campo para dar suporte a ótimas experiências de aprendizagem.
Próximas etapas
Para obter mais informações sobre como dar suporte ao serviço de Relatórios Organizacionais do Learn, leia os seguintes artigos: