ABAPI003 - Atualização Quilometragem

Documento de API

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

Considerações Gerais

Objetivo

A API, faz a atualização da quilometragem do equipamento, atualizando os movimentos como também os períodos de manutenção dos compartimentos do equipamento, planos e quilometragem de implementos.

Funcionamento

A API recebe como parâmetro a temp-table com os documento aprovados, assim busca todos os equipamentos que deverão ser atualizados.

Busca-se a vida anterior do equipamento para ser atualizado o histórico de quilometragem (mab-movto-km-eqpto).

Busca-se posteriormente a vida atual do equipamento para atualizar os períodos de manutenção dos compartimentos do equipamento.

Chama API de integração com EMS (abp\abapi005.p), se parametrização do módulo for “On-Line”.

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\abapi003.p (input pOrigem,

input table ttDocumento,

output table RowErrors).

Parâmetros

Descrição

pOrigem

Origem do Movimento

1 – MAB

2 – MPN

3 – MMV

Tabelas Temporárias

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

ttDocumento					Entrada/Saída
Contém os registros das fichas de abastecimento e lubrificação que fora atualizadas. Esta temp-table é LIKE mab-abastec-lubrific					Entrada
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
r-rowid	rowid	padrão	Rowid da Ficha de abastecimento e lubrificação	Sim	001
lIntegrar	logical	yes/no	Integrar	Não	001

ttEquipamento					Entrada/Saída
Define quais os equipamentos que estarão sendo atualizados no momento. Esta temp-table é LIKE mab-eqpto.					Entrada
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
r-rowid	rowid	padrão	Rowid do Equipamento	Sim	001
lAtualizaPlano	logical	Yes/no	Atualizar	Não	001

ttImplemento					Entrada/Saída
Define quais os implementos que estarão sendo atualizados no momento.					Entrada
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ep-codigo	integer	>>9	Código da Empresa do Equipamento (LIKE mab-eqpto.ep-codigo)	Sim	001
cod-implto	character	X(16)	Código Implemento (LIKE mab-eqpto.cod-eqpto)	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

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.

Metodo Negócio

piInicializacao
Requisito	Nenhum
Sintaxe	run piInicializacao in this-procedure.
Descrição	Busca os equipamentos referentes aos documentos aprovados.
	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

piAbastecimento
Requisito	Chamada pela piInicializacao.
Sintaxe	run piAbastecimento in this-procedure.
Descrição	Atualiza o histórico de quilometragem do equipamento.
	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.

piLubrificacao
Requisito	Chamada pela piInicializacao.
Sintaxe	run piLubrificacao in this-procedure.
Descrição	Atualiza os períodos de manutenção dos compartimentos do equipamento.
	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.

piKMHistorico
Requisito	Chamada pela piInicializacao.
Sintaxe	RUN piKMHistorico IN THIS-PROCEDURE.
Descrição	Calcula KM quando não é origem MAB ou não encontrou ficha de abastecimento
	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.

piPercursoImplementos
Requisito	Chamada pela piInicializacao.
Sintaxe	run piPercursoImplementos in THIS-PROCEDURE (INPUT <date>, INPUT <date>).
Descrição	Atualização quilometragem dos implementos relacionados aos equipamentos. Garante que não seja gerada Vida Negativa ao equipamento.
	Parâmetros	Descrição
	dData-Implto	Data inicial
	mgf-eqpto-implto.dat-final	Data final
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

piPlanoPreventiva
Requisito	Chamada pela piInicializacao.
Sintaxe	run piPlanoPreventiva in this-procedure.
Descrição	Atualização dos planos de manutenção preventiva dos equipamentos
	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.

Árvore de páginas