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.

...

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 Output table tt-estrutura).

Persistente:          

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

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

Existem 3 formas para realizar a consulta de estruturas.

...

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.  Obs: Somente serão pesquisados, quando houver registro na Não há diferença entre as chamadas dos métodos, o que muda é a existência de registros dentro da tt-digita. Com esta parametrização, alguns filtros não são realizados. 

• 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 10, /*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: 

TT-PARAM

– Temp

-

table utilizada para seleção e filtroAtributo

Utilizada para filtrar os itens que farão parte da consulta. Apenas itens cujos dados se enquadrarem em todos os quesitos serão selecionados.
Campo	Finalidade	Tipo	Formato

 

Ge

ge-codigo-ini

IntegerGe

Código inicial do grupo de estoque

INTEGER

>>9

 

ge-codigo-fim

Integer

Código final do grupo de estoque

INTEGER

>>9

 

Fm

fm-codigo-ini

Char

>>>>>,>>9.9999

 

Código inicial da família a ser considerada	CHARACTER	x(8)
fm

Fm

-codigo-fim

Char

>>>>>,>>9.9999

 

It

Código final da família	CHARACTER	x(8)
it-codigo-ini

Char

>>>>>,>>9.9999

 

Item inicial da consulta	CHARACTER	x(16)
it

It

-codigo-fim

Char

xx

 

Dt

Item final da consulta	CHARACTER	x(16)
dt-corte

Date

Data de corte da estrutura

DATE

99/99/9999

 

Nr

nr-niveis

Integer

99/99/9999

 

De-quantidade

Decimal

x(12)

 

Ind-process-mrp

Integer

>9

 

Cod-estabel

Char

Sim/Não

 

Nr-linha

Integer

Sim/Não

 

Cod-unid-negoc

Char

x(3)

 

Sumariza

Logical

>>>,>>>,>>9

 

Estado

Log (Extent 4)

99/99/9999

 

l-agrup-lista

Logical

x(8)

 

 

 

Indica o número de níveis da estrutura que será exibido no relatório. Máx = 30	INTEGER	>>9
de-quantidade	Determina a quantidade do item pai da estrutura. Esse valor será utilizado para cálculo das quantidades de uso dos itens filhos na estrutura.	DECIMAL	>>>,>>9.9999
ind-process-mrp	Parâmetro lógico que, se marcado, define que serão trazidos todos os processos de fabricação dos itens. Caso contrário, será buscado apenas o processo principal.	LOGICAL	YES/NO
cod-estabel	Código do estabelecimento. Será utilizado para buscar apenas os processos de fabricação correspondentes a esse estabelecimento.	CHARACTER	x(5)
nr-linha	Código da linha de produção. De forma semelhante ao estabelecimento, também será utilizado no filtro dos processos de fabricação.	INTEGER	>>9
cod-unid-negoc	Unidade de negócio. Também usada no filtro de processos.	CHARACTER	x(3)
sumariza	Ao ser marcado, o relatório irá resumir as informações de cada item, agrupando-as num único registro. Por exemplo, se o mesmo item for utilizado várias vezes dentro da mesma estrutura, porém possua itens pais diferentes, se o parâmetro estiver marcado, ele será exibido apenas uma vez, com as quantidades somadas.	LOGICAL	YES/NO
estado	Parâmetro lógico com quatro posições, que permite filtrar os estados dos itens que serão exibidos, sendo 1 = Ativos, 2 - Obsoleto ordens automáticas, 3 - Obsoleto todas as Ordens e 4 - Totalmente Obsoleto.	LOGICAL	YES/NO (EXTENT 4)
l-agrup-lista	Quando o relatório estiver parametrizado para Sumarizar, é possível definir se itens que são utilizados múltiplas vezes na mesma estrutura, porém com listas de componentes diferentes, também deverão ser sumarizados.	LOGICAL	YES/NO

TT-DIGITA- Tabela temporária utilizada para determinar quais itens deverão ser listados na consulta. Tem precedência sobre a tt-param, portanto se existirem registros na tt-digita, os filtros serão ignorados.
Atributo	Finalidade	Tipo	Formato
it-codigo	Código do item a ser consultado.	CHARACTER	x(16)
cod-refer	Referência do item, quando for controle por referência	CHARACTER	x(8)
dt-corte	Data de corte da estrutura	DATE	99/99/9999
cod-estabel	Código do estabelecimento para filtro dos processos	CHARACTER	x(5)
nr-linha	Linha de produção para filtro dos processos	INTEGER	>>9
cod-unid-negoc	Unidade de negócio para filtro dos processos	CHARACTER	x(3)
de-quantidade	Quantidade do item pai	DECIMAL	>>>,>>9.9999

TT-DIGITA – Temp-table que receberá os itens que serão consultados

Atributo

Tipo

Formato

Evolução

It-codigo

Char

“x(16)”

 

Cod-refer

Char

“x(8)”

 

Descricao

Char

“x(36)”

 

Un

Char

“x(2)”

 

Quant-Orig

Decimal

“->>>>>,>>9.9999”

 

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

...