Documentação - Storex Reports - Instalação e Configuração do Banco

Descrição Geral

O Storex Reports é uma ferramenta de criação de relatórios baseados em um banco relacional já existente no ecossistema da impressa, o Storex Reports ele utiliza esse banco relacional para

Requisitos Mínimos da Maquina

• Sistema operacional: Windows server 2012 RC2 ou superior
• Memoria Ram: 8GB
• Espaço em disco: 500GB 

Requisitos para Execução

• Ter o Client OracleDB 11 ou 12 já configurado na maquina. (Caso a maquina onde o Storex Reports esteja sendo instalado seja a mesma maquina do Banco Oracle a instalação do Cliente Oracle e a criação do arquivo tnsnames.ora é DISPENSAVEL) 

  ATENÇÃO caso o Client não esteja instalado

  É necessário verificar a versão do Banco Oracle que o Storex Reports vai efetuar o acoplamento para que seja instalado a versão do Client Oracle correspondente a versão do banco

  • Exemplo : Se o Banco Oracle for na versão 11 deverá ser instalado a versão do client 11 compatível em ambientes x64 bits.

  Obs: Caso a maquina onde o Storex Reports será instalado não tenha o Cliente Oracle Clique aqui ! E siga os passos do documento no link para efetuar a instalação correta

  Caso seja instalado a versão 32x bits do client oracle a aplicação do Storex Reports NÃO VAI FUNCIONAR

• Ter os Interpretadores da linguagem C++ nas versões  2013 - 12.0.30501 e 2013 - 12.0.40660
• Verificar se a maquina onde o Storex Reports será instalado tem as permissões de rede para conexões remotas (verifique com a equipe de Infra do cliente)
  
  

Verificações Básicas Para o Funcionamento Correto da Aplicação

Verificação dos interpretadores da linguagem C++

Para instalação do Client Oracle é necessário que já existam instaladas as versões dos interpretadores da linguagem C++ nas versões: 2013 - 12.0.30501 e 2013 - 12.0.40660

Para verificar siga os passos:

• Busque no menu Iniciar da maquina onde o Client Oracle será instalado por: Control Panel 
• Serão exibidas as opções do Painel de Controle, selecione a opção Programs and Features
  
  
  
• Feito isso serão exibidos todos os programas instalados na maquina busque por:
  • Microsoft Visual C++ 2013 Redistributable (x64) - 12.0.30501
  • Microsoft Visual C++ 2013 Redistributable (x64) - 12.0.40660
  
  
  
• Caso essas versões não estejam instaladas NÃO SERÁ POSSIVEL INSTALAR O CLIENT ORACLE nem executar corretamente o Storex Reports
• Recomentamos que seja instalada o programa jdk-7u80-windows-i586, com a instalação da JDK e JRE que vem nesse instalador serão instalados os interpretadores de C++ necessários, caso queira instalar Clique Aqui e baixe essa versão do instalador Java. 
• Siga a instalação normal da JDK e JRE.

Verificação da versão do Client Oracle que será instalada (Caso exista Necessidade de Instalação)

Caso seja necessário efetuar a instalação do Client Oracle, é necessário verificar qual a distribuição que será instalada para isso:

• Ao efetuar o download do instalador do Client Oracle e ao termino da descompactação do mesmo acesse a pasta client.
• Na raiz da pasta client existe um arquivo com a extensão welcome.html, efetue a abertura do mesmo com o seu navegador.
• Ao abrir o arquivo .html observe abaixo do nome Oracle Database Client Documentation se a distribuição é na versão 64-bit como mostra a imagem
  
  
  
• Caso esteja indicando uma distribuição diferente da versão x64 Bits NÃO PROCIGA COM A INSTALAÇÃO

Adicionando o tnsnames.ora no Clinet OracleBD

Para que o Storex Reportes tenha conexão com o banco relacional é necessário a adesão ou ajuste no arquivo tnsnames.ora, para verificar se o arquivo já existe em sua maquina acesse o diretório "..\Oracle\product\XX.X.X\client_1\network\admin" (onde XX.X.X representa a versão do cliente instalado) caso já exista esse arquivo será necessária a alteração seguindo o exemplo presente no bloco de código mostrado abaixo.

