Ocorrência:

Sintaxe

RUN pi-metadata-v1 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 a camada de negócio (ccp/metadata/orderSuggetionsMetadata) chamando o método pi-metadata-v1.

Retorna o metadados com os campos referentes a tela de Listagem (list), Edição (edit) ou Detalhe (detail), dependendo de qual tipo foi enviado pela requisição, para a montagem dinâmica da tela com as informações vindas do backend.

Parâmetro

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros requisitados para busca de metadados. 

• queryParams: 
  • type: Utilizando este atributo com uma das opções abaixo, permite retornar as informações de: 
    • list: Traz os metadados referentes a tabela de ordens de compra, que apresenta as ordens relacionadas a uma sugestão de pedido
    • edit: Traz os metadados referentes a tela de Gerar Pedido
    • detail: Traz os metadados referentes a tela de detalhamento da ordem
• pathParams:
  • metadata: Informar: metadata.

oOutput

JsonObject

OUTPUT

Retorno contendo o metadados com os campos conforme parâmetros recebidos:

• Metadados List

List

Descrição dos campos:

• property: Nome de referência do campo.
• width: Tamanho do campo.
• label: Rótulo do campo exibido.
• type: Tipo do valor campo.

• subtitles: Define um array de objetos para as colunas de legenda. Os campos são:
  • color: Cor que é apresentada na legenda para determinado valor.
  • tooltip: Tooltip que aparece ao colocar o mouse sobre a legenda.
  • label: Rótulo da legenda.
  • value: Valor que será usado como referência para exibição do conteúdo na coluna.
  • content: Conteúdo que será exibido na coluna da tabela.

• validateFields: Lista que define os campos que irão disparar o validate do form.
• formFields: Referente ao formulário dinâmico, que permitirá customização através de EPC.

• Metadados Edit

Edit

Descrição dos campos:

• validateFields: Lista que define os campos que irão disparar o validate do form.
• fields: São os campos a serem apresentados na tela de Gerar Pedido, tendo as seguintes propriedades:
  • gridColumns: Tamanho de exibição do campo em telas.
  • searchService: Serviço de busca usado em cada campo.
    • columns: Colunas apresentadas na tabela que é mostrada ao clicar no zoom do campo.
      • property: Nome de referência do campo.
      • label: Rótulo do campo exibido.
      • type: Tipo do valor campo.
  • gridSmColumns: Tamanho de exibição do campo em telas.
  • format: Formato de exibição do valor da coluna.
  • fieldValue: Valor da propriedade do campo.
  • advancedFilters: Array contendo os campos apresentados ao clicar na "Busca Avançada".
  • required: Indica que o campo será obrigatório.
  • rows: Quantidade de linhas exibidas nos campos "messageText" e "comments".

• Metadados Detail:

Detail

Descrição dos campos:

• businessUnityFields: Array referente a aba da tabela de Unidade de Negócio da tela de Detalhe da Ordem. Suas propriedades são:
  • property: Nome de referência do campo.
  • width: Tamanho do campo.
  • label: Rótulo do campo exibido.
  • type: Tipo do valor campo.
• detailFields: Campos apresentados no detalhe da ordem de compra.
  • gridColumns: Tamanho de exibição do campo em telas.
  • divider: Exibirá um divisor acima, utilizando o texto inserido como título.
  • property: Nome de referência do campo.
  • label: Rótulo do campo exibido.
• breadcrumb: Objeto com propriedades do breadcrumb, componente que gera uma estrutura de navegação que apresenta ao usuário a localização da URL atual, exibindo as antecessoras conforme é realizado a navegação na aplicação:
  • items: Lista de itens do breadcrumb:
    • link: Url do item.
    • label: Rótulo do item.
• contractFields: Array referente a aba de Contrato da tela de Detalhe da Ordem.
• requisitionFields: Array referente a aba contendo a tabela de Requisição da tela de Detalhe da Ordem.
• tabFields: Array contendo os campos referente a aba Complementar

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca dos dados.

Retorno

Retorna a busca dos dados do metadados escolhido ou erros ocorridos durante a busca.

Sintaxe

RUN pi-query-v1 in handle (INPUT oInput,

                                        OUTPUT oOutput).

Descrição

Executa a consulta das sugestões de pedido de compra no banco de dados, geradas pelo método pi-process e repassa os parâmetro da requisição recebido pela API de comunicação (ccp/api/v1/ordersSuggestions.p) para a camada de negócio (ccp/rules/ordersSuggestionsRules.p) chamando o método pi-query-v1. É possível filtrar a API utilizando filtros simples e complexos.

