Manual Operacional - Integração Folha x Sapiens

• Configuração Integração com outros BackOffice: Para que as tabelas intermediárias entre o Folha e os outros BackOffice sejam utilizadas, é necessário parametrizar o RM para utilização de outros BackOffice. Para isso, acessar o menu TOTVS Folha de Pagamento | Ambiente | Parâmetros | Folha de Pagamento. Selecionar a opção: Integrações → Outros BackOffice. Ao avançar, marcar o parâmetro: "Usa Integração outros BackOffice".

• Cadastros básicos necessários: Para a integração com SAPIENS, alguns cadastros do RM são necessários. 
  • Cliente Fornecedor
  • Centro de Custo
  • Natureza Orçamentária/Financeira

• Parametrização de máscaras: Para alguns cadastros citados, é necessário parametrizar as máscaras dos códigos antes da realização dos cadastros. São eles: Natureza Orçamentária/Financeira, Cliente/Fornecedor, Centro de Custo. Para definição das máscaras, acessar o menu....

Parametrização de rateios

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração Folha x Sapiens.

Disponível em: Serviços Globais | Perfil | Folha de Pagamento| Customização | Integração Folha x Sapiens | Parâmetros

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: RH | Folha de Pagamento | Customização | Integração Folha x Sapiens | Parâmetros

Dados da Conexão

• Endereço (Lançamentos Financeiros): Neste parâmetro o usuário deverá informar a URL do servidor SAPIENS referente ao método do Webservice de inclusão de lançamentos financeiros. 
• Endereço (Exclusão de Lançamentos Financeiros): Neste parâmetro o usuário deverá informar a URL do servidor SAPIENS referente ao método do Webservice de exclusão de lançamentos financeiros.
• Endereço (Inclusão de Lote Contábeis): Neste parâmetro o usuário deverá informar a URL do servidor SAPIENS referente ao método do Webservice de inclusão de lote contábeis.
• Endereço (Inclusão de Lançamentos Contábeis): Neste parâmetro o usuário deverá informar a URL do servidor SAPIENS referente ao método do Webservice de inclusão  de lançamentos contábeis.
• Endereço (Processamento de Lote Contábeis): Neste parâmetro o usuário deverá informar a URL do servidor SAPIENS referente ao método do Webservice de processar os lotes contábeis.
• Endereço (Exclusão de Lote Contábeis): Neste parâmetro o usuário deverá informar a URL do servidor SAPIENS referente ao método do Webservice de exclusão de lotes contábeis. 
• Senha: Neste parâmetro o usuário deverá informar o senha para autenticação de acesso
• Usuário: Neste parâmetro o usuário deverá informar o usuário para autenticação de acesso. 

Dados da Integração

• Código de Transação para Exportação do Lançamento Financeiro: neste parâmetro o usuário deverá informar o código de tipo de transação do SAPIENS referente a entrada de títulos (contas a pagar).
• Código da Origem para Exportação de Lote Contábil: neste parâmetro o usuário deverá informar o código da origem dos lotes/lançamentos contábeis do SAPIENS.
• Código da Empresa, armazenado no SGE por Coligada. Neste parâmetro, o usuário poderá definir qual código de empresa precisa ser enviado na integração de lançamentos financeiros e contábeis, para cada Coligada do SGE.  
• Qtde. partidas enviadas por pacote contábil,  para informar o número máximo de lançamentos contábeis que podem ser enviados para o SAPIENS na mesma requisição. Esse parâmetro foi necessário pois o Sapiens possui limitação da quantidade de partidas contábeis que podem ser processadas por requisição. Quando a quantidade de lançamentos é maior que o parâmetro, o envio do lote é particionado. 

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração Folha x Sapiens.

Disponível em: Serviços Globais | Perfil | Folha de Pagamento| Customização | Integração Folha x Sapiens | Exportação lançamentos financeiros para SAPIENS

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.

Detalhamento do processo

Foi criado um processo customizado de Exportação de Lançamentos Financeiros da Folha, para enviar os lançamentos financeiros gerados durante a emissão da Folha de Pagamento do módulo TOTVS RH, para o sistema SAPIENS, disponível em: TOTVS RH | Folha de Pagamento |Encargos | Lançamentos Financeiros| Exportação lançamentos financeiros para SAPIENS. 

