NTEGRAÇÃO HCM X TSA

Contexto de negócio (Introdução)

O objetivo é integrar os módulos de Folha de Pagamento e Controle de Frequência do produto TOTVS Linha Datasul HCM ao TOTVS Segurança e Acesso (TSA), para permitir controlar o acesso dos funcionários por meio do horário de trabalho, horas extras, troca de turno e situações de afastamento. Também receber as marcações feitas em dispositivos de ponto adaptados à Portaria 1510 e dispositivos de refeição.

A importância dessa integração é que, conforme determinação da Portaria 1510, os dispositivos de ponto não podem mais impedir a entrada do funcionário por qualquer razão, então o controle será realizado pelo acesso.

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

• TOTVS Datasul HCM - Módulos Folha de Pagamento e Controle de Frequência
• TSA (TOTVS Controle de Acesso)

Integração

A integração viabiliza a comunicação de dados entre o HCM e o Controle de Acesso TOTVS (TSA) por intermédio de Webservice. Ela é necessária quando são utilizados os módulos de Folha de Pagamento e Controle de Frequência do HCM e for adquirido o Controle de Acesso da TOTVS (TSA). Este novo modelo foi proposto para substituir a que utiliza as camadas EAI e ESB. Segue abaixo as melhorias a que se propõe:

• Simplificação do processo de implantação
  • Não utiliza mais as camadas EAI e ESB.
  • Utilização agendamento RPW (ferramenta padrão do Datasul).
• Melhoria no Monitoramento
  • Ferramentas que auxiliam na identificação e resolução de problemas ocorridos na integração.
• Melhoria na performance
  • Não necessita de controle de dependência
  • Integra somente informações que impactam no TSA

Arquitetura (Tecnologia):

Premissas:

• Para realizar o processo de integração entre os produtos é necessário primeiramente realizar o processo de carga de informações para popular a base de dados do TSA com informações iniciais.
• Processo de integração ocorre:
  • Carga: Síncrono (Online)/Assíncrono (Batch)
  • Movimentação: Assíncrono (Batch)
  • Integração Marcações do TSA para Datasul HCM: Assíncrono (Batch)
• Deve ser configurado um servidor RPW para a realização de processos Assíncronos.  Para clientes que realizam a integração com TSA via EAI/ESB não será necessário realizar o processo de carga.

Limitações:

• A integração de turno é a única que não é automática, a cada alteração de turno/jornada e intervalos é necessário realizar a integração de turno através do botão Atualizar na pasta Turma do programa FP1400 - Manutenção de turnos ou através do programa FP1404 - Atualização do Turno Controle de Acesso.

Escopo

O escopo deste documento é o detalhamento da integração parte produto TOTVS Datasul HCM. Para maiores detalhes sobre o TSA consulte o Guia de Instalação da release mais recente no link http://fluig.totvs.com/portal/p/10097/socialdocs/tsa-community

Responsabilidade dos Produtos:

• TOTVS linha Datasul HCM: integrar as movimentações realizadas na folha de pagamento e

Escopo

O escopo deste documento é o detalhamento da integração parte produto TOTVS Datasul HCM. Para maiores detalhes sobre o TSA consulte o Guia de Instalação da release mais recente no link http://fluig.totvs.com/portal/p/10097/socialdocs/tsa-community

Responsabilidade dos Produtos:

• TOTVS linha Datasul HCM: integrar as movimentações realizadas na folha de pagamento e controle de frequência e importar marcações integradas pelo TSA para o sistema Controle de Frequência.
• TOTVS Seguraça e Acesso (TSA): controlar acesso através de informações integradas e integrar as marcações de ponto para o TOTVS linha Datasul HCM.

Fluxo da integração para o processo de Carga:

Fluxo da Integração para o processo de Movimentação:

Fluxo da Integração para o Processo do Integrador de Movimentos (agendamento RPW):

No fluxo, o  "Realizar Movimentação" ocorre no dia-a-dia através dos processos normais de  folha de pagamento e controle de frequência. A seguir quadro  com a relação de programas executados na linha Datasul HCM que geram movimentos para integração com TSA: 

Pré-requisitos instalação/implantação/utilização

1. Instalação e configuração do TSA: necessário que o TSA esteja instalado e o serviço iniciado para que possa configurar e iniciar a integração.
2. Configuração de servidor RPW para Integração das Marcações: configurar um servidor RPW para Integração das Marcações provenientes do TSA para o HCM. Para realização desta configuração acessar a documentação do programa btb012aa no menu do produto TOTVS.
3. Configuração de servidor RPW para Integração dos Movimentos do HCM para o TSA: configurar um servidor RPW para Integração de Movimentos gerados para o TSA. Para realização desta configuração acessar a documentação do programa btb012aa no menu do produto TOTVS.

