Documento de API

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

Considerações Gerais

Objetivo

Verificar se existe alguma movimentação na conta durante um determinado período de tempo, para saber se ocorreu uma movimentação é analisado a data de alteração da conta e dos demais processos parametrizados e seus relacionamentos. A API também se encarregará de enviar notificações mediante ao resultado da monitoração e irá transferir as contas que não tiveram movimentação, caso esteja configurado para efetuar transferência.

Funcionamento

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 é:

run crmapi/apiCrmMonitorMovCta.p.

A sintaxe para executar a API em modo persistente é:

run crmapi/apiCrmMonitorMovCta.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.

Tabelas Temporárias

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

ttResult					Entrada/Saída
Controle de Monitoração					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
Seq	Int		Sequência
numIdResp	Int		Código responsável crm
UserResp	Char		Código responsável ems2
nomUsuarResp	Char		Nome responsável
emailUserResp	Char		E-mail responsável
numUserTransf	Int		Código usuário transferência crm
emailUsuarTransf	Char		e-mail usuário transferência
nomUsuarTransf	Char		Nome usuário transferência
numIdPessoa	Int		Código da conta crm
codPessoaErp	Char		Código da conta ems2
nomRazao	Char		Razão social
emailCta1	Char		e-mail 1 da conta
emailCta2	Char		e-mail 2 da conta
idiTipNotif	Int		Tipo de notificação
lMovmentCta	log		Transferir conta?

tttUserNotify					Entrada/Saída
Controle notificação					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
codUsuario	Char		Código usuário ems2	Sim
Email	Char		e-mail usuário	Sim
Nome	char		Nome usuário	Sim
codUsuario	Char		Código usuário ems2	Sim

ttEmailAux					Entrada/Saída
Auxiliar					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
numIdUser	Int		Código usuário crm	Sim
Email	char		e-mail	sim

ttError					Entrada/Saída
Erros					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
numIdPessoa	Int		Código conta crm	Sim
nomRazao	Char		Razão social	Sim
Erro	Char		Descrição erro	Sim
numIdResp	Int		Código responsável crm	Sim
codResp	char		Código responsável ems2	Sim

ttSearchReplace					Entrada/Saída
Controle layout					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
Num_id	Int		Sequência
Num_id_pessoa	Char		Código da conta crm
c-searchApel	Char		Apelido campo
c-searchField	Char		Campo
c-replace	Char		replace

ttEmailAcount					Entrada/Saída
Controle e-mail conta					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
Conta	int		Código conta crm	sim
Email	Char		e-mail	sim
html	char		Html	sim

ttTE					Entrada/Saída
Quebrar texto e-mail					Entrada/Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
Sequencia	Int		Sequência	sim
Texto	Char		Texto	Sim

Método Básico

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

returnParamDay
Requisito	Nenhum
Sintaxe
Descrição	Retorna a quantidade mínima de dias a ser considerado na monitoração.
	Parâmetros	Descrição
	iQtdMinDias	Quantidade mínima de dias
Retorno	iQtdMinDias

integrGpl
Requisito	Nenhum
Sintaxe
Descrição	Retorna se a integração com Gestão de Planos está ativa.
	Parâmetros	Descrição
	plIntegrGpl	Integração com GP ativa?
Retorno	plIntegrGpl

verifyMovCta
Requisito	Nenhum
Sintaxe
Descrição	Método principal com a lógica para verificar se teve ou não movimentação.
	Parâmetros	Descrição
	ttParamMonitorMovCta	Parametrização para validar a monitoração
	ttError	Erros gerado no processo de monitoração, notificação e transferência.
Retorno	ttError

integrGpl
Requisito	Nenhum
Sintaxe
Descrição	Retorna se a integração com Gestão de Planos está ativa.
	Parâmetros	Descrição
	plIntegrGpl	Integração com GP ativa?
Retorno	plIntegrGpl

sendNotif
Requisito	Nenhum
Sintaxe
Descrição	Este método contém a lógica referente ao envio de notificações e quais usuários receberam o e-mail.
	Parâmetros	Descrição
	Não contém
Retorno

transfProcess
Requisito	Nenhum
Sintaxe
Descrição	Caso haja necessidade esse método transfere a conta para um novo responsável.
	Parâmetros	Descrição
	ttError	erros
Retorno	ttError

SendCustom

Requisito

Nenhum

Sintaxe

Descrição

Método responsável em validar se há uma customização do cliente que deve ser incluída na regra, se houver considerar no momento da monitoração. Será efetuado uma verificação se existe o programa apiCustomMonitorMovCta.p, que conforme documentação esse fonte se existir deve estar disposto dentro da pasta crmesp no diretório raiz do CRM. Se for encontrada API apiCustomMonitorMovCta.r conforme já mencionado, então será chamado o método verifyCustom (esse é o método principal e obrigatório que deve estar contido dentro do fonte customizado pelo cliente). Será de responsabilidade do cliente criar essa api e manter a assinatura compatível com o que foi descrito na documentação, assim como a geração do binário. A assinatura do Método verifyCustom possuí os seguintes parâmetros:

Parâmetro	Tipo	Descrição	Entrada/Saída
pNumid	Integer	Id do registro de parametrização(crm_param_movimen_pessoa)	Entrada
ttUserNotify	Temp-table	Usuários notificação	Entrada
ttResult	Temp-table	Resultado da monitoração realizada pelo CRM.	Entrada/Saída
plAbortProces	Logical	Abortar processo de monitoração?	Saida
ttError	Temp-table	Erros ocasionados	Saída

Parâmetros

Descrição

plAbortProces

Abortar processo de monitoração?

ttError

Erros

Retorno

ttError

Árvore de páginas

apiCrmMonitorMovCta - Monitoração de contas

Documento de API

Considerações Gerais

Tabelas Temporárias

Método Básico