Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | crmrel/apiCrmRelFrequencia.p |
Objetivo
Gerar um relatório no formato Excel com a freqüência de compra dos clientes dentro do período informado.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttCli |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
numIdPessoa | Int |
| Código da conta CRM |
|
cod-emitente | Int |
| Código da conta ERP |
|
ttcarga |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
codPessoa | Int |
| Código da conta erp |
|
codRep | Int |
| Código do representante |
|
codResp | Int |
| Código do responsável |
|
dtUltComp | Date |
| Data emissão |
|
Freq | Char |
| Tipo de freqüência cliente |
|
vlTot0 | Dec |
| Valor total compra mês atual |
|
vlTot1 | Dec |
| Valor total compra 1 mês antes |
|
vlTot2 | Dec |
| Valor total compra 2 meses antes |
|
vlTot3 | Dec |
| Valor total compra 3 meses antes |
|
vlTot4 | Dec |
| Valor total compra 4 meses antes |
|
vlTot5 | Dec |
| Valor total compra 5 meses antes |
|
vlTot6 | Dec |
| Valor total compra 6 meses antes |
|
vlTot7 | Dec |
| Valor total compra 7 meses antes |
|
vlTot8 | Dec |
| Valor total compra 8 meses antes |
|
vlTot9 | Dec |
| Valor total compra 9 meses antes |
|
vlTot10 | Dec |
| Valor total compra 10 meses antes |
|
vlTot11 | Dec |
| Valor total compra 11 meses antes |
|
qTot0 | Int |
| Quantidade de compra mês atual |
|
qTot1 | Int |
| Quantidade de compra 1 mês antes |
|
qTot2 | Int |
| Qtd de compra 2 meses antes |
|
qTot3 | Int |
| Qtd de compra 3 meses antes |
|
qTot4 | Int |
| Qtd de compra 4 meses antes |
|
qTot5 | Int |
| Qtd de compra 5 meses antes |
|
qTot6 | Int |
| Qtd de compra 6 meses antes |
|
qTot7 | Int |
| Qtd de compra 7 meses antes |
|
qTot8 | Int |
| Qtd de compra 8 meses antes |
|
qTot9 | Int |
| Qtd de compra 9 meses antes |
|
qTot10 | Int |
| Qtd de compra 10 meses antes |
|
qTot11 | Int |
| Qtd de compra 11 meses antes |
|
A definição das demais tabelas temporárias pertencentes às includes abaixo podem ser encontradas no documento crmrel_df_temp_table.docx.
{crmrel/ttExcel.i}
{crmapi/UtilPedVdaNF.i}
Parâmetros de input e output da api
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
|
|
|
|
|
|
|
Métodos
Métodos básicos
Método: gerarRelatorio
Descrição: Método principal chamado pela aplicação de tela para executar a geração do relatório, efetua o controle e validação de alguns dados de tela, popula a temp-table utilizada para gerar as colunas no Excel e gerencia os demais métodos.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
qtdMes | Int |
| X |
|
| Qtd meses considerados |
pUsuar | Char |
| x |
|
| Código usuário CRM |
pConta | Char |
| X |
|
| Código conta CRM |
pRepres | Char |
| x |
|
| Código representante CRM |
pTitRelat | Char |
| x |
|
| Titulo relatório |
RowErrors | Tt |
|
|
| x | Relação de erros encontrados |
Método: carga
Descrição: método utilizado para popular as temp-tables que serão enviadas como parametro para geração do relatório em xlsx, também efetuar contagem pra totalizadores e determina como será o agrupamento no relatório.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
qtdMes |
|
| X |
|
| Qtd meses considerados |
ttCliNota | Tt |
| X |
|
| Registros filtrados p/ impressão |
ttComponente | Tt |
|
| x |
| Controle para os agrupadores |
ttColunaComponente | Tt |
|
| X |
| Valores para apresentação do relatório |
ttUpdateCel | Tt |
|
| x |
| Controle para os totalizadores |
Método: createttUpdateCel
Descrição: Adiciona registro com valor do totalizador a ser apresentado em uma das células do relatório.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Seq | char |
| X |
|
| Sequencia |
Grupo | Int |
| X |
|
| Grupo |
Valor | Char |
| X |
|
| Valor totalizador |
letraCol | Char |
| X |
|
| Coluna Excel |
lftBold | Log |
| X |
|
| Fonte bolde? |
iftCor | Int |
| X |
|
| Valor fonte cor |
iftSize | Int |
| X |
|
| Valor tamanho fonte |
iLtColor | Int |
| X |
|
| Não utilizado |
Ibdcolor | Int |
| X |
|
| Cor borda |
Método: createttColunaComponente
Descrição: Adiciona os registros com valores de cada uma das colunas a ser apresentada no relatório.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Cod | Char |
| X |
|
| Código grupo |
Colun | Int |
| X |
|
| Valor da coluna correspondente |
Ordem | Int |
| X |
|
| Ordem pra controle das linhas |
Valor | Char |
| X |
|
| Valor a ser apresentado na célula |
Método: assignTTLabelCol
Descrição: Adiciona os registros com valores dos labels de cada uma das colunas a ser apresentada no relatório.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
iPosicao | Int |
| X |
|
| Posição, utilizado p/ pos. na coluna |
cLabel | Char |
| X |
|
| Valor label coluna |
lftBold | Log |
| X |
|
| Fonte bolde? |
iftCor | Int |
| X |
|
| Valor correspondente a cor da fonte |
iftSize | Int |
| X |
|
| Tamanho da fonte |
iLtColor | Int |
| X |
|
| Cor célula |
Ibdcolor | Int |
| X |
|
| Cor borda |
Método: FindMessageError
Descrição: Adiciona erros na temp-table de retorno de erros RowErros.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
numMsg | Int |
| X |
|
| Código da mensagem de erro |
Param1 | Char |
| X |
|
| Paramtro 1 |
Param2 | Char |
| X |
|
| Parametro 2 |
RowErrors | Tt |
|
| X |
| Relação de erros encontrados |
Método: verificaFreq
Descrição: Verifica qual a freqüência de compra no período através da data da ultima compra e dos valores de compra para cada período.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pMeses | Int |
| X |
|
| Quantidade de meses considerados |
dtUltComp | dat |
| X |
|
| Data emissão |
vlTot0 | Dec |
| X |
|
| Valor compra mês atual |
vlTot1 | Dec |
| x |
|
| Valor compra 1 mês atrás |
vlTot2 | Dec |
| x |
|
| Valor compra 2 meses atras |
vlTot3 | Dec |
| x |
|
| Valor compra 3 meses atras |
vlTot4 | Dec |
| x |
|
| Valor compra 4 meses atras |
vlTot5 | Dec |
| x |
|
| Valor compra 5 meses atras |
vlTot6 | Dec |
| x |
|
| Valor compra 6 meses atras |
vlTot7 | Dec |
| x |
|
| Valor compra 7 meses atras |
vlTot8 | Dec |
| x |
|
| Valor compra 8 meses atras |
vlTot9 | Dec |
| x |
|
| Valor compra 9 meses atras |
vlTot10 | Dec |
| x |
|
| Valor compra 10 meses atras |
vlTot11 | Dec |
| x |
|
| Valor compra 11 meses atrás |
Cfreq | Char |
|
| X |
| Freqüência compra cliente |
Método: calculaFreq
Descrição: verifica se houve compra no mês em questão através do valor da compra, se valor > 0,00 possui compra, se possuir compra concatena 1 na string de retorno se não 0
Sequencias de 0 na string de retorno equivalem a períodos sem compras.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
paramFreq | Char |
|
|
| X | Valor para avaliar frequencia |
valor | Dec |
| X |
|
| Valor analisado p/ estabelecer se houve compra ou não |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas