Documento de API

Observação: A partir da release 12.1.23xx.

Objetivo

Criar documentos de entrada no módulo de Ativo Fixo do EMS 5.

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, armazenando o programa em uma variável através do comando PERSISTENT e em seguida executando uma PROCEDURE deste programa, passando-se os parâmetros com as informações necessárias.

A sintaxe para a chamada da API é:

DEF VAR v_hdl_program AS HANDLE NO-UNDO.
RUN prgfin\fas\fas791za.py PERSISTENT SET v_hdl_program.
RUN pi_api_criacao_docto_entr IN v_hdl_program (input "ems2",
                                                                                     input table tt_bem_invest_mga,
                                                                                     output table tt_log_erros).
DELETE PROCEDURE v_hdl_program. 

Parâmetros

Observações:

- Deve ser gerada a temp-table no programa que chamará a API. Esta temp-table conterá as informações sobre os documentos de entrada e os itens do documento que serão implantados no Ativo Fixo.

Retorno

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

Quando ocorrer algum erro antes da criação dos documentos e seus itens, os mesmos não serão criados.

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

O programa que irá executar a api_criar_bem_pat deverá conter e criar as seguintes tabelas temporárias:

1) Criação de Bem Patrimonial via API

4) Tabela de erros

Execução

Leitura e Criação dos Registros

Exemplo do programa para criação dos registros nas temp-tables com os documentos de entrada a serem implantados:

def new global shared var v_cod_empres_usuar
    as character
    format "x(3)":U
    label "Empresa"
    column-label "Empresa"
    no-undo.

def temp-table tt_log_erros no-undo
    field ttv_num_seq                      as integer format ">>>,>>9" label "Seqüência" column-label "Seq"
    field ttv_num_cod_erro                 as integer format ">>>>,>>9" label "Número" column-label "Número"
    field ttv_des_erro                     as character format "x(50)" label "Inconsistência" column-label "Inconsistência"
    field ttv_des_ajuda                    as character format "x(50)" label "Ajuda" column-label "Ajuda"
    index tt_id                           
          ttv_num_seq                      ascending
          ttv_num_cod_erro                 ascending
    .

    
/* Begin_Include: i_tt_bem_invest_mga */
def temp-table tt_bem_invest_mga no-undo
    &IF '{&emsfin_version}' < '5.07A' &THEN
    field ttv_cdn_empresa                  as Integer format '>>9' label 'Empresa Externa' column-label 'Empresa Ext Inicial'
    &ELSE
    field ttv_cod_empresa                  as char format 'x(3)' label 'Empresa Externa' column-label 'Empresa Ext Inicial'
    &ENDIF
    field ttv_cdn_emit                     as Integer format '>>>>>>>>9' label 'Emitente' column-label 'Emitente'
    field ttv_cod_nota                     as character format 'x(20)'
    field ttv_cod_ser_nota                 as character format 'x(5)' label 'Série Nota' column-label 'Série Nota'
    field ttv_cod_natur_operac             as character format 'x(6)' label 'Natureza Operação' column-label 'Natureza Operação'
    field ttv_cod_estab                    as character format 'x(3)' label 'Estabelecimento' column-label 'Estabelecimento'
    field ttv_dat_aquis_bem_pat            as date format '99/99/9999' label 'Data Aquisição' column-label 'Data Aquisição'
    field ttv_cod_cta                      as character format 'x(20)'
    field ttv_cdn_aux                      as Integer format '>>>,>>9'
    field ttv_cod_origem                   as character format 'x(8)' label 'Origem' column-label 'Origem'
    field ttv_des_aux_5                    as character format 'x(40)'
    field ttv_val_aquis_bem_pat            as decimal format '->>,>>>,>>>,>>9.99' decimals 2 initial 0 label 'Aquisição Bem' column-label 'Aquisição Bem'
    field ttv_val_aquis_fasb_bem_pat       as decimal format '>>,>>>,>>>,>>9.99' decimals 2
    field ttv_val_aquis_cmi_bem_pat        as decimal format '>>,>>>,>>>,>>9.99' decimals 2
    field ttv_cdn_unid_bem                 as Integer format '>>>,>>9'
    field ttv_cdn_org_bem                  as Integer format '>>>,>>9'
    field ttv_cdn_ord_manut                as Integer format '>>>,>>9'
    field ttv_des_bem_pat                  as character format 'x(40)' label 'Descrição Bem Pat' column-label 'Descrição Bem Pat'
    field ttv_rec_id_bem_pat_2             as &IF "{&ROWID_READY}" = "YES" &THEN rowid &ELSE recid format '>>>>>>9' &ENDIF
    field ttv_cod_unid_negoc               as character format 'x(3)' label 'Unid Negócio' column-label 'Un Neg'
    field tta_num_id_ri_bem_pat            as integer format '>>>,>>>,>>9' initial 1 label 'Identific Bem MRI' column-label 'ID Bem MRI'
    field ttv_gera_bem_quant               as logical initial no label "Gerar Bem por Quantidade" column-label "Gerar Bem por Quantidade"
    field ttv_sequencia                    as integer format '>>9' initial 0 label 'Sequencia' column-label 'Seq'
    field ttv_cod_moed_fasb                AS character format 'x(8)'
    field ttv_dat_fasb                     AS DATE format '99/99/9999'
    .
