🎯 Objetivo

Orientar como consultar as variáveis disponíveis para utilização na Integração com o Microsoft Word no módulo Gestão de Pessoal — GPE do TOTVS Protheus.

A própria rotina disponibiliza uma opção para listar as variáveis existentes com suas respectivas descrições. Caso seja necessária uma informação que não esteja disponível no padrão, a TOTVS informa que poderá ser realizada uma customização através do fonte:

GPEWORD.PRW

🧩 Ambiente

• Produto: TOTVS RH — Linha Protheus
• Módulo: Gestão de Pessoal — GPE
• Processo: Integração com Microsoft Word
• Versão: A partir da versão 12
• Fonte relacionado: GPEWORD.PRW

🔎 Cenário

Durante a criação ou manutenção de documentos integrados ao Word, pode surgir a necessidade de identificar qual variável deve ser utilizada para determinada informação do funcionário.

Nesse cenário, não é necessário pesquisar diretamente em fontes ou tentar descobrir o nome da variável manualmente.

O próprio Protheus permite consultar a relação das variáveis disponíveis por meio do caminho:

Atualizações
> Integrações
> Word
> Impr. Variáveis

Após a confirmação, o sistema apresenta as variáveis juntamente com suas respectivas descrições.

⚙️ Como consultar as variáveis

Acesse no módulo Gestão de Pessoal:

Atualizações
> Integrações
> Word

Em seguida, selecione:

Impr. Variáveis

e clique em:

OK

O sistema gerará em tela a relação das variáveis disponíveis e suas respectivas descrições.

Caso existam várias páginas, utilize a seta para baixo para avançar na listagem.

🆕 Variável GPE_NSOCIAL

A TOTVS informa que foi incluída a variável:

GPE_NSOCIAL

para geração do Nome Social do funcionário.

A informação está relacionada ao campo:

RA_NSOCIAL

O fluxo pode ser representado da seguinte forma:

RA_NSOCIAL
     ↓
GPE_NSOCIAL
     ↓
Documento Word

🛠️ Variável não disponível no padrão

Caso seja necessária uma variável que não conste na relação apresentada pelo sistema, a TOTVS informa que é possível realizar uma customização através do fonte:

GPEWORD.PRW

O fonte está disponível no acumulado RH, dentro da pasta:

rdmake

A documentação apresenta materiais relacionados às seguintes releases:

12.1.2410 — sem garantia estendida
12.1.2410 — com garantia estendida
12.1.2510

Antes de utilizar o fonte, é importante confirmar a release correspondente ao ambiente.

📊 Resumo do comportamento

⚠️ Ponto de atenção

Antes de realizar qualquer customização no:

GPEWORD.PRW

deve-se primeiro consultar toda a relação apresentada pela opção:

Impr. Variáveis

A customização deve ser avaliada somente quando a informação realmente não estiver disponível no padrão.

Também é importante utilizar o fonte correspondente à release correta do ambiente, evitando incompatibilidades entre versões.

✅ Resultado esperado

Após acessar:

Atualizações
> Integrações
> Word
> Impr. Variáveis

e confirmar com:

OK

o Protheus deverá apresentar em tela as variáveis disponíveis para utilização na Integração com o Word, acompanhadas de suas respectivas descrições.

Caso a variável desejada não exista, poderá ser avaliada uma customização através do:

GPEWORD.PRW

conforme orientação da TOTVS.

💡 Boas práticas

• consultar sempre Impr. Variáveis antes de realizar uma customização;
• conferir a descrição da variável antes de utilizá-la no modelo;
• utilizar GPE_NSOCIAL quando houver necessidade do Nome Social;
• confirmar o preenchimento de RA_NSOCIAL quando aplicável;
• utilizar o GPEWORD.PRW correspondente à release do ambiente;
• testar customizações inicialmente em ambiente de homologação;
• manter uma cópia do fonte original;
• documentar as alterações realizadas no fonte;
• validar novamente os documentos após atualização de release ou aplicação de acumulados.

❓ FAQ

1. Onde consulto as variáveis disponíveis para Integração com o Word?

Acesse:

Atualizações
> Integrações
> Word
> Impr. Variáveis

2. O sistema apresenta a descrição das variáveis?

Sim. O Protheus apresenta as variáveis disponíveis juntamente com suas respectivas descrições.

3. Como visualizar a próxima página da listagem?

Utilize a seta para baixo apresentada na tela.

4. Qual variável deve ser utilizada para gerar o Nome Social?

Utilize:

GPE_NSOCIAL

5. Qual campo fornece o Nome Social?

O campo utilizado é:

RA_NSOCIAL

6. O que fazer se a variável necessária não estiver disponível?

Pode ser avaliada uma customização através do fonte:

GPEWORD.PRW

7. Onde o GPEWORD.PRW é disponibilizado?

No acumulado RH, dentro da pasta:

rdmake

8. A funcionalidade está disponível a partir de qual versão?

A documentação informa aplicação:

A partir da versão 12

9. É necessário customizar o fonte para toda nova informação?

Não.

O primeiro passo deve ser sempre consultar:

Impr. Variáveis

A customização somente deve ser avaliada quando a informação necessária não estiver disponível entre as variáveis padrão.

10. Posso utilizar qualquer versão do GPEWORD.PRW?

Não é recomendado.

O fonte deve ser compatível com a release utilizada pelo ambiente Protheus.

🔗 Referência oficial

TOTVS — RH — Linha Protheus — GPE — Variáveis que podem ser usadas na Integração com o WORD.

👤 Autor

Fabrizio Augusto Ventavolo
Consultor Especialista TOTVS — Mastersiga Consultoria

“Conectamos tecnologia, processos e pessoas para acelerar resultados com excelência em sistemas TOTVS.”