Integrador - HCM

O Integrador HCM pode ser utilizado em servidores exclusivos ou compartilhados (que possuem outros sistemas).

A infraestrutura mínima necessária é:

• 1 máquina virtual com 2 núcleos de processador 2,4 GHz;
• 4 GB de RAM 1600 MHz (caso seja compartilhado, é necessário que tenha no mínimo 4 GB livre);
• Rede 1 Gbps;
• 500 GB de HD 7000 RPM;
• Java 11 — instalação ou atualização do OpenJDK 11;
• Nas variáveis de sistema, torna-se obrigatório criar a variável JAVA_HOME_HCM;
• Por padrão, a variável de ambiente JAVA_HOME_HCM deve apontar para o JDK do Java 11.

• Possuir acesso igual ao de uma estação do Gestão de Pessoas | HCM, incluindo:
  • acesso liberado para os diretórios de instalação da Senior;
  • acesso liberado para acesso ao servidor de banco de dados.

Versões do Windows compatíveis com o Integrador - HCM

O Integrador - HCM pode ser instalado nas seguintes plataformas Windows compatíveis com a aplicação:

Plataforma	Arquitetura da CPU
Windows Server 2019	x64 (64-bit)
Windows Server 2016	x64 (64-bit)
Windows Server 2012 R2	x64 (64-bit)
Windows Server 2012	x64 (64-bit)
Windows 10	x64 (64-bit)
Windows 8.x	x64 (64-bit)
Windows 7	x64 (64-bit)

Navegador homologado com o Integrador - HCM

O navegador homologado para o funcionamento do hcm-monitor do Integrador - HCM é o Google Chrome (versão mínima 70.0.3538).

Banco de dados do sistema Gestão de Pessoas | HCM (versão 6 - on-premise)

O servidor de banco de dados do Gestão de Pessoas | HCM precisa ser uma das versões homologadas pela Senior.

A execução em versões diferentes daquelas que são homologadas pode causar instabilidades ou problemas de desempenho no Integrador - HCM.

É preciso garantir que a plataforma senior X esteja implantada e configurada. Caso não esteja, é necessário ao menos atender aos mesmos requisitos de infraestrutura da plataforma (os requisitos estão detalhados na documentação dos procedimentos de instalação).

Se houver integração entre sistemas G5/G6 (on-premise) e XPlatform (cloud) é preciso garantir também a instalação em ambiente híbrido.

URLs que precisam ser liberadas para todos os usuários e no servidor do Integrador - HCM

• platform.senior.com.br (porta padrão https 443 e https 8243)
• smtp.sendgrid.net:587 (servidor de e-mail da Senior; usado pelo Integrador do HCM para enviar notificações de telemetria à Senior sobre situações críticas relacionadas ao funcionamento do Integrador no ambiente dos clientes)
• senior-hcm-storage.s3.amazonaws.com (porta padrão https 443)
• br-com-senior-blob-service-shared-area.s3-sa-east-1.amazonaws.com (porta padrão https 443)
• https://hcm-api.senior.com.br/ (porta padrão https 443; tipo CNAME: aponta para hcm-prod-services-alb-649147785.sa-east-1.elb.amazonaws.com)

URL para atualização automática

A URL abaixo precisa estar liberada para que a atualização automática do Integrador - HCM funcione corretamente.

Segurança

Toda a comunicação do Integrador HCM é criptografada e protegida sob protocolo HTTPS e TLS 1.2.

A instalação do Integrador - HCM exige que o cliente possua:

• um tenant de acesso à plataforma senior X
• o arquivo (extensão .pem), que contém as chaves de certificado para rodar a aplicação

O procedimento a seguir explica como obter essas informações. Isto precisa ser feito pelo administrador do sistema no cliente e deve estar concluído antes de iniciar a instalação do Integrador - HCM.

Criar um tenant de acesso à plataforma senior X e obter o arquivo .pem

1. Acesse a SARA do Suporte, que é o ambiente onde será feita a solicitação de criação do tenant (clique aqui para acessar).
2. Selecione a opção TENANTS e siga as instruções apresentadas pela SARA. Se quiser saber mais sobre esta etapa, consulte a documentação de criação de tenants no manual da plataforma.
3. Quando a solicitação do tenant for concluída, o administrador receberá um e-mail com um identificador único, chamado de Id do tenant. Receberá também um e-mail com um arquivo anexo (extensão .pem).
   
   Verifique este e-mail e guarde as informações e o arquivo, que serão usados na instalação do Integrador - HCM.

É necessário instalar o web service de cada módulo adquirido para que ocorra a sincronização das informações da XPlatform para os módulos contratados e vice-versa.

Este é um requisito obrigatório para o funcionamento dos processos de atualização cadastral e de gestão de férias.

Além disso, também é necessário garantir que o servidor onde o Integrador está instalado tenha acesso as URLs dos web services instalados.

Obter o instalador do Integrador - HCM

O instalador pode ser obtido em um arquivo .ZIP, que está disponível no seguinte endereço:

O arquivo hcm-integration.zip deve ser descompactado em um servidor que possui acesso ao banco de dados do Gestão de Pessoas | HCM.

Instalar o Integrador - HCM como um serviço do Windows

Para instalar o Integrador - HCM como um serviço do Windows, é preciso executar a instalação usando o arquivo abaixo, disponível no diretório raiz da aplicação:

• InstallService64.bat (instala o serviço para servidores com instalação do Java de 64 bits)

Depois que o serviço estiver instalado, ele poderá ser iniciado pelo próprio painel de serviço do Windows ou pelo arquivo START.BAT.

Ao executar o arquivo START.BAT sem parâmetros, este tentará executar o serviço e, caso não exista, é emitida uma mensagem indicando a sua ausência. Mesmo assim, ainda é possível executar o Integrador HCM na forma de aplicação, executando o arquivo START.BAT com o parâmetro -nosvc.

Exemplo da mensagem de aviso quando não há o serviço do Integrador HCM instalado na máquina e tenta-se executar a aplicação usando o arquivo START.BAT:

Exclusão do serviço do Windows

Para excluir o serviço do Windows é necessário executar o arquivo RemoveService.bat, disponível no diretório raiz do integrador.

Possível falha da VM do Java durante a instalação do Integrador HCM

Caso perceba que ocorreu uma falha da VM do Java durante a instalação do Integrador HCM, faça o download do pacote OpenJDK que é usado pela aplicação. Instale o pacote OpenJDK e repita a instalação do Integrador HCM.

O motivo do erro pode ser constatado ao verificar os arquivos de log com o nome "global", localizados na pasta de logs onde a aplicação foi instalada (exemplo: C:\HCM-Integrador\log)

Para acessar a Central de Configurações Senior, execute o aplicativo SeniorConfigCenter.exe, localizado no mesmo diretório onde o Gestão de Pessoas | HCM (on-premise) foi instalado (exemplo: c:\Senior\SeniorConfigCenter.exe).

Neste aplicativo, faça as configurações a seguir:

Dados da conexão

Na Central de Configurações Senior, navegue até a tela de configurações do HCM — localizada em Sistemas > Gestão de pessoas > HCM — e preencha os campos da tela.

Esta configuração servirá para:

• fazer a conexão entre o ambiente do sistema on-premise e da plataforma senior X
• viabilizar a autenticação via ADFS

Você pode obter detalhes adicionais sobre como preencher os campos desta tela no Manual da Tecnologia.

Chaves

Na Central de Configurações Senior, navegue até a tela de configurações das chaves e adicione (ou configure) o seguinte registro:

• Chave: com.senior.vetorh.hcm.g7.auth
• Valor: true

Confira se a chave abaixo foi incluída — essa inclusão deve ter ocorrido automaticamente quando foram configurados os dados da conexão na etapa anterior:

• Chave: com.senior.vetoh.hcm.g7.location
• Valor: https://platform.senior.com.br/t/senior.com.br/bridge/1.0/rest
  

Você pode obter detalhes adicionais sobre como preencher os campos desta tela no Manual da Tecnologia.

Proxy

Se a empresa utiliza proxy:

Configure o proxy na Central de Configurações Senior (SeniorConfigCenter), pelo menu Conexões de rede > Acesso à internet.

Para verificar se a empresa utiliza proxy, pode-se consultar as configurações do navegador (exemplo pelo Internet Explorer: Opções da Internet > Guia Conexões > Botão Configurações da LAN > Servidor proxy).

Se a empresa não utiliza proxy:

Caso não utilize proxy, a propriedade config.ignore.proxy deve estar configurada como true no arquivo integration.properties do Integrador - HCM (config.ignore.proxy=true).

Na pasta raiz onde o Integrador HCM foi instalado constará o arquivo integration.properties (exemplo: C:\HCM-Integrador\integration.properties).

Usando o Bloco de Notas ou um editor de texto similar, abra este arquivo e edite as seguintes propriedades, conforme necessário:

Nome da propriedade	Descrição da propriedade	Preenchimento da propriedade
hcm.location	Endereço dos serviços do HCM.	Obrigatório
integration.fromFile.dir	Diretório onde ficam os arquivos com dados gerados por relatórios. Esta chave precisa apontar para a pasta onde são salvos os arquivos hcm-employee-salary-premiums.txt e hcm-employee-vacation-schedule.txt (consulte a documentação de pré-requisitos do Painel de Gestão), além de outros arquivos que são citados mais adiante nesta página. Exemplo: integration.fromFile.dir=C:\temp\data_files	Obrigatório
rh.company.id	Empresas a serem consideradas na integração.	Obrigatório
config.rootdir	Pasta da instalação do sistema Gestão de Pessoas | HCM (on-premise).	Obrigatório
config.environment	Nome do arquivo .cfg (sem a extensão). Por exemplo, se o arquivo for senior.cfg, deve-se informar apenas: senior	Obrigatório
config.ignore.proxy	Se estiver como true, ignora o proxy definido na Central de Configurações Senior (SeniorConfigCenter).	Obrigatório
config.proxy.nonProxyHosts	Informar os hosts que não deverão passar pelo servidor de proxy, sem espaços e separados pelo caractere pipe (|).	Opcional
hcm.tenant.id	Deve ser preenchido com o ID do tenant (inquilino) que consta na base de dados do HCM. Esta informação pode ser obtida no e-mail que é recebido pelo administrador do tenant, no qual é enviado o arquivo chave .pem. No e-mail, a informação estará descrita em ID do inquilino, por exemplo: Nome do inquilino: XXX LTDA ID do inquilino: xxx_ltda	Obrigatório
sync.interval	Tempo para verificação da sincronia. Se nada for definido, o valor padrão será 30 segundos.	Opcional
integration.administrator	Identificação do usuário que será estabelecido como o primeiro usuário administrador do Painel de Gestão. Deve ser preenchido no formato NumEmp/TipCol/NumCad, onde: NumEmp = código da empresa TipCol = código do tipo de colaborador NumCad = código do cadastro do colaborador Exemplo: integration.administrator=1/1/19028	Opcional
hcm.admin.email	Endereço de e-mail do administrador do Integrador - HCM. Quando o mesmo for informado, o administrador receberá diariamente um e-mail com um resumo das ocorrências de erros e falhas do Integrador - HCM. Caso o Integrador não apresente erros, o e-mail não será enviado.	Opcional
integration.log.level	Nível dos logs. Valores possíveis: ALL: Logs completos, considera todas as variações de logs da aplicação. É a opção recomendada pois facilita a manutenção. FINE: Log que considera situações de erros, avisos importantes, avisos informativos e avisos de rastreio (registros percorridos num fluxo, detalhes de uma entidade, etc). Exemplo: Buscando item pai com a posição: %s; INFO: Log que considera situações de erros, avisos importantes e informativos (aviso de início e fim de execução de processos, parâmetros de requisições, etc). Exemplo: Reexecutando erros de rede de integrações...; WARNING: Log que considera situações de erros e avisos importantes (registro ignorado, indisponibilidade momentânea, erro contornável, etc). Exemplo: Ocorreu timeout ao tentar baixar o arquivo de versão remoto com timeout, tentaremos novamente em breve.; SEVERE: Log que considera apenas situações de erros. Exemplo: Falha ao criar a tabela de cache de migração da meta.; OFF: Logs desativados. Essa opção não é recomendada pois pode dificultar a manutenção. Recomenda-se utilizar o nível ALL. Se nada for definido, o valor padrão será WARNING.	Opcional
integration.hierarchy.interval​	Intervalo de integração da hierarquia em minutos. Essa propriedade indica a cada quanto tempo a hierarquia será reenviada ao HCM. Valor padrão: 180 minutos​ Observação Valores menores ou iguais a 60 minutos serão desconsiderados.	Opcional
sync.enabledOnStart	Habilita/desabilita o início automático da sincronia ao iniciar o Integrador HCM. Valor padrão: false Observação O valor padrão da propriedade sync.enabledOnStart é false, porém, esse valor pode ser alterado para true. Quando o valor está como false, por sua vez, o sistema verifica se já foram executadas cargas de, pelo menos, 80% dos fluxos. Caso já tenha executado, no mínimo, essa porcentagem, o valor muda automaticamente para true.	Opcional
movimentation.task.enabled	Indica se os fluxos relacionados às movimentações e postos de trabalho dos colaboradores serão executados diariamente, para ajustar a base e evitar inconformidades. Valor padrão: true	Opcional
updater.disable	Indica se a atualização automática está desabilitada. Valor padrão: false	Opcional
sync.request.maxRows	Quantidade máxima de pendências a serem tratadas em cada execução da sincronia. Valor padrão: 300 pendências Valor máximo: 500 pendências	Opcional
sync.request.batch.size	Tamanho do batch de envio em lote. Valor padrão: 150 Valor máximo: 300	Opcional
sync.request.batch.timeout	Timeout da sincronia em lote (em minutos). Valor padrão: 15	Opcional
updater.openjdk11.download.path	Indica o local (diretório) para o qual o download do OpenJDK11 será feito.	Opcional
updater.openjdk11.zip	Define qual a versão do Java 11 que será baixada pelo Integrador - HCM.	Opcional
updater.integration.healthcheck.port	Porta para verificar se o serviço do Integrador - HCM está sendo executado corretamente no Windows. Por padrão é utilizada a porta 9082. Se essa porta já estiver em uso por outro processo do Windows, deve ser usada outra porta nesta propriedade.	Opcional
integration.inbound.port	Porta do Integrador HCM. O valor da porta deve ter exatamente 4 (quatro) dígitos. Se nada for definido, o valor padrão será 8082.	Obrigatório
integration.inbound.host	Nome do computador do Integrador HCM. Se nada for definido o valor padrão será localhost.	Opcional
integration.batch.size	Tamanho do batch de envio em lote para a integração. Valor mínimo: 25 Valor padrão: 50 Valor máximo: 80	Opcional
old_files_cleaner.deadline_days	Quantidade de dias que os arquivos antigos (logs, por exemplo) ficam disponíveis antes que sejam eliminados. Valor padrão: 45 (dias) Valor mínimo: 7 (dias) Valor máximo: 60 (dias)	Opcional
old_files_cleaner.deadline_days	Quantidade de dias que os arquivos antigos (logs, por exemplo) ficam disponíveis antes que sejam eliminados. Valor padrão: 45 (dias) Valor mínimo: 7 (dias) Valor máximo: 60 (dias)	Opcional
integration.payrollregister.month.number	Quantidade de meses retroativos que serão carregados na integração dos fluxos referentes a holerites (demonstrativos de pagamento, rubricas e contas bancárias). Valor padrão: 6 (meses) Valor mínimo: 0 (meses) Valor máximo: 60 (meses) Se esta propriedade não for definida, será usado o valor padrão (6). Se esta propriedade for definida com um valor maior que o máximo, será usado o valor máximo (6). Os registros são filtrados pela data de pagamento que consta no demonstrativo de pagamento. Exemplos: Considerando os seguintes demonstrativos: Registro Data do pagamento 1 01/01/2021 2 19/12/2020 3 05/12/2020 4 31/11/2020 5 04/11/2020 6 01/11/2020 7 27/10/2020 8 07/10/2020 9 06/09/2020 10 05/07/2020 11 03/06/2020 12 06/05/2020 Considerando também que a data atual seja 24/12/2020. Exemplo 1: integration.payrollregister.month.number = 6 A data retroativa será 01/06/2020 e serão considerados os registros de 1 até 11. Exemplo 2: integration.payrollregister.month.number = 1 A data retroativa será 01/11/2020 e serão considerados os registros de 1 até 6. Exemplo 3: integration.payrollregister.month.number = 0 A data retroativa será 01/12/2020 e serão considerados os registros 1 e 2.	Opcional
use.index.rtcpendencies.enabled	Por padrão, o banco de dados da G5 não utiliza o índice RTC_PENDENCIESINDICE_1 na consulta, que retorna a quantidade de pendências de sincronia por tabela. Caso a consulta apresente problemas de performance no banco de dados SQLServer, recomenda-se habilitar seu uso informando true nesta propriedade.	Opcional
useraccount.module.control.disabled	Quando configurado como true, o Integrador passará a replicar para o Senior X as informações de usuários que estão vinculados a colaboradores e que não têm indicação de módulos no Gestão de Pessoas | HCM XT.	Opcional
useraccount.syntax.error	Quando configurado como true, desabilita a geração de erros causados por problemas na sintaxe dos nomes de usuários, considerando que o serviço de autenticação da plataforma senior X não aceita nomes de usuários com certos tipos de caracteres especiais. Ao habilitar este parâmetro, usuários que apresentarem algum erro de sintaxe no nome ainda não serão integrados para o HCM, mas em vez de acusar o erro, a situação será apenas exibida no log do Integrador. Valor padrão: false	Opcional
integration.jvm.params	Parâmetro para inicialização da propriedade Xmxsize (Maximum Heap Size) da Máquina virtual Java (JVM). Define o valor máximo de memória que o Integrador HCM poderá alocar durante o processamento das pendências. Valor padrão: -Xmx4096m Valor mínimo recomendado: -Xmx2048m	Opcional
integration.g5.service.module	Indica através de qual módulo da G5 serão realizadas as integrações com a XPlatform. Valores possíveis: rubi, ronda, cs, rs ou ql. Valor padrão: rubi	Opcional
platform.roles.replication.enabled	Habilita a integração de grupos de usuários do SGU (versão on-premise/versão 6 do Gestão de Pessoas | HCM para a XPlatform) Valores possíveis: true	Opcional
hcm.email.notification.enabled	Inicializa as configurações da opção Receber notificação por e-mail Valores possíveis: true, false	Opcional
platform.multidomain.enabled	Habilita o suporte ao uso de domínios alternativos (multidomínios). Quando este parâmetro está definido como true, indica que o tenant tem mais de um domínio. Valores possíveis: true, false Importante Além de habilitar a propriedade platform.multidomain.enabled no Integrador HCM, é preciso fazer algumas configurações adicionais. Consulte a documentação de domínios alternativos do HCM para conhecer todas as configurações necessárias.	Opcional
sync.request.enabled	Habilita/desabilita a sincronia no contexto SeniorX > SeniorXT do Integrador HCM. O valor padrão da propriedade sync.request.enabled é true, porém, esse valor pode ser alterado para false. Quando o valor está como false, por sua vez, o sistema não inicia nenhum processo de sincronia do contexto SeniorX > SeniorXT	Opcional

A implantação do Integrador HCM é suficiente para sincronizar os dados gerais do HCM em ambientes híbridos.

Em alguns cenários é comum usar o Integrador ETL para integrar grupos de usuários e usuários (SGU), mas existem situações em que isso não é recomendado.

A documentação a seguir demonstra os possíveis cenários e como eles ocorrem.

HCM + ETL com o ERP:

Quando o ETL e o ERP da Senior estão em uso, recomenda-se não usar o ETL para sincronizar os grupos de usuários e usuários, pois há risco de ocorrer duplicação de usuários e grupos na base.

Portanto, nesse cenário, é preciso fazer as configurações abaixo para desabilitar a sincronização de grupos de usuários e de usuários:

1. Desabilitar tabelas de replicação:
   1. Acesse a plataforma senior X com um usuário administrador do tenant.
   2. Acesse o menu: Tecnologia > Administração > Integração > Replicação.
   3. Desabilite as seguintes tabelas de replicação de usuários do ETL:
      • R900CPL
      • R900GRP
      • R900PDT
      • R999USU
2. Configurar a Unificação de Logon:
   • Acesse o aplicativo da Central de Configurações Senior (SeniorConfigCenter) e configure a Unificação de Logon da Base de Dados. Para ver detalhes de como fazer esse procedimento, consulte a documentação completa no Manual da Tecnologia.

Através do Integrador HCM, é possível realizar a carga de dados dos usuários para utilizar o aplicativo Marcação de Ponto | HCM - não havendo, assim, a necessidade de habilitar o módulo Painel de Gestão. Abaixo, veja as instruções:

1. Acesse a Sara do Suporte, através do endereço https://suporte.sara.senior.com.br/;
2. Clique na opção Tenant e, em seguida, em Gostaria de Solicitar a Criação de um Tenant;
3. Informe seu usuário e senha;

Nota

Para solicitar a criação de um Tenant, seu usuário precisa ter permissão para isso.

4. Na tela da Sara, solicite o Tenant do APP - Marcação de Ponto. Para isso, basta marcar a opção APP - Marcação de Ponto, presente no item Quantidade de colaboradores por módulo;
5. Clique em Solicitar criação;
6. Após atendida, essa solicitação irá subir para o Integrador HCM.

Já no Integrador HCM, o APP - Marcação de Ponto será exibido em:

• Na guia Dashborad, será apresentado o APP - Marcação de Ponto no card de Módulos ativos;
• Na guia Integração, será apresentado o APP - Marcação de Ponto no card de Fluxo, contendo três fluxos. Sendo eles:
  • Usuários do HCM;
  • Grupos de usuários;
  • Usuários dos grupos.

Após realizar esse processo, a carga de dados dos usuários estará feita, já sendo possível os colaboradores utilizarem o aplicativo Marcação de Ponto | HCM.

É possível customizar fluxos através da modificação dos comandos SQL. Estes comandos são executados no banco de dados do sistema Gestão de Pessoas | HCM on-premise, alterando os dados que serão integrados.

Como customizar um fluxo

1. Acesse a pasta Queries, que está localizada no mesmo diretório da instalação do Integrador - HCM.
2. Dentro da pasta Queries, faça uma cópia do arquivo da query (.sql) que deseja customizar e acrescente a extensão .usu no final.
   
   Exemplo: 
   • Arquivo original: g5-accounting-query.sql
   • Arquivo copiado: g5-accounting-query.sql.usu

   Importante

   O encoding do arquivo .usu precisa ser UTF-8 (Sem BOM) para que o Integrador - HCM possa interpretá-lo. Outros tipos de codificação não são suportados.

3. Certifique-se de que o novo arquivo ficou com a extensão correta.
   
   Exemplo:
   

A existência do arquivo .usu durante a integração e a sincronização indica para o Integrador - HCM que ele deve considerar esta query, ao invés de usar o arquivo original (.sql).

Se você modificar diretamente o arquivo da query original (.sql), ele será sobrescrito durante a atualização do Integrador - HCM e suas alterações serão revertidas.

Não é necessário reiniciar o Integrador - HCM para que a query customizada seja utilizada, pois a atualização ocorre em tempo real.

Como verificar a versão do Integrador HCM

Na tela inicial do dashboard do Integrador HCM, no campo Versão do integrador, é exibida a versão atual em execução.

Como saber se o Integrador HCM está atualizando automaticamente

Desde que a propriedade updater.disable do arquivo integration.properties esteja como false, ao existir uma nova versão o integrador será atualizado automaticamente quando o seu respectivo serviço for reiniciado.

Enquanto em execução, o Integrador HCM também possui uma tarefa agendada que, a cada seis horas, verifica a existência de uma versão mais recente disponível para download. Se uma nova versão for encontrada, é disparado um processo de reinicialização automática para que ocorra a atualização.

Como o Integrador HCM verifica se existe uma nova versão para atualizar

Uma nova versão é encontrada quando a versão registrada no arquivo version.properties possuir data inferior à versão disponível para download.

Como monitorar o processo de atualização do Integrador HCM e verificar se ocorrer algum erro neste processo

O andamento da atualização pode ser acompanhado pelo arquivo updater.log, presente na pasta log do Integrador HCM. Neste arquivo fica registrado todo o processo de atualização e as possíveis falhas, como no caso de falha ao acessar o servidor onde a nova versão está hospedada.

O dashboard de integração permite visualizar informações através dos cards e realizar ações relacionadas ao Integrador HCM.

O dashboard (hcm-monitor) está localizado dentro da instalação da aplicação (hcm-integration.zip).

Visualizar e ativar os módulos contratados

No card Módulos ativos é possível visualizar os módulos contratados, com seu respectivo status de ativação.

Os módulos recém contratados podem ser ativados pelo próprio card, ação que faz com que o Integrador HCM reinicie e registre os fluxos e sincronias necessários para o funcionamento do módulo. Também são recriadas todas as triggers de monitoramento na base de dados do Gestão de Pessoas | HCM on-premises, deixando os fluxos disponíveis para realização da carga inicial.

Ou seja, os fluxos, sincronias e triggers de módulos recém contratados não entram em funcionamento até que a ativação do módulo seja realizada. O processo de ativação de um módulo de negócio pode levar alguns minutos, e sempre que ocorrer, seus respectivos fluxos serão marcados como pendentes de carga, visto que determinados fluxos precisam de uma nova execução para carregar novos campos específicos do módulo recém ativado.

Selecionar e executar fluxos para a carga inicial

Os fluxos de integração estão agrupados por módulo no card Fluxos da guia Integração. Desta forma, ao implantar um módulo, é possível selecionar somente os específicos para executar a carga inicial, pois nesta já constam todos os fluxos necessários para o funcionamento. Através deste card também é possível identificar quais fluxos ainda precisam ser executados para finalizar a implantação do módulo.

Ao selecionar um módulo, os fluxos de sua carga inicial são exibidos em ordem de execução. Os fluxos apresentados na cor verde já tiveram sua carga inicial executada, e os apresentados na cor preta estão com a execução ainda pendente. É possível executar somente os fluxos cuja execução está pendente, ou também executar novamente os que já tiveram a carga inicial.

O botão Executar carga a partir do fluxo selecionado somente é habilitado quando apenas um fluxo for selecionado, e executa a carga inicial começando pelo fluxo em seleção e seguindo a sequência. Já o botão Executar carga completa pode ser utilizado para a execução da carga inicial completa de todos os fluxos dos módulos ativos.

Visualizar fluxos já executados ou pendentes de carga inicial

É possível visualizar os fluxos que já tiveram a carga inicial executada ou os que ainda estão pendentes através dos cards Fluxos com cargas iniciais já realizadas e Fluxos pendentes de carga inicial.

Através destes cards é possível visualizar quais fluxos já tiveram suas respectivas cargas iniciais executadas por completo (independentemente da ocorrência ou não de erros) e quais fluxos ainda estão pendentes de carga. Através dos botões Adicionar e/ou Adicionar Todos é possível incluir os fluxos pendentes de carga na fila de execução.

Lista de fluxos por módulo ou rotina

A tabela abaixo apresenta o nome dos fluxos da carga inicial e o arquivo .sql que contém a query. Os arquivos podem ser consultados na pasta queries do integrador.

Fluxos opcionais

Os fluxos a seguir são opcionais e não são executados durante a carga inicial, tampouco são selecionáveis através da lista de fluxos. Para executá-los, é necessário inserir o nome do fluxo na caixa de pesquisa, localizada logo acima da lista de fluxos:

• Contatos emergenciais das pessoas
• Configurações (enviar notificações por e-mail)

Os seguintes processos são integrados do HCM na senior X de volta para a base do HCM XT, passando pelo Integrador HCM:

Nome do processo	Nome exibido nos logs do Integrador HCM	Tabelas HCM XT que receberão os dados integrados
Dependentes - Dados pessoais	DependentRequestFlow	R036DEP
Dependentes - Imposto de renda	DependentIncomeTaxRequestFlow	R036IRF, R036DEP
Dependentes - Foto	DependentPhotoRequestFlow	R036FOT
Dependentes - Comprovantes de salário família	FamilySalaryDocumentRequestFlow	R036EDU
Históricos de contas bancárias da pensão judicial	HistoricalJudicialPensionBankAccountRequestFlow	R036CPJ
Ajustes da pensão judicial	JudicialAdjustmentRequestFlow	R036PJA
Pensão judicial - Base mensal	JudicialBaseMonthlyRequestFlow	R036PJN
Pensão judicial - Base de participação nos lucros	JudicialBasePlrRequestFlow	R036PJL
Pensão judicial - Base 13o salário	JudicialBaseSalary13RequestFlow	R036PJD
Pensão judicial - Base férias	JudicialBaseVacationRequestFlow	R036PJF
Beneficiários (Alimentandos) da pensão judicial	JudicialPayeeItemRequestFlow	R036PPD
Pagamentos da pensão judicial	JudicialPaymentRequestFlow	R036PJP
Pensões judiciais	JudicialPensionRequestFlow	R036PJU
Lançamentos de rateio - Local e cargo	ApportionmentEntryDepartmentJobPositionRequestFlow	R020RLC
Lançamentos de rateio - Colaborador	ApportionmentEntryEmployeeRequestFlow	R020RMO
Lançamentos de exceção do rateio - Local e cargo	ApportionmentEntryExceptionDepartmentJobPositionRequestFlow	R020ELC
Lançamentos de exceção do rateio - Colaborador	ApportionmentEntryExceptionEmployeeRequestFlow	R020EXC
Bases de cálculo para múltiplos vínculos	EmployeeCalculationBasisRequestFlow	R044BAS
Lançamento 13º Salário	Entry13SalaryRequestFlow	R044D13
Lançamentos fixos	FixedEntryItemRequestFlow	R044FIX
Lançamentos variáveis	VariableEntryItemRequestFlow	R044MOV
Tipos de anotações das fichas registro	AnnotationTypeRequestFlow	R022NOT
Rateios	ApportionmentRequestFlow	R020RAT
Atendentes	AttendantRequestFlow	R108TAT
Horários da busca automática	AutomaticWorkScheduleSearchRequestFlow	R006HBA
Agências bancárias	BankBranchRequestFlow	R012AGE
Bancos	BankRequestFlow	R012BAN
Castas	CasteRequestFlow	R114CAS
CID por CNAE	CidByCnaeRequestFlow	R192CNA
Cidades	CityRequestFlow	R074CID
Faixas de marcação de horário	ClockingEventBandsRequestFlow	R004FHR
Marcações do horários	ClockingEventOfWorkScheduleRequestFlow	R004MHR
Índices de conversão	ConversionRatesRequestFlow	R026ICM
Países	CountryRequestFlow	R074PAI
Moedas	CurrencyRequestFlow	R026MOE
Deficiências	DisabilityRequestFlow	R022DEF
Doenças (CID)	DiseaseRequestFlow	R192DOE
Tipos de documentos	DocumentTypeRequestFlow	R022DOC
Graus de instrução dos colaboradores	EducationDegreeRequestFlow	R022GRA
Tipos de endereço eletrônico	ElectronicAddressRequestFlow	R022EEL
Vínculos de trabalho	EmploymentRelationshipRequestFlow	R022VIN
Naturezas de Despesa	ExpenseNatureRequestFlow	R048NAT
Índices	FinancialIndexRequestFlow	R026IDM
Datas Feriados	HolidayDatesRequestFlow	R002FEC
Feriados	HolidayRequestFlow	R002FEM
Índices - Valores	IndexValueRequestFlow	R026IDV
Seguros	InsuranceRequestFlow	R166SEG
Atividades de serviço	IssActivityRequestFlow	R022ISS
Limites de isenção de ISS	IssLimitRequestFlow	R022LIM
Áreas de conhecimento	KnowledgeAreaRequestFlow	R171ACN
Preços de linha de transporte	LinePricesRequestFlow	R028PRT, R028PRM
Meios de transporte	MeansOfTransportRequestFlow	R028MVT
Motivos das movimentações	MovimentationReasonRequestFlow	R076MOT
Nacionalidades	NationalityRequestFlow	R023NAC
Bairros	NeighborhoodRequestFlow	R074BAI
Pareceres	OpinionRequestFlow	R106PAR
Estrutura de Organograma	OrganizationalChartStructureRequestFlow	R016ORE
Pontos de embarque	PointEmbarkationRequestFlow	R028BVT
Siglas dos conselhos profissionais	ProfessionalBoardAcronymRequestFlow	R022SIG
Conselhos profissionais	ProfessionalCouncilRequestFlow	R022PRF
Logradouros	PublicPlaceRequestFlow	R074RUA
Qualificações	QualificationRequestFlow	R022QUA
Religiões	ReligionRequestFlow	R114RLR
Motivos da demissão	ResignationReasonRequestFlow	R114RMD
Estados	StateRequestFlow	R074EST
Estruturas	StructureRequestFlow	R000EST
Subgrupos de Doenças (CID)	SubgroupDiseaseRequestFlow	R192SUB
Quantidades das escalas de vale transporte	TransportationVoucherScaleItemRequestFlow	R028EVL
Escalas de vale transporte	TransportationVoucherScaleRequestFlow	R028EVT
Linhas de transporte	TransportLineRequestFlow	R028LVT
Grupo de Seleção dos Eventos	WagetypeGroupRequestFlow	R008SEL
Horários	WorkSchedulesRequestFlow	R004HOR
Classes da Escala	WorkshiftClassRequestFlow	R006CLE
Turma da escala	WorkshiftGroupRequestFlow	R006TMA
Escalas (turnos)	WorkshiftRequestFlow	R006ESC
Horário de Escala	WorkshiftScheduleRequestFlow	R006HOR
Ramos de Atuação	ActivityfieldRequestFlow	R032ATU
CBO 2002	Cbo2002RequestFlow	R024CB2
Classificação brasileira de ocupações (CBO)	CboRequestFlow	R024CBO
Contratos	ContractRequestFlow	R032EMC
Centros de custos	CostCenterRequestFlow	R018CCU
Outras empresas - Dados no exterior	DataAbroadOtherCompanyRequestFlow	R032EXT
Hierarquias de Cargos	HierarchyofficeRequestFlow	R024HIE
Anexos dos cargos	JobPositionAttachmentRequestFlow	R024ANX
Cargo - Órgão Público	JobPositionPublicBodyRequestFlow	R024CPU
Cargos	JobPositionRequestFlow	R024CAR
Requisitos do Cargo	JobPositionRequirementsRequestFlow	R024RQU
Histórico de informações salariais do cargo	JobPositionSalaryInfoRequestFlow	R024HIS
Adicionais salariais dos cargos	JobPositionSalaryPremiumRequestFlow	R038LAG
Níveis de Cargos	JobPositionStructureLevelRequestFlow	R024NIV
Estruturas de Cargos	JobPositionStructureRequestFlow	R024EST
Exceção de chefia	LeadershipExceptionRequestFlow	R080EXC
Chefias	LeadershipRequestFlow	R080SUB
Áreas de Atuação	OccupationareaRequestFlow	R024AAT
Outras empresas	OtherCompanyRequestFlow	R032OEM
Outras empresas - Tipos de uso	UseTypesOtherCompanyRequestFlow	R032USO
Regiões administrativas	AdministrativeRegionRequestFlow	R074RAD
Programações de desligamento	DismissalMovimentationRequestFlow	R042PRC
Anexos das anotações das fichas registro dos colaboradores	EmployeeAnnotationAttachmentRequestFlow	R038DHA
Anotações das fichas registro dos colaboradores	EmployeeAnnotationRequestFlow	R038NOT
Anuidades do colaborador	EmployeeAnnuityRequestFlow	R034ANU
Seguros do colaborador	EmployeeInsuranceRequestFlow	R034SEG
Modalidade PAT	EmployeePatModalityRequestFlow	R034PAT
Percentuais livres do colaborador	EmployeePercentageRequestFlow	R034PLI
Fotos dos colaboradores	EmployeePhotoRequestFlow	R034FOT
Colaborador	EmployeeRequestFlow	R033PES, R034FUN, R038HVI, R110FIC, R110HDF, R038HSI, R034SIN, R038HSA, R038HPO, R038HFI, R038HCC, R038HCA, R038EVT, R038HLO, R038HES, R038HCS, R038CAT, R038HNA, R034CON, R034ADM, R034ETG, R034PAT, R034CPL, R034CTR, R034SEG, R034SEL, R034ANU, R034EST, R034IEA, R034PLI, R034USO
Tipos de uso de terceiros	EmployeeThirdPartyUsingTypeRelationshipRequestFlow	R034USO
Grupo de Seleção dos Eventos do colaborador	EmployeeWagetypeGroupRequestFlow	R034SEL
Históricos de contas bancárias do colaborador	HistoricalBankAccountRequestFlow	R034CON
Históricos de filial	HistoricalCompanyBranchRequestFlow	R038HFI
Históricos de centro de custo	HistoricalCostCenterRequestFlow	R038HCC
Históricos de local do colaborador	HistoricalDepartmentRequestFlow	R038HLO
Históricos de vínculo do colaborador	HistoricalEmploymentRelationshipRequestFlow	R038HVI
Históricos de categorias do eSocial	HistoricalEsocialCategoryRequestFlow	R038CAT
Históricos de natureza de despesa	HistoricalExpenseNatureRequestFlow	R038HNA
Históricos de prorrogação de afastamento	HistoricalExtensionLeaveRequestFlow	R038PRO
Históricos de IRRF	HistoricalIrrfRequestFlow	R038HRE
Históricos de cargo	HistoricalJobPositionRequestFlow	R038HCA
Anexos de históricos dos colaboradores	HistoricalLeaveAttachmentRequestFlow	R038IMA
Históricos de afastamento	HistoricalLeaveRequestFlow	R038AFA
Históricos de adicionais do salário	HistoricalSalaryPremiumRequestFlow	R038HAD
Históricos de salário do colaborador	HistoricalSalaryRequestFlow	R038HSA
Históricos de categorias de SEFIP do colaborador	HistoricalSefipCategoryRequestFlow	R038HCS
Itens dos históricos de sindicato do colaborador	HistoricalSyndicateItemMainSyndicateRequestFlow	R038HSI
Itens dos históricos de sindicato do colaborador	HistoricalSyndicateItemOtherSyndicateRequestFlow	R034SIN
Históricos de sindicato do colaborador	HistoricalSyndicateRequestFlow	R038HSI, R034SIN
Histórico de contribuição sindical	HistoricalSyndicateUnionContributionRequestFlow	R038HCO
Históricos de teletrabalhos dos colaboradores	HistoricalTeleworkRequestFlow	R038HTT
Histórico de contrato temporário	HistoricalTemporaryContractRequestFlow	R034CTR
Históricos de estagiário	HistoricalTraineeRequestFlow	R034ETG
Históricos de escala	HistoricalWorkshiftRequestFlow	R038HES
Históricos de posto de trabalho	HistoricalWorkstationRequestFlow	R038HPO
Históricos de estabilidades	HistoricStabilityRequestFlow	R038HEB
Cadastros de aviso prévio de desligamento	NoticeWorkedRequestFlow	R042AVI
Históricos de afastamento retroativo	RetroactiveHistoricalLeaveRequestFlow	R039AFA
Sindicato Rescisão	SyndicateDismissalRequestFlow	R014HOM
Colaboradores - Exames toxicológicos	ToxicologicalExaminationRequestFlow	R038HEX
Tabela salarial	WageScaleRequestUpdateFlow	R076DES
Revisão de tabela salarial	WageScaleRevisionRequestUpdateFlow	R076EST

O que é uma pendência de sincronia

A pendência de sincronia é um registro da base do Gestão de Pessoas | HCM (versão 6) que possui uma alteração e precisa que ela seja replicada para a base de dados do HCM senior X.

Todas as operações realizadas em uma das tabelas monitoradas pelo Integrador HCM são consideradas para gerar uma pendência. As operações são: INSERT (inclusão de um novo registro), UPDATE (alteração de um registro) e DELETE (exclusão de um registro).

Como as pendência são geradas

Essas pendências são geradas via triggers existentes em cada uma das tabelas monitoradas pelo Integrador HCM. A geração e manutenção destas triggers são realizadas no momento da consistência de base que o Integrador HCM realiza ao inicializar.

Exemplos de nomenclatura das triggers geradas:

• RTC_R034FUN_I
• RTC_R034FUN_U
• RTC_R034FUN_D

Pendências agendadas

Na guia Sincronia do dashboard, é possível encontrar o agrupador G5 → HCM em aberto (Agendada).

Nesse agrupador é apresentada a quantidade de pendências em aberto que estão agendadas para a execução noturna.

A integração das tabelas que estão aguardando pela execução noturna ocorre diariamente, no período entre 18:30 de um dia e 08:00 do dia seguinte.

A coluna Horário Execução indica se as pendências das respectivas tabelas já estão na fila para processamento ou se as pendências foram agendadas para processamento em horário noturno.

Onde as pendências de sincronia são armazenadas

As pendências geradas são armazenadas na tabela RTC_PENDENCIES, da base de dados do Gestão de Pessoas | HCM (versão 6).

Como identificar se uma pendência de sincronia já foi processada

As pendências que já foram processadas pelo Integrador HCM continuam com um registro na tabela RTC_PENDENCIES, mas recebem um registro na tabela HCM_PENDENCIES (também da base de dados do Gestão de Pessoas | HCM - versão 6). Assim, o Integrador HCM considera que a pendência já foi devidamente processada.

Portanto, uma maneira de identificar quais pendências de sincronia não foram processadas é executando a seguinte query na base de dados do Gestão de Pessoas | HCM:

Execução das pendências de sincronia

O intervalo de tempo para a execução das sincronias relacionadas às solicitações no contexto HCM > G5 será de 1 (um) minuto para clientes que possuem o módulo da Folha de Pagamento habilitado no Integrador HCM; e de 3 (três) minutos para clientes que não possuem o módulo habilitado.

A execução da sincronia também realiza consultas adicionais para reunir dados necessários ao envio para o SeniorX, conforme as pendências identificadas. Esse processo utiliza queries semelhantes às empregadas na carga inicial, diferenciando-se pelo sufixo sync nos nomes dos arquivos de sincronia.

Exemplo para o fluxo de Cargos:

• Query de carga: g5-job-position-query.sql
• Query de sincronia: g5-sync-job-position-query.sql

O Integrador HCM possui uma rotina que permite ao administrador configurar quais pendências de sincronia não devem ser processadas.

Como funciona a rotina de ignorar pendências

Esta rotina se baseia na configuração do arquivo de propriedades sync-ignorefields.properties (encontrado na pasta raiz da instalação do Integrador HCM).

Se a pendência de sincronia de uma tabela estiver como campos alterados, apenas os definidos na propriedade (um ou mais) terão a pendência ignorada, inserindo assim um registro na tabela HCM_PENDENCIES da base do Gestão de Pessoas | HCM (versão 6). Isto indica ao Integrador HCM que a pendência em questão deve ser considerada como "processada com sucesso".

Como configurar o arquivo sync-ignorefields.properties

Nesse arquivo é necessário colocar como chave o nome da tabela do Gestão de Pessoas | HCM (versão 6) e, como valor da chave, os campos que devem ser ignorados.

Assim, caso o Integrador HCM receba uma pendência de sincronização alterando apenas algum desses campos, a pendência será ignorada.

Também é possível configurar com o termo ALL, então todas as pendências de sincronia daquela tabela serão ignoradas, independentemente de quais campos foram alterados.

