Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 mnbo/bomn140.p 

 

Objetivo

Validação, Manutenção e acesso rápido a tabela “param-mi”.

 

Funcionamento

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

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

A sintaxe para a chamada BO é:

run mnbo\bomn140.p.

 

A execução na forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run mnbo\bomn140.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 “param-mi”.

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ct-prev

Char

x(8)

Conta Padrão Manut Preventiva

 

 

sc-prev

Char

x(8)

Sub-Conta Prev

 

 

ct-corretiva

Char

X(8)

Conta Padrão Manut Corretiva

 

 

sc-corretiva

Char

x(8)

Sub-Conta  Corret

 

 

classe-a-pop

Dec

>>9.99

Perc Clas A Por Pop

 

 

classe-b-pop

Dec

>>9.99

Perc Clas B Por Pop

 

 

classe-c-pop

Dec

>>9.99

Perc Clas C Por Pop

 

 

classe-a-val

Dec

>>9.99

Perc Clas A Por Val

 

 

classe-b-val

Dec

>>9.99

Perc Clas B  Por Val

 

 

classe-c-val

Dec

>>9.99

Perc Clas C  Por Val

 

 

it-codigo

char

x(16)

Item

Sim

 

classe-a-par

Dec

>>9.99

Perc Classe A Tempo Parada

 

 

classe-b-par

Dec

>>9.99

Perc Classe B Tempo Parada

 

 

classe-c-par

Dec

>>9.99

Perc Classe C Tempo Parada

 

 

tp-relogio

Int

>9

Tipo Relógio

Sim

 

ct-serv-ger

Char

X(8)

Conta Padrão Serviços Gerais

 

 

sc-serv-ger

Char

X(8)

Sub-Conta Serv Gerais

 

 

prox-sol-serv

Int

>>>,>>>,>>9

Prox Solic Serviço

Sim

 

prior-uu-x

Int

>>9

Prioridade

Sim

 

prior-uu-y

Int

>>9

Prioridade

Sim

 

prior-uu-z

Int

>>9

Prioridade

Sim

 

prior-u-x

Int

>>9

Prioridade

Sim

 

prior-u-x

Int

>>9

Prioridade

Sim

 

prior-u-x

Int

>>9

Prioridade

Sim

 

prior-n-x

Int

>>9

Prioridade

Sim

 

prior-n-y

Int

>>9

Prioridade

Sim

 

prior-n-z

Int

>>9

Prioridade

Sim

 

aloca-estoq

Log

Sim/Não

Aloca Estoque Automático

Sim

 

ordem-unica

Log

Sim/Não

Ordem Única Por Equi

Sim

 

cd-calen

Char

X(9)

Calendário

Sim

 

cap-tag

Log

Sim/Não

Considera Capacidade TAG

 

 

prim-ord-plan

Int

>>>,>>>,>>9

Prim Ord Planejada

Sim

 

ult-ord-plan

int

>>>,>>>,>>9

Última Ord Planejada

Sim

 

aceite-taref

Log

Sim/Não

Aceite

 

 

per-fech-aut

Int

>>>9

Período Fechamento

 

 

rot-fabr

Int

>>9

Roteiro Lubrific

 

 

rot-insp

Int

>>9

Roteiro Inspeção

 

 

cd-equipto

Char

X(16)

Equipamento

 

 

formato-cd-equipto

char

x(16)

Formato Equipamento

 

 

formato-cd-tag

Char

X(16)

Formato Tag

 

 

cd-sint-padr

Char

X(8)

Sintoma Padrão

 

 

cd-causa-padr

Char

X(8)

Causa

 

 

cd-interv-padr

Char

X(8)

Intervenção

 

 

forma-aloc-esp

Int

>9

Forma Alocação Especialidade

 

 

perm-equip

Int

>9

Permite Equipamento Diferente Ativo

 

 

cod-catal-img

Char

X(8)

Catálogo Imagem

 

 

cod-catal-video

Char

X(8)

Catálogo Vídeo

 

 

char-1

char

X(100)

Livre 1

 

 

char-2

char

X(100)

Livre 2

 

 

log-1

Log

Sim/Não

Livre 1

 

 

log- 2

Log

Sim/Não

Livre 2

 

 

int-1

Int

->>>>>>>>>9

Livre 1

 

 

int-2

Int

->>>>>>>>>9

Livre 2

 

 

dec-1

Dec

->>>>>>>>>>>9.9999

Livre 1

 

 

dec-2

Dec

->>>>>>>>>>>9.9999

Livre 2

 

 

data-1

date

99/99/9999

Livre 1

 

 

data-2

date

99/99/9999

Livre 2

 

 

gera-pert

Log

Sim/Não

Gera Rede PERT

 

 

cod-catal-docto-anexo

Char

X(8)

Catálogo Documento

 

 

prop-utiliz

Log

Sim/Não

Propaga Utilização Encerramento

 

 

prim-sol-serv

Int

>>>,>>>,>>9

Prim Solic Serviço

 

 

ult-sol-serv

Int

>>>,>>>,>>9

Ult Solic Serviço

 

 

numer-única

Log

Sim/Não

Numeração Única

 

 

cd-turno

Int

>>9

Turno Padrão

 

 

prim-ord-man-mi

Int

>>>,>>>,>>9

Primeira Ordem Manual

 

 

ult-ord-man-mi

int          

>>>,>>>,>>9

Última Ordem Manual

 

 

prox-ord-man-mi

int          

>>>,>>>,>>9

Próxima Ordem Manual

 

 

prim-ord-aut-mi

int          

>>>,>>>,>>9

Primeira Ordem Automática

 

 

ult-ord-aut-mi

int          

>>>,>>>,>>9

Última Ordem Automática

 

 

