Histórico da Página
Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | prgfin/cmg/ |
...
cmg700zj |
Objetivo
Eliminar os movimentos de Conta Corrente com origem CMG.
Funcionamento
Na forma padrão, realiza-se a chamada através de um comando RUN normalpersistent.
A sintaxe para a chamada da API é:
run def var v_hdl_api as HANDLE format ">>>>>>9":U .
run prgfin/cmg/cmg700zicmg700zj.py persistent set v_hdl_api.
run pi_elimina_movto_cta_corren_2 in v_hdl_api ( input 1).
input 2,
input-output table tt_row_elimina_movto_cta_corr,
input-output table tt_log_erros_elimina_movtocta).
if valid-handle(v_hdl_api) then do:
delete object v_hdl_api.
end.
Parâmetros Entrada
num_vers_integr_api...........: será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API;
O programa que irá executar a api_movto_cta_corren_elimina deverá conter e criar as seguintes tabelas temporárias (deverão estar definidas como new shared): tt_recrow_elimina_movto_cta_corren corr e tt_log_erros_elimina_movto_ctamovtocta, que são definidas logo abaixo.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt_ |
row_elimina_movto_cta_ |
corr | Conterá os |
rowid`s dos movimentos de conta corrente para eliminação. |
Input-Output |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_ |
row_movto_cta_corren |
rowid |
>>>>>>9
Rowid´s dos movimentos de contas corrente. | Sim |
...
def new shared temp-table tt_recrow_elimina_movto_cta_corren corr no-undo
field ttv_recrow_movto_cta_corren as recid format ">>>>>>9" initial ? . corren as Rowid
.
Tabela Temporária | Descrição | Entrada/Saída |
tt_log_erros_elimina_ |
movtocta | Conterá as informações dos erros apresentados na eliminação. |
Input-Ouput |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ttv_ |
row_movto_cta_corren |
rowid |
>>>>>>9
Rowid do movimento da conta corrente | Sim |
ttv_cod_msg_erro | character | x(50) | Código Mensagem | Sim |
ttv_des_mensagem | character | x(50) | Mensagem | Sim |
ttv_des_help | character | x(40) | Ajuda | Sim |
def new shared temp-table tt_log_erros_elimina_movto_cta movtocta no-undo
field ttv_recrow_movto_cta_corren as recid format ">>>>>>9" initial ? as Rowid
field ttv_cod_msg_erro as character format "x(50)" label "Código C¢digo Mensagem" column-label "Código C¢digo Mensagem"
field ttv_des_mensagem mensagem as character format "x(50)" label "Mensagem" column-label "Mensagem"
field ttv_des_help as as character format "x(40)" label "Ajuda" column-label "Ajuda"
.
Observações
Para a tt_recrow_elimina_movto_cta_correncorr:
O atributo tt_recrow_elimina_movto_cta_correncorr.ttv_recrow_movto_cta_corren corren deverá receber o recid rowid da tabela movto_cta_corren que deverá ser eliminada;
Exemplo: tt_row_elimina_movto_cta_corr.ttv_row_movto_cta_corren = ROWID(movto_cta_corren).
Para a tt_log_erros_elimina_movto_ctamovtocta:
Na tabela temporária tt_log_erros_elimina_movto_cta movtocta será gerado todos os erros encontrados ou mensagens de alerta gerados durante o processo de eliminação do movimento de conta corrente.
Quando a api for executada por um programa externo, logo após a chamada da api, deverá ser criado um tratamento para impressão dos erros.
Para a correta visualização dos erros, todos os campos desta tabela devem ser impressos.
Os seguintes erros podem ocorrer neste processo de eliminação:
4049 – Movimento conciliado parcial ou totalmente;
...
7167 - Movimento de Conta Corrente não encontrado.