WSH - Winthor Smart Hub - Integrações

Para instalar o WSH basta realizar o download do arquivo .exe informado anteriormente. Seguir o passo a passo de instalação até chegar ao passo 3. Nesse passo serão apresentadas 3 opções:

Opção 1. Realizar instalação completa

Essa opção é destinada a instalação inicial ou reinstalação do WSH.

Caso a opção seja selecionada, o passo 6 será exibido

Opção 2. Alterar o arquivo de configuração

Essa opção possibilitará trocar as informações do arquivo de configuração do WSH, como senha de conexão do banco de dados, etc.

Caso marque essa opção será exibido o passo 6.

Opção 3. Realizar atualização da versão

Essa opção apenas atualiza o .jar da aplicação, mantendo as propriedades do arquivo de configurações.

Caso necessário, e possível alterar os parâmetros setados no arquivo de configuração acessando o diretório"C:\pcsist\produtos\winthor-integracao-core" arquivo app.properties:

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

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.pdvomnishop=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

  • 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.

Feita a instalação o serviço do WSH estará ativo nos serviços do windows:

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.

Após finalizar o processo, podemos verificar no banco de dados, realizando uma consulta simples para verificar os migrations.

Consulta a realizar (utilize o sqlplus ou gerenciador de banco de dados de seu conhecimento:

"SELECT * FROM PCINTEGRACAOCOREMIGRATION;"

Verifique a coluna "SUCESSO" onde todas devem estar com um "S".

Após a execução das migrations, antes de ativar novamente o serviço do WTA, é necessário acessar a rotina 2650, na aba de Fluxos, e desativar todos os fluxos.

Feito isso, o serviço do WTA poderá ser iniciado novamente.

Após a instalação da estrutura, é necessário instalar os layouts que serão utilizados no ambiente. os layouts nada mais são que o conteúdo das rotas, variáveis e fluxos que uma integração precisa para funcionar.  Atualmente a integração do PDVSYNC está disponível para download.

A instalação do layout é feita pela opção 2 da rotina 2650 "Assistente de atualização":

Ao clicar em atualizar, será solicitada a confirmação da operação. Após todos os passos, caso seja retornada uma mensagem de sucesso, significa que todo o conteúdo necessário para a execução da integração estará presente no banco de dados.

O processo de instalação do WSH na versão futura é semelhante ao passo 2 da Versão Atual, com a diferença de que o instalador não fica disponível no link de download citado no passo "Download", ele precisa ser baixado diretamente o Azure.

Feito o download do instalador pelo azure, basta seguir o passo a passo da instalação conforme descrito no passo 2 da Versão Atual.

Ao finalizar a instalação, o WSH já estará pronto para a utilização.

É necessário editar o arquivo "app.properties" localizado no diretório "C:\pcsist\produtos\winthor-integracao-core" para adicionar as seguintes opções:

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

spring.datasource.initialize=false
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/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=false
app.migration.habilitar=false
#app.task.status-pos-integracao.intervalo-milissegundos=1000
#app.task.status-pos-integracao.tempo-maximo-minutos=1
#app.task.recursos.schedule.fixedRate=6000
app.task.paginacao-winthor.page-size=100
app.task.envio-integracao.threads=1
app.task.buscar-integracao.threads=1
app.task.buscar-integracao.tamanho=25
app.integracao-core.excluir=true
app.integracao-core.excluir.minimo-dias=120
app.integracao-core.excluir.tipo-dado=3
app.integracao-core.excluir.agendador: 0 0 2 * * *

• app.integracao-core.excluir=true
  • Este campo é responsável por definir se o serviço de expurgo estará ativo ou não. O valor default é true (habilitado).

• app.integracao-core.excluir.minimo-dias= 120

  • Este campo é responsável por definir a quantidade de dias em que os registros serão armazenados no banco. No exemplo acima, se o valor definido é 120, serão armazenados os registros até 120 dias desde a sua criação, portanto todos os registros com data inferior aos 120 dias serão deletados. O valor default é 120 dias.

• app.integracao-core.excluir.tipo-dado= 3

  • Este campo é responsável por definir o tipo de registro que será deletado. 1 para registros ENVIADOS (do WinThor para uma integração externa), 2 para registros RECEBIDOS (de uma integração externa para o WinThor) e 3 para AMBOS. O valor default é 3 - AMBOS.

• app.integracao-core.excluir.agendador=0 0 2 * * *

  • Este campo é responsável por definir o horário no qual o serviço será agendado para executar. O modelo segue o formato de string unix-cron, sendo que cada informação possui a seguinte representação: Segundos, Minutos, Horas, Dia, Mes, Dia da Semana, respectivamente. O * indica recorrência. O horário default é 0 0 2 * * * (todos os dias às 02:00 am).

Acesse os serviços do Windows ('services.msc' via 'Executar') e execute o serviço  'WSH - Winthor Smart Hub'.

No arquivo de logs do WSH (C:\pcsist\produtos\winthor-integracao-core\logs\winthor-integracao-core.out.log) caso o serviço não esteja desabilitado, deverá constar a seguinte informação:

Já no caso de a última execução ter ocorrido a mais de 24 horas, o serviço irá executar o expurgo junto com a inicialização da aplicação:

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

 Cadastro de Integração nova

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.
  • Utiliza WTA - Deverá ser informado se será utilizado como processo WTA (Sim ou Não ).
  • Filial - Deverá ser selecionado o nome da filial.
  • Tempo de expiração - Deve ser informado o tempo (em segundos) para expiração do token. 
  • Token - Este campo será gerado automaticamente após a criação da Integração
  • Botão Salvar - Salva os dados adicionados.

Para adicionar uma nova validação, basta rolar a tela até o final e preencher as informações desejadas:

Tipo: Tipo da validação (serviço ou parâmetro);

Em caso de Serviço:

• Preencher o nome do serviço (Ex.: winthor-produto);
• Preencher a versão mínima esperada. Caso o requisito seja apenas que o serviço esteja instalado. pode deixar o campo em branco;
• Os campos Filial e Permite nulo não precisaram ser usados nesse cenário;

Em caso de Parâmetro:

• Preencher o nome do parâmetro (Ex.: CON_UTILIZAVENDAPOREMBALAGEM)
• Preencher o valor esperado:
  • OBS1: tratar valores booleanos como S (verdadeiro) e N (falso);
  • OBS2: caso o requisito seja apenas que o parâmetro esteja preenchido com algum valor, deixar o campo vazio e desmarcar a opção "Permite nulo?" ao lado;
• Preencher a filial do parâmetro. Caso seja um parâmetro geral, deixar o campo vazio ou preencher com filial 99;
• Caso o parâmetro deva necessariamente estar preenchido com alguma informação, desmarcar a opção "Permite nulo?";

Adicionar: O botão "Adicionar" levará o registro para a tabela de cima, com a situação igual a "Pendente", ou seja, aguardando validação;

Para realizar a validação, basta clicar no botão "Validar":

Exemplo:

Caso a barra fique verde, todos os itens foram validados com sucesso, caso fique vermelha, um ou mais itens não puderam ser validados.

Selecione a opção Rotas no Menu;

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

 Cadastro de Rota/Serviço 

Tela destinada ao cadastro de uma nova rota

• •  Código - Campo que apresentará o ID único do cadastro, este campo é gerado automaticamente.
  • ID Integração - Deverá ser informado a empresa da rota que executará a ação.
  • Descrição da Integração - Ao selecionar o ID da empresa o nome será apresentado conforme cadastrado no banco de dados.
  • Status - O status ele define se a própria rota que tá sendo criada vai ser executada ou não. Deverá selecionar uma das opções ATIVO(será executada) / INATIVO(não será executada).
  • 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.
  • Nome do Serviço - É o nome que o usuário pode dar à rota pra identificá-la depois.

 Cadastro de Rota/Serviço 

Tela destinada ao cadastro de uma nova rota

• • Nome do Serviço / Nome Layout - É o nome que o usuário pode dar ao layout pra identificá-la depois.
  • Método HTTP - É o método que será utilizado pelo layout (GET, POST, PUT, DELETE, PATCH).
  • URL - A url a qual o layout irá utilizar.
  • Query -  Query utilizada no layout para realizar as consultas necessárias conforme configurações desejadas.
  • Body - Irá preencher o bodyraw do JSON
  • Parâmetros de Header - Permite adicionar novos parâmetros ao JSON do layut

• • 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:

{
  "name": "",
  "request": {
    "method": "",
    "header": [],
    "url": {
      "raw": "",
      "query": ""
    },
    "bodyraw": ""
  },
  "response": []
}

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

• 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.

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

• 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.

• 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,

[
  {
    "operation": "shift",
    "spec": {
      "id": "idExterno[0]",
      "shipment": { "logistic_type": "ignorarImportacaoDiferente(regra)" }
    }
  }
]

• Botão Salvar - Salva os dados adicionados.

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

Cadastro de Parâmetro

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 será vinculado.
  • Global- Ao selecionar o checkbox Global, será utilizado a rota global ao invés de alguma outra selecionada (Ao selecionar a Global, a seleção de ID Rota Serviço fica desabilitada).
  • Tipo Chave - Deverá selecionar o tipo da chave que será utilizada, se vai ser um parâmetro de BODY, PARAMS ou HEADER.
  • Chave - Será o nome do parâmetro.
  • Tipo Valor -  Informação que identifica de qual natureza é o valor, pode ser uma STRING pura, um SELECT no banco ou um ENCRYPTED, um valor que armazena codificado.
    
  • Valor - Deverá informar o valor referente ao campo.
  • Botão Salvar - Salva os dados adicionados.
  • WTA - Ao selecionar o checkbox WTA, o valor definido no parâmetro será criptografado em MD5 no padrão exigido pelo Login do WTA. Caso o tipo Valor esteja como ENCRYPTED, essa opção será desativada pois a criptografia utilizará outro algoritmo;

Abaixo um exemplo de cadastro:

Clique nos 3 pontos na frente do parâmetro que deseja editar e clique em Editar.

Após alterar o campo valor, clique em Replicar para.

Selecione os parâmetros que deseja replicar o valor e clique em Confirmar.

Clique em Salvar para concluir a replicação.

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

Cadastro de fluxos

Nesta tela deverá ser informado o nome(descrição) do fluxo a ser criado;

Cadastro de fluxos

Nesta dela, podemos selecionar os recursos e as rotas necessárias para o funcionamento do fluxo. Basta clicar no recurso ao lado esquerdo e arrastar para o lado direito. Ao soltar o recurso será solicitada a informação da rota a qual aquele recurso estará associado;

A ordem na qual as informações forem inseridos nessa tela define a ordem de execução que o fluxo seguirá.

Caso tenham vários recursos já adicionados, e a ordem não esteja de acordo com o esperado, podemos mover os recursos 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 =

Feita a definição, podemos seguir para o próximo passo:

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.

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

A informação do ID independente serve para informar se uma rota depende da execução de outra para funcionar.

Ex: Se for necessário enviar uma requisição pro WTA, vai precisar fazer o login antes, então a rota que comunica com o WTA é dependente de uma rota de login que o usuário precisa definir no cadastro do fluxo

Ao clicar em concluir o fluxo é salvo.

A segunda opção que temos é a Ativar.

Essa opção ativa o fluxo para que o WSH execute o mesmo.

A terceira opção que temos é a Desativar.

Essa opção desativa o fluxo, e dessa forma o WSH não irá mais executá-lo.

A quarta opção que temos é a Excluir Fluxo.

Essa opção remove permanentemente o fluxo, impossibilitando a ativação ou desativação do mesmo. Caso o fluxo seja excluído erroneamente, será necessário criá-lo novamente.

A quinta opção que temos é a Limpar Carga

Essa opção remove todos os registros já integrados desse fluxo, independente de terem sido integrados com sucesso ou com falha. Essa opção é recomendada para caso seja necessário refazer a carga inicial de um fluxo de envio de cadastros, por exemplo.

Ao clicar nessa opção, serão informados a quantidade de registros que serão deletados. Ao prosseguir com a limpeza de carga, será necessário digitar a palavra de confirmação para concluir a limpeza.

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

Status:

Recebido: Status definido pelo WSH quando o registro é recebido para iniciar o processamento.
Processando: Status definido pelo WSH ao iniciar o processamento de um registro.
Falha: Status definido pelo WSH quando ao final da execução do fluxo houve alguma falha para integrar o registro em questão.
Sucesso: Status definido pelo WSH quando ocorreu tudo certo com a integração do registro em questão. 

Os status a seguir servem para verificar a integridade do registro no ambiente de destino, e a aplicação do WSH não possui um controle efetivo desses status.

Aguardando Processamento: Status definido quando o registro chegou ao ambiente de destino, porém ainda não foi processado.
Processado: Status definido quando o registro chegou ao ambiente de destino e já foi processado com sucesso.
Aguardando Processamento: Status definido quando o registro chegou ao ambiente de destino, porém ouve erro no processamento do mesmo.

Na tela inicial do cadastro de de/para, temos uma visualização geral dos itens já cadastrados, e também podemos utilizar os filtros para uma melhor visualização dos dados de interesse.

Cadastro de novo item

Para cadastrar um novo item de de/para, basta clicar em novo e informar os campos solicitados:

Neste exemplo usamos a tabela de produtos(PCPRODUT) para cadastrar um código alternativo para um produto:

Após preencher todos os dados, basta salvar e depois em confirmar:

Então o novo item já deve aparecer salvo na coluna de exibição:

Edição de itens

Para editar um item de de/para, basta clicar no botão de contexto (...) e editar o item que desejar:

Os dados devem vir carregados com as informações já existentes:

Basta editar o item que desejar e salvar.

Neste caso vamos apenas mudar o código externo para exemplificar:

Após salvar, o item deve estar atualizado na listagem:

Exclusão de itens

Para excluir um item de de/para, basta clicar no botão de contexto (...) e excluir o item que desejar (esta alteração é Irreversível):

Após clicar em excluir, é necessário confirmar a exclusão:

Após confirmar, um toast de confirmação será exibido informando que o item foi excluído, e o mesmo não irá mais aparecer na listagem:

Na tela inicial da seção de Transformação de Layouts temos já os campos destinados a realizar a validação de nossos layouts.

Nesta tela temos 3 campos, sendo eles;

Json de entrada: Neste campo, devemos inserir o json que queremos transformar;

Layout: Neste campo, devemos inserir o Json, que será responsável pela transformação, ou seja, o próprio layout de transformação;

Resultado/erros: Neste campo, será apresentado  o resultado da transformação, no caso de sucesso, será informado um Json com o resultado da transformação, e em caso de erro, será exibido o erro que ocorreu brevemente.

Também é possível clicar nos botões de Validar Json de Entrada e Validar Json Layout, para que seja realizado uma validação do Json antes de transformar.

Exemplificando o uso, abaixo, a demonstração de uma transformação de exemplo;

Json de Entrada:

Json de entrada:

{
  "rating": {
    "primary": {
      "value": 3
    },
    "quality": {
      "value": 3
    }
  }
}

Json do Layout: 

 [
  {
    "operation": "shift",
    "spec": {
      "rating": {
        "primary": {
          "value": "Rating",
          "max": "RatingRange"
        },
        "*": {
          "max":   "SecondaryRatings.&1.Range",
          "value": "SecondaryRatings.&1.Value",
          "$": "SecondaryRatings.&1.Id"
        }
      }
    }
  },
  {
    "operation": "default",
    "spec": {
      "Range": 5,
      "SecondaryRatings": {
        "*": {
          "Range": 5
        }
      }
    }
  }
]

Resultado: 

Neste caso, um exemplo onde ocorreu sucesso na transformação, o resultado é um Json com os dados transformados;

{
  "Rating": 3,
  "SecondaryRatings": {
    "quality": {
      "Id": "quality",
      "Value": 3,
      "Range": 5
    }
  },
  "Range": 5
}