O usuário poderá selecionar um ou vários registros para integração.

A FIEPE precisa garantir que exista no SAPIENS apenas um lançamento financeiro por tipo de pagamento / evento (folha, encargos, férias, etc.) para todas as filiais. Para isso, só deverá existir um lançamento por tipo de pagamento no RM. 

O RM não trata rateio por filial na geração do lançamento. Portanto, a customização realizará o rateio por filial, na hora do envio para o SAPIENS, considerando a filial de lotação do funcionário (Filial da Seção). De acordo com o exemplo abaixo:

Lançamento financeiro: 100

Tipo de pagamento/evento: Líquido Salarial

Natureza Financeira: Salários

Centro de Custo: Educação

Total lançamento: R$ 150.000,00, referente aos funcionários:

Rateio enviado ao SAPIENS para o lançamento 100:

Ao executar o processo, a customização consumirá a API disponibilizada pelo SAPIENS e enviará os dados dos lançamentos financeiros da folha gerados através do SGE, para serem criados no SAPIENS.

Após a exportação dos dados, as informações enviadas para o SAPIENS ficarão armazenadas no Monitor de log com a funcionalidade:  Exportação de Lançamentos Financeiros da Folha e pode ser acessado através dos menus: RH | Folha de Pagamento | Customização | Integração Folha x Sapiens | Monitor de Log e RH | Folha de Pagamento | Encargos | Financeiro | Lançamentos (Folha de Pagamento) | Anexos | Log - Integração Financeira SAPIENS

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração Folha x Sapiens.

Disponível em: Serviços Globais | Perfil | Folha de Pagamento| Customização | Integração Folha x Sapiens | Excluir lançamentos financeiros do SAPIENS

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.

Detalhamento do processo

Foi criado um processo customizado de Exclusão dos lançamentos financeiros, para enviar os dados de lançamentos de Folha de pagamento que precisam ser excluídos do SAPIENS, disponível em: TOTVS RH | Folha de Pagamento | Encargos | Lançamentos Financeiros | Excluir lançamentos financeiros do SAPIENS.

Este processo deverá ser executado manualmente pelo usuário, não sendo permitido seu agendamento.

O usuário poderá selecionar um ou mais registros e clicar no processo. Ao executar, a customização irá chamar a API SAPIENS para exclusão do(s) lançamento(s)  selecionado(s). 

Existem os casos de exclusão em que o lançamento nem foi exportado para o SAPIENS: o usuário identifica um erro antes de exportá-lo e o lançamento precisa ser excluído. Neste caso o processo irá verificar primeiro se o lançamento já foi exportado. Caso negativo, ele será excluído do RM, seguindo as regras nativas de exclusão (sem necessidade de consultar o SAPIENS). 

Caso já tenha sido exportado,  o processo permanece sem alterações: ele precisará ser excluído primeiro do SAPIENS antes de ser excluído do RM. 

Caso o SAPIENS execute com sucesso a exclusão, o registro também será excluído da interface no RM. Caso a API retorne algum erro, o registro continuará sendo exibido na interface do RM, o status da integração será atualizado para “Integrado - Exclusão não permitida” e o erro será exibido no log do processo e no monitor de log.

Após a exportação dos dados, as informações enviadas para o SAPIENS ficarão armazenadas no Monitor de log com a funcionalidade:  Exportação de Lançamentos Financeiros da Folha e pode ser acessado através dos menus: RH | Folha de Pagamento | Customização | Integração Folha x Sapiens | Monitor de Log e RH | Folha de Pagamento | Encargos | Financeiro | Lançamentos (Folha de Pagamento) | Anexos | Log - Integração Financeira SAPIENS

Foi criado um campo de status da integração com o Sapiens (Status Integração Sapiens), nele a customização consultará o status da integração através das tabelas de controle das entidades correspondentes com as telas.

Lançamento Financeiro

Disponível através do menu: TOTVS RH | Folha de Pagamentos | Encargos | Lançamentos Financeiros.

A exibição do campo será conforme exemplo:

