Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Button
TextoVoltar
Linkhttps://tdn.totvs.com/pages/releaseview.action?pageId=857586913



API de Integração entre Microsoft Excel e Progress (v.01)


Nome Físico: utp/utapi006.p

Nome do Include com Parâmetros: utp/utapi006.i

Versão de Integração: 1

Objetivo: 

Ler planilhas do Excel e trazer os valores e fórmulas das células para que estas sejam usadas em um programa Progress.

Pré-requisitos: 

É necessário ter o MS-EXCEL com uma versão compatível com o produto. Para mais detalhes consulte a documentação localizada em: https://tdn.totvs.com/pages/releaseview.action?pageId=195301010


Considerações Gerais


- Deve ser passada 2 (duas) temp-tables. A primeira deve ser passada através do comando INPUT-OUTPUT e a segunda através do OUPUT, que retornará uma lista dos erros ocorridos durante o processamento da API.


Parâmetros de Entrada 


Temp-table tt-dados: 

nesta temp-table deverão ser passadas todas as informações que se deseja -se buscar da planilha. Nesta mesma temp-table serão armazenadas as informações retiradas da planilha.

 


TEMP-TABLE TT-DADOS

Atributo

Tipo

Formato

Valor Inicial

versao-integracao

integer

"999"


arquivo

character

“x(40)”


planilha

integer

“>>”


celula-linha

integer

“>>>”


celula-coluna

integer

“>>>”


valor

character

“x(20)”


formula-local

character

“x(20)”


formula

character

“x(20)”


Atributo

Tipo

versao-integracao

Número da versão de integração.

arquivo

Nome físico do arquivo do Excel a ser lido.

planilha

Número da planilha dentro do arquivo do Excel.

celula-linha

Corresponde ao número da linha da célula.

celula-coluna

Corresponde ao número da coluna da céluna. Ex: 2 = B.

valor

Campo que irá armazenar o valor da célula.

formula-local

Campo que irá armazenar a fórmula local da célula.

formula

Campo que irá armazenar a fórmula padrão da célula.




Temp-table tt-erros :

Tabela onde serão armazenados todos os erros ocorridos durante a execução da API.

TEMP-TABLE TT-ERROS

Atributo

Tipo

Formato

Valor Inicial

codigo-erro

integer



descricao

character



Atributo

Descrição

codigo-erro

Código da mensagem de erro ocorrido.

descricao

Descrição do erro ocorrido.




Execução


 O programa utp/utapi006.p irá executar os seguintes passos:



1ª Passo:

Versão de Integração

O programa irá verificar se o programa chamador está íntegro com a API, e isto ocorre através da verificação da versão de integração passada como parâmetro. Caso a versão esteja incompatível, a API abortará a execução retornando o código de erro 3941.

2ª Passo:

Dados

Neste momento, será verificada a existência de dados a serem buscados da planilha.

3ª Passo:

Sessão OLE com o Excel

Será aberta uma sessão de OLE Automation com o Excel e verificada a sua versão.

4ª Passo:

Leitura dos dados

Neste passo, serão lidos todos os dados pedidos e este serão gravados para serem retornados ao programa chamador.

5ª Passo:

Fim do Programa

Neste passo, o programa fecha os arquivos abertos e a sessão com o Excel.



Parâmetros de Saída


 No retorno da execução do programa utp/utapi006.p, será retornado via return-value:

NOK: 

A execução da API foi efetivada, porém, algum pedido não foi criado.


OK: 

A execução ocorreu com sucesso.