Documentação de API - ENAPI209 - API para consultas de Estrutura Via Onde-se-usa

Objetivo

Esta API tem a funcionalidade de realizar consultas de estruturas via onde-se-usa, seja de forma item a item ou por uma faixa de itens, de forma completa ou sumarizada. Baseado nos parâmetros recebidos, a API fará a listagem da estrutura do item onde os mesmos são usados.

Funcionamento

Como parâmetros iniciais, são recebidos 3 tabelas temporárias (temp-tables).

tt-param – Tabela temporária de entrada (input)
tt-digita – Tabela temporária de entrada (input)
tt-estrutura – Tabela temporária de saída (output).

Importante: A include enapi209.i1 contém a definição das temp-tables citadas e deve ser chamada no início do programa que fará a execução da API.

A API pode ser executada de forma persistente ou de forma direta, conforme abaixo:

De forma direta:

Run enp/enapi209.p (input table tt-param,
                                    Input table tt-digita,
                                    Output table tt-estrutura).

Persistente:          

Run enp/enapi209.p persistent set h-enapi209 (input table tt-param,
                                                                                Input table tt-digita,
                                                                                Output table tt-estrutura).

 Detalhe da execução dos modos, serão descritos abaixo.

Existem 3 formas para realizar a consulta de estruturas.

• Por Faixa (tt-param).

Este tipo de execução pode ser executado pela API de forma direta ou persistente. Para execução persistente, basta executar o método pesquisaItens para montar a temp-table e em seguida o getTTEstrutura para retornar os resultados. Na execução direta ambos os métodos serão executados de forma transparente, não sendo necessário mais nenhum comando.

Exemplo de execução persistente:

Run pesquisaItens in h-enapi209. 

RUN getTTEstrutura IN h-enapi209 (OUTPUT TABLE tt-estrutura).

Obs.: Somente serão pesquisados os itens desta faixa se não houver nenhum registro na tabela temporária tt-digita.

• Por Itens selecionados (tt-digita);

 Esta forma também pode ser executada de forma direta ou persistente, semelhante a execução do modo por faixa. Não há diferença entre as chamadas dos métodos, o que muda é a existência de registros dentro da tt-digita.

• Pesquisa por item :

 Este método somente pode ser executado de forma persistente e não é necessário a execução do método pesquisaitens.

Deve-se executar conforme abaixo:

 RUN recebeTTParam IN h-enapi209 (INPUT TABLE tt-param).

 RUN piSetaItem IN h-enapi209 (input “<Item>” ).

 RUN GetOndeUsaItem IN h-enapi209 (INPUT “<Item>”,
                                  INPUT “<Item>”,
                                  INPUT "",
                                  INPUT <Quantidade>, /*Quantidade */
                                  INPUT 1,
                                  INPUT 0, /*Nivel*/
                                  INPUT 0, /*Sequencial do item Pai*/
                                  INPUT NO). /* */

RUN getTTEstrutura IN h-enapi209 (OUTPUT TABLE tt-estrutura).

Tabelas Temporárias

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

Parâmetros de Saída

No retorno da execução enapi209.p, será retornado a tabela temporária tt-estrutura, conforme estrutura abaixo

Esta temp-table possui os índices, conforme abaixo

    index tt-sum  it-codigo es-codigo cod-ref-it cod-lista-compon
    index tt-estr i-sequen it-codigo es-codigo sequencia cod-ref-it cod-lista-compon