Objetivos
Tem a função de fazer um processamento das ordens de compra gerando sugestões de pedido de compras com o intuito de juntar 1 ou mais ordens de compra em um único card/seção, essa junção é feita seguindo algumas regras especificas.(pi-process);
possuem a função de pegar os metadatas das apresentação dos dados no front-end haver com as sugestões de compra (sendo eles: list, detail e edit) (pi-metadata);
possui a função de trazer as regras de validação de fornecedores (pi-validate-fields);
possui a função de trazer as ordens de compras atrelas a uma sugestão criada pelo process (pi-query-orderlines);
possui a função de trazer os valores das sugestões que foram geradas no process (por padrão o valor é 15 mas pode ser alterado) (pi-query).
Funcionalidade
A API fornece uma série de métodos que podem ser executados individualmente para apresentação das informações da(s) sugestões de compra.
Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-process (POST) | |||||||||
---|---|---|---|---|---|---|---|---|---|
Requisito | Nenhum. | ||||||||
Sintaxe | RUN pi-process in handle (INPUT oInput, OUTPUT oOutput). | ||||||||
Descrição | Repassa o parâmetro do tipo de evento recebido pela API de comunicação (ccp/rules/ordersSuggestions) para o script de negocio (ccp/rules/ordersSuggestionsRules) chamando o método pi-process-v1. É necessário enviar um payload contendo os filtros a serem aplicados, limitando assim as ordens que serão consideradas para a geração de sugestões. A primeira coisa feita é extrair todas as ordens, aplicar os filtros definidos no payload e, em seguida, unir as ordens que compartilham características específicas para formar sugestões de compra. Uma sugestão de compra é gerada quando uma ou mais ordens seguem todos os critérios a seguir:
| ||||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||||
oInput | JsonObject | INPUT | Parâmetros para busca de ordens específicos.
| ||||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações da finalização do pre processamento.
| ||||||
Retorno | Retorna a busca dos dados da ordem escolhida ou erros ocorridos durante a busca |
pi-query (GET) | |||||||
---|---|---|---|---|---|---|---|
Requisito | Precisa primeiro executar a pi-process | ||||||
Sintaxe | RUN pi-query in handle (INPUT oInput, OUTPUT oOutput). | ||||||
Descrição | Tem a finalidade de retornar as sugestões de compra geradas pela pi-process podendo ser configurado alguns parâmetros específicos ou não através do queryParam. Repassa os parâmetro da requisição (do tipo de evento) recebido pela API de comunicação (ccp/api/v1/ordersSuggestions.p) para o script de negocio (ccp/rules/ordersSuggestionsRules.p) chamando o método pi-query-orderlines-v1. Retornando os valores das sugestões passadas pelo pathParams. | ||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||
oInput | JsonObject | INPUT | Parâmetros para busca de sugestões de compra.
| ||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações das sugestões de compra pesquisada
| ||||
HasNext | Logical | OUTPUT | indica se seguindo a paginação, possui mais resultados a serem mostrados\ | ||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||||
Retorno | Retorna a busca dos dados das sugestões de compra (seguindo os parâmetros page e pageSize) encontradas ou erros ocorridos durante a busca |
pi-query-orderlines (GET) | |||||
---|---|---|---|---|---|
Requisito | precisa primeiro ter executado a pi-process. | ||||
Sintaxe | RUN pi-query-orderlines in handle (INPUT oInput, OUTPUT oOutput). | ||||
Descrição | Pega as ordens de compra atrelados a uma sugestão de compra, gerada pela pi-process, passando os parâmetros necessários pelo pathParams e queryParams. Repassa o parâmetro do tipo de evento recebido pela API de comunicação(ccp/api/v1/ordersSuggestions.p) para o script de negocio (ccp/rules/purchaseOrderLinesV2) chamando o método pi-query-orderlines-V1. | ||||
Parâmetro | Tipo | Input/Output | Descrição | ||
oInput | JsonObject | INPUT | Parâmetros para busca das ordens de compras atreladas a uma sugestão de compra especificada.
| ||
oOutput | JsonObject | OUTPUT | Retorno contendo o as informações de todos as ordens na paginação escolhida:
| ||
lHasNext, | number | OUTPUT | Informa um valor booleano se tem ou não uma próxima pagina | ||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||
Retorno | Retorna as ordens de uma sugestão de pedido de compra ou erros ocorridos durante a busca |
pi-metadata (GET) | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Requisito | Nenhum. | ||||||||||
Sintaxe | RUN pi-metadata in handle (INPUT oInput, OUTPUT oOutput). | ||||||||||
Descrição | Repassa o parâmetro do tipo de evento recebido pela API de comunicação (ccp/api/v1/ordersSuggestions) para o script de negocio (ccp/metadata/orderSuggetionsMetadata) chamando o método pi-metadata-v1. Retorna os metadatas das apresentação dos dados do front-end haver com as sugestões de compra, retornando os valores dos metadados associados com base nos pathParams e queryParams fornecidos. | ||||||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||||||
oInput | JsonObject | INPUT | Parâmetros requisitados para busca de metadatas.
| ||||||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo os valores do metadata pesquisada
edit
| ||||||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||||||||
Retorno | Retorna a busca dos dados do metadata escolhido ou erros ocorridos durante a busca |
pi-validate-fields (POST) | |||||||
---|---|---|---|---|---|---|---|
Requisito | Nenhum. | ||||||
Sintaxe | RUN pi-validate-fields in handle (INPUT oInput, OUTPUT oOutput). | ||||||
Descrição | Faz a conferencia se o campo messageText esta preenchido corretamente levando em consideração o seu id "menssageCode", caso não, ele retornara um json com ele preenchido corretamente juntamente com os outros campos já fornecidos posteriormente. Repassa o parâmetro do tipo de evento recebido pela API de comunicação(ccp/api/v1/ordersSuggestions) para o script de negocio (ccp/rules/ordersSuggestionsRules) chamando o método pi-validate-fields-v1. Retornando os valores da ordem passada pelo pathParams. | ||||||
Parâmetro | Tipo | Input/Output | Descrição | ||||
oInput | JsonObject | INPUT | Parâmetros para busca de ordens específicos.
| ||||
oOutput | JsonObject | OUTPUT | Retorno da requisição trazendo as informações da ordem pesquisada
| ||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados. | ||||
Retorno | O payLoad com todos os campos já fornecidos e também o Campo messageText preenchido corretamente levando em consideração o seu id (mensageCode). |