Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | inbo/boin00951.p |
Data Liberação | 07/2015 |
Banco | MOVIND |
Tabela | pendcia-integr-mes |
Aplicativo | Manufatura |
Considerações Gerais
Objetivo
Manter e fornecer integrações sobre pendências de integração MES.
Funcionamento
Na forma padrão, realiza-se a chamada por meio de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A sintaxe para a chamada da BO é:
run xxx/xxapinnn.p (input-output table tt-..., |
A sintaxe para executar a BO em modo persistente é:
run xxx/xxapinnn.p persistent set h-handle (input-output table tt-..., |
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:
tt-pendcia-integr-mes | Entrada/Saída | ||||
| - | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
num-id-pendcia-integr-mes | Int | 999999999 | Identificador único da pendência |
|
|
cod-trans | Char | x(40) | Descrição da transação |
|
|
idi-tip-status | Int | >9 | Status da pendência |
|
|
cod-chave-ident | Char | x(100) | Código identificador da transação |
|
|
dat-envio | Date | 99/99/9999 | Data de envio da transação |
|
|
hra-envio | Char | x(8) | Hora de envio da transação |
|
|
cod-usuar | Char | x(100) | Código do usuário |
|
|
des-msg-ret | Char | X(300) | Msg Retorno |
|
|
cod-livre-1 | Char | x(100) | Campo Livre |
|
|
cod-livre-2 | Char | x(100) | Campo Livre | ||
cod-livre-3 | Char | x(100) | Campo Livre | ||
cod-livre-4 | Char | x(100) | Campo Livre | ||
dat-livre-1 | Date | 99/99/9999 | Campo Livre | ||
dat-livre-2 | Date | 99/99/9999 | Campo Livre | ||
dat-livre-3 | Date | 99/99/9999 | Campo Livre | ||
dat-livre-4 | Date | 99/99/9999 | Campo Livre | ||
log-livre-1 | Log | Sim/Não | Campo Livre | ||
log-livre-2 | Log | Sim/Não | Campo Livre | ||
log-livre-3 | Log | Sim/Não | Campo Livre | ||
log-livre-4 | Log | Sim/Não | Campo Livre | ||
num-livre-1 | Int | >>>>>>>>9 | Campo Livre | ||
num-livre-2 | Int | >>>>>>>>9 | Campo Livre | ||
num-livre-3 | Int | >>>>>>>>9 | Campo Livre | ||
num-livre-4 | Int | >>>>>>>>9 | Campo Livre | ||
val-livre-1 | Dec | ->>>>>>>>>>>9.99999999 | Campo Livre | ||
val-livre-2 | Dec | ->>>>>>>>>>>9.99999999 | Campo Livre | ||
val-livre-3 | Dec | ->>>>>>>>>>>9.99999999 | Campo Livre | ||
val-livre-4 | Dec | ->>>>>>>>>>>9.99999999 | Campo Livre |
Método Básico
Quando a BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
goToKey | ||||||
Requisito | Busca de registro pela chave primária. | |||||
Sintaxe | run goToKey in h-handle (input num-id-pendcia-integr-mes). | |||||
Descrição | Posiciona na chave indicada por parâmetro | |||||
Parâmetros | Descrição | |||||
num-id-pendcia-integr-mes | ID da pendência. | |||||
Retorno | Não se aplica. |
Método Negócio
deleteRecordByIdentif | ||||||
Requisito | Eliminar pendências com chave de transação. | |||||
Sintaxe | deleteRecordByIdentif (input cod-chave-ident) | |||||
Descrição | Elimina pendências por meio da chave de identificação dela, todas as pendências que possuem essa chave de transação serão eliminadas. | |||||
Parâmetros | Descrição | |||||
pendcia-integr-mes.cod-chave-ident | Chave de identificação da transaçã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). |
pi-retorna-xml | ||||||
Requisito | Busca XML com a chave da pendência (rowid). | |||||
Sintaxe | pi-retorna-xml (input rRowid, output stringXML) | |||||
Descrição | Retorna string LONGCHAR com o XML da pendencia desejada. | |||||
Parâmetros | Descrição | |||||
rRowid | ROWID da pendência | |||||
Retorno | LONGCHAR contendo XML da pendência enviada no INPUT do método. |
OpenQuery / SetConstraint / LinkTo
setConstraintFiltro | ||||||
Requisito | Seta constraint de filtros básicos para a pendência. | |||||
Sintaxe | run setConstraintFiltro in h-handle (input pdt-dat-envio-ini, input pdt-dat-envio-fim, input pc-cod-trans-ini, input pc-cod-trans-fim, input pidi-tip-status, input pc-usuario-ini, input pc-usuario-fim). | |||||
Descrição | Filtros para abertura de Query. | |||||
Parâmetros | Descrição | |||||
pdt-dat-envio-ini | Inicial de faixa de data da transação. | |||||
pdt-dat-envio-fim | Término de faixa de data de transação. | |||||
pc-cod-trans-ini | Inicio de faixa de código de transação. | |||||
pc-cod-trans-fim | Término de faixa de código de transação. | |||||
pidi-tip-status | Status da transação. | |||||
pc-usuario-ini | Inicio de faixa de código de usuário. | |||||
pc-usuario-fim | Término de faixa de código de usuário. | |||||
Retorno | Não se aplica. |
openQueryFiltro | ||||||
Requisito | Abertura de Query com utilização de constraints de Filtro | |||||
Sintaxe | run openQueryFiltro in h-handle (). | |||||
Descrição | Abertura de query utilizando filtros setados pelo método setConstraintFiltro. | |||||
Parâmetros | Descrição | |||||
Não se aplica. | ROWID da pendência | |||||
Retorno | Não se aplica. |