Page tree
Skip to end of metadata
Go to start of metadata

Pré -Requisitos para a implementação:

Programas fontes envolvidos :

  1. O ambiente Protheus ( RPO ) deve possuir esses programas com datas iguais ou superiores :

LJRETAILWIZ.PRW -  
LJRETAILAPP   


Sistema Operacionais:

Windows®/Linux®
Banco de dados:Todos Relacionais
Servidor:É recomendável um serviço ( appserver.ini ) separado para o RetailApp.
Capacidade máxima da String

Conforme documentação: http://www.tdn.totvs.com/display/tec/MaxStringSize, é necessário alterar o tamanho da capacidade da string no appserver.ini conforme exemplo:

[general]
maxStringSize=500

Incluir a chave TopMemoMega conforme documentação: http://tdn.totvs.com/display/tec/TOPMemoMega

Certificado Digital:

A configuração do certificado digital é obrigatória para utilizar o protocolo seguro (HTTPS) , os detalhes da configuração que deve ser realizado no server do Protheus ( appserver.ini )
está no link
( clique aqui )


Antes de realizar a configuração é necessário verificar se o certificado está convertido:

Conversão de certificados ‘PFX’ para ‘PEM’ – Windows

Esse procedimento destina-se, exclusivamente, aos usuários do Sistema operacional Windows.

Análise da cadeia de certificação

Ao receber um certificado digital do tipo A1, antes da conversão para o formato PEM, recomenda-se a análise de alguns pontos importantes, para que não haja problemas com a conexão SSL3 e com a Secretaria de Fazenda.

Primeiramente, é necessário instalar o certificado para visualizá-lo. O procedimento é feito da seguinte forma:

  1. Faça um duplo clique no arquivo PFX para acessar a tela do Assistente de Instalação.
  2. Clique em Avançar e, posteriormente, em Arquivo a ser Importado.
  3. Selecione o arquivo que deseja importar e clique em Avançar.
  4. Assinale uma das três opções disponíveis: Formato Apache (.pem); Formato PFX (.pfx ou .p12) ou HSM.
  5. Clique em Avançar. O Sistema operacional armazena o certificado automaticamente.
  6. Clique em Concluir para efetivar a instalação do certificado.
  7. Abra uma página de Internet e acesse as opções Ferramentas / Opções da Internet / Conteúdo / Certificados.
  8. Selecione o certificado digital instalado.
  9. Clique em Exibir e em Caminho de Certificação, Verifique a existência de todos os certificados apresentados no Caminho de Certificação. Caso negativo, é necessário contatar o fornecedor do certificado digital para realizar a instalação.
  10. Se o certificado estiver instalado, clique em Exibir Certificado.

Algumas Secretarias de Fazenda exigem toda a cadeia da certificação para permitir a conexão SSL3. Caso o certificado seja instalado sem todos os certificados contidos na cadeia de certificação, o acesso é feito apenas em algumas Secretarias da Fazenda.

Se isso ocorrer, siga os procedimentos já descritos a fim de solucionar o problema de conexão.

Exportação do certificado digital

Após concluir a análise do certificado digital, é necessário exportá-lo juntamente com a chave privada.

  1. Clique Exportar. Um Wizard é apresentado. Siga o procedimento prescrito.
  2. Assinale a opção que permite exportar a chave privada ou particular.
  3. Assinale a opção que inclua todos os certificados no caminho de certificação e todas as propriedades estendidas.
  4. Informe a senha do certificado.
  5. Conclua a operação informando o arquivo de destino.
  6. Clique em Remover. Esta tarefa é fundamental para a segurança do certificado digital.



Conversão de certificados ‘PFX’ para ‘PEM’ – Linux

Este procedimento destina-se aos usuários do Sistema operacional Linux.

Para converter o certificado digital de ‘PFX’ para ‘PEM’ é necessário o utilitário ‘OpenSSL’. Acesse http://www.openssl.org/source/.

Após instalar o utilitário ‘OpenSSL‘, execute os seguintes comandos:

  • Para obter o CertificadoClient: openssl pkcs12 -in <nome do certificado de origem> -out <nome do certificado de destino>_cer.pem
  • Para obter o KeyClient: openssl pkcs12 -in <nome do certificado de origem>  -nocerts -out <nome do certificado de destino>_key.pem ->KeyClient

Um exemplo de configuração no appserver.ini utilizado :

[SSLConfigure]

TRYPROTOCOLS=1

HSM=0
SSL2=0
SSL3=0
TLS1=1
TLS1_0=1
TLS1_1=1
TLS1_2=1
BUGS=1

CertificateClient=C:\Protheus\Protheus_data\certificado\000002_all.pem

KeyClient=C:\Protheus\Protheus_data\certificado\000002_key.pem
PassPhrase=( senha de acesso a chave privada ou certificado )

Rotinas no Menu:

  1.  No Configurador (SIGACFG), acesse Ambientes/Cadastro/Menu (CFGX013)
  2.  Informe as novas opções de menu do Controle de Lojas ( SIGALOJA), conforme instruções a seguir:
 Menu Miscelânea

Submenu

Integração RetailAPP

Nome da Rotina

Setup Inicial

Programa

LJRETAILSI

Módulo

Controle de Lojas
Menu  Miscelânea

Submenu

Integração RetailAPP

Nome da Rotina

Carga Dados

Programa

LJRETAILDF

Módulo

Controle de Lojas

 Nesse link você encontra o passo a passo para incluir uma rotina no configurador (apenas exemplo) ( clique aqui )

Parâmetros:

  1. No Configurador (SIGACFG), acesse Ambientes/Cadastros/Parâmetros (CFGX017).
  2. Crie os parâmetros a seguir: 

Itens/Pastas

Descrição

Nome

MV_LJRAPP0

Tipo:

Caracter

Cont. Por

Deixar em branco, pois serão preenchidos automaticamente na rotina de carga inicial

Descrição

Esse parâmetro contém as informações sobres os caminhos ( URLs ) de integração com a RetailApp™ , as informações são separadas pela barra vertical pipe ( | ), na

seguinte sequência : URL de login | URL dos dados | URL de cálculo , conforme exemplo abaixo default abaixo 

https://woolton-backend.azurewebsites.net/api/login|https://woolton-backend.azurewebsites.net/api/data 

Itens/Pastas

Descrição

Nome

MV_LJRAPP1

Tipo:

Caracter

Cont. Por

Deixar em branco, pois serão preenchidos automaticamente na rotina de carga inicial.

Descrição

Esse parâmetro contém as informações de setup da integração , as informações são separadas pela barra vertical pipe ( | ) ,

na seguinte sequência : usuário (email) de conexão com o App | senha de conexão | quantidade de dias para o processamento | códigos das TES | minutos de intervalo

para a execução do job de carga ,exemplo de conteúdo default : teste@teste.com.br|teste123|7|501,502|15.

Habilitar Campos

Para realizar a integração, necessário habilitar os campos reservados: F2_MSEXP.

  1. No Configurador ( SIGACFG) acesse Base de Dados /Dicionário /Base de Dados.
  2. Selecione a opção Dicionario de Dados.
  3. Selecione a tabela correspondente ( SF2) 
  4. Ao entrar no cadastro através da função, clique em editar.
  5. Selecione a opção Campos.
  6. Na barra superior,(6) clique no botão Campos reservados.
  7. Selecione a opção Ident. Exp. Dados.

8. Salvar a alteração.

9. Atualizar o dicionário.

