Um dos principais recursos do Wake OMS são suas integrações com os mais diversos sistemas. Essas integrações necessitam de configurações que visam atender suas particularidades. Para isso existe a Configuração de Integração, que cadastros com determinado número de campos que permite aos usuários customizar determinadas integrações com seus respectivos parâmetros. Veja a seguir como acessar o módulo e como criar uma configuração.
...
Nesta documentação você aprenderá sobre:
Índice | ||
---|---|---|
|
...
Acessar a Configurações de Integração
...
Os cadastros das configurações de integração deverão ser criadas e associadas à conta.
...
Vale lembrar que para acessar a Configuração de Integração,
...
a funcionalidade deverá estar habilitada nas Permissões da conta. As instruções de como fazê-lo, poderão ser vistas Aqui.
Após habilitar a funcionalidade nas permissões da conta, vá até o menu localizado no canto esquerdo, localize e clique no item de menu “Configurações”, utilize a barra de rolagem se necessário, em seguida, localize e clique no item “Integrações - Configurações”.
...
...
Recursos da Configuração de Integração
...
Na tela que será aberta, é possível localizar e editar configurações existentes. O usuário poderá realizar a busca informando a Conta/Loja principal, o Processo ou Nome da Configuração. Quanto mais informações forem preenchidas nos campos, melhor o filtro será aplicado para listar o resultado desejado. Após preencher os campos, basta clicar no ícone em formato de lupa localizado do lado direito da tela.
...
Abaixo, destacaremos alguns recursos encontrados pelo usuário assim que acessa a funcionalidade:
...
Barra de Título
A Barra de Título, localizada na linha superior da tela, traz o nome da funcionalidade aberta no momento, com uma breve descrição da sua utilidade. Auxilia o usuário a identificar por qual tela está navegando.
Conta/Loja
O campo, do tipo lista, Conta/Loja não estará habilitado para todos os usuários, mas apenas a usuários administrativos, este campo permite ao usuário filtrar a lista de configurações por cliente, facilitando a localização de determinadas configurações.
Processo
O campo processo possui característica similar ao campo Conta/Loja. Permite ao usuário utilizá-lo para buscar configurações de um determinado processo.
Nome Configuração
Assim como os campos anteriores, este permite aplicar um filtro na lista de configurações, facilitando identificar determinada configuração listada.
Botão de Busca
O botão de Busca, identificado por uma e localizado à direita dos campos Conta/Loja, Processo e Nome da Configuração, tem por objetivo executar o filtro na lista de configurações após o usuário definir o valor dos campos aqui mencionados. A aplicação do filtro poderá ser com qualquer um dos campos, assim como pela combinação deles.
Botão Adicionar
O botão Adicionar identificado pelo sinal de , deverá ser utilizado pelo usuário, sempre que este desejar adicionar uma nova configuração manualmente. Veja mais sobre este tópico Aqui.
Botão Importar Planilha
O botão Importar Planilha, identificado pelo ícone , deverá ser utilizado pelo usuário, sempre que este desejar adicionar novas configurações por meio de importação de arquivos XLSX. Veja mais sobre este tópico
Botão Exportar Excel
O botão Exportar Excel, permite ao usuário exportar a lista de registro de configurações buscadas.
...
Uma quantidade grande de registros exportados, pode tornar o processo trazer morosidade ao processo de extração da planilha.
Filtrar
No lado superior direito da tabela que lista as configurações, está localizado o campo que possibilita ao usuário filtrar informações a partir de textos digitados no campo.
Lista de Configurações
As configurações são listadas em uma tabela que ocupa a maioria da tela de Configurações de Integração. Essa tabela possui 6 colunas, sendo elas:
→ Ações: coluna por onde o usuário poderá editar determinado registro de configuração;
→ Conta: descrição da conta a qual pertence o registro de configuração.
→ Processo: descrição do processo ao qual se trata o registro.
→ Nome Config.: nome da configuração do registro.
→ Valor: principal valor definido para o registro da configuração.
→ Desc. Config. Site: descrição da funcionalidade que está sendo tratada no registro da configuração.
O usuário poderá, ainda, ordenar a lista de registros a partir de uma coluna especifica, bastando a ele, clicar no título da coluna para ordená-la em ordem crescente ou decrescente.
Paginação
Para tornar a lista de configurações mais performática e melhor a experiência do usuário, a tabela de registros foi limitada a listar 10 por página. No rodapé da tabela, ao lado direito da tela, o usuário poderá navegar pelas páginas e visualizar o total de registros carregados, ao lado esquerdo, poderá visualizar o resumo do total de registros que está sendo carregado.
...
Adicionar uma Nova Configuração de Integração
Para adicionar uma configuração, clique no botão com um sinal de + (mais), localizado do lado direito da tela ao lado do botão de busca.
Após clicar para adicionar uma nova configuração, a tela com formulário que deverá ser preenchido abrirá. Os seguintes campos deverão ser preenchidos:
...
Conta/Loja: conta principal criada para a loja ou marca;
Processo: tipo de configuração que será aplicada;
Nome da Config: nome ou descrição da configuração;
Valor: campo correspondente à feature ou conta da cliente;
Descrição Configuração Site: Descrição do serviço correspondente à configuração (ex.: Endereço do endpoint para buscar informações do estoque);
Observação: campo livre para descrever detalhes sobre a configuração;
Valores possíveis (separar valor por “;”): Trata-se de lista de valores que poderão ser exibidos para o usuário;
Tipo Campo: Tipo de campo ao qual corresponde o valor (ex: Integer, String, Float etc“etc”);
Edita Web: Indica se o valor será apenas para visualização ou se poderá ser alterado;
Permite Alteração em Massa: Indica se é possível inserção em massa através de upload de um arquivo XLSX;
...
Editar uma Configuração de Integração
Para editar uma configuração, o usuário deverá localizar o registro da Configuração de Integração que deseja alterar e clicar no ícone
...
, localizado na coluna
...
Ações. Repare que a janela de edição é similar a janela de cadastro de nova configuração, com a diferença de que os campos do formulário já estarão preenchidos:
...
Exportar Registros de Configurações
A função Exportar, localizado do lado esquerdo acima da tabela de registros, permite ao usuário extrair os dados dos registros listados.
...
As extrações servem aos usuários como relatório ou simplesmente como modelo de importação de novas configurações da loja, conforme veremos no próximo tópico.
...
Importar Configurações da Loja
Nota |
---|
Pré-requisitos Para garantir o uso correto da funcionalidade, é necessário atender aos seguintes pré-requisitos:
|
A importação de configurações da loja foi desenvolvida no intuito de centralizar e otimizar o processo de configuração, evitando trabalho manual, mitigando falhas no procedimento e encurtando o período de implantação. Essa funcionalidade poderá estar disponível apenas para contas que atendam aos pré-requisitos.
Conforme vimos no tópico anterior (Exportar Registro de Configuração), é possível utilizar uma planilha exportada como modelo de importação, tanto para novos registros de configuração, quanto para atualização de registros existentes.
...
O usuário, ao utilizar-se do método de importação, deverá tomar alguns cuidados para que o procedimento transcorra sem falhas, como atentar-se a campos vazios, caracteres inválidos, etc. O correto preenchimento dos campos, também auxiliará para que o procedimento seja executado com sucesso, por tanto, faz-se necessário atentar-se à finalidade dos campos que estão sendo preenchidos e qual o valor correto para cada um deles. Veja o resumo abaixo:
→ Conta: nome da conta da loja ao qual a configuração está sendo destinada.
→ Processo: no caso da importação de configurações, o usuário deverá utilizar o processo LinxPos-Config-Aplicacao. Trata-se do processo que busca/atualiza as configurações do PDV.
→ Nome Config.: nome da configuração que está sendo exportada. O usuário deverá se atentar para que a nomenclatura esteja correta, garantindo o êxito da importação.
→ Valor: valor da configuração. O usuário deverá se atentar para o tipo de dado utilizado pelo valor da configuração, por exemplo, se é um valor “booliano”, “strings” ou uma URL.
→ Desc. Config. Site: este campo é de texto livre, mas deverá sempre descrever a finalidade da configuração.
Veja abaixo um modelo de planilha preenchida para importação:
...
Após criar a planilha e salvá-la em uma pasta do computador, o usuário deverá clicar no botão localizado na parte superior à direita da tela e identificado pelo símbolo , a seguinte janela irá abrir:
...
Ao clicar no botão SELECIONAR ARQUIVO, uma janela de navegação pelas pastas do computador abrirá. O usuário deverá ir até a pasta onde a planilha foi salva, selecioná-la e clicar no botão Abrir. O modal deverá mostrar abaixo do botão SELECIONAR ARQUIVO, o nome da planilha com a extensão do arquivo e o ícone indicando que o arquivo poderá ser removido antes de concluir a importação.
...
O usuário poderá cancelar o procedimento clicando no botão CANCELAR ou dar continuidade no processo de importação clicando no botão IMPORTAR. Antes de seguir com a importação, o sistema irá solicitar ao usuário a confirmação do procedimento.
...
Caso toda a operação de importação ocorra sem falhas, o sistema deverá emitir uma notificação indicando o êxito no procedimento.
...
Nota: Importante salientar que as atualizações ou inclusões de novos registros não ocorrem instantaneamente. Para cada inclusão de registro ou atualização, sejam elas manuais ou via importação de planilha, será considerado o prazo de 2 minutos para que o sistema inicie o processo de inclusão ou atualização na base de dados da conta.
Veja também um vídeo demonstrativo:
...
Caso ocorra alguma falha no procedimento devido a erros no preenchimento da planilha, o sistema emitirá uma pequena notificação destacada em vermelho no canto superior direito da tela e disponibilizará a planilha para download com o campo incorreto em destaque.
Notificação de erro:
...
Exemplo 1 → Planilha indicando erro no campo Conta:
...
Note que, no exemplo mencionado acima, o campo 'Conta' está com a denominação errada. Portanto, o usuário deve corrigir o texto na planilha e efetuar o procedimento mais uma vez.
Exemplo 2 → Planilha indicando erro no campo Processo:
...
No exemplo 2 (dois), o campo que recebe o valor relativo ao 'Processo' indica erro. Repare que a última palavra depois do - (hífen) está com acentuação, quando o correto seria a palavra sem nenhuma acentuação.
Exemplo 3 - Planilha indicando erro no campo Nome Config.:
...
No exemplo 3 (três), o campo que recebe o valor referente ao nome da configuração indica erro. A ausência da letra 'e' nas siglas Danfe é o suficiente para causar uma falha no processo.
Exemplo 4 - Planilha indicando erro no campo Valor:
...
No exemplo 4 (quatro), o campo Valor recebeu os caracteres ‘10’. Como se trata, neste caso, de um campo booliano, onde os únicos valores aceitos são ‘TRUE’ ou ‘FALSE’, o sistema indicou o erro.
...
Nota: Veja mais sobre análise de falhas nas configurações de integração na documentação de uso restrito GrayLog.