Documento de API

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

Objetivo

Verificações que envolvem a tela de registro de tarefa.

Tabelas Temporárias

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

ttCrmTar	[Descrição da tabela]
Atributo	Tipo	Formato	Descrição	Obr.
log_salva_template	Log
log_env_notif	Log
log_mult_tarefa	Log
dat_fim	Char
dat_inic	Char
dat_exec	Char
dsl_motivo	Char
hra_fim	Char
hra_inic	Char
hra_exec	Char
num_id	Char
num_id_pessoa	Char
num_id_acao	Char
num_id_campanha	Char
num_id_contat	Char
num_id_objet	Char
num_id_respons	Char
num_id_usuar	Char
num_id_oportun	Char
num_id_ocor	Char
num_id_histor_acao	Char

tt-campanha	[Descrição da tabela]
Atributo	Tipo	Formato	Descrição	Obr.
num_id	Int

tt-historAcao	[Descrição da tabela]
Atributo	Tipo	Formato	Descrição	Obr.
num_id_template	Int
log_salva_template	Log
num_id_pessoa	Int
num_id_contat	Int
num_id_campanha	Int
num_id_acao	Int
num_id_resultado	Int
num_id_detmnto	Int
num_id_mid	Int
lancar_despesas	Log
dat_inic	Date
dat_fim	Date
hra_inic	Char
hra_fim	Char
dsl_descricao	Char
dsl_procedimentos	Char
num_id_oportun	Int
num_id_ocor	Int
num_id_tar	Int
num_id_usuar_cad	Int
dat_cadastro	Date
dat_exec	Date
hra_cadastro	Char
hra_exec	Char

ttErro	[Descrição da tabela]
Atributo	Tipo	Formato	Descrição	Obr.
mensagem	Char

Métodos

Métodos básicos

Método: createTarefa.

Descrição: Cria a tarefa.

Requisitos: Nenhum.

Parâmetros:

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

Método: returnUser.

Descrição: Retorna o usuário da tarefa.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
c-num_id_usuar	Char			X

Método: returnBestHour.

Descrição: Retorna o melhor horário da conta selecionada.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdConta	Char		X
bestHour	Char			X

Método: contaDefaultConta.

Descrição: Retorna a conta padrão da campanha.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
g-numIdPessoa	Int		X
numIdContato	Char			X

Método: geraCampanhasUsuarioLogado.

Descrição: Retorna as campanhas que o usuário logado tem acesso.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
tt-campanha	tt			X
nenhumaCampanha	Log			X

Método: acaoDefault.

Descrição: Retorna a ação padrão da campanha.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char			X

Método: acaoObjetDefault.

Descrição: Retorna o objetivo padrão da campanha e ação passadas como parâmetro.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
numIdCampanha	Char		X
numIdAcao	Char		X
numIdObjet	Char			X

Método: buscaHistorAcao.

Descrição: Posiciona tarefa de acordo com o histórico de ação.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
i-historAcao	Int		X
tt-historAcao	tt			X

Método: verificaHoraErrada.

Descrição: Valida hora errada.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-hora	Char		X
p-retorno	Char			X

Método: verificaCalendarioComercial.

Descrição: Valida calendário comercial.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-data	Char		X
p-retorno	Char			X

Método: sugereDiaUtil.

Descrição: Sugere o dia útil para o calendário comercial.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
p-data	Char		X
p-datafim	Char		X
p-dataret	Char			X
p-datafimret	Char			X

Método: validaDataHora.

Descrição: Valida data e hora.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
dataInicial	Char		X
horaInicial	Char		X
dataFinal	Char		X
horaFinal	Char		X
formOrigem	Int		X
dataHoraProibida	Log			X
ttErro	tt			X

Método: verificaDataRetroativa.

Descrição: Verifica data retroativa.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
data	Char		X
retroativaProibida	Log			X

Método: getInfoForEmail.

Descrição: Notificação de e-mail.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
tarefa	Int		X
toEmail	Char			X
ccEmail	Char			X
txEmail	Char			X
abEmail	Char			X
idLayout	Char			X

Método: createTarefaAuxiliar.

Descrição: Cria uma tarefa auxiliar.

Requisitos: Nenhum.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
ttCrmTar	tt		X
numID	Int			X