Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | mnbo/bomn010.p |
Objetivo
Incluir, atualizar, consultar e eliminar dados da tabela hist-ord-taref do aplicativo de manutenção industrial.
Funcionamento
Na forma padrão, realiza-se a chamada por um comando RUN.
A sintaxe para a chamada da BO é:
run mnbo/bomn010.p. |
A sintaxe para executar a BO em modo persistente é:
run mnbo/bomn010.p persistent set h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Nos atributos das tabelas temporárias de entrada e saída:
RowObject | Entrada/Saída | ||||
Tabela de comunicação entre interface e banco de dados da tabela hist-ord-taref. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
nr-ord-produ | Number | >>>,>>>,>>9 | Número da ordem de manutenção | Sim |
|
cd-tarefa | Number | >>>>9 | Tarefa Manutenção | Sim |
|
estado | Number | >9 | Estado da tarefa | Não |
|
usuario | Character | X(12) | Código do Usuário | Não |
|
data | Date | 99/99/9999 | Data da transação efetuada na tarefa/ordem | Não |
|
hora | Character | X(8) | Hora da transação efetuada na tarefa/ordem | Não |
|
transacao | Number | >9 | Transação 1 – Suspensa 2 – Reativada 3 - Histórico | Não |
|
narrativa | Character | X(2000) | Narrativa da transação | Não |
|
cd-pend-padr | Character | X(8) | Pendência Padrão | Não |
|
char-1 | Character | X(100) | Livre 1 | Não |
|
char-2 | Character | X(100) | Livre 2 | Não |
|
dec-1 | Decimal | ->>>>>>>>>>>9.99999999 | Livre 1 | Não |
|
dec-2 | Decimal | ->>>>>>>>>>>9.99999999 | Livre 2 | Não |
|
int-1 | Number | ->>>>>>>9 | Livre 1 | Não |
|
int-2 | Number | ->>>>>>>9 | Livre 2 | Não |
|
log-1 | logical | Sim/Não | Livre 1 | Não |
|
log-2 | Logical | Sim/Não | Livre 2 | Não |
|
data-1 | Date | 99/99/9999 | Livre 1 | Não |
|
data-2 | Date | 99/99/9999 | Livre 2 | Não |
|
check-sum | Character | X(20) | Check-sum | Não |
|
data-inform | Date | 99/99/9999 | Data Informada | Sim |
|
hora-inform | Character | X(8) | Hora informada | Sim |
|
taref-orig | Number | >>>>9 | Tarefa Origem | Não |
|
RowErrors | Entrada/Saída | ||||
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 |
|
tt-param | Entrada/Saída | ||||
Contem parâmetros para as faixas/filtro da ordem de manutenção. | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
c-acao | Character | padrão | Ação a ser realizada: “Suspender” ou “Reativar” | Sim |
|
c-cd-pendcia-padr | Character | X(8) | Código da pendência padrão | Sim (Somente se ação for Suspender) |
|
d-data-info | Date | padrão | Data informada | Sim |
|
c-hora-info | Character | X(8) | Hora informada | Sim |
|
c-narrativa | Character | X(40) | Narrativa da transação | Sim |
|
i-nr-ord-produ-ini | Number | >>>,>>>,>>9 | Número da ordem de manutenção inicial | Sim |
|
i-nr-ord-produ-fim | Number | >>>,>>>,>>9 | Número da ordem de manutenção final | Sim |
|
c-cd-equipto-ini | Character | X(16) | Código do Equipamento inicial | Sim |
|
c-cd-equipto-fim | Character | X(16) | Código do Equipamento Fim | Sim |
|
c-tag-ini | Character | X(16) | Código da TAG do Equipamento inicial | Sim |
|
c-tag-fim | Character | X(16) | Código da TAG do Equipamento final | Sim |
|
c-cod-estabel-ini | Character | X(5) | Código do Estabelecimento do Equipamento inicial | Sim |
|
c-cod-estable-fim | Character | X(5) | Código do Estabelecimento do Equipamento final | Sim |
|
c-manut-ini | Character | X(8) | Código da manutenção inicial | Sim |
|
c-manut-fim | Character | X(8) | Código da manutenção final | Sim |
|
d-manut-ini | Date | 99/99/9999 | Data da Manutenção inicial | Sim |
|
d-manut-fim | Date | 99/99/9999 | Data da Manutenção final | Sim |
|
i-tip-manut-ini | Number | >>,>>9 | Tipo Manutenção inicial | Sim |
|
i-tip-manut-fim | Number | >>,>>9 | Tipo Manutenção Final | Sim |
|
c-planejador-ini | Character | X(12) | Planejador inicial | Sim |
|
c-planejador-fim | Character | X(12) | Planejador Final | Sim |
|
c-equipe-ini | Character | X(8) | Equipe inicial | Sim |
|
c-equipe-fim | Character | X(8) | Equipe inicial | Sim |
|
destino | Number | Padrão | Destino de Impressão do Relatório | Sim |
|
arquivo | Character | Padrão | Nome do arquivo de destino do relatório | Sim |
|
usuario | Character | Padrão | Usuário logado | Sim |
|
data-exec | Date | Padrão | Data da emissão do relatório | Sim |
|
hora-exec | Number | Padrão | Hora da emissão do relatório | Sim |
|
classifica | Number | Padrão | Classificação para emissão do relatório | Sim |
|
desc-classifica | Character | X(40) | Descrição da classificação para emissão do relatório | Sim |
|
modelo-rtf | Character | X(35) | Nome do arquivo de modelo | Sim |
|
l-habilitador | Logical | Padrão | Habilita ou não a funcionalidade de RTF | Sim |
|
tt-digita | Entrada/Saída | ||||
Na entrada, contém as ordens que serão Suspensas/Reativadas, na saída contém as ordens que foram Suspensas/Reativadas. Os dados de entrada desta temp-table são opcionais, se não existirem registros o filtro de ordens será feito utilizando a temp-table tt-param. | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
nr-ord-produ | Number | >>>,>>>,>>9 | Número da ordem de manutenção | Não |
|
c-cd-equipto | Number | X(16) | Código do equipamento | Não |
|
c-tag | Character | X(16) | Código da TAG do equipamento | Não |
|
c-manut | Character | X(8) | Código da manutenção | Não |
|
d-manut | Date | 99/99/9999 | Data da manutenção | Não |
|
c-estado | Character | X(16) | Estado da ordem | Não |
|
c-planejador | Character | X(12) | Planejador | Não |
|
Selec | Character | Padrão | Ordens selecionadas na lista: “*” selecionada, “” não selecionada | Não |
|
Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
goToKey | ||
Requisito | Nenhum | |
Sintaxe | Run goToKey in h-handle (input <character> | |
Descrição | Posiciona o registro da hist-ord-taref através do código da função. | |
Parâmetros | Descrição | |
pcod-funcao | Código da função | |
Retorno | A 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 do registro posicionado. | |
Parâmetros | Descrição | |
pcod-funcao | Código da função | |
Retorno | A 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.... As mensagens possíveis para este método são.... |
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 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 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 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 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 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 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 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 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. |
validateRecord | ||
Requisito | Executar 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 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. |
suspendeReativaOrdem | ||
Requisito | Não se aplica. | |
Sintaxe | run validate in this-procedure (input <table>, input-output <table>). | |
Descrição | Suspende/Reativa as Ordens de Manutenção. | |
Parâmetros | Descrição | |
tt-param | Tabela que contém os parâmetros para o filtro da faixa de ordens de manutenção. | |
| tt-digita | Tabela que contém as ordens de manutenção que serão suspensas/reativadas e retorna ordens de manutenção que foram suspensas/reativadas, sendo que não é obrigatória a entrada desta tabela. |
Retorno | A BO irá suspender/reativar as ordens de manutenção que passarem pelo filtro das faixas e retornará elas. |
openQueryDefault | ||
Requisito | Nenhum | |
Sintaxe | run openQueryDefault in h-handle. | |
Descrição | Busca conjunto de registros da tabela hist-ord-taref. | |
Parâmetros | Descrição | |
Não Contém |
| |
Retorno | A 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. |