Documento de API

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

Objetivo

Métodos para controle de dados na tela de Consulta de Histórico de Ações.

Tabelas Temporárias

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

montaQuery
Atributo	Tipo	Formato	Descrição	Obr.
tipo	Int		Tipo
operac	Char		Operação
Campo	Char		Campo
valor	Char		Valor
grupo	Int		Grupo

ttDgAcao
Atributo	Tipo	Formato	Descrição	Obr.
num_id	Int		Histórico de Ações
pessoa	Char		Conta
contato	Char		Contato
campanha	Char		Campanha
acao	Char		Ação
midia	Char		Mídia
resultado	Char		Resultado
detalhamento	Char		Detalhamento
usuarCad	Char		Usuário de Cadastro
dat_inic	Char		Data Início
dat_fim	Char		Data fim
hra_inic	Char		Hora Início
hra_fim	Char		Hora fim
tarefa	Char		Tarefa
oportun	Char		Oportunidade
Ocor	Char		Ocorrência
acumulRestdo	Char		Acumula Resultado
qtd_acumulRestdo	Int		Quantidade Resultado

ttDescAcao
Atributo	Tipo	Formato	Descrição	Obr.
num_id	Int		Código
descricao	Char		Descrição
conta	Int		Conta

ttChaveConta
Atributo	Tipo	Formato	Descrição	Obr.
numIdConta	Int

ttChaveCampanha
Atributo	Tipo	Formato	Descrição	Obr.
numIdCampanha	Int

ttChaveAcao
Atributo	Tipo	Formato	Descrição	Obr.
numIdAcao	Int

ttChaveResultado
Atributo	Tipo	Formato	Descrição	Obr.
numIdResult	Int

ttChaveMidia
Atributo	Tipo	Formato	Descrição	Obr.
numIdMidia	Int

ttChaveDetalhamento
Atributo	Tipo	Formato	Descrição	Obr.
numIdDetalhamento	Int

Métodos

Métodos básicos

Método: filtroAvancadoConsultaHistorAcao.

Descrição: Método para montagem do filtro avançado.

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
montaQuery	Temp-table		X			Contém informações de montagem de query.
ttDgAcao	Temp-table			X		Dados do grid de ação.
ttDescAcao	Temp-table			X		Descrição da Ação

Método: filtroBasicoConsultaAcao.

Descrição: Método para montagem do filtro básico.

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
Idx	Int		X			Id
c-desc	Char		X			Descrição
datInic	Date		X			Data Inicial
datFim	Date		X			Data Final
l-logAcumulRestdo	Log		X			Acumula Resultado ativado
ttDgAcao	Temp-table			X		Dados do grid de ação
ttDescAcao	Temp-table			X		Descrição da Ação

Método: cargaConsultaAcao.

Descrição: Popula temp-table de retorno da consulta.

Requisitos: nenhum.

Parâmetros: nenhum.

Método: populaHistoricoDeAcaoInicial.

Descrição: Popula temp-table com históricos de ação de uma conta já posicionada.

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-conta	Int		X			Código da conta
ttDgAcao	Temp-table			X		Dados do grid de ação
ttDescAcao	Temp-table			X		Descrição da Ação
ttChaveConta	Temp-table			X		Chaves da conta
ttChaveCampanha	Temp-table			X		Chaves da campanha

Método: populaHistoricoDeAcaoOcor.

Descrição: Popula histórico de ação de acordo com a ocorrência selecionada.

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-ocor	Int		X			Código da ocorrência
ttDgAcao	Temp-table			X		Dados do grid de ação
ttDescAcao	Temp-table			X		Descrição da Ação
ttChaveConta	Temp-table			X		Chaves da conta
ttChaveCampanha	Temp-table			X		Chaves da campanha

Método: carregaCampanhaDeAcordoComUsuario.

Descrição: Popula temp-table com as campanhas que o usuário tem acesso.

Requisitos: nenhum.

Parâmetros: nenhum.

Método: carregaContasDeAcordoComUsuario.

Descrição: Popula temp-table com as contas na qual o usuário tem acesso.

Requisitos: nenhum.

Parâmetros: nenhum.

Método: verificaContatosDaConta.

Descrição:

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-conta	Int		X			Código da conta
ttChaveContato	Temp-table			X		Chaves de contato

Método: verificaAcaoRelacaoCampanha.

Descrição: Popula temp-table com os contatos relacionados a conta selecionada.

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-campanha	Int		X			Código da campanha
ttChaveAcao	Temp-table			X		Chaves da ação

Método: verificaAcaoxResultadoeAcao_campanhaxMidia.

Descrição: Popula as temp-tables com os resultados e mídias que tem relação com a Acao da campanha selecionada

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-acao	Int		X			Código da ação
ttChaveResultado	Temp-table			X		Chaves do resultado
ttChaveMidia	Temp-table			X		Chaves da mídia

Método: verificaDetalhamentoRelacaoResultado.

Descrição: Popula temp-table com os detalhamentos que tem relação com os resultados selecionado.

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-result	Int		X			Código do resultado
ttChaveDetalhamento	Temp-table			X		Chaves do detalhamento

Método: populaHistoricoDeAcaoInicialPortlet.

Descrição: Popula temp-tables usadas no portlet de Histórico de Ação.

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
sqlWhere			X			Auxilia na montagem do comando SQL
i-conta			X			Código da conta
ttDgAcao				X		Dados do grid de ação
ttDescAcao				X		Descrição da Ação
ttChaveConta				X		Chaves da conta
ttChaveCampanha				X		Chaves da campanha

Método: returnConsTarHistorAcao.

Descrição: Recebe a tarefa como parâmetro, e retorna a lista de histórico de ação relacionados com a tarefa.

Requisitos: nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-tar			X			Código da tarefa
ttDgAcao				X		Dados do grid de ação
ttDescAcao				X		Descrição da Ação