BOFR073 - Métodos para manutenção e acesso à tabela de Tarefa Ordem Manutenção Mecânica

Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	frbo/bofr073

Objetivo

Validação, Manutenção e acesso rápido a tabela “mmv-tar-ord-manut”.

Funcionamento

A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mmv-tar-ord-manut”.

Na forma padrão, realiza-se a chamada através de um comando RUN.

A sintaxe para a chamada BO é:

run frbo\bofr073.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr073.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 BO.

Tabelas Temporárias

Nos atributos das tabelas temporárias:

Tabela Temporária	Descrição	Entrada/Saída
RowObject	Tabela de comunicação entre Interface e banco de dados da tabela “mmv-tar-ord-manut”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
nr-ord-produ	int	>>>,>>>,>>9	Número da Ordem Manutenção	Sim / Key	001
num-seq	int	>>,>>9	Número da Tarefa da Ordem	Sim / Key	001
cod-plano	char	x(8)	Código do Plano de Manutenção	Não	001
cod-evento	char	x(8)	Código do Evento	Sim	001
cod-sub-sist	char	x(8)	Código Sub Sistema	Não	001
cd-tipo	int	>>,>>9	Código Tipo Manutenção	Não	001
estado	int	>9	Estado da Tarefa 1 – Não Inciada 2 – Iniciada 3 – Cancelada 4 – Terminada (frinc\i01fr073.i)	Não	001
num-docto-movto-event	int	>>>,>>>,>>9	Número do Documento de Movimento de Eventos que gerou esta Tarefa	Não	001
cod-compon-reformad	char	x(16)	Código do Componente Reformado	Não	001
num-seqcial-reformad	int	>>>>>>>>9	Número Seqüencial Componente Reformado	Não	001
cod-sit-reformad	char	x(8)	Código Situação do Componente Reformado	Não	001
cod-compon-retir	char	x(16)	Código do Componente Retirado	Não	001
num-seqcial-retir	int	>>>>>>>>9	Número Seqüencial Componente Retirado	Não	001
cod-sit-retir	char	x(8)	Código Situação do Componente Retirado	Não	001
cod-compon-colocada	char	x(16)	Código do Componente Colocado	Não	001
num-seqcial-colocada	int	>>>>>>>>9	Número Seqüencial Componente Colocado	Não	001
cod-sit-colocada	char	x(8)	Código Situação do Componente Colocado	Não	001
val-km-hora-gartia	dec	>,>>>,>>9.9	Valor do Percurso de Garantia	Não	001
val-uso-estimad	dec	>>,>>>,>>9.9	Valor do Percurso Estimado	Não	001
num-dias-gartia	int	>>,>>9	Número de Dias de Garantia	Não	001
num-dias-estimad	int	>>,>>9	Número de Dias Estimados	Não	001
cod-localiz-compon	char	x(15)	Código de localização do Componente	Não	001
ep-codigo	int	>>9	Código da Empresa do Equipamento	Não	001
cod-eqpto	char	x(16)	Código Equipamento	Não	001
val-dat-invrtda-term	dec	999999999999	Valor da Data e Hora Invertidas de Término da Tarefa	Não	001
idi-tip-tar	int	9	Tipo de Tarefa 1 - NO - Normal 2 - RT - Retorno 3 - RG - Reclamar Garantia 4 - GA - Tarefa Possui Garantia (frinc\i00fr073.i)	Sim	001
val-hora-reporte	dec	>>>,>>9.999	Valor das Horas reportadas para a Tarefa.	Não	001
val-quant	dec	>>>	Indica a Quantidade	Não	001
cod-model-plano	char	X(8)	Código do Modelo	Não	001
num-seqcial-plano	Int	>>>>>>>>9	Número do Componente do Plano de Manutenção.	Não/Key
cod-setor-ofici	Char	X(8)	Código do Setor da Oficina	Não	001
dsl-obs	Char	X(2000)	Informações adicionais	Não	001
cod-orig-docto	Char	X(3)	Origem do documento	Não	001
log-e-mail	Log	Sim/Não	Email já enviado?	Sim	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
cod-emitente	int	>>>>>>>>9	Código do fornecedor da tarefa	Não
val-mdo-ggf	dec	->>>,>>>,>>9.99	Valor Custos Mão Obra e GGF	Não
val-mater	dec	->>>,>>>,>>9.99	Valor Material gasto na tarefa	Não

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 BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

