BOFR075 - Métodos para manutenção e acesso à tabela de Reporte Mão Obra da Tarefa da Ordem de Manutenção

Documento de BO

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

Objetivo

Validação, Manutenção e acesso rápido a tabela “mmv-movto-mdo”.

Funcionamento

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

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

A sintaxe para a chamada BO é:

run frbo\bofr075.p.

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run frbo\bofr075.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-movto-mdo”.	Entrada/Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ep-codigo	int	>>9	Código da Empresa do Funcionário	Sim / Key	001
cod-matr	char	x(10)	Matrícula do Funcionário	Sim / Key	001
val-dat-hora-invrtda-inicial	dec	999999999999	Valor da Data / Hora Invertida Inicial do Apontamento	Sim / Key	001
dat-movto	date	99/99/9999	Data Apontamento	Sim	001
hra-inicial	char	99:99:99	Hora Inicial do Apontamento	Sim	001
hra-final	char	99:99:99	Hora Final do Apontamento	Não	001
val-dat-hora-invrtda-final	dec	999999999999	Valor da Data / Hora Invertida Final do Apontamento	Não	001
cod-setor-ofici	char	x(8)	Código do Setor da Oficina	Sim	001
nr-ord-produ	int	>>>,>>>,>>9	Número da Ordem Manutenção	Não	001
num-seq	int	>>,>>9	Número da Tarefa da Ordem	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
log-tar-term	log	Sim/Não	Termina Tarefa?	Não	001
log-reporte-term	log	Sim/Não	Reporte Terminado?	Não	001
cod-localiz-compon	char	x(15)	Código de localização do Componente	Não	001
cc-codigo	char	x(20)	Código Centro Custo (Pode Vir do Funcionário ou do Setor da Oficina)	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-estabel-matr	char	x(3)	Estabelecimento do Funcionário	Sim
tp-especial	char	x(8)	Especialidade	Não
val-hora-normal-trabdo	dec	>>>,>>9.9999	Hora Normal	Não
val-hora-extra	dec	>>>,>>9.9999	Hora Extra	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

Tabela Temporária	Descrição	Entrada/Saída
ttTarefas	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
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

Tabela Temporária	Descrição	Entrada/Saída
tt-movto-dir	Tabela Temporária da API de Reporte de Mão de Obra do EMS tabela “movto-dir”.	Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

cod-versao-integracao

int

padrão

Código de Versão de Integração da API

Sim

001

num-id-movto-dir

int

Numeração Única do Movimento

Utiliza a Seqüência “seq-movto-dir”

Sim

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 <character>, input <decimal>).
Descrição	Reposiciona a query com base na chave primária da tabela.
	Parâmetros	Descrição
	pep-codigo	Código da Empresa do Funcionário
	pcod-matr	Matrícula do Fucnionário
	pval-dat-hora-invrtda-incial	Valor da Data/Hora invertida Inicial do Apontamento
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 <character>, output <decimal>).
Descrição	Retorna os campos da chave primária da tabela.
	Parâmetros	Descrição
	pep-codigo	Código da Empresa do Funcionário
	pcod-matr	Matrícula do Fucnionário
	pval-dat-hora-invrtda-incial	Valor da Data/Hora invertida Inicial do Apontamento
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.

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

linkToFuncionario

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

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-movto-mdo” 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.

setConstraintFuncionario

Requisito	Nenhum
Sintaxe	run setConstraintFuncionario in h-handle (input <integer>, input <character>).
Descrição	Seta as restrições para abrir a query pelo Funcionário da Oficina informado.
	Parâmetros	Descrição
	pEmpresa	Código da Empresa do Funcionário
	pMatricula	Matrícula do Funcionário
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.

setConstraintInvertida

