> For the complete documentation index, see [llms.txt](https://help.hyperflow.global/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/acao/variavel-de-protocolo.md).

# Variável de protocolo

O módulo **Variável de Protocolo** permite que você defina ou atualize variáveis personalizadas diretamente no protocolo de atendimento durante o fluxo do chatbot. Com ele, você registra informações relevantes da conversa — como identificadores de cliente, departamento ou prioridade — e as vincula ao protocolo de serviço em andamento.

## 🗂️ Como acessar

1. No menu lateral, clique em **Gerenciamento de aplicativos**.
2. Em seguida, clique em **Fluxos**.
3. Abra o fluxo desejado ou crie um novo.
4. No canvas do Hyperflow Integrações, clique no botão **+** para adicionar um novo módulo.
5. Localize e selecione **Variável de Protocolo** na lista de módulos disponíveis.

## 🧩 Conhecendo o módulo

### 📌 Visão geral no canvas

Após adicionar o módulo ao fluxo, ele aparece como um bloco no canvas. Quando variáveis já estiverem configuradas, o bloco exibe o nome e o valor de cada variável diretamente na visualização. Quando nenhuma variável estiver configurada, o bloco mostra apenas o ícone do módulo.

O módulo possui duas saídas:

| Saída       | Cor      | Quando ocorre                                       |
| ----------- | -------- | --------------------------------------------------- |
| **Sucesso** | Verde    | As variáveis foram aplicadas com êxito ao protocolo |
| **Erro**    | Vermelho | Ocorreu um problema ao tentar aplicar as variáveis  |

Conecte cada saída ao próximo módulo de acordo com o comportamento esperado no seu fluxo.

### ⚙️ Painel de configuração

Para abrir o painel de configuração, clique duas vezes no módulo ou clique no ícone de engrenagem que aparece ao passar o mouse sobre ele.

{% hint style="warning" %}
**Antes de usar este módulo**, as variáveis de protocolo precisam estar cadastradas nas configurações do **Hyperflow Conversas**. Se o painel exibir a mensagem "Nenhuma variável cadastrada", acesse **Hyperflow Conversas > Configurações > Parâmetros** para registrar as variáveis. Depois, volte para o fluxo e configure o módulo.
{% endhint %}

### 1️⃣ Adicionar uma variável

#### 🎯 Propósito

Vincular uma variável de protocolo cadastrada no Hyperflow Conversas ao fluxo, atribuindo um valor que será gravado no protocolo de atendimento da conversa ativa.

#### ✅ Como fazer na tela

1. No painel de configuração, clique em **+ Adicionar variável**.
2. Uma nova linha aparece com dois campos: **Variável** e **Valor**.
3. No campo **Variável**, clique para abrir o menu suspenso e selecione a variável desejada na lista.
4. No campo **Valor**, digite o valor que será atribuído. Você pode:
   * Digitar um texto fixo (ex: `alta`).
   * Usar referências dinâmicas com a sintaxe `{{nome.da.variavel}}` para puxar valores de outras variáveis do fluxo (ex: `{{user.id}}`).
5. Repita os passos acima para cada variável que precisar configurar.
6. Clique em **Salvar alterações** para confirmar.

#### 📌 Resultado esperado

O módulo passa a exibir no canvas o nome e o valor de cada variável configurada. Ao ser executado no fluxo, ele grava essas informações no protocolo de atendimento e segue pela saída **Sucesso**.

### 2️⃣ Usar valores dinâmicos (referências de variáveis)

#### 🎯 Propósito

Preencher o valor de uma variável de protocolo com informações coletadas durante o fluxo — como o identificador do usuário, uma resposta de formulário ou o resultado de uma integração.

#### ✅ Como fazer na tela

1. No campo **Valor**, comece a digitar `{{`.
2. Um menu de sugestões aparece com as variáveis disponíveis no fluxo.
3. Selecione a variável desejada na lista de sugestões.
4. O campo preenche automaticamente com a referência (ex: `{{user.id}}`).
5. Clique em **Salvar alterações**.

#### 📌 Resultado esperado

No momento em que o módulo for executado durante a conversa, o valor real da variável referenciada é buscado e gravado no protocolo — tornando o registro dinâmico e personalizado para cada usuário.

### 3️⃣ Remover uma variável

#### 🎯 Propósito

Retirar uma variável que não é mais necessária na configuração do módulo.

#### ✅ Como fazer na tela

1. Na linha da variável que deseja remover, clique no ícone **X** à direita dos campos.
2. A linha é removida imediatamente.
3. Clique em **Salvar alterações** para confirmar.

#### 📌 Resultado esperado

A variável deixa de fazer parte da configuração do módulo e não é mais aplicada ao protocolo quando o fluxo é executado.

### ⚠️ Estado sem variáveis cadastradas

Se nenhuma variável de protocolo estiver registrada no Hyperflow Conversas, o painel de configuração exibe uma mensagem informando que não há variáveis disponíveis.

{% hint style="warning" %}
Nesse caso, acesse **Hyperflow Conversas > Configurações > Parâmetros** para cadastrar as variáveis de protocolo. Depois, volte ao fluxo para configurar este módulo.
{% endhint %}

## 💡 Dicas úteis

* **Evite duplicatas:** a mesma variável não pode ser selecionada duas vezes no mesmo módulo. Cada variável aparece apenas uma vez por configuração.
* **Combine com outros módulos:** use este módulo após coletar dados do usuário — por exemplo, depois de um formulário ou de uma integração — para registrar as informações no protocolo em tempo real.
* **Verifique as saídas:** sempre conecte a saída **Erro** a um módulo de tratamento para garantir que o fluxo continue caso algo dê errado ao aplicar as variáveis.
* **Renomeie o módulo:** clique no título do módulo no painel de configuração para dar um nome descritivo, como "Registrar dados do cliente". Isso facilita a leitura do fluxo.

## 🧪 Caso de uso

**Objetivo:** Registrar automaticamente o identificador do cliente e o departamento de atendimento no protocolo assim que o chatbot identificar o usuário.

**Configuração principal:**

| Variável      | Valor                              |
| ------------- | ---------------------------------- |
| ID do cliente | `{{user.id}}`                      |
| Departamento  | `{{flow.departamentoSelecionado}}` |

**Como funciona no fluxo:**

1. O chatbot coleta o identificador do usuário e o departamento escolhido em etapas anteriores do fluxo.
2. O módulo **Variável de Protocolo** é executado e grava esses valores no protocolo de atendimento.
3. Quando um agente humano assume a conversa, ele já visualiza o ID do cliente e o departamento diretamente no protocolo — sem precisar perguntar novamente.

**Resultado esperado:** O protocolo de atendimento fica enriquecido com informações coletadas automaticamente pelo bot, reduzindo o esforço do agente e agilizando o atendimento.

## 📝 Resumo

* O módulo **Variável de Protocolo** grava informações personalizadas diretamente no protocolo de atendimento da conversa ativa.
* As variáveis disponíveis precisam ser cadastradas previamente em **Hyperflow Conversas > Configurações > Parâmetros**.
* Você pode combinar textos fixos e referências dinâmicas (`{{variavel}}`) no campo de valor.
* O módulo possui saídas de **Sucesso** e **Erro** — conecte ambas para garantir um fluxo robusto.
* Cada variável só pode ser selecionada uma vez por configuração do módulo.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.hyperflow.global/docs/builder-hyperflow/gerenciamento-de-aplicativos/fluxos/acao/variavel-de-protocolo.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.