Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico:

mip/miapi093.p

Objetivo              

Criação de solicitação de serviço.

 

Funcionamento

A sintaxe para executar a BO em modo persistente é:

...

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

tt-solic-serv-retorno

Temp-Table com as descrições da solicitação de serviço.

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

des-estado

character

 

Descrição do estado

 

001

des-equipto

character

 

Descrição do equipamento

 

001
des-usuariocharacter Descrição do usuário 001
des-planejadorcharacter Descrição do planejador 001
des-manutencaocharacter Descrição da manutenção 001
des-narrativacharacter Descrição da narrativa 001
des-sintoma-padraocharacter Descrição do sintoma padrão 001
des-causa-padraocharacter Descrição da causa padrão 001
des-interv-padraocharacter Descrição do intervalo padrão 001
des-equipe-respcharacter Descrição da equipe responsável 001
des-plano-paradacharacter Descrição do plano parada 001
des-tagcharacter Descrição do tag 001
des-familia-eqptocharacter Descrição da família do equipamento 001
des-centro-custocharacter Descrição do centro de custo 001
nr-ord-orig-predinteger Número da ordem origem 001
des-ord-origemcharacter Descrição da ordem origem 001
des-plano-origcharacter Descrição do plano origem 001
cd-tar-originteger Código da tarefa origem 001
des-tar-manutcharacter Descrição da tarefa 001
nr-ord-produinteger>>>,>>>,>>9Número da ordem de produção 001
des-man-corrcharacter Descrição da manutenção 001
total-orcadodecimal->>>,>>>,>>0.00Total Orçado 001
des-unid-negoccharacter Descrição da unidade de negócio 001

 

Métodos

Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

getListServiceRequest

Requisito

Nenhum

Sintaxe

run getListServiceRequest in h-handle.

Descrição

Retorna a lista com as solicitações de serviço.

 

Parâmetros

Descrição

 

ttSelecao

Parâmetros para criar a lista de solicitação.

 tt-solic-serv-retornoTemp-Table com a lista das solicitações de serviços.
 paginateNúmero de páginas.
 totalRecordsNúmero de registros na lista.

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.

createRecord

Requisito

Nenhum

Sintaxe

run createRecord in h-handle.

Descrição

Cria solicitação de serviço.

 

Parâmetros

Descrição

 

tt-solic-serv-html

Temp-table com as informações da solicitação a ser criada.

 tt-solic-serv-retornoTemp-Table com as solicitações de serviços

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.

 

getAvailableNumber

Requisito

Nenhum

Sintaxe

run getAvailableNumber in h-handle.

Descrição

Retorna um número disponível para solicitação de serviço.

 

Parâmetros

Descrição

 

i-solic-serv

Número solicitação de serviço disponível.

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.

getRowErrors

Requisito

Nenhum

Sintaxe

run getRowErrors in h-handle.

Descrição

Retorna RowErrors com os erros.

 

Parâmetros

Descrição

 

RowErrors

Temp-table com os erros.

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.

createTtSoliciServ

Requisito

Nenhum

Sintaxe

run createTtsoliciServ in h-handle.

Descrição

Cria temp-table para a criação de solicitação de serviço.

 

Parâmetros

Descrição

 

tt-solic-serv-html

Temp-table com os os dados para solicitação.

 tt-solic-servTemp-table completa para criação da solicitação de serviço.

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.

updateTtSoliciServ

Requisito

Nenhum

Sintaxe

run updateTtsoliciServ in h-handle.

Descrição

Atualiza a temp-table para a criação de solicitação de serviço.

 

Parâmetros

Descrição

 

tt-solic-serv-html

Temp-table com os os dados para solicitação.

 tt-solic-servTemp-table completa para criação da solicitação de serviço.

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.

...