Documento de API

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

Objetivo

Alterar status da tarefa, consultar tarefas e também as campanhas, ações, contas e contatos relacionadas à tarefa.

Tabelas Temporárias

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

tt-consultTar
Atributo	Tipo	Formato	Descrição	Obr.
numId	Int		Id da tarefa
Conta	Char		Conta
Contato	Char		Contato
Campanha	Char		Campanha
Ação	Char		Ação

tt-HAcao
Atributo	Tipo	Formato	Descrição	Obr.
numId	Int		Id do histórico de ação
histAcao	Char		Descrição

ttDgTarefas
Atributo	Tipo	Formato	Descrição	Obr.
idi_status_tar	Char		Status da tarefa
dat_exec	Char		Data de execução
dat_cadastro	Char		Data de cadastro
dat_inic	Char		Data inicial
dat_fim	Char		Data final
hra_inic	Char		Hora inicial
hra_fim	Char		Hora final
Pessoa	Char		Conta
Contato	Char		contato
Campanha	Char		Campanha
Ação	Char		Ação
Objet	Char		Objetivo
usuarCad	Char		Usuário de cadastro
usuarRespons	Char		Usuário responsável
nom_public_alvo	Char		Publico alvo
num_id_tarefa_orig	Char		Tarefa origem
Oportun	Char		Oportunidade
Ocor	Char		Ocorrência
num_id_histor_acao	Char		Histórico de ação
num_id	Int		Id da tarefa

ttDescTarefas
Atributo	Tipo	Formato	Descrição	Obr.
numId	Int		Id da tarefa
Descrição	Char		Descrição

montaQuery
Atributo	Tipo	Formato	Descrição	Obr.
Tipo	Int		Tipo de dado
Operac	Char		Operação
Campo	Char		Campo
Valor	Char		Valor
Grupo	Char		Grupo

ttVetChaveTarefa
Atributo	Tipo	Formato	Descrição	Obr.
numId	Int		Id da tarefa

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

ttChaveContato
Atributo	Tipo	Formato	Descrição	Obr.
numIdContato	Int		Id do contato

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

ttTarefa

Tabela definida conforme tabela CRM_TAR, porém com as diferenças abaixo.

Atributo	Tipo	Formato	Descrição	Obr.

Parâmetros de input e output da api

Parâmetro	Tipo	Formato	I	O	IO	Descrição

Métodos

Métodos básicos

Método: filtroAvancadoConsultaTarefa

Descrição: Monta e executa query para filtro avançado do formulário de consulta de tarefa.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
montaQuery	Tt		X			Relação de dados da query
ttDgTarefas	Tt			X		Relação de tarefas filtradas
ttDescTarefas	Tt			X		Relação com a descrição das tarefas

Método: filtroBaiscoConsultaTarefa

Descrição: Método para tratamento do filtro simples do formulário de consulta de tarefa.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
Idx	Int		X			Opção de filtro
c-desc	Char		X			Descrição do filtro
datInic	Date		X			Data incial
datFim	Date		X			Data final
idxStatus	Int		X			Status
ttDgTarefas	Tt			X		Relação de tarefas filtradas
ttDescTarefas	Tt			X		Relação com a descrição das tarefas

Método: cargaConsultaTarefa

Descrição: efetua a carga de dados na temp-table de retorno de tarefas.

Requisitos: Nenhum

Parâmetros:Nenhum

Método: populaTarefasIniciaisECampanhasDoUsuario

Descrição: retorna uma temp-table com as tarefas de uma conta já posicionada.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
portletTasks	Char		X			Id da tarefa
i-conta	Int		X			Id da conta
ttDgTarefas	Tt			X		Relação de tarefas filtradas
ttDescTarefas	Tt			X		Relação com a descrição das tarefas
ttChaveCampanha	Tt			X		Relação de campanhas

Método: verificaAcessoCampanha

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

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
ttChaveCampanha	Tt			X		Relação de campanhas

Método: verificaContatosDaConta

Descrição: retorna uma temp-table com os contatos da conta selecionada.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-conta	Int		X			Id da conta
ttChaveContato	Tt			X		Relação de contatos

Método: verificaAcaoRelacaoCampanha

Descrição: retorna uma temp-table com as ações relacionadas a campanha selecionada.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-campanha	Int		X			Id da campanha
ttChaveAcao	Tt			X		Relação de ações

Método: verificaParamRegitraAcaoTarefa

Descrição: verifica se deve registrar uma ação ao finalizar a tarefa.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
l-paraRegistraAcao	Log			X		Registra ação

Método: executarTarefa

Descrição: altera o status de uma tarefa para executado.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-tarefa	Int		X			Id da tarefa
c-message	Char			X		mensagem

Método: verificaRegistraAcaoTar

Descrição: verifica se deve registrar uma ação ao finalizar a tarefa e finaliza a tarefa.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-tarefa	Log		X			Registra ação
c-status	Char			X		Status da tarefa

Método: buscaConsultTar

Descrição: consulta dados da tarefa para registrar a ação.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-consultTar	Int		X			Id da tarefa
tt-consultTar	Tt			X		Dados da tarefa

Método: returnConsTarHistorAcao

Descrição: verifica se deve registrar uma ação ao finalizar a tarefa e finaliza a tarefa.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-historicoAcao	Int		X			Id do histórico de ação
tt-HAcao	Tt			X		Relação de ações do historico

Árvore de páginas

apiCrmTarefaConsulta - Api utilizada para tratamento da regra de negócio do formulário de consulta de tarefa

Documento de API

Objetivo

Tabelas Temporárias

Parâmetros de input e output da api

Métodos