Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | mip/miapi072.p |
Objetivo
A API gera as ordens de manutenção através do planejamento realizado anteriormente.
Funcionamento
A API ira confirmar o planejamento da manutenção, gerando Ordens de Manutenção a partir dos registros presentes da tabela temporária passado como parâmetro, irá também atualizar o estado do filtro para confirmado.
A sintaxe para executar a API em modo persistente é:
run mip\miapi072.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 contem as ordens que foram planejadas. | Entrada |
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. | Sim |
|
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. | Sim |
|
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 |
|
establishment | Char | Padrão | Estabelecimento | Não |
|
description | Char | Padrão | Descricao | Não |
|
inspection | Char | Padrão | Inspeção | Não |
|
planner | Char | Padrão | Planejador | Não |
|
project | Char | Padrão | Projeto | Não |
|
maintenanceDuration | Integer | Padrão | Duração da Manutenção | Não |
|
stoppedPlan | Char | Padrão | Plano de Parada | Não |
|
initialDate | Date | 99/99/9999 | Data Inicial | Não |
|
forecastCompletion | Date | 99/99/9999 | Previsão Completo | Não |
|
earlyStart | Date | 99/99/9999 | Inicio mais cedo | Não |
|
lateStart | Date | 99/99/9999 | Inicio mais tarde | Não |
|
sequence | Integer | Padrão | Sequencia | Não |
|
team | Char | Padrão | Time | Não |
|
closingDate | Date | 99/99/9999 | Data Aproximada | Não |
|
specialtyAllocationForm | Integer | Padrão | Forma de Alocação Especialidade | Não |
|
lastOrder | logical | Sim/Não | Ultima Ordem | Não |
|
isPlanned | logical | Sim/Não | Planejada | Não |
|
filterNumber | Integer | Padrão | Numero do Filtro | Não |
|
filterSequence | Integer | Padrão | Seqüencia do Filtro | Não |
|
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
confirmPlanning
Requisito | Handles estarem inicializados. | |
Sintaxe | RUN confirmPlanning IN h-handle(INPUT filterNumber, INPUT TABLE ttPlanningDetailVO, OUTPUT TABLE RowErrors). | |
Descrição | Confirmar o planejamento da Manutenção. | |
| Parâmetros | Descrição |
| filterNumber ttPlanningDetailVO | Filtro realizado para gerar o planejamento da manutenção. Tabela temporária que contem as ordens planejadas. |
| 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.
|