Caso não exista esse arquivo no diretório "..\Oracle\product\XX.X.X\client_1\network\admin" (onde XX.X.X representa a versão do cliente instalado) faça a criação do arquivo tnsnames esse arquivo deverá ter a extensão ".ora", ao efetuar essa criação edite o arquivo copiando o trecho de código informado no bloco de código abaixo e substitua os comentários informando as conexões de seu banco.

# tnsnames.ora Network Configuration File: C:\Oracle\product\10.2.0\client_1\NETWORK\ADMIN\tnsnames.ora
# Generated by Oracle configuration tools.


ORA12C =
  (DESCRIPTION =
    (ADDRESS_LIST =
      (ADDRESS = (PROTOCOL = TCP)(HOST = <\IP-DA-MAQUINA\> )(PORT = 1521)) <\ PORTA PADRAO-CONSULTAR-EQUIPE-DE-BD-PARA-ALTERACAO
    )
    (CONNECT_DATA =
      (SERVICE_NAME = <\SID-DE-CONEXAO-BANCO-ORACLE\>) 
    )
  )

Instalando o MongoDB

O mongo DB é a plataforma de armazenamento das informações geradas pelo Storex Reports, tendo como sua principal função guardar as configurações das consultas para geração dos relatórios, a plataforma oferece a disponibilidade de que seja executada em uma maquina separada do Storex Reports mas aconselhamos que seja instalado na mesma maquina em que o Storex Reports.  

Para instalar o Mongo DB e efetue o download do instalador adequado para sua versão de Sistema Operacional (informado na Nota de Aviso) 

• Execute como Administrador o instalador do mongoDB.
  
• Aceite os termos de uso e clique Next ate que sejam exibidas as opções de tipo de instalação.
• Selecione a opção de Completa para o tipo de Instalação.
  
• Clique em Next ate ate que seja exibida a tela de Status de Instalação.

Após a mensagem de Finish o servidor MongoDB está instalado será aberta a tela de conexão do MongoDB clique em Conect para que seja criado o banco, agora será necessário adicionar a DataBase para o acoplamento do storexReports.

• Clique no botão Create DataBase.
• Para a criação da DataBase e necessário preencher os campos listados com o valor "LinxStorexReports" (sem aspas):
  
  • DataBase Name 
  • Collection Name
  
  
  

Configurando e Executando o Storex Reports

Após a instalação e criação da DataBase no MongoDB vamos configurar as conexões entre o Storex Reports e os acoplamentos dos bancos de dados que ele faz uso. O Storex Reports usa o banco Oracle para fazer consultas dos dados obtidos pelo P2K e cria relatórios com base nas consultas feitas no banco OracleBD e os armazena em json no banco MongoDB. Agora vamos descompactar para configurar. 

• Crie uma pasta na raiz do drive de sua escolha com o nome Storex Reports descompacte o pacote do Storex Reports disponibilizado pela Linx.
• Ao descompactar o pacote busque pelo arquivo de configuração do Storex Reports chamado "appsettings,json" escolha o editor de texto para efetuar as devidas alterações.
• Com o arquivo appsettings,json aberto verifique as seguintes informações:
  • No objeto "DataBaseConnectionString" verifique se o valor da Porta de comunicação informada no arquivo é o mesmo utilizado no MongoDB caso não seja altere o arquivo.
    
    
• Ainda com o arquivo aberto no objeto "urls" defina a URL de acesso junto com a Porta de comunicação em que o Storex Reports será acessado, Verifique se a porta que esta no arquivo não esta em uso.
  • Caso escolha o uso do IP da maquina na url do Storex Reports utilize o IP Privado da maquina.
  appsetting.json

  {
    "Logging": {
      "LogLevel": {
        "Default": "Information",
        "Microsoft": "Warning",
        "Microsoft.Hosting.Lifetime": "Information"
      }
    },
    "AllowedHosts": "*",
    "AllowedHostsReports": "*",
    "ProductName": "Linx Storex Reports",
    "ProductVersion": "1.0.0",
    "DataBaseConnectionString": "mongodb://localhost:27017",
    "DataBaseName": "LinxStorexReports",
    "urls": "https://localhost:44385/"
  }
  
  
  

A configuração necessária para  conexão com o banco mongo foi estabelecida com o Storex Reports com isso é possível acessar a interface web, para acessar utilize o valor informado no objeto "urls", agora temos que executar como ADMINISTRADOR o arquivo com a extensão .exe chamado StorexReports.exe esse arquivo é responsável por instanciar um servidor web embarcado na maquina

Configuração Para Iniciar o Storex Reports Automaticamente 

O Storex Reports é uma aplicação que é executada pelo próprio servidor embarcado como já foi citado anteriormente, se faz necessário efetuar a configuração para o Start automático da aplicação, essa configuração é extremamente importante para que não haja necessidade de toda a vez em que a maquina onde esta o storexreports for iniciada seja preciso executar manualmente o arquivo para iniciar o servidor embarcado.

• No menu Iniciar do Windows efetue a busca por Windows Administrative Tools
  
  
  
• Será aberta a tela de Administrative Tools feito isso selecione a opção Task Scheduler
  
  
  
• Feito isso será aberta a tela de Task Sheduler, clique no menu Task Scheduler (Local) no canto esquerdo da tela.
  
  
  
• Clique ate que seja exibido a pasta Microsoft.
  
  
  
• Clique com botão direito na pasta Microsoft e selecione New Folder.
  
  
  
  
• Defina o nome da nova pasta, neste caso será Teste.
  
  
  
• Clique em OK, feito isso clique na pasta que acabou de ser criada com o botão direito e selecione a opção Create Basic Task.
  
  
  
  
• Defina o nome da Task que será criada e clique em Next.
  
  
  
  
• Selecione a opção When The Computer Starts e clique em Next.
  
  
  
  
• Selecione a opção Start o Program e clique em Next.
  
  
  
  
• Feito isso será aberta a tela de Start o Program, essa tela e responsável por definir o diretório em que o arquivo do Storex Reports será executado.
  
  
  
  
  • No campo Program/Script informe o diretório e o arquivo .exe do Storex Reportes. 
    • EX: C:\storex-reports\StorexReports.exe
  • No campo Start In (optional) informe o diretório raiz do StorexReports.
    • EX: C:\storex-reports\
• Feito isso clique em Next.
• Será exibida a tela de confirmação do cadastro, marque o check box "Open the Properties dialog for this task when I click finish" e clique em Finish
  
  
  
  
• Será aberta a tela de Properties (Local Compulter)
  
  
  
  
  • Selecione a opção Run whether user logged on or no.
  • Marque o check box Run with highest privileges
  • No combo box configure for: selecione a opção correspondente ao seu SO.
• Clique em Ok. 
• Será solicitado o usuário e senha administrador da maquina ao preencher clique em Ok.
  

Configurando a Conexão com OracleBD

Para acessar utilize o valor informado no objeto "urls" do arquivo "appsettings,json" presente na raiz do Storex Reports

•  No campo usuário informe o valor: "admin"
• No campo senha informe: 223344 ou 112233
• Clique no botão entrar

Tendo concluído com sucesso os passos anteriores o Storex Reports vai exibir sua tela de Home, agora vamos configurar a conexão com o banco Oracle responsável por armazenar os dados obtidos no ambiente de loja para isso siga os passos:

• Clique no menu para selecionar a opção Fonte de Dados.
  

• No campo Host, informe o valor do objeto criado no arquivo tnsnames.ora (Caso a maquina onde o Storex Reports esteja em execução seja a mesma maquina do Banco Oracle informe o SID do Banco Oracle)

  Exemplo

  ORA12C = <== ESSE VALOR DEVERA SER PASSADO NO CAMPO HOST (ELE CORRESPONDE AO SID DO BANCO ORACLE) 
    (DESCRIPTION =
      (ADDRESS_LIST =
        (ADDRESS = (PROTOCOL = TCP)(HOST = <\IP-DA-MAQUINA\> )(PORT = 1521)) <\ PORTA PADRAO-CONSULTAR-EQUIPE-DE-BD-PARA-ALTERACAO
      )

• No campo Usuário, informe o usuário de conexão do OracleBD passado pela equipe de Banco de Dados.
• No campo Senha, informe a senha de conexão do OracleBD passado pela equipe de Banco de Dados.
• Clique em SALVAR .