Árvore de páginas

Versões comparadas

Chave

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

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicoprgfin/cmg/cmg742zb

 


Objetivo

Realizar transferência e mútuo.

 


Funcionamento

Na forma padrão, realiza-se a chamada do programa em modo persistente, sem a passagem de parâmetros, e em seguida, através de um comando RUN normal, executa-se seu método padrão passando-se os parâmetros com as informações necessárias.

...

def var v_hdl_program as Handle format ">>>>>>9":U no-undo.

 


run prgfin/cmg/cmg742zb.py persistent set v_hdl_program. 


run pi_main_code_api_movto_cta_corren_transf_mutuo_3 4 in v_hdl_program

        (input 2,

         input-output table tt tt_movto_cta_correncorr_transf_mut_3,

         input-output table tt_import_movto_valid_cmg_3,

        input-output table tt_params_generic_api_3).

 


delete procedure v_hdl_program.

 


Parâmetros

Parâmetro

Descrição

p_num_vers_integr_api

Será utilizado para determinar se o programa que está chamando está íntegro com as definições correntes da API.

tt_movto_cta_

corren

corr_transf_mut_3

Esta temp-table conterá os movimentos da conta corrente para transferência ou mútuo.

tt_import_movto_valid_cmg_3

Esta temp-table conterá os erros que ocorreram no processo.

tt_params_generic_api_3Conterá campos novos das temp-tables passadas como parâmetro.

...


Retorno

A API retornará na tabela temporária tt_import_movto_valid_cmg_3 todos os erros encontrados ou mensagens de alerta gerados durante o processo de validação dos movimentos.

...

Observações: 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, caso o usuário não tenha ligado os parâmetros para impressão dos movimentos importados e com erros. E para a correta visualização dos erros, todos os campos desta tabela devem ser impressos.

 


Tabelas Temporárias

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

 


Tabela Temporária

Descrição

Entrada/Saída

tt

 tt_movto_cta_

corren

corr_transf_mut_3

Registros de transferência e mútuo.

Entrada e Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ttv_cod_cta_corren_orig

character

x(10)

Conta Corrente Origem

 

 



ttv_cod_cta_corren_dest

character

x(10)

Conta Corrente Destino

 

 



tta_dat_movto_cta_corren

date

99/99/9999

Data do Movimento

 

 



tta_num_seq_movto_cta_corren

integer

>>>>9

Sequência

 

 



tta_ind_tip_movto_cta_corren

character

x(2)

Tipo do Movimento

 

 



tta_cod_tip_trans_cx

character

x(8)

Tipo da Transação de Caixa

 

 



tta_ind_fluxo_movto_cta_corren

character

x(3)

Fluxo do Movimento

 

 



tta_cod_cenar_ctbl

character

x(8)

Cenário Contábil

 

 



tta_val_movto_cta_corren

decimal

>>>>,>>>,>>9.99

Valor do Movimento

 

 



tta_cod_docto_movto_cta_bco

character

x(20)

Documento Banco

 

 



tta_cod_modul_dtsul

character

x(3)

Módulo

 

 



tta_cod_histor_padr

character

x(8)

Histórico Padrão

 

 



tta_des_histor_padr

character

x(40)

Descrição do Histórico Padrão

 

 



tta_num_id_movto_cta_corren

integer

9999999999

Identificador do Movimento da Conta Corrente

 

 



ttv_cod_

rec

id_movto_cta_corren

recid

>>>>>>9

Recid

character

x(80)

String do Rowid do Movimento da Conta Corrente

 

 



ttv_ind_erro_valid

character

X(08)

Identificador se ocorreu erro

 

 



tta_val_cotac_indic_econ

decimal

>>>>,>>9.9999999999

Valor da Cotação

 

 

 




def temp-table tt_movto_cta_correncorr_transf_mut_3 no-undo

        field ttv_cod_cta_corren_orig          as orig          as character format "x(10)" label "Cta Corren Origem" column-label "Cta Corren Origem"

        field ttv_cod_cta_corren_dest          as dest          as character format "x(10)" label "Cta Corren Destino" column-label "Cta Corren Destino"   

        field tta_dat_movto_cta_corren         corren         as date format "99/99/9999" initial today label "Data Movimento" column-label "Data Movimento"

        field tta_num_seq_movto_cta_corren     corren     as integer format ">>>>9" initial 0 label "Sequência" column-label "Sequência"

        field tta_ind_tip_movto_cta_corren     corren     as character format "X(2)" initial "RE" label "Tipo Movimento" column-label "Tipo Movto"

        field tta_cod_tip_trans_cx             cx             as character format "x(8)" label "Tipo Transação Caixa" column-label "Tipo Transação Caixa"

        field tta_ind_fluxo_movto_cta_corren   corren   as character format "X(3)" initial "ENT" label "Fluxo Movimento" column-label "Fluxo Movto"

        field tta_cod_cenar_ctbl               ctbl               as character format "x(8)" label "Cenário Contábil" column-label "Cenário Contábil"

        field tta_val_movto_cta_corren         corren         as decimal format ">>>>,>>>,>>9.99" decimals 2 initial 0 label "Valor Movimento" column-label "Valor Movimento"

        field tta_cod_docto_movto_cta_bco      as bco      as character format "x(20)" label "Documento Banco" column-label "Documento Banco"

        field tta_cod_modul_dtsul              as dtsul              as character format "x(3)" label "Módulo" column-label "Módulo"

        field tta_cod_histor_padr              as padr              as character format "x(8)" label "Histórico Padrão" column-label "Histórico Padrão"

        field tta_des_histor_padr              as padr              as character format "x(40)" label "Descrição" column-label "Descrição Histórico Padrão"

        field tta_num_id_movto_cta_corren      as corren      as integer format "9999999999999999999" initial 0 label "ID Movto Conta" column-label "ID Movto Conta"

        field ttv_cod_recid_movto_cta_corren         as recid corren      as character format ">>>>>>9" initial ?x(80)"

        field ttv_ind_erro_valid               as               as character format "X(08)" initial "Não"

        field tta_val_cotac_indic_econ         econ         as decimal format ">>>>,>>9.9999999999" decimals 10 initial 0 label "Cotação" column-label "Cotação"
        . 



Tabela Temporária

Descrição

Entrada/Saída

tt_import_movto_valid_cmg_3

Contém os erros do processo de transferência e mútuo.

Entrada e Saída

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ttv_

rec

cod_id_movto_cta_corren

recid

>>>>>>9

character

x(80)

Código do Movimento com problema

Sim

 


ttv_num_mensagem

integer

>>>>,>>9

Número do Erro

Sim

 


ttv_des_mensagem

character

x(50)

Mensagem

Sim

 


ttv_des_msg_erro

character

x(60)

Mensagem Erro

Sim

 


ttv_cod_parameters

character

x(256)

Parâmetros

Sim

 

 



def temp-table tt_import_movto_valid_cmg_3 no-undo

        field ttv_cod_recid_movto_cta_corren         as recid corren      as character format ">>>>>>9" initial ?x(80)"

        field ttv_num_mensagem                 mensagem                 as integer format ">>>>,>>9" label "Número" column-label "Número Mensagem"

        field ttv_des_mensagem                 mensagem                 as character format "x(50)" label "Mensagem" column-label "Mensagem"

        field ttv_des_msg_erro                 erro                 as character format "x(60)" label "Mensagem Erro" column-label "Inconsistência"

        field ttv_cod_parameters               parameters               as character format "x(256)"
        .

 


Tabela Temporária

Descrição

Entrada/Saída

tt_params_generic_api_3

Conterá campos novos das temp-tables passadas como parâmetro.

Entrada / Saída

Atributo

Tipo

Formato

Descrição

Obrig.

Evol.

ttv_

rec

cod_id_param

recid

>>>>>>9

 

 

 

character

X(80)




ttv_cod_tabela

character

X(28)

Tabela

 

 



ttv_cod_campo

character

X(25)

Campo

 

 



ttv_cod_valor

character

X(8)

Valor

 

 

 




def temp-table tt_params_generic_api_3 no-undo

    field ttv_cod_rec_id                       as recid format ">>>>>>9id_param                       as character format "x(80)"

    field ttv_cod_tabela                   as character format "x(28)" label "Tabela" column-label "Tabela"

...

          ttv_cod_tabela                   ascending          ttv_rec_id                      

          ttv_cod_id_param                       ascending

          ttv_cod_campo                    ascending

    .

 


Exemplo Criação temp-table tt_params_generic_api_3:

CREATE tt_params_generic_api_3.
ASSIGN tt_params_generic_api_3.ttv_reccod_id_param = tt_movto_cta_correncorr_transf_mut_3.ttv_reccod_id_movto_cta_corren corren 
tt_params_generic_api_3.ttv_cod_tabela = "tt_movto_cta_correncorr_transf_mut"

tt_params_generic_api_3.ttv_cod_campo = "ttv_cod_cta_mutuo"
tt_params_generic_api_3.ttv_cod_valor = (Valor da Conta Mútuo)
.

...