Árvore de páginas

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicomfbo/bomf308fx.p

 

Objetivo

Efetuar as rotinas relacionadas com o plano de produção do módulo de planejamento da produção.

 

Funcionamento

A API/BO...

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para a chamada da API/BO é:

run xxx/xxapinnn.p (input-output table tt-...,

                    input        table tt-...,

                    ...,

                    ...).

A execução na forma persistente ...

A sintaxe para executar a API/BO em modo persistente é:

run xxx/xxapinnn.p persistent set h-handle (input-output table tt-...,

                                            input        table tt-...,

                                            ...,

                                            ...).

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

 

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

 

Tabela Temporária

Descrição

Entrada/Saída

ttExceptionVO

Exceções

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

exceptionType

character

 

 

Não

2.08

reqNumber

integer

 

 

Não

2.08

parcel

integer

 

 

Não

2.08

initialDate

date

 

 

Não

2.08

finalDate

date

 

 

Não

2.08

repositionDate

date

 

 

Não

2.08

projectedBalance

decimal

 

 

Não

2.08

reqQuantity

decimal

 

 

Não

2.08

atrCob

integer

 

 

Não

2.08

reqType

integer

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttAnalyzeExceptionsTotalVO

Total de Exceções

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

code

character

 

 

Não

2.08

labelValue

character

 

 

Não

2.08

quantity

integer

 

 

Não

2.08

       

Tabela Temporária

Descrição

Entrada/Saída

ttAnalyzeExceptionsParamVO

Parâmetros Exceções

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

productionPlanCode

integer

 

 

Não

2.08

siteCode

character

 

 

Não

2.08

cutDate

date

 

 

Não

2.08

isProjectedDeficit

logical

 

 

Não

2.08

isBalanceLessThanSecurity

logical

 

 

Não

2.08

isBalanceMoreThanSecurity

logical

 

 

Não

2.08

isDelayConfirmedOrders

logical

 

 

Não

2.08

isDelayReleasedOrders

logical

 

 

Não

2.08

isDelayPlannedOrders

logical

 

 

Não

2.08

isReprogrammingOrders

logical

 

 

Não

2.08

isBalanceWithoutUse

logical

 

 

Não

2.08

isPurchased

logical

 

 

Não

2.08

isManufactured

logical

 

 

Não

2.08

balanceMoreThanSecurityValue

decimal

 

 

Não

2.08

itemString

character

 

 

Não

2.08

familyString

character

 

 

Não

2.08

stockGroupString

character

 

 

Não

2.08

plannerString

character

 

 

Não

2.08

productionLineString

character

 

 

Não

2.08

buyerString

character

 

 

Não

2.08

businessUnitString

character

 

 

Não

2.08

lotString

character

 

 

Não

2.08

isOrdersInsideHorizon

logical

 

 

Não

2.08

isOrderCancellation

logical

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttExceptionItemVO

Item com Exceções

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

code

character

 

 

Não

2.08

description

character

 

 

Não

2.08

unitOfMeasure

character

 

 

Não

2.08

reference

character

 

 

Não

2.08

exceptionTypes

character

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttViewSalesOrderSummaryVO

Pedido de Compra (Resumo)

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

requestUnchangedQuantity

decimal

 

 

Não

2.08

requestChangedQuantity

decimal

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttViewSalesOrderDetailVO

Detalhes Pedido de Compra

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

buyerCode

character

 

 

Não

2.08

plannerCode

character

 

 

Não

2.08

variationQuantity

decimal

 

 

Não

2.08

requisitionQuantityActual

decimal

 

 

Não

2.08

requisitionQuantityOriginal

decimal

 

 

Não

2.08

orderQuantity

decimal

 

 

Não

2.08

sequenceOrder

character

 

 

Não

2.08

orderNumber

character

 

 

Não

2.08

custumerNameCode

character

 

 

Não

2.08

vendorCode

character

 

 

Não

2.08

businessUnit

character

 

 

Não

