Gerenciar arquivos com variáveis
Este recurso está disponível a partir da versão 3.0 do sistema e é exclusivo para clientes que utilizam a plataforma em nuvem do SoftExpert Suite.
Pré-requisitos
- Acesso ao menu Processo (PM063).
- Processo BPMN previamente cadastrado e modelado.
- Processo com pelo menos uma atividade de usuário com formulário associado e uma atividade de sistema em seu fluxograma.
- Arquivo modelo no formato .docx, contendo variáveis no padrão {d.objeto.nome}.
- Acesso ao menu SoftExpert Workflow > Configuração > Parâmetros gerais (WF019).
Apresentação
A funcionalidade de gestão de arquivos com variáveis permite que o usuário configure a geração automática de documentos a partir de templates (.docx) que utilizam variáveis do processo e do formulário associado.
As variáveis funcionam como espaços reservados substituídos automaticamente pelo sistema, evitando erros de digitação e garantindo consistência nos documentos.
O objetivo é automatizar a criação, assinatura e armazenamento de arquivos personalizados, reduzindo erros manuais e aumentando a produtividade do fluxo.
Veja como utilizar as variáveis nos modelos de contrato:
Identificar variáveis disponíveis e inserir arquivo modelo
Para identificar quais variáveis estão disponíveis para utilização e inserir o arquivo modelo na atividade de sistema, siga os passos abaixo:
1. Acesse o menu Processo (PM063).
2. Localize o processo desejado e clique com o botão direito do mouse sobre ele.
3. Selecione a opção Abrir fluxograma.
4. No fluxograma, selecione a atividade de sistema desejada e clique na opção Dados da barra de ferramentas.
5. Nos dados gerais, expanda o campo Integrações e selecione a opção Gerar arquivo eletrônico com variáveis.
6. Clique na opção Configurar arquivo eletrônico com variáveis.
7. Clique no campo Visualizar variáveis disponíveis no processo. Neste momento, será apresentada uma tabela com todas as variáveis disponíveis para o processo, como variáveis do formulário e variáveis do workflow (dados da instância).
Essas variáveis são detectadas automaticamente com base nas propriedades configuradas no processo e no formulário vinculado. Confira mais detalhes sobre a utilização das variáveis no tópico abaixo.
8. Após visualizar as variáveis, clique no botão Incluir arquivo eletrônico para fazer o upload do template no formato .docx que contém as variáveis no formato {d.objeto.nome}.
9. Clique no botão Concluir. Após o upload, o sistema verificará se existem erros nas variáveis do documento que possam estar fora do padrão necessário para a função.
10. Se foram identificadas variáveis fora do padrão, elas serão apresentadas como erro. Neste caso, utilize a coluna Ações para corrigir as variáveis diretamente na tela, ou edite o template e realize o upload novamente.
11. Clique no botão Próxima etapa e realize as demais configurações necessárias:
Marca d'água
É possível configurar uma marca d'água para o documento gerado. A funcionalidade permite personalizar o documento conforme as políticas internas da organização ou necessidades de rastreabilidade.
Recomenda-se utilizar marcas d'água para documentos internos que exijam controle de versão ou confidencialidade.
Os tipos disponíveis de marca d'água são:
- Texto
- Imagem
- QR Code
Confira a documentação do SoftExpert Documento para mais detalhes sobre a configuração das marcas d'água.
Assinatura eletrônica
É possível configurar assinaturas digitais, vinculadas a modelos já cadastrados no menu SoftExpert Administração > Configuração > Arquivo eletrônico > Assinatura digital (AD077).
Confira o artigo Configurar assinatura digital de documentos para mais detalhes.
Armazenamento
Na última etapa, defina onde e como o arquivo será armazenado.
Defina se o arquivo será salvo em formato PDF ou no formato original (.docx).
Indique se o arquivo será salvo em um campo do tipo Arquivo do formulário associado ao processo, na aba Anexo do workflow ou se será criado um documento do SoftExpert Documento e associado ao workflow.
Regras de armazenamento:
- Se foi configurada uma marca d'água ou uma assinatura digital, o arquivo será automaticamente convertido para PDF.
- Se foi configurada uma assinatura digital, o arquivo deve ser armazenado no SoftExpert Documento, pois a assinatura eletrônica requer vínculo com um registro do componente.
- Quando o arquivo for armazenado em um campo do tipo Arquivo do formulário, ele não permanecerá vinculado à instância do processo. Para consultá-lo posteriormente, é necessário acessar o registro do formulário.
Inserir variáveis no arquivo modelo
1. Após clicar na opção Ver variáveis disponíveis, localize a informação que deseja inserir no contrato (ex.: Título, Identificador, Prazo, etc.).
2. Clique no botão Copiar da variável correspondente à informação.
3. Abra o modelo de contrato que será utilizado e cole o código copiado na área que será substituída pela informação da variável.
4. Salve o arquivo .docx.
Confira o exemplo abaixo para entender melhor como o texto deve ser editado.
Suponha que o contrato contenha o trecho:
“Este contrato, identificado pelo número ______, terá início em ______ e prazo até ______.”
No modelo, substitua os espaços pelas variáveis:
Este contrato, identificado pelo número {d.wf.identificador}, terá início em {d.wf.dthr_inicio} e prazo até {d.wf.prazo}.
Após a execução do workflow, o contrato será gerado e o sistema fará a substituição automática das variáveis pelos dados reais:
“Este contrato, identificado pelo número 12345, terá início em 08/09/2025 10:30 e prazo até 15/09/2025.”
Repetição automática de informações no documento
Em alguns casos, o arquivo precisa mostrar listas de informações, como vários equipamentos, várias etapas de um processo ou várias pessoas envolvidas.
Para isso, o sistema consegue copiar automaticamente um mesmo trecho do arquivo, preenchendo os dados conforme as informações enviadas pelo formulário ou pelo workflow.
Não é necessário duplicar as linhas manualmente. Basta indicar no modelo do documento onde começa a sequência de informações.
Como o sistema entende que deve repetir um trecho:
A repetição acontece quando o documento possui:
- Um campo com a posição atual ([i]);
- Um campo logo abaixo com a próxima posição ([i+1]).
A primeira linha serve como modelo e a segunda linha serve apenas para que o sistema entenda que existe uma sequência. Portanto, essa segunda linha não aparece no documento final.
Apenas um campo com [i+1] já é suficiente para ativar a repetição automática.
Exemplo 1 — Lista preenchida pelo formulário:
Informações do workflow:
| Equipamentos | Código |
| Notebook | EQ-01 |
| Monitor | EQ-02 |
| Teclado | EQ-03 |
Como montar o arquivo:
| Equipamentos | Código |
| {d.form.equipments[i].name} | {d.form.equipments[i].code} |
| {d.form.equipments[i+1].name} |
O que acontece na prática:
- O sistema usa a primeira linha como padrão.
- Ele repete essa linha para cada item informado.
- A linha com [i+1] serve apenas como referência interna.
- O documento final mostra apenas as linhas preenchidas corretamente.
Resultado gerado:
| Notebook | EQ-01 |
| Monitor | EQ-02 |
| Teclado | EQ-03 |
Exemplo 2 — Etapas vindas do workflow:
Informações do workflow:
| Workflow | Etapa |
| Abertura | Solicitante |
| Análise | Gestor |
| Aprovação | Diretoria |
Como montar o arquivo:
Etapa: {d.workflow.steps[i].title}
Responsável: {d.workflow.steps[i].responsible}
{d.workflow.steps[i+1].title}
Resultado gerado:
Etapa: Abertura
Responsável: Solicitante
Etapa: Análise
Responsável: Gestor
Etapa: Aprovação
Responsável: Diretoria
Exemplo 3 — Informações agrupadas (listas dentro de listas)
Algumas informações vêm organizadas em grupos, como projetos com várias atividades.
O sistema entende automaticamente quando precisa repetir cada parte.
Informações do workflow:
| Workflow | Projetos |
| Nome: Projeto Alpha | |
| Atividades: | |
| Planejamento | 40 horas |
| Execução | 120 horas |
| Workflow | Projetos |
| Nome: Projeto Beta | |
| Atividades: | |
| Levantamento | 32 horas |
| Entrega | 24 horas |
Como montar o arquivo:
Projeto: {d.workflow.projects[i].name}
Atividades:
{d.workflow.projects[i].activities[i].label} - {d.workflow.projects[i].activities[i].hours}h
{d.workflow.projects[i].activities[i+1].label}
{d.workflow.projects[i+1].name}
Como o sistema interpreta:
- Primeiro, ele repete os projetos.
- Dentro de cada projeto, ele repete as atividades.
- Não é necessário copiar tudo novamente, apenas indicar a próxima informação.
Exemplo 4 — Tabela com linhas e colunas automáticas
Também é possível preencher tabelas completas automaticamente.
Informações do workflow:
| Workflow | |
| Colunas | |
| Nome | Jan |
| Nome | Fev |
| Nome | Mar |
| Filas: | |
| Valores: | 10, 20, 30 |
| Valores: | 15, 25, 35 |
Como montar o arquivo:
{d.workflow.columns[i].name} {d.workflow.columns[i+1].name}
{d.workflow.rows[i].values[i]} {d.workflow.rows[i].values[i+1]}
{d.workflow.rows[i+1].values[i]}
Informações importantes:
- Use sempre [i] e [i+1] no mesmo conjunto de informações.
- Apenas um campo com [i+1] já ativa a repetição.
- Não é necessário duplicar textos ou tabelas manualmente.
- A linha com [i+1] não aparece no documento final.
Para formatação de campos de data, data e hora, e decimal:
Siga o formato do exemplo abaixo:
Data:
{d.form.tabela.campodata:formatD('DD/MM/YYYY')}
Outros modelos que podem ser utilizados:
'20160131':formatD('L') // "01/31/2016"
'20160131':formatD('LL') // "January 31, 2016"
'20160131':formatD('LLLL') // "Sunday, January 31, 2016 12:00 AM"
'20160131':formatD('dddd') // "Sunday"
Data e hora:
{d.form.tabela.campodata:formatD('DD/MM/YYYY HH:mm:ss')}
Outros modelos que podem ser utilizados:
'2017-05-10T15:57:23.769561+03:00':formatD('LLLL') // "mercredi 10 mai 2017
14:57" '2017-05-10 15:57:23.769561+03:00':formatD('LLLL') // "mercredi 10 mai
2017 14:57" '20160131':formatD('LLLL') // "dimanche 31 janvier 2016 00:00"
'20160131':formatD('dddd') // "dimanche"
Decimal:
{d.form.tabela.campodc'10.456,00':formatN()}
Informações importantes:
- O modelo de contrato deve, obrigatoriamente, estar no formato .docx.
- As variáveis exibidas variam conforme os dados da instância e do formulário associado ao processo.
- Use as variáveis exatamente como aparecem na lista, incluindo as chaves {}.
- Insira quantas variáveis desejar no documento, mesmo que seja necessário repeti-las.
- Caso alguma variável não possua valor, o campo correspondente ficará vazio no documento, exibindo a variável exatamente como configurada, sem realizar a substituição adequada.
- O campo Tipo de dado ajuda a entender o formato da informação (texto, data, ícone + texto, etc.).
- As variáveis do tipo Formulário sempre virão com o padrão abaixo:
◦ Tabela > Relacionamento > Campo.
◦ Tabela > Relacionamento com a tabela da listagem > Coluna da listagem.
◦ Por exemplo, a variável {d.form.apr.arquivo} representa um dado do tipo arquivo, com o campo arquivo, e a tabela apr.
Verificar serviço
Utilize o passo a passo descrito abaixo para verificar se o serviço está rodando corretamente:
1. Acesse o menu SoftExpert Workflow > Configuração > Parâmetros gerais (WF019).
2. Selecione a aba Serviços.
3. Clique no botão Testar conexão.
Se o sistema detectar um erro na conexão, entre em contato com o time de Engine da SoftExpert. O não funcionamento do serviço impede a utilização dos recursos do Carbone pelo sistema.
Conclusão
As variáveis são a forma mais prática e segura de gerar contratos dinâmicos no SoftExpert Suite, garantindo agilidade, padronização e menos erros no dia a dia.
Com todas as configurações feitas, ao instanciar o processo no SoftExpert Workflow, o arquivo será gerado automaticamente utilizando as variáveis.