Linha Datasul

Árvore de páginas

Documento de API

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físicocrmrel/apiCrmExpExcel01.p

 

Objetivo

Apii utilizada para gerar o caminho de pastas e alocar o Excel na memória, gerenciar as chamadas para a api(crmrel/apiCrmExpExcel02) que irá inserir os dados na planilha. Descarregar da memória e fechar o arquivo. Geração do arquivo no formato xlsx.

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}

 

 Parâmetros de input e output da api

 

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-cNovoArquivo

Char

 

X

 

 

Arquivo que será gerado

n-colunas

Int

 

X

 

 

Numero de colunas do relatório

p-arvore

Log

 

X

 

 

Monta grupo?(ñ utilizado) default true

p-pinta-linha

Log

 

X

 

 

Pintar linha? (ñ utilizado)

cTitRelat

Char

 

X

 

 

Nome do arquivo que será gerado

iGrupo

Int

 

X

 

 

Quantidade agrupamento, Maximo 2

ttComponente

Tt

 

X

 

 

Temp-table para controle do agrupamto

ttColunaComponente

Tt

 

X

 

 

Temp-table com reg. Para apresentação

ttLabelCol

Tt

 

X

 

 

Temp-table com os labels das colunas

ttUpdateCel

Tt

 

X

 

 

tt atualiza cel. Valor do totalizador

RowErrors

Tt

 

X

 

 

Relação de erros encontrados

 

Métodos

 

Métodos básicos

 

Método: FormataDados

Descrição: Método para atualizar valor e características da célula no Excel.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: exportaFormatoExcel

Descrição: método utilizado para carregar Excel na memória, chamar método para atualização das células, e descarregar da memória e fechar arquivo.     

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: criaPlanilhaExcel

Descrição: Método utilizado para gerir demais métodos de atualização da planilha.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: piGeraCabecalho

Descrição: Atualiza layout e adiciona as colunas na planilha.     

Requisitos: Nenhum

 

Parâmetros: Nenhum

 

Método: piFormataColuna

Descrição: método para formatar a coluna, não está sendo utilizado.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

p-coluna

Int

 

X

 

 

coluna

p-linha

Int

 

X

 

 

linha

 

Método: piExportaDetalhe

Descrição: Método responsável por atualizar os valores correspondente para cada célula.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: assignTTMenu

Descrição: método para formatar a coluna, não está sendo utilizado. 

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pGrupo

Int

 

X

 

 

Grupo

plinhaIni

Int

 

X

 

 

Linha inicial agrupador

plinhaFim

Int

 

X

 

 

Linha final agrupador

iSeq

Int

 

X

 

 

sequência

 

Método: piPintaLinhas

Descrição: Método para configurar cor de fundo nas células (não está sendo usado).

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: assignTTMenu

Descrição: método utilizado para gerar o arquivo, alocar o excel na memória e abrir a planilha.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: piFechamento

Descrição: elimina temporário e libera o Excel da memória.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: piGeraAlfabeto

Descrição: método desenvolvido para gerar todo o alfabeto que deverá ser usado para controle das colunas.

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: piAcertaTamanho

Descrição: método desenvolvido para ajustar coluna automaticamente.         

Requisitos: Nenhum

Parâmetros: Nenhum

 

Método: piCriaCaminho

Descrição: método usado para verificar e se necessário gerar o caminho completo para alocar a planilha Excel.

Requisitos: Nenhum

Parâmetros:

Parâmetro

Tipo

Formato

I

O

IO

Descrição

pCaminho

Char

 

X

 

 

Caminho arquivo

 

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