Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmrel/apiCrmRelCliCompUnicoProd.p |
Objetivo
Gerar um relatório no formato Excel com informações pertinentes de clientes que compraram apenas um tipo de produto dentro do período informado, CRM analítico.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttParam |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
|
|
|
|
|
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}
{crmrel/ttItensCliComp.i ttItensCliComp}
{crmrel/UtilRelHierTime.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 |
pDtIni | Char |
| X |
|
| Data inicial |
pDtFim | Char |
| x |
|
| Data final |
pProdut | Char |
| X |
|
| Código produto 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 |
ttItensCliComp | 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 |