ABAPI008 - Validações dos cadastros da Manutenção Industrial nas tabelas do produto Frotas

Documento de API

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

Considerações Gerais

Objetivo

A API, faz as validações dos relacionamentos das tabelas do produto frotas com as tabelas dos cadastros básicos da Manutenção Industrial do EMS.

Funcionamento

A API, recebe como parâmetro o rowid da tabela que será validada.

A execução da API só ocorre na forma persistente.

O programa chamador irá executar a procedure correspondente a validação da tabela.

A sintaxe para executar a API/BO em modo persistente é:

run abp/abapi008.p persistent set h-handle (input pRowid).

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 de entrada e saída:

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

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

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.

getRowErros
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run getRowErros in h-handle (output table RowErrors).
Descrição	Devolve a temp-table com os erros ocorridos dentro da API.
	Parâmetros	Descrição
	Temp-Table RowErrors	Temp-table de erros da API
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

validateCausaPadrao
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateCausaPadrao in h-handle.
Descrição	Valida os relacionamentos da tabela “causa-padrao” com as tabelas do produto frotas: mpn-pneu = Pneus mpn-movto-pneu = Movimentos de Pneus
	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.

validateEPI
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateEPI in h-handle.
Descrição	Valida os relacionamentos da tabela “epi” com as tabelas do produto frotas: mmv-tar-plano-epi = Equipamentos Proteção da Tarefa do Plano Manutenção Mecânica
	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.

validateFichaMetodo
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateFichaMetodo in h-handle.
Descrição	Valida os relacionamentos da tabela “mnt-ficha-metodo” com as tabelas do produto frotas: mmv-tar-plano-ficha = Ficha de Método da Tarefa do Plano Manutenção Mecânica
	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.

validateTAG
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateTAG in h-handle.
Descrição	Valida os relacionamentos da tabela “tag” com as tabelas do produto frotas: mab-eqpto = Equipamento Frotas mab-histor-ativid = Histórico do Equipamento Frotas
	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.

validateTipoFerramenta
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateTipoFerramenta in h-handle.
Descrição	Valida os relacionamentos da tabela “tp-ferr” com as tabelas do produto frotas: mmv-tar-plano-ferram = Ferramentas da Tarefa do Plano Manutenção Mecânica
	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

validateTipoManutencao
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateTipoManutencao in h-handle.
Descrição	Valida os relacionamentos da tabela “tipo-manut” com as tabelas do produto frotas: mmv-plano-prevent = Plano Manutenção Mecânica mpn-serv = Serviço mab-item-lubrific = Item Apontamento Lubrificação mab-movto-event = Movimento Evento mmv-movto-mdo = Reporte Horas Funcionários Manutenção Mecânica mmv-ord-manut = Ordem Manutenção Mecânica mmv-tar-ord-manut = Tarefa da Ordem Manutenção Mecânica
	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.

alteraItem
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run alteraItem in h-handle (INPUT <character> INPUT <character>).
Descrição	Alteração do código do item em Frotas
	Parâmetros	Descrição
	p-cod-item-anterior	Código Item Anterior
	p-cod-item-atual	Código Item Atual
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.

validateCalendario
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateCalendario in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “calen-gener” com as tabelas do produto frotas: mmv-ofici = Oficina mmv-plano-prevent = Plano Preventiva
	Parâmetros	Descrição
	p-cd-calen	Código Calendário
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.

validateCentroCusto
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateCentroCusto in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “centro-custo” com as tabelas do produto frotas: mmv-setor-ofici = Setor Oficina mmv-func-ofici = Funcionário Oficina mmv-movto-mdo = Movimento Reporte Horas Funcionários Manutenção Mecânica
	Parâmetros	Descrição
	p-cc-codigo	Código Centro de Custo
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.

validateCidade
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateCidade in h-handle (input <character> input <character> input <character>).
Descrição	Valida os relacionamentos da tabela “cidade” com as tabelas do produto frotas: mab-eqpto = Equipamentos mab-histor-ativid = Histórico Setor Grupo Atividade Eqpto mnd-movto-infracao = Infração mnd-param = Parâmetros Documentos
	Parâmetros	Descrição
	pcidade	Cidade
	pestado	Estado
	ppais	País
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.

validateConta
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateConta in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “conta” com as tabelas do produto frotas: mab-event = Eventos
	Parâmetros	Descrição
	pconta	Conta
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.

validateContaContabil
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateContaContabil in h-handle.
Descrição	Valida os relacionamentos da tabela “conta-contab” com as tabelas do produto frotas: mab-histor-ativid = Histórico Setor Grupo Atividade Eqpto mab-abastec-lubrific = Apontamento Abastecimento Lubrificação mpn-movto-pneu = Movimento Pneus mpn-param = Parâmetros Pneus mco-compon = Cadastro de Componentes mmv-ord-manut = Ordem de Manutenção Frota mab-movto-event = Movimento Evento
	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.