Requisito	Nenhum
Sintaxe	run setConstraintInvertida in h-handle (input <decimal>, input <decimal>).
Descrição	Seta as restrições para abrir a query por faixa de Valor da Data/Hora Invertidas Iniciais do Apontamento de Mão de obra.
	Parâmetros	Descrição
	pInvertIni	Valor Data/Hora Inicial Invertida Inicial
	pInvertFim	Valor Data/Hora Inicial Invertida 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.

openQueryFuncionario

Requisito	A setConstraintFuncionario ter sido executada anteriormente.
Sintaxe	run openQueryFuncionario in h-handle.
Descrição	Abre a query da BO conforme a Empresa e Matrícula do Funcionário passados na procedure setConstraintFuncionario.
	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.

openQueryFuncionarioData

Requisito	A setConstraintFuncionario e a setConstraintInvertida tere sido executadas anteriormente.
Sintaxe	run openQueryFuncionarioData in h-handle.
Descrição	Abre a query da BO conforme a Empresa e Matrícula do Funcionário passados na procedure setConstraintFuncionario e conforme a faixa de Valor da Data/Hora invertidas Iniciais passada na procedure setConstraintInvertida.
	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.

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.

Método Negócio

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.

validateCriaTarefa

Requisito	Nenhum
Sintaxe	run validateCriaTarefa in h-handle (input <integer>, input <character>, input <integer>, input <integer>).
Descrição	Verifica se o funcionário que está tentando criar a tarefa da Ordem de Manutenção tem permissão para criar tarefas para a mesma, conforme campo <mmv-func-ofici. log-permite-cria-tar>.
	Parâmetros	Descrição
	pEmpresa	Código da empresa do Funcionário
	pMatr	Matrícula do Funcionário
	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 RowErrors.

validateEvento

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validateEvento in this-procedure.
Descrição	Validações referentes ao Evento do Reporte de Mão de Obra. Quando for reporte de Horas Paradas, deve-se informar um Evento que seja Motivo de Parada. Se for reporte de Horas Normais, deve-se informar um Evento que seja diferente de Motivo de Parada ou de Custos.
	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.

validateHorario

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validateHorario in this-procedure.
Descrição	Validações referentes aos campos de Data e Hora do reporte, verificando se estão informados e se estão no período correto.
	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.

validateOrdemTarefa

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validateOrdemTarefa in this-procedure.
Descrição	Validações referentes aos campos Número da Ordem de Manutenção e Número da Tarefa da Ordem. Se a Ordem foi informada, valida se a data e hora do reporte estão dentro da validade da Ordem, após sua criação e antes de seu término.
	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.

validateDataFuncionario

Requisito	Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente.
Sintaxe	run validateDataFuncionario in h-handle ( input <integer>, input <character>, input <character>, input <date>).
Descrição	Valida se Funcionário está ativo na data do reporte
	Parâmetros	Descrição
	pEmp	Código da Empresa
	pEstab	Código do Estabelecimento
	pFunc	Código do Funcionário
	pData	Data de 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 RowErrors.

beforeCreateRecord

Requisito	Procedure chamada pelo método interno CreateRecord. Não deve ser chamada externamente.
Sintaxe	run beforeCreateRecord in this-procedure.
Descrição	Método executado antes da criação do registro do reporte. Chama a procedure “criaTarefa”, que faz a manutenção da tarefa da Ordem informada. Verifica se não ocorreram para então chamar a procedure “alteraOrdemManut”, que fará a somatória de horas reportadas e atualizará na tarefa.
	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....

beforeDeleteRecord

Requisito	Procedure chamada pelo método interno DeleteRecord. Não deve ser chamada externamente.
Sintaxe	run beforeDeleteRecord in this-procedure.
Descrição	Método executado antes da eliminação do registro do reporte. Chama a “alteraOrdemManut”, que fará a somatória de horas reportadas e atualizará na tarefa.
	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....

beforeUpdateRecord

