Como utilizar variáveis no SoftExpert Documento
Pré-requisitos
- Documento com categoria configurada com conversão para .pdf.
- Arquivo no formato .docx.
Apresentação
O uso de variáveis no SoftExpert Documento permite que o sistema insira informações de forma automática nos arquivos, eliminando a necessidade de editar manualmente cada campo.
Essa funcionalidade contribui para a padronização de conteúdos, reduz o esforço de digitação e agiliza a elaboração de documentos, especialmente em cenários de alto volume.
Além disso, as variáveis podem ser aplicadas em tabelas, possibilitando a geração dinâmica de linhas conforme a quantidade de dados disponíveis.
Dessa forma, é possível criar um único modelo de documento e deixar que o sistema expanda automaticamente a tabela, contemplando todos os registros necessários.
Entre os exemplos de aplicação, destacam-se tabelas com a lista de envolvidos na revisão, histórico de alterações, entre outras.
Este recurso é exclusivo para clientes que utilizam a plataforma em nuvem do SoftExpert Suite.
Utilizar variáveis no documento
1. Acesse a aba Arquivo eletrônico de um documento e clique no botão Ver variáveis disponíveis.
Nesta tela, é possível visualizar os dados das seguintes colunas:
- Variável: apresenta a variável que deverá ser copiada para dentro do arquivo .docx para que ela seja preenchida automaticamente. Exemplo de seu formato: {d.document.author}.
- Descrição: descreve o que a variável representa. No exemplo {d.document.author}, representa o autor do documento.
- Tipo de dado: informa se o dado é um texto, uma lista, uma data, entre outros.
- Ações: exibe o botão que permite copiar a variável.
2. Clique no botão Copiar de uma variável e cole no arquivo .docx. Por exemplo, se deseja incluir a variável de autor do documento dentro do arquivo, é possível construir o texto da seguinte maneira: “Autor do documento: {d.document.author}.”
3. Associe o arquivo .docx ao documento.
4. Na coluna Ações do arquivo associado, clique em Mais e em Listar variáveis do arquivo.
- Ao utilizar esta opção, o sistema faz uma varredura no arquivo .docx para identificar todas as variáveis, apresentando um feedback de quais estão corretas e quais não foram encontradas correspondências.
- Se o arquivo apresentar variáveis incompatíveis, clique novamente na opção Ver variáveis disponíveis e confira se a variável foi copiada corretamente. Se necessário, apague a variável do seu arquivo e cole-a novamente. Certifique-se que ela está igual à variável apresentada no sistema.
5. Agora, quando seu arquivo for convertido para .pdf de forma automática ou manual, as variáveis serão preenchidas com o valor identificado pelo sistema.
Recursos avançados
O grande diferencial do uso dessas variáveis é a possibilidade de criação de tabelas dentro do seu arquivo .docx, para que as linhas sejam geradas automaticamente conforme a quantidade de dados disponíveis. Veja alguns exemplos e orientações:
Exemplo 1: Lista de elaboradores do documento
Para ter uma tabela deste tipo no arquivo:
| Elaborador | Área | Função | Data | Hora |
| José Antonio | Qualidade | Analista II | 07/02/2025 | 12:31:12 |
| Maria Lúcia | Produção | Supervisor | 17/02/2025 | 11:22:22 |
| Ana Clara | Qualidade | Coordenador | 09/03/2025 | 17:20:45 |
| João Silva | Desenvolvimento | Diretor | 18/03/2025 | 20:46:56 |
Configure as variáveis da seguinte maneira:
| Elaborador | Área | Função | Data | Hora |
| {d.document.revision.drafter[i].userName} | {d.document.revision.drafter[i].department} | {d.document.revision.drafter[i].function} | {d.document.revision.drafter[i].date} | {d.document.revision.drafter[i].time} |
| {d.document.revision.drafter[i+1].userName} | {d.document.revision.drafter[i+1].department} | {d.document.revision.drafter[i+1].function} | {d.document.revision.drafter[i+1].date} | {d.document.revision.drafter[i+1].time} |
Exemplo 2: Lista com todos os participantes da revisão
Também é possível construir uma tabela deste tipo:
| Participante | Data | Hora | Usuário | Área | Função |
| Elaborador | 07/02/2025 | 12:31:12 | José Antonio | Qualidade | Analista II |
| Consensador | 17/02/2025 | 11:22:22 | Maria Lúcia | Produção | Supervisor |
| Consensador | 17/02/2025 | 15:45:23 | Ana Clara | Qualidade | Coordenador |
| Aprovador | 09/03/2025 | 09:34:33 | Maria Lúcia | Produção | Supervisor |
| Aprovador | 10/03/2025 | 14:23:44 | Ana Clara | Qualidade | Coordenador |
| Homologador | 18/03/2025 | 20:46:56 | João Silva | Desenvolvimento | Diretor |
Para isso, configure as variáveis da seguinte maneira:
| Participante | Data | Hora | Usuário | Área | Função |
| Elaborador | {d.document.revision.drafter[i].date} | {d.document.revision.drafter[i].time} | {d.document.revision.drafter[i].userName} | {d.document.revision.drafter[i].department} | {d.document.revision.drafter[i].function} |
| {d.document.revision.drafter[i+1].date} | {d.document.revision.drafter[i+1].time} | {d.document.revision.drafter[i+1].userName} | {d.document.revision.drafter[i+1].department} | {d.document.revision.drafter[i+1].function} | |
| Consensador | {d.document.revision.reviewer[i].date} | {d.document.revision.reviewer[i].time} | {d.document.revision.reviewer[i].userName} | {d.document.revision.reviewer[i].department} | {d.document.revision.reviewer[i].function} |
| {d.document.revision.reviewer[i+1].date} | {d.document.revision.reviewer[i+1].time} | {d.document.revision.reviewer[i+1].userName} | {d.document.revision.reviewer[i+1].department} | {d.document.revision.reviewer[i+1].function} | |
| Aprovador | {d.document.revision.approver[i].date} | {d.document.revision.approver[i].time} | {d.document.revision.approver[i].userName} | {d.document.revision.approver[i].department} | {d.document.revision.approver[i].function} |
| {d.document.revision.approver[i+1].date} | {d.document.revision.approver[i+1].time} | {d.document.revision.approver[i+1].userName} | {d.document.revision.approver[i+1].department} | {d.document.revision.approver[i+1].function} | |
| Homologador | {d.document.revision.releaser[i].date} | {d.document.revision.releaser[i].time} | {d.document.revision.releaser[i].userName} | {d.document.revision.releaser[i].department} | {d.document.revision.releaser[i].function} |
| {d.document.revision.releaser[i+1].date} | {d.document.revision.releaser[i+1].time} | {d.document.revision.releaser[i+1].userName} | {d.document.revision.releaser[i+1].department} | {d.document.revision.releaser[i+1].function} |
Exemplo 3: Histórico de alterações
É possível exibir uma tabela com o histórico de alterações, como no exemplo abaixo:
| Data | Usuário | Alteração | Localização | Revisão |
| 07/02/2025 | Ana Clara | Alterado o título da seção. | Página 1 | 01 |
| 17/02/2025 | João Silva | Incluídos os novos requisitos referentes a segurança da informação. | Páginas 10 e 11 | 01 |
| 09/03/2025 | José Antonio | Corrigido um erro ortográfico. | Página 22 | 01 |
| 18/03/2025 | Maria Lúcia | Logo alterada com a nova identidade da empresa. | Todas as páginas | 01 |
Para isso, configure as variáveis da seguinte maneira:
| Data | Usuário | Alteração | Localização | Revisão |
| {d.document.revision.changeHistory[i].date} | {d.document.revision.changeHistory[i].userName} | {d.document.revision.changeHistory[i].description} | {d.document.revision.changeHistory[i].location} | {d.document.revision.changeHistory[i].revisionId} |
| {d.document.revision.changeHistory[i+1].date} | {d.document.revision.changeHistory[i+1].userName} | {d.document.revision.changeHistory[i+1].description} | {d.document.revision.changeHistory[i+1].location} | {d.document.revision.changeHistory[i+1].revisionId} |
Caracteres especiais
Evite colocar caracteres especiais nos identificadores de atributos, atividades do Workflow e campos de formulário.
As variáveis seguem um formato padronizado e representam dados do documento. Veja alguns exemplos:
Autor do documento: {d.document.author}
Categoria do documento: {d.document.category.name}
Atributos do documento: {d.document.attribute.atributo}
No caso acima, “atributo” será sempre substituído pelo identificador do atributo cadastrado no sistema. Por isso, atenção redobrada!
Quando utilizar o formato {d.document.attribute.atributo}, é importante que o identificador do atributo não contenha caracteres especiais, como ! @ # $ % ^ & * ( ) + = [ ] { } ; : ' " , . < > / ? \ | e espaços.
O motivo é que o sistema interpreta os caracteres como separação de níveis dentro do objeto ou ainda como alguma função que deve ser executada. Ou seja, se você cadastrar um atributo com o identificador meu.atributo, por exemplo, o sistema pode entender que você está tentando acessar algo como d.document.attribute.meu.atributo, gerando uma falha na conversão.
Esta mesma recomendação se aplica às atividades do Workflow e aos campos de formulário.
Boas práticas
- Use identificadores de atributos, atividades de Workflow e campos de formulário sem caracteres especiais.
- Sempre teste o arquivo após incluir variáveis para garantir que o preenchimento está correto.
Perguntas frequentes
1. Preciso decorar as variáveis?
Não. Você pode sempre ter em mãos a lista completa das variáveis ao acessar a aba de arquivo eletrônico de um documento e clicar no botão “Ver variáveis disponíveis”.
2. Posso usar as variáveis sem as chaves {} ou em outro formato?
Não. O preenchimento das variáveis só vai funcionar se a variável dentro do arquivo for exatamente como apresentada ao clicar no botão “Ver variáveis disponíveis”.
3. Posso usar uma variável que não está sendo exibida dentro de “Ver variáveis disponíveis”?
Não. Como comentado anteriormente, só é possível utilizar as variáveis que já estão disponíveis.
4. A categoria do documento não possui a configuração de conversão para .pdf, consigo utilizar as variáveis mesmo assim?
Não. As variáveis são preenchidas durante a conversão para .pdf. Por isso, sem a conversão, não acontecerá o preenchimento das variáveis.
5. Posso usar docvariables e variáveis dentro do mesmo arquivo?
Sim. Se você já possui a configuração de metadados na categoria, mas deseja utilizar algum recurso novo das variáveis, você pode sim utilizar as duas formas dentro do seu arquivo. Durante o processo de conversão, as docvariables e as variáveis serão preenchidas.
6. As variáveis também funcionam para arquivos com outros formatos, como .doc ou .xlsx?
Não. O preenchimento das variáveis será aplicado apenas para arquivos com extensão .docx.
7. Posso utilizar a mesma variável mais de uma vez dentro do arquivo?
Sim. Você pode usar quantas vezes quiser.
8. O que acontece se não tiver dado para ser preenchido na variável? Por exemplo, coloquei uma variável de um campo de um formulário, mas este campo está em branco, não foi preenchido.
A variável será substituída por um espaço em branco.
9. O que acontece se o meu documento tiver uma variável de um atributo que não está associado ao meu documento?
Por meio da opção “Listar variáveis do arquivo”, é possível visualizar cada uma das variáveis encontradas dentro do arquivo. Esta opção está presente na coluna “Ações” nos arquivos da aba “Arquivo eletrônico” do documento. Com esta opção, também é possível identificar quais das variáveis não possuem uma correspondência dentro do sistema. Então, caso você tenha uma variável referente à um atributo que não está mais associado ao documento, você poderá identificá-la com a opção “Listar variáveis do arquivo” e, em seguida, poderá editar o arquivo para realizar o ajuste necessário.
10. O que acontece se eu tiver uma tabela de aprovadores e o meu documento não tiver etapa de aprovação?
A sua tabela ficará em branco.
Conclusão
O recurso de variáveis amplia a flexibilidade e a automação no SoftExpert Documento, permitindo maior precisão, padronização e economia de tempo na elaboração de documentos.
Ao utilizar variáveis em campos ou tabelas, o usuário garante que as informações sejam atualizadas de forma consistente e confiável, tornando o processo mais eficiente e menos suscetível a erros manuais.