Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmapi\apiCrmCalculoPrfv.p |
Objetivo
Calcular o PRFV com base na parametrização informada.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttPotencdCli |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
num_id_pessoa | Int |
| Id da pessoa |
| |
qti_potencd | Int |
| Quantidade considerada para calcular a pontencialidade |
| |
val_potenc | Int |
| Valor potencialidade de1 a100 |
| |
percent_potencd | Int |
| Percentual considerado no calculo |
| |
num_id_grup_prfv | Int |
| Separa em grupos |
|
ttRecencCli |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
num_id_pessoa | Int |
| Id da pessoa |
| |
dt_recenc | Date | 99/99/9999 | Data rencencia |
| |
val_recenc | Int |
| Valor da recencia de1 a100 |
| |
percent_recenc | Int |
| Percentual considerado no calculo |
| |
num_id_grup_prfv | Int |
| Separa em grupos |
|
ttFreqCli |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
num_id_pessoa | Int |
| Id da pessoa |
| |
qtd_freq | Int |
| Quantidade considerada para calcular a frequencia |
| |
val_freq | Int |
| Valor da frequência de1 a100 |
| |
percent_freq | Int |
| Percentual considerado no calculo |
| |
num_id_grup_prfv | Int |
| Separa em grupos |
| |
dt_compra | Date |
| Data a ser considerada para primeira compra |
|
ttValCompCli |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
num_id_pessoa | Int |
| Id da pessoa |
| |
val_max_comp | dec |
| Valor maior compra |
| |
val_comp | dec |
| Valor de1 a100 |
| |
percent_valor | Int |
| Percentual considerado no calculo |
| |
num_id_grup_prfv | Int |
| Separa em grupos |
|
ttFreqRange |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
val_freq | Int |
| Valor freqüência |
| |
dt_inic | Date |
| Data inicial |
| |
dt_fim | Date |
| Data final |
| |
tip_per | Int |
| Tipo do periodo |
|
ttStatusPedid |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
idi_status | Int |
| Status pedido 1 - aberto, 2 - atendido parcial, 3 - atendido total, #4 - pendente#, 5 - suspenso, 6 - cancelado |
|
ttBuffers |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
Tabela | Char |
| Tabela |
| |
Campo | Char |
| campo |
|
ttBuffers2 |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
Tabela | Char |
| Tabela |
| |
Campo | Char |
| campo |
|
ttFormPrfv |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
seq | Int |
| sequencia |
| |
Campo | Char |
| campo |
|
tt-bo-erro |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
Sequen | Int |
| Seqüência |
| |
Erro | Char |
| Erro |
| |
Mensagem | Char |
| Mensagem |
| |
parametros | Char |
| Parâmetros |
| |
Errortype | Char |
| Tipo de erro |
| |
Errorhelp | Char |
| Help |
| |
Errorsubtype | Char |
| Subtipo do erro |
|
ttResultQuery |
| ||||
Atributo | Tipo | Formato | Descrição | Obr. | |
num_id_grupo_registro | Int |
| Separa em grupo |
| |
num_id | Int |
| Id do cliente |
| |
num_id_tip_clienAS | Int |
| Id do tipo de cliente |
| |
num_id_ramo_ativid | Int |
| Id do ramo de atividade |
| |
num_id_grp_clien | Int |
| Id do grupo de cliente |
| |
num_id_classif | Int |
| Id da classificação do cliene |
| |
num_id_pais | Int |
| Id do País |
| |
nom_canal_vda | Char |
| Canal de venda |
| |
idi_tip_pessoa | Int |
| Tipo de pessoa |
| |
num_id_regiao | Int |
| Id da região |
| |
num_id_repres | Int |
| Id do representante |
| |
num_id_unid_fererac | Int |
| Id da UF |
| |
num_id_grupo_prfv | Int |
| Id do grupo |
| |
log_Pertenc_public | Log |
| Não utilizado |
|
A api faz uso da include padrão {method/dbotterr.i}
A api faz uso da include {crmbo/boCrmPrfvFaixa.i ttCrmPrfvFaixa} que contém a definição de campos idêntica a tabela crm_prfv_faixa, a definição da temp-table poder ser encontrada no manual técnico da boCrmPrfvFaixa (RowObject).
Métodos
Métodos básicos
Método: CalcPrfv
Descrição: método principal para calculo do PRFV.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
num_id_prfv | Int |
| x |
|
| Id do parametrização do prfv |
tt-bo-erro | Tt |
|
| X |
| Erros relacionados ao calculo |
Método: destroyHandle
Descrição: elimina os handles.
Requisitos: Nenhum
Parâmetros: Nenhum
Método: CreateTtFreqRangeFortnight
Descrição: Calcula intervalo quinzenal.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
dt-inic | Date |
| x |
|
| Data inicial |
Método: exeCalcPrfv
Descrição: Executa o calculo prfv.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
num_id_prfv | Int |
| x |
|
| Id do parametrização do prfv |
tt-bo-erro | Tt |
|
| X |
| Erros relacionados ao calculo |
Método: calcRecenciaNormalizada
Descrição: Método para calcular a recência normalizada com valor de 1 a 100.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
dat_recenc_poster_a | Date | 99/99/9999 | x |
|
| Data inicial |
Método: calcFrequenciaNormalizada
Descrição: Método para calcular a freqüência normalizada com valor de 1 a 100.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
dat_freq_poster_a | Date | 99/99/9999 | x |
|
| Data inicial |
Método: calcValorNormalizada
Descrição: Método para calcular o valor normalizado com valor de 1 a 100.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
dat_val_poster_a | Date | 99/99/9999 | x |
|
| Data inicial |
Método: calcPotenciaNormalizada
Descrição: Método para calcular a potencialidade normalizada com valor de 1 a 100.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
numIdPotenc | Int |
| x |
|
| Id da potencialidade |
Método: calcRecenciaPercentual
Descrição: Método para calcular o percentual da recência com valor de 1% a 100%.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
dat_recenc_poster_a | Date | 99/99/9999 | x |
|
| Data inicial |
Método: calcFrequenciaNormalizada
Descrição: Método para calcular o percentual da freqüência com valor de 1% a 100%.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
dat_freq_poster_a | Date | 99/99/9999 | x |
|
| Data inicial |
Método: calcValorNormalizada
Descrição: Método para calcular o percentual do valor do prfv com valores entre 1% a 100%.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
dat_val_poster_a | Date | 99/99/9999 | x |
|
| Data inicial |
Método: calcPotenciaNormalizada
Descrição: Método para calcular o percentual da potencialidade do prfv com valores entre 1% a 100%.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
numIdPotenc | Int |
| x |
|
| Id da potencialidade |
Método: InsertValuePRFV
Descrição: Elimina registros antigos e insere os novos valores do P, R, F e V na tabela crm_prfv_faixa.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
TtResultQuery | TT |
| x |
|
| Conta a serem consideradas |
ttRecencCli | Tt |
| X |
|
| Recencia x cliente |
ttFreqCli | Tt |
| X |
|
| Freqüência x cliente |
ttValCompCli | Tt |
| X |
|
| Valor x cliente |
ttPotencdCli | Tt |
| X |
|
| Potencialidade x cliente |
tt-bo-erro | Tt |
|
| X |
| Resultado de erros |
Método: deleteFaixaPrfv
Descrição: Elimina registros da tabela de prfv.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pi-prfv | Int |
| x |
|
| Id do prfv faixa |
ttResultQuery | Tt |
| X |
|
| Contas resultantes da segmentação |
tt-bo-erro | Tt |
|
| X |
| Resultado de erros |
Método: queryFormCalc
Descrição: Executa segmentação de contas, podendo ter ou não um publico incial. Gerando assim um novo publico que será armazenado na ttResultQuery para o qual será caluculado o prfv, isso de acordo a parametrização do prfv.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
numIdPrfv | Int |
| x |
|
| Id do prfv faixa |
numIdPublic | Int |
| X |
|
| Id do publico |
ttResultQuery | Tt |
|
| X |
| Contas resultantes da segmentação |