Difference between revisions of "Automate Update data/pt-br"

From TaticView
Jump to: navigation, search
Line 141: Line 141:
 
==== Avaliando se o comando do TVCli foi executado com sucesso====
 
==== Avaliando se o comando do TVCli foi executado com sucesso====
  
<div class="mw-translate-fuzzy">
+
Ao final da execução do comando o TVCli retorna códigos distintos para informar o sucesso ou falha na execução de seus comandos. Isto permite que os arquivos BAT verifiquem se a execução prévia do comando pelo TVCli teve sucesso ou não.
O executável do TVCli retorna códigos distintos para informar o sucesso ou falha na execução de seus comandos. Os códigos atualmente disponíveis são:
 
</div>
 
  
 
Currently, the available codes are:
 
Currently, the available codes are:

Revision as of 19:35, 16 July 2021

Other languages:
English • ‎português do Brasil


Com o TaticView é possível automatizar as atualizações das informações dos seus Arquivos de Dados.

Para isso, são necessários alguns procedimentos de configuração e também a utilização do programa de linha de comando TVCli.

Veja abaixo os passos necessários para automatizar a atualização dos seus dados.


Importante:

  • Para utilizar o TVCli, a máquina onde o mesmo será configurado deverá possuir o java a partir da versão 8 instalado. Se for executada uma versão de Java inferior a 8 será exibida uma mensagem de erro "Unsupported major.minor version 52.0".
  • Uma notificação será enviada para o usuário caso ocorra erro na atualização.
  • Uma log com os detalhes das execuções será gerada no diretório de configurações do usuário (exemplo: C:\Usuários\<usuário>\AppData\Local\TVCli\Logs).


Instalando o TVCli

Primeiramente baixe o instalador:


Atenção
O navegador pode tentar bloquear o download do instalador. Se você não conseguir fazer o download, entre em contato com o nosso suporte. O Windows também pode bloquear a execução do instalador para proteger o computador. Nesse caso, continue a instalação através da opção "Mais informações".

Nas duas situações, se você precisar, entre em contato conosco para ajudá-lo.


Depois execute a instalação na máquina onde serão criados os agendamentos para a execução do TVCli. O TVCli funciona através de linha de comando. Após criar o executável contendo o comando desejado, você pode agendar a execução do mesmo, utilizando um agendador de tarefas de sua preferência.


Geração do TOKEN de Acesso

Para automatizar as atualizações de dados através do TVCli, é necessário possuir um TOKEN de Acesso criado no TaticView e, posteriormente, cadastrado no TVCli.

Um TOKEN de Acesso está sempre associado a um usuário TaticView e é como uma senha gerada pelo TaticView que permite acesso a sua conta pelo TVCli. Ele pode ser revogado por você a qualquer momento, permitindo assim que você decida quem pode acessar sua conta no TaticView e quando. Lembrando que este acesso permite apenas a atualização dos Arquivos de Dados que estão configurados para serem atualizados automaticamente. O Acesso a seus painéis é liberado exclusivamente utilizando o seu usuário e senha.


É possível gerar o TOKEN de Acesso de duas maneiras:


Usando TVCli (linha de comando)

Executar o comando via linha de comando do Windows o pedindo de geração de um novo TOKEN de Acesso


Sintaxe do Comando:

 tvcli -cmd get_token_by_password -user <seu usuário TaticView> -password <sua senha TaticView> [-token_name "<nome para o token>"]

 -cmd                   - get_token_by_password - Comando responsável em solicitar ao TaticView e armazenar o TOKEN de Acesso nas configurações do TVCli.
 -user                  - Seu usuário do TaticView (e-mail de acesso). 
 -password              - Sua senha de acesso ao TaticView.
 -token_name (opcional) - Nome que você deseja atribuir ao TOKEN de Acesso. Caso você não informe nenhum nome será atribuído o nome padrão "TaticView CLI".         

Exemplo:

 tvcli -cmd get_token_by_password -user meuemail@email.com -password 123466 -token_name "TVCli Servidor 1"

Usando a interface gráfica do TaticView

  1. Na tela principal do TaticView, acesse a opção Minha Conta e clique no botão TOKENS de Acesso;
  2. Em Identificacao-novo-token+pr-BR.png informe um nome para identificar o TOKEN de Acesso na lista e clique em GERAR NOVO TOKEN.
  3. Um TOKEN de Acesso será gerado Generated-token+pr-BR.png
  4. Execute o comando de armazenamento de TOKENS do TVCli (store_token), informando o TOKEN recém gerado.


Sintaxe do Comando:

 tvcli -cmd store_token -user <seu usuário TaticView> -token <token gerado no TaticView>
 -cmd   - store_token - Comando responsável por armazenar os tokens gerados diretamente no TaticView.
 -user  - Seu usuário do TaticView (e-mail de acesso). 
 -token - Token gerado no TaticView.

Exemplo:

 tvcli -cmd store_token -user meuemail@email.com -token ce699ce43dcbd2caeff1573eeb1d4e44

Atualizando seus dados de forma automática

Somente é possível automatizar a atualização de arquivos de dados já criados no TaticView. Portanto é necessário realizar pelo menos uma importação manual do seu arquivo/planilha para que a estrutura necessária seja criada no TaticView.

Após, é necessário liberar a atualização automática para o Arquivo de Dados desejado. Para isso você deverá acessar as propriedades do arquivo de dados desejado. O acesso está disponível no menu de contexto do cartão do arquivo de dados, na página principal do TaticView:

No desktop
Datasources properties pt-BR.png
Nos dispositivos móveis
Datasources options mobile pt-BR.png Datasources properties mobile pt-BR.png


Em seguida, a opção Atualização automática deverá ser habilitada. Ao fazer isso, será exibido o código do arquivo de dados, como no exemplo abaixo:


