Este artigo tem a finalidade de explicar a instalação e funcionamento da integração com entre o Flow e o Swile.
Funcionalidades da Integração
Envio dos Estabelecimentos do Flow para o Swile como Filiais e Grupos.
Esse fluxo tem como objetivo cadastrar todos os estabelecimentos existentes no Metadados no Swile através do endpoint POST Create a new corporate branch (corporate/branch/add). Caso seja cadastrado um novo estabelecimento, ele também será enviado.
Relação de campos:
Swile | Metadados |
name | Estabelecimentos.Descricao |
nameOnCard | Estabelecimentos.Descricao |
documents | Estabelecimentos.Inscricao |
address.street | Estabelecimentos.EnderecoLogradouro |
address.number | Estabelecimentos.EnderecoNumero |
address.complement | Estabelecimentos.EnderecoComplemento |
address.neighborhood | Estabelecimentos.EnderecoBairro |
address.zipCode | Estabelecimentos.EnderecoCEP |
address.city | Estabelecimentos.EnderecoMunicipio |
address.state | Estabelecimentos.EnderecoMunicipio(Apenas a parte da UF) |
Também são enviados os grupos. Esse fluxo tem como objetivo cadastrar todos os estabelecimentos existentes no Metadados no Swile através do endpoint POST Create WorkGroup (workgroup). Caso seja cadastrado um novo estabelecimento, ele também será enviado.
Relação de campos:
Swile | Metadados |
name | Estabelecimentos.Descricao |
description | Estabelecimentos.Descricao |
documents | Estabelecimentos.Descricao |
Carga inicial dos colaboradores do Flow para o Swile.
A carga inicial de colaboradores tem por objetivo realizar o envio de todos os colaboradores ativos e afastados do Flow para o Swile.
Em seguida segue uma relação dos campos enviados no cadastro de um novo colaborador no Swile baseado no cadastro de colaborador do Metadados com seus respectivos campos de origem e destino:
Swile | Metadados |
idWorkGroup | DescricaoDoEstabelecimento |
name | Funcionarios.NomeDaPessoa |
Funcionarios.EmailCorporativo ou Email | |
phoneNumber | DddCelular + TelefoneCelular |
document | Cpf |
externalId | Cpf |
birthDate | Cpf |
Envio das admissões do Flow para o Swile.
Sempre que houver uma nova admissão no Metadados, será criado um colaborador no Swile com seus dados. A relação dos campos é a mesma descrita na carga inicial.
Desabilitar os colaboradores no Swile quando houver uma rescisão no Flow.
Quando houver uma rescisão no Metadados, será desligado o colaborador respectivo no Swile. Isso impossibilita que o colaborador receba uma nova carga em seu cartão na Swile.
Atualização dos colaboradores no Swile quando forem alterados no Flow.
Sempre que houver uma alteração no Metadados de um dos campos descritos na carga inicial, o colaborador será atualizado na Swile.
Envio dos Pagamentos calculados pelo módulo de benefícios do Flow.
Em breve.
Processo de Ativação da Integração
- a Swile demandará para a Metadados a ativação de um novo cliente.
-
recebendo o pedido por parte da Swile, a Metadados criará um usuário na plataforma de integrações https://integracoes.metadados.com.br. Quando criado o usuário é disparado um convite para que a pessoa possa finalizar seu cadastro. Esse convite tem validade de 24 horas.
Esse usuário será o responsável por ativar a integração, gerenciar as credenciais de acesso e os horários de execução da integração.
-
Com o usuário criado já é possível ativar a integração. Mas antes é imprescindível solicitar ao RH validar os campos cadastrais das pessoas dentro do Flow.
Os campos abaixo devem ser únicos por colaborador e obrigatórios em todos os colaboradores.
- CPF
- E-mail Corporativo e/ou e-mail pessoal.
- DDD e telefone celular da pessoa.
- Email e telefone devem ser únicos por pessoa.
(Aqui o pessoal deve escrever como instruir o cliente a fazer esses ajustes.)
-
Quando o administrar acessar https://integracoes.metadados.com.br/ ele já localizará os fluxos de integração da Swile no menu "Integrações."
-
Ao clicar em "Detalhes" de cada um dos fluxos é aberto um novo menu para administração dos fluxos:
-
No menu credenciais o cliente deve preencher os dados:
URL da API do SIRH: não necessário o preenchimento.
Usuário da API do SIRH: não necessário o preenchimento.
Senha da API do SIRH: não necessário o preenchimento.
URL da API do Flow: será preenchido pela equipe Metadados, mas o cliente deve revisar.
ClientId da API do Flow: ClientID para autenticar na API do Flow.
ClientSecret da API do Flow: ClientSecret para autenticar na API do Flow.
URL da API do Swile: será preenchido pela equipe Metadados, mas o cliente deve revisar.
ClientId da API do Swile: fornecido pela Swile.
ClientSecret da API do Swile: fornecido pela Swile.
Estabelecimentos Considerados na Integração: informar os códigos dos estabelecimentos do Flow que serão considerados para a integração. Se for mais de uma separar por ponto e vírgula. Ex: 0001;0002;0003
Vínculos Empregatícios Ignorados: código dos vínculos empregatícios de colaboradores que não devem ser integrados com a Swile. Se for mais de um separar por ponto e vírgula. Exe: 15;02
Dias de Histórico para buscar os dados: será preenchido pela equipe Metadados, mas o cliente deve revisar. É o tempo de histórico que integração busca as admissões e rescisões.
E-mail enviado (Corporativo ou Pessoal): será preenchido pela equipe Metadados, mas o cliente deve revisar. Deve ser informado "Corporativo" se a preferência do e-mail para integração com o Swile será o email corporativo do Flow. Caso a preferência seja o e-mail pessoa, informar "Pessoal".
Sistema - SIRH ou FLOW: será preenchido pela Metadados.
Os itens em negrito são de preenchimento obrigatório por parte do cliente.
Somente é necessário o preenchimento dos campos em um fluxo, após é possível copiar os dados de um fluxo para o outro sendo necessário somente preencher novamente os campos:
- ClientId da API do Flow
- ClientSecret da API do Flow
- ClientId da API do Swile
- ClientSecret da API do Swile
-
No sistema Flow deve ser realizado o login com usuário "MASTER" para buscar o clientid e clientsecret. Ao realizar o login deve acessar o menu Licença:
Na tela de licenças temos o clientId no campo chave do produto
E na ação Informações de integrações API temos o clientSecret:
- Após o preenchimento dos dados se deve rodar os fluxos na seguinte ordem:
- Swile WorkGroups: para criação de Filiais e Grupos dentro da Swile.
- Swile Colaboradores: para envio de todos os colaboradores ativos e afastados para o Swile.
- os demais fluxos rodarão automaticamente nos horários agendados.
-
Também é possível que o cliente defina o horário de execução de cada fluxo no menu execução.
No exemplo da imagem abaixo, o fluxo de colaboradores estão agendado para executar as 22 horas diariamente.
No canto superior direito, no botão azul, é possível disparar a integração manualmente.
- No menu logs, se pode analisar os logs de cada uma das execuções.
Ao clicar no botão das ações será exibido o detalhe dos logs da execução: