MIAPI071 - Atualizar e Remover ordens simuladas.

Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	mip/miapi071.p

Objetivo

A API tem como objetivo detalhar, alterar e remover ordens simuladas.

Funcionamento

Através dos parâmetros de entrada a API posiciona os registros na tabela de Planejamento da Manutenção removendo ou alterando os registros.

A sintaxe para executar a API em modo persistente é:

run mip\miapi071.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.	Não
maintenanceDate	Date	99/99/9999	Data da manutenção.	Sim
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.	Sim
symptom	Char	Padrão	Sintoma do problema.	Sim
intervention	Char	Padrão	Intervenção.	Sim
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	Sim
inspection	Char	Padrão	Inspeção	Não
planner	Char	Padrão	Planejador	Sim
project	Char	Padrão	Projeto	Sim
maintenanceDuration	Integer	Padrão	Duração da Manutenção	Sim
stoppedPlan	Char	Padrão	Plano de Parada	Sim
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	Sim
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

updateOrder

Requisito	Handles estarem inicializados.
Sintaxe	RUN updateOrder IN h-handle(INPUT TABLE ttPlanningDetailVO, OUTPUT TABLE RowErrors).
Descrição	Atualizar ordem planejada.
	Parâmetros	Descrição
	ttPlanningDetailVO RowErrors	Tabela Temporária com as informações do planejamento. Tabela temporária com os erros que poderão retornar da API.
Retorno	A API/BO irá alterar na tabela os valores solicitados 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.

deletePlannedOrders

Requisito	Handles estarem inicializados.
Sintaxe	RUN deletePlannedOrders IN h-handle (INPUT TABLE ttPlanningDetailVO, OUTPUT TABLE RowErrors).
Descrição	Deletar ordens planejadas.
	Parâmetros	Descrição
	ttPlanningDetailVO RowErrors	Tabela Temporária com as informações do planejamento. Tabela temporária com os erros que poderão retornar da API.
Retorno	A API/BO irá deletar o registro da ordem planejada e 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.

Árvore de páginas