Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | mip/miapi070.p |
Objetivo
A API tem como objetivo gerar um planejamento de manutenção através do filtro aplicado.
Funcionamento
A API realiza o Planejamento da Manutenção Industrial, a partir da simulação realizada anteriormente, obtida pelo numero da simulação passada como parâmetro.
Após a leitura da tabela da simulação do planejamento, é realizado as validações e a criação das ordens ordens planejadas (mi-ord-plan).
A sintaxe para executar a API em modo persistente é:
run mip\miapi070.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
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
ttPlanningDetailVO | Tabela que contém as ordens que foram planejadas. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
dimensionCode | Char | Padrão | Código da dimensão da treeView. | Não |
|
orderNumber | Integer | Padrão | Número da Ordem de Manutenção/Produção. | Não |
|
orderStatus | Char | Padrão | Estado da ordem. | Não |
|
orderStatusCode | Integer | Padrão | Código do estado da ordem. | Não |
|
tagCode | Char | Padrão | Código da Tag. | Não |
|
equipmentFamily | Char | Padrão | Família do equipamento. | Não |
|
equipmentCode | Char | Padrão | Código do equipamento. | Não |
|
maintenanceDate | Date | 99/99/9999 | Data da manutenção. | Não |
|
isManual | Logical | Sim/Não | Indica se a ordem foi gerada manualmente. | Não |
|
originPlan | Char | Padrão | Hora de Termino do Apontamento. | Não |
|
maintenanceCode | Char | Padrão | Código da manutenção. | Não |
|
maintenanceType | Integer | Padrão | Tipo da manuntenção. | Não |
|
maintenanceTypeDescription | Char | Padrão | Descrição do tipo de manunteção. | Não |
|
businessUnit | Char | Padrão | Código da unidade de negócio. | Não |
|
costCenter | Char | Padrão | Centro de Custo. | Não |
|
cause | Char | Padrão | Causa do problema. | Não |
|
symptom | Char | Padrão | Sintoma do problema. | Não |
|
intervention | Char | Padrão | Intervenção. | Não |
|
plannedTotal | Decimal | 9999,9999 | Numero total de ordens planejadas. | Não |
|
programmedTotal | Decimal | 9999,9999 | Numero total de ordens Programadas. | Não |
|
realizedTotal | Decimal | 9999,9999 | Numero total de ordens Realizadas. | Não |
|
Tabela Temporária | Descrição | Entrada/Saída |
ttPlanningerrorvo | Contém os erros ocorridos na API. | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
description | Char | Padrão | Descrição dos erros | Sim | 001 |
equipment | Char | Padrão | Equipamento. | Sim | 001 |
planning | Char | Padrão | Planejamento. | Sim | 001 |
codError | Integer | Padrão | Código do erro. | Sim | 001 |
Tabela Temporária | Descrição | Entrada/Saída |
RowErrors | Contém os erros ocorridos na API (Mesma temp-table utilizada para gerar erros pelas BOs) | Saída |
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | integer | padrão | Seqüência dos erros | Sim | 001 |
ErrorNumber | integer | padrão | Número do erro | Sim | 001 |
ErrorDescription | char | padrão | Descrição do erro | Sim | 001 |
ErrorParameters | char | padrão | Parâmetros passados para criar mensagem | Não | 001 |
ErrorType | char | padrão | Tipo do erro: WARNING: Aviso ERROR: Erro | Sim | 001 |
ErrorHelp | char | padrão | Texto de ajuda do erro | Sim | 001 |
ErrorSubType | char | padrão | Sub Tipo da mensagem de erro | Não | 001 |
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
generatePlanning
Requisito | Handles estarem inicializados | |
Sintaxe | RUN generatePlanning IN h- handle (INPUT filterNumber, INPUT allowsOrdersReprogramming, OUTPUT TABLE ttPlanningDetailVO, OUTPUT TABLE ttPlanningerrorvo, OUTPUT TABLE RowErrors). | |
Descrição | Gerar planejamento de ordem de manutenção. | |
| Parâmetros | Descrição |
| filterNumber allowsOrdersReprogramming | Numero do filtro. Valor lógico para permitir ordens reprogramadas. |
| ttPlanningDetailVO | Tabela com os detalhes do planejamento. |
| ttPlanningerrorvo | Erros do planejamento. |
| RowErrors | Tabela temporária com os erros que poderão retornar da API. |
Retorno | A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors ou ttPlanningerrorvo. |