Projeto: FS008539 – Integração SGE x Dynamics (FS008370, FS008670,FS008539)
Nome do cliente: FIEPA FIEMA/FIEPA/FIERN
Objetivo
Este documento foi elaborada para informar aos multiplicadores e usuários-chave da área Educacional sobre as funcionalidades que possibilitarão a integração do SGE com o Dynamics. Também tem como objetivo habilitá-los a usarem as funcionalidades associadas a esses processos no SGE – SISTEMA DE GESTÃO ESCOLAR (TOTVS Educacional), bem como capacitar novos multiplicadores e usuários finais. Para isso, será apresentada uma visão prática do processo e cadastros educacionais, explorando os conceitos utilizados e as funcionalidades do Sistema. O material orienta a execução das atividades para garantir que todo o Processo Educacional mapeado durante o Programa seja contemplado.Público Alvo
Este manual é destinado aos colaboradores selecionados como multiplicadores e usuários-chave para o Programa SGE.Metodologia
Este material tem como base a visão prática e completa do Processo Customizado ,da área Educacional utilizando a Integração com o Dynamics. 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.Integração de cadastro de clientes e fornecedores, informações financeiras e contábeis entre o SGE e Dynamics.
Expandir | ||
---|---|---|
| ||
|
Expandir | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Pré-requisitos O acesso aos menus devem ser liberados nas permissões de perfil dos usuários para aparecerem nos seus respectivos lugares. Para mais detalhes de como liberar no perfil dos usuários acesse o Manual de Instalação de Customizações na seção Liberando Acesso aos Menus. Após serem liberados nas permissões de perfil dos usuários teremos acesso as customizações no módulo Educacional através do caminho: Módulo Educacional | Educacional |Aba Customização.
Detalhamento do processo A interface customizada estará disponível em: TOTVS Educacional | Customizações | Dynamics | Parâmetros
A partir dela, o usuário poderá configurar os seguintes parâmetros:
| |||||||||||||||
Expandir | |||||||||||||||
| |||||||||||||||
Pré-requisitos Os anexos de retorno devem ser liberados nas permissões de perfil dos usuários para aparecerem nos seus respectivos lugares. Para mais detalhes de como liberar no perfil dos usuários acesse o Manual de Instalação de Customizações na seção Liberando Acesso aos Menus. Print tela Após serem liberados nas permissões de perfil dos usuários teremos acesso as customizações no módulo Educacional através do caminho: Módulo Educacional | Educacional |Aba Customização.
Detalhamento do processo A interface customizada estará disponível em: TOTVS Educacional | Customizações | Integração Dynamics | Parâmetros
A partir dela, o usuário poderá configurar os seguintes parâmetros: Atualiza Cliente PJ: Se o campo não estiver marcado, alterações em cliente PJ não serão enviadas para o Dynamics.Client ID: Informe o identificador do cliente na API. Client Secret: Informe a secret utilizada pela API. Código da Filial Dynamics - Site: Deverá ser preenchido e armazenado por filial no RM. Será utilizado para informar o código correspondente à filial que será enviado para o Dynamics na integração, eliminando a necessidade de de-para fixo no código fonte. Código da Coligada: Deverá ser preenchido e armazenado por coligada no RM. Este código será utilizado pela integração, substituindo os momentos em que são enviados os códigos fixos 1–SESI e 2-SENAI
Concatenar Código Coligada ao Departamento: Deverá ser marcado e armazenado por coligada no RM. Será utilizado para definir se o código da coligada será concatenado ao código do departamento, no momento do envio da dimensão financeira, campo DimensionDisplayValue. Tal informação é enviada ao Dynamics nos processos de taxa extra, contrato e alteração de competência. Conta Orçamentária - Receita: Campo texto para informar o código da conta orçamentária que será utilizada no envio da combinação da dimensão contábil (criação do contrato de venda). Conta Orçamentária - Carga Inicial - Acordo: Campo texto para informar o código da conta orçamentária que será utilizada no envio da combinação da dimensão contábil e conta contábil na carga de dados de Acordos. Conta Orçamentária – Receita – Taxas Extras: Campo texto para informar o código da conta orçamentária que será utilizada no envio da combinação da dimensão contábil e conta contábil (envio de taxas extras do contrato de venda). Data de Produção (Preenchido pelo processo de Carga): Esse campo será preenchido automaticamente com a data que o usuário realizou o Processo Customizado de Carga Inicial de Dados. A customização não realizará o bloqueio deste campo para edição manual. Número tentativas de reenvio: Campo texto para informar o número máximo de tentativas que a customização deverá tentar realizar a integração com dynamics dos registros com status de erro. Serviço (por nível de ensino): Campo utilizado para informar o código do serviço que será considerado para envio dos contratos para o Dynamics. Status que indica Matrícula: Será exibido uma lista da tabela padrão de situação de matrícula (SSTATUS) para que seja informado quais situações de matrícula que a customização irá considerar o aluno como matriculado. Endereço do Web Service de Autenticações: Endereço de acesso ao Webservice para autenticação para das operações no Dynamics. Endereço do Web Service de Integrações: Endereço de acesso ao Webservice disponibilizado pelo Dynamics para efetuar as operações de inserção de clientes, contratos, títulos, baixas, etc.
|
|
Novo!!
Expandir | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Expandir | ||
---|---|---|
| ||
Pré-requisitos Para que alterações em clientes PJ não sejam enviadas para o Dynamics, o parâmetro abaixo não pode estar habilitado. Caso contrário, serão enviadas atualizações de clientes PF e PJ.
Detalhamento do processo Ao incluir um Contrato Educacional no TOTVS Educacional, o responsável financeiro associado às parcelas deste contrato serão enviadas para o Dynamics, junto com os dados do Pedido (Contrato). Caso o responsável financeiro associado já exista no Dynamics, será enviada uma atualização deste cadastro. |
Para integração destes dados foi desenvolvido um processo de exportação no TOTVS Educacional | Customização | |
Dynamics | Exportação | |
Contrato.
O processo poderá ser executado a qualquer momento pelo usuário, na data do processamento ou agendado conforme recurso nativo de |
agendamento de job.
Ao ser executado, este processo enviará os Responsáveis Financeiros (clientes) dos contratos pendentes de envio para o Dynamics. (O detalhamento do envio do contrato está disponível em item específico deste manual). Atualização de Clientes |
Ao alterar os campos listados abaixo no cadastro de clientes (somente Pessoa Física), será enviada uma atualização deste cadastro para o Dynamics. |
|
Campos a serem atualizados: |
|
|
Ao editar qualquer um dos campos citados, será enviada automaticamente uma atualização deste cliente (Pessoa Física) para o Dynamics. Para realizar a alteração, acesse a interface TOTVS Backoffice | Gestão Financeira | Cadastros | Clientes Fornecedores.
|
Expandir | |||||
---|---|---|---|---|---|
| |||||
Descrição do processo A customização não permitirá que um contrato educacional seja incluído sem o preenchimento dos campos Competência Inicial e Competência Final. Além disso, foi desenvolvido uma consistência para alteração destas datas, devendo respeitar algumas regras:
Detalhamento do processo Para o preenchimento ou alteração das datas de competência no contrato educacional, acesse TOTVS Educacional | Financeiro - Contábil | Contratos. Ao editar o contrato, acesse a aba “Contabilização”.
Assim, todo contrato que for incluído para este plano, já terá estas datas preenchidas automaticamente.
|
Expandir | |||||
---|---|---|---|---|---|
| |||||
Descrição do processo Ao salvar uma Matriz Aplicada no TOTVS Educacional, a customização fará as seguintes validações:
Detalhamento do processo A validação para inclusão ou alteração da Matriz Aplicada será nos campos Centro de Custos (Sesi e Senai) e Departamento (somente Senai). Disponível em: TOTVS Educacional | Currículo e Oferta | Matrizes Curriculares | Anexo | Matriz Aplicada
Portanto haverá uma validação ao salvar uma Turma (SESI) no TOTVS Educacional, a customização irá verificar se o campo Departamento disponível em: TOTVS Educacional | Currículo e Oferta | Turmas | Aba Identificação esta preenchido, pois a validação para inclusão ou alteração da turma, será no campo Departamento.
|
Expandir | ||
---|---|---|
| ||
Descrição do processo Ao realizar uma transferência interna no TOTVS Educacional, a customização fará a seguinte notificação: “[Dynamics]: Atenção! Foi gerado um novo contrato para cada aluno transferido na nova filial. Deverão ser preenchidos os dados de plano de pagamento e data de competência contábil do novo contrato.” |
Expandir | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Pré-requisitos Status que indica matrícula: A situação de matrícula deverá estar informada nos parâmetros da customização. Serão considerados para exportação todos os contratos de alunos com o status informado neste parâmetro.
Período de Competência preenchido no contrato: Contratos que não possuem o período de competência informado na aba Contabilização do Contrato - Data inicial e Final, não serão enviados. Detalhamento do processo: A integração de Contratos e Parcelas/Boletos será realizada para os contratos e parcelas/boletos de alunos com situação de matrícula no Período letivo igual a situação de matrícula parametrizada e que ainda não foram exportados para o Dynamics. Serão exportadas parcelas de mensalidades e também alteração em parcelas já integradas anteriormente. Para essa integração foi desenvolvido um processo no TOTVS Educacional | Customização | Dynamics | Exportação | Contrato, para exportar os contratos/lançamentos/boletos para o Dynamics.
O processo poderá ser executado a qualquer momento pelo usuário, na data do processamento ou agendado conforme recurso nativo de agendamento de job.
Ao executar o processo, para cada Contrato Educacional do TOTVS será enviado para o Dynamics cabeçalho de Contrato de Vendas, para cada mês de competência do contrato educacional (período de contabilização do contrato) será criada uma linha no contrato de vendas e para cada Parcela/Boleto do contrato será criada uma linha de boleto no contrato de vendas (linha financeira) no Dynamics. Para os casos de mais de um responsável financeiro no mesmo contrato, será gerado um lançamento para cada responsável financeiro, e estes lançamentos serão enviados ao Dynamics. Este processo envia apenas as parcelas referentes à Mensalidades no Contrato. Para identificá-las será criado um parâmetro por Nível de Ensino para definir o Serviço que será reconhecido como Mensalidade, para que a customização consiga identificar as parcelas que estão associadas a esse serviço.
Alteração de parcelas do contrato Após ter ocorrido a integração de um contrato, poderá haver necessidade de alteração de seus valores no SGE. As alterações abaixo, quando realizadas, serão enviadas para o Dynamics atualizando os valores integrados anteriormente. ⇒ Inclusão de uma nova parcela no contrato: Integração ocorrerá na geração do lançamento financeiro.
|
Expandir | ||
---|---|---|
| ||
Pré-requisitos Registros de competências de contrato já processados e enviado para o dynamics. Detalhamento do processo: A integração de Atualização de Competências do Contrato será realizada para atualizar o envio das informações das competências para os contratos que ainda não foram geradas todas as parcelas. Quando as parcelas são geradas por completo após o pagamento da primeira e efetivação da matricula, os valores das competências são reenviados para o Dynamics. O acionamento para atualização dos valores ao Dynamics consta na manipulação das seguintes telas: TOTVS Educacional | Currículo e Oferta | Matrizes Curriculares | Anexos | Matriz Aplicada TOTVS Educacional | Currículo e Oferta | Turmas
|
Expandir | |||||||
---|---|---|---|---|---|---|---|
| |||||||
Pré-requisitos Registros de competências de contrato já processados e enviado para o dynamics. Detalhamento do processo: A integração de Alteração de Dimensão Contábil será realizada para atualizar a informação das dimensões para os contratos. O acionamento do processo para o envio da dimensão da conta, se deve ao alterar o centro de custo da Matriz Aplicada (SESI e SENAI) ou Departamento na turma (SESI) ou Departamento na matriz aplicada (SENAI), assim acionando o atual processamento de envio das linhas de competência onde e passado a dimensão alterada. O processo irá enviar/reenviar todas as competências com a nova dimensão de conta a partir do mês de O acionamento para atualização da dimensão da conta ao Dynamics consta na manipulação das seguintes telas: TOTVS Educacional | Currículo e Oferta | Matrizes Curriculares | Anexos | Matriz Aplicada TOTVS Educacional | Currículo e Oferta | Turmas
|
Expandir | ||
---|---|---|
| ||
Descrição do processo A integração enviará as linhas de competência dos contratos criados após a data corte já parametrizada na base para envio das atualização dos mesmas (valor/dimensão).
Detalhamento do processo Para integração destes dados foi desenvolvido um processo de exportação no TOTVS Educacional | Customização | Dynamics | Exportação | Competências/Dimensão.
O processo poderá ser executado a qualquer momento pelo usuário, na data do processamento ou agendado conforme recurso nativo de agendamento de job.
Ao executar o processo, será enviado para o Dynamics Linhas de Competência dos Contratos processadas (retroativas e correntes) para as mesmas serem atualizadas. |
Expandir | ||
---|---|---|
| ||
Descrição do processo A integração de taxas extras será realizada para os contratos e parcelas/boletos de alunos com situação de matrícula no Período letivo igual a situação de matrícula parametrizada e que ainda não foram exportados para o Dynamics. Detalhamento do processo Para integração destes dados foi desenvolvido um processo de exportação no TOTVS Educacional | Customização | Dynamics | Exportação | Receita.
O processo poderá ser executado a qualquer momento pelo usuário, na data do processamento ou agendado conforme recurso nativo de agendamento de job.
Ao executar o processo, para cada taxa extra do Contrato Educacional do TOTVS será enviado para o Dynamics a Capa de diário geral da contabilidade, criação das linhas do diário geral da contabilidade e lançamento diário geral da contabilidade. |
Expandir | ||
---|---|---|
| ||
Descrição do processo A realização de acordo no SGE é uma ferramenta que permite a negociação de um ou vários lançamentos financeiros vencidos e/ou a vencer, consistindo na baixa destes lançamentos e gerando novos boletos com novos vencimentos. Os acordos realizados no SGE ou pelo Portal do aluno que estiverem com o status = “efetivado” e que ainda não foram exportados para o Dynamics poderão ser enviados através do processo customizado. Detalhamento do processo |
Para integração destes dados foi desenvolvido um processo de exportação no TOTVS Educacional | Customização | |
Dynamics | Exportação | |
Acordo.
|
O processo poderá ser executado a qualquer momento pelo usuário, na data do processamento ou agendado conforme recurso nativo de agendamento de job. |
|
Para cada Acordo Financeiro do TOTVS Gestão financeira será enviada para o Dynamics os métodos de Criação da capa do diário de acordo SGE, Criação das linhas da capa do diário de acordo SGE, Criação das linhas de acordo referente ao título gerado e Lançamento do diário de acordo SGE. |
Expandir | ||
---|---|---|
| ||
Descrição do processo As baixas de boletos vinculados aos contratos educacionais ocorrerão no SGE e serão enviadas para o Dynamics através de processo customizado. A exportação de baixas será realizada para os seguintes tipos de baixa: ⇒ Baixa Manual do boleto: Ao realizar uma Baixa manual do boleto no TOTVS será necessário informar manualmente o valor pago. ⇒ Baixa automática do boleto: A baixa automática do boleto será realizada a partir dos pagamentos com cartão de crédito/débito pelo Portal do aluno e pelo retorno do arquivo de retorno do banco. Detalhamento do Processo |
Para integração destes dados foi desenvolvido um processo de exportação no TOTVS Educacional | Customização | |
Dynamics | Exportação | |
Baixa. |
O processo poderá ser executado a qualquer momento pelo |
usuário, na data do processamento ou agendado conforme recurso nativo de agendamento de job.
Exportação de Baixas O processo irá acionar os métodos do Dynamics de Criação da capa do diário de baixa de pagamento, Criação das linhas da capa do diário de baixa do pagamento e Lançamento do diário de baixa de pagamento. Após processamento, o Dynamics retornará à informação se o registro foi processado com sucesso ou erro, informando a mensagem em caso de erro.
Exportação de Pagamento Antecipado As baixas de lançamentos financeiros/boletos que possuem data de vencimento posterior ao mês corrente e que foram baixadas no mês corrente serão considerados pagamento antecipado.
A customização irá acionar os métodos Criação da capa do diário de adiantamento de contrato de venda, Criação das linhas da capa do diário de adiantamento e Lançamento do diário de adiantamento, enviando todas as informações do Pagamento Antecipado. Após o processamento o Dynamics retornará à informação se o registro foi processado com sucesso ou erro, informando a mensagem em caso de erro.
|
Expandir | ||
---|---|---|
| ||
Descrição do processo Os contratos educacionais do SGE já integrados ao Dynamics poderão ser cancelados a qualquer momento, através de funcionalidade nativa do SGE. Ao realizar este processo, a customização irá enviar as informações de cancelamento para o Dynamics, ao final da execução do processo. Detalhamento do processo Quando é enviado um cancelamento, o Dynamics finda o contrato, atualizando seu status. Depois de alterado, o contrato consegue receber apenas novas baixas (de títulos em aberto). Não será mais permitido enviar novos lançamentos e reconhecimento de receita para o contrato. O cancelamento do contrato no SGE poderá ocorrer através dos seguintes processos: ⇒ Cancelar contrato: (TOTVS Educacional | Financeiro-Contábil | Contratos | Processo | Cancelar Contrato)
⇒ Alterar situação de matrícula: (TOTVS Educacional | Matrícula e Avaliação | Matrículas | Processo | Alterar Situação de Matrícula)
|
Expandir | ||
---|---|---|
| ||
Detalhamento do processo Processo customizado para realizar a Carga Inicial de dados TOTVS Educacional para o Dynamics disponível em: TOTVS Educacional | Customização | Dynamics | Carga Inicial.
Ao ser executado o processo customizado retornará o campo “Data de Corte – Início”, para que o usuário informe a Data Inicial que a customização deverá considerar os lançamentos financeiros e os Acordos Financeiros com Status Efetivado e que ainda possuem um ou mais lançamentos financeiros em aberto para esses serem enviados para o Dynamics. O campo “Data de Corte – Início” será de preenchimento obrigatório. Caso o usuário não informe a data não será possível executar o processo. |
Expandir | ||
---|---|---|
| ||
Descrição do processo Através do monitor de logs será possível realizar consultas dos Logs de todas as operações de exportação executadas pela integração do TOTVS Educacional com Dynamics. Detalhamento do processo Nesta interface o usuário poderá consultar os LOGs das operações de exportação executadas pela integração do TOTVS Educacional com Dynamics.
Será apresentada ao usuário uma visão com a relação de registros importados e exportados.
Para alguns casos onde a comunicação não aconteceu com sucesso, o log foi ajustado para armazenar os dados que deveriam ser enviados na requisição, visando facilitar a identificação de problemas. O mesmo pode ser baixado pelo botão de Download de arquivos associados. Não é possível incluir, editar ou excluir informações através dessa interface. |
Expandir | ||
---|---|---|
| ||
Descrição do processo Permitir o reenvio de registros em caso de falha na integração, seja de forma agendada ou manualmente. Detalhamento do processo O objetivo |
é permitir o envio para o Dynamics dos registros que não foram exportados corretamente |
. O processo poderá ser executado manualmente, selecionando os registros desejados, ou poderá ser agendado para buscar todos os registros com erro. Ao executar, a integração efetuará a exportação dos registros com erro novamente. |
Dynamics | Monitor de Log | Processos | |
Reenvio |
O processo de reenvio de dados buscará os registros com erro e tentará realizar novamente o envio das informações ao Dynamic. Caso consiga o status do registro passará para Sucesso. O processo de reenvio automático será executado até atingir o número máximo de tentativas parametrizado (Parâmetros da integração – Parâmetros Gerais). Caso o parâmetro esteja vazio a customização não realizará nenhuma tentativa de reenvio automaticamente. Caso seja atingido o número máximo de tentativas de reenvio e em nenhuma das tentativas tenha retornado sucesso, a customização passará o status do registro para Cancelado, sendo o registro não integrado com o Dynamics. 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 manual (selecionando o registro desejado).
|