Histórico da Página

API de Integração entre Progress e Microsoft Word (001)

Considerações Gerais

• A API recebe como parâmetros valores, que serão utilizados para o preenchimento de campos de formulário existentes no documento;
• A include {utp/utapi027.i} contém as definições das Temp-Tables que devem ser passadas como parâmetros à API utp/utapi027.p. Sendo que a chamada desta include, como a inclusão de valores, deve ser feita antes da chamada da API utp/utapi027.p;
• A API pode ser executada de forma direta ou persistente. Ela deve ser executada persistente apenas quando for necessário salvar o documento que foi gerado, caso contrário a sua simples execução irá gerar o relatório no word e caberá ao usuário informar se deseja ou não salvar o documento gerado;
• O procedimento interno pi-salvar recebe como parâmetros o nome do arquivo que se deseja salvar. Caso não seja possível salvar o arquivo, o erro será retornado na temp-table tt-erros (OBS.: Para obter os erros quando o utilitário for executado de forma persistente é necessário utilizar o procedimento interno pi-getErrors que está documento abaxio);
• O procedimento interno pi-getErrors possui um parâmetro de OUTPUT que é a temp-table de erros(tt-erros). Esse procedimento só deve ser executado para obter os erros quando o utilitário for executado de forma persistente;
• O procedimento interno pi-finalizar recebe como parâmetros um valor lógico (TRUE/FALSE) que determina se o arquivo do word que foi gerado deve ser fechado ou deve continuar aberto. A execução desse procedimento faz com que todas as referências ao word sejam eliminadas da memória e por isso a sua execução é necessária apenas quando o utilitário for executado de forma persistente.
• A funcionalidade de inserir documentos só permite que sejam informados arquivos com as seguintes extensões: DOC, XML, HTML, HTM, DOT, RTF e TXT.

Parâmetros de Entrada 

Temp-table tt-configuracao2configuracao: possui as definições, gerais, do arquivo a ser criado.

Temp-Table tt-dados: possui as definições, gerais, sobre cada um dos campos a serem preenchidos no documento.

Execução

Cabe ao programa de origem, verificar os registros que estão com errochamador verificar os possíveis erros ocorridos durante a execução da API.

* ver Principais Validações da Temp-Table tt-configuracao2configuracao
* ver Principais Validações da Temp-Table tt-dados

Parâmetros de Saída

Outras Informações

Abaixo se encontram as principais validações a serem executadas em cada uma das Temp-Tables de entrada utilizadas pelo procedimento interno pi-executepela API utp/utapi027.p.

A seguir se encontram referências sobre os valores que alguns campos podem assumir:

Caso o nome da impressora retornada pelo Progress, utilizando o comando session:printer-name não seja uma impressora válida para o ms-word foram disponibilizadas as procedures:

Exemplo

Abaixo programa exemplo de utilização da API.

Instruções:

• Crie um formulário no Word com três quatro campos texto, os campos precisam ter os nomes (nome, endereço, telefone, imagem, arquivo) e grave como um modelo do Word no diretório c:\tmp com o nome de  de a.dot.
• O valor do campo imagem do exemplo abaixo deve ser substituído pelo caminho de uma imagem existente na máquina onde o programa será executado.
• O valor do campo arquivo do exemplo abaixo deve ser substituído pelo caminho de um arquivo existente na máquina onde o programa será executado.
• Execute o programa abaixo:

{utp/utapi012utapi027.i}              
run utp/utapi012.p persistent set h-utapi012.                                                  
SYSTEM-DIALOG PRINTER-SETUP.  /*seleciona impressora*/
os-delete value("c:\tmp\a.doc").

create tt-configuracao2configuracao.       
assign tt-configuracao2configuracao.versao-integracao = 1
       tt-configuracao2.arquivo = "c:\tmp\a.doc" /*arquivo que será gerado*/
       tt-configuracao2configuracao.modelo  = "c:\tmp\a.dot"
 /*arquivo que contem o formulário*/
       tt-configuracao2configuracao.senha-modelo = ""
           tt-configuracao2configuracao.exibir-construcao = no.
       tt-configuracao2.abrir-word-termino = no
       tt-configuracao2configuracao.imprimir = yes. /*imprime o documento*/no.

create tt-dados.
assign tt-dados.campo-nome = "Nome"
           tt-dados.campo-tipo = 3
           tt-dados.campo-valor = "Datasul - Tecnologia".         

create tt-dados.
assign tt-dados.campo-nome = "Endereco"
           tt-dados.campo-tipo = 3
           tt-dados.campo-valor = "Santos Dummond, 831".         

create tt-dados.
assign tt-dados.campo-nome = "telefone"
           tt-dados.campo-tipo = 3
           tt-dados.campo-valor = "(47) 441-7000".         

/*-------------------------------------------------------------------*/
run pi-execute in h-utapi012create tt-dados.
assign tt-dados.campo-nome = "imagem"
           tt-dados.campo-tipo = 4
           tt-dados.campo-valor = "c:\tmp\amostra.jpg".
create tt-dados.
assign tt-dados.campo-nome = "arquivo"
           tt-dados.campo-tipo = 5
           tt-dados.campo-valor = "c:\tmp\arquivo.doc".

run utp/utapi027.p
                 (input-output table tt-configuracao2configuracao,
                  input-output table tt-dados,
                  input-output table tt-erros).
/* Este código em comentário é um exemplo de como utilizar a API para salvar o documento gerado. 
/*Quando for utilizada essa codificação é necessário comentar a execução da API que se encontra acima.

DEFINE VARIABLE hApi AS HANDLE     NO-UNDO.

run utp/utapi027.p PERSISTENT SET hApi
                 (input-output table tt-configuracao,
                  input-output table tt-dados,
                  input-output table tt-erros).

RUN pi-salvar IN hApi (INPUT "c:\tmp\teste.doc").

RUN pi-finalizar IN hApi (INPUT TRUE).

RUN pi----------------------------------------------------------*/
getErrors IN hApi (OUTPUT TABLE tt-erros).

DELETE OBJECT hApi.
*/

if return-value = "NOKnok" then do: 
    for each tt-erros: 
        disp tt-erros with 1 col width 500. 
    end.
end. 
/*-------------------------------------------------------------------*/                 
Delete procedure h-utapi012.    
/*-------------------------------------------------------------------*/             

Técnicas de Importação/Importação