O Pacote de expansão de widgets da página inicial oferece uma série de widgets da página inicial para fornecer uma experiência de aprendizagem mais personalizada nas páginas iniciais.
Importante: o Pacote de expansão de widgets da página inicial hospedado personalizado será desativado em setembro de 2024/20.24.9. Os clientes podem continuar a usar as versões hospedadas do widget até essa data; no entanto, eles não são mais suportados pela D2L. Os clientes que usarem as versões hospedadas personalizadas dos widgets devem atualizar para os novos widgets do Brightspace System.
Os widgets hospedados personalizados que serão substituídos por widgets do sistema incluem:
- Widget Índice visual
- Widget Janela de boas-vindas
- Widget Banner de fotos
- Widget Prêmios do aluno
- Widget Anúncios compactos
- O widget Cartão de perfil único
- Widget Navegador de conteúdo
Os widgets hospedados personalizados que não serão mais suportados incluem:
- Calendário da educação básica
- Rodapé da educação básica
Observação: o widget de vários perfis faz parte do Pacote de expansão de widgets da página inicial e continuará a funcionar normalmente como um widget do sistema.
Se você tiver atualmente um widget hospedado personalizado disponível na sua instância do Brightspace, uma nova versão do widget do sistema do mesmo widget será adicionada à sua instância.
Verifique se os widgets precisam ser substituídos
Se você tiver a permissão Criar/Editar página inicial, uma mensagem de aviso será exibida em todos os widgets hospedados personalizados ativos na página inicial no seguinte formato: "Ação necessária: Atualização do widget: O suporte para esse widget está terminando. Para obter suporte automatizado para substituir esse widget, visite o Serviço de suporte HWEP EOL."
Use o serviço de mensagens no widget (por exemplo, no widget de índice visual) para navegar até o serviço de suporte HWEP EOL.
Observação: um aviso semelhante também será exibido na página da Ferramenta Gerenciamento da Página Inicial se houver versões hospedadas personalizadas de widgets ativos no ambiente. Clique neste aviso para navegar até a página Serviço de substituição automática do widget personalizado.
Na página Serviço de substituição automática do widget personalizado, você pode fazer o seguinte:
- Verifique uma lista de todos os widgets hospedados personalizados e o número de páginas iniciais nas quais o widget está ativo.
- Encontre os locais exatos onde cada widget está ativo clicando em um número na linha correspondente da coluna Páginas iniciais usando widgets herdados.
Figura: use a página Serviço de substituição automática do widget personalizado para localizar, substituir ou remover widgets hospedados personalizados.
Para obter mais informações sobre como identificar quais widgets legados você está usando e planejar a desativação do Pacote de expansão de widgets da página inicial em seu ambiente, consulte Atualizar a partir dos widgets hospedados.
Observação: a funcionalidade de substituição automática será adicionada posteriormente.
Usar Serviço de substituição de widget hospedado personalizado
O Serviço de substituição de widget hospedado personalizado faz parte da página de Widget hospedado personalizado (Suporte EOL do widget hospedado personalizado). O serviço de substituição permite:
- Substituir em massa todas as instâncias do widget hospedado de forma personalizada pela versão do sistema (as configurações são automaticamente migradas).
- Excluir em massa todas as instâncias do widget hospedado de forma personalizada.
Preparar seu site
Para oferecer suporte a uma substituição suave de widgets hospedados sob medida, considere o seguinte:
-
Garanta que ninguém consiga adicionar widgets hospedados personalizados às páginas iniciais enquanto o serviço estiver ativo: ou anuncie à equipe que os widgets hospedados personalizados não são mais permitidos ou altere temporariamente as permissões de edição das páginas iniciais para os papéis relevantes.
-
Garanta que para cada widget hospedado personalizado, o widget do sistema correspondente esteja habilitado para sua instância e a ferramenta de widget do sistema esteja ativada para sua organização. A D2L forneceu automaticamente as permissões para os equivalentes de widget do sistema para todos os clientes que usam widgets personalizados hospedados.
-
Planeje executar a substituição dos widgets durante um período de uso fora do pico. Os widgets personalizados hospedados e os widgets do sistema têm variações pequenas que podem distrair os usuários se forem alteradas repentinamente.
Aviso: ao agendar períodos de bloqueio, leve em consideração que os widgets têm uma duração de cache de dois minutos. Após a migração estar completa, os widgets podem não aparecer imediatamente como migrados até que esse período de dois minutos tenha decorrido.
Executar o Serviço de substituição de widget hospedado personalizado
Aviso: as substituições automáticas não podem ser revertidas automaticamente. O único método para reverter as ações realizadas pelo serviço de substituição é desfazer manualmente as alterações.
Para executar o Serviço de substituição de widget hospedado personalizado
- Navegue até a página Widget hospedado personalizado.
- Selecione um widget que deseja substituir. O serviço só pode ser aplicado a um widget hospedado personalizado de cada vez, e esse widget deve estar em sua fase final de vida útil. Isso inclui todos os widgets HWEP, exceto o Multi-Profile Widget.
Nota: o serviço de substituição não pode ser executado em widgets hospedados personalizados que não têm um equivalente de widget do sistema. Isso inclui o Calendário K12 e o Rodapé de educação básica K12.
- Clique em Substituir ao lado do widget.
Figura: clique em Substituir para executar o Serviço de substituição de widget hospedado personalizado.
O serviço de substituição é executado como uma tarefa em segundo plano no site do Brightspace.
Observação: se você tentar executar o serviço de substituição em um widget enquanto ele já estiver em andamento para o mesmo widget, a tentativa mais recente não será processada.
Você pode sair da página de Widgets hospedados personalizados sem interromper o serviço de substituição.
Após a conclusão, o serviço de substituição envia uma notificação para a seção Atualizar alertas (representada pelo ícone de sino) da barra de navegação principal do Brightspace. Se o serviço de substituição encontrar um problema, a notificação incluirá um código de erro. Clique na notificação para navegar até a página de Widgets hospedados personalizados para obter detalhes sobre o código de erro.
Consulte a lista de códigos de erro fornecida abaixo para obter mais informações.
| Código |
Definição |
Solução |
|---|
| x001 |
O widget personalizado que você está tentando substituir não possui um widget do sistema equivalente. |
Envie um ticket de suporte. |
| x002 |
Os arquivos de configuração associados a este widget não puderam ser migrados. |
Envie um ticket de suporte. |
| x003 |
Houve um problema na migração da definição de função do widget personalizado mais antigo instalado no nível da organização. |
Envie um ticket de suporte. |
| x004 |
Um usuário adicionou esse widget a uma página inicial enquanto o serviço de substituição estava em execução. |
Execute novamente o serviço de substituição para este widget personalizado. |
| x005 |
Esse widget não pôde ser substituído. |
Envie um ticket de suporte. |
| x006 |
Houve um problema. O análogo do widget do sistema para esse widget personalizado não está autorizado. |
Envie um ticket de suporte. |
| x007 |
Outro usuário está executando o processo de substituição para este widget. |
Volte a executar o serviço depois de concluir o funcionamento atual (se necessário). |
| x008 |
Os títulos personalizados associados a este widget não puderam ser migrados. |
Envie um ticket de suporte. |
Visão geral das ações e considerações para o serviço de substituição
Confirmar o direito e o status da ferramenta
O serviço de substituição verifica se a versão do sistema do widget está habilitada para a instância e verifica se o widget do sistema está ativado em Ferramentas de organização:
- Se o serviço de substituição descobrir que o widget do sistema não está habilitado no nível da instância, ele encerra e notifica o usuário.
- Se o serviço de substituição descobrir que o widget do sistema não está habilitado em Ferramentas de organização, ele ativa o widget no nível da organização e continua.
- Se o widget não estiver ativo em nenhuma unidade organizacional filha, o serviço de substituição prossegue como se o widget estivesse ativo para essa unidade organizacional e substitui o widget. O widget substituído aparece inativo na página inicial até que o proprietário da página inicial ative o widget para essa unidade organizacional.
Catalogar todas as páginas iniciais e cursos afetados
O serviço de substituição verifica o site em busca de todas as instâncias do widget nas páginas iniciais e identifica todos os cursos que usam páginas iniciais com esse widget. Em determinados sites, o widget pode ter sido instalado várias vezes por engano. Nesses casos, o serviço seleciona a instalação do widget no nível da organização com a data de instalação mais antiga como a versão canônica. Na maioria dos casos, as instalações secundárias são idênticas à instalação original da organização, tornando essa estratégia inofensiva. No entanto, existem casos especiais, identificados por consultas ao banco de dados, onde as instalações secundárias foram personalizadas de alguma forma. Essas instalações secundárias personalizadas devem ser gerenciadas manualmente antes de executar o serviço de substituição. A D2L entrou em contato diretamente com esses clientes.
Migrar arquivos de configuração
Os widgets hospedados personalizados têm um config.txt padrão no nível da organização. O serviço de substituição verifica se este config.txt da organização já foi migrado para os Dados do widget da organização e realiza a migração se ainda não tiver sido feita.
Os widgets hospedados personalizados usam uma combinação de arquivos config.txt armazenados localmente e Dados do widget armazenados remotamente para salvar configurações para cada ocorrência de curso de um widget. Essa abordagem permite que um widget seja único em cada curso.
Os widgets do sistema usam exclusivamente os Dados do widget para armazenamento de dados. Para que a migração seja bem-sucedida, o serviço deve transferir os dados dos arquivos config.txt para os Dados do widget. Usando seu catálogo de cursos afetados, o serviço de substituição lê os dados do arquivo config.txt de cada curso e os copia para os Dados do widget específicos daquele curso.
Os seguintes casos são possíveis:
- Se o config.txt local for idêntico aos dados já armazenados nos Dados do widget da organização, a configuração local é considerada redundante e não é migrada. Configurações personalizadas podem ser adicionadas no futuro, conforme necessário. Os arquivos config.txt legados não são removidos do sistema de arquivos; eles são mantidos no local como backup caso o serviço de substituição falhe.
- Se o arquivo config.txt estiver ausente no nível da organização, as configurações de todos os níveis do curso são migradas.
- Se um curso tiver uma configuração presente tanto nos Dados do widget quanto em um arquivo config.txt, o serviço de substituição mantém a versão nos Dados do widget e descarta os dados do config.txt. Embora esse cenário seja improvável, pode acontecer se, em um curso, forem usadas tanto as versões do sistema quanto as personalizadas de um widget. Se o JSON dentro do arquivo config.txt não puder ser lido ou o próprio arquivo for ilegível, a configuração não será migrada. Se isso acontecer no caso de uma configuração no nível do curso, o widget herdará a configuração armazenada na organização.
Nota: as configurações para cursos reciclados não são migradas.
Migrar configurações de função
Os widgets Prêmios do aluno, Anúncios compactos e janela de boas-vindas têm definições de função. As definições de função são uma correspondência entre os papéis disponíveis no widget, como aluno ou moderador, e os papéis definidos dentro do Brightspace. Para widgets hospedados personalizados, essas definições são armazenadas como uma variável JavaScript dentro do campo de conteúdo do widget personalizado. Para widgets do sistema, as definições de função são armazenadas em uma variável de configuração específica para cada widget.
Observação: para widgets hospedados personalizados, as definições de função só podem ser definidas por instalação de widget, não por unidade organizacional.
Veja abaixo um exemplo de definições de função:
var roleDefinitions = {
"administrator": [
"D2LAdmin"
],
"moderator": [
"D2LAdmin",
"Super administrador",
"Instrutor"
],
"instructor": [],
"learner": []
};
O serviço de substituição examina o campo de conteúdo do widget, extrai a definição de função e a salva na variável de configuração apropriada da organização para esse widget.
Se o objeto JavaScript que define a definição de função não for válido, a definição de função correspondente não será migrada.
Nos casos em que um widget foi instalado várias vezes em um site, o serviço de substituição utiliza as definições de função do widget instalado no nível da organização com a data de instalação mais antiga como as definições de função canônicas para o site. Foi realizada uma pesquisa no banco de dados de todas as configurações de função para garantir que não haja sites com definições de função divergentes em várias instalações.
Migrar título do widget e títulos personalizados
O serviço de substituição tenta migrar a nomenclatura personalizada associada ao widget hospedado personalizado, incluindo o nome personalizado do widget, substituição do nome personalizado do widget e substituição do nome do widget na página inicial:
| Tipo de título |
UI do Brightspace |
Local |
Operação |
|---|
| Campo Nome do widget personalizado |
 Figura: o campo Nome.
