Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | inbo/boin311fx.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 | |||||
ttProductionPlanItemVO | Item do Plano de Produção | Entrada | |||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | ||
date | date |
|
| Não | 2.08 | ||
quantity | decimal |
|
| Não | 2.08 | ||
reference | character |
|
| Não | 2.08 | ||
shortName | character |
|
| Não | 2.08 | ||
customerGroup | character |
|
| Não | 2.08 | ||
customerRequest | character |
|
| Não | 2.08 | ||
sequence | integer |
|
| Não | 2.08 | ||
confirmQuantity | decimal |
|
| Não | 2.08 | ||
period | integer |
|
| Não | 2.08 | ||
source | character |
|
| Não | 2.08 | ||
structureNumber | integer |
|
| Não | 2.08 | ||
deliveryNumber | integer |
|
| Não | 2.08 | ||
itemCode | character |
|
| Não | 2.08 | ||
componentListCode | character |
|
| Não | 2.08 | ||
siteCode | character |
|
| Não | 2.08 | ||
planCode | integer |
|
| Não | 2.08 | ||
year | integer |
|
| Não | 2.08 | ||
unitOfMeasure | character |
|
| Não | 2.08 | ||
unitOfMeasureDescription | character |
|
| Não | 2.08 | ||
isSelected | logical |
|
| Não | 2.08 | ||
periodString | character |
|
| Não | 2.08 | ||
periodType | integer |
|
| Não | 2.08 | ||
itemDescription | character |
|
| Não | 2.08 | ||
hasReference | 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 | ||||||
ttProductionPlanItemParamVO | Parâmetros Item do Plano | Entrada | ||||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |||
itemString | char |
|
| Não | 2.08 | |||
familyString | char |
|
| Não | 2.08 | |||
stockGroupString | char |
|
| Não | 2.08 | |||
siteString | char |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | |||||
ttProductionPlanCalculateVO | Cálculo do Plano de Produção | Entrada | |||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | ||
productionPlanCode | integer |
|
| Não | 2.08 | ||
calculationType | integer |
|
| Não | 2.08 | ||
generateTrace | logical |
|
| Não | 2.08 | ||
printLot | logical |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttProductionPlanParamVO | Parâmetros do Plano de Produção | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
planCodeString | char |
|
| Não | 2.08 | |
initialDate | date |
|
| Não | 2.08 | |
finalDate | date |
|
| Não | 2.08 | |
initialPeriod | char |
|
| Não | 2.08 | |
finalPeriod | char |
|
| Não | 2.08 | |
isActive | logical |
|
| Não | 2.08 | |
isInactive | logical |
|
| Não | 2.08 | |
isProductionPlan | logical |
|
| Não | 2.08 | |
isPlanSale | logical |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttProductionPlanSitesVO | Estabelecimentos do Plano de Produção | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
siteCode | char |
|
| Não | 2.08 | |
siteDescription | char |
|
| Não | 2.08 | |
isSelectedSites | logical |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttProductionPlanGenerateVO | Geração do Plano de Produção | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
finalFamily | char |
|
| Não | 2.08 | |
initialStockGroup | integer |
|
| Não | 2.08 | |
finalItem | char |
|
| Não | 2.08 | |
initialPlanner | char |
|
| Não | 2.08 | |
initialProductionLine | integer |
|
| Não | 2.08 | |
initialSite | char |
|
| Não | 2.08 | |
period | char |
|
| Não | 2.08 | |
Date | date |
|
| Não | 2.08 | |
isPurchItem | logical |
|
| Não | 2.08 | |
isMadeItem | logical |
|
| Não | 2.08 | |
isWithConfirmation | logical |
|
| Não | 2.08 | |
isGenerateMultiPurchReq | logical |
|
| Não | 2.08 | |
isSplitPurchReqByVendors | logical |
|
| Não | 2.08 | |
isBlockApprovedItems | logical |
|
| Não | 2.08 | |
isPrintModifiedItems | logical |
|
| Não | 2.08 | |
isGenerateAutomaticReq | logical |
|
| Não | 2.08 | |
isPrintConfirmedReq | logical |
|
| Não | 2.08 | |
siteForGeneration | integer |
|
| Não | 2.08 | |
planCode | integer |
|
| Não | 2.08 | |
initialItem | char |
|
| Não | 2.08 | |
initialFamily | char |
|
| Não | 2.08 | |
finalPlanner | char |
|
| Não | 2.08 | |
finalStockGroup | integer |
|
| Não | 2.08 | |
finalProductionLine | integer |
|
| Não | 2.08 | |
finalSite | char |
|
| Não | 2.08 | |
initialBusinessUnit | char |
|
| Não | 2.08 | |
finalBusinessUnit | char |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttProductionPlanVO / ttProductionPlanVO2 | Plano de Produção | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
planCode | integer |
|
| Não | 2.08 | |
planDescription | character |
|
| Não | 2.08 | |
planType | character |
|
| Não | 2.08 | |
periodType | integer |
|
| Não | 2.08 | |
initialPeriodYear | integer |
|
| Não | 2.08 | |
finalPeriodYear | integer |
|
| Não | 2.08 | |
initialPeriod | integer |
|
| Não | 2.08 | |
finalPeriod | integer |
|
| Não | 2.08 | |
validateDate | integer |
|
| Não | 2.08 | |
purchasedReprogramming | integer |
|
| Não | 2.08 | |
considersSafetyStockPurch | logical |
|
| Não | 2.08 | |
considersStockBalancePurch | logical |
|
| Não | 2.08 | |
considersPurchaseReq | logical |
|
| Não | 2.08 | |
considersMadeNeeds | logical |
|
| Não | 2.08 | |
considersBacklogPurch | logical |
|
| Não | 2.08 | |
reprogrammingMade | integer |
|
| Não | 2.08 | |
considersSafetyStockMade | logical |
|
| Não | 2.08 | |
considersStockBalanceMade | logical |
|
| Não | 2.08 | |
considersProductionReq | logical |
|
| Não | 2.08 | |
considersPurchNeeds | logical |
|
| Não | 2.08 | |
considersBacklogMade | logical |
|
| Não | 2.08 | |
generateTracking | logical |
|
| Não | 2.08 | |
calculationStatus | integer |
|
| Não | 2.08 | |
regeneratePlan | logical |
|
| Não | 2.08 | |
userCode | character |
|
| Não | 2.08 | |
initialDate | date |
|
| Não | 2.08 | |
initialTime | character |
|
| Não | 2.08 | |
finalDate | date |
|
| Não | 2.08 | |
finalTime | character |
|
| Não | 2.08 | |
independentDemandItems | integer |
|
| Não | 2.08 | |
dependentDemandItems | integer |
|
| Não | 2.08 | |
purchaseReq | integer |
|
| Não | 2.08 | |
manufacturingReq | integer |
|
| Não | 2.08 | |
reprogrammingReq | integer |
|
| Não | 2.08 | |
manufacturingItems | integer |
|
| Não | 2.08 | |
committedNeeds | integer |
|
| Não | 2.08 | |
itemsOrder | integer |
|
| Não | 2.08 | |
plannedReq | integer |
|
| Não | 2.08 | |
plannedNeeds | integer |
|
| Não | 2.08 | |
planStatus | integer |
|
| Não | 2.08 | |
initialDateNetChange | date |
|
| Não | 2.08 | |
finalDateNetChange | date |
|
| Não | 2.08 | |
initialTimeNetChange | character |
|
| Não | 2.08 | |
finalTimeNetChange | character |
|
| Não | 2.08 | |
itemsNetChange | integer |
|
| Não | 2.08 | |
fixedHorizon | integer |
|
| Não | 2.08 | |
considersConfirmQuantity | logical |
|
| Não | 2.08 | |
defaultSite | character |
|
| Não | 2.08 | |
onlyApprovedPurchOrders | logical |
|
| Não | 2.08 | |
onlyApprovedMadeOrders | logical |
|
| Não | 2.08 | |
considersPayrollBalanceMade | logical |
|
| Não | 2.08 | |
considersPayrollBalancePurch | logical |
|
| Não | 2.08 | |
considersTransitBalanceMade | logical |
|
| Não | 2.08 | |
considersTransitBalancePurch | logical |
|
| Não | 2.08 | |
thirdpartyBalanceMade | logical |
|
| Não | 2.08 | |
thirdpartyBalancePurch | logical |
|
| Não | 2.08 | |
considersResupplyPurch | logical |
|
| Não | 2.08 | |
considersResupplyMade | logical |
|
| Não | 2.08 | |
safetyDaysNumber | integer |
|
| Não | 2.08 | |
planCalculation | integer |
|
| Não | 2.08 | |
checkSum | character |
|
| Não | 2.08 | |
numIdPlan | integer |
|
| Não | 2.08 | |
needByComponentList | integer |
|
| Não | 2.08 | |
configuredPVSales | logical |
|
| Não | 2.08 | |
deliveryPurchProcessing | logical |
|
| Não | 2.08 | |
entryPurchProcessing | logical |
|
| Não | 2.08 | |
deliveryPurchPayroll | logical |
|
| Não | 2.08 | |
entryPurchPayroll | logical |
|
| Não | 2.08 | |
entryMadePayroll | logical |
|
| Não | 2.08 | |
deliveryMadePayroll | logical |
|
| Não | 2.08 | |
deliveryMadeProcessing | logical |
|
| Não | 2.08 | |
entryMadeProcessing | logical |
|
| Não | 2.08 | |
numPlanCalculation | integer |
|
| Não | 2.08 | |
isMultiSites | logical |
|
| Não | 2.08 | |
grossRequirements | logical |
|
| Não | 2.08 | |
repressionDemandMade | character |
|
| Não | 2.08 | |
repressionDemandPurch | character |
|
| Não | 2.08 | |
planInHorizon | character |
|
| Não | 2.08 | |
reprogramInProgressReqMade | logical |
|
| Não | 2.08 | |
reprogramInProgressReqPurch | logical |
|
| Não | 2.08 | |
initialPeriodString | character |
|
| Não | 2.08 | |
finalPeriodString | character |
|
| Não | 2.08 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
ttProductionPlanSummaryVO | Plano de Produção (Resumo) | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
planCode | integer |
|
| Não | 2.08 | |
planType | character |
|
| Não | 2.08 | |
initialPeriodYear | integer |
|
| Não | 2.08 | |
finalPeriodYear | integer |
|
| Não | 2.08 | |
initialPeriod | integer |
|
| Não | 2.08 | |
finalPeriod | integer |
|
| Não | 2.08 | |
calculationStatus | integer |
|
| Não | 2.08 | |
initialPeriodIniDate | date |
|
| Não | 2.08 | |
planStatus | integer |
|
| Não | 2.08 | |
isSelected | logical |
|
| Não | 2.08 | |
periodType | integer |
|
| Não | 2.08 | |
percentualCalculation | integer |
|
| Não | 2.08 | |
isMultiSites | logical |
|
| Não | 2.08 | |
planDescription | character |
|
| Não | 2.08 | |
initialPeriodEndDate | date |
|
| Não | 2.08 | |
finalPeriodEndDate | date |
|
| Não | 2.08 | |
finalPeriodIniDate | date |
|
| 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:
addProductionPlanItem
Requisito | Plano de produção válido | |
Sintaxe | addProductionPlanItem (input table ttProductionPlanItemVO, output table RowErrors) | |
Descrição | Inclusão de itens (necessidades) para um plano de produção. | |
| Parâmetros | Descrição |
| ttProductionPlanItemVO | Tabela com as informações do item (necessidade). |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. |
getDateOfPeriod
Requisito | Tabela de períodos cadastrada | |
Sintaxe | getDateOfPeriod (input periodValue, input yearValue, input periodType, output table ttPeriodDateReturnVO, output table RowErrors) | |
Descrição | Consulta da data final do período. | |
| Parâmetros | Descrição |
| periodValue | Número do período. |
| yearValue | Ano do período. |
| periodType | Código do período. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retorna a temp-table ttPeriodDateReturnVO contendo os valores da data final do período consultado. |
getInitialDateOfPeriod
Requisito | Tabela de períodos cadastrada | |
Sintaxe | getInitialDateOfPeriod (input periodValue, input yearValue, input periodType, output table ttPeriodDateReturnVO, output table RowErrors) | |
Descrição | Consulta da data inicial do período. | |
| Parâmetros | Descrição |
| periodValue | Número do período. |
| yearValue | Ano do período. |
| periodType | Código do período. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retorna a temp-table ttPeriodDateReturnVO contendo os valores da data inicial do período consultado. |
getNextPlan
Requisito | Plano de produção informado não ser o ultimo (last). | |
Sintaxe | getNextPlan (input planCode, output table ttProductionPlanSummaryVO, output table RowErrors) | |
Descrição | Consulta do próximo plano de produção cadastrado. | |
| Parâmetros | Descrição |
| planCode | Código do plano de produção. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retorna a temp-table ttProductionPlanSummaryVO contendo o próximo plano de produção cadastrado. |
getPrevPlan
Requisito | Plano de produção informado não ser o primeiro (first). | |
Sintaxe | getPrevPlan (input planCode, output table ttProductionPlanSummaryVO, output table RowErrors) | |
Descrição | Consulta do plano de produção cadastrado previamente. | |
| Parâmetros | Descrição |
| planCode | Código do plano de produção. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retorna a temp-table ttProductionPlanSummaryVO contendo o plano de produção cadastrado anteriormente. |
getPeriodOfDate
Requisito | Tabela de períodos cadastrada | |
Sintaxe | getPeriodOfDate (input dateValue, input periodType, output table ttPeriodDateReturnVO, output table RowErrors) | |
Descrição | Consulta do plano de produção cadastrado previamente. | |
| Parâmetros | Descrição |
| dateValue | Data. |
| periodType | Código do período. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retorna a temp-table ttPeriodDateReturnVO contendo o período correspondente a data parametrizada. |
getProductionPlanItemNeeds
Requisito |
| |
Sintaxe | getProductionPlanItemNeeds (input productionPlanCode, input itemCode, output table ttProductionPlanItemVO, output table RowErrors) | |
Descrição | Busca das necessidades do item. | |
| Parâmetros | Descrição |
| productionPlanCode | Código do plano de produção. |
| itemCode | Código do Item. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retorna a temp-table ttProductionPlanItemVO contendo as necessidades conforme parâmetros. |
getProductionPlanItems
Requisito |
| |
Sintaxe | getProductionPlanItems (input productionPlanCode, input ttProductionPlanItemParamVO, output table ttProductionPlanItemVO, output table RowErrors) | |
Descrição | Busca de itens que possuem necessidades para o plano de produção. | |
| Parâmetros | Descrição |
| productionPlanCode | Código do plano de produção. |
| ttProductionPlanItemParamVO | Parâmetros do item. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. A BO retorna a temp-table ttProductionPlanItemVO contendo os itens do plano conforme parâmetros. |
importItemsFile
Requisito |
| |
Sintaxe | importItemsFile (input fileName, input planCode, input importType, input overrideItems, output table RowErrors) | |
Descrição | Importação de itens para o plano de produção. | |
| Parâmetros | Descrição |
| fileName | Nome do arquivo. |
| planCode | Código do plano de produção. |
| importType | Tipo de importação. |
| overrideItems | Valor lógico para override de itens já cadastrados. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. |
removeProductionPlanItem
Requisito |
| |
Sintaxe | removeProductionPlanItem (input productionPlanCode, input itemCode, output table RowErrors) | |
Descrição | Eliminação de itens do plano de produção. | |
| Parâmetros | Descrição |
| productionPlanCode | Código do plano de produção. |
| itemCode | Código do item. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. |
setProductionPlanItemNeeds
Requisito |
| |
Sintaxe | setProductionPlanItemNeeds (input productionPlanCode, input table ttProductionPlanItemVO, input isImport, input isOverride, input importType, output table RowErrors) | |
Descrição | Criação/alteração de necessidades para itens do plano de produção | |
| Parâmetros | Descrição |
| productionPlanCode | Código do plano de produção. |
| ttProductionPlanItemVO | Temp-table com os itens a serem criados/alterados. |
| isImport | Variável lógica informando se ação provem de importação. |
| isOverride | Variável lógica informando se override está ativo (se isImport ser verdadeiro) |
| importType | Tipo de importação (se isImport ser verdadeiro) |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors. |