Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | mrbo/bomr001fx.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 | ||||
ttCalculatedItemVO | Itens Calculados | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
itemDescription | character |
|
| Não | 2.08 | |
itemInitialQuantity | decimal |
|
| Não | 2.08 | |
referenceCode | character |
|
| Não | 2.08 | |
itemCode | character |
|
| Não | 2.08 | |
siteCode | character |
|
| Não | 2.08 | |
unitOfMeasure | character |
|
| Não | 2.08 | |
isRecalcNeeded | logical |
|
| Não | 2.08 | |
finalBalance | decimal |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttDetailUpdateOrdersVO | Detalhe Alteração de Ordens | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
referenceCode | character |
|
| Não | 2.08 | |
deliveryDate | date |
|
| Não | 2.08 | |
itemFinalQuantity | decimal |
|
| Não | 2.08 | |
orderQuantity | decimal |
|
| Não | 2.08 | |
orderParcel | integer |
|
| Não | 2.08 | |
orderNumber | integer |
|
| Não | 2.08 | |
orderType | character |
|
| Não | 2.08 | |
shortName | character |
|
| Não | 2.08 | |
customerRequest | character |
|
| Não | 2.08 | |
siteCode | character |
|
| Não | 2.08 | |
isSelected | logical |
|
| Não | 2.08 | |
planCode | integer |
|
| Não | 2.08 | |
itemCode | character |
|
| Não | 2.08 | |
itemPeriodRowid | character |
|
| Não | 2.08 | |
openOrderRowid | character |
|
| Não | 2.08 | |
reprogOrderRowid | character |
|
| Não | 2.08 | |
oldDate | date |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttUpdateOrdersParamVO / ttUpdateOrdersParamVO2 | Alteração de Ordens | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
finalDate | date |
|
| Não | 2.08 | |
initialDate | date |
|
| Não | 2.08 | |
productionPlanCode | integer |
|
| Não | 2.08 | |
dateType | integer |
|
| Não | 2.08 | |
isReprogramming | logical |
|
| Não | 2.08 | |
isPlanned | logical |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttReprogrammingOrdersParamVO | Parâmetros Ordens Reprogramadas | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
businessUnitString | character |
|
| Não | 2.08 | |
lotString | character |
|
| Não | 2.08 | |
buyerString | character |
|
| Não | 2.08 | |
productionLineString | character |
|
| Não | 2.08 | |
plannerString | character |
|
| Não | 2.08 | |
stockGroupString | character |
|
| Não | 2.08 | |
familyString | character |
|
| Não | 2.08 | |
itemString | character |
|
| Não | 2.08 | |
finalDate | date |
|
| Não | 2.08 | |
initialDate | date |
|
| Não | 2.08 | |
productionPlanString | character |
|
| Não | 2.08 | |
finalEmitedDate | date |
|
| Não | 2.08 | |
initialEmitedDate | date |
|
| Não | 2.08 | |
finalDeliveryDate | date |
|
| Não | 2.08 | |
initialDeliveryDate | date |
|
| Não | 2.08 | |
isPurchased | logical |
|
| Não | 2.08 | |
isManufactured | logical |
|
| Não | 2.08 | |
siteString | character |
|
| Não | 2.08 | |
customerRequestString | character |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttReprogrammingOrdersItemVO | Parâmetros Itens c/ Ordens Reprog. | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
itemCode | character |
|
| Não | 2.08 | |
familyCode | character |
|
| Não | 2.08 | |
plannerCode | character |
|
| Não | 2.08 | |
buyerCode | character |
|
| Não | 2.08 | |
itemDescription | character |
|
| Não | 2.08 | |
plannerDescription | character |
|
| Não | 2.08 | |
buyerDescription | character |
|
| Não | 2.08 | |
familyDescription | character |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttReprogrammingOrdersDetailVO | Detalhe Ordens Reprogramadas | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
itemCode | character |
|
| Não | 2.08 | |
referenceCode | character |
|
| Não | 2.08 | |
unitOfMeasure | character |
|
| Não | 2.08 | |
customerName | character |
|
| Não | 2.08 | |
numberRequest | integer |
|
| Não | 2.08 | |
sequence | integer |
|
| Não | 2.08 | |
requisitionQuantity | decimal |
|
| Não | 2.08 | |
days | integer |
|
| Não | 2.08 | |
originalDate | date |
|
| Não | 2.08 | |
requisitionType | integer |
|
| Não | 2.08 | |
orderNumber | integer |
|
| Não | 2.08 | |
vendorCode | character |
|
| Não | 2.08 | |
itemDescription | character |
|
| Não | 2.08 | |
familyCode | character |
|
| Não | 2.08 | |
obtaining | character |
|
| Não | 2.08 | |
stockGroup | character |
|
| Não | 2.08 | |
defaultSite | character |
|
| Não | 2.08 | |
planCode | integer |
|
| Não | 2.08 | |
requisition | decimal |
|
| Não | 2.08 | |
businessUnit | character |
|
| Não | 2.08 | |
parcel | integer |
|
| Não | 2.08 | |
startDate | date |
|
| Não | 2.08 | |
endDate | date |
|
| Não | 2.08 | |
actionType | integer |
|
| Não | 2.08 | |
plannerCode | character |
|
| Não | 2.08 | |
buyerCode | character |
|
| Não | 2.08 | |
productionLine | character |
|
| Não | 2.08 | |
reportType | integer |
|
| Não | 2.08 | |
siteCode | character |
|
| Não | 2.08 | |
ocurrence | character |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttCriticalPlanningOrdersItemVO | Itens c/ Ordens Críticas | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
itemCode | character |
|
| Não | 2.08 | |
familyCode | character |
|
| Não | 2.08 | |
plannerCode | character |
|
| Não | 2.08 | |
buyerCode | character |
|
| Não | 2.08 | |
itemDescription | character |
|
| Não | 2.08 | |
plannerDescription | character |
|
| Não | 2.08 | |
buyerDescription | character |
|
| Não | 2.08 | |
familyDescription | character |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttCriticalPlanningOrdersParamVO | Parâmetros Ordens Críticas | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
businessUnitString | character |
|
| Não | 2.08 | |
buyerString | character |
|
| Não | 2.08 | |
productionLineString | character |
|
| Não | 2.08 | |
plannerString | character |
|
| Não | 2.08 | |
stockGroupString | character |
|
| Não | 2.08 | |
familyString | character |
|
| Não | 2.08 | |
itemString | character |
|
| Não | 2.08 | |
finalDate | date |
|
| Não | 2.08 | |
initialDate | date |
|
| Não | 2.08 | |
productionPlanString | character |
|
| Não | 2.08 | |
finalEmitedDate | date |
|
| Não | 2.08 | |
initialEmitedDate | date |
|
| Não | 2.08 | |
finalDeliveryDate | date |
|
| Não | 2.08 | |
initialDeliveryDate | date |
|
| Não | 2.08 | |
isPurchased | logical |
|
| Não | 2.08 | |
isManufactured | logical |
|
| Não | 2.08 | |
listExternalOperationValue | logical |
|
| Não | 2.08 | |
onlyProcessingOrders | logical |
|
| Não | 2.08 | |
priceType | integer |
|
| Não | 2.08 | |
initialNeedDate | date |
|
| Não | 2.08 | |
finalNeedDate | date |
|
| Não | 2.08 | |
siteString | character |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttCriticalPlanningOrdersDetailVO / b-ttCriticalPlanningOrdersDetai | Detalhes Ordens Críticas | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
orderType | integer |
|
| Não | 2.08 | |
itemCode | character |
|
| Não | 2.08 | |
referenceCode | character |
|
| Não | 2.08 | |
unitOfMeasure | character |
|
| Não | 2.08 | |
orderQuantity | decimal |
|
| Não | 2.08 | |
occurrencyDescription | character |
|
| Não | 2.08 | |
daysQuantity | integer |
|
| Não | 2.08 | |
finalDate | date |
|
| Não | 2.08 | |
initialDate | date |
|
| Não | 2.08 | |
orderValue | decimal |
|
| Não | 2.08 | |
orderValueIPI | decimal |
|
| Não | 2.08 | |
planCode | integer |
|
| Não | 2.08 | |
familyCode | character |
|
| Não | 2.08 | |
plannerCode | character |
|
| Não | 2.08 | |
buyerCode | character |
|
| Não | 2.08 | |
itemDescription | character |
|
| Não | 2.08 | |
obtaining | integer |
|
| Não | 2.08 | |
stockGroupCode | character |
|
| Não | 2.08 | |
defaultSite | character |
|
| Não | 2.08 | |
basePrice | decimal |
|
| Não | 2.08 | |
lastEntryPrice | decimal |
|
| Não | 2.08 | |
repositionPrice | decimal |
|
| Não | 2.08 | |
fiscalPrice | decimal |
|
| Não | 2.08 | |
batchPrice | decimal |
|
| Não | 2.08 | |
ipiPercentage | decimal |
|
| Não | 2.08 | |
siteCode | character |
|
| Não | 2.08 | |
businessUnit | character |
|
| 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:
exportCriticalData
Requisito |
| |
Sintaxe | exportCriticalData (input table ttCriticalPlanningOrdersParamVO, output table ttCriticalPlanningOrdersDetailVO, output table RowErrors) | |
Descrição | Exportação de ordens críticas. | |
| Parâmetros | Descrição |
| ttCriticalPlanningOrdersParamVO | Parâmetros para consulta. |
Retorno | ttCriticalPlanningOrdersDetailVO: Detalhes de Ordens Críticas. RowErrors: Erros na execução da função. |
exportData
Requisito |
| |
Sintaxe | exportData (input table ttReprogrammingOrdersParamVO, output table ttReprogrammingOrdersDetailVO, output table RowErrors) | |
Descrição | Exportação de ordens reprogramadas. | |
| Parâmetros | Descrição |
| ttReprogrammingOrdersParamVO | Parâmetros para consulta. |
Retorno | ttReprogrammingOrdersDetailVO: Detalhes de Ordens Reprogramadas. RowErrors: Erros na execução da função. |
getCriticalPlanningItem
Requisito |
| |
Sintaxe | getCriticalPlanningItem (input table ttCriticalPlanningOrdersParamVO, output table ttCriticalPlanningOrdersItemVO, output table RowErrors) | |
Descrição | Busca de itens que possuem ordens críticas. | |
| Parâmetros | Descrição |
| ttCriticalPlanningOrdersParamVO | Parâmetros para consulta. |
Retorno | ttReprogrammingOrdersDetailVO: Itens que possuem ordens críticas. RowErrors: Erros na execução da função. |
getCriticalPlanningList
Requisito |
| |
Sintaxe | getCriticalPlanningList (input table ttCriticalPlanningOrdersParamVO, input table ttCriticalPlanningOrdersItemVO, output table ttCriticalPlanningOrdersDetailVO, output table RowErrors) | |
Descrição | Busca listagem de ordens críticas. | |
| Parâmetros | Descrição |
| ttCriticalPlanningOrdersParamVO | Parâmetros para consulta. |
| ttCriticalPlanningOrdersItemVO | Item. |
Retorno | ttCriticalPlanningOrdersDetailVO: Ordens críticas. RowErrors: Erros na execução da função. |
getFinalBalance
Requisito |
| |
Sintaxe | getFinalBalance (input table ttUpdateOrdersParamVO, input itemCode, input siteCode, input referenceCode, output table ttStringReturn, output table RowErrors) | |
Descrição | Busca do saldo final. | |
| Parâmetros | Descrição |
| ttUpdateOrdersParamVO | Parâmetros para consulta. |
| itemCode | Item. |
| siteCode | Estabelecimento. |
| referenceCode | Referência. |
Retorno | ttStringReturn: Saldo final. RowErrors: Erros na execução da função. |
getItems
Requisito |
| |
Sintaxe | getItems (input table ttUpdateOrdersParamVO, output table ttCalculatedItemVO, output table RowErrors) | |
Descrição | Busca itens do plano de produção. | |
| Parâmetros | Descrição |
| ttUpdateOrdersParamVO | Parâmetros para consulta. |
Retorno | ttCalculatedItemVO: Itens calculados pelo planejamento. RowErrors: Erros na execução da função. |
getOrders
Requisito |
| |
Sintaxe | getOrders (input table ttUpdateOrdersParamVO, input itemCode, input siteCode, input referenceCode, output table ttDetailUpdateOrdersVO, output table RowErrors) | |
Descrição | Busca ordens do plano de produção. | |
| Parâmetros | Descrição |
| ttUpdateOrdersParamVO | Parâmetros para consulta. |
| itemCode | Item. |
| siteCode | Estabelecimento. |
| referenceCode | Referência. |
Retorno | ttDetailUpdateOrdersVO: Ordens do demonstrativo. RowErrors: Erros na execução da função. |
getReprogrammingItem
Requisito |
| |
Sintaxe | getReprogrammingItem (input table ttReprogrammingOrdersParamVO, output table ttReprogrammingOrdersItemVO, output table RowErrors) | |
Descrição | Busca itens que possuem ordens reprogramadas. | |
| Parâmetros | Descrição |
| ttReprogrammingOrdersParamVO | Parâmetros para consulta. |
Retorno | ttReprogrammingOrdersItemVO: Itens com ordens reprogramadas. RowErrors: Erros na execução da função. |
getReprogrammingList
Requisito |
| |
Sintaxe | getReprogrammingList (input table ttReprogrammingOrdersParamVO, input table ttReprogrammingOrdersItemVO, output table ttReprogrammingOrdersDetailVO, output table RowErrors) | |
Descrição | Busca ordens reprogramadas. | |
| Parâmetros | Descrição |
| ttReprogrammingOrdersParamVO | Parâmetros para consulta. |
| ttReprogrammingOrdersItemVO | Item. |
Retorno | ttReprogrammingOrdersDetailVO: Ordens reprogramadas. RowErrors: Erros na execução da função. |
saveOrders
Requisito |
| |
Sintaxe | saveOrders (input table ttDetailUpdateOrdersVO, input dateType, input table ttUpdateOrdersParamVO, output table RowErrors) | |
Descrição | Salvar ordens do planejamento. | |
| Parâmetros | Descrição |
| ttDetailUpdateOrdersVO | Ordem. |
| dateType | Tipo de período. |
| ttUpdateOrdersParamVO | Paramêtros. |
Retorno | RowErrors: Erros na execução da função. |