|
Clique no ícone de edição ao lado do nome do widget > Propriedades personalizadas do widget > Nome. |
A substituição é aplicada na unidade organizacional onde o widget está instalado, desde que não haja substituição de nome personalizado existente para o widget do sistema. O serviço de substituição adota o nome do widget mais recentemente criado. |
| Substituição do nome do widget personalizado |
 Figura: caixas de seleção Configurações do widget e os botões de opção Nome do widget.
|
Clique no ícone de personalização ao lado do nome do widget > Configurações do Widget > Nome do Widget > selecione Personalizado. |
Se presente, ela é aplicada como uma substituição adicional na unidade organizacional onde o widget está instalado. O widget adota o nome da substituição mais recentemente criada. |
| Substituição do nome do widget da página inicial |
Figura: caixas de seleção Configurações do widget e os botões de opção Nome do widget.
|
Clique em Estilizar widget em qualquer página inicial > Configurações de widget > Nome do widget > selecione Personalizado. |
Se houver, essa substituição será aplicada adicionalmente à página inicial. O widget adota o nome da substituição mais recentemente criada.
Observação: o widget prioriza a adoção da Substituição do nome do widget da página inicial em relação a qualquer outro nome.
|
Substituir o widget hospedado personalizado
Todos os widgets do sistema e todos os widgets personalizados têm IDs exclusivos. Os widgets são adicionados às páginas iniciais referenciando esses IDs. Para substituir um widget personalizado em uma página inicial, o serviço de substituição atualiza o registro da página inicial para usar o ID do widget do sistema correspondente. Esta ação remove o antigo widget personalizado e adiciona o widget do sistema. O novo widget do sistema funciona de forma idêntica ao antigo widget personalizado, pois sua configuração e funções foram migradas anteriormente.
Os cursos não são modificados diretamente. Os cursos individuais só são afetados se uma página inicial que eles estão usando for atualizada.
Desinstalar o widget hospedado personalizado
Na etapa final, o widget é desinstalado do site para evitar seu uso futuro em páginas iniciais. Dentro do banco de dados, o widget é removido da lista de widgets personalizados, excluindo todo o conteúdo personalizado previamente armazenado no campo de conteúdo do widget. Isso equivale a usar a função Excluir no painel Widgets personalizados da página Gerenciar widgets.
Aviso: se um usuário adicionou um widget a uma página inicial enquanto o serviço de substituição está em execução, o serviço completa sua operação, mas não desinstalará o widget. Em vez disso, uma notificação é enviada ao usuário. Nesse caso, o serviço de substituição deve ser executado novamente para remover o widget adicionado recentemente. Consulte a seção Executar o serviço de substituição de widget hospedado personalizado.
Uma vez que o widget é desinstalado do site, ele fica indisponível para uso em páginas iniciais. Como o serviço de substituição atualiza páginas iniciais mas não cursos, isso significa que cursos reciclados, excluídos e inativos também são afetados, mesmo que não estejam disponíveis para os usuários.