# Dicionário de dados / banco de dados

## Visão geral

**O dicionário de dados é acessível exclusivamente para os clientes que adquiriram o produto "Banco de dados de replicação".** Esse produto consistem em um a cópia atualizada do banco de dados com acesso de leitura direto à views do banco de dados, facilitando assim a integração com plataformas de BI e relatórios.  Caso você tenha interesse nesse produto,[ entre em contato com nossa equipe de atendimento. ](/zeev/outras-informacoes/sobre-formas-de-contato.md)

Ao adquirir esse produto, você receberá os dados de conexão ao banco de dados, assim como usuário e senha de conexão.

## Acesso às tabelas

Por motivos de segurança, *compliance* e facilidade, o acesso é disponibilizado à *views* que resumem os principais dados do sistema. O acesso a essas *views* eliminam complexidades inerentes à como o sistema opera.&#x20;

Nem todos os dados do sistema são disponibilizados nas views, mas nos comprometemos a disponibilizar os principais dados relevantes ao seu negócio. Alguns dados não são disponíveis por motivos de segurança, outros por motivos de simplicidade.&#x20;

Se você não encontrou o dado que necessita, [entre em contato com nossa equipe de suporte](/zeev/outras-informacoes/sobre-suporte-tecnico.md), explicando sua necessidade, que avaliaremos com o maior prazer a possibilidade de disponibilizar a informação faltante.

## Views

### wrVW**Users**

**Descrição**: Exibe informações detalhadas sobre os usuários, incluindo status, dados de contato e informações administrativas.

| Nome da Coluna         | Tipo de Dados    | Descrição                             | FK para outra View |
| ---------------------- | ---------------- | ------------------------------------- | ------------------ |
| UserId                 | INT              | Identificador único do usuário        |                    |
| UserUID                | UNIQUEIDENTIFIER | Identificador único global do usuário |                    |
| UserCreatedBy          | INT              | ID do usuário que criou este usuário  | wrVWUsers          |
| UserLogin              | VARCHAR          | Nome de login do usuário              |                    |
| UserFullName           | VARCHAR          | Nome completo do usuário              |                    |
| UserEmail              | VARCHAR          | Email do usuário                      |                    |
| UserDocument           | VARCHAR          | Documento (CPF) do usuário            |                    |
| UserIdentification     | VARCHAR          | Identificação interna do usuário      |                    |
| UserMobile             | VARCHAR          | Número de celular do usuário          |                    |
| IsUserActive           | BIT              | Indicador se o usuário está ativo     |                    |
| IsUserBlocked          | BIT              | Indicador se o usuário está bloqueado |                    |
| IsUserAbsent           | BIT              | Indicador se o usuário está ausente   |                    |
| IsUserSuperAdmin       | BIT              | Indicador se o usuário é superadmin   |                    |
| UserLastPasswordChange | DATETIME         | Data da última alteração de senha     |                    |

***

### wrVW**Teams**

**Descrição**: Exibe informações sobre os times da organização, incluindo hierarquia e status.

| Nome da Coluna | Tipo de Dados | Descrição                      | FK para outra View |
| -------------- | ------------- | ------------------------------ | ------------------ |
| TeamId         | INT           | Identificador único do time    |                    |
| TeamName       | VARCHAR       | Nome do time                   |                    |
| TeamParentId   | INT           | Identificador do time pai      | wrVWTeams          |
| IsTeamActive   | BIT           | Indicador se o time está ativo |                    |
| TeamCode       | VARCHAR       | Código de integração do time   |                    |

***

### wrVW**Positions**

**Descrição**: Exibe informações sobre as funções disponíveis na organização.

| Nome da Coluna   | Tipo de Dados | Descrição                        | FK para outra View |
| ---------------- | ------------- | -------------------------------- | ------------------ |
| PositionId       | INT           | Identificador único da função    |                    |
| PositionName     | VARCHAR       | Nome da função                   |                    |
| PositionParentId | INT           | Identificador da função pai      | wrVWPositions      |
| IsPositionActive | BIT           | Indicador se a função está ativa |                    |
| PositionCode     | VARCHAR       | Código de integração da função   |                    |

***

### wrVW**Groups**

**Descrição**: Exibe informações sobre os grupos de permissões configurados no sistema.

| Nome da Coluna   | Tipo de Dados | Descrição                     | FK para outra View |
| ---------------- | ------------- | ----------------------------- | ------------------ |
| GroupId          | INT           | Identificador único do grupo  |                    |
| GroupName        | VARCHAR       | Nome do grupo                 |                    |
| GroupDescription | VARCHAR       | Descrição do grupo            |                    |
| GroupCode        | VARCHAR       | Código de integração do grupo |                    |

***

### wrVW**UserTeamsAndPositions**

**Descrição**: Exibe as associações entre usuários, times e posições.

| Nome da Coluna     | Tipo de Dados | Descrição                         | FK para outra View |
| ------------------ | ------------- | --------------------------------- | ------------------ |
| UserTeamPositionId | INT           | Identificador único da associação |                    |
| UserId             | INT           | Identificador do usuário          | wrVWUsers          |
| TeamId             | INT           | Identificador do time             | wrVWTeams          |
| PositionId         | INT           | Identificador da função           | wrVWPositions      |

***

### wrVW**UserGroups**

**Descrição**: Exibe a associação entre usuários e grupos.

| Nome da Coluna | Tipo de Dados | Descrição                         | FK para outra View |
| -------------- | ------------- | --------------------------------- | ------------------ |
| UserGroupId    | INT           | Identificador único da associação |                    |
| UserId         | INT           | Identificador do usuário          | wrVWUsers          |
| GroupId        | INT           | Identificador do grupo            | wrVWGroups         |

***

### wrVW**Apps**

**Descrição**: Exibe informações sobre os aplicativos configurados no sistema.

| Nome da Coluna                | Tipo de Dados    | Descrição                                         | FK para outra View |
| ----------------------------- | ---------------- | ------------------------------------------------- | ------------------ |
| AppId                         | INT              | Identificador único do aplicativo                 |                    |
| AppName                       | VARCHAR          | Nome do aplicativo                                |                    |
| AppVersion                    | INT              | Versão do aplicativo                              |                    |
| AppDescription                | VARCHAR          | Descrição do aplicativo                           |                    |
| AppParentId                   | INT              | Identificador do aplicativo pai (versão anterior) | wrVWApps           |
| TeamId                        | INT              | Identificador do time associado                   | wrVWTeams          |
| AppExecutionMode              | VARCHAR          | Modo de execução do aplicativo                    |                    |
| IsAppMobile                   | BIT              | Indicador se o aplicativo suporta mobile          |                    |
| IsAppDeployAnonymousShareLink | BIT              | Indicador se suporta link de compartilhamento     |                    |
| IsAppDeploy                   | BIT              | Indicador se o aplicativo está publicado          |                    |
| AppUID                        | UNIQUEIDENTIFIER | Identificador único global do aplicativo          |                    |

### wrVW**TaskTypes**

**Descrição**: Exibe os tipos de tarefas disponíveis no sistema.

| Nome da Coluna | Tipo de Dados | Descrição                             | FK para outra View |
| -------------- | ------------- | ------------------------------------- | ------------------ |
| TaskTypeId     | INT           | Identificador único do tipo de tarefa |                    |
| TaskTypeName   | VARCHAR       | Nome do tipo de tarefa                |                    |

***

### wrVW**Tasks**

**Descrição**: Exibe informações sobre as tarefas criadas nos aplicativos.

| Nome da Coluna | Tipo de Dados | Descrição                       | FK para outra View |
| -------------- | ------------- | ------------------------------- | ------------------ |
| TaskId         | INT           | Identificador único da tarefa   |                    |
| AppId          | INT           | Identificador do aplicativo     | wrVWApps           |
| TaskDesc       | VARCHAR       | Descrição da tarefa             |                    |
| TaskTypeId     | INT           | Identificador do tipo de tarefa | wrVWTaskTypes      |
| TaskName       | VARCHAR       | Nome da tarefa                  |                    |

***

### wrVW**AppFormField**

**Descrição**: Exibe os campos configurados nos formulários dos aplicativos.

| Nome da Coluna          | Tipo de Dados | Descrição                                   | FK para outra View |
| ----------------------- | ------------- | ------------------------------------------- | ------------------ |
| AppId                   | INT           | Identificador do aplicativo                 | wrVWApps           |
| FieldId                 | INT           | Identificador único do campo                |                    |
| FieldName               | VARCHAR       | Nome técnico do campo                       |                    |
| FieldLabel              | VARCHAR       | Rótulo visível do campo                     |                    |
| FieldExample            | VARCHAR       | Exemplo de valor para o campo               |                    |
| IsFieldRequired         | BIT           | Indicador se o campo é obrigatório          |                    |
| FieldMaxLength          | INT           | Tamanho máximo permitido para o campo       |                    |
| FieldMinLength          | INT           | Tamanho mínimo permitido para o campo       |                    |
| FieldOrder              | INT           | Ordem de exibição do campo                  |                    |
| IsFieldVisibleOnReports | BIT           | Indicador se o campo aparece nos relatórios |                    |
| IsFieldActive           | BIT           | Indicador se o campo está ativo             |                    |
| FieldTypeId             | INT           | Identificador do tipo do campo              |                    |
| FieldTypeName           | VARCHAR       | Nome do tipo do campo                       |                    |
| FieldTypeMask           | VARCHAR       | Máscara para o tipo do campo                |                    |
| FieldFormatId           | INT           | Identificador do formato do campo           |                    |
| FieldFormat             | VARCHAR       | Nome do formato do campo                    |                    |
| FieldFormatAlias        | VARCHAR       | Alias para o formato do campo               |                    |
| IsFieldFormatInterface  | BIT           | Indicador se o formato é interface          |                    |
| ValidationId            | INT           | Identificador da validação do campo         |                    |
| ValidationName          | VARCHAR       | Nome da validação                           |                    |
| ValidationRegExp        | VARCHAR       | Expressão regular para validação            |                    |
| FieldGroupId            | INT           | Identificador do grupo de campos            |                    |
| FieldGroupName          | VARCHAR       | Nome do grupo de campos                     |                    |
| IsFieldGroupTable       | BIT           | Indicador se o grupo é uma tabela           |                    |
| FieldGroupOrder         | INT           | Ordem do grupo de campos                    |                    |
| IsFieldGroupActive      | BIT           | Indicador se o grupo de campos está ativo   |                    |

***

### wrVW**Instances**

**Descrição**: Exibe informações sobre as instâncias de execução dos aplicativos.

| Nome da Coluna            | Tipo de Dados | Descrição                                   | FK para outra View |
| ------------------------- | ------------- | ------------------------------------------- | ------------------ |
| InstanceId                | INT           | Identificador único da instância            |                    |
| InstanceParentId          | INT           | Identificador da instância pai              | wrVWInstances      |
| InstanceMasterId          | INT           | Identificador da instância principal        | wrVWInstances      |
| AppId                     | INT           | Identificador do aplicativo                 | wrVWApps           |
| ServiceId                 | INT           | Identificador do serviço associado          |                    |
| InstanceStartDate         | DATETIME      | Data de início da instância                 |                    |
| InstanceEndDate           | DATETIME      | Data de término da instância                |                    |
| InstanceResult            | VARCHAR       | Resultado da instância                      |                    |
| IsInstanceActive          | BIT           | Indicador se a instância está ativa         |                    |
| IsInstanceCancelled       | BIT           | Indicador se a instância foi cancelada      |                    |
| IsInstanceSimulation      | BIT           | Indicador se a instância é uma simulação    |                    |
| InstanceLeadtimeInMinutes | FLOAT         | Tempo de execução da instância (em minutos) |                    |
| UserRequesterId           | INT           | Identificador do solicitante                | wrVWUsers          |
| TeamRequesterId           | INT           | Identificador do time solicitante           | wrVWTeams          |
| PositionRequesterId       | INT           | Identificador da função do solicitante      | wrVWPositions      |

