Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	crmrel/apiCrmRelAnalUsuar.p

Objetivo

Gerar um relatório no formato Excel com as informações pertinentes do usuário para o CRM analítico.

Tabelas Temporárias

Atributos das tabelas temporárias de entrada e saída:

ttParam
Atributo	Tipo	Formato	Descrição	Obr.
Repres	Char		Código Representante
nomRepres	Char		Representante
superv	Char		Código supervisor
nomSuperv	Char		Nome supervisor
usuarSubor	Int		Código usuário
qtdPed	Int		Qtd pedido
nrVdaCli	Int		Num. Venda Cliente
nrVdaCliUnico	Int		Num. Venda cliente único
nrVdaCliFil	Int		Num. Venda cliente filial
nrCliUnico	Int		Num. Cliente único
nrCliCartera	Int		Num. Cliente carteira
nrCliVda	Int		Num. Cliente venda
nrCliFiliais	Int		Num. Cliente filiais
porcCliVda	Dec		Porcentagem venda cliente
porcCliVdaUnico	Dec		Porcentagem venda cliente único
procCliVdaFil	Dec		Porcentagem venda cliente filial
valFaturado	Dec		Valor faturado
valTotCotac	Dec		Valor total cotação
valTotTrans	Dec		Valor total transação
valTotSimRem	Dec		Valor total simples remessa

ttConta
Atributo	Tipo	Formato	Descrição	Obr.
Id	Int		Código conta CRM
idUsuario	Int		Código 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}

{crmapi/UtilPedVdaNF.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: returnRepres

Descrição: Método utilizado para retornar o código e a descrição do representante amarrado ao usuário.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
codUsuario	Char		X			Código do usuário
codRepres	Int			x		Código do representante
nomRepres	Char			X		Nome representante

Método: returnInfUser

Descrição: Método utilizado para retornar o código e a descrição do usuário amarrado ao representante.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
codRepres	Char		X			Código do representante
codUsuario	Int			x		Código do usuário
nomRepres	Char			X		representante

Método: returnUsers

Descrição: retorna um relação com todos os usuários subordinados relacionados ao usuário e/ou representante passado como parâmetro.

Requisitos: Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pUsuar	Char		X			Código do usuário
pRepres	char		x			Código do representante
ttUsuarSubor	Tt			X		Relação de usuários subordinados
RowErrors	Tt			X		Relação de erros encontrados

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
pUsuar	Char		X			Código usuario 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
ttParam	Tt		X			Registros filtrados p/ impressão
ttComponente	Tt			x		Controle para os agrupadores
ttUpdateCel	Tt			x		Controle para os totalizadores

Método: ReturnCustumerHierTime

Descrição: verifica se as contas filtradas estão de acordo com a regra de times, caso não, então remove.

Requisitos: Nenhum

Parâmetros: Nenhum

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: 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: 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

Árvore de páginas

apiCrmRelAnalUsuar - Geração do relatório analítico usuários, no formato xlsx

Documento de API

Objetivo

Tabelas Temporárias

Parâmetros de input e output da api

Métodos