ABAPI010 - Transferência do Bem pelo Patrimônio

Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	abp/abapi010

Considerações Gerais

Objetivo

Fazer a integração entre o Frotas e o Patrimônio do EMS2 ou 5, fazendo a transferência de estabelecimento do bem pelo Patrimônio.

Funcionamento

A API recebe como parâmetros o código do bem e o índice. De posse desses dados, é buscado na tabela mab-eqpto algum equipamento cadastrado naquele Bem. Caso não encontre, busca na tabela mco-compon algum componente que corresponda àquele Bem.

Caso ele encontre um equipamento para aquele Bem, ele cria um novo histórico para aquele equipamento (tabela mab-histor-ativid), copiando todos os valores do histórico anterior do mesmo e atualizando apenas os valores cod-estabel e dat-cadastro.

Caso ele encontre um componente para o Bem, ele cria um novo documento de movimentação do componente (tabela mco-movto-compon). Sendo que ele busca na DBO dessa tabela, através do método buscaDocumento, o código de documento que ele deverá gravar (num-docto), que é seqüencial. Para gravar no campo val-dat-hora-invrtda, ele se utiliza do método converteParaHoraInvertida que se encontra na mesma DBO, passando como parâmetros a dat-movto e a hra-movto.

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/abapi010.p (input p-bm-codigo,

input p-bm-indice,

input p-cod-estabel,

input p-data,

input p-hora,

output table RowErrors).

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:

tt_trans_bem					Entrada/Saída
Transferência de bens para integração entre o Frotas e o Patrimônio do EMS2 ou 5.					Entrada
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ttv_num_empresa	Integer	"999"	Codgo Empresa	Sim	001
ttv_cod_cta_pat	char	"x(18)"	Código Conta Patrimonial	Sim	001
ttv_num_bem_pat	Integer	">>>>>>>>9"	Numero bem patrimonial	Sim	001
ttv_num_seq_bem_pat	Integer	">>>>9"	Numero seqüência bem patrimonial	Sim	001
ttv_cod_estab	Char	"x(3)"	Código Estabelecimento	Sim	001
ttv_cod_ccusto	Char	"x(11)"	Código Centro de Custo	Sim	001
tta_cod_unid_negoc	Char	"x(3)"	Unidade Negócio	Sim	001
ttv_dat_trans	Date	"99/99/9999"	Data Transação	Sim	001
ttv_hra_trans	Char	"99:99:99"	Hora Transação	Sim	001

tt_row_errors					Entrada/Saída
Contém os erros ocorridos na API					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
ttv_num_seq_erro	Integer	">>>>,>>9"	Seqüência dos erros	Sim	001
ttv_num_erro	Integer	">>>>,>>9"	Número do erro	Sim	001
ttv_des_erro	Char	"x(50)"	Descrição do erro	Sim	001
ttv_des_param	Char	"x(50)"	Parâmetros passados para criar mensagem	Não	001
ttv_des_type	Char	"x(10)"	Tipo do erro: WARNING: Aviso ERROR: Erro	Sim	001
ttv_des_help	Char	"x(40)"	Texto de ajuda do erro	Sim	001
ttv_des_sub_type	Char	"x(40)"	Sub Tipo da mensagem de erro	Não	001

RowErrors					Entrada/Saída
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/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, buscando pelo código e índice do Bem o equipamento ou componente, e executa o método adequado conforme o bem encontrado.
	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 da transferência pelo Bem são especificados na temp-table RowErrors

Pi-inicializa-handle-compon
Requisito	Chamada pela pi-atualiza-compon.
Sintaxe	run inicializa-handle-compon in this-procedure.
Descrição	Inicializa os handles utilizados na API em caso de atualização de componente.
	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.

Pi-inicializa-handle-eqpto
Requisito	Chamada pela pi-atualiza-eqpto.
Sintaxe	run pi-inicializa-handle-eqpto in this-procedure.
Descrição	Inicializa os handles utilizados na API em caso de atualização de equipamento.
	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.

Pi-finaliza-handle-eqpto
Requisito	Chamada pela pi-atualiza-eqpto.
Sintaxe	run pi-finaliza-handle-eqpto in this-procedure.
Descrição	Finaliza os handles utilizados na API em caso de atualização de equipamento.
	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.

Pi-finaliza-handle-compon
Requisito	Chamada pela pi-atualiza-compon.
Sintaxe	run pi-finaliza-handle-compon in this-procedure.
Descrição	Finaliza os handles utilizados na API em caso de atualização de componente.
	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

Pi-inicializa
Requisito	Nenhum
Sintaxe	run pi-inicializa in this-procedure.
Descrição	Inicializa a API, buscando pelo código e índice do Bem o equipamento ou componente, e executa o método adequado conforme o bem encontrado.
	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.

Pi-atualiza-eqpto
Requisito	Deve ser chamada pela pi-Inicializa.
Sintaxe	run pi-atualiza-eqpto in this-procedure.
Descrição	Busca o equipamento relativo ao bem recebido e o último histórico da atividade relativa ao equipamento encontrado. Com base no histórico encontrado, cria um registro na temp-table tt-mab-histor-ativid com todos os dados do último histórico, apenas gravando o novo estabelecimento e data passada.
	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.

Pi-atualiza-compon
Requisito	Deve ser chamada pela pi-inicializa.
Sintaxe	run pi-atualiza-compon in this-procedure.
Descrição	Busca o componente relativo ao bem recebido. Com base no componente encontrado, cria um registro na temp-table tt-mco-movto-compon com os dados do registro do componente, gravando o novo estabelecimento, data e hora passados.
	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.

Árvore de páginas