Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | cdp/cdapi283.p |
Objetivo
Esta API será executada na geração dos movimentos de Mão de Obra da Manutenção Industrial. Seu objetivo é alterar a cpapi006.p, adicionando a chamada da API de Execução Orçamentária, a fim de verificar se o os movimentos de Mão de Obra (movto-mob) 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/cdapi283.p (INPUT TABLE tt-movto-dir,
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 cpapi006.p e dentro do Browser (b04in221.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-dir | Temp-Table |
| Temp-Tabela Movto-dir | 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-dir | Conterá as informações referente a tabela movto-dir | Entrada |
tt-erro | Conterá os erros ocorridos | Entrada/Saída |
Definição Atributos da Tabela Temporária tt-movto-dir:
Obs.: A tt-movto-dir é uma temp-table like da tabela movto-dir mais os campos abaixo.
Atributo | Tipo | Formato | Descrição |
cod-versao-integracao | Int | 999 | Código da versão de integração |
rw-movto-dir | Rowid |
| Rowid da tabela movto-dir |
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-dir like movto-dir
field cod-versao-integracao as integer format "999"
field rw-movto-dir as rowid
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/cdapi283.p (INPUT TABLE tt-movto-dir,
INPUT 0,
OUTPUT c-retorno-integ-bgc,
INPUT-OUTPUT tt-erro).
RUN cdp/cdapi283.p (INPUT TABLE tt-movto-dir,
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-dir 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 cpapi006.p (movto-dir).