Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicomrbo/bomr005fx.p

 

Objetivo

Efetua 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

ttDemonstrativeItemDetailVO

Detalhes Item Demonstrativo

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

initialBalance

decimal

 

 

Não

2.08

typeRefueling

character

 

 

Não

2.08

ressuplyQuantity

decimal

 

 

Não

2.08

prioritySite

character

 

 

Não

2.08

securityTime

integer

 

 

Não

2.08

scrapPercent

decimal

 

 

Não

2.08

multipleLot

decimal

 

 

Não

2.08

economicLot

decimal

 

 

Não

2.08

minimumLot

decimal

 

 

Não

2.08

typePolitics

character

 

 

Não

2.08

fixedPeriod

integer

 

 

Não

2.08

typeObtaining

character

 

 

Não

2.08

ressuplyProvider

integer

 

 

Não

2.08

ressuplyPurchase

integer

 

 

Não

2.08

ressuplyCqManufactured

integer

 

 

Não

2.08

ressuplyManufactured

integer

 

 

Não

2.08

ressuplyCq

integer

 

 

Não

2.08

repositionPoint

decimal

 

 

Não

2.08

lossQuantity

decimal

 

 

Não

2.08

typeIssueOrder

character

 

 

Não

2.08

fixedHorizonDays

integer

 

 

Não

2.08

releaseHorizon

integer

 

 

Não

2.08

securityQuantity

decimal

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttDemonstrativePeriodVO / ttDemonstrativePeriodVO2

Demonstrativo Período

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

periodString

character

 

 

Não

2.08

periodNumber

integer

 

 

Não

2.08

periodYear

integer

 

 

Não

2.08

compromisedOrders

decimal

 

 

Não

2.08

plannedOrders

decimal

 

 

Não

2.08

reservedCompromised

decimal

 

 

Não

2.08

reservedPlanned

decimal

 

 

Não

2.08

requisitions

decimal

 

 

Não

2.08

quantities

decimal

 

 

Não

2.08

repositionPointQuantity

decimal

 

 

Não

2.08

projection

decimal

 

 

Não

2.08

coverageDays

integer

 

 

Não

2.08

availableField

decimal

 

 

Não

2.08

simulation

decimal

 

 

Não

2.08

ordersNumber

integer

 

 

Não

2.08

initialDate

date

 

 

Não

2.08

finalDate

date

 

 

Não

2.08

scrapValue

decimal

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttDemonstrativeInfoDetailVO

Info Detalhes Demonstrativo

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

requisition

integer

 

 

Não

2.08

lot

character

 

 

Não

2.08

quantity

decimal

 

 

Não

2.08

conclusion

date

 

 

Não

2.08

statusCode

character

 

 

Não

2.08

parcel

integer

 

 

Não

2.08

reqType

integer

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttDemonstrativeDetailVO

Detalhes Demonstrativo

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

detailString

character

 

 

Não

2.08

sourceItem

character

 

 

Não

2.08

kindSource

character

 

 

Não

2.08

requisition

integer

 

 

Não

2.08

icon

character

 

 

Não

2.08

indexId

character

 

 

Não

2.08

parentIndexId

character

 

 

Não

2.08

indexNumber

integer

 

 

Não

2.08

itemCode

character

 

 

Não

2.08

quantity

decimal

 

 

Não

2.08

unitOfMeasure

character

 

 

Não

2.08

shortName

character

 

 

Não

2.08

customerRequest

character

 

 

Não

2.08

dataType

character

 

 

Não

2.08

sequence

integer

 

 

Não

2.08

delivery

decimal

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttDemonstrativeMessageVO

Mensagem Demonstrativo

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

planCode

integer

 

 

Não

2.08

commentDate

date

 

 

Não

2.08

userCode

character

 

 

Não

2.08

periodString

character

 

 

Não

2.08

comment

character

 

 

Não

2.08

itemCode

character

 

 

Não

2.08

siteCode

character

 

 

Não

2.08

referenceCode

character

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttDemonstrativeExportVO

Exportação Demonstrativo

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

itemCode

character

 

 

Não

2.08

itemDescription

character

 

 

Não

2.08

reference

character

 

 

Não

2.08

family

character

 

 

Não

2.08

periodString

character

 

 

Não

2.08

periodNumber

integer

 

 

Não

2.08

periodYear

integer

 

 

Não

2.08

compromisedOrders

decimal

 

 

Não

2.08

plannedOrders

decimal

 

 

Não

2.08

reservedCompromised

decimal

 

 

Não

2.08

reservedPlanned

decimal

 

 

Não

2.08

requisitions

decimal

 

 

Não

2.08

quantities

decimal

 

 

Não

2.08

repositionPointQuantity

decimal

 

 

Não

2.08

projection

decimal

 

 

Não

2.08

coverageDays

integer

 

 

Não

2.08

availableField

decimal

 

 

Não

2.08

ordersNumber

integer

 

 

Não

2.08

initialDate

date

 

 

Não

2.08

finalDate

date

 

 

Não

2.08

initialBalance

decimal

 

 

Não

2.08

typeRefueling

character

 

 

Não

2.08

ressuplyQuantity

decimal

 

 

Não

2.08

prioritySite

character

 

 

Não

2.08

securityTime

integer

 

 

Não

2.08

scrapPercent

decimal

 

 

Não

2.08

multipleLot

decimal

 

 

Não

2.08

economicLot

decimal

 

 

Não

2.08

minimumLot

decimal

 

 

Não

2.08

typePolitics

character

 

 

Não

2.08

fixedPeriod

integer

 

 

Não

2.08

typeObtaining

character

 

 

Não

2.08

ressuplyProvider

integer

 

 

Não

2.08

ressuplyPurchase

integer

 

 

Não

2.08

ressuplyCqManufactured

integer

 

 

Não

2.08

ressuplyManufactured

integer

 

 

Não

2.08

ressuplyCq

integer

 

 

Não

2.08

repositionPoint

decimal

 

 

Não

2.08

lossQuantity

decimal

 

 

Não

2.08

typeIssueOrder

character

 

 

Não

2.08

fixedHorizonDays

integer

 

 

Não

2.08

releaseHorizon

integer

 

 

Não

2.08

securityQuantity

decimal

 

 

Não

2.08

planCode

integer

 

 

Não

2.08

parentItem

character

 

 

Não

2.08

shortName

character

 

 

Não

2.08

changedOrders

logical

 

 

Não

2.08

changedInventory

logical

 

 

Não

2.08

changedItems

logical

 

 

Não

2.08

changedPlan

logical

 

 

Não

2.08

parentQuantity

decimal

 

 

Não

2.08

finishedQuantity

decimal

 

 

Não

2.08

finishedItem

character

 

 

Não

2.08

sequence

integer

 

 

Não

2.08

balance

decimal

 

 

Não

2.08

unitOfMeasureCode

character

 

 

Não

2.08

inventoryGroup

character

 

 

Não

2.08

defaultSite

character

 

 

Não

2.08

ressuply

integer

 

 

Não

2.08

typeOrderEmission

character

 

 

Não

2.08

calculationKind

character

 

 

Não

2.08

kindSource

character

 

 

Não

2.08

delivery

decimal

 

 

Não

2.08

previewPlannedQuantity

decimal

 

 

Não

2.08

orders

decimal

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttDemonstrativeParamVO

Parâmetros Demonstrativos

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

planCode

integer

 

 

Não

2.08

siteCode

character

 

 

Não

2.08

familyString

character

 

 

Não

2.08

itemString

character

 

 

Não

2.08

stockGroupString

character

 

 

Não

2.08

plannerString

character

 

 

Não

2.08

buyerString

character

 

 

Não

2.08

productionLineString

character

 

 

Não

2.08

customerRequestString

character

 

 

Não

2.08

initialEmitDate

date

 

 

Não

2.08

