Projeto: Integração SGE x Dynamics (FS008370, FS008670,FS008539)
Nome do cliente: FIEMA/FIEPA/FIERN
Objetivo
Integração de cadastro de clientes e fornecedores, informações financeiras e contábeis entre o SGE e Dynamics.
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 | Integração Dynamics | Parâmetros
A partir dela, o usuário poderá configurar os seguintes parâmetros:
Dica:
Para preencher cada um dos campos acima, clique duas vezes em cima do campo ou clique no ícone "Editar" 
Novo!!
Pré-requisitos
Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração Dynamics.
Disponível em: Serviços Globais | Perfil | Educacional| Customização | Integração Dynamics | DE|Para | Meios de Pagamento
Detalhamento do processo
Foi criada uma interface de DE|PARA para o usuário definir para cada Meio de Pagamento do RM, os correspondentes no Dynamics.
A interface de DE|PARA poderá ser acessada pelo seguinte caminho:
Menu customização: TOTVS Educacional | Customização | Integração Dynamics | DE|PARA| Meios de Pagamento.
Ao acessar a interface pelo menu customização, será exibida uma visão com todos os registros que possuem De/Para cadastrado, e será possível incluir, editar e excluir um registro.
Ao incluir ou editar, será exibida a interface com os campos:
Código RM: campo do tipo Lookup para informar o código de Meio de Pagamento no RM.
Código Externo: campo do tipo texto livre, para informar o código do Meio de Pagamento do Dynamics que corresponde ao cadastro do RM.
Atenção
Este cadastro de De|Para é separado por Coligada, sendo necessário realizar os cadastros em todas as coligadas em que a Exportação de Baixas serão utilizadas.
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 | 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 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:
- Nome
- Data de nascimento
- Endereço
- Contato
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.
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:
- Não será permitido data de competência sem preencher. (Se estiver preenchida no plano de pagamento, já será preenchida automaticamente no contrato).
- Contrato Contabilizado no Dynamics: Não será permitido alteração das datas de competência.
- Contrato não contabilizado no Dynamics: será permitido alterar data de competência inicial desde que seja maior que o mês de execução do processo (data atual).
- Contrato não contabilizado no Dynamics: será permitido alterar data de competência final desde que seja maior ou igual ao mês de execução do processo (data atual).
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. Disponível em: TOTVS Educacional | Financeiro - Contábil | Planos de Pagamento.
Assim, todo contrato que for incluído para este plano, já terá estas datas preenchidas automaticamente.
Descrição do processo
Ao salvar uma Matriz Aplicada no TOTVS Educacional, a customização fará as seguintes validações:
- Centro de Custo deverá estar preenchido nas Matrizes Aplicadas do SENAI e SESI.
- Departamento deverá estar preenchido nas Matrizes Aplicadas do SENAI.
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
Importante:
Para a Coligada SESI, o departamento será validado no cadastro de Turmas.
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.
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.
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 | Integração Dynamics | Exportação | Contratos, 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.
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.
Contratos de gratuidade e sem parcela, não são realizadas as validações nas datas de competência inicial e final.
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.
Contratos de Gratuidade
Para contratos de gratuidade ou com bolsa incondicional 100%, não serão enviados as linhas financeiras do Contrato para o Dynamics, já que não possuem valores financeiros e isso pode acarretar erro no Dynamics.
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).
Nos casos de atualização dos valores da linha de competência serão enviados todos os meses das competências, valor e dimensão atualizados.
Competências retroativas ao mês do processamento, será processado os valores das competências atualizados, mas não passando a dimensão para atualização.
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 | 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.
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.
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.
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.
Meio de Pagamento
Caso o parâmetro De|Para Meio de pagamento tenha registros cadastrados no processo de exportação de baixa irá considerar o valor do meio de pagamento informado no De-para para o valor correspondente, caso não tenha cadastro ou nenhum relacionado ao meio de pagamento da baixa o envio da informação continuará o padrão Boleto SGE para o campo PaymMode.
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.
Baixa Antecipada
Baixas que acontecem antes do vencimento, não será atualizado o valor original do lançamento financeiro considerando o valor do desconto. Neste caso, consideramos o valor líquido da baixa (sem juros e multa) para atualização das linhas financeiras do contrato no Dynamics.
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.
Baixa Parcial
O processamento das baixas só acontece quando o título é baixado na sua totalidade. Caso aconteça uma baixa parcial, ela ainda não será enviada ao Dynamics. A baixa somente será enviada quando o título for liquidado.
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)
Detalhamento 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.
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.
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.
Os históricos das exportações de dados para o Dynamics serão registrados e poderão ser visualizadas no menu TOTVS Educacional | Customização | Integração Dynamics | Monitor de Log.
Será apresentada ao usuário uma visão com a relação de registros importados e exportados.
▪ Id Log: Identificador sequencial de Log.
▪ Campos Chave: Descrição dos campos utilizados para gerar o registro integrado.
▪ Valores Chave: Chave primária do registro integrado.
▪ Status: Situação da Integração (Sucesso ou Erro).
▪ Funcionalidade: Tipo de Processo que está sendo feito (Por exemplo: Exportação de Cliente).
▪ Módulo: Tipo da integração que está sendo feita.
▪ Data de Criação: Data de Criação do registro.
▪ Data da última alteração: Data da última alteração do registro.
▪ Filial: Filial do registro enviado.
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.
Os dados informados nesta interface serão armazenados em tabela customizada por coligada.
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.
A funcionalidade estará disponível em: TOTVS Educacional | Customização | Integração 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).
Importante
A seleção manual dos registros será permitida para os status Erro e Cancelado. O processo automático (agendado) busca todos os registros com Erro. Não é permitido agendar o processo selecionando algum registro.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas