Documento de API

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

Objetivo

Cadastrar novos templates e consultar dados dos templates gerados.

Tabelas Temporárias

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

tt-crm_ocor
Atributo	Tipo	Formato	Descrição	Obr.
num_id_tip_ocor	Int		Id do tipo da ocorrência
num_id_priorid_ocor	Int		Id da prioridade da ocorrência
num_id_orig	Int		Id da origem
num_id_classif	Int		Id da classificação
num_id_vers	Int		Id da versão

tt-crm_campanha
Atributo	Tipo	Formato	Descrição	Obr.
nom_campanha	Char		Nome campanha
num_id_tip_campanha	Int		Id do tipo de campanha
dsl_campanha	Char		Descrição

tt-crm_oportun_vda
Atributo	Tipo	Formato	Descrição	Obr.
num_id_pessoa	Int		Id da conta
num_id_usuar_respons	Int		Id do responsável
num_id_estrateg_vda	Int		Id da estratégia de venda
num_id_fase	Int		Id da fase
num_id_probab	Int		Id da probabilidade
dat_prev_fechto	Char		Data prevista fechamento
dat_fechto_oportun	Char		Data fechamento
num_id_moed	Int		Id da moeda
val_bgc	Int		Valor bgc
log_suspenso	Log		suspenso

tt-crm_text_histor_acao
Atributo	Tipo	Formato	Descrição	Obr.
num_id_histor_acao	Int		id do histórico de ação
dsl_histor_acao	Char		Descrição

tt-crm_tar
Atributo	Tipo	Formato	Descrição	Obr.
num_id_campanha	Int		Id da campanha
num_id_acao	Int		Id da ação
num_id_objetivo	Int		Id do objetivo
dsl_motivo	Char		Descrição

tt-crm_template

Tabela definida conforme tabela CRM_TEMPLATE, 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: createTemplate

Descrição: adiciona um novo template.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pc-apelido	CHAR		X			Apelido
pc-tipoTemplate	Int		X			Tipo do template
pc-numIdReg	Int		X			Id do registro
pc-retorno	Char			X		Retorno
pl-erro	Log			X		Erro

Método: getNumId

Descrição: retorna o identificador seqüencial do registro recém criado.

Requisitos: Nenhum

Observação: faz uso do comando current-value, não utilizar este método em abientes oracle,

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pc-tabela	CHAR		X			Tabela
pi-numId	Int			X		Id do registro

Método: loadCampaignTemplate

Descrição: retorna os dados da campanha a partir de um template.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pi-numIdTemplate	char		X			Id do template
tt-crm_campanha	Tt			X		Relação de dados da campanha

Método: loadOportunityTemplate

Descrição: retorna os dados da oportunidade a partir de um template.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pi-numIdTemplate	CHAR		X			Id do template
tt-crm_oportun_vda	Tt			X		Relação de dados da oportunidade

Método: loadOcorTemplate

Descrição: retorna os dados da ocorrência a partir de um template.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pc-numIdTemplate	CHAR		X			Id do template
tt-crm_ocor	Tt			X		Relação de dados da ocorrência

Método: loadActionTemplate

Descrição: retorna os dados da ação a partir de um template.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pi-numIdTemplate	CHAR		X			Id do template
tt-crm_histor_acao	Tt			X		Relação de dados do histórico de ação
tt-crm_text_histor_acao	Tt			X		Relação com a descrição do histórico

Método: loadTaskTemplate

Descrição: retorna os dados da tarefa a partir de um template.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pi-numIdTemplate	CHAR		X			Id do template
tt-crm_tar	Tt			X		Relação de dados da tarefa