Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	crmapi/apiCrmExecRelatorio.p

Considerações Gerais

Objetivo

A API tem por objetivo montar a tela de acordo com os parâmetros criados e posteriormente criar a URL para executar o relatório Birt.

Funcionamento

A API/BO...

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para a chamada da API/BO é:

RUN crmapi/apiCrmExecRelatorio.p.

A execução na forma persistente ...

A sintaxe para executar a API/BO em modo persistente é:

RUN crmapi/apiCrmExecRelatorio.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.

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

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

piInitial
Requisito
Sintaxe
Descrição	Primeiro método chamado ao abrir o freeform. Caso tenha parâmetros no relatório, o método os retorna. Caso não tenho parâmetro, o método retorna a URL para abrir o relatório sem filtros.
	Parâmetros	Descrição
	numIdRelatCrm	Código do relatório selecionado
	ttCampos	Campos preenchidos
Retorno	Out / cUrl / Url Out / lSemPermissao / Usuário sem permissão para acessar o relatório Out / iBirtHeight / Altura da janela a ser aberta Out / iBirtWidth / Largura da janela a ser aberta

piExecRelat
Requisito
Sintaxe
Descrição	Método que retorna a URL montada de acordo com o que foi parametrizado no freeform.
	Parâmetros	Descrição
	numIdRelatCrm	Código do relatório selecionado
	cLabelCampo1	Label do campo 1
	cTextCampo1	Texto do campo 1
	cDzCampo1	Zoom do campo 1
	cLabelCampo2	Label do campo 2
	cTextCampo2	Texto do campo 2
	cDzCampo2	Zoom do campo 2
	cLabelCampo3	Label do campo 3
	cTextCampo3	Texto do campo 3
	cDzCampo3	Zoom do campo 3
	cLabelCampo4	Label do campo 4
	cTextCampo4	Texto do campo 4
	cDzCampo4	Zoom do campo 4
	cLabelCampo5	Label do campo 5
	cTextCampo5	Texto do campo 5
	cDzCampo5	Zoom do campo 5
Retorno	Out / cUrl / Usuário sem permissão para acessar o relatório Out / iBirtHeight / Altura da janela a ser aberta Out / iBirtWidth / Largura da janela a ser aberta

piInicializacao
Requisito
Sintaxe
Descrição	Método que concatena o nome do parâmetro com o valor parametrizado, para posteriormente formar a URL.
	Parâmetros	Descrição
	numIdRelatCrm	Código do relatório selecionado
	cLabelCampo	Label do parâmetro
	cTextCampo	Texto do parâmetro
	cDzCampo	Valor do zoom
Retorno	Out / cParam/ Parâmetro concatenado

piMontarUrl
Requisito
Sintaxe
Descrição	Método responsável por efetivamente montar a URL, de acordo com os parâmetros.
	Parâmetros	Descrição
	numIdRelatCrm	Código do relatório selecionado
	lParam	Identifica se o relatório possui parâmetros
	cParam1	Valor do parâmetro 1
	cParam2	Valor do parâmetro 2
	cParam3	Valor do parâmetro 3
	cParam4	Valor do parâmetro 4
	cParam5	Valor do parâmetro 5
Retorno	Out / cUrl / Usuário sem permissão para acessar o relatório Out / iBirtHeight / Altura da janela a ser aberta Out / iBirtWidth / Largura da janela a ser aberta

piVerificarPermissaoUsuario
Requisito
Sintaxe
Descrição	Retorna se o usuário tem ou não permissão para executar o relatório em questão
	Parâmetros	Descrição
	numIdRelatCrm	Código do relatório selecionado
Retorno	Out / lSemPermissao / Retorna se o usuário tem ou não permissão para executar o relatório em questão.

setConstraintFaixaEquipamento
Requisito
Sintaxe
Descrição	Retorna o usuário logado.
	Parâmetros	Descrição

Retorno	Out / iNumIdUsuario / Usuário logado

piCaminhos
Requisito
Sintaxe
Descrição	Retorna os valores que foram parametrizados para o relatório nos parâmetros do CRM
	Parâmetros	Descrição
	plEcm	Integração com ECM ativa?
Retorno	Out / cBirtUrl / Local de execução do BIRT viewer. Exemplo: http://localhost:8080/birt Out / cBirtCrm / Local de execução dos relatórios BIRT viewer. Exemplo: crm/report Out / cBirtDatabase / Identifica o tipo de banco que será usado (Progress, Oracle ou SQL Server) Out / cBirtDatabaseDate / Formato de data Out / cBirtHeight / Altura da janela a ser aberta Out / cBirtWidth / Largura da janela a ser aberta Out / lErro / Retorna caso algum campo chave não esteja preenchido