(Obrigatório)

Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

(Obrigatório)

 Objetivo 

Desenvolver Web Service para consulta de pedidos de Vendas no LOGIX com base no protocolo REST.

O Web Service irá tratar toda a regra de negócio porém não contempla interface. Ou seja, deverá ser chamado por algum aplicativo passar passando os parâmetros de entrada e receberá recebendo o retorno do processamento. A interface ficará sob responsabilidade do cliente.

(Obrigatório)

Definição da Regra de Negócio

Basicamente serão desenvolvidas duas funções 4gl, sendo uma API para trabalhar como Web Service e outra com as regras de negócios do produto.

A estrutura dos novos fontes seguirá a seguinte divisão:

 VDPR272VDPR0003.4gl – API para consulta de pedido de venda. Deve receber os parâmetros por REST, enviar para a função de consulta e retornar os dados para o requisitante. 

Função principalMétodo: vdpr272 vdpr0003_pub_get_consultaPedidoVenda()

Parâmetros de entrada:

Parâmetros de saída:

VDP90423.4gl – Consulta de pedidos externos.

          1) Criar função para pesquisa que será executada pela API vdpr272 vdpr0003 ou alguma outra função que venha a ser desenvolvida futuramente.Estrutura da função: 

                  --> Criar um cursor dinâmico, com base nos filtros informados, buscando apenas os dados da tabela "pedidos" (utilizar DISTINCT) e ordenando pelos campos empresa e pedido.

                  --> Dentro do FOREACH: adicionar a lógica de paginação; inserir os pedidos em uma temp (estrutura da temp: empresa e pedido) e armazenar os dados da tabela  "pedidos" no array para posterior retorno.

                   –> Se a pesquisa for do tipo "COMPLETA", criar novo cursor na temp para percorrer pelas empresas encontradas. Para cada empresa carregar os parâmetros e as validações de tabela utilizada. Dentro desse cursor carregar os demais dados das tabelas auxiliares, criando cursores relacionando a tabela com a temp (conforme parametrização); 

                   --> Realizar FREE de todos os cursores após uso.

                  --> Retornar Status de execução e Mensagem (erro/validação,etc) para a função chamadora;

Funções externas:

1) inicializa_variáveis() - Inicializar todos os parâmetros que são recebidos.

2) função_set() - Criar função de SET para cada campo de filtro e parâmetros que serão enviados pela função chamadora.

3) função_get()  - Criar funções de GET para os seguintes retornos:

o   Para cada campo/tabela de pedidos prevista na função

o   Status da paginação: "PENDENTE" quando utiliza paginação e não retornou todos os registros solicitados; "FINALIZADO" se conseguiu retornar todos os pedidos daquele filtro.

Obs.: Para desenvolvimento das API com protocolo REST seguir o padrão estabelecido em: http://tdn.totvs.com.br/display/public/FRAMJOI/LGX+-+Desenvolvimento+de+API 

Conceitos que não serão previstos: 

--> Integração com módulo de fluxo de caixa;
--> Conceito de Kit;
--> Integração com módulo de assistência técnica;
--> Cota de representante (Parâmetro "controla_cota");
--> Previsão de produção;

   Tabelas previstas

         Tabelas que não foram previstas