Mudanças entre as edições de "INSTALACAO VRFICHA API"

De VRWiki
Linha 56: Linha 56:
 
==<b>IMPRESSÃO DAS FICHAS</b>==
 
==<b>IMPRESSÃO DAS FICHAS</b>==
 
* Para realizar a impressão das fichas, é necessário que o <b>VRFichaMobileImpressao</b> esteja sendo executado no servidor e conectado ao mesmo serviço do RabbitMQ em que a API do VRFicha Mobile está, pois ele irá consumir a fila do RabbitMQ e imprimir as fichas na impressora configurada no VRFicha. Você pode encontrar como configura-lo [[Manual do Sistema VR Ficha Mobile Impressao|clicando aqui]]
 
* Para realizar a impressão das fichas, é necessário que o <b>VRFichaMobileImpressao</b> esteja sendo executado no servidor e conectado ao mesmo serviço do RabbitMQ em que a API do VRFicha Mobile está, pois ele irá consumir a fila do RabbitMQ e imprimir as fichas na impressora configurada no VRFicha. Você pode encontrar como configura-lo [[Manual do Sistema VR Ficha Mobile Impressao|clicando aqui]]
 +
 +
==<b>CATRACAS</b>==
 +
* A aplicação VRFicha API gera arquivos XML para integração com catracas dos tipos Acesso e Blantech
 +
* Quando executada em container Docker, a aplicação grava os arquivos nos diretórios:
 +
<b>Catraca Acesso</b>
 +
<pre style="color: silver; background: black;">
 +
/VRFichaAPI/acesso
 +
</pre>
 +
<b>Catraca Blantech</b>
 +
<pre style="color: silver; background: black;">
 +
/VRFichaAPI/blantech
 +
</pre>
 +
 +
Para que os arquivos sejam disponibilizados em uma pasta compartilhada da rede, recomenda-se:
 +
 +
1. Montar o compartilhamento SMB/Samba no sistema operacional host.
 +
2. Configurar um volume no Docker para mapear o diretório compartilhado para dentro do container.
 +
 +
===<b>1. Montando um compartilhamento de rede no host</b>===
 +
* Cenário
 +
Considere um compartilhamento disponível na rede:
 +
<pre>\\192.168.1.100\ficha_entrada</pre>
 +
ou
 +
<pre>\\SERVIDOR\ficha_entrada</pre>
 +
 +
O servidor pode ser:
 +
* Um computador Windows;
 +
* Um servidor Linux utilizando Samba;
 +
* Qualquer dispositivo que disponibilize compartilhamentos SMB.

Edição das 19h36min de 22 de junho de 2026

REQUISITOS MÍNIMOS

Para que o VR Ficha API funcione corretamente de maneira consistente é necessário ter um computador com esta configuração ou superior:

  • VRUbuntu 20.04.0-1 (No Windows, utilizar o WSL)
  • Processador: i3 (5ª geração +) ou equivalente
  • Memória RAM: 8 GB
  • Disco: 80 GB
  • Docker instalado

INSTALAÇÃO

  • Certifique-se de que as configurações do VR Ubuntu foram todas executadas neste link
  • Certifique-se de que o Docker está instalando no sistema operacional na versão mais recente.
  • Faça o download do arquivo docker-compose-vrfichaapi.yml clicando aqui
  • Se o cliente já possuir o VR Service Manager rodando, o RabbitMQ do Service Manager pode ser utilizado, caso contrário, baixe o arquivo docker-compose-rabbitmq.yml clicando aqui para subir o sistema de mensageria no servidor onde ficará o VR Ficha API.
  • No arquivo docker-compose-vrfichaapi.yml é configurado a porta de comunicação com a API, a conexão com o banco de dados e a conexão com o RabbitMQ. (Obs.: A conexão com o RabbitMQ configurada tem que ser a mesma no serviço de impressão dos pedidos, para que este funcione corretamente)
services:
  vrficha-api:
    image: vrsoftbr/vrfichaapi:4.1.10
    ports:
      - "9015:9015"
    environment:
      - TZ=GMT-3
      - PORT=9015
      - DATABASE_IP=
      - DATABASE_PORTA=
      - DATABASE_NOME=
      - DATABASE_USUARIO=
      - DATABASE_SENHA=
      - SYSTEM_NUMEROLOJA=
      - RABBITMQ_IP=
      - RABBITMQ_PORTA=5672
      - RABBITMQ_USUARIO=vr
      - RABBITMQ_SENHA=vr!RbtMQ
    networks:
      - vr-network

networks:
  vr-network:
    external: true
  • Você deve preencher corretamente os dados de conexão com o banco, o numero da loja e os dados de conexão com o RabbitMQ. Não é mais utilizado vr.properties. A configuração é feita diretamente no arquivo de compose do docker.
  • Caso seja necessário alterar a porta, alterar em environment o valor de PORT, e também alterar as portas em ports

INICIALIZAÇÃO

  • Para iniciar a API, basta executar este comando, passando na flag -f o nome do arquivo yml (Executar comando no mesmo diretório onde o arquivo está)
docker compose -f docker-compose-vrfichaapi.yml up -d

Obs: Será necessário estar autenticado no docker, pois a imagem é privada. Caso não esteja, executar o comando docker login e informar as credenciais

  • Caso seja necessário subir o RabbitMQ, executar o docker compose no arquivo do RabbitMQ também
docker compose -f docker-compose-rabbitmq.yml up -d

IMPRESSÃO DAS FICHAS

  • Para realizar a impressão das fichas, é necessário que o VRFichaMobileImpressao esteja sendo executado no servidor e conectado ao mesmo serviço do RabbitMQ em que a API do VRFicha Mobile está, pois ele irá consumir a fila do RabbitMQ e imprimir as fichas na impressora configurada no VRFicha. Você pode encontrar como configura-lo clicando aqui

CATRACAS

  • A aplicação VRFicha API gera arquivos XML para integração com catracas dos tipos Acesso e Blantech
  • Quando executada em container Docker, a aplicação grava os arquivos nos diretórios:

Catraca Acesso

/VRFichaAPI/acesso

Catraca Blantech

/VRFichaAPI/blantech

Para que os arquivos sejam disponibilizados em uma pasta compartilhada da rede, recomenda-se:

1. Montar o compartilhamento SMB/Samba no sistema operacional host. 2. Configurar um volume no Docker para mapear o diretório compartilhado para dentro do container.

1. Montando um compartilhamento de rede no host

  • Cenário

Considere um compartilhamento disponível na rede:

\\192.168.1.100\ficha_entrada

ou

\\SERVIDOR\ficha_entrada

O servidor pode ser:

  • Um computador Windows;
  • Um servidor Linux utilizando Samba;
  • Qualquer dispositivo que disponibilize compartilhamentos SMB.