Para conferir o envio das informações para RetailApp, é necessário habilitar os campos reservados das tabelas SF1 (NF. Entrada), SA3 ( Vendedor), SB1 ( Produto e Estoque) e SE1 (Título a Reber - )

  1. No Configurador ( SIGACFG) acesse Base de Dados /Dicionário /Base de Dados.
  2. Selecione a opção Dicionario de Dados.
  3. Selecione a tabela correspondente (SF1) 
  4. Ao entrar no cadastro através da função, clique em editar.
  5. Selecione a opção Campos.
  6. Na barra superior,(6) clique no botão Campos reservados.
  7. Selecione a opção Ident. Exp. Dados.
  8. Salvar a alteração.

  9. Atualizar o dicionário.

  1. No Configurador ( SIGACFG) acesse Base de Dados /Dicionário /Base de Dados.
  2. Selecione a opção Dicionario de Dados.
  3. Selecione a tabela correspondente (SA3) 
  4. Ao entrar no cadastro através da função, clique em editar.
  5. Selecione a opção Campos.
  6. Na barra superior,(6) clique no botão Campos reservados.
  7. Selecione a opção Ident. Exp. Dados.
  8. Salvar a alteração.

  9. Atualizar o dicionário.

  1. No Configurador ( SIGACFG) acesse Base de Dados /Dicionário /Base de Dados.
  2. Selecione a opção Dicionario de Dados.
  3. Selecione a tabela correspondente (SB1) 
  4. Ao entrar no cadastro através da função, clique em editar.
  5. Selecione a opção Campos.
  6. Na barra superior,(6) clique no botão Campos reservados.
  7. Selecione a opção Ident. Exp. Dados.
  8. Salvar a alteração.
  9. Atualizar o dicionário.

  10. No Configurador ( SIGACFG) acesse Base de Dados /Dicionário /Base de Dados.
  11. Selecione a opção Dicionario de Dados.
  12. Selecione a tabela correspondente (SE1) 
  13. Ao entrar no cadastro através da função, clique em editar.
  14. Selecione a opção Campos.
  15. Na barra superior,(6) clique no botão Campos reservados.
  16. Selecione a opção Ident. Exp. Dados.
  17. Salvar a alteração.
  18. Atualizar o dicionário.



Passo 1 - Efetuando o setup inicial:

A rotina Setup Inicial (rotina  LJRETAILSI ) tem a finalidade de efetuar a montagem da estrutura organizacional da empresa, conforme os passos abaixo:

  1. No Controle de Lojas (SIGALOJA) acesse Miscelânea/ RetailApp Integração/Setup Inicial (rotina LJRETAILSI ).
  2. A primeira tela do Wizard de configuração será para a configuração da estrutura organizacional da empresa, ou seja, todas as lojas que aparecerão no app no nível hierárquico.
  3. Abaixo temos 2 exemplos de estruturas organizacionais: um exemplo de uma empresa com apenas uma loja e outro exemplo de um grupo com duas empresas e cada empresa com suas lojas:

         Exemplo 1: Se a sua estrutura organizacional for igual a da imagem abaixo 

   A configuração será dessa maneira :

 Exemplo 2:

 Caso a estrutura da sua empresa seja assim :

     




























No campo nível, é possível informar até o quarto nível, ou seja, de 1 a 4.

É necessário informar todos os níveis para continuar o setup.

