...
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | cop/coapi001 |
Objetivo
A API, atualiza a quilometragem do componente na vida e no apontamento de movimentos de componentes.
Funcionamento
A API percorre os componentes, buscando para cada um, o último movimento. Para este movimento é verificado qual a vida em que este se encontra.
...
A execução na forma persistente não existe para esta API.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
Tabela Temporária | Descrição | Entrada/Saída |
tt-param | Contém os campos para se fazer a seleção dos registros na API | Entrada |
...
Como a API não é rodada persistente, não existem métodos disponíveis para execução.
Método Básico
piValidaInicial
Requisito | Nenhum | |
Sintaxe | run piValidaInicial in this-procedure. | |
Descrição | Faz as Validações Iniciais para atualizações dos componentes. | |
| Parâmetros | Descrição |
| Não contém | |
Retorno | A API 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 | |
| | | |
Método Negócio
piProcessaAtualizacao
Requisito | Nenhum. | |
Sintaxe | run piProcessaAtualizacao in this-procedure. | |
Descrição | Processa as atualizações das quilometragens nos componentes. Percorre os componentes e calcula a quilometragem verificando os apontamentos de movimentos de componentes e a localização atual do componente. | |
| Parâmetros | Descrição |
| Não Contém | |
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. | | | | | |
piCalculo
Requisito | Deve ser chamada pela piProcessaAtualizacao. | |
Sintaxe | run piCalculo in this-procedure (input <integer>, input <character>, input <decimal>, input <decimal>). | |
Descrição | Busca os movimentos de quilometragem do equipamento ao qual o componente estava locado nas datas passadas e calcula a durabilidade do componente (diferença entre a quilometragem final menos a inicial do equipamento, verificando a porcentagem de suspensão do eixo, conforme cadastrado no equipamento). |
| | Parâmetros | Descrição |
| pEmp | Empresa |
| pEqpto | Equipamento |
| pInvFinal | Data/Hora invertida para buscar a quilometragem final |
| pInvInicial | Data/Hora invertida para buscar a quilometragem inicial |
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. | | | | | |
buscaKM
Requisito | Deve ser chamada pela piCalculo. | |
Sintaxe | run buscaKM in this-procedure input <integer>, input <character>, input <decimal>, output <decimal>). | |
Descrição | Busca a quilometragem do equipamento na data/hora passadas como parâmetro, se não encontrar, retorna a quilometragem inicial do equipamento. | |
| Parâmetros | Descrição |
| pEmp | Empresa |
| pEqpto | Equipamento |
| pInvertida | Data/Hora invertida para buscar a quilometragem |
| pKM | Valor da quilometragem |
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. | |
| | | |
...
piAtualizaDurabilidade
Requisito | Deve ser chamada pela piProcessaAtualizacao. | |
Sintaxe | run piAtualizaDurabilidade in this-procedure. | |
Descrição | Atualiza os valores percorridos na vida e no apontamento do componente. | |
| Parâmetros | Descrição |
| Não contém | |
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. | | | | | |
piProcessaAtualizacaoPlano
Requisito | Nenhum. | |
Sintaxe | run piProcessaAtualizacaoPlano in this-procedure. | |
Descrição | Processa as atualizações das quilometragens dos planos de manutenção dos componentes. Busca os componentes que estão sendo lidos em piPricessaAtualizaPlano e calcula a quilometragem verificando os apontamentos de movimentos de componentes e a localização atual do componente . | |
| Parâmetros | Descrição |
| Não Contém | |
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. | | | | | |
piComponenteTotal
Requisito | Deve ser chamada pela piProcessaAtualizacao. | |
Sintaxe | run piComponenteTotal in this-procedure. | |
Descrição | Percorre todas as vidas do componente, acumulando o valor percorrido por cada uma e atualizando este valor no valor percorrido total da carcaça do componente. | |
| Parâmetros | Descrição |
| Não contém | |
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. | | | | | |