Páginas filhas
  • Integração do Winthor com TOTVS Varejo PDV Omni

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Dica
titleO que é o Winthor Smart Hub

O Winthor Smart Hub é um produto de Varejo e Distribuição Winthor que pode ser utilizado em diferentes parceiros de integração dentro do nosso ecossistema TOTVS.

Consiste em possibilitar integração entre duas API’s distintas utilizando um mecanismo de transformação chamado Jolt Transform, que, através de um Spec (especificação template) intermediário, trabalha na conversão de um Json retornado para um Json esperado.

Pensado como medware, executa, no modo agendamento de tarefas, o serviço de buscar e enviar dados Json entre duas API’s diferentes, realiza conexão com diversos serviços API utilizando um esquema/template baseado no mesmo gerado pela ferramenta Postman.

Todas as funções e cadastros citados podem ser configurados de forma simples e intuitiva através da rotina 2650 disponibilizada no WTA.

Nota
titleATENÇÃO

A TOTVS não se responsabiliza por aplicações de terceiros instaladas no servidor.

Caso seja encontrada aplicações de terceiros nos diretórios de instalação padrão WinThor e ou banco de dados, qualquer tipo de atendimento não poderá ser seguido pela TOTVS.

Aviso
titlePré-requisitos

Antes de iniciar a implantação, verifique se todos os pré-requisitos foram atendidos:


  • Requisitos de hardware


    • Equipamento: Servidor dedicado
    • Sistema Operacional: Windows 10 ou Superior 64bits;
    • Processador: De 4+ núcleos e 2ghz+ de processamento;
    • Memória RAM: mínimo de 8GB (recomendado 16GB);
    • Conexão com Internet.
    • Espaço em Disco: Mínimo de 50gb disponíveis;
    • Java 1.8.0
    • Conexão com o banco de dados do WinThor;



Aviso
titleATENÇÃO
  • Caso a instalação seja feita em uma estação comum de trabalho ou em servidor compartilhado com outra aplicaçãoa performance pode ser seriamente afetada
  • O compartilhamento de recursos pode não só deixar lento quanto também travar a aplicação. Isso acontece porque quando não há recursos suficientes para o processamento da JVM, a sua instancia é fechada, paralisando todos processos dependentes. Desse modo, não poderemos garantir a perfeita execução da aplicação conforme é planejado para ser.



  • Requisitos de software



  • Acesse o WinThor Anywhere e no menu principal, preencha no campo de Pesquisar a rotina 801 - Atualização de Serviços Web e tecle Enter (ou clique diretamente sobre a rotina no menu principal do lado esquerdo);

Image Removed

  • Na tela Gerenciador de Rotinas e Serviços, clique o botão Instalações;

Image Removed

  • Instale os serviços winthor-integracao-config e winthor-integracao-2650 na última versão disponível. 

O objetivo é possibilitar o Cadastro de Integrações no Winthor Smart Hub.

Para realizar uma nova integração, devemos acessar as configurações de integrações através da rotina 2650 do WSH.

Acesse o WinThor Anywhere, localize/pesquise a rotina 2650 - Winthor Smart Hub

Image Removed

Selecione a opção Integrações no Menu;

Image Removed

Clique no botão Novo, (será apresentado os dados para Cadastro de Integração);

Image Removed

 Cadastro de Integração nova

Image Removed 

Tela destinada ao cadastro de uma nova integração:

    •  Código - Campo que apresentará o ID único do cadastro, este campo é gerado automaticamente.
    • Nome - Deverá ser informado o nome da integração para identificação da mesma.
    • URL Sistema Externo - Deverá ser informada a URL da API que será usada na integração externa.
    • Processo WTA - Deverá ser informado se será utilizado como processo WTA (Sim ou Não ).
    • Filial - Deverá ser informado o nome da filial.
    • Token - Este campo será gerado automaticamente após a criação da Integração
    • Botão Salvar - Salva os dados adicionados.

O objetivo é possibilitar o Cadastro de Rotas de busca e envio de dados, independente das API’s de emitente e destinatário.

Desta forma o serviço WSH(Winthor Smart Hub)  poderá realizar os processos de integração do produto Winthor, criando uma camada de transformação e intermediação de dados onde será possível realizar integrações com parceiros internos e externos.

Para cadastrar uma nova Rota, realize os procedimentos abaixo:

Acesse o WinThor Anywhere, localize/pesquise a rotina 2650 - Winthor Smart Hub

Image Removed

Selecione a opção Rotas no Menu;