validateDeposito
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateDeposito in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “deposito” com as tabelas do produto frotas: mab-posto = Posto Abastecimento mpn-histor-vida = Histórico Vida Pneu mpn-movto-pneu = Movimento Pneus
	Parâmetros	Descrição
	p-cod-depos	Código Deposito
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.

validateEmitente
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateEmitente in h-handle (input <integer>).
Descrição	Valida os relacionamentos da tabela “emitente” com as tabelas do produto frotas: mab-posto = Posto Abastecimento mab-eqpto = Equipamentos mpn-histor-vida = Histórico Vida Pneu mpn-movto-pneu = Movimento Pneus mmv-ofici = Oficina mmv-movto-mater = Movimento Materiais nas Ordens de Manutenção mco-histor-vida = Histórico Vida Componente mnd-solicit-pagto = Solicitação Pagamento mnd-movto-proces = Movimento de Processos
	Parâmetros	Descrição
	p-cod-emitente	Código Emitente
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.

validateEmpresa
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateEmpresa in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “empresa” com as tabelas do produto frotas: mab-param = Parâmetro Frota mab-eqpto = Equipamentos mab-posto = Posto Abastecimento mpn-pneu = Cadastro de Pneus mmv-param = Parâmetros da Manutenção Mecânica mmv-func-ofici = Funcionário Oficina mgf-event-param = Parametrização dos Eventos de Custos
	Parâmetros	Descrição
	p-ep-codigo	Código Empresa
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.

validateEstabelecimento
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateEstabelecimento in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “estabelec” com as tabelas do produto frotas: mab-histor-ativid = Histórico Setor Grupo Atividade Eqpto mab-posto = Posto Abastecimento mpn-pneu = Cadastro de Pneus mpn-movto-pneu = Movimentos de Pneus mmv-ofici = Oficina mmv-ord-manut = Ordem Manutenção Mecânica mgf-cust-event = Apontamento dos Custos por Evento mgf-cust-item-estoq = Custo Item Estoque mco-compon = Cadastro de Componentes mco-movto-compon = Movimento Componente
	Parâmetros	Descrição
	p-cod-estabel	Código Empresa
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.

validateGrupoEstoque
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateGrupoEstoque in h-handle (input <integer>).
Descrição	Valida os relacionamentos da tabela “grup-estoque” com as tabelas do produto frotas: mmv-movto-mater = Movimento Materiais nas Ordens de Manutenção mgf-grp-estoq = Mgf Grupo Estoque
	Parâmetros	Descrição
	p-ge-codigo	Código Grupo Estoque
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.

validateItem
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateItem in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “item” com as tabelas do produto frotas: mab-tip-mater-item = Tipo do Material x Item Estoque mab-item-abastec = Item do Apontamento de abastecimento mab-item-lubrific = Item Apontamento Lubrificação mpn-histor-vida = Histórico Vida Pneu mpn-km-esperad = Durabilidade esperada por Desenho/Medida/Vida Pneu mmv-param = Parâmetros da Manutenção Mecânica mmv-tar-plano-item = Materiais Necessários para Tarefa do Plano mgf-cust-item-estoq = Custo Item Estoque mco-compon = Cadastro de Componentes mao-amostra-oleo = Amostra de Óleos
	Parâmetros	Descrição
	p-it-codigo	Código Item
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.

validateMaoObra
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateMaoObra in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “tab-mob-dir” com as tabelas do produto frotas: mmv-func-ofici = Funcionário Oficina
	Parâmetros	Descrição
	p-cd-mob-dir	Código Mob Direta
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.

validateNaturezaOperacao
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateNaturezaOperacao in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “natur-oper” com as tabelas do produto frotas: mpn-movto-pneu = Movimentos de Pneus
	Parâmetros	Descrição
	p-nat-operacao	Natureza Operação
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.

validateSubConta
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateSubConta in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “sub-conta” com as tabelas do produto frotas: mab-eqpto = Equipamentos mab-histor-ativid = Histórico do Equipamento Frotas mnd-movto-infracao = Infração mco-compon = Cadastro de Componentes mco-movto-compon = Movimento Componente
	Parâmetros	Descrição
	psubconta	Sub-Conta
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.

validateUF
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateUF in h-handle (input <character> input <character>).
Descrição	Valida os relacionamentos da tabela “unid-feder” com as tabelas do produto frotas: mab-motoris = Motorista mnd-movto-infracao = Infração mnd-solicit-pagto = Solicitação Pagamento mnd-movto-proces = Movimento de Processos
	Parâmetros	Descrição
	pestado	Estado
	ppais	País
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.

validateUnidade
Requisito	API deve estar rodando persistente na varável h-handle.
Sintaxe	run validateUnidade in h-handle (input <character>).
Descrição	Valida os relacionamentos da tabela “tab-unidade” com as tabelas do produto frotas: mab-tip-mater = Tipo de Material mab-model = Modelo Equipamento mpn-model = Modelo Pneu mgf-quant-transp = Apontamento Quantidade Transportada por Eqpto
	Parâmetros	Descrição
	pun	Unidade
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