Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | mip/miapi078.p |
Objetivo
O objetivo desta API é analisar os planos de manutenção executados para cada equipamento e identificar se o plano foi executado (cumprimento das ordens) antes, dentro ou após o prazo estipulado para a sua execução, ou se não foi executado.
Funcionamento
Através dos parâmetros de entrada a API filtra os planos de manutenção e calcula o planejamento para demonstrar se o que foi previsto pelo planejamento está sendo realizado.
A sintaxe para executar a API em modo persistente é:
run mip\miapi078.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 |
|
fmEquiptoIni | CHAR |
| Família do equipamento inicial | Não |
|
fmEquiptoFim | CHAR |
| Família do equipamento 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 |
|
eventoIni | CHAR |
| Evento inicial | Não |
|
eventoFim | CHAR |
| Evento final | Não |
|
tipoManutIni | CHAR |
| Tipo de manutenção inicial | Não |
|
tipoManutFim | CHAR |
| Tipo de manutenção final | Não |
|
manutIni | CHAR |
| Manutenção inicial | Não |
|
manutFim | CHAR |
| Manutenção final | Não |
|
planejadorIni | CHAR |
| Planejador inicial | Não |
|
planejadorFim | CHAR |
| Planejador final | Não |
|
equipeIni | CHAR |
| Equipe inicial | Não |
|
equipeFim | CHAR |
| Equipe final | Não |
|
paradaIni | CHAR |
| Parada inicial | Não |
|
paradaFim | CHAR |
| Parada 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 – Evento 08 – Plano Origem 09 – Manutenção 10 – Planejador 11- Tipo de Manutenção 12 – Classe 13 - Estatística | 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 | |||||
ttParam | Parâmetros para indicar os tipos de resultados que serão mostrados na consulta: Antes do Prazo, Dentro do Prazo, Depois do Prazo ou Não Realizado | Entrada |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
antesPrazo | LÓGICO |
| Indica se serão apresentadas ordens executadas antes do prazo | Sim |
|
dentroPrazo | LÓGICO |
| Indica se serão apresentadas ordens executadas dentro do prazo | Sim |
|
depoisPrazo | LÓGICO |
| Indica se serão apresentadas ordens executadas depois do prazo | Sim |
|
naoRealizado | LÓGICO |
| Indica se serão apresentadas ordens não realizadas | 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 |
|
|
origem | CHAR |
| Origem do plano |
|
|
dtExec | CHAR |
| Data de execução |
|
|
dtIniCedo | CHAR |
| Data de início mais cedo |
|
|
dtPadrao | CHAR |
| Data prevista para manutenção da ordem |
|
|
dtIniTarde | CHAR |
| Data de início mais tarde |
|
|
utDiaria | CHAR |
| Média de utilização diária |
|
|
vlContador | CHAR |
| Valor do contador do equipamento |
|
|
usoReal | CHAR |
| Utilização real do equipamento |
|
|
usoPadrao | CHAR |
| Utilização padrão prevista para manutenção |
|
|
diferenca | CHAR |
| Diferenção entre o usuário real e o uso padrão |
|
|
execução | CHAR |
| Antes do Prazo, Dentro do Prazo, Depois do Prazo ou Não Realizado |
|
|
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
piCalculaPrevistoXRealizado
Requisito | Handles estarem inicializados. | |
Sintaxe | RUN piCalculaPrevistoXRealizado IN h-handle(INPUT TABLE ttFiltro, INPUT TABLE ttTarget, INPUT TABLE ttParam, OUTPUT TABLE ttTree, OUTPUT TABLE ttPlanoPrevXReal). | |
Descrição | Calcular previsto x realizado dos planos. | |
| Parâmetros | Descrição |
| ttFiltro | Filtro dos planos |
| ttTarget | Dimensões para classificação |
| ttParam | Parâmetros |
| ttTree | Valores da consulta agrupados conforme as dimensões |
| ttPlanoPrevXReal | Ordens de manutenção previstas e realizadas |
Retorno | A API irá retornar duas temp-tables: uma para classificação/agrupamento dos registros e outra com os valores previstos x realizados dos planos de manutenção. |