Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | abp/abapi011 |
Considerações Gerais
Objetivo
Fazer a integração entre o Frotas e o Patrimônio do EMS2 ou 5, fazendo a atualização do campo “Situação (cód-sit-eqpto)” e “Data da Situação(dat-situacao)” da tabela MAB-EQPTO.
Funcionamento
A API recebe como parâmetros o código da empresa, conta patrimonial, bem patrimonial e seqüência do bem patrimonial e o índice. De posse desses dados, é buscado na tabela mab-eqpto algum equipamento cadastrado naquele Bem.
Caso ele encontre um equipamento para aquele Bem, ela pesquisa na tabela mab-sit-eqpto o primeiro registro que tenha
Descrição(des-sit-eqpto) igual o parâmetro “situação”, se não encontrar é verificado a data passada por parâmetro, se a mesma for igual a “?”, pesquisa na tabela mab-sit-eqpto o primeiro registro que tenha Tipo(idi-tip) = 1, e se a data for diferente de “?”, pesquisa na tabela mab-sit-eqpto o primeiro registro que tenha Tipo(idi-tip) = 2.
Localizando o registro da tabela mab-sit-eqpto a tabela mab-eqpto é atualizada assim:
“mab-eqpto.cod-sit-eqpto = mab-sit-eqpto.cod-sit-eqpto”.
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/abapi011.p (input pi-ep-codigo, input pc-cod_cta_pat, input pi-bm-codigo, input pi-bm-indice, input pd-data, input pc-situacao, 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_dat_trans | Date | "99/99/9999" | Data Transação | Sim | 001 |
ttv_situacao | Char | "x(20)" | Situaçã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-situacao | ||
Requisito | Chamada pela pi-atualiza-eqpto. | |
Sintaxe | run inicializa-handle-situacao in this-procedure. | |
Descrição | Inicializa os handles utilizados na API para pesquisa na tabela mab-sit-eqpto. | |
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. |