ABAPI004 - Remonta Motor

Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	abp/abapi004

Considerações Gerais

Objetivo

A API, cria os movimentos de remonta que ocorreram no equipamento.

Funcionamento

A API, recebe os equipamentos, inicializa os handles necessários para sua execução e faz as validações de parâmetros do módulo.

Busca-se os parâmetros necessários do módulo de abastecimento. São percorridos os equipamentos, busca-se os compartimentos dos equipamentos para buscar o último apontamentos de lubrificação onde foi feita última lubrificação.

Busca-se todos os apontamentos de lubrificação com eventos de remonta no período atual à ultima lubrificação, somando-se as quantidades do apontamento.

Cria os históricos de remonta para o compartimento do equipamento, se foi encontrado alguma remonta.

Cria um evento para equipamento se a remonta estiver acima do percentual parametrizado no módulo.

A API roda apenas na forma padrão, onde 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 abp\abapi004.p (input <date>,

input table tt-digita,

output table RowErrors).

Tabelas Temporárias

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

tt-digita					Entrada/Saída
Contém os equipamentos que serão verificados					Entrada
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ep-codigo	integer	>>9	Código da Empresa	Sim	001
cod-eqpto	char	x(16)	Código do Equipamento	Sim	001

ttEvento					Entrada/Saída
Contém o evento que está sendo alterado. É definida como LIKE mab-movto-event.					Entrada
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
r-rowid	Rowid	Padrão	Rowid da MAB-MOVTO-EVENT	Sim	001

RowErrors					Entrada/Saída
Contém os erros ocorridos na API (Mesma temp-table utilizada para gerar erros pelas BOs).					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ErrorSequence	integer	padrão	Seqüência dos erros	Sim	001
ErrorNumber	integer	padrão	Número do erro	Sim	001
ErrorDescription	char	padrão	Descrição do erro	Sim	001
ErrorParameters	char	padrão	Parâmetros passados para criar mensagem	Não	001
ErrorType	char	padrão	Tipo do erro: WARNING: Aviso ERROR: Erro	Sim	001
ErrorHelp	char	padrão	Texto de ajuda do erro	Sim	001
ErrorSubType	char	padrão	Sub Tipo da mensagem de erro	Não	001

Métodos

Método Básico

finalizaHandle
Requisito	Nenhum
Sintaxe	run finalizaHandle in this-procedure.
Descrição	Elimina os handles utilizados na API
	Parâmetros	Descrição
	Não contém
Retorno	A API 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.

initializeHandle
Requisito	Nenhum
Sintaxe	run initializeHandle in this-procedure.
Descrição	Inicializa os handles utilizados na API
	Parâmetros	Descrição
	Não contém
Retorno	A API 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.

piInicializacao
Requisito	Nenhum
Sintaxe	run piInicializacao in this-procedure.
Descrição	Chamada para iniciar a execução da API.
	Parâmetros	Descrição
	Não contém
Retorno	A API 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.

piValidaInicial
Requisito	Nenhum
Sintaxe	run piValidaInicial in this-procedure.
Descrição	Faz as Validações Iniciais verificando se parâmetros necessários para execução da API estão cadastrados.
	Parâmetros	Descrição
	Não contém
Retorno	A API 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.

piCriaErro
Requisito	Nenhum
Sintaxe	run piCriaErro in this-procedure (input <integer>, input <character>, input <character>).
Descrição	Cria os erros ocorridos dentro da API.
	Parâmetros	Descrição
	pErrorNumber	Número do erro do EMS.
	pErrorType	Tipo de Erro (EMS, sistema, Progress).
	pErrorParameters	Parâmetros passados as mensagens EMS.
Retorno	A API 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.

Método Negócio

piProcessaRemonta
Requisito	Chamada pela piInicializacao.
Sintaxe	run piProcessaRemonta in this-procedure.
Descrição	Percorre equipamentos, buscando seus compartimentos e seus respectivos apontamentos de lubrificação e remonta, para criar o histórico de remonta.
	Parâmetros	Descrição
	Não Contém
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.

piEvento
Requisito	Chamada pela piProcessaRemonta.
Sintaxe	run piEvento in this-procedure.
Descrição	Cria a temp-table de movimento de evento e valida se já existe movimento cadastrado para equipamento.
	Parâmetros	Descrição
	Não Contém
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