Documento de API

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

Considerações Gerais

Objetivo

Listar e relacionar os processos do ECM a ação da campanha no CRM. Verificar e validar a parametrização referente a integração com o ECM.

Funcionamento

Na forma padrão, realiza-se a chamada por intermédio 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/apiCrmIntegrTarEcm.p.

A sintaxe para executar a API em modo persistente é:

run crmapi/apiCrmIntegrTarEcm.p persistent set h-handle.

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

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

returnParamPed
Requisito
Sintaxe
Descrição	Retorna os parâmetros de acesso ao ecm.
	Parâmetros	Descrição
	Pusername	Código do usuário
	Ppassword	Senha
	pcompanyId	Empresa
	puserId1	Usuário logado
Retorno	Out / Pusername Out / Ppassword Out / pcompanyId Out / puserId1

returnParamConfigEcm
Requisito
Sintaxe
Descrição	Retorna os parâmetros de acesso e conexão com o ECM .
	Parâmetros	Descrição
	PcWebService	servico desejado
	Pusername	Código do usuário
	Ppassword	Senha
	pcompanyId	Empresa
	puserId1	Usuário logado
	ppserver	Sevidor ecm
Retorno	Out / Pusername Out / Ppassword Out / pcompanyId Out / puserId1 Out / ppserver

returnParamEcm
Requisito
Sintaxe
Descrição	Verificar se integração com ECM está ativa.
	Parâmetros	Descrição
	plEcm	Integração com ECM ativa?
Retorno	Out / plEcm

relacionaWorkflow
Requisito
Sintaxe
Descrição	Relaciona o processo a ação da campanha.
	Parâmetros	Descrição
	numIdCampanhaAcao	Chave da ação da campanha
	plEncerra	Encerra tarefa?
	ttWorkFlowTemplate	Processo que será relacionado a ação da campanha
	RowErrors	Erros
Retorno	O método irá retornar os erros ocorridos durante a execução do método Out / RowErrors.

returnWorkflowTemplate
Requisito
Sintaxe
Descrição	Retornar os processos disponíveis para abrir um workflow.
	Parâmetros	Descrição
	iCurrentPage	pagina
	iPageSize	Registros por pagina
	iCampAcao	Id campanha
	pProcessId	Id do processo
	ttWorkFlowTemplate	Processos disponíveis
	RowErrors	Erros
	totalRecord	Total de registros
Retorno	O método irá retornar os processos disponíveis no ECM (ttWorkFlowTemplate) e se ocorreu algum erro durante a execução do método (RowErrors).

returnProcess
Requisito
Sintaxe
Descrição	Retornar os processos disponíveis para abrir um workflow filtrados conforme parametrização em tela.
	Parâmetros	Descrição
	iCurrentPage	pagina
	iPageSize	Registros por pagina
	iCampAcao	Id campanha
	pProcessId	Id do processo
	ttWorkFlowTemplate	Processos disponíveis
	RowErrors	Erros
	totalRecord	Total de registros
Retorno	O método irá retornar os processos disponíveis no ECM (ttWorkFlowTemplate) e se ocorreu algum erro durante a execução do método (RowErrors).

connectWebservice
Requisito
Sintaxe
Descrição	Conecta no web service e retorna os processos.
	Parâmetros	Descrição
	ttWorkFlowTemplate	Processos
	RowErrors	Erros
Retorno	O método irá retornar os processos disponíveis no ECM (ttWorkFlowTemplate), se ocorrer algum erro durante a execução do método (RowErrors).

returnLinkWorkflow
Requisito
Sintaxe
Descrição	Retorna a url para detalhar o workflow passado como parâmetro.
	Parâmetros	Descrição
	pNumIdTar	tarefa
	pcLink	url
Retorno	O método irá retornar a url para detalhar o workflow da tarefa.