Apenas no nível 4 deve informar as lojas (Empresa+Filial Protheus).

          3. Na segunda tela do Wizard é necessário colocar o nome do usuário e e-mail que será o administrador do aplicativo, será utilizado para logar no portal ( https://admin.getretailapp.com )

              e também receberá um e-mail cada atualização que for realizada   :

Importante! (info)

É necessário informar todos os campos para continuar o setup.

4. No último passo é o caminho que será gerado os arquivos de configuração, esse caminho é fixo, e não pode ser alterado.

 5. Será gerado no caminho que por default está localizado em: Protheus_data\retailapp\inicial_files.

      Ao final do processamento, é possível também salvar os arquivos, selecionando o caminho local.

 Na tela abaixo você poderia salvar uma cópia localmente.

Importante (info)

Caso tente acessar a rotina Setup Inicial( LJRETAILSI ), após ter concluído a montagem da estrutura organizacional, observe que é apresentada a seguinte mensagem: 

Caso tenha necessidade de refazer ou ajustar a estrutura, apague os arquivos na pasta \retailapp\initial_files\ e refaça a estrutura organizacional da empresa.

6- Para facilitar o envio, compactar a pasta com os arquivos.

Importante!

7 - Enviar um e-mail para support@retailapp.com com o arquivo .ZIP anexado para que seja criado a estrutura no app e você receberá o usuário com login e senha que será utilizado na próxima etapa da configuração.


Passo 2 - Efetuando Carga de Dados .

Pré-requisitos:

  • Ter efetuado a montagem da estrutura organizacional na rotina Setup Inicial (rotina  LJRETAILSI ).
  • Ter recebido o e-mail com a confirmação da estrutura organizacional, o email/login e senhas de acesso para o app é necessário realizar a carga inicial, conforme instruções abaixo:

Importante! (info)

Antes de realizar a carga inicial, é necessário realizar uma verificação na base de dados com o intuito de não ter caracteres especiais que poderiam causar algum problema na integração.

Para facilitar essa verificação, revisar as seguintes tabelas: SB2 - Saldo Físico e Financeiro (B2_FILIAL, B2_COD, B2_QATU), SBM - Grupo de Produtos (BM_DESC), SA3 - Vendedores (A3_FILIAL, A3_COD, A3_NOME, A3_NREDUZ).

  1. No Controle de Lojas (SIGALOJA) acesse Miscelânea/ RetailApp Integração/Carga Dados (rotina LJRETAILDF ) .
  2. Nesse primeiro passo (Empresas/Filiais), selecione quais filiais devem gerar as cargas, conforme abaixo.

Por padrão, todas as filiais que foram cadastradas no Setup Inicial, serão apresentadas nessa tela e marcadas para geração das cargas.
É possível desmarcar as filiais que não forem gerar a carga.

  

   Após selecionar as filiais, são apresentadas os endereços de comunicação com o app (Urls RetailApp).

   Por padrão esses endereços (URL's), já são carregados. Porém caso haja alguma alteração nesses endereços, os mesmos podem ser alterados nesse momento.

  

4. No próximo passo (Usuário de Conexão), é necessário informar as seguintes informações:

Informe e-mail (login) e senha do usuário que realiza a conexão com o app. (Informe o e-mail e senha, conforme informações do e-mail enviado pela RetailApp, confirmando a estrutura organizacional). 
Observação!  Esse usuário foi previamente cadastrado no Setup Inicial.

Informe todas as TES (códigos de Tipos de Entrada e Saída) que serão consideradas no filtro das vendas. 

      Observação!  Somente as TES de saída são aceitas. Deve-se informar pelo menos um código.

      

 5. Nesse passo (Rotina Automática), é possível realizar a configuração automática da carga das vendas.

     Para isso, é necessário marcar a opção de rotina automática e é imprescindível informar o tempo (minutos) entre uma execução e outra.

     Importante! (info) 

     Por padrão esse tempo, não pode ser inferior a 60 minutos.

     É recomendável inserir as configurações automáticas no appserver.ini, pois caso não selecione a opção automática, a integração ocorrerá apenas de forma manual, sendo necessário executar a opção Executa Movimento da rotina Carga de Dados

Importante! (info)

Ao informar os minutos para a atualização automática, o sistema grava no parâmetro MV_LJRAPP1, de forma que essa informação é apenas informativa. O que determina a atualização automática é a gravação do appserver.ini

Caso seja necessário alterar os minutos para atualização automática, será necessário alterar no appserver.ini.

Alteração dos minutos deve ser convertida em segundos, conforme exemplo abaixo:

Lembrando que a rotina automática deve ser configurada com no mínimo de 60 minutos = 3600 segundos 

Atenção! (warning)

Após realizar a confirmação, é apresentada uma mensagem de aviso, solicitando a  inclusão dessas informações no arquivo do servidor. Caso tenha outros serviços de rotinas automáticas já configuradas, não será possível incluir esse serviço automático.

É solicitado que seja configurado um servidor somente para esse serviço de carga (RetailApp). Essa configuração é necessária para que não entre em conflito com os outros serviços automáticos. 

Após a confirmação, serão gravadas no arquivo appserver.ini as configurações necessárias para a rotina automática.

Exemplo:

[RETAILAPP]
Main=LJRetailApp
Environment=RETAIL
nParms=2
Parm1=99
Parm2=01

[ONSTART]
Jobs=RETAILAPP
REFRESHRATE=3600

Importante!

Quando a estrutura das lojas for por empresa, é necessário a configuração do Job também por empresa:

[RETAILAPP_01]

Main=LJRetailApp
Environment=RETAIL
nParms=2
Parm1=01
Parm2=01

[RETAILAPP_02]

Main=LJRetailApp
Environment=RETAIL
nParms=2
Parm1=02
Parm2=01

[ONSTART]
Jobs=RETAILAPP_01, RETAILAPP_02
REFRESHRATE=3600

  6. No último passo (Período de Carga), é possível realizar a carga inicial ou executar a carga de x dias definido no campo "Dias para Processamento".

   Inicialmente a primeira carga deve ser executada. Essa carga vai considerar todas as vendas dos últimos 12 meses.

  Executa Carga Inicial: Ao executar a opção Executa Carga Inicial, o parâmetro MV_LJRAPP1, é atualizado com as seguintes informações:

  •   usuário (email) de conexão com o App | senha de conexão | quantidade de dias para o processamento (default = 001)| códigos das TES | minutos de intervalo.
    Observações: caso a soma dos caracteres informados (E-mail e senha para conexão, TES, minutos de Job Automático e os dias para processamento) seja maior que a quantidade de caracteres permitida no parâmetro, é exibida uma mensagem alertando sobre a gravação das informações:


  Executa Movimento: Após a carga inicial, esta opção pode ser utilizada se houver necessidade de enviar movimentações com quantidade de dias diferentes da configuração do parâmetro MV_LJRAPPI, que por default =001.

Importante: Após a carga inicial, pode-se realizar a carga das últimas vendas, definindo a quantidade de dias no campo e clicando no botão "Executar Movimento"

Observe que após concluir a carga inicial ou a execução da opção Executa Movimento, são gerados os seguintes arquivos na Raiz do Protheus, Pasta RetailApp:

       Os arquivos abaixo são apresentados com informações da última execução, não são gravados histórico de execuções:

  • Inventory.json - Inventário -  Nessa entidade são enviadas  as movimentações de estoque para o aplicativo , os dados serão extraídos do arquivo de estoque ( SB2, SBM ) .
    Observação: É necessário realizar o relacionamento do cadastro de Produto x Grupo de Produto para todos os produtos. Exemplo: 



  • Orders.json -  Vendas - Essa entidade é responsável pelo envio das vendas realizadas no Protheus , com a seguinte regra, Todas as vendas ( SF2 ) da empresa corrente.Somente irá considerar as filiais na qual conter o arquivo de estrutura ( organization_structure.csv ). 
  • payments.json - Pagamentos -  Essa entidade é responsável pelo envio dos títulos financeiro a receber ( SE1 ) para o app , os títulos enviados são apenas os títulos relacionados a vendas, com a seguinte regra :
    • A vista : Títulos do tipo ( E1_TIPO ) dinheiro e cartão de débito.
    • Meses : Todos os outros tipos diferentes de a vista ficaram nos campos de meses , a regra é a seguinte : Venda a venda são verificados os títulos (SE1) , se o vencimento
                 do titulo( E1_VENCREA ) for igual ao mês da venda esse título será incluído no 1 Mês , caso seja do mês subsequente será incluído no 2 Meses do aplicativo e assim sucessivamente.
  • Users.json - Vendedores - Esse arquivo é gerado com base nos vendedores da loja , com a seguinte estrutura : Nome : A3_NREDUZ , email : A3_EMAIL , código : A3_COD