COAPI002 - Realiza o envio 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/coapi002

Objetivo

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

Funcionamento

A API realizará o envio 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).

Valida se a Ficha esta transferida.

Valida se existe componentes a serem transferidos.

Posiciona na ficha de transferência conforme paramente recebido.

Gera a gravação das informações na tabela “mco-transf-compon”, passando os componentes para enviados, caso ocorra erro desfaz toda transação.

A sintaxe para a chamada da API é:

run cop/coapi002.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

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

mostraErrors

Requisito	Procedure executada internamento pela própria api.
Sintaxe	run mostraErrors in this-procedure.
Descrição	Exibe os erros encontrados durante a execução 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.

Árvore de páginas