Requisito	Procedure chamada pelo método interno updateRecord. Não deve ser chamada externamente.
Sintaxe	run beforeUpdateRecord in this-procedure.
Descrição	Método executado antes da alteração do registro do reporte. Chama a procedure “criaTarefa”, que faz a manutenção da tarefa da Ordem informada. Verifica se não ocorreram para então chamar a procedure “alteraOrdemManut”, que fará a somatória de horas reportadas e atualizará na tarefa.
	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....

alteraOrdemManut

Requisito	Procedure chamada pelos métodos interno beforeCreateRecord beforeDeleteRecord beforeUpdateRecord. Não deve ser chamada externamente.
Sintaxe	run alteraOrdemManut in this-procedure (input <integer>).
Descrição	Verifica qual a ação que está sendo feita (Create, Update ou Delete), e chama a procedure “atualizaHorasOrdem”, passando os horários do reporte e se será feito estorno ou reporte. Quando for Inclusão (1 – Create), fará um reporte. Quando for Alteração (2 – Update), fará um estorno e um reporte. Quando for Eliminação (2 – Delete), fará um estorno.
	Parâmetros	Descrição
	pAcao	Tipo de Manutenção que está sendo feita no Reporte de Mão de Obra 1 – Create 2 – Update 3 – 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 tt-erro....

atualizaHorasOrdem

Requisito	Procedure chamada pelo método interno alteraOrdemManut. Não deve ser chamada externamente.
Sintaxe	run atualizaHorasOrdem in this-procedure (input <integer>, input <integer>, input <character>, input <character>, input <integer>, input <integer>).
Descrição	Calcula a quantidade de horas reportadas conforme a Hora Inicial e Final do apontamento de Mão de Obra, conforme o parâmetro recebido, irá somar (reporte) ou subtrair (estorno) da quantidade de horas reportadas da tarefa. Se for um estorno e for a eliminação do reporte, verifica-se a existência de mais reportes para a mesma tarefa, se não houverem, os campos referentes ao componente da tarefa são zerados e o estado da tarefa é modificado conforme o estado da Ordem. Quando for um reporte e for a inclusão, será atualizado o centro de custo do reporte, conforme parametrização pode vir do Funcionário ou do Setor da Oficina. Após todas as atualizações, chama as procedures de criação de GGF e Mão de obra para o EMS, “criaGGF” e “criaDIR”.
	Parâmetros	Descrição
	pOrdem	Número da ordem de Manutenção
	pTarefa	Número da Tarefa da Ordem de Manutenção
	pInicial	Hora Inicial do Reporte
	pFinal	Hora Final do Reporte
	pAcao	Tipo de Manutenção que está sendo feita no Reporte de Mão de Obra 1 – Create 2 – Update 3 – Delete
	pTipo	Tipo de Transação 1 – Reporte 2 – Estorno
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....

buscaHorario

Requisito	Nenhum
Sintaxe	run buscaHorario in this-procedure (input <integer>, input <character>, input <date>, output <character>).
Descrição	Busca o próximo horário a ser incluído ou iniciado para o apontamento de Mão de Obra do funcionário informado.
	Parâmetros	Descrição
	pEmp	Código da Empresa do Funcionário
	pMatr	Matrícula do Funcionário
	pData	Data do Apontamento
	pHora	Horário Inicial do Apontamento
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....

buscaUltimoReporte

Requisito	Nenhum
Sintaxe	run buscaUltimoReporte in h-handle (input <integer>, input <character>).
Descrição	Busca o último apontamento de horas do funcionário e verifica se o mesmo não está finalizado, gerando um erro.
	Parâmetros	Descrição
	pEmp	Código da Empresa do Funcionário
	pMatr	Matrícula do Funcionário
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....

criaDIR

Requisito	Procedure chamada pelo método interno alteraHorasOrdem. Não deve ser chamada externamente.
Sintaxe	run criaDIR in this-procedure (input <integer>, input <decimal>).
Descrição	Cria a temp-table tt-movto-dir (Movimento de Mão de Obra do EMS), chama a API (cpp\cpapi006.p), a qual cria o movimento e retorna se ocorreram erros.
	Parâmetros	Descrição
	pTipo	Tipo de Transação 1 – Reporte 2 – Estorno
	pQtdHoras	Quantidade de Horas Reportadas
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....