Retorna as sugestões de pedido de compra. Se houver filtro, retorna os valores filtrados.

Parâmetro

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para busca de sugestões de pedido de compra:

• queryParams:  É permitido informar filtros simples e complexos. 
  • page: Informar: numero da paginação;
  • pageSize informa a quantidade de campos que será retornado por cada paginação;

aResult

JsonArray

OUTPUT

Retorno da requisição trazendo as informações das sugestões de pedido de compra.

Descrição dos campos:

• total: Total de registros encontrados
• hasNext: Indica se tem mais páginas com registros a serem mostrados
• items: Array com os registros retornados:

• • orderType: Natureza
  • paymentTermId: Código da condição de pagamento
  • freightPaymentType: Pagamento do frete 
  • siteCode: Código do estabelecimento
  • package: Número do processo da ordem
  • totalPrice: Valor total
  • vendorId: Código do emitente
  • currencySymbol: Símbolo da moeda
  • totalPurchaseOrders: Quantidade de ordens na sugestão
  • userCode: Código do usuário
  • suggestionSequence: Sequência do card da sugestão de pedido de compra
  • paymentTermDescription: Descrição da condição do pagamento
  • processSequence: Sequência do processo criado pelo método pi-process
  • incoterm: Incoterm
  • carrierCode: Código do transportador
  • freightPrice: Valor do frete
  • vendorShortName: Nome abreviado do fornecedor
  • quotationProcessId: Código da solicitação de cotação

lHasNext

Logical

OUTPUT

aExpandables

JsonArray

OUTPUT

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca dos dados.

Retorno

Retorna a busca das sugestões de pedido de compra bem como seus dados, ou erros ocorridos durante a busca.

Sintaxe

RUN pi-query-orderlines-v1 in handle (INPUT oInput,

                                                         OUTPUT oOutput).

Descrição

Busca as ordens de compra das sugestões cadastradas na tabela de ordens da sugestão do pedido de compra (sugest-ped-comp-ordem) através de uma chave. Para montar a chave é necessário o código do usuário, sequência do processamento e sequência da sugestão (valores esses que podem ser consultados via pi-query-v1).

Repassa o parâmetro recebido pela API de comunicação (ccp/api/v1/ordersSuggestions.p) para a camada de negócio (ccp/rules/ordersSuggestionsRules.p) chamando o método pi-query-orderlines-v1.

Retorna as informações das ordens relacionadas a chave enviada por pathParam.

Parâmetro

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para busca das ordens de compras atreladas a uma sugestão de pedido de compra:

• pathParams
  • usuário: código do usuário a ser consultado.
  • process: numero do processo gerado após a execução do método "pi-process".
  • sugestão: numero do card da sugestão.
  • orderLines: endPoint atual (pi-query-orderlines-v1).
• queryParams: 
  • page: informar número da paginação (se não for especificado valor, será automaticamente 1).
  • pageSize: quantidade de campos que será retornado por paginação.

aResult

JsonArray

OUTPUT

Retorno trazendo todas as ordens atreladas ao usuário, processo e sequência enviados por pathParams.

Descrição dos campos:

• total: Total de registros encontrados
• hasNext: Indica se tem mais páginas com registros a serem mostrados
• items: Array com os registros retornados:
  • freightPaymentType: Frete
  • comments: Narrativa
  • quantity: Quantidade solicitada
  • totalPriceInDefaultCurrency: Preço total na moeda padrão
  • unitOfMeasure: Unidade de medida
  • freightPriceInDefaultCurrency: Valor do frete na moeda padrão
  • itemCode: Código do item
  • unitPriceInDefaultCurrency: Preço unitário na moeda padrão
  • userCode: Código de usuário
  • quotationValidityDate: Data validade cotação
  • firstDeliveryDate: Data primeira entrega
  • suggestOrderLineSeq: Sequência da sugestão da ordem
  • urgencyDescription: Descrição da urgência
  • urgency: Urgência
  • quotationValidityDays: Dias validade
  • suggestSeq: Sequência da sugestão
  • processSeq: Sequência do processo
  • itemDescription: Descrição do item
  • orderLineNumber: Número da ordem de compra
  • expiredQuote: Cotação expirada

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 conforme a chave, ou erros ocorridos durante a busca