finalEmitDate

date

 

 

Não

2.08

initialDeliveryDate

date

 

 

Não

2.08

finalDeliveryDate

date

 

 

Não

2.08

initialIntervalDate

date

 

 

Não

2.08

finalIntervalDate

date

 

 

Não

2.08

isPurchasedItem

logical

 

 

Não

2.08

isManufacturedItem

logical

 

 

Não

2.08

isCriticalItem

logical

 

 

Não

2.08

isItemWithoutBalance

logical

 

 

Não

2.08

isItemOnlyManualUpdate

logical

 

 

Não

2.08

isProjectNegativeBalance

logical

 

 

Não

2.08

isBalanceHigherThanSecurity

logical

 

 

Não

2.08

isBalanceLessThanSecurity

logical

 

 

Não

2.08

isBalanceHigherThanSecurityValue

decimal

 

 

Não

2.08

isHidePeriodWithoutInfo

logical

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttDemonstrativeItemVO

Item Demonstrativo

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

itemCode

character

 

 

Não

2.08

itemDescription

character

 

 

Não

2.08

reference

character

 

 

Não

2.08

family

character

 

 

Não

2.08

isOK

logical

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttPeriodDateReturnVO

Período da Data

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

periodValue

integer

 

 

Não

2.08

yearValue

integer

 

 

Não

2.08

dateValue

date

 

 

Não

2.08

finalDateValue

date

 

 

Não

2.08

Tabela Temporária

Descrição

Entrada/Saída

ttBooleanReturn

Retorno Lógico

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

booleanValue

logical

 

 

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:

addItemComment

Requisito

 

Sintaxe

addItemComment (input  table ttDemonstrativeMessageVO,

                output table RowErrors)

Descrição

Adicionar comentário nos itens.

 

Parâmetros

Descrição

 

ttDemonstrativeMessageVO

Comentário.

Retorno

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

cancelItemRevision

Requisito

 

Sintaxe

cancelItemRevision (input  planCode,

                    input  itemCode,

                    output table RowErrors)

Descrição

Cancela revisão do item.

 

Parâmetros

Descrição

 

planCode

Código do plano.

 

itemCode

Código do item.

Retorno

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

exportData

Requisito

 

Sintaxe

exportData (input table ttDemonstrativeParamVO,

            input queryType,

            input queryDateGrouping,

            output table ttDemonstrativeExportVO,

            output table RowErrors)

Descrição

Exportar dados do demonstrativo.

 

Parâmetros

Descrição

 

ttDemonstrativeParamVO

Parâmetros da consulta.

 

queryType

Tipo de consulta (Perído/Data).

 

queryDateGrouping

Tipo de agrupamento (em consulta por Data).

Retorno

ttDemonstrativeExportVO: Dados para serem exportados.

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

getCalculatedItems

Requisito

 

Sintaxe

getCalculatedItems (input table ttDemonstrativeParamVO,

                    output table ttDemonstrativeItemVO,

                    output table RowErrors)

Descrição

Busca itens calculados pelo planejamento.

 

Parâmetros

Descrição

 

ttDemonstrativeParamVO

Parâmetros da consulta.

Retorno

ttDemonstrativeItemVO: Item calculado.

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

getItemComments

Requisito

 

Sintaxe

getItemComments (input  itemCode,

                 input  siteCode,

                 input  referenceCode,

                 input  queryType,

                 input  initialDate,

                 input  planCode,

                 output table ttDemonstrativeMessageVO,

                 output table RowErrors)

Descrição

Busca de comentário dos itens.

 

Parâmetros

Descrição

 

itemCode

Código do item.

 

siteCode

Código do estabelecimento.

 

referenceCode

Código da referência.

 

queryType

Tipo de consulta (1-Todos os comentários/2-Somente comentários do plano).

 

initialDate

Data inicial.

 

planCode

Código do plano.

Retorno

ttDemonstrativeMessageVO: Comentários dos itens.

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

getItemDetail

Requisito

 

Sintaxe

