Histórico da Página
Central de NotificaçãoNotificação
Características do Requisito
Linha de Produto: | Informe a linha de produto.RM | ||||||||||||||||||||||
Segmento: | Informe o segmento.TOTVS Educacional | ||||||||||||||||||||||
Módulo: | Informe o módulo.Educacional | ||||||||||||||||||||||
Rotina: |
| ||||||||||||||||||||||
Cadastros Iniciais: | Relacione os cadastros necessários que precisam ser preenchidos antes da utilização desse requisito.Parametrização da integração com o Fluig e servidor de E-mail | ||||||||||||||||||||||
Parâmetro(s): | Informe os parâmetros utilizados. | ||||||||||||||||||||||
Ponto de Entrada: | Informe o ponto de entrada relacionado (link). | ||||||||||||||||||||||
Chamados Relacionados | Informe o(s) chamado(s) relacionado(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): | Informe o requisito relacionado (Issue).PCREQ-5421 | ||||||||||||||||||||||
País(es): | Informe o(s) Pais(es). | ||||||||||||||||||||||
Banco(s) de Dados: | Informe o(s) Banco(s) de Dados utilizado(s). | ||||||||||||||||||||||
Tabelas Utilizadas: | Informe as tabelas utilizadas. | ||||||||||||||||||||||
Sistema(s) Operacional(is): | Informe o(s) sistema(s) operacional(is) utilizados. | ||||||||||||||||||||||
Versões/Release: | Informe as versões. | ||||||||||||||||||||||
Versão Corrigida: | Versão na qual está sendo feita a manutenção deste programa. | ||||||||||||||||||||||
Versão Expedida: | Versão em que o programa será oficialmente expedido. |
Descrição
Escreva aqui a descrição da nova implementação ou melhoria.
Importante
(Apenas para Microsiga Protheus, versões anteriores à versão 12)
Antes de executar o compatibilizador informe o nome do compatibilizador é imprescindível:
- Realizar o backup da base de dados do produto que será executado o compatibilizador (diretório PROTHEUS_DATA\DATA, se versão 10, ou \PROTHEUS11_DATA\DATA, se versão 11) e dos dicionários de dados SXs (diretório PROTHEUS_DATA_SYSTEM, se versão 10, ou \PROTHEUS11_DATA\SYSTEM, se versão 11).
- Os diretórios acima mencionados correspondem à instalação padrão do Protheus, portanto, devem ser alterados conforme o produto instalado na empresa.
- Essa rotina deve ser executada em modo exclusivo, ou seja, nenhum usuário deve estar utilizando o sistema.
- Se os dicionários de dados possuírem índices personalizados (criados pelo usuário), antes de executar o compatibilizador, certifique-se de que estão identificados pelo nickname. Caso o compatibilizador necessite criar índices, irá adicioná-los a partir da ordem original instalada pelo Protheus, o que poderá sobrescrever índices personalizados, caso não estejam identificados pelo nickname.
- O compatibilizador deve ser executado com a Integridade Referencial desativada*.
Atenção O procedimento a seguir deve ser realizado por um profissional qualificado como Administrador de Banco de Dados (DBA) ou equivalente! A ativação indevida da Integridade Referencial pode alterar drasticamente o relacionamento entre tabelas no banco de dados. Portanto, antes de utilizá-la, observe atentamente os procedimentos a seguir:
Contate o Help Desk Framework EM CASO DE DÚVIDAS! |
---|
- Em Microsiga Protheus TOTVS Smart Client (se versão 10) ou ByYou Smart Client (se versão 11), digite informe o nome do compatibilizador no campo Programa Inicial. Descreva se o compatibilizador deve ter uma data específica ou superior para que a atualização nos dicionários seja efetuada corretamente. Importante: Para a correta atualização do dicionário de dados, certifique-se que a data do compatibilizador seja igual ou superior a ___/___/____.
- Clique em OK para continuar.
- Após a confirmação é exibida uma tela para a seleção da empresa em que o dicionário de dados será modificado ou é apresentada a janela para seleção do compatibilizador. Selecione o programa xxxx().
- Ao confirmar é exibida uma mensagem de advertência sobre o backup e a necessidade de sua execução em modo exclusivo.
- Clique em Processar para iniciar o processamento. O primeiro passo da execução é a preparação dos arquivos.
É apresentada uma mensagem explicativa na tela. - Em seguida, é exibida a janela Atualização concluída com o histórico (log) de todas as atualizações processadas. Nesse log de atualização são apresentados somente os campos atualizados pelo programa. O compatibilizador cria os campos que ainda não existem no dicionário de dados.
- Clique em Gravar para salvar o histórico (log) apresentado.
- Clique em OK para encerrar o processamento.
- Clique em Processar para iniciar o processamento. O primeiro passo da execução é a preparação dos arquivos.
Descreva se há algum procedimento necessário após a aplicação do compatibilizador.
Procedimento para Implantação
O sistema é atualizado logo após a aplicação do pacote de atualizações (Patch) deste chamado.
- Aplique o patch do chamado e execute uma vez a rotina Informe o nome da rotina.
- No módulo informe o nome do módulo acesse informe o caminho e verifique que o parâmetro informe o nome do parâmetro é criado conforme especificações abaixo:
Nome da Variável: | Informe o Nome da Variável |
Tipo: | Informe o Tipo |
Descrição: | Informe a Descrição |
Valor Padrão: | Informe o Valor Padrão |
Atualizações do Compatibilizador
(Apenas para Microsiga Protheus, versões anteriores à versão 12)
- Criação ou Alteração de Perguntas no arquivo SX1 – Cadastro de Perguntes:
Pergunte | (X1_PERGUNT) |
Nome |
|
Grupo | (X1_GRUPO) |
Ordem | (X1_ORDEM) |
Tipo | (X1_TIPO) |
Tamanho | (X1_TAMANHO) |
2. Criação ou Alteração de tabela no arquivo SX2– Tabelas:
Chave | Nome | Modo | PYME |
B04 (X2_CHAVE) | Dente/Região (X2_NOME) | C (X2_MODO) | N (X2_PYME) |
3. Criação ou Alteração de Tabelas Genéricas no arquivo SX5 – Tabelas Genéricas:
Chave | Ex.: AR |
Descrição | Ex.: Tabela de IR de Aplicações Financeiras |
4. Criação ou Alteração (mantenha somente a instrução correspondente) de Campos no arquivo SX3 – Campos:
- Tabela BGD - Prod x Cob x Proc x Co-Part:
Campo | (X3_CAMPO) |
Tipo | (X3_TIPO) |
Tamanho | (X3_TAMANHO) |
Decimal | (X3_DECIMAL) |
Formato | (X3_PICTURE) |
Título | (X3_TITULO) |
Descrição | (X3_DESCRIC) |
Nível | (X3_NÍVEL) |
Usado | (X3_USADO) Informe Sim ou Não |
Obrigatório | (X3_OBRIGAT) Informe Sim ou Não |
Browse | (X3_BROWSE) Informe Sim ou Não |
Opções | (X3_CBOX) |
When | (X3_WHEN) |
Relação | (X3_RELACAO) |
Val. Sistema | (X3_VALID) |
Help | Descreva o conteúdo informado para Help de Campo no ATUSX |
Importante:
O tamanho dos campos que possuem grupo pode variar conforme ambiente em uso.
5. Criação ou Alteração de Consulta Padrão no arquivo SXB – Consulta Padrão:
- Pesquisa B05PLS:
Alias | (XB_ALIAS) |
Tipo | (XB_TIPO) |
Sequência | (XB_SEQ) |
Coluna | (XB_COLUNA) |
Descrição | (XB_DESCRI) |
Contém | (XB_CONTEM) |
6. Criação ou Alteração de Índices no arquivo SIX – Índices:
Índice | AA1 |
Ordem | 6 |
Chave | AA1_FILIAL+AA1_CODVEN |
Descrição | Cod. Vendedor |
Proprietário | S |
7. Criação ou Alteração de Parâmetros no arquivo SX6 – Parâmetros:
Nome da Variável | (X6_VAR) |
Tipo | (X6_TIPO) |
Descrição | (X6_DESCRIC + X6_DESC1 + X6_DESC2) |
Valor Padrão | (X6_CONTEUD) |
8. Criação ou Alteração (mantenha somente a instrução correspondente) de Gatilhos no arquivo SX7 – Gatilhos:
- Tabela BD5 – Contas Médicas:
Campo | Informe o conteúdo do (X7_CAMPO) |
Sequência | Informe o conteúdo do (X7_SEQUENC) |
Campo Domínio | Informe o conteúdo do (X7_CDOMIN) |
Tipo | Informe o conteúdo do (X7_TIPO) |
Regra | Informe o conteúdo do (X7_REGRA) |
Posiciona? | Informe o conteúdo do (X7_SEEK) |
Chave | Informe o conteúdo do (X7_CHAVE) |
Condição | Informe o conteúdo do (X7_CONDIC) |
Proprietário | Informe o conteúdo do (X7_PROPRI) |
Procedimento para Configuração
(Estes procedimentos devem ser feitos quando for necessário configurar parâmetros e/ou rotinas no menu).
CONFIGURAÇÃO DE PARÂMETROS
- No Configurador (SIGACFG), acesse Ambientes/Cadastros/Parâmetros (CFGX017). Crie/configure (mantenha somente a instrução correspondente) o(s) parâmetro(s) a seguir:
(É necessário criar uma tabela para cada parâmetro descrito no item Parâmetro(s), da tabela Características do Requisito)
Itens/Pastas | Descrição |
Nome: |
|
Tipo: | Informe o Tipo do parâmetro |
Cont. Por.: | Informe o Conteúdo padrão |
Descrição: |
|
CONFIGURAÇÃO DE MENUS
2. No Configurador (SIGACFG), acesse Ambientes/Cadastro/Menu (CFGX013). Informe a nova opção de menu do informe o nome do módulo, conforme instruções a seguir:
Menu | Informe o Menu em que estará localizada a rotina |
Submenu | Informe o Submenu em que estará localizada a rotina |
Nome da Rotina | Informe o Título da rotina |
Programa | Informe o Fonte da rotina |
Módulo | Informe o Nome do(s) produto(s) a ser utilizado ou “Todos” |
Tipo | Informe a Função |
Procedimento para Utilização
- Descreva os procedimentos, passo a passo (caso de uso), que serão realizados pelos usuários para que a melhoria seja visualizada identificando as seguintes informações:
- Localização da rotina no menu;
- Localização dos novos campos e/ou perguntas e respectivas pastas de cadastro que são visualizadas pelo usuário;
- Caso seja necessário ter algum cadastro feito previamente, faça uma observação.
Exemplo:
1. No Plano de Saúde (SIGAPLS), acesse Atualizações / Produto Saúde / Produto Saúde (PLSA800).
O sistema apresenta a janela de produtos cadastrados.
2. Posicione o cursor em um produto e clique em Alterar.
3. Na pasta Cobertura/Carências selecione a subpasta Tipo de Prestador.
4. Dê duplo clique no campo TP Prestador (BCW_TIPPRE).
O sistema apresenta a janela Tipo de Prestador – Coparticipação – Alterar.
5. Informe os dados conforme orientação do help de campo e observe o preenchimento do novo campo:
Som. p/Compra (BCW_SOMCOM): selecione Sim para indicar se a coparticipação cadastrada será válida somente para efeito de compra de procedimentos ou Não, caso contrário.
6. Confira os dados e confirme.
Vídeo
- Vídeo hospedado no youtube e inserido no template por meio da macro Widget Connector.
** Canal do youtube e software de vídeoem definição.
Título do Vídeo: | Disponibilizado pelo Marketing. |
Introdução: | Disponibilizado pelo Marketing. |
Passo a Passo: | Capturar diretamente do sistema. |
Finalização: | Disponibilizado pelo Marketing. |
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
Ponto de Entrada
Descrição: | Informe o Menu em que estará localizada a rotina | ||||||||||||||||
Localização: | Informe o Submenu em que estará localizada a rotina | ||||||||||||||||
Eventos: | Informe o Título da rotina | ||||||||||||||||
Programa Fonte: | Informe o Fonte da rotina | ||||||||||||||||
Função: | Informe o Nome do(s) produto(s) a ser utilizado ou “Todos” | ||||||||||||||||
Retorno: |
|
Exemplo:
#Include 'Protheus.ch'
User Function CN120ALT()
Local aCab:= PARAMIXB[1]
Local cTipo:= PARAMIXB[2]
If cTipo == '1'
aCab[4][2]:= 'NF' //Validações do usuário
EndIf
Return aCab