Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmrel/apiCrmRelFatMensalCli.p

 

Objetivo

Gerar um relatório no formato Excel com as informações pertinentes ao faturamento mensal do representante de acordo o período informado pelo usuário, CRM analítico.

 

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 ERP

 

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

 

 

 

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