Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | crmrel/apiCrmExpExcel02.p |
Objetivo
Api utilizada para atualização do valores na planilha Excel, gerar o agrupador e totalizador de registros. Planilha Excel 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 |
|
|
|
|
|
|
|
Métodos
Métodos básicos
Método: piExpDetGrupo1
Descrição: Método para atualizar os valores das colunas na planilha quando a organização dos registros é feita pelo agrupamento de apenas uma coluna.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
n-colunas | int |
| X |
|
| Numero colunas |
c-alfabeto | Char |
| x |
|
| Alfabeto utilizado para colunas |
p-arvore | log |
| X |
|
| agrupamento |
i-linha | Char |
| x |
|
| Contador linhas |
ch-planilha | CMH |
| x |
|
| Planilha carregada na memória |
ttComponente | Tt |
| X |
|
| tt com valores do agrupamento |
ttColunaComponente | Tt |
| X |
|
| Relação valores das células |
ttUpdateCel | Tt |
| X |
|
| Relação pra controle totalizador |
ttMenuGrupo | Tt |
| X |
|
| Tt de controle do agrupamento |
i-cont | Int |
|
| X |
| Contador |
i-lin | Int |
|
| X |
| Ultima linha |
Método: piExpDetGrupo2
Descrição: Método para atualizar os valores das colunas na planilha quando a organização dos registros é feita pelo agrupamento de duas colunas.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
n-colunas | int |
| X |
|
| Numero colunas |
c-alfabeto | Char |
| x |
|
| Alfabeto utilizado para colunas |
p-arvore | log |
| X |
|
| agrupamento |
i-linha | Char |
| x |
|
| Contador linhas |
ch-planilha | CMH |
| x |
|
| Planilha carregada na memória |
ttComponente | Tt |
| X |
|
| tt com valores do agrupamento |
ttColunaComponente | Tt |
| X |
|
| Relação valores das células |
ttUpdateCel | Tt |
| X |
|
| Relação pra controle totalizador |
ttMenuGrupo | Tt |
| X |
|
| Tt de controle do agrupamento |
i-cont | Int |
|
| X |
| Contador |
i-lin | Int |
|
| X |
| Ultima linha |
Método: UpdateCel
Descrição: Atualiza os valores dos totalizadores por agrupamento conforme especificado no relatório.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
Seq | char |
| X |
|
| Sequencia |
iGrupo | Int |
| X |
|
| Grupo |
Linha | Char |
| X |
|
| linha |
ch-planilha | CMH |
| X |
|
| Planilha carregada na memória |
Método: assignTTMenu
Descrição: Cria um novo agrupador de registros na planilha de acordo com parametrização da temp-table ttMenuGrupo.
Requisitos: Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pGrupo | Int |
| X |
|
| Grupo |
plinhaIni | Int |
| X |
|
| Linha inicial |
plinhaFim | Int |
| X |
|
| Linha final |
iSeq | Int |
| X |
|
| Sequencia |
c-alfabeto | Char |
| X |
|
| Alfabeto para identificar a coluna |
n-colunas | Int |
| X |
|
| Total colunas |