Projeto: FS008539 - Integração SGE x Dynamics
Cliente: FIEPA – SESI e SENAI
Autor: Viviane Pires Magalhães
Data: Novembro/2021



Sumário
Objetivo
2. Customização
2.1 Parâmetros Integração SGE x Dynamics
2.2 Exportação e Atualização de Clientes
2.3 Validação no Período Contábil do Contrato Educacional
2.4 Validação ao salvar Matriz Aplicada
2.5 Validação ao salvar Turma (Sesi)
2.6 Exportação de Contratos | Parcelas | Lançamentos Financeiros | Boletos
2.7 Exportação de Taxas Extras
2.8 Exportação de Acordos
2.9 Exportação de Baixas e Pagamento Antecipado
2.10 Cancelamento de Contrato
2.11 Carga inicial
2.12 Processo para Reenvio de Dados
2.13 Interface de Log









Objetivo


Este manual operacional tem como objetivo orientar o usuário na utilização dos menus e rotinas customizadas, para integração entre SGE x Dynamics.

2. Customização

2.1 Parâmetros Integração SGE x Dynamics

Descrição do processo:
No TOTVS Educacional, por meio do menu Customização | Integração Dynamics | Parâmetros foi disponibilizada uma tela para preenchimento de campos específicos das rotinas customizadas.



Detalhamento do Processo:
Após clicar no menu Parâmetros, serão apresentados os campos criados especificamente para a customização realizar a integração entre o SGE x Dynamics.
Dica:
Para preencher cada um dos campos abaixo, clique duas vezes em cima do campo ou clique no ícone "Editar" ( )


Descrição dos campos:


2.2 Exportação e Atualização de Clientes

Descrição do processo:
Exportação de Clientes
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 | Integração Dynamics | Exportação | Contratos.
O processo poderá ser executado a qualquer momento pelo usuário, na data do processamento ou agendado conforme recurso nativo de agendamento de job.

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:


Atenção:
Para que alterações em clientes PJ não sejam enviadas para o Dynamics, o parâmetro abaixo não deverá estar habilitado.


Detalhamento do Processo
Exportação de Clientes
Acesse o TOTVS Educacional | Customização | Integração Dynamics | Exportação | Contrato


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
Acesse o TOTVS Backoffice | Gestão Financeira | Cadastros | Clientes Fornecedores
Ao editar qualquer um dos campos abaixo, será enviada automaticamente uma atualização deste cliente (Pessoa Física) para o Dynamics.




2.3 Validação no Período Contábil do Contrato Educacional

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".


Dica:
Para o preenchimento automático das datas de competência no contrato educacional, preencha estas datas no cadastro do Plano de Pagamento. TOTVS Educacional | Financeiro - Contábil | Planos de Pagamento.
Assim, todo contrato que for incluído para este plano, já terá estas datas preenchidas automaticamente.



2.4 Validação ao salvar Matriz Aplicada

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).
OBS: No caso do Sesi, o departamento será validado no cadastro de turmas
TOTVS Educacional | Currículo e Oferta | Matrizes Curriculares | Anexo | Matriz Aplicada



2.5 Validação ao salvar Turma (Sesi)

Descrição do processo:
Ao salvar uma Turma no TOTVS Educacional, a customização fará as seguintes validações para o Sesi:


Detalhamento do processo:
A validação para inclusão ou alteração da turma será no campo Departamento.
TOTVS Educacional | Currículo e Oferta | Turmas.

2.6 Exportação de Contratos | Parcelas | Lançamentos Financeiros | Boletos

Descrição 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 integração destes dados foi desenvolvido um processo de exportação no TOTVS Educacional | Customização | Integração Dynamics | Exportação | Contratos.

Detalhamento do processo:
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.

Exportação de Mensalidades:
Para exportar os contratos/lançamentos/boletos para o Dynamics, acesse o menu TOTVS Educacional | Customização | Integração Dynamics | Exportação | Contratos.
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.
⇒ Inclusão de bolsa incondicional em parcelas do contrato: Integração ocorrerá na re-geração do lançamento financeiro.
⇒ Inclusão de desconto no lançamento financeiro: Integração ocorrerá ao salvar o lançamento financeiro.
⇒ Alteração de data de vencimento do lançamento financeiro /boleto: Integração ocorrerá ao finalizar o processo de alteração de data de vencimento do lançamento financeiro.
⇒ Cancelamento de lançamento financeiro: integração ocorrerá quando os lançamentos financeiros de um contrato forem cancelados, após a execução do cancelamento do contrato.


2.7 Exportação de Taxas Extras

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.
Serão consideradas taxas extras as parcelas que estiverem associadas à um contrato educacional e que não estiverem associadas ao serviço de Mensalidade (serviço informado no parâmetro customizado).
Detalhamento do Processo:
Para integração destes dados foi desenvolvido um processo de exportação no TOTVS Educacional | Customização | Integração Dynamics | Exportação | Receitas.

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.





2.8 Exportação de Acordos

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 | Integração Dynamics | Exportação | Acordos.

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.

2.9 Exportação de Baixas e Pagamento Antecipado

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 | Integraçã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.





2.10 Cancelamento de Contrato

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)




2.11 Carga inicial

Descrição do Processo:
Processo customizado para realizar a Carga Inicial de dados TOTVS Educacional para o Dynamics disponível em: TOTVS Educacional | Customização | Integração Dynamics | Carga Inicial.

Detalhamento do Processo:
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.


2.12 Processo para Reenvio de Dados

Descrição do Processo:
O objetivo do processo de reenvio de dados é permitir o envio para o Dynamics dos registros que não foram exportados corretamente. Esse processo poderá ser executado manualmente ou poderá ser agendado, por registro (com status de cancelado, erro ou pendente) e a integração efetuará a exportação dos registros novamente.
Detalhamento do processo
O processo de reenvio de dados está disponível na interface customizada de Monitor de Log que ao ser executado tentará realizar a exportação do registro novamente, armazenando o novo retorno. Será permitido selecionar apenas registros com status de erro ou cancelado. Caso não seja selecionado nenhum registro, serão reprocessados todos os registros com status de erro.
Para acessar o processo: TOTVS Educacional | Customização | Integração Dynamics | Monitor de Log | Processos | Reeenvio


2.13 Interface de Log

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
O monitor de log está disponível em TOTVS Educacional | Customização | Integração Dynamics | Monitor de Log.

Na tela de log estarão disponíveis os seguintes campos: