Histórico da Página
...
| Aviso | ||
|---|---|---|
| ||
ESTE DOCUMENTO SOMENTE TERÁ UTILIDADE PARA CLIENTES QUE JÁ UTILIZAM A PLATAFORMA CAROL, CASO CONTRÁRIO NÃO SERÁ POSSÍVEL A REALIZAÇÃO DESTA CONFIGURAÇÃO. |
02. FLUXO DO AMBIENTE
03. VISÃO GERAL
A configuração da integração entre a Carol e Protheus se baseia na configuração de um Schedule que será executado em intervalos previamente definidos, acionando as API's da Carol ou a rotina cadastrada em Menu:
...
| Informações | ||
|---|---|---|
| ||
O CAMPO PISCODE NA PLATAFORMA CAROL É OBRIGATÓRIO PARA A INTEGRAÇÃO CORRETA COM O PROTHEUS, POIS SE TRATA DE UMA INFORMAÇÃO CHAVE PARA O SISTEMA. |
...
04. EXEMPLO DE UTILIZAÇÃO
O cliente utiliza a Carol para as marcações de ponto dentro da empresa, esta empresa possui diversos dispositivos espalhados pela organização.
O Protheus será o responsável por acionar a plataforma Carol, buscar as informações contidas em cada dispositivo e armazenar os registros dentro do módulo SIGAPON. Nos próximos tópicos, os passos serão detalhados:
...
4.1. PARAMETRIZAÇÃO
Para que haja a devida integração entre os dois sistemas, se faz necessário preencher os parâmetros abaixo:
...
| Aviso | ||
|---|---|---|
| ||
1. Após a criação do parâmetro MV_APICLOA, o sistema sempre irá realizar a primeira tentativa de autenticação utilizando o API Token (MV_APICLOA). Caso o Token esteja inválido, será realizada uma tentativa de autenticação por usuário e senha. O Log de erro de integração só será exibido se ambas as tentativas de autenticação falharem. |
...
4.2. CADASTRO DO RELÓGIO CAROL
Para cadastro do relógio, basta acessar no SIGAPON/CADASTRO DO PONTO/RELÓGIOS e preencher os dados da aba geral com atenção especial para os campos:
...
| Informações | ||
|---|---|---|
| ||
Somente será permitido deixar o campo Rep em branco se o parâmetro MV_APICLO0 estiver como .T. . |
...
4.3. SCHEDULE\MENU
A rotina desenvolvida para a realização de todo o fluxo de requisição para a Carol foi nomeada de PONAPI01, esta rotina não estará disponibilizada em Menu ou pré-carregada no Schedule.
O Processo de Cadastramento será o mesmo utilizado por outras rotinas:
...
4.3.1. PREENCHIMENTO DO SCHEDULE
- Acessar o módulo SIGACFG - Configurador;
- Acessar o caminho do menu AMBIENTE/SCHEDULE/SCHEDULE;
- Clicar na opção Cadastro no calendário de agendamentos, conforme imagem1 da tela no Tópico 0506;
- O preenchimento é simples e intuitivo para o preenchimento correto do schedule (leia o item 5 abaixo, antes de confirmar o cadastro);
- Clique o ícone cinza ao lado do botão de confirmar, pois lá se encontra as informações de periodicidade de acionamento da rotina cadastrada (Imagem 2 do Tópico 0506);
- Após a confirmação do cadastramento, será necessário habilitar os agents (Imagem 3 do Tópico 0506 ), onde você pode cadastrar manualmente ou pressionar o ícone de radar verde no canto superior direito e os agents serão incluídos automaticamente;
- Com os agents devidamente cadastrados, o usuário deve pressionar o ícone de pasta do lado esquerdo e ligar Task Manager e Queue Manager (São os gerenciadores da fila de acionamento dos agents) (Imagem 4 do Tópico 0506 ).
4.3
...
.1 PREENCHIMENTO DO CADASTRO DA ROTINA NO MENU
- Acessar o módulo SIGACFG - Configurador;
- Acessar o caminho do menu AMBIENTE/CADASTROS/MENU;
- Selecione o módulo\Menu que deseja realizar a inclusão da rotina, conforme imagem 1 do Tópico 0506;
- Quando clicar em "OK" será aberta uma tela semelhante a imagem 2 do Tópico 0506 e você deverá pressionar o primeiro botão central "Adicionar>>" e o menu inteiro será transferido para o lado direito da tela;
- Clique na pasta azul que desejar incluir o item da rotina e pressione o botão Novo Item conforme imagem 3 do Tópico 0506, desta forma será exibida uma nova tela para inclusão da rotina conforme imagem 4;
- Preencha o nome que deseja que apareça no menu e digite o nome da rotina citada no início deste documento PONAPI01, conforme imagem 4;
- Confirme o cadastro e clique no botão central de Gerar;
- O Sistema exibirá uma mensagem solicitando o nome do xnu que será gerado, sugerimos manter o mesmo nome do xnu padrão ex.
...
4.4. DETALHES DO PONAPI01
Para eventual manutenção na rotina de leitura dos marcações da Carol, é possível utilizar os parâmetros abaixo afim de realizar alguns filtros específicos. Estes parâmetros não são obrigatórios. Caso não sejam informados, a rotina utilizará a sequência de marcações para realização da importação dos dados. Os parâmetros opcionais são:
...
| Dica | ||
|---|---|---|
| ||
Ao configurar a rotina para execução automática (Schedule), os parâmetros (lWork, dInicio, dFinal, cCoDisp e nCodNSR) não deverão ser informados. Devido ao tamanho da string trafegada entre os sistemas, pode haver estouro de string caso os parâmetros citados a seguir não estejam configurados no appserver.ini, pare o Server e coloque a propriedade TOPMemoMega=1 ("Veja Mais sobre TopMemoMega) e a propriedade MaxStringSize ( Veja Mais Sobre MaxStringSize e o valor que deve colocar no parâmetro) |
...
05. CONFIGURAÇÃO SSL
Para realizar requisições para a Carol, será necessária a configuração do SSL no Appserver. Atualmente a Carol utiliza a versão SSL 1.3 e por este motivo é necessária a configuração do SSL por parte do Protheus. Segue abaixo um exemplo da configuração:
...
Para mais informações de como realizar a configuração do SSL no AppServer, no final da desta documentação, em anexos, estará disponível o link do passo a passo de como realizar a configuração.
| Âncora | ||||
|---|---|---|---|---|
|
...
06. TELA DE CADASTRO DE SCHEDULE
Cadastro de Rotina
Preenchimento da periodicidade dos acionamentos:
...
Gerenciamento da fila e execução dos agents.
...
07. TELA DE CADASTRO DE MENU
Tela de listagem de menus
...
Tela de configuração do menu escolhido
...
08. MENSAGENS DE INTEGRAÇÃO
Para possibilitar o acompanhamento da integração do Protheus com a Carol, será apresentado algumas mensagens em tela caso o acionamento seja manual pelo menu ou no console.log, quando a rotina for acionada via Schedule.
- Caso o código NSR enviado por parâmetro e o mesmo seja abaixo de zero:
- Verifique o Código NSR Informado, pois o mesmo somente aceita números positivos!
- Inconsistências nas datas:
- Verifique as Datas informadas para acesso ao Clock In da Carol.
- Será apresentada a seguinte mensagem e a mensagem retornada da plataforma Carol.
- Não foi possível acessar a API Clockin da Carol.
- Problemas com o preenchimento dos parâmetros:
- Verifique o parâmetro MV_APICLO1 pois ele é responsável pelo cadastro da URL de EndPoint para a integração de Clock In da Carol.
- Verifique o parâmetro MV_APICLO2 pois ele é responsável pelo cadastro do path da API Token para a integração de Clock In da Carol.
- Verifique o parâmetro MV_APICLO3 pois ele é responsável pelo cadastro do Id Conector para a integração de Clock In da Carol.
- Verifique o parâmetro MV_APICLO4 pois ele é responsável pelo cadastro do User Name para a integração de Clock In da Carol.
- Verifique o parâmetro MV_APICLO5 pois ele é responsável pelo cadastro do Password para a integração de Clock In da Carol.
- Verifique o parâmetro MV_APICLO6 pois ele é responsável pelo cadastro do Domain Name para a integração de Clock In da Carol.
- Verifique o parâmetro MV_APICLO7 pois ele é responsável pelo cadastro do path da API DeviceList para a integração de Clock In da Carol.
- Verifique o parâmetro MV_APICLO8 pois ele é responsável pelo cadastro do path da API clockinrecordsList para a integração de Clock In da Carol.
- Não foi possível acessar a API Clock In da Carol. Verifique os parametros MV_APICLO0, MV_APICLO1, MV_APICLO2, MV_APICLO3, MV_APICLO4, MV_APICLO5, MV_APICLO6,MV_APICLO7, MV_APICLO8 com as informações fornecidas.
- Não foi possível acessar a API Clock In da Carol. Verifique os parametros MV_APICLO0, MV_APICLO1, MV_APICLO2, MV_APICLO3, MV_APICLO4, MV_APICLO5, MV_APICLO6,MV_APICLO7, MV_APICLO8, MV_APICLO9 com as informações fornecidas.
- Não foi possível acessar a API Clock In da Carol. Verifique o parametro MV_APICLO8 pois ele é responsável pelo cadastro do path da api clockinrecordsList para a integração de Clockin da Carol.
- O parâmetro MV_APICLO9 está vazio ou não foi criado e a Carol possui uma organização configurada. Por favor crie e preencha o MV_APICLO9 com o Nome da Organização.
...
09. TABELAS UTILIZADAS
- SP0 - Pré-Leitura\Relógio de Ponto;
- RFE - Relógio de Ponto;
- SP8 - Movimento de Marcações;
- MSA_CONTROL_MARCAC - Tabela criada na primeira carga de dados com a Carol para armazenar as marcações integradas, caso o dicionário de dados não possua a RR1. Esta tabela também é utilizada no modelo de integração com o TSA e Suricato, a partir deste momento, será processado pelo sistema onde serão gerados os registros na SP8.
- RR1 - Nova tabela para armazenamento das marcações integradas, esta tabela substitui a MSA_CONTROL_MARCAC.
...
10. ROTINAS ENVOLVIDAS
- GPEA010: Cadastro de Funcionários;
- PONA030: Cadastro de Relógios;
- PONM010: Leitura e Apontamento.
...
11. ANEXOS
- DRHGCH-13658 Alterar rotina PONA030 - Relógio (Detalhes para funcionamento na rotina PONA030)
- DRHGCH-13255 - Integração Ponto X Carol - Batidas - API de acesso ao Token ( Detalhes sobre o funcionamento na rotina PONAPI01)
- DRHGCH-13652 Integração Ponto X Carol - Batidas - API de acesso ao DeviceList
- Seção [SSLConfigure]
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas