Skip to content

Commit

Permalink
Documentação
Browse files Browse the repository at this point in the history
  • Loading branch information
@brodao2
brodao2 committed Jun 3, 2024
1 parent 79a374d commit 2e449c1
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 31 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Foi adicionado a possibilidade de passar parâmetros para o navegador a ser util
Em estruturas sem a devida finalização, p.e. `class` e `end class`, poderia gerar lista de símbolos (visão _Outline_) incorreta e/ou gerar um erro no log.
Foi adicionado tratamento para esses blocos, de forma a evitar a ocorrência.

#### Validações chave TDS [#1238](https://github.com/totvs/tds-vscode/issues/1238)

Ajuste na validação das chaves TDS.

## Versão [2.0.7]

### Correções
Expand Down
63 changes: 32 additions & 31 deletions docs/servers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Pode-se acessá-lo acionando o ícone semelhante a uma engrenagem.

![Edit file server](./gifs/serversEditFile.gif)

## Estrutura do arquivo _servers.json_
## Estrutura do arquivo *servers.json*

> Recomenda-se que a edição seja efetuada com *nenhum* servidor conectado/selecionado.
> Faça um cópia de segurança antes. Modificações erradas podem inviabilizar seu uso ou mesmo da extensão.
Expand Down Expand Up @@ -89,35 +89,35 @@ Pode-se acessá-lo acionando o ícone semelhante a uma engrenagem.
| Chave | Descrição/uso |
| --------------------- | --------------------------------------------------------------------------------------- |
| `version` | Versão do arquivo. Não editar. |
| `includes ` | Lista de pastas global para busca de arquivos de definição. |
| `includes` | Lista de pastas global para busca de arquivos de definição. |
| | Utilizada quando não informada na definição do servidor e para o [linter](docs/linter). |
| `permissions ` | Lista de permissões. |
| `permissions` | Lista de permissões. |
| `authorizationtoken` | Chave de compilação com as permissões. |
| `configurations ` | Configurações de servidores registrados para uso. |
| `id ` | Identificação única, gerada no momento de seu registro. |
| `type ` | Tipo do servidor, podem ser: |
| | - _totvs_server_protheus_, para servidores com suporte a Adv/PL. (versão ) |
| | - _totvs_server_logix_, para servidores com suporte a Adv/PL e 4GL. |
| | - _totvs_server_totvstec_, para servidores com suporte a Adv/PL e 4GL, versão iqual ao superior 7.00.210324P (*Harpia*) . |
| `name ` | Identificação do servidor para humanos. |
| `port ` | Porta de conexão. |
| `address ` | Endereço IP ou nome da estação do servidor. |
| `buildVersion ` | Versão do servidor. Valor obtido automaticamente. |
| `secure ` | Conexão segura (SSL) ou não. Valor obtido automaticamente. |
| `includes ` | Lista de pastas para busca de arquivos de definição. |
| ` ` | Se não informada utilizará a lista padrão. |
| `environments ` | Ambientes acessados. |
| `username ` | Último usuário utilizado na conexão. |
| `environment ` | Último ambiente utilizado na conexão. |
| `token ` | Código de acesso para reconexão. Valor obtido automaticamente. |
| `savedTokens ` | Listas de código de acesso, associados a um servidor e ambientes. |
| `configurations` | Configurações de servidores registrados para uso. |
| `id` | Identificação única, gerada no momento de seu registro. |
| `type` | Tipo do servidor, podem ser: |
| | - *totvs_server_protheus*, para servidores com suporte a Adv/PL. (versão ) |
| | - *totvs_server_logix*, para servidores com suporte a Adv/PL e 4GL. |
| | - *totvs_server_totvstec*, para servidores com suporte a Adv/PL e 4GL, versão iqual ao superior 7.00.210324P (*Harpia*) . |
| `name` | Identificação do servidor para humanos. |
| `port` | Porta de conexão. |
| `address` | Endereço IP ou nome da estação do servidor. |
| `buildVersion` | Versão do servidor. Valor obtido automaticamente. |
| `secure` | Conexão segura (SSL) ou não. Valor obtido automaticamente. |
| `includes` | Lista de pastas para busca de arquivos de definição. |
| `` | Se não informada utilizará a lista padrão. |
| `environments` | Ambientes acessados. |
| `username` | Último usuário utilizado na conexão. |
| `environment` | Último ambiente utilizado na conexão. |
| `token` | Código de acesso para reconexão. Valor obtido automaticamente. |
| `savedTokens` | Listas de código de acesso, associados a um servidor e ambientes. |
| | Valores obtidos automaticamente. |
| | \<id>:\<ambiente> |
| | id: identificaão do servidor |
| | token: código de acesso |
| `lastConnectedServer` | Último servidor utilizado e que será reconectado na próxima sessão de forma automática. |

## Local de gravação de _servers.json_
## Local de gravação de *servers.json*

Por padrão, o arquivo com os registros de servidores é armazenado no arquivo `_servers.json_`, na área do usuário conforme o sistema operacional.

Expand All @@ -129,19 +129,19 @@ Caso deseje ter o registro de servidores por área de trabalho, ative a opção

![Workspace Server Config](./images/workspaceServerConfig.png)

Ou use a troca rápida disponível na barra de _status_.
Ou use a troca rápida disponível na barra de *status*.

![Workspace Server Config](./gifs/toggleSaveLocation.gif)

> A troca rápida aplica-se somente a área de trabalho corrente e se sobrepoem a configuração padrão ou por usuário. Detalhes em [User and Workspace Settings](https://code.visualstudio.com/docs/getstarted/settings).
## Sistema de Privilégios

O **TDS-VSCode**, suporta um sistema simples de privilégios, baseada em configuração efetuada no arquivo _appServer.ini_, podendo-se configurar privilégios para determinadas operações e estações, através da adição de chaves na sessão `[TDS]`.
O **TDS-VSCode**, suporta um sistema simples de privilégios, baseada em configuração efetuada no arquivo *appServer.ini*, podendo-se configurar privilégios para determinadas operações e estações, através da adição de chaves na sessão `[TDS]`.

> Quando a conexão é local (_localhost_), não há restrições (sessão `[TDS]` é ignorada).
> Quando a conexão é local (*localhost*), não há restrições (sessão `[TDS]` é ignorada).
> Modificações na sessão `[TDS]` requer **reconexão** do _VS-Code_.
> Modificações na sessão `[TDS]` requer **reconexão** do *VS-Code*.
> Para manter o mesmo comportamento de ambientes com versões mais antigas, todas as operações vem liberadas por padrão na ausência da sessão `[TDS]` ou da chave da operação.
Expand All @@ -160,19 +160,20 @@ EnableStopServer=<IP/name list>
AllowApplyTemplate=<IP/name list>

```

| Chave | Permissão |
| ------------------------ | ----------------------------------------- |
| AllowApplyPatch | Aplicar pacotes de atualização (_patchs_) |
| AllowBuildPatch | Gerar pacotes de atualização (_patchs_) |
| AllowApplyPatch | Aplicar pacotes de atualização (*patchs*) |
| AllowBuildPatch | Gerar pacotes de atualização (*patchs*) |
| AllowCompile | Compilar fontes e recursos |
| AllowMonitor | Acesso ao monitor de conexões |
| EnableDisconnectUser | Desconectar usuários |
| EnableSendMessage | Enviar mensagens |
| EnableBlockNewConnection | Bloquear novas conexões |
| EnableStopServer | Encerrar o _appServer_ |
| EnableStopServer | Encerrar o *appServer* |
| AllowApplyTemplate | Aplicar pacotes de amostras (\*.tpl) |

- `<IP/name>` é a lista de estações com o privilégio liberado, identificadas pelo seu endereço IP ou nome (_host name_) e separadas por `,` (vírgula).
- `<IP/name list>` é a lista de estações com o privilégio liberado, identificadas pelo seu endereço IP ou nome (*host name*) e separadas por `,` (vírgula).

> Para liberar o privilégio a qualquer estação, coloque `*` (valor padrão).
Expand Down Expand Up @@ -202,4 +203,4 @@ Neste exemplo, temos:

![My privileges](./images/my-privileges.png)

Passando o ponteiro do _mouse_ sobre a indicação de servidor/ambiente selecionado (barra de status), lhe será apresentado os privilégios que lhe foram concedidos.
Passando o ponteiro do *mouse* sobre a indicação de servidor/ambiente selecionado (barra de status), lhe será apresentado os privilégios que lhe foram concedidos.

0 comments on commit 2e449c1

Please sign in to comment.