Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmrel/apiCrmRelTar.p |
Objetivo
Gerar um relatório no formato Excel com as informações pertinentes Tarerfa, 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/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 |
cConta | Char |
| x |
|
| Código conta CRM |
cDataIni | Char |
| X |
|
| Data inicial |
cDataFim | Char |
| x |
|
| Data final |
pTitRelat | Char |
| x |
|
| Titulo relatório |
cReturn | Char |
|
| x |
| retorno |
RowErrors | Tt |
|
| X |
| Relação de erros encontrados |
Método: assignTTComponente
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 |
iTemp | Int |
| X |
|
| Posição |
ordemCompom | Int |
|
|
| X | ordem |
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: Nenhum
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 |