COAPI003 - Realiza o recebimento dos componentes existentes em uma ficha de transferência de componentes em lote.

Documento de API

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

Objetivo

A API realiza o recebimento dos componentes existentes em uma ficha de transferência de componentes em lote.

Funcionamento

A API realizará o recebimento dos componentes existentes em uma ficha de transferência de componentes em lote.

Quando é executa através da ação relacionada de um crud receberá como parâmetro “zparam”, que por sua vez armazena o numero do documento (Código da Ficha), data recebimento, hora recebimento e tipo de recebimento.

Valida se os componentes da Ficha já foram recebidos.

Se já recebido mostra mensagem que já tenha sido recebido, caso contrário realizar o recebimento através da procedure “piReceber”.

A sintaxe para a chamada da API é:

run cop/coapi003.p.

A execução na forma persistente não existe para esta API, pois ela é chamada em uma ação relacionada de um crud do Metadados .

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

Tabela Temporária	Descrição	Entrada/Saída
RowErrors	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

Tabela Temporária

Descrição

Entrada/Saída

ttMcoTransf

Temp-table de uso interno. Segue sua definição:

DEFINE TEMP-TABLE ttMcoTransf NO-UNDO LIKE mco-transf

FIELD r-rowid AS ROWID.

Tabela Temporária	Descrição	Entrada/Saída
ttMcoTransfCompon	Temp-table de uso interno. Segue sua definição: DEFINE TEMP-TABLE ttMcoTransfCompon NO-UNDO LIKE mco-transf-compon FIELD r-rowid AS ROWID.
Tabela Temporária	Descrição	Entrada/Saída
ttMcoCompon	Temp-table de uso interno. Segue sua definição: DEFINE TEMP-TABLE ttMcoCompon NO-UNDO LIKE mco-compon FIELD r-rowid AS ROWID.

Métodos

Como a API não é rodada persistente, não existem métodos disponíveis para execução.

Método Básico

piCriaErro

Requisito	Nenhum
Sintaxe	run piCriaErro in this-procedure (input <integer>, input <character>, input <character>).
Descrição	Cria os erros ocorridos dentro da API.
	Parâmetros	Descrição
	pErrorNumber	Número do erro do EMS.
	pErrorType	Tipo de Erro (EMS, sistema, Progress).
	pErrorParameters	Parâmetros passados as mensagens EMS.
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

piExecutaRecebimento

Requisito	Nenhum
Sintaxe	run piExecutaRecebimento in h-handle (input <character>, output <temp-table>).
Descrição	Realiza as devidas validações para realizar o recebimento através da procedure “piReceber”.
	Parâmetros	Descrição
	zParams	String contendo as seguintes informações: numero do documento, data recebimento, hora recebimento e tipo recebimento.
	RowErrors	Temp-table com os erros de gravação. (Ver definição de Temp-table no início desse documento)
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.

piReceber

Requisito	Procedimento chamado internamente pela procedure “piExecutaRecebimento”.
Sintaxe	run piReceber in h-handle (input <date>, input <character>).
Descrição	Realiza a gravação dos componentes recebidos.
	Parâmetros	Descrição
	dDataRecebimento	Data de Recebimento
	cHora	Hora do recebimento
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.

initializeHandle

Requisito	Procedimento chamado internamente pela procedure “piReceber”.
Sintaxe	run initializeHandle in this-procedure.
Descrição	Inicializa os handles utilizados na API
	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

destroyHandle

Requisito	Procedimento chamado internamente pela procedure “piReceber”.
Sintaxe	run destroyHandle in this-procedure.
Descrição	Elimina os handles utilizados na API
	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

getHora:

Requisito	Nenhum
Sintaxe	run mostraErrors in h-handle (output <character>).
Descrição	Retorna a hora atual com o formato "HHMMAA”.
	Parâmetros	Descrição
	cHora	Valor da hora atual
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