Automatic-importation+pr-BR.PNG


Estando o arquivo de dados liberado para atualização automática, será possível executar a atualização dos dados automaticamente por linha de comando, utilizando o seu código identificador.


Sintaxe do Comando:

 tvcli -cmd import_file -user <seu usuário TaticView> -datamart <código identificador do arquivo de dados> -file "<caminho para o arquivo/planilha>" [-type "<tipo>"] [-wait [-notifyshare]] [-nonotifyerror]  
 -cmd                   - import_file   - Comando que faz o upload do seu arquivo/planilha e coloca na fila de atualização.
 -user                  - Seu usuário TaticView (e-mail de acesso).
 -datamart              - Código identificador do arquivo de dados obtido na opção Propriedades do Arquivo de Dados, na tela principal do TaticView.
 -file                  - Caminho onde encontra-se o seu arquivo de dados Texto (CSV) ou planilha (XLSX, XLS, XLSM) que será importado. Você pode utilizar unidades mapeadas (Ex.: C:\, D:\) ou então caminhos UNC (Ex.: \\servidor\pasta\arquivo).
 -type (opcional)       - clear_and_add - Exclui todos os dados do Arquivo de Dados do TaticView e importa os novos dados. Este é o comportamento padrão do TVCli.
                          append        - Adiciona dados do seu arquivo/planilha no Arquivo de Dados do TaticView, mantendo os dados importados anteriormente. É necessário ter cuidado para não duplicar dados.
 -wait (opcional)       - Comando que faz o TVCli aguardar o final da atualização dos seus dados junto ao TaticView. Necessário caso você queira efetuar testes de retorno dos comandos.
 -nonotifyerror (opcional)    - Comando utilizado para NÃO notificar o usuário caso ocorra um erro durante o processo de atualização.
 -notifyshare (opcional) - Comando utilizado para enviar uma notificação de atualização dos dados para os usuários que possuem painéis compartilhados desse arquivo de dados quando a importação termina sem erros. Funciona somente em conjunto com o comando -wait. 

Exemplos:

 tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "\\server\taticview\imp\myspreadsheet.xls"
 tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "c:\taticview\imp\file.xlsx"
 tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "c:\taticview\imp\file.csv" -wait -notifyshare
 tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "c:\taticview\imp\sales.xlsx" -wait
 tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "c:\taticview\imp\file.xlsx" -type clear_and_add
 tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "c:\taticview\imp\file.xlsx" -type append
 tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "c:\taticview\imp\file.xlsx" -type append -nonotifyerror
 Call "C:\Program Files\TvCli\tvcli" -cmd import_file -user meuemail@email.com -datamart 246 -file "D:\taticview\imp\file.xlsx" -wait

Executando TVCli em um arquivo BAT (Script)

Você pode criar arquivos BAT para agendar vários comandos ao TVCli. Fazendo isso, o processo inteiro de atualização de dados pode ser automatizado. Já que você pode agendar a execução destes arquivos BAT no agendador do Windows, ou em uma ferramenta similar.


Atenção
Para executar o TVCli em um arquivo BAT, é necessário usar o comando CALL do Windows. Por exemplo:

CALL C:\TaticView\tvcli -cmd import_file -user jonathan@sadig.com -file "C:\Users\jonathan\Documents\TaticView\Import Files\rh.xlsx" -datamart 673 -wait


Avaliando se o comando do TVCli foi executado com sucesso

Ao final da execução do comando o TVCli retorna códigos distintos para informar o sucesso ou falha na execução de seus comandos. Isto permite que os arquivos BAT verifiquem se a execução prévia do comando pelo TVCli teve sucesso ou não.

Currently, the available codes are:

0 - Sucesso

 8 - Erro

Com base nesses códigos de retorno, é possível efetuar tratamentos no seu script de automação.

if %errorlevel% == 0 (
   echo SALES updated successfully!
) else (
   echo Problems updating SALES!
)

Exemplo de Script

@ECHO OFF

call C:\TaticView\tvcli -cmd import_file -user jonathan@sadig.com -file "C:\Usuários\jonathan\Documentos\TaticView\Arquivos Importacao\Vendas.xlsx" -datamart 674 -wait
if %errorlevel% == 0 (
	echo VENDAS atualizado com sucesso!
) else (
	echo Problemas na atualizacao do VENDAS!
)
call C:\TaticView\tvcli -cmd import_file -user jonathan@sadig.com -file "C:\Usuários\jonathan\Documentos\TaticView\Arquivos Importacao\rh.xlsx" -datamart 673 -wait
if %errorlevel% == 0 (
  	echo RH atualizado com sucesso!
) else (
  	echo Problemas na atualizacao do RH!
)

Dúvidas sobre como gerar os comandos de automação?

Além disso, na tela de propriedades dos Arquivos de Dados ao clicar no link Ajuda para gerar os comandos de automação? será exibida a tela Comandos TVCli onde você poderá obter os comandos do TVCli já configurados, basta informar alguns dados necessários.

Caso tenha dificuldades durante o processo de configuração do TVCli, abra um ticket de suporte. Teremos prazer em lhe ajudar.


Other TVCli commands

Versão TVCli

Para visualizar em qual versão o TVCli instalado em sua máquina está, é possível executar o comando -version. Este comando mostra a versão do TVCli na console e também registra na log do TVCli.


Sintaxe do Comando:

 tvcli -version

Logs do TVCli (a partir da versão 1.1)

since TVCli version 1.1

Para exibir as logs do TVCli você pode executar o comando com a opção show_logs.

Sintaxe do comando:

 tvcli -cmd show_logs - Exibe as logs do dia atual 
 tvcli -cmd show_logs -all - Exibe todas as logs do diretório tvcli\logs