Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmapi/apiCrmIntegrTarEcm02.p |
Considerações Gerais
Objetivo
Adicionar um novo workflow no ECM pela integração com o CRM.
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/apiCrmIntegrTarEcm02.p. |
A sintaxe para executar a API em modo persistente é:
run crmapi/apiCrmIntegrTarEcm02.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:
RowErrors | Entrada/Saída | ||||
Tabela de Erros | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
ErrorSequence | Int |
| Sequência |
|
|
ErrorNumber | Int |
| Número |
|
|
ErrorDescription | Char |
| Descrição |
|
|
ErrorParameters | Char |
| Parâmetros |
|
|
ErrorType | Char |
| Tipo |
|
|
ErrorHelp | Char |
| Ajuda |
|
|
ErrorSubType | Char |
| Sub Tipo |
|
|
Método Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
returnParamStartProcess | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Popula as variáveis utilizadas como parâmetro para geração do workflow. | |
Parâmetros | Descrição | |
|
| |
Retorno |
|
returnValDescr | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Monta uma query dinâmica e retorna o valor do campo recebido como parâmetro. | |
Parâmetros | Descrição | |
ptable | Tabela principal | |
| pcValReg | Valor do registro |
| ptp | Tipo de dados |
| ptablef | Tabela referencia |
| pfk | Usuário logado |
| Pcmp | Campo para comparação com o valor |
| pcmpdesc | Campo que deseja retornar a descrição |
| pcDinamic | Query já montada(pendente implementação) |
| pcVal | Valor encontrado no campo que foi solicitado |
Retorno | Out/pcVal |
returnDataProcess | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Retorna o processo relacionado a ação da campanha utilizado ao registrar a tarefa. E monta o card data utilizado para gerar o novo workflow. | |
Parâmetros | Descrição | |
pNumId | Id tarefa | |
| ptable | Tabela |
| pCardDada | Card data |
| pProcessId | Id do processo |
Retorno | Out / pProcessId |
cardSegmtcaoDados | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Busca informações da conta para alimentar o card data. | |
Parâmetros | Descrição | |
pNumIdPessoa | Id conta | |
| pNumId | Id tarefa |
| pNumIdSegDados | Id grupo de informações |
Retorno |
|
executeQuery | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Metódo que executa a query dinâmica e posiciona no registro desejado | |
Parâmetros | Descrição | |
|
| |
Retorno |
|
startProcess | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Método principal para gerar o novo workflow para tarefa. | |
Parâmetros | Descrição | |
pNumIdTar | Id tarefa | |
| RowErrors | Erros |
Retorno |
|
connectWebservice | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Conecta no web service e gera o workflow no ECM. | |
Parâmetros | Descrição | |
RowErrors | Erros | |
Retorno | se ocorrer algum erro durante a execução do método (RowErrors). |