2.08

referenceCode

character

 

 

Não

2.08

typeDocument

integer

 

 

Não

2.08

planCode

integer

 

 

Não

2.08

stockGrupCode

character

 

 

Não

2.08

typeObtaining

character

 

 

Não

2.08

itemUnitOfMeasure

character

 

 

Não

2.08

familyCode

character

 

 

Não

2.08

itemDescription

character

 

 

Não

2.08

itemCode

character

 

 

Não

2.08

parcel

integer

 

 

Não

2.08

requisitionNumber

decimal

 

 

Não

2.08

requisitionQuantity

decimal

 

 

Não

2.08

siteCode

character

 

 

Não

2.08

defaultSiteCode

character

 

 

Não

2.08

productionLineCode

character

 

 

Não

2.08

typeReportDescription

character

 

 

Não

2.08

deliveryDate

date

 

 

Não

2.08

needDate

date

 

 

Não

2.08

issueDate

date

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttPlanInfoVO

Informações do Plano

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

isMultiSite

logical

 

 

Não

2.08

lastCalculationDate

date

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttChangedPurchaseOrderDetailVO

Detalhes Ordens de Compra

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

buyerCode

character

 

 

Não

2.08

deliveryActualDate

date

 

 

Não

2.08

deliveryOriginalDate

date

 

 

Não

2.08

variationQuantity

decimal

 

 

Não

2.08

requestActualQuantity

decimal

 

 

Não

2.08

requestOriginalQuantity

decimal

 

 

Não

2.08

orderNumber

integer

 

 

Não

2.08

partPurchase

character

 

 

Não

2.08

providerCode

character

 

 

Não

2.08

businessUnit

character

 

 

Não

2.08

referenceCode

character

 

 

Não

2.08

siteItemCode

character

 

 

Não

2.08

planCode

character

 

 

Não

2.08

stockGrupCode

character

 

 

Não

2.08

typeObtaining

character

 

 

Não

2.08

unitItem

character

 

 

Não

2.08

familyCode

character

 

 

Não

2.08

descriptionItem

character

 

 

Não

2.08

itemCode

character

 

 

Não

2.08

variationDays

decimal

 

 

Não

2.08

sequenceRequest

character

 

 

Não

2.08

requestNumber

character

 

 

Não

2.08

custumerCode

character

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttViewSalesOrderParamVO

Parâmetros Pedido de Venda

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

planCode

integer

 

 

Não

2.08

initialDate

date

 

 

Não

2.08

finalDate

date

 

 

Não

2.08

initialDeliveryDate

date

 

 

Não

2.08

finalDeliveryDate

date

 

 

Não

2.08

isChangedQuantityUp

logical

 

 

Não

2.08

isChangedQuantityDown

logical

 

 

Não

2.08

plannerString

character

 

 

Não

2.08

itemString

character

 

 

Não

2.08

familyString

character

 

 

Não

2.08

stockGroupString

character

 

 

Não

2.08

siteCode

character

 

 

Não

2.08

initialNeedDate

date

 

 

Não

2.08

finalNeedDate

date

 

 

Não

2.08

customerRequestString

character

 

 

Não

2.08

requestNumberString

character

 

 

Não

2.08

       

Tabela Temporária

Descrição

Entrada/Saída

ttChangedPurchaseOrderParamVO

Parâmetros Ordens de Compra

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

planCode

integer

 

 

Não

2.08

initialDate

date

 

 

Não

2.08

finalDate

date

 

 

Não

2.08

initialDeliveryDate

date

 

 

Não

2.08

finalDeliveryDate

date

 

 

Não

2.08

isChangedQuantity

logical

 

 

Não

2.08

isChangedDate

logical

 

 

Não

2.08

plannerString

character

 

 

Não

2.08

itemString

character

 

 

Não

2.08

familyString

character

 

 

Não

2.08

stockGroupString

character

 

 

Não

2.08

siteCode

character

 

 

Não

2.08

buyerString

character

 

 

Não

2.08

providerString

character

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttChangedPurchaseOrderSummaryVO

Ordens de Compra (Resumo)

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

purchaseOrderUnchanged

decimal

 

 

Não

2.08

purchaseOrderChanged

decimal

 

 

Não

2.08

 

Métodos

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

getChangedPurchaseOrdersDetailList

Requisito

 

Sintaxe

getChangedPurchaseOrdersDetailList (input table                  

                                    ttChangedPurchaseOrderParamVO,

                                    output table

                                    ttChangedPurchaseOrderDetailVO,

                                    output table RowErrors)

Descrição

Busca detalhes das ordens.                                                  

 

Parâmetros

Descrição

 

ttChangedPurchaseOrderParamVO

Parâmetros para consulta

Retorno

ttChangedPurchaseOrderDetailVO: Dados da ordem.

RowErrors: Erros na execução da função.

getChangedPurchaseOrdersSummary

Requisito

 

Sintaxe

getChangedPurchaseOrdersSummary (input table                  

                                 ttChangedPurchaseOrderParamVO,

                                 output table

                                 ttChangedPurchaseOrderSummaryVO,

                                 output table RowErrors)

Descrição

Busca detalhes em resumo das ordens                                  

 

Parâmetros

Descrição

 

ttChangedPurchaseOrderParamVO

Parâmetros para consulta

Retorno

ttChangedPurchaseOrderSummaryVO: Dados em resumo da ordem.

RowErrors: Erros na execução da função.

getChangedSummary

Requisito

 

Sintaxe

getChangedSummary (input  table ttViewSalesOrderParamVO,

                   output table ttViewSalesOrderSummaryVO,

                   output table RowErrors)

Descrição

Busca de ordens de compras alteradas.

 

Parâmetros

Descrição

 

ttViewSalesOrderParamVO

Parâmetros para consulta

Retorno

ttViewSalesOrderSummaryVO: Ordens de compra alteradas.

RowErrors: Erros na execução da função.

getDetailList

Requisito

 

Sintaxe

getDetailList (input  table ttViewSalesOrderParamVO,

               output table ttViewSalesOrderDetailVO,

               output table RowErrors)

Descrição

Busca detalhes das ordens de compras alteradas.

 

Parâmetros

Descrição

 

ttViewSalesOrderParamVO

Parâmetros para consulta

Retorno

ttViewSalesOrderDetailVO: Detalhes das ordens de compras.

RowErrors: Erros na execução da função.

getExceptionItems

Requisito

 

Sintaxe

getExceptionItems (input  table ttAnalyzeExceptionsParamVO,

                   input  exceptionType,

                   output table ttExceptionItemVO,

                   output table RowErrors)

Descrição

Busca itens com exceções.

 

Parâmetros

Descrição

 

ttAnalyzeExceptionsParamVO

Parâmetros para consulta

 

exceptionType

Tipo de exceção

Retorno

ttExceptionItemVO: Itens com exceções.

RowErrors: Erros na execução da função.

getExceptionsOfItem

Requisito

 

Sintaxe

getExceptionsOfItem (input  table ttAnalyzeExceptionsParamVO,

                     input  itemCode,

                     input  referenceCode,

                     output table ttExceptionVO,

                     output table RowErrors)

Descrição

Busca exceções dos itens.

 

Parâmetros

Descrição

 

ttAnalyzeExceptionsParamVO

Parâmetros para consulta

 

itemCode

Código do item.

 

referenceCode

Código da referencia.

Retorno

ttExceptionVO: Exceções.

RowErrors: Erros na execução da função.

getPlanInfo

Requisito

 

Sintaxe

getPlanInfo (input  planCode,

             output table ttPlanInfoVO,

             output table RowErrors)

Descrição

Busca informações do plano.

 

Parâmetros

Descrição

 

planCode

Código do plano.

Retorno

ttPlanInfoVO: Informações do plano.

RowErrors: Erros na execução da função.