Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Instalação e Configuração
  2. Guia API Parâmetros
  3. Guia API Serviço
  4. Guia SGBD

1. Instalação e Configuração

...

  • A tela da aplicação possui duas abas "API" e a "SGBD". Cada uma delas serão melhor descritas nos tópicos abaixo.
  • Recomendado sempre executar a API como "Administrador". Caso contrário, não terá sucesso na tentativa de instalação como serviço do Windows.

...

2. Guia API

...

2.1. Guia API - Parâmetros de Recebimento

...


Image Added


...

  • Porta: Campo destinado à digitação da porta de conexão que será utilizada pelo APP ou aplicações terceiras. Por padrão, a porta sugerida será: 9000. Porém, pode ser alterada a critério do Hotel.

...

    • Garantir que a porta digitada e conectada, esteja liberada para uso no firewall e regras de segurança.
  • Conectar: Clicar para tornar disponível a porta digitada para conexão à API .
  • Desconectar: Clicar para desconectar a porta.
    • Após esta ação, o APP ou aplicações terceiras não conseguirá acessar a API.

Image Removed

...

2.2. Guia API - Serviço do Windows

...

Image Added


  • Este recurso tem como função instalar/desinstalara API como um serviço no Windows.
  • Permitirá a execução dos serviços, em segundo plano, sem a necessidade de deixa-los abertos.
  • Quando esta opção for utilizada pelo hotel, os serviços serão executados automaticamente caso o servidor de aplicação seja desligado e ligado novamente.


Informações
  • Após a instalação, como Serviços do Windows, faz-se necessário fechar as APIs, acessar o serviço do Windows e iniciá-las. Importante garantir que estejam configurados para iniciar automaticamente.

...


32.2.1. Instalar: Clicar para instalar o serviço

...

Informações
  • Para que este processo tenha sucesso, o arquivo deve ser executado como administrador.
  • Ao final, não será exibida mensagem informando o termino término do processo.
  • O processo de instalação será rápido, e para garanti-lo, acesse o serviço do Windows.

O vídeo abaixo explica o processo para instalar os serviços.

Image Removed


Será exibido no vídeo, a seguir, como instalar uma API como serviço do Windows:

O que será exibido?

  • Execução da aplicação como administrador e instalação da API.
  • Evidência na tela de serviço do Windows, com a instalação da aplicação.
  • Evidência da inicialização do serviço, dentro da tela de serviço do Windows.
  • Evidência da parametrização do início automático, na tela de propriedades do serviço, dentro da tela de serviços do Windows.

Image Added

...


2.2.2. 3.2 Desinstalar: Clicar para desinstalar o serviço

...


Informações
  • Para que este processo tenha sucesso, o arquivo deve ser executado como administrador.
  • Ao final, não será exibida mensagem informando o termino do processo.
  • O processo de instalação será rápido, e para garanti-lo, acesse o serviço do Windows.

O vídeo abaixo explica o processo para desinstalar os serviços.

Image Removed


Será exibido no vídeo, a seguir, como desinstalar a API do serviço do Windows:

O que será exibido?

  • Execução da aplicação como administrador e instalação da API.
  • Evidência na tela de serviço do Windows, com a instalação da aplicação.
  • Evidência da paralização do serviço, dentro da tela de serviço do Windows.
  • Evidência da ação de clicar no botão de desinstalar em cada API.
  • Evidência de que na tela do serviço do Windows, os serviços foram desinstalados.

Image AddedImage Removed


...

3. Guia SGBD

...

Esta parte é destinada a inserção de dados reservados a conexão direta Disponibilizada para configuração da conexão com o banco de dados sendo ele: Oracle ou SQL Server. 

Image RemovedImage Added

...


3.1. Gerenciador de Conexão

...

4.1 Campos para preenchimento, informações sobre a base de dados.

Image Removed

...

/ Driver

...

  • Preencha os dados de acordo com o banco de dados utilizado.
  • O campo host será preenchido somente quando o banco de dados for SQL Server.
  • Para banco de dados Oracle, a API utilizará as configurações do TNS do Oracle Client instalado.
  • O dado informado no campo usuário e senha, vai variar de acordo com a opção Usuário Fixo ou Usuário

...

4.2 Driver 

Oracle: Escolha da plataforma de banco de dados, Oracle.

SQL Server: Escolha da plataforma de banco de dados, SQL Server.

...

  • Banco

...

Image Removed

...

  • .
  • Ao clicar no botão Testar Conexão, a API gravará as informações digitadas em um arquivo <ini> que será utilizado sempre que a API estiver em execução.

...


43.1.2.1 Qual  Qual a diferença entre a opção Usuário Fixo e Usuário Banco. Image Removed

Algumas APIs disponibilizam a opção Usuário Banco, além da opção Usuário Fixo. E qual a diferença entre uma opção e outra?

...

Na prática:

  • Quando a decisão for utilizar a opção Usuário Fixo, o usuário e senha informado nesses campos, deve ser cadastrados primeiro no VHF e vinculado a um grupo de usuárioestar cadastrado em algum módulo dos produtos TOTVS Hotelaria.
  • Quando a decisão for utilizar a opção Usuário Banco, o usuário e senha será o mesmo utilizado para acessar o banco de dados. Caso o cliente não queria disponibilizar o usuário padrão do banco, pode ser criado um usuário específico para a API.

...