Projeto: FS008981-Integração ThriveDX - Curso de Segurança Cibernética
Nome do Cliente: Confederação Nacional da Indústria - SESI
Objetivo
Este documento foi elaborado para informar aos usuários-chave da área Educacional do SESI, sobre a Integração ThriveDX para o curso de Segurança Cibernética. As atividades do Curso Segurança Cibernética, serão realizadas na plataforma ThriveDX . A integração com o TOTVS Educacional é responsável pela exportação dos registros e pela importação do resultado dos alunos.
Público Alvo
Este manual é destinado aos colaboradores selecionados como usuários-chave do SESI.
Metodologia
Este material tem como base a visão prática e completa do Processo Customizado da área Educacional através da Integração ThriveDX (TDX).
A metodologia utilizada tem como ponto de partida o mapeamento completo do respectivo processo, relacionado com as interfaces no Sistema TOTVS Educacional. Sempre que houver alguma atividade a ser realizada no Sistema, as suas funcionalidades e rotinas serão explicadas com detalhe.
Este manual detalha a Integração do SGE com a plataforma TDX. O SESI utilizará a plataforma da ThriveDX para realização de atividades do curso de Segurança Cibernética. Desta forma, foi realizado a integração da plataforma com o TOTVS Educacional.
Essa integração tem dois momentos principais:
Exportação de dados: Onde enviaremos os registros cadastrados no SGE (Coligada, Filial, Curso, turma, aluno, professor e matricula) para a plataforma.
Importação de Resultados: Onde será consultando o Certificados dos Alunos da ThriveDX, e os resultados dessa consulta serão gravados no SGE.
Para utilizar a integração é necessário realizar a instalação do Projeto, seguindo as orientações, descritas na página de Release Notes.
Para que os usuários tenham acesso a customização, é necessário a liberação nas permissões de perfil dos usuários. Para permitir o acesso siga este caminho abaixo:
Serviços Globais | Segurança | Perfil | Selecione o Sistema: Educacional | Acesso a menus | Sistema Industria | Integrações | ThriveDX, conforme exemplo a abaixo:
Após a liberação no perfil do usuário, o mesmo poderá acessar o módulo: TOTVS Educacional | Sistema Industria | Integrações | ThriveDX
A customização estará liberados para acesso, conforme imagem abaixo:
A integração requer que algumas informações já tenham sido previamente inseridas no SGE, Sendo elas:
O usuário deverá estar logado no contexto da Educação Continuada para realizar as parametrizações, disponíveis no Menu:
Ao acessar o Menu, será apresentado da tela e configurações com as abas:
As orientações para configuração estão descritas nos tópicos abaixo.
Nesta tela o usuário deverá informar os dados para conexão com o Web Service do ThriveDX.
Todos os campos são de preenchimento obrigatório. O usuário deverá obrigatoriamente informar todos campos, para conseguir salvar o cadastro.
Os dados de conexão são disponibilizados ao SESI DN, pela ThriveDX.
Nesta tela será informado o curso que será exportado para a plataforma.
Ao clicar em inserir, será apresentada a tela com o campo Curso. Este campo é um lookup, que trás a lista de todos os cursos cadastrados na base, considerando o contexto que o usuário está logado.
O SESI definiu que, apenas o Curso de Segurança Cibernética será integrado. Sendo assim o usuário deverá estar logado no contexto da Educação continuada e parametrizar apenas o curso citado.
Após inserir é necessário salvar o registro, para que ele seja visualizada no grid.
O cadastro não impedi a inclusão de outro curso. O usuário deve se atentar a NÃO incluir outro curso, para estar de acordo com a regra do SESI:
O SESI definiu que, apenas o Curso de Segurança Cibernética será integrado. Sendo assim o usuário deverá estar logado no contexto da Educação continuada e parametrizar apenas o curso citado.
Neste anexo, será registrado o público alvo, para o curso Segurança Cibernética.
Para o Curso de Segurança Cibernética, o SESI definiu que o público alvo, serão alunos do 8º e 9º ano do Ensino Fundamental. Não haverá regra customizada para validar essa definição, ficará sob a responsabilidade do usuário definir neste anexo apenas matrizes correspondentes ao 8° e 9° ano.
O anexo está disponível na aba Cursos, da parametrização.
Para incluir um público alvo, é necessário informar a Matriz aplicada, desejada. Conforme imagens abaixo:
Na tela de seleção, o cadastro deverá ser seguido considerando as relações:
O usuário poderá selecionar uma Matriz Aplicada por vez, mas poderão ser associadas N Matrizes neste cadastro. Após salvo o registro será apresentado no grid:
O cadastro do público alvo não impede a inclusão de uma matriz aplicada que NÃO seja do 8º ou 9º ano. O usuário deve estar atento a essa etapa, para estar de acordo com a regra do SESI.
Nesta aba, o usuário deverá informar as Situações de Matrícula que serão considerados durante a Exportação das Entidades para a plataforma TDX bem como para a Importação de resultados da plataforma para o SGE.
Para exportação:
O usuário deverá definir quais são as situações de matricula, que serão consideradas durante a Exportação de matrículas para a plataforma TDX.
O usuário poderá selecionar um status de matrícula por vez, mas poderão ser cadastrados N status de matrícula neste cadastro.
O usuário deverá definir quais são as situações de matricula, que serão consideradas durante a Importação de Resultados da plataforma TDX para o SGE.
Todos os registros, serão apresentados no grid, conforme imagem abaixo:
Premissas
Para a Criação do Canal (Turma) é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Para a Criação do Canal é necessário que o Master Curso com ID "CYBER_SECURITY_2023-06-06-043214" esteja cadastrado corretamente na plataforma TDX - Este item é uma premissa, porém não é necessária nenhuma ação pelo regional, pois este é mantido pelo DN para todos os regionais
Elegível para exportar:
Importante
Importante: a exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Criação do Departamento Regional (Coligada) é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Como este é o primeiro agrupador do Regional no TDX não há necessidade de nenhum cadastro/integração prévio
Elegível para exportar:
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Criação da Unidade Escolar (Filial) é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Elegível para exportar:
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Criação do Curso (Grupo) é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Elegível para exportar:
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Criação da Turma (Grupo) é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Elegível para exportar:
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Criação do Estudante (Usuário) é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Como o Usuário no TDX não tem dependências, não há necessidade de nenhum cadastro/integração prévio.
Elegível para exportar:
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Criação do Docente (Usuário) é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Como o Usuário no TDX não tem dependências, não há necessidade de nenhum cadastro/integração prévio.
Elegível para exportar:
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Vínculo do Docente ao Canal é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Elegível para exportar:
Ser o Professor:
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Vínculo da Turma ao Canal é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Elegível para exportar:
Sempre que a Turma e o Canal tiverem exportados com sucesso.
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Para a Matrícula do Aluno na Turma (Grupo) é necessário atender:
Itens que devem ser integrados/existir no TDX primeiro..
Elegível para exportar:
Importante
A exportação não reenvia item - Itens com erro devem ser enviados pelo Reenvio de item no Log.
Após finalizadas todas as parametrizações e cadastros, o usuário pode executar o processo de Exportação de Dados. Através desse processo as Integração com a Plataforma TDX será iniciada.
O processo pode ser agendado ou executado através do Menu: TOTVS Educacional | Sistema Industria | Integrações | ThriveDX | Exportação de Dados.
O resultado do processo de exportação é apresentado na tela (quando executado manualmente), conforme exemplo abaixo:
Todas os registros exportados com sucesso ou que apresentaram erros, serão registrado no Menu : Monitor de log.
Quando o curso é finalizado na Plataforma TDX e os alunos já possuem certificação, o usuário deverá realizar a importação dos resultados da plataforma para o SGE.
O processo de Importação de resultados, retorna para o SGE a informação de conclusão ou não conclusão do aluno no Curso de Segurança Cibernética.
Este processo deverá ser executado manualmente através do menu: TOTVS Educacional | Sistema Industria | Integrações | ThriveDX | Importação de Resultados .
Ao acessar o menu, será exibida a tela para seleção da turma, que o usuário deseja importar o resultado.
O lookup apresentado, terá a lista de turmas que já foram exportadas à plataforma TDX.
Ao selecionar a turma, o usuário garante que a mesma, já está finalizada e certificada na plataforma TDX. Ao executar o processo será apresentada um mensagem de alerta ao usuário:
O resultado do processo de imprtação é apresentado na tela , conforme exemplo abaixo:
Todas os registros importados com sucesso ou que apresentaram erros, serão registrado no Menu : Monitor de log.
Após o processo de importação ser executado, a customização fará as seguintes alterações no SGE, considerando as regras:
Certificados identificados na plataforma TDX (Alunos concluintes):
Certificados NÃO identificados na plataforma TDX (Alunos NÃO concluintes):
Exemplo de um aluno concluinte:
Matricula na disciplina
Matricula no Período letivo
Motivo da alteração registrado:
Caso o usuário selecione uma turma que não tenha certificado na plataforma, a integração seguirá o fluxo de registro de resultados, considerado todos alunos da turma como "não concluintes''. Ainda que o processo seja executado novamente, a integração não fará atualização dos registros no SGE. Não está previsto atualizações para essa Integração.
Monitor de log armazena informações de dados exportados e/ou importados da plataforma ThriveDX, com detalhes dos dados enviados, dados recebidos, status e datas de processamento. O Monitor de log também será a referência do usuário para identificar casos que tenham necessidade de reenvio de dados.
A interface estará disponível em: TOTVS Educacional | Sistema Industria | Integrações | ThriveDX | Monitor de Log
Na tela de log estarão disponíveis os seguintes campos:
Ao acessar o anexo de um registro será possível o usuário visualizar todos os registros relacionados ao cadastro integrado selecionando a opção Item de Log. Estarão disponíveis os seguintes campos:
O Processo de reenvio de dados permite o envio dos registros que não foram exportados com sucesso. Esse processo poderá ser executado manualmente ou poderá ser agendado pelo menu de Processos de Monitor de Log, por registro (com status de erro ou pendente) e a integração efetuará a exportação dos registros novamente.
A funcionalidade estará disponível em: TOTVS Educacional | Sistema Industria | Integrações | ThriveDX | Monitor de Log | Processos | Reenvio de Log
O usuário deverá selecionar um ou vários registros com o status de Erro para executar o processo.
Ao ser acionado o processo customizado de reenvio de dados, a customização tentará realizar novamente o envio dos dados. Caso seja processado corretamente, o status do registro passará para Sucesso.
Dependendo do erro ocorrido, o usuário precisará acessar o Monitor de log e analisar os logs, corrigir os registros (caso necessário) e então acionar o processo de reenvio.
Para informações sobre Alteração Status Logs com Erro e o processo de Exclusão de Logs no monitor, acesse o Manual Operacional da Customização - LIB DN
Dados técnicos da exportação:
Campo ThriveDX | Tipo | Obrig | Descrição | Integração - SGE |
Dados do DR | ||||
identifier | Body | string | Sim | Id único do modelo de entidade - Definido por um provedor externo | {SiglaDR}{NúmerosCNPJColigada} |
name | Body | string | Sim | Nome do Grupo/Curso | {SiglaDR} - {NomeFantasia} |
parentIdentifier | Body | string | Não | Id do grupo pai, definido por um provedor externo. O Grupo que seja filho é obrigatório o preenchimento | Não será filho de nenhum outro Grupo. |
subAccountName | Body | string | Não | Nome da Sub-conta | Não será enviado |
type | Body | string | Sim | Tipo do Grupo de acordo com a hierarquia | Fixo: “Departamento Regional” |
Dados do Escola | ||||
identifier | Body | string | Sim | Id único do modelo de entidade - Definido por um provedor externo | {SiglaDR}{CodColigada}{CodFilial} EX.: PR330001 |
name | Body | string | Sim | Nome do Grupo/Curso | {NomeFantasia} |
parentIdentifier | Body | string | Não | Id do grupo pai, definido por um provedor externo. O Grupo que seja filho é obrigatório o preenchimento | {SiglaDR}{NúmerosCNPJColigada} |
subAccountName | Body | string | Não | Nome da Sub-conta | Não será enviado |
type | Body | string | Sim | Tipo do Grupo de acordo com a hierarquia | Fixo: “Unidade Escolar” |
Campo ThriveDX | Tipo | Obrig | Descrição | Integração - SGE |
Dados do Curso | ||||
identifier | Body | string | Sim | Id único do modelo de entidade - Definido por um provedor externo | {SiglaDR}{CodColigada}{CodFilial}{CodCurso} EX.: CT3001ECOSEGCY |
name | Body | string | Sim | Nome do Grupo/Curso | {NomeCurso} |
parentIdentifier | Body | string | Não | Id do grupo pai, definido por um provedor externo. O Grupo que seja filho é obrigatório o preenchimento | {SiglaDR}{CodColigada}{CodFilial} |
subAccountName | Body | string | Não | Nome da Sub-conta | Não será enviado |
type | Body | string | Sim | Tipo do Grupo de acordo com a hierarquia | Fixo: “Curso” |
Dados da Turma | ||||
identifier | Body | string | Sim | Id único do modelo de entidade - Definido por um provedor externo | {SiglaDR}{CodColigada}{CodFilial}{IdPerLet}{CodTurma} |
name | Body | string | Sim | Nome do Grupo/Curso | {CodTurma} - {NomeReduzidoTurma} |
parentIdentifier | Body | string | Não | Id do grupo pai, definido por um provedor externo. O Grupo que seja filho é obrigatório o preenchimento | {SiglaDR}{CodColigada}{CodFilial}{CodCurso} |
subAccountName | Body | string | Não | Nome da Sub-conta | Não será enviado |
type | Body | string | Sim | Tipo do Grupo de acordo com a hierarquia | Fixo: “Turma” |
Campo ThriveDX | Tipo | Obrig | Descrição | Integração - SGE |
Dados do Aluno | ||||
identifier | Body | string | Sim | Identificador único | {CPFdoAluno} |
isActive | Body | bool | Não | Status do Usuário. Padrão: true | Não será enviado. Não iremos controlar a inativação de usuários neste escopo. |
username | Body | string | Não | Usuário | {CPFdoAluno} |
Body | string | Não | E-mail de usuário | E-mail principal do cadastro de pessoa | |
firstName | Body | string | Não | Primeiro nome | Primeiro nome do cadastro de pessoa. Se preenchido o Nome Social ele substitui. |
lastName | Body | string | Não | Ultimo nome | Sobrenome do cadastro de pessoa |
password | Body | string | Não | Senha do usuário | Não será enviado |
possibleRoles | Body | enum | Não | Learner | |
customAttributes | Body | object | Não | Não será enviado |
Dados do Professor | ||||
identifier | Body | string | Sim | Identificador único | {CPFdoProfessor} |
isActive | Body | bool | Não | Status do Usuário. Padrão: true | Não será enviado. Não iremos controlar a inativação de usuários neste escopo. |
username | Body | string | Não | Usuário | {CPFdoProfessor} |
Body | string | Não | E-mail de usuário | E-mail principal do cadastro de pessoa | |
firstName | Body | string | Não | Primeiro nome | Primeiro nome do cadastro de pessoa. Se preenchido o Nome Social ele substitui. |
lastName | Body | string | Não | Ultimo nome | Sobrenome do cadastro de pessoa |
password | Body | string | Não | Senha do usuário | Não será enviado |
possibleRoles | Body | enum | Não | INSTRUCTOR | |
customAttributes | Body | object | Não | Não será enviado |
Alunos sem CPF serão integrados?
Resposta: Não. Em situações envolvendo alunos sem CPF, esses casos serão tratados separadamente pelo SESI em comunicação direta com a TDX.
É necessário que o Curso seja cadastrado com um código especifico?
Resposta: Para integração não será necessário. O Curso deverá ser cadastrado, seguindo as regras já definidas pelo SESI.
No processo de importação, selecionei uma turma que não foi finalizada ou não possui certificados na Plataforma, e todos os alunos aparecem como 'reprovados'. O que devo fazer?
Resposta: Nesse cenário, a correção deve ser feita manualmente, obedecendo às orientações do SESI para a alteração individual de cada resultado. Isso é importante para evitar qualquer impacto em outras soluções, como o envio ao SCAE. A customização não tem ações nesse caso.