Histórico da Página
Central de Notificação
Características do Requisito
Linha de Produto: | RM | ||||||||||||||||
Segmento: | TOTVS Educacional | ||||||||||||||||
Módulo: | Educacional | ||||||||||||||||
Rotina: |
| ||||||||||||||||
Cadastros Iniciais: | Parametrização da integração com o Fluig e servidor de E-mail | ||||||||||||||||
Parâmetro(s): | Parâmetros do sistema relacionados a central de notificação e conta de comunicação, parâmetros globais para integração com o Fluig | ||||||||||||||||
Requisito (ISSUE): | PCREQ-5421 | ||||||||||||||||
País(es): | Brasil | ||||||||||||||||
Tabelas Utilizadas: | SMENSAGEMPADRAO, STURMA, STURMADISC, SSUBTURMA, SCURSO, SHABILITACAO, SALUNO, SPROFESSOR, PPESSOA, GUSUARIO, SCOMUNIDADESOCIAL, SPARAM, SATIVIDADE | ||||||||||||||||
Versões/Release: | 12.1.9 |
Descrição
A central de notificação será composta da junção de duas funcionalidades já implementadas no TOTVS Educacional e a adição de outras duas, são elas:
- Cadastro de Mensagens de Notificação
- Processo de Mala Direta
- Processo de Envio de Notificação e/ou Post nas Comunidades (nova funcionalidade)
- Processo de Envio de Mensagens de Notificações Temporais (nova funcionalidade)
Configuração do ambiente
Fluig:
- Utilizar o usuário administrador do Fluig e acessar o Painel de controle -> WCM
- Configurar o Oauth Provider
- Configurar o Oauth App (pode-se utilizar qualquer conjunto de caracteres para definição do Consumer Key e Consumer Secret)
Para mais detalhes sobre o passo 2 e 3 consulte o documento "Cadastrar aplicativo no Fluig" pelo link: http://tdn.totvs.com/display/public/fluig/Fluig+API#FluigAPI-CadastraraplicativonoFluig
Parâmetros Globais e Contas de Comunicação
- Acessar a guia Ambiente -> Parâmetros -> Globais
- Aba: Integração Fluig definir:
- Endereço do servidor do Fluig
- Id da empresa do Fluig
- Usuário administrador do Fluig
- Senha do usuário administrador do Fluig
- Aba: Integração oAuth definir:
- Chave de consumo: é a chave consumer key definida na etapa da configuração do fluig.
- Chave secreta: é a chave consumer secret definida na etapa da configuração do fluig.
- Salvar os parâmetros
- Aba: Integração Fluig definir:
- Acessar a guia Gestão -> Fontes e verificar se a fonte de comunicação com o Fluig está cadastrada. Caso não encontre entre em contato com o suporte da TOTVS.
- Acessar a guia Gestão -> Contas -> Contas individuais e criar um novo registro
- Código da fonte de comunicação: vincular a fonte relacionada ao Fluig
- Utilizar "Usar esta conta como remetente"
- Identificação na rede social: informar o usuário mestre do Fluig
- Obter credenciais: ao clicar neste botão será exibida a tela de login do Fluig onde deve ser informado o usuário administrador e sua senha
- As credenciais serão obtidas e o campo Descrição será preenchido com o nome do usuário administrador.
- Salvar o registro
Cadastro de Mensagens de Notificação (Acessar TOTVS Educacional | Atividades Acadêmicas | Central de notificações | Mensagens de Notificação)
Na versão 12.1.7 todos os parâmetros do sistema relacionados a definição das mensagens de e-mail foram deslocados para este cadastro, unificando o ponto de definição das mensagens de notificação. A partir da versão 12.1.9 este cadastro sofre mais uma evolução passando a permitir que as mensagens de notificação possam ser também enviadas como notificações para usuários no Fluig. Importante frisar que esta evolução foi implementada apenas para o módulo TOTVS Educacional.
Outro ponto, é que a partir desta versão todos os parâmetros que determinam o envio ou não da mensagem foram transferidos dos parâmetros do Educacional para esse cadastro, desta forma na definição da mensagem o usuário passa a parametrizar se utilizará o envio por e-mail e/ou por notificação.
O tipos de mensagens de notificação disponíveis no TOTVS Educacional:
- Categoria: Secretária
- Confirmar reservas de recursos
- Confirmar reservas de instalações
- Categoria: Estágio
- Informar ao aluno que houve alguma alteração na vaga de estágio para a qual ele está inscrito
- Informar ao aluno que ele foi selecionado para a vaga de estágio na qual está inscrito
- Informar ao aluno que ele não foi selecionado para a vaga de estágio na qual está inscrito
- Informar ao aluno sobre aprovação do plano de atividades do estágio
- Informar ao aluno sobre reprovação do plano de atividades do estágio
- Informar para o participante que ele foi convidado para a banca
- Categoria: Pesquisa e Extensão
- Informar os pesquisadores sobre a divulgação do edital (Pesquisa)
- Informar os pesquisadores sobre a divulgação do edital (Extensão)
- Categoria: Matrícula e Avaliação
- Pendências financeiras do aluno
- Cadastro de ocorrência para o aluno
- Frequência do aluno próximas do limite ou excedida
- Pendências de matrícula
- Liberação ou digitação de etapa de nota
- Liberação ou digitação de etapa de falta
Os tipos de mensagens passam a ter uma classificação interna que determina de que modo estas são disparadas:
- Classificação: Fixa -> mensagens com este tipo de classificação são disparadas por funcionalidades já existentes no sistema.
- Classificação: Temporal -> mensagens com este tipo de classificação são disparadas pela funcionalidade "Envio de mensagens de notificações temporais".
As mensagens temporais disponíveis neste primeiro momento são:- Pendências financeiras do aluno
- Frequência do aluno próximas do limite ou excedida
- Pendências de matrícula.
Escolhida a mensagem que se quer definir pode-se preencher os seguintes campos:
- Ativar envio por e-mail
- Assunto do e-mail
- Texto do e-mail (para envio no formato HTML é permitido formatar o texto e incluir imagens)
- Enviar e-mail como HTML ou texto
- Ativar envio por notificação via Fluig
- Texto da notificação (não poderá conter formatação e nem imagens)
Lembrado que cada mensagem de notificação possui algumas tag's que podem ser incluídas na definição do template da mensagem a ser encaminhada.
Processo de Mala Direta (Acessar TOTVS Educacional | Atividades Acadêmicas| Central de Notificações| Mala direta)
- Informar a consulta SQL responsável por listar os usuários, depois de informado os parâmetros (caso sejam necessários) e executada a consulta os registros são listados para visualização do usuário. Caso seja necessário remover algum registro basta selecionar o mesmo e clicar em remover.
- Informar o conteúdo da mensagem a ser encaminhada via mala direta. Neste passo o usuário tem as seguintes opções:
- Importar um arquivo template para a mala direta
- Criar um novo arquivo
- Editar um arquivo existente.
- Definir a forma de execução
- Enviar por e-mail
- Informar assunto do e-mail;
- Tipo de remetente:
- Usuário logado no sistema;
- Coligada atual; Coligada global;
- Parâmetros globais (parametrização padrão de envio de mensagens que está definido na tela de parâmetros Globais na aba Envio E-mails);
- Personalizado: o usuário poderá informar um e-mail e nome do remetente a ser identificado. Esta lista de e-mail(s) personalizado precisa ser informado em TOTVS Educacional | Configurações | Configuração |Parâmetros | Secretaria | Geral 4/4]
- Identificador dos registros de log.
- Gerar arquivos
- Informar diretório físico onde serão gravados os arquivos criados;
- Informar o prefixo para nome dos arquivos. Caso o usuário tenha carregado um arquivo de template no editor de texto, o nome do arquivo será carregado neste campo “prefixo para nome dos arquivos”, podendo o usuário alterar o seu conteúdo.
- Informar em “Salvar como” qual extensão para os arquivos. O usuário terá como opção às seguintes extensões: pdf, rtf, doc, docx e html.
- Identificador dos registros de log.
- Enviar por e-mail
- Após clicar no botão “Executar” será exibida a tela padrão de andamento do processo e nesta teremos dois botões com funcionalidades diferentes:
- Botão “Cancelar”: Aborta o andamento do processo, mostrando o log até o momento do cancelamento.
- Botão “Fechar”: Ao clicar neste botão, o usuário será informado que a tela do processo será fechada e que sua execução continuará em segundo plano. Para que a tela seja fechada é solicitado ao usuário uma confirmação escolhendo a opção “Sim” a tela é fechada e a execução é realizada em segundo plano, ou a opção “Não” que continua o processamento normalmente com a tela aberta.
Importante: Quando o processo estiver sendo executado em segundo plano, o usuário receberá uma caixa de mensagem quando sua execução for finalizada.
Processo de Envio de Posts para Comunidades e Notificações para Usuários do Fluig (Acessar TOTVS Educacional | Atividades Acadêmicas| Central de Notificações| Envio de posts para comunidades e notificações para usuários do Fluig)
Este processo só estará disponível se houver integração com o Fluig. A integração será entendida como ativa quando o parâmetro código de comunicação estiver preenchido nos parâmetros do TOTVS Educacional. Este processo disponibilizará as seguintes etapas:
- Definições relacionadas ao mecanismo de geração das informações.
- Campo: "Tipo de saída"
- Post nas comunidades do Fluig (esta opção só estará disponível se o sistema estiver integrado com a parte Social do Fluig, ou seja, o TOTVS Educacional deve estar configurado para utilizar a funcionalidade "Acadêmia Social")
- Notificação para usuários do Fluig
- Campo: "Tipo de consulta"
- Consulta padrão do sistema
- Consulta SQL
- Entidades:
- Para "Post nas comunidades do Fluig" podemos ter (depende de quais entidades estão parametrizadas para integrar com o Fluig):
- Turma
- Turma/Disciplina
- Subturma
- Atividade Ofertada
- Curso
- Habilitação ou Serie
- Para "Notificação para usuário do Fluig" podermos ter:
- Aluno
- Professor
- Pessoa
- Para "Post nas comunidades do Fluig" podemos ter (depende de quais entidades estão parametrizadas para integrar com o Fluig):
- Campo: "Tipo de saída"
- Seleção dos registros
- Se o campo tipo saída for: "Post nas comunidades do Fluig"
- Definição de SQL:
- A sentença deverá conter obrigatoriamente o campo "ALIASCOMUNIDADE".
- Se a sentença retornar comunidades inativas na execução do processo essas deverão ser ignoradas
- Definição via consulta as comunidades:
- Selecionar as comunidades que devem receber o post (apenas comunidades ativas são listadas)
- Definição de SQL:
- Se o campo tipo saída for: "Notificação no Fluig"
- Definição do SQL responsável por buscar a lista dos destinatários das notificações.
- A sentença SQL deverá conter obrigatoriamente os campos "CODUSUARIO" e "EMAIL".
- Se o campo tipo saída for: "Post nas comunidades do Fluig"
- Definição da mensagem a ser encaminhada
- As tags disponíveis para definição da mensagem contém todos os campos retornados no SQL criado pelo cliente ou na consulta exibida na seleção das comunidades.
- A mensagem não permitirá formatação do texto e/ou inclusão de imagens
- Ao executar o processo o mesmo terá como resultado final a criação do post nas comunidades ou o envio das notificações para os usuários do Fluig.
Processo de Envio de Mensagens de Notificações Temporais (Acessar TOTVS Educacional | Atividades Acadêmicas| Central de Notificações| Envio de mensagens de notificações temporais)
Este processo será responsável por disparar as mensagens de notificações classificadas como temporais, para tanto o usuário deverá:
- Definir o período letivo
- Definir as notificações temporais que devem ser executadas
- Definir o tipo de consulta:
- Consulta padrão do sistema
- Pode-se definir a curso, habilitação, matriz curricular ou matriz aplicada
- Pode-se definir a turma
- Consulta SQL
- Definir a consulta SQL. Deve possuir obrigatoriamente os campos CODCOLIGADA, RA, CODUSUARIO e EMAIL para todas as notificações temporais e para a notificação de pendência de matrícula ainda deverá conter os campos "IDHABILITACAOFILIAL", "CODCURSO", "NOMECURSO", "CODHABILITACAO" e "NOMEHABILITACAO".
- Preencher os parâmetros
- Consulta padrão do sistema
- Se a mensagem de notificação temporal estiver parametrizada para envio por e-mail todos destinatários que não possuírem um e-mail definido serão ignorados.
- Se a mensagem de notificação temporal estiver parametrizada para notificação no Fluig:
- Parâmetros Educacional: deve possuir a definição da conta de comunicação
- Todos destinatários que não estiverem cadastrados no Fluig serão ignorados.
- O log final do processo contendo o detalhamento das mensagens enviadas com sucesso e as que por algum motivo não puderam ser enviadas.
Documentação Adicional:
- Para utilizar o envio de posts para comunidades deve-se parametrizar a acadêmia social, para mais informações sobre este item acesso o Documento Técnico: DT_Academia_Social