Documento de API

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

Considerações Gerais

Objetivo

Remover processos do CRM. Esta Api contém todos os métodos para consultar e remover os processos do CRM.

Funcionamento

A API possibilita tratamento e validação da regra de negócio. 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/apiCrmRemoveProces.p

A sintaxe para executar a API em modo persistente é:

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

Método Negócio

filtroBasico
Requisito	Executar a API de forma persistente.
Sintaxe	filtroBasico in h-handle (input iCurrentPage, input iPageSize, input ttFiltro, input table ttProcesso, output table ttAnexo, output table ttcampanha, output table ttPessoaFacil, output table ttconta, output table ttHistorAcao, output table ttocor, output table ttoportun, output table ttpublico, output table ttsegmtcao, output table tttarefa, output table ttDescTarefas, output table RowErrors, output totalRecordAnexo, output totalRecordCamp, output totalRecordFacilit, output totalRecordConta, output totalRecordHistAcao, output totalRecordOcor, output totalRecordOportun, output totalRecordPublico, output totalRecordSegmt, output totalRecordTarefa, output shQueryAnexo, output shQueryCamp, output shQueryFacilit, output shQueryConta, output shQueryHistAcao, output shQueryOcor, output shQueryOpor, output shQuerySegmt, output shQueryPublico, output shQueryTarefa).
Descrição	Método usado para aplicar regra de negócio referente a consulta do processos, conforme filtro aplicado em tela.
	Parâmetros	Descrição
	iCurrentPage iPageSize	Página (integer).
	ttFiltro	Qtd Registros por página (integer).
	ttProcesso	Filtro (integer).
	ttAnexo	Processos considerados na busca (integer).
	ttcampanha	Temp table anexo.
	ttPessoaFacil	Temp table campanha.
	ttconta	Temp table pessoa fácil.
	ttHistorAcao	Temp table contas.
	ttocor	Temp table ação.
	ttoportun	Ttemp table ocorrências.
	ttpublico	Temp table oportunidades.
	ttsegmtcao	Temp table publico.
	tttarefa	Temp table segmentação.
	RowErrors	Temp table tarefas.
	totalRecordAnexo	Temp table de erros.
	totalRecordCamp	Total registros anexo.
	totalRecordFacilit	Total registros campanha.
	totalRecordConta	Total registros facilitado.
	totalRecordHistAcao	Total registros contas.
	totalRecordOcor	Total registros hist ações.
	totalRecordOportun	Total registros Ocorrências.
	totalRecordPublico	Total registros Oportunidades.
	totalRecordSegmt	Ttotal registros públicos.
	totalRecordTarefa	Total registros Segmentações.
	shQueryAnexo	Total registros tarefas.
	shQueryCamp	Query anexo (character).
	shQueryFacilit	Query campanha (character).
	shQueryConta	Query pessoa fácil (character).
	shQueryHistAcao	Query conta (character).
	shQueryOcor	Query ação (character).
	shQueryOpor	Query ocorrência (character).
	shQueryPublico	Query oportunidade (character).
	shQuerySegmt	Query publico (character).
	shQueryTarefa	Query segmentação (character).
Retorno	As temp-table referente a cada processo selecionado na pesquisa será populada com os dados apresentados na query. Os Erros serão tratados na temp-table RowErrors.

refreshProces
Requisito	Executar a API de forma persistente.
Sintaxe	refreshProces in h-handle (input iCurrentPage, input iPageSize, input lanexo, input lcamp, input lfacil, input lconta, input lacao, input locor, input loport, input lpub, input lsegmt, input ltar, input shQueryAnexo, input shQueryCamp, input shQueryFacilit, input shQueryConta, input shQueryHistAcao, input shQueryOcor, input shQueryOpor, input shQueryPublico, input shQuerySegmt, input shQueryTarefa, output ttAnexo, output ttcampanha, output ttPessoaFacil, output ttconta, output ttHistorAcao, output ttocor, output ttoportun, output ttpublico, output ttsegmtcao, output tttarefa, output ttDescTarefas, output RowErrors, output totalRecordAnexo, output totalRecordCamp, output totalRecordFacilit, output totalRecordConta, output totalRecordHistAcao, output totalRecordOcor, output totalRecordOportun, output totalRecordPublico, output totalRecordSegmt, output totalRecordTarefa).
Descrição	Método usado para aplicar regra de negócio referente a consulta do processos após execução do método de remoção dos processos, conforme filtro aplicado anteriormente.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	lanexo	Considera anexo?
	lcamp	Considera campanha?
	lfacil	Considera facilitado?
	lconta	Considera conta?
	lacao	Considera ação?
	locor	Considera ocorrência?
	loport	Considera oportunidade?
	lpub	Considera público?
	lsegmt	Considera segmentação?
	ltar	Considera Tarefa?
	shQueryAnexo	Query anexo (character).
	shQueryCamp	Query campanha (character).
	shQueryFacilit	Query pessoa fácil (character).
	shQueryConta	Query conta (character).
	shQueryHistAcao	Query ação (character).
	shQueryOcor	Query ocorrência (character).
	shQueryOpor	Query oportunidade (character).
	shQueryPublico	Query publico (character).
	shQuerySegmt	Query segmentação (character).
	shQueryTarefa	Query tarefa (character).
	ttAnexo	Temp table anexo.
	ttcampanha	Temp table campanha.
	ttPessoaFacil	Temp table pessoa fácil.
	ttconta	Temp table contas.
	ttHistorAcao	Temp table ação.
	ttocor	Temp table ocorrências.
	ttoportun	Temp table oportunidades.
	ttpublico	Temp table publico.
	ttsegmtcao	Temp table segmentação.
	tttarefa	Temp table tarefas.
	RowErrors	Temp table de erros.
	totalRecordAnexo	Total registros anexo.
	totalRecordCamp	Total registros campanha.
	totalRecordFacilit	Total registros facilitado.
	totalRecordConta	Total registros contas.
	totalRecordHistAcao	Total registros hist ações.
	totalRecordOcor	Total registros Ocorrências.
	totalRecordOportun	Total registros Oportunidades.
	totalRecordPublico	Total registros públicos.
	totalRecordSegmt	Total registros Segmentações.
	totalRecordTarefa	Total registros Segmentações.
Retorno	As temp-table referente a cada processo selecionado na pesquisa será populada com os dados apresentados na query. Os Erros serão tratados na temp-table RowErrors.

pageChangeAnexo
Requisito	-
Sintaxe	Run pageChangeAnexo in h-handle (input iCurrentPage,input iPageSize, input shQueryAnexo, output table ttAnexo, output table RowErrors, output totalRecord).
Descrição	Método utilizado para realizar a consulta dos dados através da paginação.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryAnexo	Query (character).
	ttAnexo	Temp table anexo.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangeCamp
Requisito	-
Sintaxe	Run pageChangeCamp in h-handle (input iCurrentPage, input iPageSize, input shQueryCamp, output table ttcampanha, output table RowErrors, output totalRecord).
Descrição	Método utilizado para realizar a consulta dos dados através da paginação.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryCamp	query (character).
	ttcampanha	Temp table campanha.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangeFacilit
Requisito	-
Sintaxe	Run pageChangeFacilit in h-handle (input iCurrentPage, input iPageSize, input shQueryFacilit, output table ttPessoaFacil, output table RowErrors, output totalRecord).
Descrição	Método utilizado para realizar a consulta dos dados através da paginação.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryFaciit	Query (character).
	ttPessoaFacil	Temp table facilitado.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangeConta
Requisito	-
Sintaxe	Run pageChangeConta in h-handle (input iCurrentPage, input iPageSize, input shQueryConta, output table ttconta, output table RowErrors, output totalRecord).
Descrição	Método utilizado para realizar a consulta dos dados através da paginação.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryConta	Query (character).
	ttconta	Temp table contas.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangeHistorAcao
Requisito	-
Sintaxe	Run pageChangeHistorAcao in h-handle (input iCurrentPage, input iPageSize, input shQueryHistAcao, output table ttHistorAcao, output table RowErrors, output totalRecord).
Descrição	Método utilizado para realizar a consulta dos dados através da paginação.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryHistAcao	Query (character).
	ttHistorAcao	Temp table histórico de ações.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangeOcor
Requisito	-
Sintaxe	Run pageChangeOcor in h-handle (input iCurrentPage, input iPageSize, input shQueryOcor, output table ttocor, output table RowErrors, output totalRecord).
Descrição	Método utilizado para realizar a consulta dos dados através da paginação.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryOcor	Query (character).
	ttocor	Temp table ocorrências.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangeOportun
Requisito	-
Sintaxe	Run pageChangeOportun in h-handle (input iCurrentPage, input iPageSize, input shQueryOpor, output table ttoportun, output table RowErrors, output totalRecord).
Descrição	Método utilizado para realizar a consulta dos dados através da paginação.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryOpor	Query (character).
	ttoportun	Temp table oportunidade.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangePublico
Requisito	-
Sintaxe	Run pageChangePublico in h-handle (input iCurrentPage, input iPageSize, input shQueryPublico, output table ttpublico, output table RowErrors, output totalRecord).
Descrição	Método utilizado para realizar a consulta dos dados através da paginação.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryPublico	Query (character).
	ttpublico	Temp table public.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangeSegmt
Requisito	-
Sintaxe	Run pageChangeSegmt in h-handle (input iCurrentPage, input iPageSize, input shQuerySegmt, output table ttsegmtacao, output table RowErrors, output totalRecord).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQuerySegmt	Query (character).
	ttsegmtacao	Temp table segmentação.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

pageChangeTarefa
Requisito	-
Sintaxe	Run pageChangeTarefa in h-handle (input iCurrentPage, input iPageSize, input shQueryTarefa, output table tttarefa, ouptup table ttDescTarefas, output table RowErrors, output totalRecord).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iCurrentPage	Página (integer).
	iPageSize	Qtd Registros por página (integer).
	shQueryTarefa	Query (character).
	tttarefas	Temp table tarefas.
	ttDescTarefa	Temp table descrição das tarefas.
	RowErrors	Temp table erros.
	totalRecord	Total de registros encontrados.
Retorno	Retorna o total de registros e dados da página atual. Os Erros serão tratados na temp-table RowErrors.

executeQuery
Requisito	-
Sintaxe	Run executeQuery in h-handle (input pTable, input pProcesso, input table ttFiltro, output query).
Descrição	Método utilizado a query passada como parametro.
	Parâmetros	Descrição
	pTable	Tabela.
	pQuery	Query.
	iCurrentPage	Página.
	iPageSize	Qtd registros por página.
	ttId	Registros encontradas.
	RowErrors	Retorno de erros.
	totalRecord	Qtd de registros encontrados.
Retorno	Retorna os dados do processo encontrado e o total de registros. Os Erros serão tratados na temp-table RowErrors.

createQuery
Requisito	-
Sintaxe	Run createQuery in h-handle (input pTable, input pProcesso, input table ttFiltro, output query).
Descrição	Método utilizado para montar a query de acordo com o filtro parametrizado para cada processo.
	Parâmetros	Descrição
	pTable	Tabela.
	pProcesso	Processo.
	ttFiltro	Filtro por processo.
	pQuery	Query.
Retorno	Retorna a query que deve ser executada para realizar a consulta dos dados. Os Erros serão tratados na temp-table RowErrors.

setBufTable
Requisito	-
Sintaxe	Run setBufTable in h-handle (input cTable, output hBuffer).
Descrição	Método utilizado para setar o buffer de acordo com a tabela ou temp-table passada como parâmetro.
	Parâmetros	Descrição
	cTable	Tabela.
	hBuffer	Buffer.
Retorno	Os Erros serão tratados na temp-table RowErrors.

loadDataAnexo
Requisito	-
Sintaxe	Run loadDataAnexo in h-handle (input table ttId, output table ttAnexo).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttAnexo	Anexos.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataCampanha
Requisito	-
Sintaxe	Run loadDataCampanha in h-handle (input table ttId, output table ttcampanha).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttcampanha	Campanhas.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataFacilit
Requisito	-
Sintaxe	Run loadDataFacilit in h-handle (input table ttId, output table ttPessoaFacil).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttPessoaFacil	Cadastro facilitado.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataConta
Requisito	-
Sintaxe	Run loadDataConta in h-handle (input table ttId, output table ttconta).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttconta	Conta.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataHistorAcao
Requisito	-
Sintaxe	Run loadDataHistorAcao in h-handle (input table ttId, output table ttHistorAcao).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttHistorAcao	Histórico de ação.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataOcor
Requisito	-
Sintaxe	Run loadDataOcor in h-handle (input table ttId, output table ttocor).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttocor	Ocorrências.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataOportun
Requisito	-
Sintaxe	Run loadDataOportun in h-handle (input table ttId, output table ttopor).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttopor	Oportunidades.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataSegmtcao
Requisito	-
Sintaxe	Run loadDataSegmtacao in h-handle (input table ttId, output table ttsegmtacao).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttsegmtacao	Segmentação.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataPublico
Requisito	-
Sintaxe	Run loadDataPublico in h-handle (input table ttId, output table ttpublico).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttpublico	Publico.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

loadDataTarefa
Requisito	-
Sintaxe	Run loadDataTarefa in h-handle (input table ttId, output table tttarefa, output table ttDescTarefas).
Descrição	Método utilizado para retornar o demais valores do registro encontrado na consulta aplicada.
	Parâmetros	Descrição
	ttId	Contem os códigos dos registros encontrados.
	ttpublico	Publico.
	ttDescTarefas	Descrição das tarefas.
Retorno	Retorna a temp-table como os demais valores populados. Os Erros serão tratados na temp-table RowErrors.

updateRegistry
Requisito	-
Sintaxe	Run updateRegistry in h-handle (input table ttId, output table tttarefa, output table ttDescTarefas).
Descrição	Método utilizado para atualização de registros,através de query dinâmica.
	Parâmetros	Descrição
	cQuery	Query.
	cTable	Tabela.
	campo	Campo.
	valor	Valor.
Retorno	Os Erros serão tratados na temp-table RowErrors.

destroyHandle
Requisito	-
Sintaxe	Run destroyHandle.
Descrição	Método utilizado para eliminar os handles da memória.
	Parâmetros	Descrição
	-	-
Retorno	-

Árvore de páginas

apiCrmRemoveProces - Regra de negócio com os métodos para remover processos do CRM

Documento de API

Considerações Gerais

Método Negócio