Linha Datasul

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Eliz Regina Pedrini do Nascimento

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Eliz Regina Pedrini do Nascimento

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocdpcpp/cpapi301b.p
Data Liberação 07/2015
 BancoMOVIND
Tabela ord-prod
AplicativoManufatura

...

 

Considerações Gerais


Objetivo

Manter e fornecer integrações sobre pendências de integração MESordens de produção do Datasul 12 com soluções externas.

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-...,
                    input        table tt-...,
                    ...,
                    ...).

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

 

run xxxcpp/xxapinnncpapi301b.p persistent set h-handle (input -output table tt-...,
                                            input        table tt-...,
                                            ...,
                                            ...).
r-rowid
input p-num-ordem,
input p-tipo).

A  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-2Charx(100)Campo Livre   
cod-livre-3Charx(100)Campo Livre   
cod-livre-4Charx(100) Campo Livre   
dat-livre-1Date 99/99/9999Campo Livre  
dat-livre-2Date99/99/9999Campo Livre  
dat-livre-3Date99/99/9999Campo Livre  
dat-livre-4Date99/99/9999Campo Livre  
log-livre-1LogSim/NãoCampo Livre  
log-livre-2LogSim/NãoCampo Livre  
log-livre-3LogSim/NãoCampo Livre  
log-livre-4LogSim/NãoCampo Livre  
num-livre-1Int >>>>>>>>9Campo Livre  
num-livre-2Int>>>>>>>>9Campo Livre  
num-livre-3Int>>>>>>>>9Campo Livre  
num-livre-4Int>>>>>>>>9Campo Livre  
val-livre-1Dec->>>>>>>>>>>9.99999999Campo Livre  
val-livre-2Dec->>>>>>>>>>>9.99999999Campo Livre  
val-livre-3Dec->>>>>>>>>>>9.99999999Campo Livre  
val-livre-4Dec->>>>>>>>>>>9.99999999Campo 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.

 Sintaxerun goToKey in h-handle (input num-id-pendcia-integr-mes).  
 DescriçãoPosiciona na chave indicada por parâmetro
 ParâmetrosDescrição 
 num-id-pendcia-integr-mes ID da pendência.
 RetornoNão se aplica.

 

Método Negócio

 

deleteRecordByIdentif

Requisito 

Eliminar pendências com chave de transação.

 SintaxedeleteRecordByIdentif (input  cod-chave-ident)
 DescriçãoElimina 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âmetrosDescrição 
 pendcia-integr-mes.cod-chave-identChave de identificação da transação
 RetornoA 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).

 Sintaxepi-retorna-xml (input rRowid, output stringXML)
 DescriçãoRetorna string LONGCHAR com o XML da pendencia desejada.
 ParâmetrosDescrição 
 rRowidROWID da pendência
 RetornoLONGCHAR 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.

 Sintaxerun 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âmetrosDescrição 
pdt-dat-envio-iniInicial de faixa de data da transação.
pdt-dat-envio-fimTé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-statusStatus da transação.
pc-usuario-ini Inicio de faixa de código de usuário.
pc-usuario-fimTérmino de faixa de código de usuário.
 RetornoNão se aplica.

...

openQueryFiltro

...

Requisito 

...

Abertura de Query com utilização de constraints de Filtro

...

r-rowid – Rowid da ord-prod que deverá ser integrada.
p-num-ordem – Deve ser utilizado para o Tipo “3” uma vez que o rowid da tabela não estará mais disponível.
p-tipo – Onde, 1 – Adicionar, 2 – Alteração ,3 – Eliminação.

Método Básico 

 

Não se aplica, todas as funções são executadas automaticamente por meio da chamada direta da API cpp/cpapi301b.p

...

.