Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | frbo/bofr074 |
Objetivo
Validação, Manutenção e acesso rápido a tabela “mpn-movto-pneu”.
Funcionamento
A BO irá validar os dados, manutenir a tabela e fazer a leitura dos registros da tabela “mpn-movto-pneu”.
Na forma padrão, realiza-se a chamada através de um comando RUN.
A sintaxe para a chamada BO é:
run frbo\bofr074.p.
A execução na forma persistente ...
A sintaxe para executar a BO em modo persistente é:
run frbo\bofr074.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 “mpn-movto-pneu”. | Entrada/Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
num-docto | int | >>>,>>>,>>9 | Número Documento | Sim / Key | 001 |
dat-movto | date | 99/99/9999 | Data do Movimento | Sim | 001 |
hra-inic-apont | char | 99:99:99 | Hora início do Movimento | Sim | 001 |
hra-fim-apont | char | 99:99:99 | Hora término do Movimento | Sim | 001 |
val-dat-hora-invrtda | dec | 999999999999 | Valor da Data e Hora Invertidas do Apontamento | Sim | 001 |
qti-conserto | int | >>9 | Quantidade de Consertos no Pneu | Sim | 001 |
cod-pneu | char | x(12) | Código do Pneu | Sim | 001 |
ep-codigo-orig | int | >>9 | Código Empresa Origem | Sim | 001 |
cod-eqpto-orig | char | x(16) | Código Equipamento Origem | Sim | 001 |
val-hodom-horim-orig | dec | >,>>>,>>9.9 | Contador Origem | Não | 001 |
cod-pos-orig | char | x(3) | Código Posição Origem | Sim | 001 |
cod-estabel-orig | char | x(3) | Código Estabelecimento Origem | Não | 001 |
cod-servico | char | x(4) | Código Serviço Executado | Sim | 001 |
cd-causa-padr | char | x(8) | Código Causa Padrão do Movimento | Sim | 001 |
val-sulco-1 | dec | >>9.9 | Valor Sulco 1 do Pneu | Sim | 001 |
val-sulco-2 | dec | >>9.9 | Valor Sulco 2 do Pneu | Sim | 001 |
val-sulco-3 | dec | >>9.9 | Valor Sulco 3 do Pneu | Sim | 001 |
val-sulco-4 | dec | >>9.9 | Valor Sulco 4 do Pneu | Sim | 001 |
val-sulco-5 | dec | >>9.9 | Valor Sulco 5 do Pneu | Sim | 001 |
val-sulco-6 | dec | >>9.9 | Valor Sulco 6 do Pneu | Sim | 001 |
val-sulco-7 | dec | >>9.9 | Valor Sulco 7 do Pneu | Sim | 001 |
val-sulco-8 | dec | >>9.9 | Valor Sulco 8 do Pneu | Sim | 001 |
val-sulco-9 | dec | >>9.9 | Valor Sulco 9 do Pneu | Sim | 001 |
val-sulco-10 | dec | >>9.9 | Valor Sulco 10 do Pneu | Sim | 001 |
vli-calibr-encontr | int | >>9 | Valor da Calibragem encontrada no Pneu | Sim | 001 |
vli-calibr-colocada | int | >>9 | Valor da Calibragem colocada no Pneu | Sim | 001 |
ep-codigo-dest | int | >>9 | Código Empresa Destino | Sim | 001 |
cod-eqpto-dest | char | x(16) | Código Equipamento Destino | Sim | 001 |
val-hodom-horim-dest | dec | >,>>>,>>9.9 | Contador Destino | Não | 001 |
cod-pos-dest | char | x(3) | Código Posição Destino | Sim | 001 |
cod-estabel-dest | char | x(3) | Código Estabelecimento Destino | Não | 001 |
cod-sit-eqpto | char | x(8) | Código Situação do Pneu | Sim | 001 |
idi-consist | int | 99 | Status do Movimento: 1 - Ficha não consistida 2 - Equipamento origem inválido 3 - Posição origem inválida 4 - Estabelecimento origem inválido 5 - Durabilidade Estimada Não Cadastrada 6 - Ficha anterior não consistida 7 - Localização destino incorreta 8 - Pneu desativado 21 - Apontamento correto | Sim | 001 |
dsl-obs | char | x(300) | Observações do Movimento | Não | 001 |
cod-usuar | char | x(12) | Código Usuário do EMS | Sim | 001 |
val-km-percur | dec | >,>>>,>>9.9 | Valor da Quilometragem Percorrida | Não | 001 |
val-uso-atual | dec | >>>>>>9.9 | Valor Uso Atual do Pneu | Não | 001 |
log-consist | log | Sim/Não | Movimento está Consistido e Correto? | Sim | 001 |
cod-emitente | int | >>>>>>>>9 | Código Reformador | Sim | 001 |
cod-desen | char | x(8) | Código Desenho Reforma | Sim | 001 |
cod-borracha | char | x(8) | Código Borracha Reforma | Sim | 001 |
val-km-hora-gartia | dec | >,>>>,>>9.9 | Valor da Garantia da Reforma (Horas ou KM) | Sim | 001 |
nr-nota-fis | char | x(16) | Número Nota Fiscal | Não | 001 |
Serie | char | x(5) | Série da Nota Fiscal | Não | 001 |
nat-operacao | char | x(6) | Natureza de Operação | Não | 001 |
dat-entrega | date | 99/99/9999 | Data de Entrega da Reforma | Não | 001 |
ep-codigo-matr | int | >>9 | Código Empresa Funcionário | Não | 001 |
cod-matr | char | x(10) | Código Funcionário Oficina | Não | 001 |
val-mater-1 | dec | >>,>>>,>>9.99 | Valor da Reforma na moeda Padrão 0 | Sim | 001 |
val-mater-2 | dec | >>,>>>,>>9.99 | Valor da Reforma na moeda Alternativa 1 | Sim | 001 |
val-mater-3 | dec | >>,>>>,>>9.99 | Valor da Reforma na moeda Alternativa 2 | Sim | 001 |
log-recus | log | Sim/Não | Reforma foi Recusada? | Sim | 001 |
log-medi-sulco | log | Sim/Não | Movimento com Medição de Sulco? | Sim | 001 |
ct-codigo | char | X(20) | Código da Conta de aplicação do pneu | Não | 007 |
cc-codigo | char | X(20) | Código do Centro-de-Custo aplicação do pneu | Não | 007 |
cod-refer | char | x(8) | Referência Item | Não | 007 |
cod-localiz | char | x(10) | Código da Localização do Material | Não | 007 |
lote | char | x(10) | Lote ou Número de Série | Não | 007 |
nr-trans | int | >>>,>>>,>>9 | Número da transação | Não | 007 |
idi-integr | int | >9 | Nome da informação que será integrada | Não | 007 |
it-codigo | char | x(16) | Código do Item | Não | 007 |
cod-estabel-matr | Char | x(3) | Estabelecimento do Funcionário | Não | 001 |
cod-depos | char | x(3) | Código do Depósito | Não | 007 |
cod-livre-1 | char | x(1000) | Character Livre | Não | 001 |
cod-livre-2 | char | x(1000) | 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 |
log-transf | log | Sim/Não | Pneu está na área de transferência | Não |
|
cod-pneu-colocada | char | x(16) | Código Pneu Colocação | 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 |
ttParam | Parâmetros do Filtro (opneQueryAtualizacao) | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
docIni | int | padrão | Número Documento Inicial | Sim | 001 |
docFim | int | padrão | Número Documento Final | Sim | 001 |
dataIni | date | padrão | Data Movimento Inicial | Sim | 001 |
dataFim | date | padrão | Data Movimento Final | Sim | 001 |
pneuIni | char | padrão | Código Pneu Inicial | Sim | 001 |
pneuFim | char | padrão | Código Pneu Final | Sim | 001 |
empIni | int | padrão | Código Empresa Origem Inicial | Sim | 001 |
empFim | int | padrão | Código Empresa Origem Final | Sim | 001 |
eqptoIni | char | padrão | Código Equipamento Origem Inicial | Sim | 001 |
eqptoFim | char | padrão | Código Equipamento Origem Final | Sim | 001 |
estabIni | char | padrão | Código Estabelecimento Origem Inicial | Sim | 001 |
estabFim | char | padrão | Código Estabelecimento Origem Final | Sim | 001 |
codServico | char | padrão | Código Serviço Executado | Sim | 001 |
unid-negoc-ini | char | X(3) | Código da Unidade de Negócio | Sim | 001 |
Unid-negoc-fim | char | X(3) | Código da Unidade de Negócio | Sim | 001 |
Tabela Temporária | Descrição | Entrada/Saída |
tt-param | Contém os campos para se fazer a seleção dos registros na API de atualização dos movimentos de pneus (PNAPI001) | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
destino | integer | padrão | Destino do relatório | Não | 001 |
arquivo | char | x(35) | Nome do arquivo do relatório | Não | 001 |
usuario | char | x(12) | Nome do usuário corrente | Não | 001 |
data-exec | date | 99/99/9999 | Data de execução do relatório | Não | 001 |
hora-exec | integer | padrão | Hora de execução do relatório | Não | 001 |
docIni | integer | >>>,>>>,>>9 | Documento Inicial | Não | 001 |
docFim | integer | >>>,>>>,>>9 | Documento Final | Não | 001 |
dataIni | date | 99/99/9999 | Data Inicial | Sim | 001 |
dataFim | date | 99/99/9999 | Data Final | Sim | 001 |
pneuIni | char | x(12) | Pneu Inicial | Sim | 001 |
pneuFim | char | x(12) | Pneu Final | Sim | 001 |
empIni | integer | >>9 | Empresa Inicial | Sim | 001 |
empFim | integer | >>9 | Empresa Final | Sim | 001 |
eqptoIni | char | x(16) | Equipamento Inicial | Sim | 001 |
eqptoFim | char | x(16) | Equipamento Final | Sim | 001 |
estabIni | char | x(3) | Estabelecimento Inicial | Sim | 001 |
estabFim | char | x(3) | Estabelecimento Final | Sim | 001 |
iConsist | integer | padrão | Tipo de Consistência | Sim | 001 |
descConsist | char | x(40) | Descrição da Consistência | Não | 001 |
lConsist | logical | yes/no | Consistir fichas anteriores | Não | 001 |
codServico | char | x(4) | Código Serviço | Não | 001 |
rRowid | rowid | padrão | Rowid do Apontamento | 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>). | |
Descrição | Reposiciona a query com base na chave primária da tabela. | |
| Parâmetros | Descrição |
| pnum-docto | Número do Documento |
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>). | |
Descrição | Retorna os campos da chave primária da tabela. | |
| Parâmetros | Descrição |
| pnum-docto | Número do Documento |
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
linkToMpn-Pneu
Requisito | Ser chamado somente quando há o Join entre a tabela em questão e a tabela mpn-pneu. | |
Sintaxe | run linkToMpn-Pneu in h-handle (input <hanlde>). | |
Descrição | Faz o JOIN entre as tabelas “mpn-pneu” e “mpn-movto-pneu”. Recebe como parâmetro o handle da BO da tabela mpn-pneu, para buscar a chave primária da mesma (do registro corrente na BO), para setar as restrições “setConstraintMpn-pneu”. | |
| Parâmetros | Descrição |
| pHandle | Handle da BO “mpn-pneu” (Pneu). |
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. |
setConstraintAtualizacao
Requisito | Nenhum | |
Sintaxe | run setConstraintAtualizacao in h-handle (input table ttParam). | |
Descrição | Seta as restrições para abrir a query por filtro do programa de atualização dos movimentos de pneus. | |
| Parâmetros | Descrição |
| ttParam | Temp-Table com o filtro para programa PN0403. |
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. |
setConstraintData
Requisito | Nenhum | |
Sintaxe | run setConstraintData in h-handle (input <date>, input <date>). | |
Descrição | Seta as restrições para abrir a query por faixa de datas de movimentos de pneus. | |
| Parâmetros | Descrição |
| pDataIni | Data Movimento Inicial |
| pDataFim | Data Movimento 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. |
setConstraintDocumento
Requisito | Nenhum | |
Sintaxe | run setConstraintDocumento in h-handle (input <integer>, input <integer>). | |
Descrição | Seta as restrições para abrir a query por faixa de número dos movimentos de pneus. | |
| Parâmetros | Descrição |
| pDocIni | Número Documento Inicial |
| pDocFim | Número Documento 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. |
setConstraintFiltro
Requisito | Nenhum | |
Sintaxe | run setConstraintFiltro in h-handle (input <character>). | |
Descrição | Seta as restrições para abrir a query para um Serviço que foi executado. | |
| Parâmetros | Descrição |
| pServico | Código do Serviço Executado |
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. |
setConstraintMpn-Pneu
Requisito | Nenhum | |
Sintaxe | run setConstraintMpn-Pneu in h-handle (input <character>). | |
Descrição | Seta as restrições para abrir a query para um Pneu. | |
| Parâmetros | Descrição |
| pCodPneu | Código do Pneu |
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. |
setConstraintPneu
Requisito | Nenhum | |
Sintaxe | run setConstraintPneu in h-handle (input <character>, input <character>). | |
Descrição | Seta as restrições para abrir a query por faixa de código de pneus. | |
| Parâmetros | Descrição |
| pPneuIni | Código Pneu Inicial |
| pPneuFim | Código Pneu 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. |
setConstraintServico
Requisito | Nenhum | |
Sintaxe | run setConstraintServico in h-handle (input <character>, input <character>). | |
Descrição | Seta as restrições para abrir a query por faixa de código de serviço executado. | |
| Parâmetros | Descrição |
| pServIni | Código Serviço Inicial |
| pServFim | Código Serviç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. |
openQueryAtualizacao
Requisito | A setConstraintAtualizacao ter sido executada anteriormente. | |
Sintaxe | run openQueryAtualizacao in h-handle. | |
Descrição | Abre a query da BO conforme o filtro passado na procedure setConstraintAtualizacao. Obs: Se código do Serviço estiver em branco, não restringe a query por serviç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. |
openQueryData
Requisito | A setConstraintData ter sido executada anteriormente. | |
Sintaxe | run openQueryData in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de datas de movimentos passada na procedure setConstraintData. | |
| 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. |
openQueryDataFiltro
Requisito | A setConstraintData e a setConstraintFiltro terem sido executadas anteriormente. | |
Sintaxe | run openQueryDataFiltro in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de datas de movimentos passada na procedure setConstraintData e conforme o código do serviço passado na procedure setConstraintFiltro. | |
| 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. |
openQueryDocumento
Requisito | A setConstraintDocumento ter sido executada anteriormente. | |
Sintaxe | run openQueryDocumento in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de números do documento passada na procedure setConstraintDocumento. | |
| 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. |
openQueryDocumentoFiltro
Requisito | A setConstraintDocumento e a setConstraintFiltro terem sido executadas anteriormente. | |
Sintaxe | run openQueryDocumentoFiltro in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de números do documento passada na procedure setConstraintDocumento e conforme o código do serviço passado na procedure setConstraintFiltro. | |
| 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. |
openQueryMpn-Pneu
Requisito | A setConstraintMpn-Pneu ter sido executada anteriormente. | |
Sintaxe | run openQueryMpn-Pneu in h-handle. | |
Descrição | Abre a query da BO conforme o código do pneu passado na procedure setConstraintMpn-Pneu. | |
| 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. |
openQueryPneu
Requisito | A setConstraintPneu ter sido executada anteriormente. | |
Sintaxe | run openQueryPneu in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de código do pneu passada na procedure setConstraintPneu. | |
| 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. |
openQueryPneuFiltro
Requisito | A setConstraintPneu e a setConstraintFiltro terem sido executadas anteriormente. | |
Sintaxe | run openQueryPneuFiltro in h-handle. | |
Descrição | Abre a query da BO conforme a faixa de código do pneu passada na procedure setConstraintPneu e conforme o código do serviço passado na procedure setConstraintFiltro. | |
| 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. |
validateCalibragem
Requisito | Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente. | |
Sintaxe | run validateCalibragem in this-procedure. | |
Descrição | Faz as validações para os atributos de Serviço de Calibragem. vli-calibr-colocada = Calibragem Colocada vli-calibr-encontr = Calibragem Encontrada | |
| 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. |
validateDestino
Requisito | Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente. | |
Sintaxe | run validateDestino in this-procedure. | |
Descrição | Faz as validações para os atributos da Localização Destino do Pneu. ep-codigo-dest = Empresa Destino cod-eqpto-dest = Equipamento Destino val-hodom-horim-dest = Contador Destino cod-pos-dest = posição Pneu Destino cod-estabel-dest = Estabelecimento Destino | |
| 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. |
validateNotaFiscal
Requisito | Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente. | |
Sintaxe | run validateNotaFiscal in this-procedure. | |
Descrição | Faz as validações para os atributos referentes a Nota Fiscal de Reforma. nr-nota-fis = Nota Fiscal serie = Série Nota Fiscal nat-operacao = Natureza Operação dat-entrega = Data de Entrega val-mater-1 = Valor Moeda 0 val-mater-2 = Valor Moeda 1 val-mater-3 = Valor Moeda 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 RowErrors. |
validateOrigem
Requisito | Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente. | |
Sintaxe | run validateOrigem in this-procedure. | |
Descrição | Faz as validações para os atributos da Localização Origem do Pneu. ep-codigo-orig = Empresa Origem cod-eqpto-orig = Equipamento Origem val-hodom-horim-orig = Contador Origem cod-pos-orig = posição Pneu Origem cod-estabel-orig = Estabelecimento Origem | |
| 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. |
validateReforma
Requisito | Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente. | |
Sintaxe | run validateReforma in this-procedure. | |
Descrição | Faz as validações para os atributos da Reforma ocorrida no Pneu. cod-emitente = Código Reformador cod-desen = Código Desenho cod-borracha = Código Borracha val-km-hora-gartia = Valor da Garantia log-recus = Reforma Recusada? | |
| 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. |
validateRequisição
Requisito | Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente. | |
Sintaxe | run validateRequisicao in this-procedure. | |
Descrição | Validação para requisição do Item. | |
| 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. |
validateSulcos
Requisito | Procedure chamada pelo método interno validateRecord. Não deve ser chamada externamente. | |
Sintaxe | run validateSulcos in this-procedure. | |
Descrição | Faz as validações para os atributos do serviço de Medição de Sulco. val-sulco-(1 ao 10) = Valor do Sulco. | |
| 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. |
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 está parametrizado para atualizar o apontamento de movimento de pneu On-line. Se estiver, chama a procedure piChamaAPI, a qual cria o ambiente necessário para chamar a API de atualização dos apontamento (PNAPI001). | |
| 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 | Elimina o histórico de vida de pneu e atualiza os valores dos sulcos do pneu. Chama a procedure piChamaAPI, a qual cria o ambiente necessário para chamar a API de atualização dos apontamento (PNAPI001). | |
| 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.... |
afterUpdateRecord
Requisito | Procedure chamada pelo método interno UpdateRecord. Não deve ser chamada externamente. | |
Sintaxe | run afterUpdateRecord in this-procedure. | |
Descrição | Verifica se o apontamento atualizado já foi consistido. Se estiver, chama a procedure piChamaAPI, a qual cria o ambiente necessário para chamar a API de atualização dos apontamento (PNAPI001). | |
| 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.... |
buscaContador
Requisito | Nenhum | |
Sintaxe | run buscaContador in h-handle (input <integer>, input <character>, input <decimal>, output <decimal>). | |
Descrição | Busca a última ficha de apontamento de abastecimento primário consistida do equipamento para ler o contador da mesma, se não existir , deve-se pegar o contador inicial do equipamento. | |
| Parâmetros | Descrição |
| pEmp | Código da Empresa |
| pEqpto | Código do Equipamento |
| pInvertida | Data / Hora Invertida |
| pContador | Contador 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.... |
buscaDocumento
Requisito | Nenhum | |
Sintaxe | run buscaDocumento in h-handle (output <integer>). | |
Descrição | Busca o próximo número de apontamento de movimento de pneus que deve ser incluído. | |
| Parâmetros | Descrição |
| pDoc | Número Documento |
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.... |
buscaSulcos
Requisito | Nenhum | |
Sintaxe | run buscaSulcos in h-handle (input <character>, input <decimal>, output <integer>, output <decimal>). | |
Descrição | Busca o número de sulcos do desenho do pneu passado, conforme o desenho da vida do pneu, verificada através da data informada. Retorna também o valor inicial destes sulcos. | |
| Parâmetros | Descrição |
| pPneu | Código do Pneu |
| pInvertida | Data / Hora Invertida do Apontamento |
| pSulcos | Número de Sulcos do Desenho do Pneu |
| pInicial | Valor Inicial dos Sulcos dos Pneus |
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.... |
consisteDataInvertida
Requisito | Nenhum | |
Sintaxe | run consisteDataInvertida in h-handle (input <integer>, input <date>, input <character>, input <character>, output <decimal>). | |
Descrição | Converte data e hora para invertida e se for passada a Ação para validar este valor, busca-se a data e hora da desativação do pneu, para ser validada a data do apontamento. | |
| Parâmetros | Descrição |
| pAcao | Ação a ser Executada 1 = Validação |
| pData | Data do Apontamento |
| pHora | Hora do Apontamento |
| pPneu | Código do Pneu |
| pInvertida | Data / Hora Invertida 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.... |
criaMovimentos
Requisito | Nenhum | |
Sintaxe | run criaMovimentos in h-handle (input table RowObject, input <character>). | |
Descrição | Percorre a temp-table RowObject e executa a ação passada: CREATE, UPDATE ou DELETE. Faz as validações, chamando a validateRecord. | |
| Parâmetros | Descrição |
| RowObject | Temp-Table comunicação da tabela mpn-movto-pneu (Movimentos de Pneus) |
| pAcao | Ação a ser feita pela procedure: CREATE, UPDATE ou 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.... |
criaMovimentoPneu
Requisito | Nenhum | |
Sintaxe | run criaMovimentoPneu in h-handle (input table RowObject, input <character>). | |
Descrição | Percorre a temp-table RowObject e executa a ação passada: CREATE, UPDATE ou DELETE. Faz as validações, chamando a validateRecord. | |
| Parâmetros | Descrição |
| RowObject | Temp-Table comunicação da tabela mpn-movto-pneu (Movimentos de Pneus) |
| pAcao | Ação a ser feita pela procedure: CREATE, UPDATE ou 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.... |
criaMovimentoPneuColocado
Requisito | Nenhum | |
Sintaxe | run criaMovimentoPneuColocado in h-handle. | |
Descrição | Cria movimento de pneu colocado. | |
| 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.... |
getItemReforma
Requisito | Nenhum | |
Sintaxe | run getItemReforma in h-handle (input <character>, input <decimal>, input <character>, output <character> output <character>). | |
Descrição | Retorna o código do item registrado na tabela de durabilidade padrão dos pneus, bem como o código do depósito da última vida do pneu com data menor que data/hora do apontamento, como sugestões na inclusão do registro. | |
| Parâmetros | Descrição |
| pCodPneu | Código do Pneu |
| pDatHoraInv | Data e Hora Invertidas |
| pCodDesen | Código do Desenho |
| pItCodigo | Código do Item |
| pCodDepos | Código do Depósito |
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.... |
getItemRequisicao
Requisito | Nenhum | |
Sintaxe | run getItemRequisicao in h-handle (input <character>, input <decimal>, input <character, input <integer>, output <character>, output <character> output <character>, output <character>). | |
Descrição | Retorna o código do item e o código do depósito da última vida do pneu com data menor que data/hora do apontamento, bem como o código da conta e sub-conta dos parâmetros de pneu quando informados ou do cadastro de equipamentos, como sugestões na inclusão do registro. | |
| Parâmetros | Descrição |
| pCodPneu | Código do Pneu |
| pDatHoraInv | Data e Hora Invertidas |
| pCodEqptoOrig | Código Equipamento Origem |
| pEpCodigoOrig | Código Empresa Origem |
| pItCodigo | Código do Item |
| pCodDepos | Código do Depósito |
| pCtCodigo | Código da Conta |
| pCcCodigo | Código Centro de Custo/Sub-Conta |
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.... |
piChamaAPI
Requisito | Chamado pelos métodos afterCreateRecord, afterDeleteRecord e afterUpdateRecord. Não deve ser chamado externamente. | |
Sintaxe | run piChamaAPI in this-procedure. | |
Descrição | Chama a API de atualização de movimentos de pneus (PNAPI001), para o registro atual e após chama a API para atualizar todos os registros posteriores ao registro alterado. | |
| 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.... |
piParametroAPI
Requisito | Chamado pelos método piChamaAPI. Não deve ser chamado externamente. | |
Sintaxe | run piParametroAPI in this-procedure (input <rowed>). | |
Descrição | Criação dos registros de parâmetros para a API de atualização dos movimentos de pneus. Se parâmetro pRowid <> ?, então será atualizado apenas o registro atual, senão atualiza registros posteriores. | |
| Parâmetros | Descrição |
| pRowid | Rowid da tabela mpn-movto-pneu (Movimentos de Pneus). |
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.... |
recebeReqEnable
Requisito | Nenhum. | |
Sintaxe | run recebeReqEnable in this-procedure (input <logical>). | |
Descrição | Recebe a variável para validação ou não dos dados de “Requisição”. | |
| Parâmetros | Descrição |
| pReqEnable | Validar ou não os dados referente a requisiçã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.... |
verificaFolder
Requisito | Nenhum. | |
Sintaxe | run verificaFolder in this-procedure (input <character>, input <decimal>, input <integer>, input <integer>, output <logical>). | |
Descrição | Verifica de acordo com os parâmetros passados se deverá o folder “Requisição” ser habilitado para o usuário. | |
| Parâmetros | Descrição |
| pcod-pneu | Código do Pneu |
| pInvertida | Data e Hora invertidas |
| pep-codigo-dest | Código da Empresa Destino |
| pep-codigo-orig | Código da Empresa Origem |
| pEnable | Habilitar ou não os dados de Requisiçã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.... |
setaPrograma
Requisito | Nenhum | |
Sintaxe | RUN setaPrograma IN THIS-PROCEDURE (input <character>) | |
Descrição | Seta programa chamador. | |
| Parâmetros | Descrição |
| p-programa | Programa chamador |
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.... |