Exemplo de configuração do arquivo:

A sincronia em lote permite que as rotinas processem suas pendências de forma independente, agrupando-as por contexto e enviando para o servidor de aplicação — processo que ocorre desta forma devido às sincronias que são executadas em grandes quantidades por dia.

Não é necessário fazer nenhuma configuração adicional para usar a rotina de sincronia em lote, pois ela é habilitada por padrão para todos os clientes.

Devido ao decreto do Governo que suspendeu o horário de verão por tempo indeterminado, pode ser necessário ajustar o Integrador - HCM para que os horários do log da aplicação fiquem corretos.

Procedimento para adequar os horários do Integrador - HCM:

1. Faça o download do arquivo tzdb.zip, disponível em: http://s3-sa-east-1.amazonaws.com/senior-hcm-integration/tzdb.zip
2. Descompacte o arquivo que foi baixado e coloque o arquivo tzdb.dat descompactado na pasta lib das seguintes JDK:
   • JDK 11 do Integrador - HCM (pasta jdk-11.0.2 no diretório do Integrador)
   • JDK 8 utilizada para a instalação do Integrador - HCM (normalmente pode ser encontrada pela variável de ambiente %JAVA_HOME_HCM%)

   Importante

   Se o banco de dados da solução on-premise for Oracle, coloque o arquivo tzdb.dat também na pasta lib do Java do Oracle. Se isto não for feito, o Java utilizado pelo Oracle não terá as mesmas configurações de data e hora, causando erros nas consultas que envolvem campos do tipo date e datetime.

3. Reinicie o serviço do Integrador - HCM para que a alteração seja aplicada.

O Integrador HCM permite realizar a integração de grupos de usuários do SGU (versão on-premise/versão 6 do Gestão de Pessoas | HCM para a XPlatform).

Como habilitar esta funcionalidade

1. Acesse a pasta raiz onde o Integrador HCM foi instalado (exemplo: C:\HCM-Integrador\integration.properties);
2. Acesse o arquivo integration.properties;
3. Dentro do arquivo integration.properties, ative (coloque como true) a chave platform.roles.replication.enabled;
4. Reinicie o Integrador HCM.

Ao reiniciar o Integrador HCM, a integração de grupos de usuários do SGU para a XPlatform já vai estar disponível.

Após reiniciar o Integrador HCM, os fluxos Grupos de usuários e Usuários dos grupos estarão marcados como Pendente na guia Integração. Portanto, torna-se necessário rodar os dois grupos para inicializar a rotina. Com isso, novamente frisamos a importância de verificar/realizar os itens destacados na caixa de Atenção acima.

Como utilizar esta funcionalidade

Com a funcionalidade habilitada, basta criar, alterar e/ou excluir um grupo (bem como os usuários de um grupo) no SGU. Ao fazer qualquer tipo de alteração no SGU, as informações serão sincronizadas com a XPlatform.

A tabela abaixo clarifica o que é modificado no SGU e qual/onde é o impacto na XPlatform:

No SGU	Na XPlatform
Grupo de usuários (campos: Nome, Descrição e Origem do grupo) Tabela da versão on-premise/versão 6 em que os dados são salvos: Usuários - People Data (R900PDT)	Papel (campos: Nome do papel, Descrição e Tipo)
Membros Tabela da versão on-premise/versão 6 em que os dados são salvos: Usuários - Group Members (R900GRP)	Usuários

Dúvidas frequentes

O sistema possibilita tornar padrão o envio de notificações por e-mail aos usuários da empresa, isso se dá através do fluxo Configurações (enviar notificações por e-mail). Para isso, deve-se seguir o passo a passo abaixo para habilitar essa funcionalidade.

1. Na guia Integração, informe o fluxo Configurações (enviar notificações por e-mail) na caixa de pesquisa acima da lista de fluxos;
2. Após, clique em Executar fluxo selecionado;

3. Acesse a pasta raiz onde o Integrador HCM foi instalado (exemplo: C:\HCM-Integrador\integration.properties);
4. Acesse o arquivo integration.properties;
5. Dentro do arquivo integration.properties, informe a chave hcm.email.notification.enabled = true;
6. Reinicie o Integrador HCM para que seja efetuada a leitura dessa nova chave;
7. Execute o fluxo Configurações (enviar notificações por e-mail);

A tela Associação de colaboradores e usuários, acessada na XPlatform em Gestão de Pessoas | HCM > Integrador HCM > Associação de Colaboradores Usuários, permite consultar e associar usuários criados ao colaborador correspondente no HCM.

• Para clientes que integram com o SeniorX através do XT, a tela é utilizada apenas para consulta de colaboradores associados.
• Para aqueles que integram via Novasoft (ou seja, sem o XT), a tela é utilizada para, além de consultas, inclusão e remoção das associações. Neste caso, essa funcionalidade é essencial para definir quem terá acesso à XPlatform, garantindo que cada usuário tenha as permissões apropriadas associadas ao seu perfil.

Nessa tela, os administradores ou pessoas por eles autorizadas podem realizar as seguintes ações:

• Associar: permite a inclusão de novas associações entre colaboradores e usuários;
• Desassociar: permite a remoção de associações previamente estabelecidas;
• Consultar: permite a visualização das associações existentes.
• Importar: permite a importação coletiva de associações de usuários e colaboradores, através do upload de um arquivo .csv.
  • Esse botão está disponível apenas para clientes que utilizam a integração via Novasoft.

Ao clicar em Importar, uma nova tela será exibida para realizar o pré-carregamento do arquivo. O sistema validará sua estrutura e conteúdo, que obrigatoriamente deve conter as seguintes colunas:

• username: nome do usuário previamente cadastrado na XPlatform;
• person: código da pessoa (que, para clientes Novasoft, é o mesmo código de colaborador);
• cod_cia_extr: código da empresa;
• tipcol: tipo de colaborador (para Novasoft, sempre 1);
• cod_emp_extr: código do colaborador.

O processo de importação é assíncrono — ou seja, após carregar o arquivo, o sistema processará as associações em segundo plano. O usuário que iniciou a importação receberá uma notificação com os resultados do processamento:

• Se todos os registros forem importados com sucesso, a notificação informará a conclusão bem-sucedida;
• Se houver erros, a notificação incluirá um link para download de um arquivo detalhando os registros que falharam e os motivos dos erros.