Documentao de API -BO

API X BO
API para Retornar Saldo Oramento BGC
Descrio: Possibilitar atravs da passagem de informaes que
retorne o valor orado, empenhado e realizado.

Nome Fsico bgc/bgc705za.py

Release Inicial 5.05

Data de Liberao 03/07/2009

Uma API (Application Programming Interface) um programa que recebe parmetros especficos e executa uma tarefa determinada no
Datasul EMS Framework. A tarefa pode ser uma atualizao ou pode retornar informaes, resultados de um clculo ou um grfico.
Uma API uma interface aberta para as funes de negcio do Datasul EMS Framework.

O DBO um programa Progress que contm a lgica de negcio e acesso a dados para uma tabela do banco de dados. uma
evoluo das APIs dos produtos Datasul.

Objetivo
Possibilitar atravs da passagem de informaes que retorne o valor orado, empenhado e realizado.

Funcionamento
A execuo na forma persistente padro para essa API a execuo persistente.

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

run prgfin/bgc/bgc705za.py persistent set h-handle.
run pi_main_retorna_dados_ctbl_01 in h-handle(input-output table
tt_integr_retorna_sdo_orcto).

A varivel denominada h-handle ir receber o handle do programa, permitindo o acesso aos mtodos
internos da API.

Tabelas Temporrias
Nos atributos das tabelas temporrias de entrada e sada:

Arquivo: Documentao API e BO (TEC.193) Pgina 1 de 4

Reviso: 1.000 Novembro/2002 ltima Atualizao: 07/01/2010 15:57:00h

Tabela Temporria Descrio Entrada/Sada

tt_integr_retorna_sdo_orcto Entrada

Atributo Tipo Formato Descrio Obrigatrio Evoluo

ttv_cod_produt_dtsul char "x(8)" Produto (EMS2 / EMS5) Sim

tta_cod_empresa char "x(3)" Cdigo da Empresa Sim

tta_cod_estab char "x(5)" Estabelecimento No

tta_cod_plano_cta_ctbl char "x(8)" Plano de Contas No

tta_cod_cta_ctbl char "x(20)" Conta Contbil No

tta_cod_plano_ccusto char "x(8)" Plano de Centro de Custo No

tta_cod_ccusto char "x(11)" Centro de Custo No

ttv_cod_matriz_trad_org_ex char "x(8)" Matriz de Traduo No

t

ttv_cod_empresa_ext char "x(3)" Empresa Externa No

ttv_cod_estab_ext char "x(3)" Estabelecimento Externo No

ttv_cod_cta_ctbl_ext char "x(20)" Conta Contbil Externa No

ttv_cod_sub_cta_ctbl_ext char "x(08) Sub-Conta Externa No

ttv_cod_matriz_trad_finalid char "x(8)" Matriz de Traduo No

_ext Finalidade Externa

ttv_num_finalid_ext int >9 Moeda Externa No

tta_cod_unid_negoc char "x(3)" Unidade de Negcio Sim (EMS5)

tta_cod_proj_financ char "x(20)" Projeto No

tta_cod_finalid_econ char "x(10)" Finalidade Econmica No

tta_cod_cenar_ctbl char "x(8)" Cenrio Contbil No

tta_cod_exerc_ctbl char "9999" Exerccio Sim

tta_num_period_ctbl int ">99" Perodo Sim

ttv_dat_movto date "99/99/9999" Data Movimento No

Observaes:
a) Quando o produto origem for EMS2, devero ser informados somente os atributos externos (_ext). A API
far as tradues necessrias para os atributos correspondentes do EMS5;

Arquivo: Documentao API e BO (TEC.193) Pgina 2 de 4

Reviso: 1.000 Novembro/2002 ltima Atualizao: 07/01/2010 15:57:00h

b) Quando no for informada uma Matriz de Traduo, ser bucado primeiro a matriz de traduo
informada nos Parmetros Gerais do BGC, caso no tenha matriz informada nos parmetros, ser buscada
ento a matriz de traduo dos parmetros de integrao do EMS (Contabilizaes 2.00);

c) Quando no for informado o Cenrio Contbil, ser utilizado o cenrio parametrizado como Fiscal no
cadastro de Utilizao do Cenrio Contbil;

d) Quando no for informada a Data do Movimento, esse atributo ser atualizado com a data final do
Perodo/Exerccio Contbil informados;

e) Ser obrigatrio informar a Unidade de Negcio somente quando o produto for EMS5.

Tabela Temporria Descrio Entrada/Sada

tt_integr_retorna_sdo_orcto Entrada/Sada

Atributo Tipo Formato Descrio Obrigatrio Evoluo

tta_cod_cenar_orctario char "x(8)" Cenrio Oramentrio No

tta_cod_unid_orctaria char "x(8)" Unidade Oramentria No

tta_num_seq_orcto_ctbl int ">>>>>>>>9" Sequencia do Oramento No

tta_cod_vers_orcto_ctbl char "x(10)" Verso do Oramento No

Observao:
Se a base estiver parametrizada para efetuar a execuo oramentria, a API ir retornar os valores de
saldo utilizando as informaes de Ordem de Busca e Parmetros de Bloqueio cadastrados para a
empresa. Nesse caso, alm de retornar os valores Orado, Empenhado e Realizado, sero retornados
nesses campos tambm os dados do oramento encontrado atravs dos parmetros da execuo
oramentria. Caso contrrio, se a base NO estiver parametrizada para efetuar a execuo oramentria,
a API tentar retornar os valores buscando diretamente no Saldo do Oramento informado, e no Saldo da
Conta Contbil informada, sem utilizar a execuo oramentria. Nesse caso ser retornado somente o
Valor Orado e o Valor Realizado, sendo que o valor realizado poder ser negativo, quando o valor dos
movimentos a crdito for maior do que o valor dos movimentos a dbito.

Tabela Temporria Descrio Entrada/Sada

tt_integr_retorna_sdo_orcto Saida

Atributo Tipo Formato Descrio Obrigatrio Evoluo

ttv_val_tot_orcado dec "->>,>>>,>>>,>>9.99" Valor Orado ---

ttv_val_movto_empenh dec "->>,>>>,>>>,>>9.99" Valor Empenhado ---

ttv_val_realiz dec "->>,>>>,>>>,>>9.99" Valor Realizado ---

Arquivo: Documentao API e BO (TEC.193) Pgina 3 de 4

Reviso: 1.000 Novembro/2002 ltima Atualizao: 07/01/2010 15:57:00h

ttv_log_utiliz_exec_orctaria logical Sim/No Indica se foi Utilizada a ---
Execuo
Oramentria

ttv_cod_exerc_ctbl_ini char "9999" Exerccio Contbil ---

Inicial

ttv_cod_exerc_ctbl_fim char "9999" Exerccio Contbil Final ---

ttv_num_period_ctbl_ini int ">99" Perodo Inicial ---

ttv_num_period_ctbl_fim int ">99" Perodo Final ---

tta_log_bloq_empres logical Sim/No Bloqueio por Empresa ---

tta_log_bloq_estab logical Sim/No Bloqueio por ---

Estabelecimento

tta_log_bloq_unid_negoc logical Sim/No Bloqueio por Unidade ---

de Negcio

ttv_log_plano_cta_ctbl_bloq logical Sim/No Bloqueio por Plano de ---

Contas

tta_log_bloq_cta_ctbl logical Sim/No Bloqueio por Conta ---

Contbil

ttv_log_plano_ccusto_bloq logical Sim/No Bloqueio por Plano ---

Centro de Custo

tta_log_bloq_ccusto logical Sim/No Bloqueio por Centro de ---

Custo

tta_log_bloq_proj_financ logical Sim/No Bloqueio por Projeto ---

ttv_num_cod_erro int ">>>>,>>9" Nmero do Erro ---

ttv_des_msg_erro char "x(60)" Mensagem de Erro ---

ttv_des_msg_ajuda char "x(40)" Texto de Ajuda ---

Observaes:
a) Alm dos valores orado, empenhado e realizado, sero retornados tambm a faixa de Exerccio/Perodo
e as informaes do Parmetro de Bloqueio utilizados para retornar os valores. Esses atributos sero
atualizados somente quando for utilizada a execuo oramentria;

b) Ao primeiro erro ocorrido, a API ir interromper o processo de busca dos valores de saldo. As
informaes desse erro sero retornadas nos trs ltimos atributos da temp-table;

d) Se no momento da execuo da API o extrato de verso estiver ativo, sero gerados dois arquivos no
diretrio temporrio do sistema. Um contendo os dados de entrada recebidos pela API, e outro contendo as
informaes retornadas pela mesma.

2002 Datasul. Todos os direitos reservados.

Arquivo: Documentao API e BO (TEC.193) Pgina 4 de 4

Reviso: 1.000 Novembro/2002 ltima Atualizao: 07/01/2010 15:57:00h