Difference between revisions of "TVCli Commands Reference/pt-br"

From TaticView
Jump to: navigation, search
(Created page with "'''TVCli enviando dados para o DataMart'''")
 
(52 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
=== import_file ===
 
=== import_file ===
  
−
'''TVCli enviando dados para o DataMart'''
+
'''TVCli enviando dados para o Arquivo de Dados'''
  
−
Use '''import_file''' to send data to a DataMart
+
Use o '''import_file''' para enviar dados a um Arquivo de Dados.
−
You can see a [[Automate_Update_data#Updating_your_data_automatically|tutorial]] to help in this process, and we have a [[TVCli_Commands#Data_update_command|graphic wizard]] interface to help you on building a complete command
+
Você pode usar o [[Automate_Update_data/pt-br#Atualizando_seus_dados_de_forma_autom.C3.A1tica|tutorial]] para ajudá-lo neste processo, além disso temos um [[TVCli_Commands/pt-br#Atualizando_Dados|Wizard]] que constrói o comando completo para você
  
−
 
+
Sintaxe do comando:
−
Command Syntax:
+
   '''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]   
−
   '''tvcli -cmd import_file -user <your TaticView user> -datamart <data file identification code> -file "<file/spreadsheet address>" [-type "<type>"] [-wait [-notifyshare]] [-nonotifyerror]   
 
 
  '''
 
  '''
  
−
   -cmd                  - import_file  - Command that uploads your files and add them to the update queue.
+
   -cmd                  - import_file  - Comando que faz o upload do seu arquivo/planilha e coloca na fila de atualização.
−
  -user                  - Your TaticView user (access e-mail).
+
-user                  - Seu usuário TaticView (email de acesso).
−
  -datamart              - The identification code of the data file obtained through the properties option on the TaticView main page.
+
-datamart              - Código identificador do arquivo de dados obtido na opção Propriedades do Arquivo de Dados, na tela principal do TaticView.
−
  -file                  - The address of the text (CSV) or spreadsheet (XLSX, XLS, XLSM) data file that will be updated. You can use mapped drives (Ex.: C:\, D:\) or UNC address (Ex.: \\server\folder\file).
+
-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 - Deletes every data from the TaticView's Data File and imports new data. This is TVCli's default behavior.
+
-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        - It adds new data to your TaticView's data files file/spreadsheet while still keeping the previously imported data. It's important to make sure to not duplicate any data.
+
                          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)      - Command that makes TVCli wait the end of your data updates along with TaticView. It's necessary in case you want to test commands responses (ERROR_LEVEL).
+
-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)    - Command used to not notify the user in case of an error occurring during the update process.  
+
-nonotifyerror (opcional)    - Comando utilizado para NÃO notificar o usuário caso ocorra um erro durante o processo de atualização.
−
  -notifyshare (opcional) - Command used to send a notification to the users who own shared dashboards informing that the data update finished successfully. This command only works when used with the <i>-wait</i> command.  
+
-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.  
  
−
Example:
+
tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "\\server\taticview\imp\myspreadsheet.xls"
−
  '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "\\servidor\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 myemail@email.com -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx"'''
+
tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "c:\taticview\imp\file.csv" -wait -notifyshare
−
  '''tvcli -cmd import_file -user myemail@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 myemail@email.com -datamart 246 -file "C:\taticview\imp\spreadsheet.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 myemail@email.com -datamart 246 -file "C:\taticview\imp\spreadsheet.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 myemail@email.com -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx" -type append'''
+
tvcli -cmd import_file -user meuemail@email.com -datamart 246 -file "c:\taticview\imp\file.xlsx" -type append -nonotifyerror
−
  '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "C:\taticview\imp\spreadsheet.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
−
  '''Call "C:\Program Files\TvCli\tvcli" -cmd import_file -user myemail@email.com -datamart 246 -file "D:\taticview\imp\spreadsheet.xlsx" -wait'''
 
  
 
=== get_token_by_password ===
 
=== get_token_by_password ===
  
−
'''TVCli get new token'''
+
'''TVCli criando e armazenando no repositório local um novo token'''
 +
 
 +
Use o comando '''get_token_by_password''' para gerar uma requisição de um novo '''[[Manage_Access/pt-br#Tokens|access TOKEN]]'''.
 +
 
 +
Você pode ler nosso [[Automate_Update_data/pt-br#Atualizando_seus_dados_de_forma_autom.C3.A1tica|tutorial]] para ajudá-lo no nosso processo, além disso, temos um [[TVCli_Commands/pt-br#Atualizando_Dados|Wizard]] para construir um comando completo
 +
 
 +
 
 +
Sintaxe do comando:
 +
  '''tvcli -cmd get_token_by_password -user <seu usuário TaticView> -password <sua senha TaticView> [-token_name "<nome/descrição do 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 (email 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".       
 +
 
 +
Examplo:
 +
  '''tvcli -cmd get_token_by_password -user meuemail@email.com -password 123466 -token_name "TVCli token exemplo" '''
 +
 
 +
=== store_token ===
  
−
Use '''get_token_by_password''' command to request the generation of a new '''[[Manage_Access#Tokens|Access TOKEN]]'''.
 
  
−
You can see a [[Automate_Update_data#Updating_your_data_automatically|tutorial]] to help in this process, and we have a [[TVCli_Commands#Token_creation_command|graphic wizard]] interface to help you on building a complete command
+
'''TVCli salva/armazena um token no repositório local'''
 +
 
 +
Use o comando '''store_token''' para salvar um '''[[Manage_Access/pt-br#Tokens|access TOKEN]]''' previamente gerado no repositório local de tokens do TVCli.
 +
 
 +
Você pode ler nosso [[Automate_Update_data/pt-br#Atualizando_seus_dados_de_forma_autom.C3.A1tica|tutorial]] para ajudá-lo no nosso processo, além disso, temos um [[TVCli_Commands/pt-br#Token_creation_command|wizard]] para construir um comando completo
  
  
 
Command Syntax:
 
Command Syntax:
−
   '''tvcli -cmd get_token_by_password -user <your TaticView user> -password <your TaticView password> [-token_name "<token name>"]'''
+
   '''tvcli -cmd store_token -user <seu usuário TaticView> -token <token gerado no TaticView>'''
 +
 
 +
 
 +
  -cmd                  - store_token - Comando responsável por armazenar o '''[[Manage_Access/pt-br#Tokens|access TOKEN]]''' gerado diretamente no TaticView para uso futuro do TVCli.
 +
  -user                  - Seu usuário do TaticView (email de acesso).
 +
  -token                 - O '''[[Manage_Access/pt-br#Tokens|access TOKEN]]'''.
  
−
-cmd                  - get_token_by_password - The command responsible for requesting and storing the Access TOKEN on the TVCli settings.
 
−
  -user                  - Your TaticView user (access e-mail).
 
−
  -password              - Your TaticView access password.
 
−
  -token_name (optional) - The name you want to set to your Access TOKEN. The default name '''TaticView CLI''' will be set if you do not specify a name.       
 
  
 
Example:
 
Example:
−
   '''tvcli -cmd get_token_by_password -user myemail@email.com -password 123466 -token_name "TVCli Server 1" '''
+
   '''tvcli -cmd store_token  -user meuemail@email.com -token 9bdr845gh5r4r1vd5d5'''
  
 
===version===
 
===version===
  
−
'''TVCli show version'''
+
'''Visualizando a versão do TVCli'''
  
−
Use the '''version''' command to see which TVCli version is installed on your computer. This command displays the TVCli version on the console and registers it on the TVCli log.
+
Use o comando '''version''' para saber qual a versão do TVCli está sendo executada. Este comando mostra a versão na console do sistema operacional e também a registra na log.
  
  
−
Command Syntax:  
+
Sintaxe do Commando :  
 
   '''tvcli -version'''
 
   '''tvcli -version'''
  
 
=== show_logs===
 
=== show_logs===
  
−
'''TVCli show log'''
+
'''Mostrando a log do TVCli'''
  
−
''since TVCli version 1.1''
+
''a partir da versão 1.1''
  
−
Use the '''show_logs''' command to show the log file.
+
Use o comando'''show_logs''' para mostrar o arquivo de log das execuções do TVCli no console do sistema operacional.
  
−
Command Syntax:
+
tvcli -cmd show_logs - Exibe as logs do dia atual
−
  '''tvcli -cmd show_logs''' - Show the current day logs'''
+
tvcli -cmd show_logs -all - Exibe todas as logs do diretório tvcli\logs
−
  '''tvcli -cmd show_logs -all''' - Show all logs in the logs directory'''
 

Latest revision as of 13:34, 15 April 2023

Other languages:
English • ‎português do Brasil

Referência de comandos do TVCli


Aqui você descrevemos os comandos do TVCli e suas opções.

import_file

TVCli enviando dados para o Arquivo de Dados

Use o import_file para enviar dados a um Arquivo de Dados. Você pode usar o tutorial para ajudá-lo neste processo, além disso temos um Wizard que constrói o comando completo para você

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 (email 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. 

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

get_token_by_password

TVCli criando e armazenando no repositório local um novo token

Use o comando get_token_by_password para gerar uma requisição de um novo access TOKEN.

Você pode ler nosso tutorial para ajudá-lo no nosso processo, além disso, temos um Wizard para construir um comando completo


Sintaxe do comando: 

 tvcli -cmd get_token_by_password -user <seu usuário TaticView> -password <sua senha TaticView> [-token_name "<nome/descrição do 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 (email 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".

Examplo: 

 tvcli -cmd get_token_by_password -user meuemail@email.com -password 123466 -token_name "TVCli token exemplo"

store_token

TVCli salva/armazena um token no repositório local

Use o comando store_token para salvar um access TOKEN previamente gerado no repositório local de tokens do TVCli.

Você pode ler nosso tutorial para ajudá-lo no nosso processo, além disso, temos um wizard para construir um comando completo


Command Syntax: 

 tvcli -cmd store_token -user <seu usuário TaticView> -token <token gerado no TaticView>



 -cmd                   - store_token - Comando responsável por armazenar o access TOKEN gerado diretamente no TaticView para uso futuro do TVCli.
 -user                  - Seu usuário do TaticView (email de acesso).
 -token                 - O access TOKEN.


Example: 

 tvcli -cmd store_token  -user meuemail@email.com -token 9bdr845gh5r4r1vd5d5

version

Visualizando a versão do TVCli

Use o comando version para saber qual a versão do TVCli está sendo executada. Este comando mostra a versão na console do sistema operacional e também a registra na log.


Sintaxe do Commando : 

 tvcli -version

show_logs

Mostrando a log do TVCli

a partir da versão 1.1

Use o comandoshow_logs para mostrar o arquivo de log das execuções do TVCli no console do sistema operacional. 

tvcli -cmd show_logs - Exibe as logs do dia atual 
tvcli -cmd show_logs -all - Exibe todas as logs do diretório tvcli\logs
Retrieved from "http://wiki.taticview.com/index.php?title=TVCli_Commands_Reference/pt-br&oldid=30275"