TEGRAÇÃ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.  

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.

4. Validação de informações para a Carga: o processo de validação de informações tem como objetivo verificar inconsistências na base de dados do cliente. É necessário que estas inconsistências sejam resolvidas para que o processo de carga possa ser realizado. Para executar o processo de validação, deve-se acessar o programa FP8875 - Carga TSA e pressionar o botão “Dispara Validação Informações”. Ao final do processo, este programa emitirá um relatório contendo as inconsistências encontradas. Para maiores detalhes das acões a serem todas acessar o manual de referência do programa FP8875.

5. Atualização do campo Crachá  TSA (FP1500/FP1510): para que ocorra a integração do crachá do funcionário com o TSA, é necessário que o campo Crachá TSA localizado nos programas Manutenção de Funcionário (FP1500) e Manutenção Funcionário Contrato Especial (FP1510), pasta Lotação, seja atualizado. Este procedimento deverá ser realizado antes do processo de carga/movimentação. Para a realização deste processo, é necessário acessar o programa FP8875 - Carga TSA. Para maiores detalhes sobre procedimento acessar o manual de referencia do programa FP8875.O processo de atualização carga e integração de crachá somente é possível para funcionários. Para prestadores pessoa física, o crachá deverá ser informado no TSA.

6. Atualização Data de Fim de Validade do Prestador de Serviço: com o objetivo de enviar somente os prestadores ativos na carga de prestador de serviço no processo de implantação, é necessário que seja informada o campo Data Fim Validade na Manutenção Prestador e Serviço (FP0840), pasta Cadastrais. O processo de carga considera “Inativo” o prestador que estiver com a data de fim de validade igual ou menor que a data do dia. Exemplo: caso a carga de informação esteja sendo realizada do dia 25/03/2013 e a data fim de validade de esteja cadastrada com o 25/03/2013 ou menor, o sistema não realizada a carga deste prestador para o TSA. 
7. Atualização de Turnos para Inativos: no TSA, os turnos são utilizados para controlar o acesso de funcionários considerando os períodos de suas jornadas, assim como, é possível restringir acesso a turnos específicos em feriados determinados. Na maioria das empresas, muitos turnos são criados e deixados de utilizar com o passar do tempo ocasionando a carga de informação desnecessária e baixa desempenho no processo de carga de feriados. Para que seja realizada a carga de somente turnos “Ativos” para o TSA, é necessário inativar o Turno pelo programa de Manutenção de Turno Trabalho (FP1400), pasta Gerais, campo Inativo. O processo de carga considera um turno “Inativo” quando este estiver com o campo Inativo marcado, a data da inativação for igual ou inferior ao dia atual e não possuir funcionário relacionado a esse turno. O excesso de intervalos que não são utilizados relacionados as jornadas x turnos que também acarretam em problemas de performance que podem dificultar a integração. Neste caso é necessário criar um novo turno com somente os intervalos mínimos necessário para as jornadas, realizar o processo de transferência dos funcionários para esse novo turno e inativar o turno anterior.
8. Parametrização de Funcionários Exceção REP: essa funcionalidade permite que funcionários sem vínculo empregatício com a empresa e do tipo contrato especial não sejam enviados para os equipamentos REP. Pelo programa Manutenção Regras para Exceção REP (PE7120) é possível parametrizar os funcionários que serão considerados como Exceção REP no TSA. No momento que é realizada a carga de informação ou atualização de um funcionário, o sistema verifica se este se encaixa nas regras cadastradas e envia um código que indica que o funcionário é do tipo “Exceção REP”, caso contrário, envia um código que indica que o funcionário é do tipo “Funcionário”. Caso a parametrização seja feita posteriormente a implantação a cada alteração da parametrização são enviadas mensagens para atualização de todos os funcionários das empresas que integram com o TSA.
9. Ajuste da Imagem da Pessoa Física: é possível integrar imagem da pessoa física com o TSA pelo programa de carga e do cadastro de pessoa física (FP1440). No entanto, é necessário o ajuste do arquivo de imagem de pessoas físicas cujo tamanho do arquivo seja maior que 500KB. O programa FP8875 - Carga TSA permite tanto realizar a carga quanto emitir um relatório das imagens que serão integradas com TSA. Neste relatório é possível visualizar as pessoas físicas cujo arquivo de imagem está acima de 500 KB. O processo de carga de imagem não impede a carga de informações para o TSA, entretanto, as imagens que não foram ajustadas para o tamanho de 500KB não serão integradas.

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. 
• Atentar para o formato do campo Crachá TSA tanto na atualização do campo Crachá TSA via programa de carga quanto pela admissão do funcionário. Sempre informar o crachá com o formato que ele é utilizado no TSA, por exemplo, se o formato é 8 dígitos, deve ser informado 00000523.

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

Manutenção Regras de Exceção de REP (PE7120)

• Incluir registro: se a empresa da regra está parametrizada para integrar com Controle de Acesso (FP0500), serão enviadas mensagens contendo todos os funcionários que se encaixam nas regras informadas com o papel “Exceção REP”.

• Alterar registro: se a empresa da regra está parametrizada para integrar com Controle de Acesso (FP0500), serão enviadas mensagens contendo todos os funcionários que se encaixam nas regras informadas com o papel “Exceção REP”.

• Excluir registro: se a empresa da regra está parametrizada para integrar com Controle de Acesso (FP0500), serão enviadas mensagens contendo todos os funcionários que se encaixam nas regras eliminadas informadas com o papel “Funcionário”.
  
  

Manutenção Estabelecimentos (FP0560)

• Incluir registro: se a empresa do estabelecimento está integrada ao Controle de Acesso (FP0500), o TSA atualizará a unidade por meio da chave externa "empresa;estabelecimento". Também será enviada uma mensagem com a lista das situações de afastamento cujo significado seja “Afastado” e “Férias” atualizará todas as situações de afastamento para este estabelecimento.

• Alterar registro: se a empresa do estabelecimento está integrada ao Controle de Acesso, o TSA atualizará a unidade por meio da chave externa "empres;estabelecimento".

• Excluir registro: se a empresa está integrada ao Controle de Acesso, o TSA eliminará o registro da unidade por meio da chave "empresa + estabelecimento". Também será enviada uma mensagem com a lista das situações de afastamento que estão marcadas para serem integradas com o Controle de Acesso para o estabelecimento e o TSA eliminará todas as situações de afastamento deste estabelecimento.
  
  

Manutenção Centros de Custo (FP0660)

• Incluir registro: se a empresa do centro de custo está integrada ao Controle de Acesso, o TSA atualizará o centro de custo por meio da chave externa "código empresa;código de centro de custo".

• Alterar registro: se a empresa do centro de custo está integrada ao Controle de Acesso, o TSA atualizará o centro de custo por meio da chave externa "código empresa;centro de custo".

• Excluir registro: se a empresa do centro de custo está integrada ao Controle de Acesso, o TSA eliminará o registro do centro de custo por meio da chave "empresa;centro de custo".
  
  

Manutenção Plano de Lotação (FP0800)

• Relacionar uma lotação em um plano de lotação: o TSA atualizará a unidade de lotação por meio da chave externa "código de plano de lotação;código de unidade de lotação".

• Eliminar relacionamento de unidade de lotação com plano: o TSA eliminará o registro de unidade de lotação por meio da chave "código plano;unidade de lotação".

• Manutenção Unidade de Lotação (FP0780).

• Alterar descrição da unidade de lotação existente: o TSA atualizará todas as lotações que tiverem como chave externa "código do plano;lotação da lista".

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

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

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

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.