MIAPI010 - Gerar Movimento de Histórico do Equipamento.

Documento de API

Objetivo

Gerar o Movimento de Histórico do Equipamento, e enviar e-mail ao responsável pelo equipamento.

run mip/miapi010.p (input table tt_trans_bem,

output table RowErrors).

A API irá validar os dados e manutenir as tabelas “mi-histor-eqpto” e “equipto”.

A execução é feita somente na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run mip/miapi010.p persistent set h-handle.

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Nos atributos das tabelas temporárias:

Tabela Temporária	Descrição	Entrada/Saída
tt_trans_bem	Temp-Table da “mmv-ord-manut”.	Entrada

Tabela Temporária	Descrição	Entrada/Saída
mi-histor-equipto	Contém o Histórico do Equipamento	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cd-equipto	Char	X(16)	Código do Equipamento	Sim	001
Dat-histor	Date	99/99/9999/	Data do histórico	Sim	001
Ep-codigo	Int	>>9	Código da Empresa do Equipamento	Não	001
Cód-estabel	Char	X(3)	Código do estabelecimento do Equipamento	Não	001
cc-codigo	char	X(8)	Centro de Custo	Não	001
cd-tag	char	X(16)	Código do TAG do Equipamento	Não	001
Dsl-obs	char	X(2000)	Observações	Não	001
cod-livre-1	char	x(100)	Character Livre	Não	001
cod-livre-2	char	x(100)	Character Livre	Não	001
log-livre-1	log	Sim/Não	Logical Livre	Não	001
log-livre-2	log	Sim/Não	Logical Livre	Não	001
num-livre-1	int	->>>>>>>>>9	Inteiro Livre	Não	001
num-livre-2	int	->>>>>>>>>9	Inteiro Livre	Não	001
val-livre-1	dec	->>>>>>>>>>>9.9	Decimal Livre	Não	001
val-livre-2	dec	->>>>>>>>>>>9.9	Decimal Livre	Não	001
dat-livre-1	date	99/99/9999	Data livre	Não	001
dat-livre-2	date	99/99/9999	Data livre	Não	001
Idi-sit-eqpto	Int	>9	Situação do Equipamento	Não	001
Idi-sit-histor	Int	>9	Situação Histórico	Não	001

Tabela Temporária	Descrição	Entrada/Saída
RowErrors	Contém os erros ocorridos na BO.	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

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

Método Básico

Requisito	Nenhum
Sintaxe	run emptyRowErrors in h-handle.
Descrição	Limpa a temp-table de erros da API.
	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.

Requisito	Nenhum
Sintaxe	run getRowErrors in h-handle (output table RowErrors).
Descrição	Retorna os erros ocorridos na API.
	Parâmetros	Descrição
	RowErrors	Temp-Table de Erros da API
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.

Requisito	Nenhum
Sintaxe	run piCriaPendencia.
Descrição	Cria pendência no Histórico 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.

Requisito	Nenhum
Sintaxe	run piEnviaEmail.
Descrição	Envia e-mail para o responsável pelo equipamento, sobre pendência deste.
	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.