Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | crmapi/apiCrmParamTransfClas.p |
Considerações Gerais
Objetivo
Gerenciar a transferência de classificação dos clientes, afim de garantir que os esses clientes estejam classificados conforme sua relevância para a empresa, tendo como base as regras parametrizadas.
Funcionamento
A API/BO...
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/apiCrmParamTransfClas.p.
|
A execução na forma persistente ...
A sintaxe para executar a API/BO em modo persistente é:
run crmapi/apiCrmParamTransfClas.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:
ttCrmHistorAcao | Entrada/Saída | ||||
Histórico de Ação | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
num_id_template | char |
| Id template |
|
|
log_salva_template | log |
| Salvar template? |
|
|
num_id_pessoa | char |
| Id conta CRM |
|
|
num_id_contat | Char |
| Id Contato |
|
|
num_id_campanha | Char |
| Id Campanha |
|
|
num_id_acao | char |
| Id Ação |
|
|
num_id_resultado | Char |
| Id Resultado |
|
|
num_id_detmnto | Char |
| Id detalhamento |
|
|
num_id_mid | char |
| Id Midia |
|
|
lancar_despesas | log |
| Lançar despesas? |
|
|
dat_inic | Char |
| Data Inicial |
|
|
dat_fim | Char |
| Data final |
|
|
hra_inic | Char |
| Hora inicial |
|
|
hra_fim | char |
| Hora final |
|
|
dsl_descricao | char |
| descrição |
|
|
dsl_procedimentos | Char |
| procedimentos |
|
|
num_id_oportun | Char |
| Id oportunidades |
|
|
num_id_ocor | Char |
| Id ocorrência |
|
|
num_id_tar | Char |
| Id tarefa |
|
|
num_id_usuar_cad | Char |
| Id usuário cadastro |
|
|
dat_cadastro | Char |
| Data cadastro |
|
|
dat_exec | Char |
| Data execução |
|
|
hra_cadastro | Char |
| Hora cadastro |
|
|
hra_exec | Char |
| Hora execução |
|
|
idi_outlook_type | int |
| Tipo e-mail outlook |
|
|
ttValPed | Entrada/Saída | ||||
Auxiliar pedido | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
valPed | Dec |
| Valor pedido |
|
|
codMo | Int |
| Moeda |
|
|
codEmit | Char |
| Conta |
|
|
pedVend | Char |
| Pedido de venda |
|
|
nomAbrev | char |
| Nome abreviado |
|
|
ttErro | Entrada/Saída | ||||
Erros | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
codigo | Int |
| Código erro | Sim |
|
msg | Char |
| descrição | Sim |
|
ttTextoHistAcao | Entrada/Saída | ||||
Quebrar texto em 4000 caracteres por registro | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
texto | Char |
| texto | Sim |
|
sequencia | int |
| Sequência | sim |
|
ttHistAcumul | Entrada/Saída | ||||
Acumula Histórico de Ação | Entrada/Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução |
numIdHistorAcao | int |
| Id histórico de Ação | sim |
|
qtdRepet | int |
| Quantidade repete | sim |
|
numIdCta | int |
| Id conta | sim |
|
Método Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
sendErros | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Enviar erros para central de documentos | |
Parâmetros | Descrição | |
pcArquivo | Arquivo | |
Retorno |
| |
searchParamTransClas | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Retorna os valores parametrizados da campanha, ação e resultado para transferência de classe | |
Parâmetros | Descrição | |
iCamp | Id campanha | |
| iAcao | Id ação |
| iRestdo | Id resultado |
Retorno | iCamp | |
| iCamp iRestdo | |
sendParam | ||||||||||||||||||||||||||||||||||||||||||
Requisito |
| |||||||||||||||||||||||||||||||||||||||||
Sintaxe |
| |||||||||||||||||||||||||||||||||||||||||
Descrição | Método principal com a lógica para verificar se deve ser efetuada a transferência de classe do cliente, caso a validação obtenha um resultado positivo indicando que a conta atende as condições para subir de classificação então esse método também se encarregará de trocar a classe do cliente. Será efetuado uma verificação se existe o programa apicrmtransfclas.p, que conforme documentação esse fonte se existir deve estar disposto dentro da pasta crmesp no diretório raiz do CRM. Se o parâmetro(LOG_BO_TRANS_CLAS) que indica que deve ser considerado o programa específico do cliente na regra de validação estiver ativo, então será rodado de forma persistente a api apicrmtransfclas.r para o método verifyCustom desta mesma api que irá tratar a regra de transição de classe da forma customizada pelo cliente. Para o método verifyCustom a assinatura do método deve ser a seguinte:
| |||||||||||||||||||||||||||||||||||||||||
Parâmetros | Descrição | |||||||||||||||||||||||||||||||||||||||||
iValueConta | Id conta | |||||||||||||||||||||||||||||||||||||||||
| iValuePublico | Id público | ||||||||||||||||||||||||||||||||||||||||
| plValueTodos | Considerar todas as contas? | ||||||||||||||||||||||||||||||||||||||||
Retorno |
| |||||||||||||||||||||||||||||||||||||||||
VerifyResultClassTransition | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Validação para transição de classe efetuada com base nos históricos de ação da conta | |
Parâmetros | Descrição | |
pIdPessoa | Id conta | |
| dtParam | Data chave a ser considerada na regra de transição |
| pIdCamp | Id campanha |
| pIdAcao | Id acao |
| pIdResult | Id resultado |
| qtdResult | Quantidade resultado |
| plTransferir | Transferir de classe? |
Retorno | plTransferir | |
verifyClass | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Verificar se a regra de transferência é por pedido faturado, cadastrado ou registro de ação. Dependendo do tipo parametrizado será efetuada as devidas validações pertinentes a regra cadastrada. | |
Parâmetros | Descrição | |
numIdPessoa | Id conta CRM | |
| codEmitente | Id Conta EMS2 |
| idClas | Id Classificação |
| ttErro | erros |
Retorno | ttErro | |
FindSalesOrders | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Busca todos os pedidos do cliente, calcula e retorna o total. | |
Parâmetros | Descrição | |
cQuery | Query | |
| totalPedido | Total pedido do cliente |
Retorno | totalPedido | |
calculateTotalSalesOrders | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Método auxiliar para calcular o valor total de pedidos do cliente | |
Parâmetros | Descrição | |
ttValPed | Todos os pedidos do cliente | |
| Vtotal | Valor total dos pedidos |
Retorno | Vtotal | |
updateValueForPrice | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Método utilizado para converter o valor total para moeda corrente | |
Parâmetros | Descrição | |
pdVal | Valor total a ser convertido | |
| piMoedaPedVda | Moeda para considerar na conversão |
Retorno | pdVal (Entrada/Saída) | |
returnCurrency | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Retorna a moeda default | |
Parâmetros | Descrição | |
moCodigo | Moeda default | |
| idMoedCrm | Moeda (Não utilizado) |
Retorno | moCodigo idMoedCrm | |
UpdateClassClien | ||
Requisito |
| |
Sintaxe |
| |
Descrição | Método responsável por fazer a troca da classificação do cliente. | |
Parâmetros | Descrição | |
idClien | Id cliente | |
| idProxClass | Id próxima classe |
| idClassAtual | Id classe atual |
| idiTipGatilh | Tipo de gatilho |
| dValGatilho | Valor do gatilho |
Retorno |
| |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas