Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicodocapi/vcapi006.p


Objetivo

Fazer e retornar a comparação entre:

  • Configuração Custo (Custo da Configuração já calculado)
  • Configuração Preço Venda (Preço de Venda calculado na Configuração)
  • Produção Real(com base nos movimentos)
  • Produção Previsto(com base nas reservas da Ordem e na parametrização das operações, preparação, preço do item:  base, batch, etc)
  • Pedido(Valor do Pedido)

Relações possíveis:

Valor Base de Comparação

X

Valor a ser Comparado

Configuração Custo

X

Configuração Preço Venda

Configuração Custo

X

Produção Real

Configuração Custo

X

Produção Previsto

Configuração Custo

X

Pedido

Configuração Preço Venda

X

Configuração Custo

Configuração Preço Venda

X

Produção Real

Configuração Preço Venda

X

Produção Previsto

Configuração Preço Venda

X

Pedido

Produção Real

X

Configuração Custo

Produção Real

X

Configuração Preço Venda

Produção Real

X

Produção Previsto

Produção Real

X

Pedido

Produção Previsto

X

Configuração Custo

Produção Previsto

X

Configuração Preço Venda

Produção Previsto

X

Produção Real

Produção Previsto

X

Pedido

Pedido

X

Configuração Custo

Pedido

X

Configuração Preço Venda

Pedido

X

Produção Real

Pedido

X

Produção Previsto

 

A ordem da seleção é importante, pois ela é quem define a variação sobre qual valor. No caso a primeira parcela selecionada da esquerda para direita será a referência de variação tomada.

Ex.:

Valor

Tipo Parcela

10,00

Configuração Custo

11,00

Produção Real

9,00

Pedido

 

A x B

Usando a Regra de Três:   

A – 100%

B – X%

Na fórmula abaixo foi acrescentado o -1, para calcular apenas a diferença (variação) entre os valores.

 

Configuração Custo X Produção Real

((11/10) – 1)* 100 = 10%

Assim a leitura que se faz na interpretação das informações é que a Variação da Produção frente a Configuração, foi de 10% positivos. No gráfico abaixo, esta configuração estaria na quarta coluna, dentro da variação de 10% positivos.

 

Se a comparação fosse ao contrário:

Produção Real X Configuração Custo

((10/11) – 1) * 100 = -9,09 %

Assim a leitura seria: a Variação da Configuração frente a Produção, foi de aproximadamente 9,1% negativos.

Principais Características

Esta API pode ser utilizada de duas formas diferentes:

  • A primeira forma (forma padrão) é a execução direta (“não-persistente”) da API, passando-se por parâmetro – os dados necessários referentes à execução.
  • A segunda forma de utilização da API é a execução “persistente”. Neste caso, estarão disponíveis algumas opções adicionais referentes à execução da comparação.

 

Funcionamento

 

  • Execução Direta

A sintaxe para a execução na modalidade Direta (“não-persistente”) da API é a seguinte:

run vcp/vcapi006.p (INPUT TABLE ttConfigPortletVO,

                    OUTPUT TABLE ttPortletSummaryCompareVO,

                    OUTPUT TABLE ttConfigProdSalesCompareVO,

                    OUTPUT TABLE RowErrors).

Parâmetros

Descrição

ttConfigPortletVO

Temp-table de configuração do Portlet. Trás todos os dados do filtro.

ttPortletSummaryCompareVO

Temp-table com as faixas criadas para a exibição no portlet.

ttConfigProdSalesCompareVO

Temp-table com todas as configurações e comparações retornadas na faixa.

RowErrors

Temp-table de retorno de erros gerados na execução.


  • Execução Persistente

A sintaxe para a execução na modalidade Persistente da API é a seguinte:

run vcp/vcapi006.p persistent set hvcapi006 (INPUT  table ttConfigPortletVO,

                                          OUTPUT table ttPortletSummaryCompareVO,

                                          OUTPUT table ttConfigProdSalesCompareVO,

                                          OUTPUT TABLE RowErrors).

 

Parâmetros

Descrição

ttConfigPortletVO

Temp-table de configuração do Portlet. Trás todos os dados do filtro.

ttPortletSummaryCompareVO

Temp-table com as faixas criadas para a exibição no portlet.

ttConfigProdSalesCompareVO

Temp-table com todas as configurações e comparações retornadas na faixa.

RowErrors

Temp-table de retorno de erros gerados na execução.

 

Os parâmetros de entrada e saída são idênticos nas duas formas de execução (persistente e não-persistente). A diferença básica é que, na execução persistente, a efetivação da Análise do Valor do Configurado se dará mediante a execução do método piInicializaParametros, o qual permite informar alguns parâmetros adicionais. O método piInicializaParametros é explicado adiante.


Características Gerais

A API pode executar vinte e cinco diferentes comparações, resultantes das combinações dos cinco seguintes itens:

            Custo Configuração, Preço de Venda da Configuração, Produção Real, Produção Previsto, Pedido.

-                      Custo Configuração

-                      Preço de Venda da Configuração

-                      Produção Real

-                      Produção Previsto

-                      Pedido

Tabelas Temporárias

Para comunicação com os métodos da API, as seguintes temp-tables são utilizadas:

 

Tabela Temporária

Descrição

Entrada/Saída

ttConfigPortletVO

Temp-table de configuração do Portlet. Trás todos os dados do filtro.

Entrada

Atributo

Tipo

Descrição

isFx

logical

Parâmetro que identifica o chamador (se é o Flex ou não)

confConfiguration

character

Filtro de Configuração

inicialRequestDeliveryDate

date

Data Inicial da Entrega

finalRequestDeliveryDate

date

Data Final da Entrega

isRequestSitSuspended

logical

Requisição Suspensa

isRequestSitPending

logical

Requisição Pendente

isRequestSitAttendedTotal

logical

Requisição Atendida Total

isRequestSitAttendedPart

logical

Requisição Atendida Parcial

isRequestSitOpen

logical

Requisição Aberta

isRequestSitBilledBalcony

logical

Requisição Paga no Balcão

isStateOrderSeparate

logical

Ordem Separada

isStateOrderFinalized

logical

Ordem Finalizada

isStateOrderStarted

logical

Ordem Iniciada

isStateOrderRequired

logical

Ordem Requisitada

isStateOrderClosed

logical

Ordem Fechada

isStateOrderAllocated

logical

Ordem Alocada

isStateOrderNotStarted

logical

Ordem Não-Iniciada

isStateOrderReleased

logical

Ordem Liberada

initialOrderStartDate

date

Faixa Inicial Data Início Ordem

initialOrderEndDate

date

Faixa Inicial Data Final  Ordem

finalOrderStartDate

date

Faixa Final Data Início Ordem

isConfSitReleased

logical

Configuração Liberada

isConfSitSuspended

logical

Configuração Suspensa

isConfSitRoadmapApproved

logical

Roteiro Aprovado

isConfSitOpen

logical

Configuração Aberta

initialConfDate

date

Data Início Configuração

initialViewVariation

integer

Variação para visualização inicial

isCompareHideIntervalNotInf

logical

Esconder intervalos sem informação

finalViewVariation

integer

Variação para visualização final

viewInterval

integer

Intervalo de variação

finalConfDate

date

Data Final Configuração

isConfSitStructuredApproved

logical

Configuração Estrutura Aprovada

finalOrderEndDate

date

Faixa Final Data Final Ordem

orderProductionLine

character

Filtro Linha de Produção da Ordem

orderNumber

character

Filtro Número de Ordem

requestNumberCustomer

character

Filtro Número Pedido Cliente

requestCustomer

character

Filtro Cliente Requisição

confModel

character

Filtro Modelo

orderSetConsEstabChildItem

logical

Considerar Estabelecimento Item Filho

orderSetConsEconomicLot

logical

Considerar Lote Econômico

orderSetCourtDateStructure

date

Data de Corte Estrutura

orderSetCourtDateOperation

date

Data de Corte Operação

orderSetPreparationCost

integer

Custo de Preparação

orderSetCurrency

integer

Moeda

orderSetTypeOperationCost

integer

Custo de Operação

orderSetTypeEstablishment

character

Tipo de Estabelecimento

orderSetTypeItemPrice

integer

Tipo de Preço Item

comparePlotsBasePlots

integer

Primeira opção de comparação

comparePlotsPlotToCompare

integer

Segunda opção de comparação

paramBusinessUnit

character

Filtro Unidade de Negócio

paramFamily

character

Filtro Família

paramItem

character

Filtro Item

paramEstablishment

character

Filtro Estabelecimento

isRequestSitCanceled

logical

Requisição Cancelada

isConfSitStrutureRoadmapApproved

logical

Configuração Roteiro Aprovada

initialCompareRange

integer

Faixa de comparação inicial

finalCompareRange

integer

Faixa de comparação final

orderSetConsWaste

logical

Considerar Refugo

orderSetRatesStartLastLevel

logical

Preço a partir do último nível

negativeRange

integer

Envia se é faixa negativa ou não

Tabela Temporária

Descrição

Entrada/Saída

ttPortletSummaryCompareVO

Temp-table com as faixas criadas para a exibição no portlet.

Saída

 

 

  

Tabela Temporária

Descrição

Entrada/Saída

ttConfigProdSalesCompareVO

Temp-table com todas as configurações e comparações retornadas na faixa.

Saída

  

 

Atributo

Tipo

Descrição

range

character

Faixa de Variação

quantity

integer

Quantidade de Configurações

majorVariation

character

Maior Variação

minorVariation

character

Menor Variação

rangeInitial

integer

Variação Inicial

rangeFinal

integer

Variação Final

negativeRange

logical

Se a faixa é negativa ou não

Atributo

Tipo

Descrição

difValuesTrueXTotalCost

decimal

Diferença Valores Real X Custo Total

difPercentTrueXTotalCost

decimal

Diferença Porcentagem Real X Custo Total

difValuesTrueXSimulated

decimal

Diferença Valores Real X Simulado

difPercentualTrueXSimulated

decimal

Diferença Porcentagem Real X Simulado

difValuesTrueXSalesPrice

decimal

Diferença Valores Real X Preço de Venda

difPercentTrueXSalesPrice

decimal

Diferença Porcentagem Real X Preço de Venda

difValuesSimulatedXSalesPrice

decimal

Diferença Valores Simulado X Preço de Venda

difPercentSimulatedXSalesPrice

decimal

Diferença Porcentagem Simulado X Preço de Venda

difValuesTotalCostXSalesPrice

decimal

Diferença Valores Custo Total X Preço de Venda

difPercentTotalCostXSalesPrice

decimal

Diferença Porcentagem Custo Total X Preço de Venda

difValuesSalesPriceXTotalCost

decimal

Diferença Valores Preço de Venda X Custo Total

difPercentSalesPriceXTotalCost

decimal

Diferença Porcentagem Preço de Venda X Custo Total

difValuesSalesPriceXSimulated

decimal

Diferença Valores Preço de Venda X Simulado

difPercentSalesPriceXSimulated

decimal

Diferença Porcentagem Preço de Venda X Simulado

difValuesSimulatedXTotalCost

decimal

Diferença Valores Simulado X Custo Total

difPercentSimulatedXTotalCost

decimal

Diferença Porcentagem Simulado X Custo Total

difPercentRequestXSalesPrice

decimal

Diferença Porcentagem Pedido X Preço de Venda

difValuesRequestXSalesPrice

decimal

Diferença Valores Pedido X Preço de Venda

difPercentRequestXSimulated

decimal

Diferença Porcentagem Pedido X Simulado

difValuesRequestXSimulated

decimal

Diferença Valores Pedido X Simulado

difPercentRequestXTotalCost

decimal

Diferença Porcentagem Pedido X Custo Total

difValuesRequestXTotalCost

decimal

Diferença Valores Pedido X Custo Total

difValuesTotalCostXSimulated

decimal

Diferença Valores Custo Total X Simulado

difPercentTotalCostXSimulated

decimal

Diferença Porcentagem Custo Total X Simulado

difPercentTrueXEstimated

decimal

Diferença Porcentagem Real X Previsto

difPercentTrueXRequest

decimal

Diferença Porcentagem Real X Pedido

difValuesEstimatedXSalesPrice

decimal

Diferença Valores Previsto X Preço de Venda

difValuesEstimatedXTotalCost

decimal

Diferença Valores Previsto X Custo Total

difValuesEstimatedXSimulated

decimal

Diferença Valores Previsto X Simulado

difPercentEstimatedXSalesPrice

decimal

Diferença Porcentagem Previsto X Preço de Venda

difPercentEstimatedXSimulated

decimal

Diferença Porcentagem Previsto X Simulado

difPercentEstimatedXTotalCost

decimal

Diferença Porcentagem Previsto X Custo Total

difValuesRequestXTrue

decimal

Diferença Valores Pedido  X Real

difValuesRequestXEstimated

decimal

Diferença Valores Pedido X Previsto

difPercentEstimatedXRequest

decimal

Diferença Porcentagem Previsto X Pedido

difPercentRequestXEstimated

decimal

Diferença Porcentagem Pedido X Previsto

difPercentRequestXTrue

decimal

Diferença Porcentagem Pedido X Real

difPercentEstimatedXTrue

decimal

Diferença Porcentagem Previsto X Real

difPercentTotalCostXEstimated

decimal

Diferença Porcentagem Custo Total X Previsto

difPercentTotalCostXRequest

decimal

Diferença Porcentagem Custo Total X Pedido

difPercentTotalCostXTrue

decimal

Diferença Porcentagem Custo Total X Real

difValuesTrueXEstimated

decimal

Diferença Valores Real X Previsto

difValuesEstimatedXTrue

decimal

Diferença Valores Previsto  X Real

difValuesEstimatedXRequest

decimal

Diferença Valores Previsto X Pedido

difValuesTrueXRequest

decimal

Diferença Valores Real X Pedido

codeItem

character

Código do Item

numberConfiguration

integer

Número Configuração

difPercentSimulatedXTrue

decimal

Diferença Porcentagem Simulado X Real

difPercentSimulatedXRequest

decimal

Diferença Porcentagem Simulado X Pedido

difPercentSimulatedXEstimated

decimal

Diferença Porcentagem Simulado X Previsto

difPercentSalesPriceXRequest

decimal

Diferença Porcentagem Preço de Venda X Pedido

difPercentSalesPriceXTrue

decimal

Diferença Porcentagem Preço de Venda X Real

numberOrder

integer

Número da Ordem

quantityOrder

decimal

Quantidade da Ordem

dateOrder

date

Data da Ordem

quantityRequest

decimal

Quantidade Pedido

dateRequestDelivery

date

Data de Entrega Pedido

valuesTrueOrder

decimal

Valor Real Ordem

valuesEstimated

decimal

Valor Previsto

valuesRequest

decimal

Valor Pedido

difValuesTotalCostXTrue

decimal

Diferença Valores Custo Total  X Real

difValuesTotalCostXRequest

decimal

Diferença Valores Custo Total X Pedido

difValuesTotalCostXEstimated

decimal

Diferença Valores Custo Total  X Previsto

difValuesSalesPriceXTrue

decimal

Diferença Valores Preço de Venda X Real

difValuesSalesPriceXRequest

decimal

Diferença Valores Preço de Venda X Pedido

difValuesSalesPriceXEstimated

decimal

Diferença Valores Preço de Venda X Previsto

difValuesSimulatedXRequest

decimal

Diferença Valores Simulado X Pedido

difValuesSimulatedXEstimated

decimal

Diferença Valores Simulado X Previsto

difValuesSimulatedXTrue

decimal

Diferença Valores Simulado X Real

numberRequestSequency

integer

Sequência Pedido

difPercentSalesPriceXEstimated

decimal

Diferença Porcentagem Preço de Venda X Previsto

numberRequestCustomer

character

Número Pedido Cliente

codeCustomerRequest

character

Código Cliente

salesPriceXSimulatedValue

decimal

Preço de Venda x Valor Simulado

salesPriceXTotalCost

decimal

Preço de Venda x Custo Total

simulatedValueXSalesPrice

decimal

Valor Simulado X Preço de Venda

simulatedValueXTotalCost

decimal

Valor Simulado X Custo Total

totalCostXSalesPrice

decimal

Custo Total X Preço de Venda

totalCostXSimulatedValue

decimal

Custo Total X Valor Simulado

simulatedValue

decimal

Valor Simulado

salesPrice

decimal

Preço de Venda

totalCost

decimal

Custo Total

difPercentTrueXSimulated

decimal

Diferença Porcentagem Real X Simulado

Tabela Temporária

Descrição

Entrada/Saída

rowErrors

