Árvore de páginas


Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

cdp/cdapi024a.p

 

Objetivo              

Fazer a integração entre módulos de Manutenção e Patrimônio do EMS2 ou 5 recebendo os seguintes parâmetros:              

run cdp/cdapi024.p (input  table tt_trans_bem,               

                                output table RowErrors).                  


Funcionamento

A execução é feita somente na  forma persistente ...

A sintaxe para executar a BO em modo persistente é:

run cdp/cdapi024a.p persistent set h-handle.

 

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:

Tabela Temporária

Descrição

Entrada/Saída

tt_trans_bem

Temp-Table da  “mmv-ord-manut”.

Entrada

Atributo

Tipo

Formato

Descrição

Obrigatório

Evolução

ttv_num_empresa

int

999

Empresa

Sim  /  Key

001

ttv_cod_cta_pat

Char

X(18)

Conta Patrimonial

Não

001

ttv_num_bem_pat

Int

>>>>>>>>9

Bem Patrimonial

Não

001

ttv_num_seq_bem_pat

Int

>>>>9

Seqüência Bem

Não

001

ttv_dat_trans

date

99/99/9999

Data

Não

001

ttv_situacao

char

X(20)

Situação

Não

001

Tabela Temporária

Descrição

Entrada/Saída

RowErrors

Contém os erros ocorridos na BO.

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 for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

 

Método Básico

emptyRowErrors

Requisito

Nenhum

Sintaxe

run emptyRowErrors in h-handle.

Descrição

Limpa a temp-table de erros da API.

 

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.

getRowErrors

Requisito

Nenhum

Sintaxe

run getRowErrors in h-handle (output table RowErrors).

Descrição

Retorna os erros ocorridos na API.

 

Parâmetros

Descrição

 

RowErrors

Temp-Table de Erros da API

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.