Atenção:

• A integração está disponível na versão 12.1.10 no produto TOTVS linha Datasul HCM.
• O TSA deverá estar pelo menos na versão 12.1.9.
• Caso servidor seja Linux, este não poderá ser configurado com Quantidade de Execuções acima de 1 no programa btb012aa – Manutenção de Servidor de Execução.
• Atentar para não configurar a empresa no servidor RPW, pois isso acarretará em somente integrar informações daquela empresa. 

Instalação/Atualização

Primeiramente realizar a Configuração da Integração, através do acesso ao programa FP8870 - Monitor TSA, botão configuração. Para maiores detalhes acessar o manual de referência deste programa.

Após o processo de configuração pressione botão "Verificar Conexão TSA e RPW" e verificar o status na tela do Monitor. O Status do TSA e do RPW devem estar como ativos para iniciar a integração com TSA . Quadro a seguir demonstra os possíveis Status e suas soluções:

Após a verificação da ativação da integração é necessário realizar o processo de carga para a atualização inicial das informações na base de dados do TSA.

Acessar  o programa FP8875 - Carga TSA através do botão Carga do programa FP8870 - Monitor TSA ou pelo menu do produto. Para maiores detalhes sobre o funcionamento do programa acessar ao Manual de Referência do programa. 

Atenção:

Para clientes que já utilizam a integração com TSA via EAI/ESB não é necessário realizar o processo de carga, somente selecionar a opção "Realizando Movimentação" no programa de configuração. Após verificar que as informações estão sendo geradas na fila do Monitor,  deverá ser parado o Serviço do ESB. 

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

Suporte

O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e, quando necessário, repassar para a equipe mais adequada em cada caso.

Observação: Este modelo de suporte está sendo revisado pela TOTVS.

Fluxo das Informações

Para cada fluxo de informação descreva, se necessário, alterações de comportamento que o respectivo produto irá sofrer. Por exemplo: quando o Logix recebe o PEDIDO de OUTRO ERP, este pedido não poderá ser alterado no Logix.

Liste quais as entidades integradas e como é o mapeamento entre as diferentes estruturas. Por exemplo: Classe no sistema A vira categoria no sistema B, o campo X é refletido no campo Y etc.

Liste quais transações/operações a integração fará com as entidades relacionadas. Exemplo: Insert de PEDIDO, Insert, update de ITEM, buscar saldo em estoque do ITEM no dia X ou buscar dados do FUNCIONÁRIO.

Cadastros

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita.

Processos

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

<Transação/Processo>

Tipo de Fluxo: Protheus -> RM

Mensagem: Request_1_000

Versão: 1.000

Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.

Acrescentar um diagrama do processo.

A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita. 

Limitações / Restrições Gerais

Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:

• ERP1 envia ITEM cadastrado para o ERP2

ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.

Se o tipo de valorização do estoque for FIFO.

• ERP2 envia PEDIDO cadastrado para o ERP1

O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.

Situações comuns (opcional)

Descreva situações problemáticas comuns que podem ocorrer durante o funcionamento da integração e como solucioná-los. Neste ponto também é importante dar instruções de como reconhecer e investigar problemas que podem vir a ocorrer durante a integração. Se houver, apresente tabelas de códigos e descrições de erros que a integração poderá apresentar.

Este tópico possivelmente será alimentado com as experiências durante o desenvolvimento da integração e poderá ser realimentado durante o uso da integração no cliente.

Exemplo 1:

Tratamento de erros de integração (Produto A)

Tratamento de erros de integração (Produto B)

Exemplo 2:

Quando uma mensagem é enviada do Logix para o Protheus, podem ocorrer situações em que o WebService não estará totalmente funcional. Nestes casos uma mensagem de erro genérica irá aparecer na tela:

Exemplo:

Erro ao enviar a mensagem de Cidade via Integração

Se o arquivo de log for analisado, poderemos ver a falha na comunicação com o sistema destino:

-------------------------------------------------------------------------------

WSCERR044 / Não foi possível POST : URL http://172.16.31.57:8011/ws/FWWSEAI.apw

ADVPL WSDL Client 1.080707 / tst on 20120315 08:49:51

-------------------------------------------------------------------------------

Para resolver este problema, verifique as configurações do sistema de destino, analisando o funcionamento do servidor utilizado para esta comunicação e a habilitação do endereço do WebService. 

Checklist de suporte da aplicação

Crie um check-list de verificação de alguns pontos importantes para o funcionamento e atendimento da integração.

Instalação/Configuração

Relacione itens de verificação para garantir que a integração está corretamente instalada e configurada. Isto não pode ser uma cópia do procedimento de instalação/configuração, mas verificações pontuais que podem remeter aos itens da instalação.

Checklist de Verificações:

Relacione itens de verificações para que o atendente possa:

• Identificar o funcionamento da integração;
• Identificar a ocorrências de problemas;
• Coletar evidências do mau funcionamento relatado pelo cliente;
• Realizar possíveis ajustes na integração quanto à configuração ou negócio.

• A URL raiz não é a URL de acesso ao TSA, procure pela JBoss Web Services Console, utilizando a URL do servidor + Porta, conforme abaixo:

• A execução da carga deve ser realizada seguindo a ordem de informação relacionada no browse do programa de carga.
• O processo de carga de informações deverá ser realizado uma a uma; cada carga de informação deve ser iniciada e finalizada antes de iniciar a próxima.
• E antes de iniciar a próxima carga é necessária a conferência da quantidade de informação integrada com o TSA.
• Este processo de conferência é realizado comparando a quantidade de registros integrados do relatório de carga da informação com a quantidade de registros atualizados da informação no TSA, acessando o Monitor de Integração Informações
• E a mais adiante um exemplo do relatório de carga com a quantidade de registros enviados para o TSA. A quantidade deverá ser a mesma. Caso contrário o arquivo log do TSA deverá ser consultado para verificar os erros ocorridos. As demais informações estão na linha “Validações Dados” do TSA é deve-se proceder da mesma forma para conferir as quantidades.
• No caso de Feriados X Dias Não Trabalhados, é necessária uma conferência mais detalhada de informações. Abaixo é demonstrada a tela do Monitor de Consulta com as informações de Dias não trabalhados integrados por dia e com a somatória de localidades e turnos relacionados ao dia.
• A integração de turno é a única que não é automática, a cada alteração de turno/jornada e intervalos é necessário realizar a integração de turno através do botão Atualizar na pasta Turma do programa FP1400 - Manutenção de turnos ou através do programa FP1404 - Atualização do Turno Controle de Acesso.

Processos

Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.

Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos

Em seguida faça uma descrição para cada um dos fluxos para cada entidade

<Transação/Processo>

Tipo de Fluxo: Protheus -> RM

Mensagem: Request_1_000

Versão: 1.000

Descrição de todo o comportamento e funcionamento do processo. Breve contexto, origem, regras, integração (geração da mensagem, envio, recebimento no destino), o quê supostamente irá ocorrer no destino, retorno, impacto, consequências, o que foi afetado, como conferir, validar, etc o retorno.

Acrescentar um diagrama do processo.

A seguir descrever as variações, particularidades da mensagem e processos (desta integração) de acordo com cada marca

Notas:

Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela

Limitações/Restrições

Descreva limitações e restrições para a integração que está sendo descrita. 

Limitações / Restrições Gerais

Descreva limitações e restrições para cada fluxo descrito no tópico anterior. Exemplo:

• ERP1 envia ITEM cadastrado para o ERP2

ERP1 somente enviará o ITEM se este estiver em uma das famílias cadastradas no parâmetro FAMILIA_INTEGRACAO.

Se o tipo de valorização do estoque for FIFO.

• ERP2 envia PEDIDO cadastrado para o ERP1

O pedido recebido no ERP1 vindo do ERP2 estará bloqueado para alteração.

Situações comuns (opcional)

• A URL raiz não é a URL de acesso ao TSA, procure pela JBoss Web Services Console, utilizando a URL do servidor + Porta, conforme abaixo:

• A execução da carga deve ser realizada seguindo a ordem de informação relacionada no browse do programa de carga.
• O processo de carga de informações deverá ser realizado uma a uma; cada carga de informação deve ser iniciada e finalizada antes de iniciar a próxima.
• E antes de iniciar a próxima carga é necessária a conferência da quantidade de informação integrada com o TSA.
• Este processo de conferência é realizado comparando a quantidade de registros integrados do relatório de carga da informação com a quantidade de registros atualizados da informação no TSA, acessando o Monitor de Integração Informações
• E a mais adiante um exemplo do relatório de carga com a quantidade de registros enviados para o TSA. A quantidade deverá ser a mesma. Caso contrário o arquivo log do TSA deverá ser consultado para verificar os erros ocorridos. As demais informações estão na linha “Validações Dados” do TSA é deve-se proceder da mesma forma para conferir as quantidades.
• No caso de Feriados X Dias Não Trabalhados, é necessária uma conferência mais detalhada de informações. Abaixo é demonstrada a tela do Monitor de Consulta com as informações de Dias não trabalhados integrados por dia e com a somatória de localidades e turnos relacionados ao dia.