MIAPI011 - Integração do MI x Patrimônio (EMS2 x EMS5).

Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	mip/miapi011.p

Objetivo

Fazer a integração entre módulos de Manutenção e Patrimônio do EMS2 ou 5 recebendo os seguintes parâmetros:

run cdp/cdapi024.p (input table tt_trans_bem,

output table RowErrors).

Funcionamento

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/miapi011.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.

Tabelas Temporárias

Nos atributos das tabelas temporárias:

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

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ttv_num_empresa	int	999	Empresa	Sim / Key	001
ttv_cod_cta_pat	Char	X(18)	Conta Patrimonial	Não	001
ttv_num_bem_pat	Int	>>>>>>>>9	Bem Patrimonial	Não	001
ttv_num_seq_bem_pat	Int	>>>>9	Seqüência Bem	Não	001
ttv_dat_trans	date	99/99/9999	Data	Não	001
ttv_situacao	char	X(20)	Situação	Não	001

Tabela Temporária	Descrição	Entrada/Saída
Equipto	Contém os dados do Equipamento	Entrada

Atributo		Tipo	Formato	Descrição	Obrigatório		Evolução
Gm-codigo		Char	X(9)	Grupo de Maquina	Sim		001
Bm-codigo		Dec	ZZZ,ZZZ,ZZ9/	Bem	Sim		001
Bm-indice		Int	99999	Índice	Sim		001
Descricao		char	X(45)	Descrição	Não		001
cd-planejado		char	X(12)	Planejador	Sim		001
Fm-equipto		char	X(8)	Código da Família Equipamento	Sim		001
Situacao		int	>9	Situação do Equipamento	Sim		001
Tp-contador		Char	X(2)	Tipo de contador do Equipamento	Sim		001
Tp-equipto		Int	>9	Tipo do Equipamento	Sim		001
Cód-estabel		Char	X(3)	Estabelecimento Padrão do Equipamento	Sim		001
di-codigo		Int	>>>>9	Divisão de localização do Equipamento	Sim		001
cc-codigo		Char	X(8)	Centro Custo do Equipamento	Sim		001
Narrativa		Char	X(2000)	Narrativa do Equipamento	Não		001
Cód-emitente		Char	x(12)	Fornecedor	Não		001
Data-aquis		Date	99/99/9999	Data da aquisição	Não		001
Data-ativa		Date	99/99/9999	Data da Ativação	Não		001
Fornec-at		Char	X(12)	Fornecedor de Assistência Técnica do Equipamento	Não		001
Nr-nota		Char	X(16)	Número da Nota Fiscal	Não		001
Serie-nota		Char	X(5)	Série da Nota Fiscal	Não		001
Valor-aquis		Dec	>>>,>>>,>>9.99	Valor de Aquisição do Equipamento	Não		001
Fabricante		Char	X(20)	Fabricante	Não		001
Criticidade		Int	>9	Criticidade	Sim		001
Cód-altern		Char	X(16)	Alternativo	Sim		001
Motivo		Char	X(76)	Motivo	Não		001
De-codigo		Char	X(16)	Desenho	Não		001
Rv-codigo		Char	X(8)	Revisão	Não		001
cd-calen		Char	X(9)	Calendário	Sim		001
cd-tag		Char	X(16)	TAG	Sim		001
Tp-apont		Int	>9	Tipo Apontamento	Não		001
cd-parada		Char	X(8)	Parada	Não		001
Perc-rateio		Dec	>>9.99	Percentual de rateio	Sim		001
Fator-conversao		Dec	>>9.9999	Fator de conversão	Sim		001
Calc-utilizacao		Int	>9	Calculo utilização	Sim		001
Seqüência		Int	>>>>9	Seqüência de lubrificação	Sim		001
Vl-contador		Dec	>>>,>>>,>>>,>>9.9999	Valor do contador do equipamento	Não		001
cd-equipto		Char	X(16)	Equipamento	Sim		001
Cód-imagem		Char	X(30)	Imagem	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
Check-sum		Char	X(20)	Check-sum	Não		001
Ep-codigo		Int	>>9	Código da Empresa	Não		001
Cód-cta-pat		Char	X(18)	Conta Patrimonial	Não		001
Tabela Temporária	Descrição					Entrada/Saída
mi-histor-eqpto	Contém os dados do Histórico do Equipamento					Entrada

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

Métodos

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

Método Básico

emptyRowErrors

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.

getRowErrors

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.

Métodos de Negócio

piCriaPendencia

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.

piEnviaEmail

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.

Árvore de páginas