Árvore de páginas


Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 cdp/cdapi284.p

 

Objetivo

 

Esta API será executada geração dos  movimentos de Gastos Gerais de Fabricação(movto-ggf) do Manutenção Industrial. Seu objetivo é alterar a cpapi005.p, adicionando a chamada da API de Execução Orçamentária, a fim de verificar se os movimentos de Gastos Gerais de Fabricação (movto-ggf) em questão ultrapassam o valor do orçamento, e se não ultrapassarem empenhar essas movimentações, recebendo os seguintes parâmetros:

                  RUN cdp/cdapi284.p (INPUT TABLE tt-movto-ggf,

                                      INPUT 0,

                                      OUTPUT c-retorno-integ-bgc,

                                      INPUT-OUTPUT tt-erro).


Funcionamento

Essa API será executa somente a partir de um ponto específico dentro cpapi005.p e dentro do Browser (b01in569.w) responsável pela eliminação de reporte.

A API irá alimentar informações na tabela tt_xml_input_1 que será envida para api de finanças “prgfin/bgc/bgc700za.py “.

 

Definição dos Parâmetros:

 

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

tt-movto-ggf

Temp-Table

 

Temp-Tabela Movto-ggf

Sim

001

i-tipo-trans

Int

Default

Tipo de Transação

Não

001

c-retorno-integ-bgc

Char

Default

Retorno da Integração (OK/NOK)

Não

001

 

Tabelas Temporárias

Atributos das tabelas temporárias:

 

Tabela Temporária

Descrição

Entrada/Saída

tt-movto-ggf

Conterá as informações referente a tabela movto-ggf

Entrada

tt-erro

Conterá os erros ocorridos

Entrada/Saida

 

Definição Atributos da Tabela Temporária tt-movto-ggf:

Obs.: A tt-movto-ggf é uma temp-table like da tabela movto-ggf mais os campos abaixo.

Atributo

Tipo

Formato

Descrição

cod-versao-integracao

Int

999

Código da versão de integração

rw-movto-ggf

Rowid

 

Rowid da tabela movto-ggf

cria-ext-ord         

Log

Default

Cria extensão da Tabela Ordem

lg-recalc-horas

Log

Default

Recalcula horas

rw-mov-orig

Rowid

 

Rowid mov-orig

Exemplo de definição de “temp-table like” com campos a mais:

def temp-table tt-movto-ggf like movto-ggf

   field cod-versao-integracao as integer format "999"

   field rw-movto-ggf          as rowid

   field cria-ext-ord          as logical

   field lg-recalc-horas       as logical

   field rw-mov-orig           as rowid.

 

Definição Atributos da Tabela Temporária tt-erro:

Atributo

Tipo

Formato

Descrição

i-sequen 

Int

Default

Seqüência do Erro

cd-erro     

Int

x(40)

Código do Erro

Mensagem

Char

x(255)

Descrição da Mensagem de Erro

Considerações Gerais:

 

  • Devem ser passadas os parâmetros listados acima, sendo 1 (uma) temp-table de entrada.

 

  • A temp-table de entrada é passada como parâmetro através do comando INPUT PARAM TABLE.

 

  • A temp-table de entrada e saída é passada como parâmetro através do comando INPUT-OUTPUT PARAM TABLE.

 

 

Exemplo                  RUN cdp/cdapi284.p (INPUT TABLE tt-movto-ggf,

                                      INPUT 0,

                                      OUTPUT c-retorno-integ-bgc,

                                      INPUT-OUTPUT tt-erro).

 

                      RUN cdp/cdapi284.p (INPUT TABLE tt-movto-ggf,

                                          INPUT 3, /* 3 - Elimina Empenho */

                                          OUTPUT c-retorno-integ-bgc,

                                          INPUT-OUTPUT tt-erro).

 

  • A API funciona da seguinte forma: Recebe os parâmetros, faz as criticas das mesmas, caso não tenha ocorrido nenhum problema faz o estorno ou a atualização. O primeiro parâmetro passa a temp-table da tabela movto-ggf para que seja feita a leitura dentro desta API. O segundo parâmetro, indica qual a operação que foi feita, com isso sabemos a função que será executa. E o terceiro é o retorno que indicara se a integração foi com sucesso ou não.

 

  • Essa API será executa pela cpapi005.p (movto-ggf).