Árvore de páginas

 

Documento de BO

Produto:

Datasul

Ocorrência:

Documentação de BO

Nome Físico

 mnbo/bomn206

 

Objetivo

Manutenir informações da tabela mgc-apont-calib.

 

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para executar a API/BO em modo persistente é:

run mnbo/bomn206.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.

 

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

Tabela Temporária

Descrição

Entrada/Saída

(Rowobject)

Tabela definida em formato like, semelhante a mgc-apont-calib.

Abaixo os atributos que não constam na temp-table

Entrada/Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

RowNum

integer

 

 

 

2.02

r-Rowid

rowid

 

Rowid do Registro

 não

2.02

Exemplo:

DEFINE TEMP-TABLE {1} NO-UNDO LIKE mgc-apont-calib

&IF "{&ROW-NUM-DEFINED}":U = "YES":U &THEN

    FIELD RowNum AS INTEGER INIT 1

&ENDIF

    FIELD r-Rowid AS ROWID.

 

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

getCharField

Requisito

Nenhum   

Sintaxe

run getCharField in <h-handle> (input  PFieldName,

                                output PfieldValue)              

Descrição

Retorna valor de campos do tipo caracter.

 

Parâmetros

Descrição

 

PFieldName

Contém o nome do campo a ser retornado

 

PFieldValue

Retorna o valor do campo solicitado

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

getDateField

Requisito

Nenhum

Sintaxe

run getDateField in <h-handle> (input  PFieldName,

                                output PFieldValue)              

Descrição

Retorna valor de campos do tipo data.

 

Parâmetros

Descrição

 

PFieldName

Contém o nome do campo a ser retornado

 

PFieldValue

Retorna o valor do campo solicitado

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

getDecField

Requisito

Nenhum

Sintaxe

run getDecField in <h-handle> (input  PFieldName,

                               output PFieldValue)              

Descrição

Retorna valor de campos do tipo decimal.

 

Parâmetros

Descrição

 

PFieldName

Contém o nome do campo a ser retornado

 

PFieldValue

Retorna o valor do campo solicitado

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

getIntField

Requisito

Nenhum

Sintaxe

run getIntField in <h-handle> (input  PFieldName,

                               output PFieldValue)              

Descrição

Retorna valor de campos do tipo inteiro.

 

Parâmetros

Descrição

 

PFieldName

Contém o nome do campo a ser retornado

 

PFieldValue

Retorna o valor do campo solicitado

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

As mensagens possíveis para este método são....

getKey

Requisito

Nenhum

Sintaxe

run getkey in  <h-handle> (output pnr-ord-produ)

Descrição

Retorna os valores dos campos do índice único da tabela.

 

Parâmetros

Descrição

 

pNr-ord-produ

Chave do índice único 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).

getLogField

Requisito

Nenhum

Sintaxe

run getLogField in <h-handle> (input  pFieldName,

                               output pFieldValue)

Descrição

Retorna o valor do campo do registro corrente – Logical.

 

Parâmetros

Descrição

 

pFieldName

Nome do campo a ser retornado a valor

 

pFieldValue

Conteúdo do campo pesquisado

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

getRawField

Requisito

Nenhum

Sintaxe

run getRawField in <h-handle> (input  pFieldName,

                               output pFieldValue)

Descrição

Retorna o valor do  campo tipo Raw .

 

Parâmetros

Descrição

 

pFieldName

Recebe o nome do campo

 

pFieldValue

Retorna o 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). 

goToKey

Requisito

Nenhum

Sintaxe

run goToKey  in <h-handle> (input  pNrOrdProdu)

Descrição

Reposiciona registro com base no índice mgcpntcl-id

 

Parâmetros

Descrição

 

pNrOrdProdu

Número da Ordem de Produçã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).

openQueryMain

Requisito

Nenhum

Sintaxe

openQueryMain

Descrição

Abre a query com todos os registos da tabela de apontamento.

 


Método   Negócio

atualizaResultados

Requisito

Nenhum.

Sintaxe

