ABAPI006 - Geração / Eliminação de Eventos Programados dos Equipamentos

Documento de API

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

Considerações Gerais

Objetivo

A API, gera os eventos programados dos equipamentos e também elimina os eventos criados, de acordo com a seleção pedida.

Funcionamento

A API, conforme ação passada, pode gerar ou eliminar os movimentos de eventos dos equipamentos, do cadastro de eventos programados.

Quando é feita a geração, o programa lê os equipamentos ativos <mab-eqpto> no sistema conforme seleção, então lê os eventos programados para o equipamento <mab-programac-event>.

São verificados o número de parcelas e a data de vencimento do evento, conforme seleção.

Cria-se uma tabela temporária que valida se o evento já foi gerado.

Feita a geração, são guardados os eventos gerados para posterior impressão.

Quando é feita a eliminação, o programa lê os movimentos dos equipamentos <mab-movto-event> conforme seleção, para verificar os eventos que não foram executados.

O evento pode estar vencido ou a vencer, e conforme parametrização pode-se eliminar eventos com estes dois estados.

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

run abp/abapi006.p (input table tt-param,

output table RowErrors,

output table ttCriados).

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:

tt-param					Entrada/Saída
Contém os campos para se fazer a seleção dos registros na API					Entrada
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
usuario	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 2 – Eliminaçã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
lInferior	logical	yes-no	Inferior	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
unidNegocIni	char	x(3)	Unidade de Negócio Inicial	Sim	001
unidNegocFim	char	x(3)	Unidade de Negócio Final	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

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

RowErrorsEqpto					Entrada/Saída
Guarda os erros gerados conforme o equipamento em questão. Esta temp-table é like RowErrors					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ep-codigo	int	>>9	Código da Empresa do Equipamento	Sim	001
cod-eqpto	char	X(16)	Código do Equipamento	Sim	001

Métodos

Como a API não é rodada persistente, não existem métodos disponíveis para execução.

Método Básico

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

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

piCriacao
Requisito	Deve ser chamada pela piInicializacao.
Sintaxe	run piCriacao in this-procedure.
Descrição	Busca os equipamentos e a programação de eventos para estes equipamentos para fazer a geração dos eventos.
	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	Deve ser chamada pela piCriacao.
Sintaxe	run piEvento in this-procedure.
Descrição	Cria a tabela temporária ttEvento, que valida a existência dos movimentos de eventos. Se não existir um movimento, é efetuada a geração do mesmo.
	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.

piElimina
Requisito	Deve ser chamada pela piInicializacao.
Sintaxe	run piEliminacao in this-procedure.
Descrição	Busca os movimentos de eventos dos equipamentos selecionados, verificando o vencimento dos mesmos para ser efetuada a sua eliminação.
	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.

pi-epc-movto-evento
Requisito	Deve ser chamada pela piEvento.
Sintaxe	RUN pi-epc-movto-evento IN THIS-PROCEDURE.
Descrição	EPC para Movimento de Evento.
	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.

piDescEvento
Requisito	Deve ser chamada pela piEvento.
Sintaxe	RUN piDescEvento IN THIS-PROCEDURE.
Descrição	Gera a descrição do evento.
	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