***

### wrVW**InstanceTasks**

**Descrição**: Exibe informações sobre as tarefas em andamento ou executadas nas instâncias de aplicativos.

| Nome da Coluna                | Tipo de Dados | Descrição                                  | FK para outra View |
| ----------------------------- | ------------- | ------------------------------------------ | ------------------ |
| InstanceTaskId                | INT           | Identificador único da instância da tarefa |                    |
| InstanceId                    | INT           | Identificador da instância                 | wrVWInstances      |
| InstanceParentId              | INT           | Identificador da instância pai             | wrVWInstances      |
| InstanceMasterId              | INT           | Identificador da instância principal       | wrVWInstances      |
| AppId                         | INT           | Identificador do aplicativo                | wrVWApps           |
| TaskId                        | INT           | Identificador da tarefa                    | wrVWTasks          |
| UserId                        | INT           | Identificador do usuário executor          | wrVWUsers          |
| TaskTypeId                    | INT           | Identificador do tipo da tarefa            | wrVWTaskTypes      |
| IsInstanceTaskActive          | BIT           | Indicador se a tarefa está ativa           |                    |
| InstanceTaskStartDate         | DATETIME      | Data de início da tarefa                   |                    |
| InstanceTaskEndDate           | DATETIME      | Data de término da tarefa                  |                    |
| InstanceTaskResult            | VARCHAR       | Resultado da tarefa                        |                    |
| InstanceTaskLeadtimeInMinutes | FLOAT         | Tempo de execução da tarefa (em minutos)   |                    |
| IsInstanceTaskLate            | BIT           | Indicador se a tarefa está atrasada        |                    |

***

### wrVW**InstanceTaskAssignees**

**Descrição**: Exibe os responsáveis atribuídos às instâncias de tarefas

| Nome da Coluna                  | Tipo de Dados | Descrição                                                               | FK para outra View |
| ------------------------------- | ------------- | ----------------------------------------------------------------------- | ------------------ |
| InstanceTaskAssignmentId        | INT           | Identificador único da atribuição                                       |                    |
| InstanceTaskId                  | INT           | Identificador da tarefa                                                 | wrVWInstanceTasks  |
| InstanceId                      | INT           | Identificador da instância                                              | wrVWInstances      |
| InstanceParentId                | INT           | Identificador da instância pai                                          | wrVWInstances      |
| InstanceMasterId                | INT           | Identificador da instância principal                                    | wrVWInstances      |
| AppId                           | INT           | Identificador do aplicativo                                             | wrVWApps           |
| TaskId                          | INT           | Identificador da tarefa                                                 | wrVWTasks          |
| UserId                          | INT           | Identificador do usuário responsável                                    | wrVWUsers          |
| TaskTypeId                      | INT           | Identificador do tipo da tarefa                                         | wrVWTaskTypes      |
| IsInstanceTaskAssignmentActive  | BIT           | Indicador se a atribuição está ativa                                    |                    |
| InstanceTaskAssignmentExecuted  | BIT           | Indicador se essa atribuição foi responsável pela finalização da tarefa |                    |
| InstanceTaskAssignmentStartDate | DATETIME      | Data de início da atribuição                                            |                    |
| InstanceTaskAssignmentDueDate   | DATETIME      | Data limite de término da atribuição                                    |                    |
| InstanceTaskAssignmentLate      | BIT           | Indicador se a atribuição está atrasada                                 |                    |

### wrVW**InstanceFormValues**

**Descrição**: Exibe os valores dos campos preenchidos nas instâncias de execução.

| Nome da Coluna         | Tipo de Dados | Descrição                               | FK para outra View |
| ---------------------- | ------------- | --------------------------------------- | ------------------ |
| InstanceFormValueId    | INT           | Identificador único do valor preenchido |                    |
| InstanceId             | INT           | Identificador da instância              | wrVWInstances      |
| InstanceParentId       | INT           | Identificador da instância pai          | wrVWInstances      |
| InstanceMasterId       | INT           | Identificador da instância principal    | wrVWInstances      |
| AppId                  | INT           | Identificador do aplicativo             | wrVWApps           |
| FieldId                | INT           | Identificador do campo                  | wrVWAppFormField   |
| InstanceFormValueOrder | INT           | Ordem do valor dentro do formulário     |                    |
| InstanceFormValue      | VARCHAR       | Valor preenchido no campo               |                    |

***

### wrVW**InstanceMessages**

**Descrição**: Exibe as mensagens trocadas dentro das instâncias de execução.

| Nome da Coluna                   | Tipo de Dados | Descrição                                      | FK para outra View |
| -------------------------------- | ------------- | ---------------------------------------------- | ------------------ |
| InstanceMessageId                | INT           | Identificador único da mensagem                |                    |
| InstanceId                       | INT           | Identificador da instância                     | wrVWInstances      |
| InstanceParentId                 | INT           | Identificador da instância pai                 | wrVWInstances      |
| InstanceMasterId                 | INT           | Identificador da instância principal           | wrVWInstances      |
| InstanceTaskId                   | INT           | Identificador da tarefa                        | wrVWInstanceTasks  |
| AppId                            | INT           | Identificador do aplicativo                    | wrVWApps           |
| TaskId                           | INT           | Identificador da tarefa                        | wrVWTasks          |
| UserId                           | INT           | Identificador do usuário autor da mensagem     | wrVWUsers          |
| InstanceMessageDate              | DATETIME      | Data e hora da mensagem                        |                    |
| IsInstanceMessageRequesterCanSee | BIT           | Indicador se o solicitante pode ver a mensagem |                    |
| InstanceMessageContents          | VARCHAR       | Conteúdo da mensagem                           |                    |

***

### wrVW**InstanceFiles**

**Descrição**: Exibe os arquivos associados às instâncias de execução.

{% hint style="info" %}
Atenção! Essa tabela disponibiliza somente metadados dos arquivos. Os arquivos, em si, são armazenados em storage separado, e não podem ser acessados pelo banco de dados.
{% endhint %}

| Nome da Coluna                | Tipo de Dados | Descrição                                     | FK para outra View |
| ----------------------------- | ------------- | --------------------------------------------- | ------------------ |
| InstanceFileId                | INT           | Identificador único do arquivo                |                    |
| InstanceId                    | INT           | Identificador da instância                    | wrVWInstances      |
| InstanceParentId              | INT           | Identificador da instância pai                | wrVWInstances      |
| InstanceMasterId              | INT           | Identificador da instância principal          | wrVWInstances      |
| InstanceTaskId                | INT           | Identificador da tarefa associada             | wrVWInstanceTasks  |
| AppId                         | INT           | Identificador do aplicativo                   | wrVWApps           |
| TaskId                        | INT           | Identificador da tarefa associada             | wrVWTasks          |
| UserId                        | INT           | Identificador do usuário responsável          | wrVWUsers          |
| InstanceFileDate              | DATETIME      | Data de associação do arquivo                 |                    |
| IsInstanceFileRequesterCanSee | BIT           | Indicador se o solicitante pode ver o arquivo |                    |
| InstanceFilePath              | VARCHAR       | Caminho do arquivo                            |                    |
| InstanceFileName              | VARCHAR       | Nome do arquivo                               |                    |
| InstanceFileResume            | VARCHAR       | Resumo ou descrição do arquivo                |                    |
| IsInstanceFileActive          | BIT           | Indicador se o arquivo está ativo             |                    |
| InstanceFileDocType           | VARCHAR       | Tipo de documento associado ao arquivo        |                    |

## Relacionamento

O desenho abaixo é um esquema simplificado do relacionamento entre as *views*.

<figure><img src="/files/LvDcfVidbbhg4ZoAosly" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: 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:

```
GET https://kb.stoque.com.br/zeev/apis/dicionario-de-dados-banco-de-dados.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
