F000CWS - Configuração de web services

Através dessa tela é possível configurar quais informações de um web service podem ser consultadas ou retornar valor em uma integração.

Configurando um web service

Estes são os passos para configurar um novo web service para uso:

1. No campo Código, digite o número desejado para inclusão de uma nova configuração ou então utilize a tecla Tab para que o sistema defina o código automaticamente. Cada web service precisa receber um código diferente, é importante fazer esse cadastro com atenção, sob risco de sobrescrever os registros ao utilizar o mesmo código para todos os web services. Por exemplo:
   • O primeiro web service recebe o código 1
   • Segundo web service recebe o código 2 e assim sucessivamente.
2. Informe a Empresa e a Filial desejadas, assim como o Sistema para o qual quer configurar a restrição.
3. No campo Web service, selecione o desejado, e em seguida a Porta que quer configurar.
   Notas
   

   • Nem todos os web services do Gestão Empresarial | ERP ficam disponíveis no campo Web service - somente aqueles que permitem a configuração. Considera-se na disponibilização de edição dos web services, a verificação de informações dos módulos constantes na proprietária.
   • Esta é a lógica para obtenção da configuração da porta: inicialmente o sistema tenta obter a configuração da porta que está sendo executada. Caso não exista configuração para esta porta, tenta obter a configuração da porta de versão inferior à última porta pesquisada e assim sucessivamente até que se chegue na porta inicial.
     
     Exemplo: Considerando que exista configuração apenas para a porta Exportar e a porta que está sendo executada é a porta Exportar_5. Inicialmente o sistema tenta obter a configuração da porta Exportar_5, e como não encontra, tenta obter a configuração da porta Exportar_4, como não encontra, tenta obter a configuração da porta Exportar_3, e assim sucessivamente até que encontre alguma configuração ou até chegar na porta inicial (neste caso, porta Exportar).
     
     Caso nenhuma configuração seja encontrada, as requisições a essas portas serão bloqueadas. A única exceção a essa regra são os web services que integram as informações do Gestão Empresarial | ERP com a solução de Gestão de Lojas da Senior, que nesse caso mantêm o comportamento nativo (exportam as informações sem aplicar nenhum filtro).
4. No painel Campos exportados pelo web service, selecione aqueles que deseja exportar.
   Importante
   

   • Este é um passo obrigatório para que seja possível utilizar qualquer web service disponível nesta tela, pois do contrário nenhuma informação será exportada por eles.
   • Os campos que não são marcados continuam na assinatura do web service, porém com valor nulo.
   • Alguns campos são exibidos agrupados e nesses casos é possível selecionar só os campos desejados ou marcar todos que estão no agrupamento clicando no agrupador:
     
   • Os campos de usuário são contemplados nessa configuração.
   • Quando o web service é para integração com o Gestão de Lojas: o painel de Campos exportados pelo web service não é mostrado, já que esses web services são exclusivos para essa integração e nesse caso a personalização de informações integradas não é necessária.
5. Se desejar, utilize o painel Definições das regras de filtro para o sistema e tipo de informação selecionadas para restringir os valores dos campos liberados.
6. Clique em Processar.

Restringindo os valores dos campos liberados

Ao configurar um web service, é possível restringir os campos liberados, definindo quais registros devem retornar valor. Isso acontece através do painel Definições das regras de filtro para o sistema e tipo de informação selecionadas e funciona assim:

1. No campo Regra, informe aquela que deseja utilizar.
   
   Dica

   A regra ligada ao web service tem as seguintes variáveis de entrada:

   • GerNCodEmp: Código da empresa.
   • GerNCodFil: Código da filial.
   • GerAFilTro: Filtro aplicado no web service.
   • GerNCodInt: Código de identificação do sistema.
   • GerAWebSer: Web service.
   • GerAPorTaa: Porta do web service, como por exemplo "Exportar" ou "ConsultarGeral".
   • GerNSeqCws: Código de identificação da configuração do web service.
   • Usuário logado: Utilize a variável de sistema para obter qual usuário está executando o serviço.

   E a seguinte variável de saída: GerAFilTro - Retorna o SQL definido na regra caso o mesmo não seja alterado. Do contrário, mantém o filtro definido na tela.
   

2. No campo Where adicionado ao web service, defina um filtro para os registros do web service. O valor deste campo é recebido pela regra utilizada.
   
   Quando definida uma configuração de SQL pelo usuário, o sistema não mantém a cláusula where padrão existente no serviço que está sendo configurado, pois assim é possível que novas versões da solução Gestão Empresarial | ERP tenham alterações no where padrão sem afetar as customizações do cliente.

   Nota

   • Para saber quais campos podem ser informados, consulte a documentação do web service, para saber quais são os principais campos que podem ser utilizados como filtro.
   • Para saber sobre campos e tabelas dentro do ERP, utilize o atalho F8 ou acesse Diversos > Campos/Tabelas;
   • Para um melhor detalhamento sobre as tabelas, os campos e as possíveis ligações entre tabelas, utilize a aplicação CBDS;
   • Todos os web services possuem uma tabela principal;
     Exemplo:

     • O web service de cliente tem como tabela principal a Cadastros - Clientes (E085CLI);
     • O web service de pedido tem como tabela principal a Vendas - Pedidos - Dados Gerais (E120PED) (dados gerais do pedido);

     • O web service de nota fiscal de saída tem como tabela principal a Vendas - Notas Fiscais de Saída - Dados Gerais (E140NFV) (dados gerais da nota fiscal de saída).

   • Estão disponíveis para serem utilizadas como filtro apenas os campos da tabela principal de cada um dos web services;
   Cenário 1:

   Utilizado um web service que trata produto e se deseja filtrar um código do produto específico, neste caso, o where deve iniciar informando AND e conter o nome da tabela principal antes do campo, exemplo: AND E075PRO.CODPRO = '1101'.

   Cenário 2:

   Utilizado um web service que trata pedido e se deseja filtrar um número de pedido, neste caso, o where deve iniciar informando AND e conter o nome da tabela principal antes do campo, exemplo: AND E120PED.NUMPED= 767.

   Se houver necessidade, pode ser usado comandos SQL para filtrar a tabela principal com ligação entre outra tabela.

   Cenário 3:

   Utilizando um web service que trata pedido e se deseja ter um filtro mais refinado para os pedidos, utilizando a tabela de item de produto, neste caso, será necessário utilizar um comando SQL para filtrar a tabela principal de pedido, Vendas - Pedidos - Dados Gerais (E120PED), ligada com a tabela de item de produto (E120IPD), exemplo: SELECT * FROM E120PED WHERE 1=1 AND EXISTS (SELECT * FROM E120IPD WHERE E120PED.NUMPED = E120IPD.NUMPED AND E120IPD.CODPRO= '1101');

   Cenário 4:

   Utilizando um web service que trata nota fiscal de saída e se deseja filtrar notas em que o cliente seja interno, neste caso, será necessário utilizar um comando SQL para filtrar a tabela principal de nota de saída, Vendas - Notas Fiscais de Saída - Dados Gerais (E140NFV), ligada com a tabela de cliente, Cadastros - Clientes (E085CLI), exemplo: SELECT * FROM E140NFV WHERE 1=1 AND EXISTS (SELECT 1 FROM E085CLI WHERE E140NFV.CODCLI = E085CLI.CODCLI AND E085CLI.TIPMER = 'I');

   Observação

   Qualquer filtro pode ser realizado, desde que a ligação entre as tabelas seja feita de forma correta, caso contrário, o comando SELECT pode não atender a necessidade do cliente, trazendo registros indesejáveis ou não trazendo registro algum. É recomendável fazer as ligações mais completas possíveis entre as tabelas envolvidas.

Duplicando as configurações do web service

Depois que uma configuração de web service é processada, o botão Duplicar pode ser utilizado para duplicá-la para outras filiais, aumentando a eficiência da configuração.