RUN piValidateFields in handle (INPUT oInput,

                                                    OUTPUT oOutput).

Descrição

Valida se o campo messageText, responsável por trazer o texto da mensagem na modal de Gerar Pedido, está preenchido corretamente conforme seu campo auxiliar "messageCode" (Código de mensagem, na modal Gerar Pedido). Caso haja alguma falha no preenchimento, ele será validado e retornado preenchido corretamente em um JSON, evitando assim erro na exibição das informações.

O parâmetro é repassado pela api de comunicação (ccp/api/v1/ordersSuggestions) para a camada de negócio (ccp/rules/ordersSuggestionsRules) chamando o método piValidateFields.

Retorna o texto da mensagem enviada por payload.

Parâmetro

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para busca de ordens específicos.

• pathParams: 
  • validate: endPoint do método atual (piValidateFields)
• payload:
  • É enviado o código do campo messageCode

oOutput

JsonObject

OUTPUT

Informações do respectivo texto cadastrado para o código da mensagem enviado por payload

Descrição dos campos:

• messageText: Campo da modal Gerar Pedido que apresenta o texto cadastrado para o código da mensagem escolhido no campo "Código de mensagem"
• messageCode: Código da mensagem. Seu texto é apresentado no campo "messageText", ao lado.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a busca dos dados.

Retorno

Texto cadastrado para o código da mensagem enviado por payload, bem como o próprio código da mensagem.

Sintaxe

RUN pi-process-v1 in handle (INPUT oInput,

                                                OUTPUT oOutput).

Descrição

Realiza o processamento das sugestões de pedido, ou seja, procura as ordens de compra com campos em comum e cria os registros das tabelas sugest-ped-comp-process, sugest-ped-comp e sugest-ped-comp-ordem. Repassa os parâmetros recebidos pela API de comunicação (ccp/rules/ordersSuggestions)  para a camada de negócio (ccp/rules/ordersSuggestionsRules) chamando o método pi-process-v1.

O processamento é feito com base no que for recebido por payload. Além do payload vazio, é possível enviar nele filtros limitando assim as ordens que serão consideradas para a geração de sugestões, com base em diferentes critérios e combinações. 

Uma sugestão de compra é gerada quando uma ou mais ordens seguem todas as especificações a seguir:

• Estabelecimento: As ordens devem possuir o mesmo estabelecimento indicado.

• Emitente: O emitente das ordens precisa ser o mesmo.

• Condição de Pagamento: As ordens devem compartilhar a mesma condição de pagamento.

• Natureza: A natureza da transação deve ser idêntica entre as ordens consideradas.

• Processo: O número do processo vinculado à ordem precisa ser idêntico.

• Transportador: A empresa transportadora deve ser a mesma em todas as ordens.

• Número do Processo de Cotação: As ordens precisam possuir o mesmo número de processo de cotação.

• Incoterm: O Incoterm deve ser idêntico entre as ordens.

• Situação: A ordem deve estar como "Cotada".
• Pedido de compra: Não possuir pedido de compra atrelado a essa ordem.
• Expectativa: As ordens não podem estar como Expectativa de Compra.

Parâmetro

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para busca de ordens específicos.

• pathParams: 
  • process (endPoint do método atual).
• payload: O payload pode ter os seguintes filtros atrelados:
  • orderLineNumber: Número das ordens especificada;
  • requestNumber: Código da solicitação de compra;
  • vendorId: Código do fornecedor;
  • urgency: Numero da urgência (pode ser de 1 ate 4);
  • buyerCode: Código dos compradores;
  • siteCode: Estabelecimento;
  • quotationProcessId: Código do processo de cotação;
  • itemCode: Código do item;
  • quotationDate: Período da cotação :
    • start: Data inicial;
    • end: Data final.
  • orderDate: Data do pedido;
  • orderBy: Campo que será utilizado para a ordenação das sugestões de compra.

oOutput

JsonObject

OUTPUT

Retorno da requisição trazendo as informações da finalização do processamento.

Descrição dos campos:

• initialDatetime: Data e hora inicial do processamento
• processSequence: Sequência do processo, será atrelada as sugestões de pedido
• progressPercent: Percentual de progresso do processamento
• finalDatetime: Data e hora final do processamento
• userCode: Usuário que fez o processamento
• creationDatetime: Data da criação do processo
• status: Status do processamento, 3 significa que foi encerrado.

Retorno

Retorna os dados relacionados a criação do processamento da sugestão.