prox-ord-aut-mi

int          

>>>,>>>,>>9

Próxima Ordem Automática

 

 

cod-estabel

char

x(3)

Estabel Padrão

 

 

aloca-reserva

Log

Sim/Não

Aloca Reserva

 

 

tp-intervalo

Int

>9

Intervalo Alocação

 

 

seq-param-mi

Int

>>>,>>>,>>9

Sequência

Sim

 

agrupa-om

Log

Sim/Não

Agrupa OM

Sim

 

tp-turno

Int

>9

Tipo Turno

 

 

cod-catal-docto-anexo-ss

Char

X(8)

Catalogo Documento SS

 

 

log-interf-util

Log

Sim/Não

Interfere Utilização

 

 

cd-tecnico

Char

99999-9

Técnico

 

 

 

 

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

 

ErrorNumber

integer

padrão

Número do erro

Sim

 

ErrorDescription

char

padrão

Descrição do erro

Sim

 

ErrorParameters

char

padrão

Parâmetros passados para criar mensagem

Não

 

ErrorType

char

padrão

Tipo do erro:

WARNING: Aviso

ERROR: Erro

Sim

 

ErrorHelp

char

padrão

Texto de ajuda do erro

Sim

 

ErrorSubType

char

padrão

Sub Tipo da mensagem de erro

Não

 

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

goToKey

Requisito

Nenhum

Sintaxe

run goToKey in h-handle (input <character>).

Descrição

Reposiciona o registro do Parâmetros da Manutenção Industrial através do código do  turno.

 

Parâmetros

Descrição

 

pcd-turno

Código do turno

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 <character>).

Descrição

Retorna os campos da chave primária da tabela.

 

Parâmetros

Descrição

 

pcd-turno

Código do turno.

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

openQueryDefault

Requisito

Nenhum.

Sintaxe

run openQueryDefault in h-handle.

Descrição

Busca conjunto de registros da tabela param-mi.

 

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.

afterUpdateRecord

Requisito

Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente.

Sintaxe

run afterUpdateRecord in this-procedure.

Descrição

Metodo executado após a atualização do registro.

 

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

   

getCatalogoMI

Requisito

Nenhum

Sintaxe

run getCatalogoMI in h-handle(output <character>).

Descrição

Retorna o código do catálogo de Imagem.

 

Parâmetros

Descrição

 

catalogo

Código do catálogo de imagem MI.

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

   

getDescFK

Requisito

Nenhum

Sintaxe

run getDescFKin h-handle(input <character>,

                         input <character>,

                         output <character>).

Descrição

Retorna descrição das chaves estrangeiras.

 

Parâmetros

Descrição

 

pTableName 

nome da tabela

 

pForeignKey

chave(s)

 

pFKDesc    

Descriçã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....

getFKRowid

Requisito

Nenhum

Sintaxe

run getFKRowid h-handle(input <character>,

                        input <character>,

                        output <rowid>).

Descrição

Retorna rowid das chaves estrangeiras.

 

Parâmetros

Descrição

 

pTableName 

nome da tabela

 

pForeignKey

chave(s)

 

pFKRowid   

rowid

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

setaProximaOrdemManual

Requisito

Procedure chamada internamente. Não deve ser chamada externamente.

Sintaxe

run setaProximaOrdemManual h-handle(input <integer>).

Descrição

Seta a próxima ordem manual.

 

Parâmetros

Descrição

 

i-prox-ord-manual

Numero da próxima 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....

setaProximaSolicServ

Requisito

Procedure chamada internamente. Não deve ser chamada externamente.

Sintaxe

run setaProximaSolicServ  h-handle(input <integer>).

Descrição

Seta a próxima solicitação de serviço.

 

Parâmetros

Descrição

 

i-prox-sol-serv

Número da próxima solicitação de serviç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....

validatePage2

Requisito

Procedure chamada pelo método interno ValidateRecord. Não deve ser chamada externamente.

Sintaxe

run validatePage2 in this-procedure.

Descrição

Método que faz as validações dos campos da página 2.

 

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

validatePage3

Requisito

Procedure chamada pelo método interno ValidateRecord. Não deve ser chamada externamente.

Sintaxe

run validatePage3 in this-procedure.

Descrição

Método que faz as validações dos campos da página 3.

 

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

validatePage3

Requisito

Procedure chamada pelo método interno ValidateRecord. Não deve ser chamada externamente.

Sintaxe

run validatePage3 in this-procedure.

Descrição

Método que faz as validações dos campos da página 3.

 

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

validatePage4

Requisito

Procedure chamada pelo método interno ValidateRecord. Não deve ser chamada externamente.

Sintaxe

run validatePage4 in this-procedure.

Descrição

Método que faz as validações dos campos da página 4.

 

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

validatePage5

Requisito

Procedure chamada pelo método interno ValidateRecord. Não deve ser chamada externamente.

Sintaxe

run validatePage5 in this-procedure.

Descrição

Método que faz as validações dos campos da página 5.

 

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

validatePage6

Requisito

Procedure chamada pelo método interno ValidateRecord. Não deve ser chamada externamente.

Sintaxe

run validatePage6 in this-procedure.

Descrição

Método que faz as validações dos campos da página 6.

 

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

validatePage7

Requisito

Procedure chamada pelo método interno ValidateRecord. Não deve ser chamada externamente.

Sintaxe

run validatePage7 in this-procedure.

Descrição

Método que faz as validações dos campos da página 7.

 

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

getTurnType

Requisito

Nenhum.

Sintaxe

run getTurnType in h—handle(output <integer>).

Descrição

Retorna o tipo de turno.

 

Parâmetros

Descrição

 

p-tipo-turno

1 – turno padrão

2 – informa turno

3 – não informa turno.

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