/* End_Include: i_tt_bem_invest_mga */

def var v_handle    as handle no-undo.

create tt_bem_invest_mga.
assign tt_bem_invest_mga.ttv_cod_empresa       = "10"
       tt_bem_invest_mga.ttv_cod_estab         = "1"
       tt_bem_invest_mga.ttv_dat_aquis_bem_pat = today
       tt_bem_invest_mga.ttv_cdn_emit          = 5
       tt_bem_invest_mga.ttv_cod_nota          = "04062024"
       tt_bem_invest_mga.ttv_cod_natur_operac  = "6181A"
       tt_bem_invest_mga.ttv_cod_ser_nota      = "S"
       tt_bem_invest_mga.ttv_val_aquis_bem_pat = 129.99 //VALOR DO BEM
       tt_bem_invest_mga.ttv_cdn_unid_bem      = 5 //QUANTIDADE
       tt_bem_invest_mga.ttv_des_bem_pat       = "Primeiro Bem"
       . 
       
create tt_bem_invest_mga.
assign tt_bem_invest_mga.ttv_cod_empresa       = "10"
       tt_bem_invest_mga.ttv_cod_estab         = "1"
       tt_bem_invest_mga.ttv_dat_aquis_bem_pat = today
       tt_bem_invest_mga.ttv_cdn_emit          = 5
       tt_bem_invest_mga.ttv_cod_nota          = "04062024"
       tt_bem_invest_mga.ttv_cod_natur_operac  = "6181A"
       tt_bem_invest_mga.ttv_cod_ser_nota      = "S"
       tt_bem_invest_mga.ttv_val_aquis_bem_pat = 1.99 //VALOR DO BEM
       tt_bem_invest_mga.ttv_cdn_unid_bem      = 20 //QUANTIDADE
       tt_bem_invest_mga.ttv_des_bem_pat       = "Segundo Bem"
       . 
 

run prgfin\fas\fas791za.py persistent set v_hdl_program.

run pi_api_criacao_docto_entr in v_hdl_program (input "ems2",
                                                                              input  table tt_bem_invest_mga,
                                                                              output table tt_log_erros).
delete procedure v_hdl_program.
assign  v_hdl_program = ?.                                 

for each tt_log_erros no-lock:
      message "Seq.:  " ttv_num_seq skip
                     "Cod. Erro: " ttv_num_cod_erro skip
                     "Descrição Erro: " ttv_des_erro skip
                     "Ajuda: " ttv_des_ajuda skip
                     view-as alert-box.
end.

CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Tela XXX
   1. Outras Ações / Ações relacionadas
      
4. Tela XXX
   1. Principais Campos e Parâmetros
      
5. Tabelas utilizadas

01. VISÃO GERAL

Descreva a visão geral. 

02. EXEMPLO DE UTILIZAÇÃO

Use esse espaço para colocar exemplos de utilização. 

03. TELA XXXXX

Outras Ações / Ações relacionadas

04. TELA XXXXX

Principais Campos e Parâmetros

05. TABELAS UTILIZADAS

Coloque o link das tabelas relacionadas