Image Removed

Clique no botão Novo, (será apresentado os dados para Cadastro de Rota/Serviço);

Image Removed

 Cadastro de Rota/Serviço 

Image Removed

Tela destinada ao cadastro de uma nova rota

    •  Código - Campo que apresentará o ID único do cadastro, este campo é gerado automaticamente.
    • ID Empresa - Deverá ser informado a empresa da rota que executará a ação.
    • Nome Empresa - Ao selecionar o ID da empresa o nome será apresentado conforme cadastrado no banco de dados.
    • Status - Deverá selecionar uma das opções ATIVO(será executada) / INATIVO(não será executada) para as Rotas.
    • Tipo do Documento - Este campo disponibilizamos algumas opções do Tipo de Documento que poderá ser trafegado na Rota
    • Autenticador -  Deverá selecionar as opções SIM/NÃO. Caso a Rota precise de autenticação antes da execução, este campo deverá ser informado igual a SIM, caso contrário informar NÃO.
    • Atualizar Token - Deverá selecionar as opções SIM/NÃO. Caso a Rota precise ATUALIZAR o Token, este campo deverá ser informado igual a SIM, caso contrário informar NÃO.
    • Arquitetura - Informe a arquitetura da sua integração (JSON, XML, outros)
    • Tipo de Processo - O Tipo Processo é muito importante, ele determina a ação que a ROTA executará na integração (BUSCAR/ENVIAR) dados.
    • Nome do Serviço - Adicionar o Nome da Rota que está sendo cadastrada para identificar em demais processos da integração.
    • Layout de Comunicação - Campo destinado a inserção do Layout que faça comunicação com o serviço, deve-se indicar o tipo de requisição e parâmetros necessários para que a ação seja executada, conforme o exemplo abaixo:
Informações
titleInstalaçãoIntegração PDV Omnishop
Expandir
titleDownloads
Expandir
titleDownload pacote WSH

O download dos arquivos necessário parar realizar a instalação do WSH - Winthor Smart Hub podem ser feitos através do link abaixo:

Expandir
titleInstalaçãoComo deve ser feita a integração
  • Este campo é responsável pela informação do banco de dados do winthor.
  • spring.datasource.username= nome_usuário_banco

    • Este campo é responsável pela informação.
  • spring.datasource.password= DED9EFD3B48EBDBB5E69A00393B57EC9

    • Este campo é responsável pela informação da senha do banco de dados que deve ser em formato MD5 sempre em caixa alta.
  • spring.datasource.driver-class-name=oracle.jdbc.OracleDriver

    • Este campo é responsável pela informação do driver do banco de dados.
    • path.winthor.ini= C:/winthor/Prod/Winthor.ini

      • Este campo é responsável pela informação do local do arquivo de winthor.ini que deve estar dentro do diretório do winthor.
    • url.ssh.wta=localhost

      • Este campo é responsável pela informação da url do WTA.
    • port.ssh.wta:8101

      • Este campo é responsável pela informação da porta de acesso do WTA.
    Totvs custom tabs box
    tabsDescompactando os arquivos, Editando arquivo de propriedades "app.properties", Parando o servido WTA, Executando jar para finalizar as configurações iniciais
    idspasso1,passo2,passo3,passo4

    Para realizar a instalação, é necessário realizar o download dos arquivos informados no passo anterior e descompactar os mesmo no diretório padrão da instalação do WTA - Winthor Anywhere que por padrão é "C:\pcsist\produtos".

    Após ser descompactado deve ficar "C:\pcsist\produtos\winthor-integracao-core" com a estrutura conforme imagem abaixo:

    Image Removed

    Após ter os arquivos no local correto, precisa-se editar o arquivo "app.properties" e configurar o mesmo de acordo com os dados da instalação conforme indicado na imagem abaixo:

    Image Removed

    Exemplo dos dados que devem conter no arquivo app.properties;

    Totvs custom tabs box items
    defaultyes
    referenciapasso1
    Totvs custom tabs box items
    defaultno
    referenciapasso2
    Bloco de código
    spring.datasource.initialize=false
    #spring.datasource.url= jdbc:oracle:thin:@(DESCRIPTION =    (ADDRESS = (PROTOCOL = TCP)(HOST = gowend01)(PORT = 1521))    (CONNECT_DATA =      (SERVER = DEDICATED)      (SERVICE_NAME = ORCL)    )  )
    spring.datasource.url= jdbc\:oracle\:thin\:@127.0.0.1:1521\:ORCL
    spring.datasource.username= LOCAL
    spring.datasource.password= 54B4C4075463B2E02CD69F5CD139B5B2
    spring.datasource.driver-class-name=oracle.jdbc.OracleDriver
    path.winthor.ini= C:/winthor/Prod/MOD-000/Winthor.ini
    url.ssh.wta=localhost
    port.ssh.wta:8101
    path.folder.temporary=C:/pcsist/produtos/winthor-integracao-core/temp
    app.task.habilitadas=ALL
    app.task.recursos.execucao.ativar-log-tempo=true
    #app.migration.ambiente.teste=true
    #app.task.paginacao-winthor.page-size=10
    app.migration.ambiente.teste=true
    app.migration.habilitar=true
    #app.task.status-pos-integracao.intervalo-milissegundos=1000
    #app.task.status-pos-integracao.tempo-maximo-minutos=1
    #app.task.recursos.schedule.fixedRate=60000

    Os seguintes campos devem ser informados de acordo com as configurações do ambiente onde o mesmo está sendo configurado:

    spring.datasource.url= jdbc\:oracle\:thin\:@127.0.0.1:1521\:ORCL


    Antes de executar o arquivo de configuração do WSH, devemos parar o serviço do WTA que fica nos serviços do Windows:

    Pressionar no teclado as teclas "Windows + R" e em seguida no campo de texto colocar o somando "services.msc" responsável por exibir os serviços do Windows

    Image Removed 

    Na tela de serviços procurar pelo serviço do Winthor Anywhere:

    Image Removed

    Clicar com o botão direito sobre o serviço e clicar em "Parar"

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciapasso3


    Após parar o serviço, podemos executar os arquivos de configurações do WSH.

    Para configurar os dados mencionados, deve se executar o arquivo "winthor-integracao-core.jar" via prompt de comando para que todas as configurações sejam realizadas para iniciar o WSH:

    Para isto, basta executar no prompt no local onde o arquivo se encontra "C:\pcsist\produtos\winthor-integracao-core" o comando "java -jar winthor-integracao-core.jar".

    Image Removed

    Se se todas as configurações do arquivo "app.properties" estiverem certas, as migrations serão executadas e assim que começarem a ser executados os fluxos, para a aplicação podemos conferir as migrations no log.

    Image Removed

    Após finalizar o processo, podemos verificar no banco de dados realizando uma consulta com o select "SELECT * FROM PCINTEGRACAOCOREMIGRATION;" e verificar a coluna "SUCESSO" onde todas devem estar com um "S"

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciapasso4
    Expandir
    titleConfiguração de rotinas
    Expandir
    titleConfigurando rotina 2650
    Expandir
    titleConfiguração de integrações
    Expandir
    titleCadastro de integrações
    Totvs custom tabs box
    tabsPasso 1, Passo 2, Passo 3, Passo 4
    idsitem-int1,item-int2,item-int3,item-int4
    Totvs custom tabs box items
    defaultyes
    referenciaitem-int1
    Totvs custom tabs box items
    defaultyes
    referenciaitem-int2
    Totvs custom tabs box items
    defaultno
    referenciaitem-int3
    Totvs custom tabs box items
    defaultno
    referenciaitem-int4
    Expandir
    titleConfiguração de rotas
    Expandir
    titleCadastro de rotas/serviço
    Totvs custom tabs box
    tabsPasso 1, Passo 2, Passo 3, Passo 4, Passo 5
    idsitem-rota1,item-rota2,item-rota3,item-rota4,item-rota5
    Totvs custom tabs box items
    defaultyes
    referenciaitem-rota1
    Totvs custom tabs box items
    defaultno
    referenciaitem-rota2
    Totvs custom tabs box items
    defaultno
    referenciaitem-rota3
    Totvs custom tabs box items
    defaultno
    referenciaitem-rota4
    Bloco de código
    languagejs
    titleExemplo Comunicação
    {
        "name": "ObterNotaPedido",
        "request": {
            "method": "GET",
            "header": [
                {
                    "key": "Authorization",
                    "value": "Bearer {{TOKEN}}"
                },
                 {
                    "key": "Content-Type",
                    "value": "application/JSON"
                },
                {
                    "key": "Accept",
                    "value": "*/*"
                }
            ],
            "url": {
                "raw": "{{URL_BASE}}//users/{{USER_ID}}/orders/{{IDEXTERNO}}/",
                "protocol": "https",
                "host": [
                    "api",
                    "com"
                ],
                "path": [
                    "users",
                    "00001",
                    ""
                ],
                "query": [
                    {
                        "key": "sale",
                        "value": "authorized"
                    }
                ]
            }
        },
        "response": []
    }

    Ao finalizar o Cadastro de Rota/Serviço, será apresentado o botão "Próximo" que levará ao segundo passo de configuração, Layout de Transformação.

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciaitem-rota5
    • O layout de transformação é dividido em 4 partes que são:
      • JSON de entrada - Campo destinado a adição de como receber a informação.

    Image Removed

    • JSON de Saída - Campo destinado a informação de como deve ficar o JSON final do processo.

    Image Removed

    • Mapear JSON - está no centro das informações JSON de entrada e JSON de Saída, este campo é responsável por configurar o que liga os campos de entrada e saída para gerar o JSON de transformação do processo.

    Image Removed

    • Layout de Transformação - Campo destinado a inserção do Layout que faça transformação dos dados recebidos de forma que o ERP Winthor consiga integrar. Ao clicar no botão "Gerar Layout" será gerado dinamicamente após preenchimento das informações JSON entrada/saída e mapeamento dos campos,
    Bloco de código
    languagejs
    titleExemplo Transformação
    [
      {
        "operation": "shift",
        "spec": {
          "id": "idExterno[0]",
          "shipment": { "logistic_type": "ignorarImportacaoDiferente(regra)" }
        }
      }
    ]
    
    
    • Botão Salvar - Salva os dados adicionados.
    Expandir
    titleConfiguração de Parâmetros
    Expandir
    titleCadastro de parâmetros

    O objetivo é possibilitar o Cadastro de parâmetros no Winthor Smart Hub.

    Para cadastrar um novo Parâmetro, devemos acessar as configurações de parâmetros através da rotina 2650 do WSH.

    Expandir
    titleCadastro de parâmetros
    Totvs custom tabs box
    tabsPasso 1, Passo 2, Passo 3
    idsitem-param1,item-param2,item-param3
    Totvs custom tabs box items
    defaultyes
    referenciaitem-param1

    No WSH, acessar o item 3 da rotina 2650, que é a configuração de parâmetros;

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciaitem-param2

    Clique no botão Novo, (será apresentado os dados para Cadastro de parâmetro);

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciaitem-param3

    Cadastro de Parâmetro

    Image Removed 

    Tela destinada ao cadastro de um novo parâmetro;

      • Código - Campo que apresentará o ID único do cadastro, este campo é gerado automaticamente.
      • ID Rota Serviço- Deverá ser informado o ID da rota para qual o parâmetro executará a ação.
      • Nome da rota- Ao selecionar o ID da empresa o nome será apresentado conforme cadastrado no banco de dados.
      • Tipo Chave - Deverá selecionar o tipo da chave que será utilizada.
      • Chave - Informar a chave que será usada no parâmetro novo. 
      • Tipo Valor -  Deverá informar o tipo do valor.
      • Valor - Deverá informar o valor referente ao campo.
      • Botão Salvar - Salva os dados adicionados.

    Abaixo um exemplo de cadastro:

    Image Removed

    Expandir
    titleConfiguração de fluxos
    Expandir
    titleCadastro de fluxos

    O objetivo é possibilitar o Cadastro de fluxos no Winthor Smart Hub.

    Os fluxo basicamente são os passos que devem ser feitos para que os dados sejam trafegados da maneira adequada no winthor.

    Para cadastrar um novo Fluxo, devemos acessar as configurações de parâmetros através da rotina 2650 do WSH.

    Totvs custom tabs box
    tabsPasso 1, Passo 2, Passo 3, Passo 4, Passo 5
    idsitem-fluxo1,item-fluxo2,item-fluxo3,item-fluxo4,item-fluxo5
    Totvs custom tabs box items
    defaultyes
    referenciaitem-fluxo1

    Já no WSH, acessar o item 4 da rotina 2650, que é a configuração de fluxos;

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciaitem-fluxo2

    Clique no botão Novo, (será apresentado os dados para Cadastro de fluxos);

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciaitem-fluxo3

    Cadastro de fluxos

    Image Removed

    Nesta dela, podemos montar os fluxos de acordo com o necessário simplesmente selecionando no lado esquerdo o fluxo necessário e arrastando para a tela em branco da direita.

    Caso tenham vários fluxos já adicionados, e a ordem não esteja de acordo com o esperado, podemos mover os fluxos já adicionados entre eles, também arrastando os mesmos com o mouse.

    Temos uma lista com vários recursos que podem ser utilizados:

    AutenticadorRefreshTokenApi =

    BuscaRotaServicoNaoPaginada =

    BuscaRotaServicoPaginada =

    CriaVariavelTemporaria =

    FinalizaVariavelTemporaria =

    PersisteIntegracao =

    EnvioIntegracaoStatusRecebido =

    EnvioIntegracaoStatusEmProcessamento =

    ConsultarStatusPosIntegracao =

    EnvioIntegracaoStatusRecebidoLote =

    Após adicionar os itens que forem necessários, podemos ir para a Seleção de rotas clicando em próximo passo;

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciaitem-fluxo4

    Neste passo, devemos vincular as rotas em cada fluxo que foi adicionar, clicando na lupa para realizar a busca da rota;

    Image Removed

    Após clicar na lupa, devemos procurar a rota necessária de acordo com o fluxo, como no exemplo abaixo, buscamos a rota de autenticação para o fluxo de AutenticadorRefreshTokenApi;

    Buscando a rota digitando pelo nome, ou listando as mesmas sem a necessidade de digitar;

    Clicar sobre a rota para selecionar a mesma;

    Confirmar a rota selecionada.

    Image Removed

    Após selecionar as rotas para cada fluxo podemos ir para a revisão dos dados ou em caso de necessidade, podemos voltar um passo para selecionar ou remover outro item no fluxo voltando a página anterior;

    Image Removed

    Totvs custom tabs box items
    defaultno
    referenciaitem-fluxo5

    Ao chegar no último passo, o passo de revisão, podemos ficará ativo ou não, também definir IDs independentes e também podemos alterar novamente a ordem de cada item arrastando os mesmos para cima e para baixo.

    Obs: No caso de alterar a ordem, podemos verificar que o primeiro item da tabela, "Ordem de execução" também irá alterar, respeitando a ordem de cima para baixo.

    Image Removed

    Ativar ou desativar o fluxo, irá definir se o fluxo vai ficar operante ou não;

    A informação do ID independente serve para ... (Definir texto)

    Ao clicar em concluir o fluxo é salvo.

    Expandir
    titleConfiguração de detalhes técnicos
    Expandir
    titleDetalhes técnicos

    O objetivo é possibilitar o acesso aos detalhes técnicos do Winthor Smart Hub.

    Para consultar os detalhes técnicos, devemos acessar a rotina 2650 do WSH.

    Já no WSH, acessar o item 5 da rotina 2650, que é a configuração de detalhes técnicos;

    Image Removed

    Na tela dos detalhes técnicos, podemos realizar as devidas consultas podendo filtrar as mesmas por período de data, por rota, por status sendo esses apenas um ou múltiplos e também controlar a quantidade itens exibidos por página.

    Image Removed

    item-detalhes3
    Totvs custom tabs box
    tabsPasso 1, Passo 2, Passo 3
    idsitem-detalhes1,item-detalhes2,item-detalhes3
    Totvs custom tabs box items
    defaultyes
    referenciaitem-detalhes1
    Totvs custom tabs box items
    defaultno
    referenciaitem-detalhes2
    Totvs custom tabs box items
    defaultno
    referencia


    Expandir
    titleDúvidas frequentes
    Informações
    titleIntegrações


    Integração com Fulfillment


    Expandir
    titleOmni Fulfillment




    Integração com PDV Omnishop


    Expandir
    titlePDV Omnishop

    Page Tree
    rootWSH - Winthor Smart Hub - Integrações




    Expandir
    titleComo acessar o WTA - Winthor Anywhere em outras estações?

    Para acessar o Winthor Anywhere em outra estação de trabalho da sua empresa realize os seguintes passos:

    1. Acesse a rotina 132 - Parâmetros da presidência
    2. Obtenha o ID e PORTA do WTA nos parâmetros 2851- IP do Servidor WTA e 2849 - Número da Porta do WTA respectivamente;
    3. Acesse o seu navegador de internet e coloque o IP e a PORTA separados por ":", conforme exemplo: 10.62.46.50:8180
    4. Ao abrir a tela de acesso da ferramenta, utilize o mesmo usuário e senha do WinThor.

    Aviso

    Caso não consiga trafegar pelo navegador da máquina da sua empresa é possível que seja bloqueio por conta de ferramentas como (microtic, Firewall e ou PF Sense), então solicite para o administrador da rede de infraestrutura para fazer a liberação.

    ...