COAPI005 - Realizar a visualização de arquivos (imagens e documentos).

Documento de API

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

Objetivo

A API realiza a visualização de arquivos (imagens e documentos).

Funcionamento

A API realiza a visualização de arquivos (imagens e documentos).

Quando é executa através da ação relacionada de um crud receberá como parâmetro “zparam”, que por sua vez armazena o código do catálogo, código arquivo, descrição do arquivo e numero de registros selecionados.

Se o numero de registro for diferente de 1 será emitido uma mensagem de alerta.

Valida se o documento poderá ser visualizado pelo webdesk, caso contrário será executado o programa “btb/btb915za.p” que por sua vez executará a visualização de acordo com a extensão do arquivo.

A sintaxe para a chamada da API é:

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

Não se aplica.

Métodos

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

Método Básico

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

Método Negócio

piValidaDocumento

Requisito	Procedure para uso interno.
Sintaxe	run piValidaDocumento in this-procedure.
Descrição	Realiza a validade do arquivo, se o mesmo pode ou não ser aberto pelo webdesk.
	Parâmetros	Descrição
	Não Contem
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.

piVisualizaDocto

Requisito	Procedimento chamado internamente pela procedure “piValidaDocumento”.
Sintaxe	run piValidaDocumento in this-procedure.
Descrição	Realiza a execução do programa “btb/btb915za.p” que por sua vez executará a visualização de acordo com a extensão do arquivo. recebidos.
	Parâmetros	Descrição
	Não Contem	Código do arquivo
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