Histórico da Página

...

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 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

...

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.

...

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.

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave