Documento de API

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

Considerações Gerais

Objetivo

Remover processos do CRM. Esta include contém os métodos para deletar os registros referentes aos processos determinado em tela pelo usuário.

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

run crmapi/apiCrmRemoveProces.p

A sintaxe para executar a API/BO 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.

Tabelas Temporárias

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

ttContato					Entrada/Saída
Tabela temporária usada para armazenar os contatos que serão removidos do vínculo após confimada a exclusão da conta.					Saída
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
num_id	Int	99999999	Identificador do contato	Sim

removeProces
Requisito	Executar a API de forma persistente.
Sintaxe	removeProces in h-handle (input ianexo, input icamp, input ifacil, input iconta, input iacao, input iocor, input iopor, input ipub, input isegmt, input itar, input shQueryAnexo, input shQueryCamp, input shQueryFacilit, input shQueryConta, input shQueryHistAcao, input shQueryOcor, input shQueryOpor, input shQueryPublico, input shQuerySegmt, input shQueryTarefa, input ttAnexo, input ttcampanha, input ttPessoaFacil, input ttconta, input ttHistorAcao, input ttocor, input ttoportun, input ttpublico, input ttsegmtcao, input tttarefa, output RowErrors).
Descrição	Método usado para aplicar regra de negócio referente a exclusão dos processos.
	Parâmetros	Descrição
	iAnexo	Página (integer).
	iCamp	Qtd Registros por página (integer).
	iFacil	Filtro (integer).
	iConta	Processos considerados na busca (integer).
	iAcao	Temp table anexo.
	iOcor	Temp table campanha.
	iOport	Temp table pessoa fácil.
	iPub	Temp table contas.
	iSegmt	Temp table ação.
	iTar	Ttemp table ocorrências.
	shQueryAnexo	Temp table oportunidades.
	shQueryCamp	Temp table publico.
	shQueryFacilit	Temp table segmentação.
	shQueryConta	Temp table tarefas.
	shQueryHistAcao	Temp table de erros.
	shQueryOcor	Total registros anexo.
	shQueryOpor	Total registros campanha.
	shQueryPublico	Total registros facilitado.
	shQuerySegmt	Total registros contas.
	shQueryTarefa	Total registros hist ações.
	ttAnexo	Total registros Ocorrências.
	ttcampanha	Total registros Oportunidades.
	ttPessoaFacil	Ttotal registros públicos.
	ttconta	Total registros Segmentações.
	ttHistorAcao	Total registros tarefas.
	ttocor	Query anexo (character).
	ttoportun	Query campanha (character).
	ttpublico	Query pessoa fácil (character).
	ttsegmtcao	Query conta (character).
	tttarefa	Query ação (character).
	RowErrors	Query ocorrência (character).
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteAnexo
Requisito
Sintaxe	deleteAnexo in h-handle (input iAnexo, input shQueryAnexo, input table ttAnexo, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iAnexo	Anexo (integer).
	shQueryAnexo	Query anexo (character).
	ttAnexo	Temp table anexo.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteCampanha
Requisito	-
Sintaxe	deleteCampanha in h-handle (input iCamp, input shQueryCamp, input table ttcampanha, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iCamp	Campanha (integer).
	shQueryCamp	Query campanha (character).
	ttcampanha	Temp table campanha.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteFacilit
Requisito	-
Sintaxe	deleteFacilit in h-handle (input iFacil, input shQueryFacilit, input table ttPessoaFacil, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iFacil	Pessoa facil (integer).
	shQueryFacilit	Query pessoa fácil (character).
	ttPessoaFacil	Temp table pessoa fácil.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteConta
Requisito	-
Sintaxe	deleteConta in h-handle (input iConta, input shQueryConta, input table ttconta, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iConta	Conta (integer).
	shQueryConta	Query conta (character).
	ttconta	Temp table contas.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteHistAcao
Requisito	-
Sintaxe	deleteHistAcao in h-handle (input iAcao, input shQueryHistAcao, input table ttHistorAcao, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iAcao	Ação (integer).
	shQueryHistAcao	Query ação (character).
	ttHistorAcao	Temp table ação.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteOcor
Requisito	-
Sintaxe	deleteOcor in h-handle (input iOcor, input shQueryOcor, input table ttocor, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iOcor	Ocorrência (integer).
	shQueryOcor	Query ocorrência (character).
	ttocor	Temp table ocorrências.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deletePublico
Requisito	-
Sintaxe	deletePublico in h-handle (input iPub, input shQueryPublico, input table ttpublico, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iPub	Público (integer).
	shQueryPublico	Query publico (character).
	ttpublico	Temp table publico.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteSegmt
Requisito	-
Sintaxe	deleteSegmt in h-handle (input iSegmt, input shQuerySegmt, input table ttSegmtcao, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iSegmt	Segmentação (integer).
	shQuerySegmt	Query segmentação (character).
	ttsegmtcao	Temp table segmentação.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteTar
Requisito	-
Sintaxe	deleteTar in h-handle (input iTar, input shQueryTarefa, input table tttarefa, output table RowErrors).
Descrição	Validar quais registros serão deletados.
	Parâmetros	Descrição
	iTar	Tarefa (integer).
	shQueryTarefa	Query tarefa (character).
	tttarefa	Temp table tarefas.
	RowErrors	Temp table erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteRegistry
Requisito	-
Sintaxe	deleteRegistry in h-handle (input cQuery, input cTable, input iTipProces, input cdescricao).
Descrição	Remover o registro da base.
	Parâmetros	Descrição
	cQuery	query (character).
	cTable	tabela usada na query (character).
	iTipProces	tipo de processo (integer).
	Cdescricao	campo descrição da tabela (character).
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteRelationshipAction
Requisito	-
Sintaxe	deleteRelationshipAction in h-handle(input pNumid, output table RowErrors)
Descrição	Remover os registro relacionados ao histórico de ação.
	Parâmetros	Descrição
	pNumid	Código oportunidade (integer).
	RowErrors	Temp-table de erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteRelationshipOcor
Requisito	-
Sintaxe	deleteRelationshipOcor in h-handle(input pNumid, output table RowErrors).
Descrição	Remover os registro relacionados a ocorrência.
	Parâmetros	Descrição
	pNumid	Código ocorrência (integer).
	RowErrors	Temp-table de erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteRelationshipOcor
Requisito	-
Sintaxe	deleteRelationshipOcor in h-handle(input pNumid, output table RowErrors).
Descrição	Remover os registro relacionados a ocorrência.
	Parâmetros	Descrição
	pNumid	Código ocorrência (integer).
	RowErrors	Temp-table de erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

deleteRelationshipTask
Requisito	-
Sintaxe	deleteRelationshipTask in h-handle(input pNumid, output table RowErrors).
Descrição	Remover os registro relacionados a tarefa.
	Parâmetros	Descrição
	pNumid	Código tarefa (integer).
	RowErrors	Temp-table de erros.
Retorno	Os Erros serão tratados na temp-table RowErrors.

createLog
Requisito	-
Sintaxe	createLog in h-handle(input pIdiProces, input pDescricao).
Descrição	Adiciona no log de conversão o registro que foi removido, de acordo com o processo.
	Parâmetros	Descrição
	pIdiProces	Processo (integer).
	pDescricao	Descrição.
Retorno	Os Erros serão tratados na temp-table RowErrors.