run atualizaResultados in <h-handle> (input  pNrApont)           

Descrição

Executa a API gcapi007 para leitura da planilha e atualização dos apontamentos.

 

Parâmetros

Descrição

 

pNrApont

Número 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).

 buscaRegistro

Requisito

Nenhum

Sintaxe

run buscaRegistro in <h-handle> (input  pNrApont,

                                 output pRowid)              

Descrição

Busca o apontamento informado eretornando o rowid do registro.

 

Parâmetros

Descrição

 

pNrApont

Número do apontamento

 

pRowid

Rowid do registro encontrado

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

carregaTTApont

Requisito

Nenhum

Sintaxe

run carregaTTApont in <h-handle> (input p-cd-equipto,

                                  input d-data

                                  output table ttApont)              

Descrição

Carrega a ttApont para a execução da gcapi001.

 

Parâmetros

Descrição

 

p-cd-equipto

Código do equipamento

 

d-data

Data Inicial de seleção

 

ttApont

temp-table dos apontamentos

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

consultaDocto                  

Requisito

Nenhum

Sintaxe

run consultaDocto in <h-handle> (input  pNrApont)              

Descrição

Executa a abertura da planilha do apontamento.

 

Parâmetros

Descrição

 

pNrApont

Número 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). 

 getCamposOrdem

Requisito

Nenhum

Sintaxe

run getRawField in <h-handle> (input  pNrOrdProdu,

                               output pItCodigo,

                               output pDescItem,

                               output pTipoconEst,

                               output pCodRefer,

                               output pDescRefer)

Descrição

Retorna o conteúdo dos cmapos da ordem.

 

Parâmetros

Descrição

 

pNrOrdProdu

Número da ordem de produção

 

pitCodigo

Código do Item

 

pDescitem

Descrição do Item

 

pTipoConEst

Tipo Controle estoque do item

 

pCodRefer

Código de Referência do item

 

pDescRefer

Descrição da referência do item

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

 getDescApont

Requisito

Nenhum

Sintaxe

run getDescApont in <h-handle> (input  pNrApont,

                                output pDesc)

Descrição

Retorna a descrição da ordem de manutenção.

 

Parâmetros

Descrição

 

pNrApont

Número do Apontamento

 

pDesc

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

getDescCausa

Requisito

Nenhum

Sintaxe

run getDescCausa in <h-handle> (input  pCodCausa,

                                output pDesc)

Descrição

Retona a descrição da causa solicitada.

 

Parâmetros

Descrição

 

pCodCausa

Código da causa

 

pDesc

Descrição da causa

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

getDescEquipe

Requisito

Nenhum

Sintaxe

run getDescEquipe in <h-handle> (input  pCodEquipe,

                                 output pDesc)

Descrição

Retorna a descrição da Equipe.

 

Parâmetros

Descrição

 

pCodEquipe

Código da Equipe

 

pDesc

Descrição da Equipe

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

getDescEquipto

Requisito

Nenhum

Sintaxe

run getDescEquipto in <h-handle> (input  pEquipto,

                                  output pDesc)   

Descrição

Retorna a descrição do equipamento

 

Parâmetros

Descrição

 

pEquipto

Código do Equipamento

 

pDesc

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

getDescInterv

Requisito

Nenhum

Sintaxe

run getDescInterv in <h-handle> (input  pCodInterv,

                                 output pDesc)

Descrição

Retorna a descrição da intervenção

 

Parâmetros

Descrição

 

pCodInterv

Código da Intervenção

 

pDesc

Descrição da Intervençã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).

getDescLab

Requisito

Nenhum

Sintaxe

run getDescLab in <h-handle> (input  pCodLab,

                              output pDesc)

Descrição

Retorna a descrição do Laboratório

 

Parâmetros

Descrição

 

pCodLab

Código do Laboratório

 

pDesc

Descrição do laborató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).

getDescmanut                  

Requisito

Nenhum

Sintaxe

run getDescManut in <h-handle> (input  pCdManut,

                                output pDesc)

Descrição

Retorna a descrição da manutenção

 

Parâmetros

Descrição

 

pCdManut

Código da Manutenção

 

pDesc

Descrição da Manutenção

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getDescPlanejad

Requisito

Nenhum

Sintaxe

run getDescPlanejad in <h-handle> (input  pCodPlanejad,

                                   output pDesc)

Descrição

Retorna a descrição do planejador

 

Parâmetros

Descrição

 

pcodPlanejad

Código do planejador

 

pDesc

Descrição do Planejador

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

getDescSint

Requisito

Nenhum

Sintaxe

run getDescSint in <h-handle> (input pCodSintoma,

                               output pDesc)

Descrição

Retorna a Descrição do sintoma

 

Parâmetros

Descrição

 

pcodPlanejad

Código do planejador

 

pDesc

Descrição do Planejador

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

getDescTag

Requisito

Nenhum

Sintaxe

run getDescTag in <h-handle> (input  pCodTag,

                              output pDesc)

Descrição

Retorna a descrição do tag

 

Parâmetros

Descrição

 

pCodTag

Código do Tag

 

pDesc

Descrição do Tag

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

getDescTipoManut

Requisito

Nenhum

Sintaxe

run getDescTipoManut in <h-handle> (input  pCdTipo,

                                    output pDesc)

Descrição

Retorna a descrição do Tipo de manutenção

 

Parâmetros

Descrição

 

pCdTipo

Código do Tipo da Manutenção

 

pDesc

Descrição do Tipo da Manutenção

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas).

getEmailTecn

Requisito

Nenhum

Sintaxe

run getEmailTecn in <h-handle> (input  pCdTecnico,

                                output pEmail)

Descrição

Retorna o e-mai do técnico

 

Parâmetros

Descrição

 

pCdTecnico

Código do Técnico

 

pDesc

Email do técnico

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

getNarrativa

Requisito

Nenhum

Sintaxe

run getNarrativa in <h-handle> (input  pNrOrdProdu,

                                output pNarrativa)

Descrição

Retorna a narrativa

 

Parâmetros

Descrição

 

pNrOrdProdu

Número da ordem de produção

 

pNarrativa

Narrativa da OM

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

getNomePlanejad

Requisito

Nenhum

Sintaxe

getNomePlanejad (input  pCodPlanejad,

                 output pDesc)

Descrição

Retorna a descrição do Planejador

 

Parâmetros

Descrição

 

pCodPlanejad

Código do Planejador

 

pDesc

Descrição do Planejador

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

getNomeTecn

Requisito

Nenhum

Sintaxe

run getNomeTecn in <h-handle> (input  pCdTecnico,

                               output pNome)

Descrição

Retorna o nome do Técnico

 

Parâmetros

Descrição

 

pCodSintoma

Código do Sintoma

 

pDesc

Descrição do Sintoma

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

getOrdProdEstab

Requisito

Nenhum

Sintaxe

run getOrdProdEstab in <h-handle> (input  pNrOrdProdu,

                                   output pCodEstabel,

                                   output pNome)

Descrição

Retorna o estabelecimento da ordem

 

Parâmetros

Descrição

 

pNrOrdProdu

Número da Ordem de Produção

 

pCodEstabel

Código do Estabelecimento

 

pDesc

Descrição do Estabelecimento

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

getRowidOrdManut

Requisito

Nenhum

Sintaxe

run getRowidOrdmanut in <h-handle> (input  pNrOrdProdu)                

Descrição

Retorna o rowid da ordem de manutenção.

 

Parâmetros

Descrição

 

pNrOrdProdu

Número da Ordem de Produçã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).

mantemApontamento

Requisito

Nenhum

Sintaxe

run mantemApontamento in <h-handle> (input  pNrApont,

                                     input  pAcao)                

Descrição

Executa a API gcapi002, para tratamento do apontamento.

 

Parâmetros

Descrição

 

pNrApont

Número do Apontamento.

 

pAcao

Ação a ser tomada 1- Libera, 2- Bloqueia, 3- Encerra

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

openQueryApont

Requisito

Nenhum

Sintaxe

run openQueryApont in <h-handle>

                

Descrição

Abre a query com todos os registros de Apontamentos

openQueryApontamento

Requisito

Nenhum

Sintaxe

run openQueryApontamento in <h-handle>                

Descrição

Abre a query com todos os registros de Apontamentos do filtro de estados do apontamento e da seleção inicial e final do numero do apontamento.

openQueryEquipamento

Requisito

Nenhum

Sintaxe

run openQueryEquipamento in <h-handle>                

Descrição

Abre a query com todos os registros de Equipamentos que se encaixam no filtro de estados de calibração do equipamento  e dentro da faixa inicial e final do código do equipamento.

openQueryFiltro

Requisito

Nenhum

Sintaxe

run openQueryFiltro in <h-handle>                

Descrição

Abre a query com todos os registros de apontamentos do filgro de estado de calibração.

 

openQueryFaixaApont

Requisito

Nenhum

Sintaxe

run openQueryFaixaApont in <h-handle>                

Descrição

Abre a query com todos os registros de apontamentos Equipamentos dentro da faixa de datas definida.

 

openQueryFaixaEquipto

Requisito

Nenhum

Sintaxe

run openQueryFaixaEquipto in <h-handle>                 

Descrição

Abre a query com todos os registros de equipamentos dentro da faixa de codigo inicial e final definida.

setConstraintApont

Sintaxe

run setConstrintApont in <h-handle>                

Descrição

Seta a variável de controle do número do apontamento para queries .

 

Parâmetros

Descrição

 

pNrApont

Número do Apontamento.

setConstraintApontamento

Sintaxe

run setContraintApontamento in <h-handle>                

Descrição

Seta a variável de controle de faixa  do número do apontamento para queries .

 

Parâmetros

Descrição

 

iNrApontIni

Número do Apontamento inicial.

 

iNrApontFim

Número do Apontamento Final

setConstraintEquipamento

Sintaxe

run setContraintEquipamento in <h-handle>                

Descrição

Seta a variável de controle de faixa  de equipamento para queries .

 

Parâmetros

Descrição

 

cCdEqptoni

Número do Equipamento inicial.

 

cCdEqptoFim

Número do Equipamento Final

setConstraintEquipto

Sintaxe

run setContraintEquipto in <h-handle>                

Descrição

Seta a variável de controle do código do  equipamento para queries .

 

Parâmetros

Descrição

 

pCdEquipto

Número do Equipamento inicial.

setConstraintFaixaApont

Sintaxe

run setContraintFaixaApont in <h-handle>                

Descrição

Seta a variável de controle de faixa  de Apontamentos para queries .

 

Parâmetros

Descrição

 

pNrApontIni

Número do Apontamento inicial.

 

iNrApontFim

Número do Apontamento Final

setConstraintFiltro

Sintaxe

run setContraintfiltro in <h-handle>                

Descrição

Seta a variável de controle de estado da calibração  para queries .

 

Parâmetros

Descrição

 

pProgramada

Programada

 

pEmCalibracao

Em calibração

 

pEmEnsaio

Em ensaio

 

pEmEstudoRR

Em Estudo RR

 

pPendenteApro

Pendente de Aprovação

 

pEmRevisao

Em Revisão

 

pAprovado

Aprovado

 

pAprovadoCond

Aprovado Condicional

 

pReprovado

Reprovado

 

pNaoExecutado

Nao executado

validaModuloCp

Requisito

Nenhum

Sintaxe

run validaModuloCp in <h-handle> (output pModuloCp)

Descrição

Valida se o módulo de produção esta implantado

 

Parâmetros

Descrição

 

pModuloCp

Módulo de produçã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).

validateRecord

Requisito

Nenhum

Sintaxe

run validateRecord in <h-handle> (input pType)

Descrição

Validação pertinente ao DBO.

 

Parâmetros

Descrição

 

ptype

Recebe o tipo de validaçã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).