• Pendente: Integração não realizada. 
• Sucesso: Integração realizada com sucesso, preenchido pelo processo de exportação de lançamentos financeiros. 
• Erro: Erro na integração, preenchido pelo processo de exportação de lançamentos financeiros.  
• Integrado - Erro na exclusão: registro integrado no
  SAPIENS e apresentou erro na exclusão do SAPIENS, preenchido pelo processo de exclusão de lançamentos financeiros do SAPIENS.

Lançamento Contábil

Disponível através do menu: TOTVS RH | Folha de Pagamentos | Encargos | Contabilização | Lançamentos | Lançamentos (Folha de Pagamento)

A exibição do campo será conforme exemplo:

• Sucesso: Lote, lançamentos e processamento (contabilização) integrados com sucesso no Sapiens.
• Erro no Lote: Erro ao integrar o lote contábil.
• Erro no Lançamento: Lote integrado com sucesso, mas ocorreu um erro ao integrar os lançamentos do lote.
• Erro no Processamento: Lote e lançamentos integrados com sucesso, mas ocorreu um erro ao realizar o processamento do lote (contabilização no Sapiens).
• Pendente: Integração com o Sapiens pendente.
• Integrado - Erro na Exclusão: Lote integrado com sucesso, mas ocorreu um erro no processo de exclusão do lote.
• Sucesso Parcial:
  • O lote foi integrado com sucesso, mas as outras etapas não foram processadas.
  • O lote e os lançamentos foram integrados com sucesso, mas a etapa de contabilização não foi concluída.

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração Folha x Sapiens.

Disponível em: Serviços Globais | Perfil | Folha de Pagamento| Customização | Integração Folha x Sapiens | Exportar lotes contábeis para o SAPIENS

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.

Detalhamento do processo

Os lotes contábeis serão gerados no RM através das funções nativas do produto. Ao finalizar a geração dos lotes, conferência dos lançamentos (partidas) e rateios, o usuário deverá executar o processo de exportação para o SAPIENS. A customização não fará cálculos no envio das informações, ela será responsável por enviar ao SAPIENS, os dados gerados através das funções nativas.

Para isso foi criado um processo customizado Exportação de Lotes Contábeis, disponível em: TOTVS Educacional | RH | Folha de Pagamento | Encargos | Lançamentos Contábeis| Exportar lotes contábeis para o SAPIENS.

Este processo deverá ser executado manualmente pelo usuário, não sendo permitido seu agendamento. 

O usuário poderá selecionar um ou vários registros de lotes (gerados pela folha) para integração. 

Ao executar o processo, a customização enviará os lotes contábeis selecionados e seus respectivos lançamentos para o SAPIENS. Para cada lote do RM, será necessário enviar seus dados principais e seus lançamentos, além de enviar o processamento do lote.

Número do Lote:

O número do lote no SAPIENS é gerado automaticamente na inclusão e devolvido para o RM no momento da requisição da API. Ele será armazenado no RM, na interface nativa de Lotes Contábeis pelo campo Id. Lote Sapiens.

Correção de lançamentos e reenvio:

Caso seja necessário alterar algum lote ou lançamento do lote, ela será permitida conforme recursos nativos, caso o lote ainda não tenha sido exportado para o SAPIENS. Caso contrário, será necessário excluir o lote do SAPIENS pelo processo customizado, para então proceder com o ajuste ou nova geração de lote. 

Todas as alterações permitidas na interface nativa lançamentos contábeis da Folha: inclusão de partidas, rateio, nome do lote, por exemplo, serão bloqueadas caso o lote já tenha sido integrado ao SAPIENS. 

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração Folha x Sapiens.

Disponível em: Serviços Globais | Perfil | Folha de Pagamento| Customização | Integração Folha x Sapiens | Exportação lançamentos financeiros para SAPIENS

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.

Detalhamento do processo

Foi criado um processo customizado de Exclusão dos lotes contábeis, para enviar os dados dos lotes que serão excluídos pelo usuário, disponível em: TOTVS RH | Folha de Pagamento | Encargos | Lançamentos (Folha de Pagamento)|Excluir lançamentos contábeis no SAPIENS.

O usuário poderá selecionar um ou mais registros e clicar no processo. Será exibida a opção para o usuário excluir ou não o registro do RM, já que a exclusão pode estar sendo feita para permitir alguma alteração no cadastro. Por padrão, este campo virá marcado (Excluir registro do RM). 

Ao executar, a customização irá chamar a API SAPIENS para exclusão do(s) lotes(s)  contábeis selecionado(s). 

É de responsabilidade do SAPIENS controlar se o registro poderá ou não ser excluído, já que as movimentações contábeis serão feitas apenas no SAPIENS. 

Caso o SAPIENS execute com sucesso a exclusão, o registro também será excluído da interface no RM, se o usuário optar por esse comportamento. Caso a API retorne algum erro, o registro continuará sendo exibido na interface do RM, o status da integração será atualizado para “Integrado - Exclusão não permitida” e o erro será exibido no log do processo e no monitor de log.

Caso a exclusão seja feita no SAPIENS e o usuário opte por manter o registro do RM, o status da integração será atualizado para Pendente e o número do lote no SAPIENS ficará vazio. Este registro estará disponível para ser integrado novamente.

Caso seja necessário excluir o registro do RM, o usuário poderá utilizar a opção nativa de exclusão, na interface de lançamentos contábeis. 

Detalhamento do processo

Atualmente, o processo de geração dos lançamentos contábeis está disponível para execução a qualquer momento pelo usuário, mesmo que já existam lançamentos gerados no RM para um lote específico. Isso pode ser feito através da interface nativa disponível em: TOTVS Educacional| RH| Folha de Pagamento | Encargos | Contabilização |Geração dos Lançamentos.

Quando o usuário executar o processo de geração dos lançamentos contábeis, caso o lote do lançamento já esteja integrado ao Sistema SAPIENS, será exibida mensagem para o usuário informando que o lançamento não poderá ser gerado novamente.

Pré-requisitos

Devem ser liberadas nas permissões de perfil dos usuários, os menus da customização Integração Folha x Sapiens.

Disponível em: Serviços Globais | Perfil | Folha de Pagamento| Customização | Integração Folha x Sapiens | Monitor de Log

Detalhamento do processo

Foi criada uma interface de Log para armazenar informações e status dos dados que foram exportados do SGE para o SAPIENS, referentes aos lançamentos financeiros e contábeis da folha de pagamento. 

O histórico das exportações de dados para o SAPIENS serão registrados e poderão ser acessados por dois caminhos distintos:

• Menu customização: TOTVS RH | Customizações | Integração SAPIENS | Monitor de Log.

• Interface de Lançamentos Financeiros da Folha TOTVS RH | Folha de Pagamento | Encargos | Lançamentos Financeiros| Anexos | Monitor de Log - Lançamentos Financeiros.

• Interface de Lançamentos Contábeis da Folha TOTVS RH | Folha de Pagamento | Encargos | Contabilização | Lançamentos Contábeis | Anexos | 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.
• Data de Criação: Data de Criação do registro.
• Data da última alteração: Data da última alteração do registro.
• Status: Situação da Integração (Sucesso ou Erro).
• Id. Job: Ultimo job executado que resulto criação ou alteração do log.
• Descrição do módulo: Descrição que permite identificar o módulo.
• Cód. Filial: Código da Filial associada ao registro.
• Funcionalidade: Tipo de Processo que está sendo feito (Por exemplo: Exportação Moodle).
• Campos Chave: Descrição dos campos utilizados para gerar o registro integrado.
• Valores Chave: Chave primária do registro integrado.
• Última mensagem do item de log: Ultima mensagem do item do log.
• Download de arquivos associados: Permitirá o download de arquivo associado ao logo caso exista.

Ao acessar o anexo de um registro será possível o usuário visualizar todos os registros relacionados ao cadastro integrado selecionando a opção Item de Log. Estarão disponíveis os seguintes campos:

• Id. Item Log: Identificador sequencial de log.
• Id. Log: Identificador sequencial de log.
• Mensagem: Mensagem com o status da integração do item.
• Status: Situação da integração do item selecionado.
• Dados Enviados: Relação dos dados enviados para integração.
• Dados Recebidos: Relação dos dados recebidos.
• Data de Criação: Data de criação do registro.
• Data da última Alteração: Data da última alteração do registro.

Foram criadas as seguintes funcionalidades no Monitor, são elas:

1. Exportação de Lançamentos Financeiros da Folha
2. Exclusão de Lançamentos Financeiros da Folha
3. Exportação de Lotes contábeis
4. Cancelamento da Integração dos Lotes contábeis