Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
| Nome Físico | crmrel/apiCrmRelClienGeral.p |
Objetivo
Gerar um relatório no formato Excel com as informações pertinentes do Cliente, CRM analítico.
Tabelas Temporárias
Atributos das tabelas temporárias de entrada e saída:
ttConta |
| |||
Atributo | Tipo | Formato | Descrição | Obr. |
Id | Int |
| Código da conta CRM |
|
idUsuar | Int |
| Código do usuário CRM |
|
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}
{crmboCustom/contaUsuar.i tt-cta_usuar}
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 |
pConta | Char |
| X |
|
| Código da conta CRM |
pRepres | Char |
| X |
|
| Código do representante CRM |
pUsuar | Char |
| X |
|
| Código do usuário CRM |
pDtIni | Char |
| X |
|
| Data inicial |
pDtFim | Char |
| x |
|
| Data final |
pUF | Char |
| X |
|
| Código UF entrega CRM |
pCidade | Char |
| x |
|
| Código cidade entrega CRM |
pBairro | Char |
| X |
|
| Código bairro entrega CRM |
pUF2 | Char |
| X |
|
| Código UF cobrança CRM |
pCidad2 | Char |
| x |
|
| Código cidade cobrança CRM |
pBair2 | Char |
| X |
|
| Código bairro cobrança 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 |
ttConta | Tt |
| X |
|
| Registros filtrados p/ impressão |
ttComponente | Tt |
|
| x |
| Controle para os agrupadores |
ttUpdateCel | Tt |
|
| x |
| Controle para os totalizadores |
Método: ReturnMatriz
Descrição: Retorna o código da Matriz se a conta possuir uma.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
numIdPessoa | Int |
| X |
|
| Código da conta no CRM |
codEmpMatriz | Char |
|
| X |
| Código da matriz |
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 |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas