Expandir |
---|
| Expandir |
---|
| 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 |
---|
| Totvs custom tabs box |
---|
tabs | Descompactando os arquivos, Editando arquivo de propriedades "app.properties", Parando o servido WTA, Executando jar para finalizar as configurações iniciais |
---|
ids | passo1,passo2,passo3,passo4 |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | passo1 |
---|
| 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: ![](/download/attachments/766958564/estrutura-winthor-integracao-core.png?version=1&modificationDate=1686159397070&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo2 |
---|
| 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: ![](/download/attachments/766958564/image2023-6-14_16-51-0.png?version=2&modificationDate=1700244520677&api=v2)
Exemplo dos dados que devem conter no arquivo app.properties;
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.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.
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo3 |
---|
| 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
Na tela de serviços procurar pelo serviço do Winthor Anywhere: ![](/download/attachments/766958564/image2023-6-9_9-51-24.png?version=1&modificationDate=1686315084387&api=v2)
Clicar com o botão direito sobre o serviço e clicar em "Parar" ![](/download/attachments/766958564/image2023-6-9_9-52-45.png?version=1&modificationDate=1686315166237&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | passo4 |
---|
| 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". ![](/download/attachments/766958564/exec-whintor-integracao-core.jpg?version=1&modificationDate=1686159396730&api=v2)
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. ![](https://beatrizmenezestotvs.notion.site/image/https%3A%2F%2Fs3-us-west-2.amazonaws.com%2Fsecure.notion-static.com%2F77c416a8-2140-4f41-b36c-77d355be2be3%2FUntitled.png?id=509f3418-038e-4af7-9d1a-1ab1e43a3b5e&table=block&spaceId=1cfe1170-0618-406a-91a4-66c6ec783005&width=1770&userId=&cache=v2)
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" ![](/download/attachments/766958564/image2023-6-9_10-8-28.png?version=1&modificationDate=1686316108477&api=v2)
|
|
|
Expandir |
---|
title | Configuração de rotinas |
---|
| Expandir |
---|
title | Configurando rotina 2650 |
---|
| - 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);
![](/download/attachments/766958564/rotina-801.jpg?version=1&modificationDate=1686159396333&api=v2)
- Na tela Gerenciador de Rotinas e Serviços, clique o botão Instalações;
![](/download/attachments/766958564/instal-801.jpg?version=1&modificationDate=1686573833580&api=v2)
- Instale os serviços winthor-integracao-config e winthor-integracao-2650 na última versão disponível.
|
|
Expandir |
---|
title | Configuração de integrações |
---|
| Expandir |
---|
title | Cadastro de integrações |
---|
| 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.
Totvs custom tabs box |
---|
tabs | Passo 1, Passo 2, Passo 3, Passo 4 |
---|
ids | item-int1,item-int2,item-int3,item-int4 |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | item-int1 |
---|
| Acesse o WinThor Anywhere, localize/pesquise a rotina 2650 - Winthor Smart Hub
![](/download/attachments/766958564/busca-2650.jpg?version=1&modificationDate=1686576898233&api=v2)
|
Totvs custom tabs box items |
---|
default | yes |
---|
referencia | item-int2 |
---|
| Selecione a opção Integrações no Menu;
![](/download/attachments/766958564/acesso-integra%C3%A7%C3%B5es.jpg?version=1&modificationDate=1686580762407&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-int3 |
---|
| Clique no botão Novo, (será apresentado os dados para Cadastro de Integração);
![](/download/attachments/766958564/novo-item-integra.jpg?version=1&modificationDate=1686581211127&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-int4 |
---|
| 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.
|
|
|
|
Expandir |
---|
title | Configuração de rotas |
---|
| Expandir |
---|
title | Cadastro de rotas/serviço |
---|
| 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:
Totvs custom tabs box |
---|
tabs | Passo 1, Passo 2, Passo 3, Passo 4, Passo 5, Passo 6 |
---|
ids | item-rota1,item-rota2,item-rota3,item-rota4,item-rota5,item-rota6 |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | item-rota1 |
---|
| Acesse o WinThor Anywhere, localize/pesquise a rotina 2650 - Winthor Smart Hub
![](/download/attachments/766958564/busca-2650.jpg?version=1&modificationDate=1686576898233&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-rota2 |
---|
| Selecione a opção Rotas no Menu;
![](/download/attachments/766958564/menu-rotas-2650.jpg?version=1&modificationDate=1686576953433&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-rota3 |
---|
| Clique no botão Novo, (será apresentado os dados para Cadastro de Rota/Serviço);
![](/download/attachments/766958564/clicar%20em%20novo.jpg?version=1&modificationDate=1686576983760&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-rota4 |
---|
| Cadastro de Rota/Serviço
![](/download/attachments/766958564/image2023-7-31_8-23-37.png?version=1&modificationDate=1690802617260&api=v2)
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.
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-rota5 |
---|
| Cadastro de Rota/Serviço
![](/download/attachments/766958564/image2023-7-31_8-28-9.png?version=1&modificationDate=1690802889120&api=v2)
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:
Bloco de código |
---|
language | js |
---|
title | Exemplo Comunicação |
---|
| {
"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.
![](/download/attachments/766958564/layout-trasnf.jpg?version=1&modificationDate=1686577946780&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-rota6 |
---|
| - 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.
![](/download/attachments/766958564/image2023-3-13_14-43-32.png?version=1&modificationDate=1686578119807&api=v2)
- JSON de Saída - Campo destinado a informação de como deve ficar o JSON final do processo.
![](/download/attachments/766958564/image2023-3-13_14-44-23.png?version=1&modificationDate=1686578119893&api=v2)
- 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.
![](/download/attachments/766958564/image2023-3-13_14-45-2.png?version=1&modificationDate=1686578119973&api=v2)
- 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 |
---|
language | js |
---|
title | Exemplo Transformação |
---|
| [
{
"operation": "shift",
"spec": {
"id": "idExterno[0]",
"shipment": { "logistic_type": "ignorarImportacaoDiferente(regra)" }
}
}
]
|
- Botão Salvar - Salva os dados adicionados.
|
|
|
|
Expandir |
---|
title | Configuração de Parâmetros |
---|
| Expandir |
---|
title | Cadastro 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 |
---|
title | Cadastro de parâmetros |
---|
|
|
Totvs custom tabs box |
---|
tabs | Passo 1, Passo 2, Passo 3 |
---|
ids | item-param1,item-param2,item-param3 |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | item-param1 |
---|
| No WSH, acessar o item 3 da rotina 2650, que é a configuração de parâmetros;
![](/download/attachments/766958564/acesso-parametros.jpg?version=1&modificationDate=1686580693103&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-param2 |
---|
| Clique no botão Novo, (será apresentado os dados para Cadastro de parâmetro);
![](/download/attachments/766958564/novo-param.jpg?version=1&modificationDate=1686660787037&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-param3 |
---|
| 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.
- 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, 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.
Abaixo um exemplo de cadastro:
![](/download/attachments/766958564/CADASTRO-PARAM.jpg?version=1&modificationDate=1686662576827&api=v2)
|
|
|
|
Expandir |
---|
title | Configuração de fluxos |
---|
| Expandir |
---|
| 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. É basicamente um conjunto de rotas configuradas para serem executadas em uma ordem específica Para cadastrar um novo Fluxo, devemos acessar as configurações de parâmetros através da rotina 2650 do WSH.
Totvs custom tabs box |
---|
tabs | Passo 1, Passo 2, Passo 3, Passo 4, Passo 5 |
---|
ids | item-fluxo1,item-fluxo2,item-fluxo3,item-fluxo4,item-fluxo5 |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | item-fluxo1 |
---|
| Já no WSH, acessar o item 4 da rotina 2650, que é a configuração de fluxos;
![](/download/attachments/766958564/acesso-fluxos.jpg?version=1&modificationDate=1686580676137&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-fluxo2 |
---|
| Clique no botão Novo, (será apresentado os dados para Cadastro de fluxos);
![](/download/attachments/766958564/novo-fluxo.jpg?version=1&modificationDate=1686664143520&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-fluxo3 |
---|
| Cadastro de fluxos
![](/download/attachments/766958564/image2023-6-13_16-37-35.png?version=1&modificationDate=1686685054320&api=v2)
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;
![](/download/attachments/766958564/proximo-passo-fluxo.jpg?version=1&modificationDate=1686685926810&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-fluxo4 |
---|
| Neste passo, devemos vincular as rotas em cada fluxo que foi adicionar, clicando na lupa para realizar a busca da rota; ![](/download/attachments/766958564/buscar-rotas-fluxos.jpg?version=1&modificationDate=1686686177017&api=v2)
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;
1º Buscando a rota digitando pelo nome, ou listando as mesmas sem a necessidade de digitar; 2º Clicar sobre a rota para selecionar a mesma; 3º Confirmar a rota selecionada.
![](/download/attachments/766958564/selecionando-rota-fluxo.jpg?version=1&modificationDate=1686686451070&api=v2)
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;
![](/download/attachments/766958564/proximo-passo-passo-anterior-fluxo.jpg?version=1&modificationDate=1686686768903&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-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.
![](/download/attachments/766958564/salvar-fluxo.jpg?version=1&modificationDate=1686688145447&api=v2)
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. |
|
|
|
Expandir |
---|
title | Configuração de detalhes técnicos |
---|
| Expandir |
---|
| 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.
Totvs custom tabs box |
---|
tabs | Passo 1, Passo 2, Passo 3 |
---|
ids | item-detalhes1,item-detalhes2,item-detalhes3 |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | item-detalhes1 |
---|
| Já no WSH, acessar o item 5 da rotina 2650, que é a configuração de detalhes técnicos;
![](/download/attachments/766958564/acesso-detalhes.jpg?version=1&modificationDate=1686580655917&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-detalhes2 |
---|
| 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.
![](/download/attachments/766958564/image2023-6-13_17-42-36.png?version=1&modificationDate=1686688955607&api=v2)
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | item-detalhes3 |
---|
|
|
|
|
|
|