Biblioteca

Protheus Consultas

Serviço

Consultar Cliente

Descrição

 Esta biblioteca realiza consulta de clientes no Protheus na tabela SA1, utilizando como parâmetro default o campo A1_CGC.

Parâmetros de configuração do conector

  • url-base-protheus: Informar o endereço ou globals referente ao endereço de acesso aos serviços REST do Protheus.
  • autenticacao-protheus: Informar o account cadastrado para autenticação com o ambiente protheus

Entrada

{
  "A1_CGC":"000000000"
}

Saída

Sucesso, sem dados:

{
  "result": {
    "code": "400",
    "success": "false",
    "detailedmessage": "Na pesquisa nao foi encontrado nenhum registro na filtragem",
    "check": "SA1"
  },
  "status": 200
}

Sucesso, com dados:

{
  "SA1": [
    {
      "A1_PESSOA": "J",
      "A1_COD_MUN": "",
      "A1_END": "",
      "A1_LOJA": "SP",
      "A1_COD": "",
      "A1_NOME": "",
      "A1_MUN": "",
      "A1_CGC": ""
    }
  ],
  "success": true
}

Erro:

{
   "code": 404,
   "error": "Error 404"
   //opcionais:
   "message" : "",
   "body" :  ""
   "timestamp" : 1563889045517
}

Parâmetros possíveis de serem informados na entrada, para realizar a consulta de forma customizada, estes e outros podem ser informados dentro do objeto "header":

{
  "header": {
    "aFields": "Campos Desejados para retornar no resultado da consulta, separado por vírgula. Ex: A1_COD, A1_CGC, A1_END",

    "page": "Qual a página deve ser retornado para a consulta. Default: 1",

    "pageSize": "tamanho da página da consulta. Default: 5",

    "cOrder": "Coluna utilizada na ordenação da consulta. Default: A1_COD",

    "cFilEmp": "Filial da empresa no protheus para a consulta. Default: 0102",

    "cEmpresa": "Empresa do protheus para a consulta. Default: 01",

    "cWhere": "Condição para consulta. Default: A1_CGC LIKE '{A1_CGC}%' "
  }
}


Sugestão para utilização das condições no choice com JsonPath após step do serviço:

Sem registros para a consulta: $.result
Registros encontrados para a consulta: $.SA1
Erro: otherwise

Abaixo um exemplo para copiar e colar no seu pipeline:

{"nodes":[{"id":"087c8a9a-1473-43ec-adee-91e07d646e8a","type":"component@choicechoice","data":{"type":"choice","stepName":"Choice","blank":true,"uuid":"129458d3-ae65-42d7-8408-79ca0dfb2709"},"left":0,"top":160},{"id":"b4754ea6-2e01-495a-8259-f0ff271a709b","type":"component@transformertransformer","data":{"type":"transformer","stepName":"Transformer","transformSpec":[{"operation":"default","spec":{"success":true}}],"uuid":"07961023-58b3-4488-a27c-db9e9fb56d5e"},"left":null,"top":null},{"id":"0e2c29b7-0ad3-4d64-8dd1-544d6080466b","type":"component@transformertransformer","data":{"type":"transformer","stepName":"trasnformer","transformSpec":[{"operation":"shift","spec":{"SA1":"cliente"}}],"uuid":"7e2ff621-ec40-4c7f-8c05-9761724446d5"},"left":247,"top":161},{"id":"40bdd0b6-44fb-4684-9431-4ff95a630a48","type":"component@connectorlog-connector","data":{"type":"connector","name":"log-connector","stepName":"Log-Connector","params":{"logLevel":"ERROR","message":"Erro ao consultar o protheus #{error} #{code}"}},"left":105,"top":373}],"edges":[{"source":"087c8a9a-1473-43ec-adee-91e07d646e8a","target":"b4754ea6-2e01-495a-8259-f0ff271a709b","data":{"id":"1cc848b8-816a-478e-a209-38aa3a1ab64a","type":"choice","conditionType":"when","label":"item-nao-encontrado","conditionRule":"jsonPath","condition":"$.result"}},{"source":"087c8a9a-1473-43ec-adee-91e07d646e8a","target":"0e2c29b7-0ad3-4d64-8dd1-544d6080466b","data":{"id":"0020ace5-7393-4b07-b1bd-d300514a9a64","type":"choice","conditionType":"when","label":"item-encontrado","conditionRule":"jsonPath","condition":"$.SA1"}},{"source":"087c8a9a-1473-43ec-adee-91e07d646e8a","target":"40bdd0b6-44fb-4684-9431-4ff95a630a48","data":{"conditionType":"otherwise","label":"erro na consulta","type":"choice"}}]}



Ilustração do tratamento:

Encontrou sua resposta?