Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • RM
    • versão 12.1.31.104 ou superior.
    • Estar aderente à portabilidade das versões do RM (verificar item 08. LINKS ÚTEISdesse documento);
    • Utilizar ambiente 3 camadas;
    • Caso não tenha acessado o parametrizador dos Serviços Globais após a atualização do ambiente, é necessário executá-lo até o final, ainda que não faça nenhuma alteração. Isso é necessário para criação de parâmetros internos.
    • Caso não tenha acessado o parametrizador do Totvs Folha de Pagamento após a atualização do do ambiente, é necessário executá-lo até o final, ainda que não faça nenhuma alteração. Isso é necessário para criação de parâmetros internos.
  • Ativação do Totvs App , pode ser visto a seguir.
Informações

Os valores usados para o preenchimento dos campos são específicos para cada cliente e serão disponibilizados para que sejam realizadas as validações. Os dados usados na validação dos campos das imagens são apenas exemplos, para demonstração do funcionamento do assistente.

  • (Ativação):

Para que seja possível utilizar o TOTVS Consignado é importante estar de posse das credenciais enviadas por email pela TOTVS, para integração entre as plataformas. A ativação poderá ocorrer:

Ativação por ConnectorID (Versões enquadradas na pré-condição do produto e inferiores as versões habilitadas para uso do RAC (12.1.31.104 ou superiores).)

Parâmetros necessários : connectorid e token

Ativação por RACID ( Preferencial  - Pré-condição, versões: 12.1.31.104 ou superior.)

Parâmetros necessários : clientid e clientsecret (credenciais enviadas por email)


Informações

Os valores usados para o preenchimento dos campos são específicos para cada cliente e serão disponibilizados para que sejam realizadas as validações. Os dados usados na validação dos campos das imagens são apenas exemplos, para demonstração do funcionamento do assistente.

1,2,3
Totvs custom tabs box
tabsScript Inicial, Permissão de Acesso, Ativação das Credenciais, Processo de Desativação da Integração
ids1,2,3,4
Totvs custom tabs box items
defaultyes
referencia1
  • É necessário realizar a execução do script personalizado enviado pela equipe técnica, para que seja habilitado as configurações para o TOTVS Consignado:
    • Script de liberação do ambiente. 
    • Script de liberação do parametrizador da Folha de Pagamento (Parametrizador > Integrações > TOTVS Consignado), habilitando assim as Instituições de Crédito parceiras da empresa detentora do ERP. 
Totvs custom tabs box
tabsPermissão de Acesso, Ativação das Credenciais, Processo de Desativação da Integração
ids
Totvs custom tabs box items
defaultyesno
referencia12

Para acessar o Totvs App, é necessário fornecer permissão para o perfil do usuário. No RM, acesse a opção Serviços Globais > Segurança > Perfis > Sistema: Integração.


Figura 16 - Tela de permissão para acesso ao Totvs App.


Totvs custom tabs box items
defaultno
referencia23

Após a permissão fornecida, o acesso ao Totvs App é feito através do sistema Integração > Totvs App > Ativação Totvs App.

O assistente de ativação possui apenas uma tela, onde deve ser informado os dados de conexão conforme necessário, considerando:

  • Marque o checkbox "Consignado", que ativar o processo de integração.
  • Conforme a Ativação disponibilizada preencha os campos chave (ou a primeira ativação ou a segunda conforme credenciais recebidas):
    • Ativação por ConnectorID - URL da Carol,
Id do Connector da Carol, Token da Carol e o checkbox "Consignado", que ativa o processo de integração.
    • Connector da Carol e Token da Carol)
    • Ativação por RACID ( RAC Client Id e RAC Client Secret (credenciais enviadas por email)

Figura 17 - Tela do Processo de Ativação do Totvs App.


Caso algum campo não seja preenchido, o processo finalizará com falha, como mostra o exemplo a seguir:

Figura 18: Tela de configuração do Totvs App sem o campo Token Carol preenchido.



Figura 19 - Tela com log de erro.


Após a execução do processo de ativação, será criado um job, que executará em background, enviando os dados para a Carol.

Totvs custom tabs box items
defaultno
referencia34

Após ativado, a qualquer momento será possível desativar, conforme imagem a baixo:

Figura 20 - Tela para habilitar Ativação.

Obs.: Uma vez que a processo de desativar seja executado, todos os dados de configuração serão perdidos. Para ativá-lo, será necessário realizar o processo de configuração novamente, conforme mostrado anteriormente.


...

Totvs custom tabs box
tabsHabilitar Integração Parceiro, Conceitos
ids45,56
Totvs custom tabs box items
defaultyes
referencia45
  • É necessário realizar a execução do script personalizado enviado pela equipe técnica, para que seja habilitado nas Configurações do RM Labore (Parametrizador > Integrações > TOTVS Consignado), com os campos relacionados ao processo de integração do Totvs Consignado com o ERP, habilitando assim as Instituições de Crédito parceiras.
Totvs custom tabs box items
defaultno
referencia56


Para que seja possível utilizar a integração do ERP com o Totvs App  é importante ter atenção para a carga dos Conceitos que serão responsáveis pelo envio de dados para Carol e TotvsApps . Esses "Conceitos" serão processados via Jobserver conforme configurado em sua estrutura de criação e serão consumidos seguindo o processo de ativação da integração, podendo ser:

Ativação por ConnectorID

Parâmetros necessários : connectorid e token

Versões enquadradas na pré-condição do produto e inferiores as versões habilitadas para uso do RAC (12.1.31.104 ou superiores).

Caso esta seja a ativação da integração, através do processamento do arquivo totvsAppConfig (executado obrigatoriamente ao ativar a integração com o TOTVS Apps que deverá estar no diretório /RM.NET caminho sugerido ="C:\totvs\CorporeRM\RM.Net\Conceitos" />    ) , será acionado processo de baixar os "Conceitos" atualizados da versão disponibilizada na nuvem , inserindo-os na tabela GTOTVSAPPCONCEITO e podendo ser acompanhado processamento através do recurso para Gerenciamento de Job (GTOTVSAPPCONCEITOHST) .


Ativação por RACID ( Preferencial )

Parâmetros necessários : clientid e clientsecret

Pré-condição, versões: 12.1.31.104 ou superior.

Caso esta seja a ativação da integração, após a leitura das credenciais do RAC será acionado processo de baixar o arquivo totvsAppConfig (executado obrigatoriamente ao ativar a integração com o TOTVS Apps ) e os "Conceitos" atualizados da versão disponibilizada na nuvem, inserindo-os na tabela GTOTVSAPPCONCEITO e podendo ser acompanhado processamento através do recurso para Gerenciamento de Job (GTOTVSAPPCONCEITOHST) .



...

Totvs custom tabs box
tabsEventos integração Folha de Pagamento, Parametrização RM-Ativação e Integração na Folha de Pagamento, Distribuição margem consignável por funcionário
ids6,7,8.9
Totvs custom tabs box items
defaultyes
referencia67


No RM Labore (Administração de Pessoal > Eventos > Eventos), deverá ser cadastrado eventos com código de cálculo 438, 439, 442, 443 e opcionalmente 444 . (verificar item 08. LINKS ÚTEIS, desse documento) para cada parceiro de crédito existente, ou seja, cada parceiro Habilitado terá um agrupamento de eventos a serem cadastrados com numeração do código desejada e diferenciada.



Figura 2 - Exemplo de cadastro de evento com código de cálculo 438.


(ideia)Atenção:

  • Fórmula de Cálculo - Evento Desconto (c.c: 438)

 Para que seja garantida a legalidade do débito limitado a 30% do líquido para desconto do empréstimo,  deverá ser criada uma Fórmula de Cálculo para receber a regra de cálculo desejada para apuração do desconto. Abaixo segue um exemplo como sugestão de uso.

Lembre-se o evento carregará integralmente o valor da parcela imputada para desconto pelo parceiro de crédito no TOTVS Consignado e este valor conforme contrato poderá ter um numerário acima da Margem Consignável aceita para desconto em folha de pagamento laboral.

Exemplo de fórmula:  30% da folha do funcionário. (Sugestão)

Se C('XXXX') > 0
entao
Se C('XXXX')>= (L*0.3)
entao L*0.3
Senao C('XXXX')
FimSe;

* Onde 'XXXX' deve ser o código do evento de base de cálculo com código de cálculo 439 - BASE DE CÁLCULO EMPRÉSTIMO CONSIGNADO PLATAF.TOTVS



Figura 3 - Exemplo de cadastro de evento com código de cálculo 439.


(ideia)Atenção:

Para os eventos com código de cálculo 442 - DESCONTO DE EMPRÉSTIMO CONSIGNADO RESCISÃO e 444 - MARGEM CONSIGNÁVEL, o cálculo também poderá ser customizável por fórmula conforme o entendimento do usuário. 


Totvs custom tabs box items
defaultno
referencia78


No parametrizador do TOTVS RM - Folha de Pagamento (Configurações > Parametrizador > , deverá ser informado os dados necessários para a configuração inicial para realização do processo de integração do ERP com o TOTVS Consignado, conforme detalhamento dos campos a seguir:

Figura 4 - Acesso ao Parametrizador.


Figura53 - Etapas de Configuração da Conexão e definição dos Eventos pertinentes a integração.



  • TOTVS Consignado 1/2
    • Configurações de Conexão:  Dados de acesso ao RAC. Todos os dados são autoexplicativos e devem ser inseridos pela equipe técnica responsável pela manutenção de acessos na base do ERP.
    • Utiliza rateio da Margem Consignável:  Esse parâmetro poderá ser utilizado se existir contrato de parceria de Empréstimo Consignado com mais de uma operadora de crédito, e o usuário desejar ratear a margem consignável entre as operadoras de crédito. Ao marcar este campo será habilitado o campo "Fator de Rateio" que  nesse caso terá seu preenchimento obrigatório. 
      • Fator de rateio:  deverá informar nesse campo o fator de divisão entre as operadoras de crédito.
      • Exemplo: A empresa possui parceria entre a operadora de crédito A e B. O funcionário possui margem consignável de R$1.000,00. Marcando o parâmetro e informando o fator de rateio igual a 2, será enviado para cada operadora de crédito a margem consignável de R$500,00.


Figura 6 - Exemplo da tela de configuração da conexão.



  • TOTVS Consignado 2/2
    • Evento de margem consignável: Informe aqui através da digitação do código ou da pesquisa de eventos pelo botão de pesquisa  o evento cadastrado do tipo Valor, Base de Cálculo com o código de cálculo 444 que poderá ter uma fórmula definida para apuração do Valor da Margem Consignável a ser enviada ao TOTVS Consignado. Os eventos de desconto e base de cálculo do Empréstimo Consignado deverão ser definidos por operadora de crédito na Etapa 3 desse processo ( TOTVS Consignado - Eventos Integração)

Figura 7 - Exemplo da tela de configuração do evento de Margem Consignável.


  •  TOTVS Consignado - Eventos Integração
    Deverão ser informados os eventos cadastrados com os devidos códigos de cálculo do consignado para serem vinculados aos parceiros de crédito,  conforme detalhamento dos campos a seguir:
    • Evento de desconto de Crédito Consignado:  evento do tipo "Desconto / Valor" tendo obrigatoriamente o código de cálculo 438 informado. Esse evento pode ser calculado por fórmula conforme entendimento do usuário, tirando como base o evento com código de cálculo 439.
    • Evento de base de cálculo do valor a ser descontado:  evento do tipo "Base de cálculo / Valor" tendo obrigatoriamente o código de cálculo 439 informado. Esse evento terá o valor original do empréstimo consignado a ser lançado na folha de pagamento. 
    • Evento de desconto de Crédito Consignado - Rescisão:  evento do tipo "Desconto / Valor" tendo obrigatoriamente o código de cálculo 442 informado. Esse evento pode ser calculado por fórmula conforme entendimento do usuário, tirando como base o evento com código de cálculo 443.
    • Evento de base de cálculo do valor a ser descontado - Rescisão:  evento do tipo "Base de cálculo / Valor" tendo obrigatoriamente o código de cálculo 443 informado. Esse evento terá o valor original a ser lançado na rescisão do funcionário.
    • Evento de margem consignável:  evento do tipo "Base de cálculo / Valor" tendo obrigatoriamente o código de cálculo 444 informado. O evento com esse código de cálculo não é obrigatório. Deve ser calculado por fórmula, conforme entendimento do usuário. Caso não seja informado na parametrização, o cálculo nativo do sistema será o valor líquido do mês anterior * 30%.

Figura 8 – Parametrização da integração com o TOTVS Consignado.


IMPORTANTE:  Para cada operadora de crédito, informe os eventos de desconto e base de cálculo que devem ser específicos para cada parceiro, ou seja, não poderá ser utilizado o mesmo evento em operadoras diferentes. Cada uma deverá ter o seu evento distinto respeitando as regras citadas acima de cadastro. Exemplo:


Figura 9 – Configuração dos Eventos Desconto e Base por Operadora


  • Etapa 54 - Eventos de Integração
    • Deverá ser marcado a flag referente ao TOTVS Consignado para que seja possível a integração dos descontos em folha de pagamento via Grupo de Eventos, conforme imagem abaixo:


Figura 10 - Etapa do Parametrizador pertinente


Totvs custom tabs box items
defaultno
referencia89


  • Caso seja definido a utilização de Rateio de Margem consignável entre os parceiros de crédito, faz-se necessário a distribuição do percentual referente a margem através do cadastro do funcionário configurado de forma individual. Para isso acesse o cadastro de funcionários(Administração de Pessoal > Funcionários) através da opção Anexos > Folha de Pagamento > Distribuição da margem consignável ,  conforme detalhamento dos passos a seguir:


Figura 11 – Parametrização da Distribuição do rateio da margem consignável.


IMPORTANTE: Para acessar a Distribuição da margem consignável , é necessário fornecer permissão para o perfil do usuário. No RM, acesse a opção Serviços Globais > Segurança > Perfis > Sistema > RH : Folha de Pagamento.

Figura 12 – Liberação de Acesso no Perfil de Usuários.


  • Ao incluir um novo registro, será apresentada a tela de edição para informar o percentual de rateio das margens. Selecione a operadora pelo botão [... através das opções disponibilizadas. 
  • No campo Percentual informe o valor a ser estabelecido para apuração daquela operadora selecionada. A soma de todos os rateios distribuídos deverá alcançar o total de 100%.
    • Exemplo 1: Funcionário não deseja ratear sua margem consignável e deseja que seja considerado o total em 100% para determinada Operadora de Crédito.


 Figura 13 – Cadastro do rateio de distribuição da margem consignável.


  • Exemplo 2: Líquido do Funcionário X no mês MM/AAAA    -     Liquido R$1.000,00           Margem consignável calculada: 300,00             

  Fator de Rateio: 2, só que o funcionário deseja dividir sua margem em:

                            Operadora 1 = 50%         Operadora 2 = 25%       Operadora 3 = 25%

Nesse exemplo os valores de margem consignável para cada operadora será:

     Operadora 1 = R$150,00         Operadora 2 = R$75,00       Operadora 3 = R$75,00

Figura 14 – Visão da Distribuição do rateio da margem consignável para funcionário selecionado. 


IMPORTANTE:  Todo rateio deve respeitar a distribuição de 100% de seu percentual, desta forma, na tela de edição irá apresentar uma informação orientativa em destaque, até que toda distribuição seja realizada.

 Figura 15 – Cadastro do rateio de distribuição da margem consignável. Tela de alerta


...

Totvs custom tabs box
tabsProcesso de Integração, Logs de Exceção, Consulta Movimento de Integração
ids9,10,11,12

No Totvs RM Folha de Pagamento, o acesso ao Wizard  é feito pelo menu Folha Mensal, chamando o ícone "Integração TOTVS Consignado", conforme imagem abaixo.


Figura 21 - Tela de acesso ao Wizard.


Totvs custom tabs box items
defaultyes
referencia910

O processo de integração dos dados do TOTVS Consignado com o ERP é simples e não precisa de interação do usuário além das configurações realizadas nas etapas anteriores citadas neste documento. Apenas é solicitado a confirmação de realização do processo por tabelas internas serão preenchidas neste momento, considerando os dados apurados no TOTVS Consignado para a competência em questão.


Figura 22 - Tela de confirmação do processo de integração.


Figura 23 - Tela de acompanhamento do Progresso de execução do processo.


Figura 24 - Tela esperada após conclusão do processo de integração.


IMPORTANTE: Caso não for concluído com sucesso a validação da integração, verifique a exceção apresentada conforme Log de Exceções apresentados neste documento.


Totvs custom tabs box items
defaultno
referencia1011

Após a finalização do processo de integração, você poderá acompanhar os movimentos que formam importados para a base do ERP (tabela PFMOVTEMP) , bem como possíveis causas de insucesso na conclusão do processo, conforme detalhamento a seguir:


  • Exceções consideradas e tratadas com as seguintes mensagens:

              - Na obtenção dos dados plataforma Consignado:

                            - Algum dos dados da integração com o TOTVS Consignado não está preenchido.


              - Na obtenção de seções centralizadoras:

                            - Nenhuma seção centralizadora encontrada.


              - Na obtenção do token do rac:

                            - O token de acesso não pode ser obtido.

                                           - Código 404 (not found) na obtenção do token de acesso, possivelmente existe uma parametrização errada na sua URL da plataforma do RAC.

                                           - Código 400 (bad request) na obtenção do token de acesso, possivelmente existe uma parametrização errada nos dados de cliend_id e client_secret.

                                           - Código 500 (internal server error) ocorreu um erro inesperado do lado do servidor do RAC.


              - Na obtenção das parcelas do consignado:

                            - Nenhum evento de folha cadastrado.

                            - Nenhuma parcela a ser consumida do TOTVS Consignado na competência {0}/{1}.      

                           

  • Eventos descritos no Log resultante do processo de integração:

              - Integração TOTVS Consignado

                            - Foram encontradas {0} parcelas para serem importadas na competência {1}/{2}.

                            - Uma parcela de valor {0} na competência {1}/{2}, para a matrícula de funcionário {3}, não foi inserida.


Figura 25 - Exemplo da Tela de Logs


Totvs custom tabs box items
defaultno
referencia1112

Para acompanhar os movimentos integrados pela plataforma TOTVS Consignado (tabela PFMOVTEMP) , utilize a ferramenta abaixo que permitirá um acompanhamento do que irá ser gravado na tabela financeira dos funcionários para a competência em questão.

    Figura 26 - Tela de acesso a consulta


  • Para facilitar a busca, você poderá criar um filtro aplicando apenas a regra da Origem do Evento = TOTVS Consignado ou Tipo Lançamento = Parcela do empréstimo consignado conforme abaixo :


             Figura 27 - Exemplo da Consulta de Movimento Integração (tabela PFMOVTEMP), carregada pela integração a ser consumida no Grupo de Eventos


...

Totvs custom tabs box
tabsGrupo de Eventos, Lançamento do Funcionário
ids1113,1214
Totvs custom tabs box items
defaultyes
referencia1113

Para a importação para a folha de pagamento, o grupo de eventos de lançamento de movimento deve ser marcado os campos em destaque abaixo para que a integração TOTVS Consignado (arquivo PFMOVTEMP) sejam carregados no movimento do Funcionário para a competência em questão.



Figura 28 – Tela de Grupo de Eventos - Lançar eventos de integração com outros aplicativos.



Figura 29 – Tela de Grupo de Eventos - TOTVS Consignado

Totvs custom tabs box items
defaultno
referencia1214

Para verificar o lançamento da verba de empréstimo na folha do funcionário, basta acessar o Envelope de Pagamento: Anexos > Movimento > Envelope de Pagamento.

Figura 30 – Verba de Empréstimo importada pela integração para a folha do funcionário.



IMPORTANTE: Pode-se acompanhar o andamento das concessões através do  Portal - Empréstimos


...

Totvs custom tabs box
tabsProcesso Manual,Processo em Lote
ids1315,1416
Totvs custom tabs box items
defaultyes
referencia1315

Realizado através do cadastro de rescisão individual do funcionário. Após realizar o preenchimento dos dados referente ao aviso, na aba Rescisão será apresentado o campo: "Enviar dados para o TOTVS Consignado". 

Figura 31 – Menu de cadastro de rescisão.


Como padrão, o campo já vem preenchido como Não (enum=1) identificando que a instituição somente será avisada da rescisão ao liberar a competência e caso o RH desejar que a rescisão em questão seja informada antecipadamente, deverá alterar o campo para Sim (enum=2).

ATENÇÃO: Para rescisões do tipo 5 e 6, o campo não será exibido.


Figura 32 – Campo para envio dos dados dentro do cadastro de rescisão.


IMPORTANTE: As rescisões que não forem enviadas antecipadamente, serão enviadas como confirmadas (enum=4) quando for realizada a liberação de competência.


Totvs custom tabs box items
defaultno
referencia1416

Para facilitar o envio de informações para a instituição de crédito de forma global, permitindo assim que o RH da empresa por contrato possa se organizar no envio destes dados e realizá-lo em grupo de dados, será possível a utilização do processo de "Autorização envio de dados da rescisão para o TOTVS Consignado". Neste caso, poderá aplicar filtros, definindo assim o grupo de pessoas que se deseja enviar de forma antecipada para a credora. 

Os campos de data vão contemplar as rescisões que estão cadastradas dentro do período informado. A data deve estar dentro do intervalo do primeiro dia da competência atual até o último dia da próxima competência.

Ao confirmar o processo de autorização será enviado de forma antecipada os dados para a instituição de crédito como previsibilidade (poderá ser reversível pela revogação antes da virada de competência). O processo de revogação cancelará esse envio antecipado, contudo, os dados serão enviados como confirmados após a liberação de competência.



Figura 33 – Processo de autorização e revogação de envio de dados da rescisão.


Figura 34 – Tela do processo de autorização e revogação de envio de dados da rescisão.


...