getItemDetail (input  itemCode,

               input  siteCode,

               input  referenceCode,

               input  planCode,

               output table ttDemonstrativeItemDetailVO,

               output table RowErrors)

Descrição

Busca detalhe do item.

 

Parâmetros

Descrição

 

itemCode

Código do item.

 

siteCode

Código do estabelecimento.

 

referenceCode

Código da referência.

 

planCode

Código do plano.

Retorno

ttDemonstrativeItemDetailVO: Detalhe do item

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

getPeriodDetail

Requisito

 

Sintaxe

getPeriodDetail (input  itemCode,

                 input  periodString,

                 input  planCode,

                 input  siteCode,

                 input  referenceCode,

                 input  queryType,

                 input  fieldType,

                 input  finalPeriodDate,

                 output table ttDemonstrativeDetailVO,

                 output table RowErrors)

Descrição

Busca detalhe do período.

 

Parâmetros

Descrição

 

itemCode

Código do item.

 

periodString

Período.

 

planCode

Código do plano.

 

siteCode

Código do estabelecimento.

 

referenceCode

Código da referência.

 

queryType

Tipo de consulta.

 

fieldType

Campo.

 

finalPeriodDate

Data final do período.

Retorno

ttDemonstrativeDetailVO: Detalhe do período no demonstrativo.

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

getPeriodInfoDetail

Requisito

 

Sintaxe

getPeriodInfoDetail (input  itemCode,

                     input  periodString,

                     input  planCode,

                     input  siteCode,

                     input  referenceCode,

                     input  finalPeriodDate,

                     output table ttDemonstrativeInfoDetailVO,

                     output table RowErrors)

Descrição

Busca detalhes rápido do período.

 

Parâmetros

Descrição

 

itemCode

Código do item.

 

periodString

Período.

 

planCode

Código do plano.

 

siteCode

Código do estabelecimento.

 

referenceCode

Código da referência.

 

finalPeriodDate

Data final do período.

Retorno

ttDemonstrativeInfoDetailVO: Detalhe do período.

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

getPeriodsOfItem

Requisito

 

Sintaxe

getPeriodsOfItem (input table ttDemonstrativeParamVO,

                  input  itemCode,

                  input  periodString,

                  input  referenceCode,

                  input  queryType,

                  input  queryDateGrouping,

                  output table ttDemonstrativePeriodVO,

                  output table RowErrors)

Descrição

Busca períodos do item.

 

Parâmetros

Descrição

 

itemCode

Código do item.

 

periodString

Período.

 

referenceCode

Código da referência.

 

queryType

Tipo de consulta.

 

queryDateGrouping

Agrupamento de data.

Retorno

ttDemonstrativePeriodVO: Período do item.

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

setItemRevision

Requisito

 

Sintaxe

setItemRevision (input  planCode,

                 input  itemCode,

                 output table RowErrors)

Descrição

Método para revisar o item.

 

Parâmetros

Descrição

 

planCode

Código do plano.

 

itemCode

Código do item.

Retorno

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

simulatePeriods

Requisito

 

Sintaxe

simulatePeriods (input  planCode,

                 input  siteCode,

                 input  itemCode,

                 input  referenceCode,

                 input  queryType,

                 output table ttDemonstrativePeriodVO,

                 output table RowErrors)

Descrição

Simulação de períodos.

 

Parâmetros

Descrição

 

planCode

Código do plano.

 

siteCode

Código do estabelecimento.

 

itemCode

Código do item.

 

referenceCode

Código da referência.

 

queryType

Tipo de consulta.

Retorno

ttDemonstrativePeriodVO: Perídos do plano.

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

validatePeriodicity

Requisito

 

Sintaxe

validatePeriodicity (input  periodType,

                     output table ttBooleanReturn,

                     output table RowErrors)

Descrição

Valida período do plano.

 

Parâmetros

Descrição

 

periodType

Tipo do período.

Retorno

ttBooleanReturn: Resultado lógico da validação.

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