Método Básico

goToKey

Requisito	Nenhum
Sintaxe	run goToKey in h-handle (input <integer>, input <integer>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pnr-ord-produ	Número da Ordem de Manutenção
	pnum-seq	Número da Tarefa da Ordem de Manutenção
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.

getKey

Requisito	Nenhum
Sintaxe	run getKey in h-handle (output <integer>, output <integer>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pnr-ord-produ	Número da Ordem de Manutenção
	pnum-seq	Número da Tarefa da Ordem de Manutenção
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.

getCharField

Requisito	Nenhum
Sintaxe	run getCharField in h-handle (input <character>, output <character>).
Descrição	Retorna os valores dos campos da tabela que são caracteres.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
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.

getDateField

Requisito	Nenhum
Sintaxe	run getDateField in h-handle (input <character>, output <date>).
Descrição	Retorna os valores dos campos da tabela que são data.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
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.

getDecField

Requisito	Nenhum
Sintaxe	run getDecField in h-handle (input <character>, output <decimal>).
Descrição	Retorna os valores dos campos da tabela que são decimais.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
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.

getIntField

Requisito	Nenhum
Sintaxe	run getIntField in h-handle (input <character>, output <integer>).
Descrição	Retorna os valores dos campos da tabela que são inteiros.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
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.

getLogField

Requisito	Nenhum
Sintaxe	run getLogField in h-handle (input <character>, output <logical>).
Descrição	Retorna os valores dos campos da tabela que são Lógicos.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
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.

getMovtoCompon

Requisito	Nenhum
Sintaxe	run getMovtoCompon in h-handle (output ttMovtoCompon).
Descrição	Retorna tabela para o método chamador.
	Parâmetros	Descrição
	ttMovtoCompon	Temp-table
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.

getRawField

Requisito	Nenhum
Sintaxe	run getRawField in h-handle (input <character>, output <raw>).
Descrição	Retorna os valores dos campos da tabela que são caracteres longos.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
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.

getRecidField

Requisito	Nenhum
Sintaxe	run getRecidField in h-handle (input <character>, output <recid>).
Descrição	Retorna os valores dos campos da tabela que são numéricos e definem uma seqüência única para a tabela dentro do database.
	Parâmetros	Descrição
	pFieldName	Nome do campo a ser retornado
	pFieldValue	Valor do campo.
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.

getRowid

Requisito	Nenhum
Sintaxe	run getRowid in h-handle (output <rowid>).
Descrição	Retorna o ROWID do registro corrente da Query que está aberta na BO. Este método não aparece para ser manutenido.
	Parâmetros	Descrição
	pRowid	Rowid da tabela.
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.

OpenQuery / SetConstraint / LinkTo

linkToOM

Requisito	Ser chamado somente quando há o Join entre a tabela em questão e a tabela mmv-ord-manut.
Sintaxe	run linkToOM in h-handle (input <hanlde>).
Descrição	Faz o JOIN entre as tabelas “mmv-tar-ord-manut” e “mmv-ord-manut”. Recebe como parâmetro o handle da BO da tabela mmv-ord-manut, para buscar a chave primária da mesma (do registro corrente na BO), para setar as restrições “setConstraintOM”.
	Parâmetros	Descrição
	pHandle	Handle da BO “mmv-ord-manut” (Ordem Manutenção).
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.

linkToEqpto

Requisito	Ser chamado somente quando há o Join entre a tabela em questão e a tabela mmv-ord-manut.
Sintaxe	run linkToEqpto in h-handle (input <hanlde>).
Descrição	Faz o JOIN entre as tabelas “mmv-tar-ord-manut” e de equipamento.
	Parâmetros	Descrição
	pHandle	Handle da BO “mmv-ord-manut” (Ordem Manutenção).
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.

setConstraintFaixaOM

Requisito	Nenhum
Sintaxe	run setConstraintFaixaOM in h-handle (input <integer>, input <integer>).
Descrição	Seta as restrições para abrir a query por faixa de Número da Ordem de Manutenção
	Parâmetros	Descrição
	pOMIni	Número Ordem Inicial
	pOMFim	Número Ordem Final
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.

setConstraintFaixaTarefa

Requisito	Nenhum
Sintaxe	run setConstraintFaixaTarefa in h-handle (input <integer>, input <integer>).
Descrição	Seta as restrições para abrir a query por faixa de Número da Tarefa da Ordem de Manutenção
	Parâmetros	Descrição
	pTarIni	Número da Tarefa da Ordem Inicial
	pTarFim	Número da Tarefa da Ordem Final
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.

setConstraintEqpto

Requisito	Nenhum
Sintaxe	run setConstraintEqpto in h-handle (input <integer>, input <character>).
Descrição	Seta as restrições na BO para o Equipamento.
	Parâmetros	Descrição
	pi-ep-codigo	Código da Empresa
	pc-cod-eqpto	Código do Equipamento
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.

setConstraintParamTarefa

Requisito	Nenhum
Sintaxe	run setConstraintParamTarefa in h-handle (input <logical>, input <logical>, input <logical>, input <logical>).
Descrição	Seta as restrições para abrir a query por estado.
	Parâmetros	Descrição
	pl-nao-iniciada	Indica estado da Tarefa não iniciada
	pl-iniciada	Indica estado da Tarefa iniciada
	pl-cancelada	Indica estado da Tarefa cancelada
	pl-terminada	Indica estado da Tarefa terminada
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.

setConstraintSelecTarefa

Requisito	Nenhum
Sintaxe	run setConstraintSelecTarefa in h-handle (input <date>, input <date>, input <character>, input <character>, input <character>, input <character>, input <integer>, input <integer>).
Descrição	Seta as restrições para abrir a query por faixa de data de término, código evento, código subsistema e tipo manutenção.
	Parâmetros	Descrição
	pdt-term-ini	Data término inicial
	pdt-term-fin	Data término final
	pc-cod-evento-ini	Código evento inicial
	pc-cod-evento-fin	Código evento final
	pc-cod-sub-sist-ini	Código subsistema inicial
	pc-cod-sub-sist-fin	Código subsistema final
	pi-cd-tipo-ini	Tipo manutenção inicial
	pi-cd-tipo-fin	Tipo manutenção final
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.

setConstraintOM

Requisito	Nenhum
Sintaxe	run setConstraintOM in h-handle (input <integer>).
Descrição	Seta as restrições para abrir a query pelo Número da Ordem de Manutenção informado.
	Parâmetros	Descrição
	pDocumento	Número da Ordem de Manutenção
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.

openQueryMain

Requisito	Nenhum
Sintaxe	run openQueryMain in h-handle.
Descrição	Abre a query da BO com todos os registros.
	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.

openQueryOM

Requisito	A setConstraintOM ter sido executada anteriormente.
Sintaxe	run openQueryOM in h-handle.
Descrição	Abre a query da BO conforme o número da Ordem de Manutenção passado na procedure setConstraintOM.
	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.

openQueryOMFiltro

Requisito	A setConstraintOM e a setConstraintEstadoTar, terem sido executadas anteriormente.
Sintaxe	run openQueryOMFiltro in h-handle.
Descrição	Abre a query da BO conforme o número da Ordem de Manutenção passado na procedure setConstraintOM, utilizando o filtro de Estado das Tarefas passados na procedure setConstraintEstadoTar.
	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.

openQueryOMTarefa

Requisito	A setConstraintFaixaOM e a setConstraintFaixaTarefa terem sido executadas anteriormente.
Sintaxe	run openQueryOMTarefa in h-handle.
Descrição	Abre a query da BO conforme a faixa de Número da Ordem de Manutenção passada na procedure setConstraintFaixaOM e conforme a faixa de Tarefa da Ordem de Manutenção passada na procedure setConstraintFaixaTarefa.
	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.

openQueryTarEqpto

Requisito	A setConstraintEqpto ter sido executada anteriormente.
Sintaxe	run openQueryTarEqpto in h-handle.
Descrição	Abre a query com todos os registros por faixa de date de Término,código evento, código subsistema e tipo manutenção e utilizando o filtro de estado.
	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.

openQueryTarOrdManut

Requisito	A setConstraintFaixaOM ter sido executada anteriormente.
Sintaxe	run openQueryTarOrdManut in h-handle.
Descrição	Abre a query com todos os registros por faixa de date de Término,código evento, código subsistema e tipo manutenção e utilizando o filtro de estado.
	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.

Método Negócio

piFiltroEvento

Requisito	Nenhum
Sintaxe	run piFiltroEvento in this-procedure (input <character>).
Descrição	Filtra o evento e grupo de evento.
	Parâmetros	Descrição
	pEvento	Código do evento
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

validateRecord

Requisito	Ter sido executada alguma ação para manutenção do registro da tabela. Esta procedure é executada somente internamente pela BO.
Sintaxe	run validate in this-procedure (input <character>).
Descrição	Valida as ações feitas em cima do registro da tabela corrente da BO. Estas ações podem ser: “CREATE”, “UPDATE” e “DELETE”.
	Parâmetros	Descrição
	pType	Tipo de ação: “CREATE” “UPDATE” “DELETE”
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.

validateComponenteSituacao

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validateComponenteSituacao in this-procedure.
Descrição	Faz as validações para atributos de Componentes. num-seqcial-reformad = Número Seqüencial Componente Reformado num-seqcial-retir = Número Seqüencial Componente Retirado num-seqcial-colocada = Número Seqüencial Componente Colocada cod-compon-reformad = Código Componente Reformado cod-compon-retir = Código Componente Retirado cod-compon-colocada = Código Componente Colocado cod-sit-reformad = Código Situação Componente Reformado cod-sit-retir = Código Situação Componente Retirado num-dias-estimad = Número dias estimativa val-uso-estimad = Valor Percurso estimativa num-dias-gartia = Número dias Garantia val-km-hora-gartia = Valor Percurso Garantia
	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.

validateDuplicidade

Requisito	Procedure chamada pelo método interno validateRecord. Pode ser chamada externamente.
Sintaxe	run validateDuplicidade in h-handle (input <integer>, input <integer>, input <character>, input <character>, input <character>).
Descrição	Valida a duplicidade de tarefas para mesma localização, fazendo o mesmo trabalho.
	Parâmetros	Descrição
	pOrdem	Número da Ordem
	pTarefa	Número da Tarefa
	pEvento	Código do Evento
	pSub	Código do Sub Sistema
	pLocal	Localização do Componente
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.

validateEventoSubSistema

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validateEventoSubSistema in this-procedure.
Descrição	Faz as validações para os campos Evento e Sub-Sistema.
	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.

validatePlano

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validatePlano in this-procedure.
Descrição	Validações do plano de manutençã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.

validateEventos

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validateEventos in h-handle (input <integer>).
Descrição	Verifica se existem eventos programados para o equipamento que não sejam "Motivo de Parada" ou "Custos"
	Parâmetros	Descrição
	pOrdem	Número da Ordem de Manutenção do Eqpto
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.

afterUpdateRecord

Requisito	Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente.
Sintaxe	run afterUpdateRecord in this-procedure.
Descrição	Modifica o tipo de ordem de manutençã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 tt-erro....

afterCreateRecord

Requisito	Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.
Sintaxe	run afterCreateRecord in this-procedure.
Descrição	Verifica se existem mais tarefas do plano de manutenção a serem criadas, cria avisos da duplicidade de tarefas para a mesma localizaçã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 tt-erro....

beforeCreateRecord

Requisito	Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.
Sintaxe	run beforeCreateRecord in this-procedure.
Descrição	Verifica se cria tarefas do plano quando este for informado. Chama a procedure “gravaManutencao”.
	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 tt-erro....

afterDeleteRecord

Requisito	Procedure chamada pelo método interno DeleteRecord. Não deve ser chamada externamente.
Sintaxe	run afterDeleteRecord in this-procedure.
Descrição	Se a tarefa que foi eliminada for originada de um Evento Programado, é executada a procedure “disparaEvento”, passando valor false, para deixar o Evento não disparado.
	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 tt-erro....

buscaKM

Requisito	Nenhum
Sintaxe	run buscaKM in h-handle (input <integer>, input <character>, input <decimal>, output <decimal>).
Descrição	Busca a quilometragem do equipamento na data do movimento da tarefa.
	Parâmetros	Descrição
	pEmpresa	Código da Empresa do Equipamento
	pEqpto	Código do Equipamento
	pInvertida	Data / Hora Invertida Movimento
	pKM	Valor da Quilometragem do Equipamento
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 tt-erro....

buscaModelo

Requisito	Nenhum
Sintaxe	run buscaModelo in h-handle (input <pOrdem>).
Descrição	Busca o código do modelo do equipamento ou do componente, conforme o tipo da Ordem de Manutenção.
	Parâmetros	Descrição
	pOrdem	Número da Ordem de Manutenção
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 tt-erro....

buscaTarefa

Requisito	Nenhum
Sintaxe	run buscaTarefa in this-procedure (input <integer>, input <integer>).
Descrição	Busca qual a próxima numeração da tarefa da Ordem de Manutenção
	Parâmetros	Descrição
	pOrdem	Número da Ordem de Manutenção
	pTarefa	Número da Tarefa da Ordem de Manutenção
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 tt-erro....

criaMovtoCompon

Requisito	Nenhum.
Sintaxe	run criaMovtoCompon in h-handle (input <integer>, input <integer>, input <character>, input <character>, input <decimal>).
Descrição	Cria movimento de componentes
	Parâmetros	Descrição
	pTipo	Tipo de Evento
	pSeq	Número sequencial
	pComp	Código do Componente
	pSit	Situação do componente
	pDataHora	Data e Hora
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 tt-erro....

eliminaTarefas

Requisito	Nenhum
Sintaxe	run eliminaTarefas in h-handle (input table RowObject2).
Descrição	Elimina as tarefas em batch. Executa a procedure “deleteRecord”. Guarda todos os erros que possam ter acontecido, mas não desfaz as tarefas já eliminadas.
	Parâmetros	Descrição
	RowObject2	Temp-Table Auxiliar da tabela de comunicação da <mmv-tar-ord-manut>.
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 tt-erro....

eliminaMovtoCompon

Requisito	Nenhum
Sintaxe	run eliminaMovtoCompon in h-handle (input <handle> input <integer>).
Descrição	Desvincular os Movimentos de Componentes das Tarefas da Ordem Manutenção.
	Parâmetros	Descrição
	hDBOComp	Handle para BO de componetes
	iErro	Indice de Erros
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 tt-erro....

disparaEvento

Requisito	Nenhum
Sintaxe	run disparaEvento in h-handle (input <integer>, input <logical>).
Descrição	Dispara ou não o Evento Programado.
	Parâmetros	Descrição
	pDocto	Número do Documento
	pDispara	Dispara o Evento?
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 tt-erro....

estadoTarefa

Requisito	Nenhum
Sintaxe	run estadoTarefa in h-handle (input table RowObject).
Descrição	Altera o estado da Tarefa da Ordem de Manutenção em Batch. Recebe os registros já modificados em temp-table e estes são atualizados em tabela.
	Parâmetros	Descrição
	RowObject	Temp-Table de comunicação da <mmv-tar-ord-manut>.
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 tt-erro....

geracaoEventos

Requisito	Nenhum
Sintaxe	run geracaoEventos in h-handle (input <integer>, input <decimal>, input table RowObject).
Descrição	Gera Eventos Programados se não existirem para as tarefas da Ordem de Manutenção não iniciadas. Após ter criado os eventos, chamando a BO (frbo\bofr059.p), executa a procedure “eliminaTarefas”, para excluir as tarefas Não Iniciadas.
	Parâmetros	Descrição
	pDias	Número de Dias do Vencimento do Evento
	pPercurso	Valor do Percurso que irá vencer o Evento
	RowObject	Temp-Table de comunicação da <mmv-tar-ord-manut>.
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 tt-erro....

EncerraEvento

Requisito	Nenhum
Sintaxe	run encerraEventos in h-handle (input <integer>, input <date>, input <character>).
Descrição	Encenrra eventos programados.
	Parâmetros	Descrição
	pDocto	Número do Documento
	pData	Data de término do evento
	pHora	Hora de término do evento
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 tt-erro....

gravaEventos

Requisito	Nenhum
Sintaxe	run gravaEventos in h-handle (input <integer>).
Descrição	Verifica se existem eventos programados para o equipamento da Ordem de Manutenção que não sejam "Motivo de Parada" ou "Custos" e grava os mesmos nas tarefas da Ordem de Manutenção. Utiliza o campo “num-docto-movto-event”, no qual grava o “mab-movto-event.num-docto”.
	Parâmetros	Descrição
	pOrdem	Número da Ordem de Manutenção
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 tt-erro....

gravaManutencao

Requisito	Procedure chamada pelo método interno beforeCreateRecord. Não deve ser chamada externamente.
Sintaxe	run gravaManutencao in this-procedure.
Descrição	Verifica o plano informado, se o mesmo gera tarefas, para criar as mesmas para a Ordem de Manutenção. Se cria tarefas, cria uma temp-table auxiliar “RowObject2”, que guarda as tarefas do plano para serem criadas no afterCreateRecord.
	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 tt-erro....

gravaComponentes

Requisito	Procedure chamada pelo método interno beforeCreateRecord. Não deve ser chamada externamente.
Sintaxe	run gravaComponentes in h-handle (input <integer>).
Descrição	Cria as tarefas de componentes que estão vencidos.
	Parâmetros	Descrição
	pOrdem	Ordem de Manutenção
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 tt-erro....

gravaTipoTarefa

Requisito	A temp-table RowObject, deve estar populada.
Sintaxe	run gravaTipoTarefa in h-handle (input table RowObject, output <integer>).
Descrição	Valida o registro da RowObject e verifica qual o tipo de tarefa é a mesma. 1 = NO – Normal (Garantia não foi digitada) 2 = RT - Retrabalho ou Retorno (Tarefa refeita antes do prazo de retorno) 3 = RG - Reclamar Garantia (Tarefa dentro da garantia da anterior) 4 = GA - Tarefa possui Garantia (Número dias Garantia foi digitado)
	Parâmetros	Descrição
	RowObject	Temp-Table da tabela “mmv-tar-ord-manut”
	pTipo	Tipo da Tarefa.
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 tt-erro....

piTrocaComponente

Requisito	Nenhum
Sintaxe	run piTrocaComponente in h-handle (input <integer>, input <character>, input <integer>).
Descrição	Verifica se o componente foi informado em tela, criando um aviso, tando para Componentes Retirados como para Colocados. Valida o valor contra o parâmetro da Empresa da Ordem de Manutenção, se deixa passar, Deixa e avisa ou não deixa e avisa.
	Parâmetros	Descrição
	pOrdem	Número da Ordem de Manutenção
	pCompon	Código do Componente
	pTipo	Tipo de Componente 1 – Retirado 2 – Colocado
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 tt-erro....

piCriaAviso

Requisito	Nenhum
Sintaxe	run piCriaAviso in h-handle (input <character>, input <integer>, input <integer>).
Descrição	Cria os avisos / erros necessários para serem mostrados ao criar tarefas que contém garantia, ou retorna status para interface para fazer pergunta ao usuário.
	Parâmetros	Descrição
	pGarantia	Character informando o valor do número de dias ou a Unidade de Garantia do Percurso.
	pTipo	Tipo do Serviço prestado. 1 – Serviço 2 – Componente 3 – Retorno
	pTipo2	Tipo de Aviso da Garantia 1 – Dias 2 – Unidade
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 tt-erro....

piCalculaKM

Requisito	Nenhum
Sintaxe	run piCalculaKM in h-handle (input <integer>, input <character>, input <decimal>, input <integer>, input <decimal>).
Descrição	Busca a quilometragem do equipamento em uma data.
	Parâmetros	Descrição
	pEmp	Código da Empresa
	pEqpto	Código do Equipamento
	pInvertida	Data/Hora Invertida
	pTipo	Qual campo retornar (1 = Percurso / 2 = Contador)
	pKM	Valor da Quilometragem na data
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 tt-erro....

verificaEventos

Requisito	Nenhum
Sintaxe	run verificaEventos in h-handle (input <integer>).
Descrição	Verifica se existem eventos programados para o equipamento que não sejam "Motivo de Parada" ou "Custos". Retorna Status para programa interface.
	Parâmetros	Descrição
	pOrdem	Número da Ordem de Manutenção
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 tt-erro....

gravaNarrativa

Requisito	Nenhum
Sintaxe	run gravaNarrativa in h-handle (input <integer>, input <integer>, input <character>).
Descrição	Altera o estado da Tarefa da Ordem de Manutenção.
	Parâmetros	Descrição
	pi-nr-ord-produ	Número da Ordem de Manutenção (“mmv-tar-ord-manut.nr-ord-produ”).
	pi-num-seq	Número da Tarefa da Ordem de Manutenção (“mmv-tar-ord-manut.num-seq”)
	pc-narrativa	Informações adicionais (“mmv-tar-ord-manut.dsl-obs”)
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 tt-erro....

setaPrograma

Requisito	Nenhum
Sintaxe	run setaPrograma in h-handle (input <character>).
Descrição	Seta na BO o nome do programa que criou a Ordem.
	Parâmetros	Descrição
	pPrograma	Código do programa que criou a Ordem.
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 tt-erro....

setaReporte

Requisito	Nenhum
Sintaxe	run setaReporte in h-handle (input <logical>).
Descrição
	Parâmetros	Descrição
	l-reporte
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 tt-erro....

setMovtoCompon

Requisito	Nenhum
Sintaxe	run setMovtoCompon in h-handle (input <temp-table>).
Descrição	Recebe a temp-table “ttMovtoCompon”.
	Parâmetros	Descrição
	ttMovtoCompon	Temp-Table que será recebida.
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 tt-erro....

origemTarefaPlanos

Requisito	Nenhum
Sintaxe	run origemTarefaPlanos in h-handle (input <character>, input <integer>, input <character>).
Descrição	Busca a origem da tarefa de planos de manutenção.
	Parâmetros	Descrição
	pModelo	Código do modelo
	pTipo	Tipo de Ordem de Manutenção
	pOrig	Código da Origem
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 tt-erro....

buscaDescricaoTarefa

Requisito	Nenhum
Sintaxe	run buscaDescricaTarefa in h-handle (input <integer>, input <integer>, output <character>).
Descrição	Busca descrição sobre as tarefas.
	Parâmetros	Descrição
	pNunOM	Número da Ordem de Manutenção
	pNunTarefa	Número da Tarefa
	pDescTarefa	Descrição da Tarefa
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 tt-erro....

piValidadePlanoEqpto

Requisito	Método interno chamado pela procedure “validateRecord”.
Sintaxe	run piValidadePlanoEqpto in this-procedure (input <integer>, input <character>, input <character>, input <date>).
Descrição	Verifica se o plano de manutenção relacionado ao equipamento é valido. Essa validação é referente a entrada do equipamento na manutenção, e é realizada no cadastra da tarefa da ordem de manutenção.
	Parâmetros	Descrição
	pEpCodigo	Código Empresa
	pCodEqpto	Código Equipamento
	pCodPlano	Código do Plano de Manutenção
	pDatEntr	Data da Entrada do Equipamento na Manutenção
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 “tt-erro”.
	PROCEDURE updateAllOrderTasks:

updateAllOrderTasks

Requisito	Nenhum.
Sintaxe	run updateAllOrderTasks in h-handle (input <integer>, input <integer>, input <character>, input <character>).
Descrição	Realiza a alteração das informações (Tipo Manutenção, Causa e Sintomas) das tarefas da ordem, conforme informado na própria ordem de manutenção.
	Parâmetros	Descrição
	pNrOrd	Número da Ordem de Manutenção Mecânica
	pTpOrd	Código do Tipo da Manutenção
	pCausa	Código da Causa da Manutenção
	pSintoma	Código do Sintoma da Manutenção
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 “tt-erro”.

Árvore de páginas