Utilizada como saída alternativa dos erros gerados na execução da API. Sua definição encontra-se na include method/dbotterr.i. Obs.: Somente pode ser utilizada a rowErrors para saída dos erros da API quando fazendo a execução no modo persistente, e mediante o ajuste de um parâmetro específico. Mais detalhes estão descritos no detalhamento do método setaGeraRowErrors.

Saída

Atributo

Tipo

Descrição

ErrorSequence

integer

Seqüência do erro

ErrorNumber

integer

Número do erro

ErrorDescription

char

Descrição do erro

ErrorParameters

char

Parâmetros passados para criar mensagem

ErrorType

char

Tipo do erro. WARNING: Aviso; ERROR: Erro

ErrorHelp

char

Texto de ajuda do erro

ErrorSubType

char

Sub Tipo da mensagem de erro

 

Métodos

Desta forma, seguem as instruções para utilização dos métodos disponíveis.

piInicializaParametros

Requisito

Nenhum

Sintaxe

run piInicializaParametros in h-handle (input table ttConfigPortletVO).

Descrição

Inicializa os parâmetros na API, passando os dados necessários para execução.

 

Parâmetros

Descrição

 

ttConfigPortletVO

Temp-table com os dados (filtros) necessários para a execução da Análise.

Retorno

Não há.

piRetornaValores

Requisito

Nenhum

Sintaxe

run piRetornaValores in h-handle (input table ttConfigPortletVO,
                              input p-item-cotacao,

                              input p-nr-estrut,

                              input p-nr-ord-produ,

                              input p-Ordem-Prev,

                              input p-Ordem-real,

                              input p-nome-abrev,

                              input p-nr-pedcli,

                              input p-sequencia,

                              input p-base-1,

                              input p-base-2)

Descrição

Passados os parâmetros necessários para a execução dos valores, popula a temp-table persistente com os valores e comparações das ordens/pedidos passados.

 

Parâmetros

Descrição

 

ttConfigPortletVO

Temp-table com os dados (filtros) necessários para a execução da Análise.

 

p-item-cotacao

Código do Item

 

p-nr-estrut

Número Estrutura

 

p-nr-ord-produ

Número Ordem

 

p-Ordem-Prev

Ordem Prevista

 

p-Ordem-real

Ordem Real

 

p-nome-abrev

Nome abreviado cliente

 

p-nr-pedcli

Número Pedido Cliente

 

p-sequencia

Sequência Pedido

 

p-base-1

Primeiro valor a ser comparado

 

p-base-2

Segundo valor a ser comparado

Retorno

Não há.

piDesceOrdemReal

Requisito

Nenhum

Sintaxe

run piDesceOrdemReal in h-handle (input p-nr-ord-produ,

                                  output de-valor-real).

Descrição

Desce até o último nível a ordem recursivamente, e retorna a somatória dos valores reais.

 

Parâmetros

Descrição

 

p-nr-ord-produ

Número da Ordem de Produção

 

de-valor-real

Valor Real obtido pela consulta

Retorno

Não há.

piDesceOrdemConfigurada

Requisito

Nenhum

Sintaxe

run piDesceOrdemConfigurada in h-handle (input p-nr-ord-produ,

                                         output de-valor-previsto).

Descrição

Desce até o último nível a ordem recursivamente, e retorna a somatória dos valores previstos.

 

Parâmetros

Descrição

 

p-nr-ord-produ

Número da Ordem de Produção

 

de-valor-previsto

Valor Previsto obtido pela consulta

Retorno

Não há.

piProcessaOrdens

Requisito

Nenhum

Sintaxe

run piProcessaOrdens in h-handle (input pNrOrdProdu,

                                  output pValorReal).

Descrição

Calcula o valor real, referente à ordem passada por parâmetro.

 

Parâmetros

Descrição

 

pNrOrdProdu

Número da Ordem de Produção

 

pValorReal

Valor Real obtido pela consulta

Retorno

Não há.

piPrevistoOrdem

Requisito

Nenhum

Sintaxe

run piPrevistoOrdem in h-handle (input p-nr-ord-produ,

                                  output p-valor-previsto).

Descrição

Calcula o valor previsto, referente à ordem passada por parâmetro.

 

Parâmetros

Descrição

 

p-nr-ord-produ

Número da Ordem de Produção

 

p-valor-previsto

Valor Previsto obtido pela consulta

Retorno

Não há.

piRetornaPrevOper

Requisito

Nenhum

Sintaxe

run piRetornaPrevOper in h-handle (input p-rowid-Oper,

                                  output p-Valor-Oper).

Descrição

Calcula o valor previsto da operação, referente à operação (rowid) passada por parâmetro.

 

Parâmetros

Descrição

 

p-rowid-Oper

Rowid da Operação

 

p-Valor-Oper

Retorno valor da Operação

Retorno

Não há.

piRetornaPrevReserva

Requisito

Nenhum

Sintaxe

run piRetornaPrevReserva in h-handle (input p-it-codigo,

                                      input p-cod-estabel,

                                      output p-unit-item).

 

Parâmetros

Descrição

 

p-it-codigo

Código do Item

 

p-cod-estabel

Código do Estabelecimento

 

p-unit-item

Valor unitário corrigido para reserva

Retorno

Não há.

pi-gera-est-config-filho

Requisito

Nenhum

Sintaxe

run pi-gera-est-config-filho in h-handle (input p-item-cotacao,

                                      input p-nr-estrut,

                                      input p-quantidade,

                                      input p-nivel,

                                      input p-da-data-corte,

                                      input p-nr-ord-produ,
                                      input-output table tt-estrutura).

Descrição

Retorna a estrutura (cot-estrut) filha da configuração. Responsável pela montagem da árvore do Simular Preço.

 

Parâmetros

Descrição

 

p-item-cotacao

Código do Item

 

p-nr-estrut

Número da Estrutura

 

p-quantidade

Quantidade

 

p-nivel

Nível

 

p-da-data-corte

Data de Corte

 

p-nr-ord-produ

Número da Ordem de Produção

 

tt-estrutura

Temp-table representando a estrutura

Retorno

Não há.

pi-gera-ordem-filho

Requisito

Nenhum

Sintaxe

run pi-gera-ordem-filho in h-handle (input p-nivel,

                                      input p-da-data-corte,

                                      input p-quantidade,

                                      input p-nr-ord-produ,
                                      input-output table tt-estrutura).

Descrição

Retorna a estrutura (al-res-op e reservas) filhas da ordem. Responsável pela montagem da árvore do Detalhe da Estrutura.

 

Parâmetros

Descrição

 

p-nivel

Nível

 

p-da-data-corte

Data de Corte

 

p-quantidade

Quantidade

 

p-nr-ord-produ

Número da Ordem de Produção

 

tt-estrutura

Temp-table representando a estrutura

Retorno

Não há.

pi-gera-estrutura-filho

Requisito

Nenhum

Sintaxe

run pi-gera-estrutura-filho in h-handle (input p-item-cotacao,

                                      input p-refer,

                                      input p-quantidade,

                                      input p-nivel,

                                      input p-da-data-corte,

                                      input p-nr-ord-produ,
                                      input-output table tt-estrutura).

Descrição

Retorna a estrutura (estrutura) filha da item. Responsável por montar a estrutura do item no simular preço quando ele não é um item configurado.

 

Parâmetros

Descrição

 

p-item-cotacao

Código do Item

 

p-refer

Retorna a referência do Item

 

p-quantidade

Quantidade

 

p-nivel

Nível

 

p-da-data-corte

Data de Corte

 

p-nr-ord-produ

Número da Ordem de Produção

 

tt-estrutura

Temp-table representando a estrutura

Retorno

Não há.

pi-item-configurado

Requisito

Nenhum

Sintaxe

run pi-item-configurado in h-handle (input table ttInputConfigurado,

                                input p-base,

                                input p-comparado,

                                output table ttConfigProdSalesCompleteVO,

                                output table ttReturnConfigurado).

Descrição

Retorna os itens configurados (correção dos valores) do que é passado pelo ttInputConfigurado.

 

Parâmetros

Descrição

 

ttInputConfigurado

Temp-table com os itens configurados.

 

p-base

Primeiro valor a ser comparado

 

p-comparado

Segundo valor a ser comparado

 

ttConfigProdSalesCompleteVO

Temp-table com os dados comparados (analisados), já com as diferenças de porcentagem do Valor do Configurado.

 

ttReturnConfigurado

Temp-table com os itens configurados (corrigidos).

Retorno

Não há.