ABAPI014 - Inativa Componentes/Equipamentos dos Equipamentos

Documento de API

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

Considerações Gerais

Objetivo

A API, gera as temp-tables necessárias para a criação de inativação dos equipamentos.

Funcionamento

A API, conforme ação passada, pode criar os movimentos de inativação dos equipamentos.

Esta API faz a leitura dos pneus conforme parâmetros informados e gera as temp-tables necessárias para fazer inativação dos equipamentos.

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se os parâmetros com as informações necessárias.

A sintaxe para a chamada da API é:

run abp/abapi014.p (input RowObject.ep-codigo,

input RowObject.cod-eqpto,

input RowObject.cod-sit-eqpto,

input “CREATE”:U,

output TABLE RowErrors).

A execução na forma persistente não existe para esta API.

Tabelas Temporárias

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

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
Destino	integer	padrão	Destino do relatório	Não	001
Arquivo	char	x(35)	Nome do arquivo do relatório	Não	001
Usuário	char	x(12)	Nome do usuário corrente	Sim	001
data-exec	date	99/99/9999	Data de execução do relatório	Não	001
hora-exec	integer	padrão	Hora de execução do relatório	Não	001
iAcao	integer	padrão	Tipo de Ação: 1 – Geração	Sim	001
dataIni	date	99/99/9999	Data Inicial	Sim	001
dataFim	date	99/99/9999	Data Final	Sim	001
docIni	integer	>>>,>>>,>>9	Documento Inicial	Não	001
docFim	integer	>>>,>>>,>>9	Documento Final	Não	001
empIni	integer	>>9	Empresa Inicial	Sim	001
empFim	integer	>>9	Empresa Final	Sim	001
eqptoIni	char	x(16)	Equipamento Inicial	Sim	001
eqptoFim	char	x(16)	Equipamento Final	Sim	001
eventIni	char	x(8)	Evento Inicial	Não	001
eventFim	char	x(8)	Evento Final	Não	001
subIni	char	x(8)	Sub Sistema Inicial	Não	001
subFim	char	x(8)	Sub Sistema Final	Não	001
lResumo	logical	yes/no	Imprimir Resumo dos Eventos Criados	Não	001
lVencidos	logical	yes/no	Eliminar Eventos Vencidos e não Executados	Não	001
lVencer	logical	yes-no	Eliminar Eventos a Vencer	Não	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

ttMpn-movto-pneu					Entrada/Saída
Contém os movimentos que foram gerados. Esta temp-table é like <mpn-movto-pneu>					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
rowid	padrão	Rowid do Registro	Não	001	rowid

ttMco-movto-compon					Entrada/Saída
Contém os movimentos que foram gerados. Esta temp-table é like <mcomovto-compon>					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
r-rowid	rowid	padrão	Rowid do Registro	Não	001

Métodos

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Método Básico

finalizaHandle
Requisito	Chamada pela piInicializacao.
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.

inicializaHandle
Requisito	Chamada pela piInicializacao.
Sintaxe	run inicializaHandle 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

Método Negócio

piInicializacao
Requisito	Nenhum.
Sintaxe	run piInicializacao in this-procedure.
Descrição	Verifica qual ação deve ser feita pela API (Criação) e chama as procedures corretas.
	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.

piCriacaoMovtoPneu
Requisito	Deve ser chamada pela piInicializacao.
Sintaxe	run piCriacaoMovtoPneu in this-procedure.
Descrição	Busca os pneus do equipamento e faz a criação das temp-tables dos pneus relativos a estes equipamentos.
	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.

piCriaMovtoCompon
Requisito	Deve ser chamada pela piInicializacao.
Sintaxe	run piCriaMovtoCompon in this-procedure.
Descrição	Busca os componentes do equipamento e faz a criação das temp-tables dos componentes relativos a estes equipamentos.
	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.

Cria-mpn-movto-pneu
Requisito	Deve ser chamada pela piCriacaoMovtoPneu.
Sintaxe	run Cria-mpn-movto-pneu in this-procedure.
Descrição	Executa um método na frbo/bofr074 onde fará a criação do registro na tabela mpn-movto-pneu de acordo com a temp-table criada pela inativação do 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.

Cria-mco-movto-compon
Requisito	Deve ser chamada pela piCriacaoMovtoPneu.
Sintaxe	run Cria-mco-movto-compon in this-procedure.
Descrição	Executa um método na frbo/bofr066 onde fará a criação do registro na tabela mco-movto-compon de acordo com a temp-table criada pela inativação do 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