Árvore de páginas


Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 abp/abapi012

 

Considerações Gerais

 

Objetivo

Fazer a alteração em todas as tabelas de abastecimento do código do motorista, que anteriormente somente era o código do motorista, passando agora para Empresa do Motorista, Estabelecimento do Motorista e Código da Matrícula.

 

Funcionamento

A API recebe como parâmetros (1) uma flag que indica se o registro que está sendo atualizado é de um funcionário ou um motorista, (2) o código da empresa do funcionário/motorista em questão, (3) o código do estabelecimento do funcionário/motorista e (4) o código da matrícula do funcionário/motorista. De posse desses dados, o programa verifica se o registro que está sendo atualizado é de um funcionário ou motorista para então executar a procedure determinada para tal.

 

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se os parâmetros com as informações necessárias.

 

A sintaxe para a chamada da API é:

run abp/abapi012.p (input  pFlag,

                    input  pEpCodigoMatr,

                    input  pCodEstabelMatr,

                    input  pCodMatr).

Parâmetros

 

pFlag = Recebe o número {1} para Motorista ou {2} para atualização de Funcionário.

 

pEpCodigoMatr = Recebe o código da Empresa do Motorista/Funcionário.

 

pCodEstabelMatr = Recebe o código do Estabelecimento do  Motorista/Funcionário.

 

pCodMatr = Recebe o código da matrícula do  Motorista/Funcionário.

 

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:

 

Entrada/Saída

Não existem temp-tables para essa API.

 

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

 

 

 

 

 

 

 

Métodos

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

 

Método Básico

 

Pi-inicializa

Requisito

Chamada pelo main block.

Sintaxe

run pi-inicializa in this-procedure.

Descrição

Inicializa a API, verificando se o registro a ser atualizado é o do Funcionário ou Motorista..

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).

piAtualizaFuncionario

Requisito

Chamada pela pi-inicializa.

Sintaxe

run piAtualizaFuncionario in this-procedure.

Descrição

Busca na tabela mpn-movto-pneu todos os movimentos que tenham o código da empresa e o código do motorista, atualizando assim o código do estabelecimento.

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).

piAtualizaMotorista

Requisito

Chamada pela pi-inicializa.

Sintaxe

run piAtualizaMotorista in this-procedure.

Descrição

Busca nas tabelas: mab-motoris-model, mab-abastec-lubrific, mab-movto-event, mab-reserva, mab-viagem e mnd-movto-infracao buscando os registros que tenham o mesmo código da matrícula do funcionário/motorista e atualizando o código da empresa e do estabelecimento.

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).