Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | mip/miapi079.p |
Objetivo
O objetivo desta API é apresentar as garantias e uso estimado dos componentes.
Funcionamento
Através dos parâmetros de entrada a API filtra as tarefas e subsistemas e calcula a garantia e uso estimado.
A sintaxe para executar a API em modo persistente é:
run mip\miapi079.p persistent set h-handle.
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
ttFiltro | Tabela que contém o filtro para os planos de manutenção | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
periodoIni | DATE |
| Período inicial | Não |
|
periodoFim | DATE |
| Período final | Não |
|
estabIni | CHAR |
| Estabelecimento inicial | Não |
|
estabFim | CHAR |
| Estabelecimento final | Não |
|
subContaIni | CHAR |
| Centro de custo inicial | Não |
|
subContaFim | CHAR |
| Centro de custo final | Não |
|
tagIni | CHAR |
| TAG inicial | Não |
|
tagFim | CHAR |
| TAG final | Não |
|
equiptoIni | CHAR |
| Equipamento inicial | Não |
|
equiptoFim | CHAR |
| Equipamento final | Não |
|
sistemaIni | CHAR |
| Sistema inicial | Não |
|
sistemaFim | CHAR |
| Sistema final | Não |
|
subSistIni | CHAR |
| Subsistema inicial | Não |
|
subSistFim | CHAR |
| Subsistema final | Não |
|
planejadorIni | CHAR |
| Planejador inicial | Não |
|
planejadorFim | CHAR |
| Planejador final | Não |
|
analistaIni | CHAR |
| Analista inicial | Não |
|
analistaFim | CHAR |
| Analista final | Não |
|
componenteIni | CHAR |
| Componente inicial | Não |
|
componenteFim | CHAR |
| Componente final | Não |
|
Tabela Temporária | Descrição | Entrada/Saída |
ttTarget | Tabela que contem as dimensões para classificar a apresentação dos dados. As visões disponíveis para consulta são as seguintes: 01 – Estabelecimento 02 – Centro de Custo 03 – TAG 04 – Equipamento 05 – Sistema 06 – Sub-Sistema 07 – Componente 08 – Planejador 09 – Analista 10 – Período (mês/ano) | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
dimension | CHAR |
| Código da dimensão conforme valores informados acima | Sim |
|
Tabela Temporária | Descrição | Entrada/Saída |
ttTree | Temp-table com os valores da consulta agrupada conforme as dimensões definidas | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
fatherKey | CHAR |
| Chave do pai |
|
|
itemKey | CHAR |
| Chave do item |
|
|
itemText | CHAR |
| Código e descrição do item |
|
|
dimensionCode | CHAR |
| Código da dimensão |
|
|
Sequence | INTEGER |
| Sequência |
|
|
Tabela Temporária | Descrição | Entrada/Saída |
ttPlanoPrevXReal | Tabela que contém as ordens de manutenção da consulta | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
nrOrdProdu | INTEGER |
| Número da ordem de manutenção |
|
|
cdTarefa | INTEGER |
| Número da tarefa |
|
|
cdManut | CHAR |
| Código da manutenção |
|
|
cdEquipto | CHAR |
| Código do equipamento |
|
|
cdSubSist | CHAR |
| Código do subsistema |
|
|
dtGartia | CHAR |
| Data de garantia |
|
|
diasGartia | INTEGER |
| Dias garantia |
|
|
gartia | CHAR |
| Garantia conforme utilização |
|
|
dtVenctoGartia | CHAR |
| Data de vencimento da garantia |
|
|
unVenctoGartia | CHAR |
| Vencimento da garantia conforme utilização |
|
|
emGartia | CHAR |
| Indica se está em garantia |
|
|
difGartia | CHAR |
| Diferença de garantia |
|
|
difDiasGartia | INTEGER |
| Diferença de garantia em dias |
|
|
diasUsoEstimad | INTEGER |
| Dias de uso estimado |
|
|
usoEstimado | CHAR |
| Uso estimado por utilização |
|
|
dtVenctoUso | CHAR |
| Data de vencimento do uso estimado |
|
|
unVenctoUso | CHAR |
| Vencimento do uso estimado por utilização |
|
|
emUsoEstimado | CHAR |
| Indica se está em uso |
|
|
difUsoEstimado | CHAR |
| Diferença de uso estimado |
|
|
difDiasUsoEst | INTEGER |
| Diferença de uso estimado em dias |
|
|
dtAvaliacao | CHAR |
| Data de Avaliação |
|
|
itemKey | CHAR |
| Chave do item para associar o registro com a dimensão (ttTree) |
|
|
Métodos
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Método Negócio
piBuscaGarantias
Requisito | Handles estarem inicializados. | |
Sintaxe | RUN piBuscaGarantias IN h-handle(INPUT TABLE ttFiltro, INPUT TABLE ttTarget, OUTPUT TABLE ttTree, OUTPUT TABLE ttConsultaVencimentoGarantia). | |
Descrição | Calcular previsto x realizado dos planos. | |
| Parâmetros | Descrição |
| ttFiltro | Filtro da consulta |
| ttTarget | Dimensões para classificação |
| ttTree | Valores da consulta agrupados conforme as dimensões |
| ttConsultaVencimentoGarantia | Valores de garantia e uso estimado dos componentes |
Retorno | A API irá retornar duas temp-tables: uma para classificação/agrupamento dos registros e outra com os valores de garantia e uso estimado dos componentes.
|