criaGGF

Requisito	Procedure chamada pelo método interno alteraHorasOrdem. Não deve ser chamada externamente.
Sintaxe	run criaGGF in this-procedure (input <integer>, input <decimal>).
Descrição	Cria a temp-table tt-movto-ggf (Movimento de Gastos Gerais de Fabricação do EMS), chama a API (cpp\cpapi005.p), a qual cria o movimento e retorna se ocorreram erros.
	Parâmetros	Descrição
	pTipo	Tipo de Transação 1 – Reporte 2 – Estorno
	pQtdHoras	Quantidade de Horas Reportadas
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....

criaTarefa

Requisito	Procedure chamada pelos métodos internos beforeCreateRecord e beforeUpdateRecord. Não deve ser chamada externamente.
Sintaxe	run criaTarefa in this-procedure.
Descrição	Conforme o registro da temp-table ttTarefas, passada pela procedure “recebeTarefa”, chama os métodos da BO da Tarefa da Ordem (frbo\bofr073.p), verifica se é uma alteração ou criação, valida os erros da manutenção da tarefa.
	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....

emptyttTarefas

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

estadoOrdem

Requisito	Método interno executado pela procedure “atualizaHorasOrdem”.
Sintaxe	run estadoOrdem in this-procedure.
Descrição	Altera o estado da Ordem de Produção do EMS, executando a API (mvp\mvapi001.p) persistente, e executando a procedure “alteraEstadoOrdem”. Verifica se ocorreram erros para acumular estes na BO.
	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....

piAction

Requisito	Nenhum
Sintaxe	run piAction in h-handle (input <character>).
Descrição	Seta a ação que está sendo feita no reporte de mão de obra.
	Parâmetros	Descrição
	pAcao	Ação que o programa de Reporte está executando. BEGIN = Inicializar Reporte END = Finalizar Reporte ADD = Incluir Reporte UPDATE = Alterar Reporte DELETE = Elimina 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....

piOficinaSetor

Requisito	Nenhum
Sintaxe	run piOficinaSetor in h-handle (input <character>, output <integer>).
Descrição	Busca a Ordem de Manutenção de Parada da Oficina do Setor da Oficina informado. No cadastro de setor da oficina, a Ordem pode estar zerada.
	Parâmetros	Descrição
	pSetor	Código do Setor da Oficina
	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....

piTipoOrdem

Requisito	Nenhum
Sintaxe	run piTipoOrdem in h-handle (input <integer>, output <logical>).
Descrição	Verifica o tipo de Ordem de Manutenção que foi informada. Quando for zero, significa Ordem de Horas de Parada. Quando a Ordem informada, for a Ordem da Oficina, também é uma Ordem de Horas de Parada. Para os outros casos é Ordem de Horas Normais.
	Parâmetros	Descrição
	pOrdem	Número da Ordem de Manutenção
	pParada	Indicador informando se é Ordem de Parada ou nã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....

recebeTarefa

Requisito	Nenhum
Sintaxe	run recebeTarefa in h-handle (input table ttTarefas).
Descrição	Recebe a temp-table de Tarefas da Ordem de Manutenção e verifica se existem registros na mesma.
	Parâmetros	Descrição
	ttTarefas	Temp-Table da tabela “mmv-tar-ord-manut” (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....

tarefasAbertasOM

Requisito	Nenhum
Sintaxe	run tarefasAbertasOM in h-handle (input <integer>, input <integer>).
Descrição	Verifica se existem tarefas da Ordem de Manutenção em aberto, que não sejam a informada.
	Parâmetros	Descrição
	pTarefa	Número da Tarefa da Ordem de Manutençã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....

fnEmpresaOM

Requisito	Nenhum
Descrição	Busca a Empresa da 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....

Árvore de páginas