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

From TaticView
Jump to: navigation, search
(Updating to match new version of source page)
Line 39: Line 39:
 
=== get_token_by_password ===
 
=== get_token_by_password ===
  
 +
<div class="mw-translate-fuzzy">
 
'''TVCli criando um novo token'''
 
'''TVCli criando um novo token'''
 +
</div>
  
 +
<div class="mw-translate-fuzzy">
 
Use o comando '''get_token_by_password''' para gerar uma requisição de um novo '''[[Manage_Access/pt-br#Tokens|Access TOKEN]]'''.
 
Use o comando '''get_token_by_password''' para gerar uma requisição de um novo '''[[Manage_Access/pt-br#Tokens|Access TOKEN]]'''.
 +
</div>
  
 
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  
 
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  
Line 49: Line 53:
 
   '''tvcli -cmd get_token_by_password -user <seu usuário TaticView> -password <sua senha TaticView> [-token_name "<nome/descrição do token>"]'''
 
   '''tvcli -cmd get_token_by_password -user <seu usuário TaticView> -password <sua senha TaticView> [-token_name "<nome/descrição do token>"]'''
  
 +
<div class="mw-translate-fuzzy">
 
  -cmd                  - get_token_by_password - Comando responsável em solicitar ao TaticView e armazenar o TOKEN de Acesso nas configurações do TVCli.
 
  -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).  
 
  -user                  - Seu usuário do TaticView (e-mail de acesso).  
 
  -password              - Sua senha de acesso ao TaticView.
 
  -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".         
+
  -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".
 +
</div>          
  
 
Examplo:
 
Examplo:
 
   '''tvcli -cmd get_token_by_password -user meuemail@email.com -password 123466 -token_name "TVCli Servidor 1" '''
 
   '''tvcli -cmd get_token_by_password -user meuemail@email.com -password 123466 -token_name "TVCli Servidor 1" '''
 +
 +
=== store_token ===
 +
 +
 +
'''TVCli store/save token on local repository'''
 +
 +
Use '''store_token''' command to store a previously generated '''[[Manage_Access#Tokens|access TOKEN]]''' in TVCli Token Store.
 +
 +
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
 +
 +
 +
Command Syntax:
 +
  '''tvcli -cmd store_token -user <your TaticView user> -token <the token generated on TaticView> [-token_name "<token name>"]'''
 +
 +
 +
  -cmd                  - store_token - The command save the informed '''[[Manage_Access#Tokens|access TOKEN]]''' the TVCli Token Store for future use.
 +
  -user                  - Your TaticView user (access e-mail).
 +
  -token                - the '''[[Manage_Access#Tokens|access TOKEN]]'''.
 +
  -token_name (optional) - The name you want to set to your '''[[Manage_Access#Tokens|access TOKEN]]'''. The default name '''TaticView CLI''' will be set if you do not specify a name.       
 +
 +
 +
Example:
 +
  '''tvcli -cmd store_token  -user myemail@email.com -token 9bdr845gh5r4r1vd5d5 -token_name "TVCli Server 1" '''
  
 
===version===
 
===version===

Revision as of 18:24, 14 July 2022

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

Examplo:

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

store_token

TVCli store/save token on local repository

Use store_token command to store a previously generated access TOKEN in TVCli Token Store.

You can see a tutorial to help in this process, and we have a graphic wizard interface to help you on building a complete command


Command Syntax:

 tvcli -cmd store_token -user <your TaticView user> -token <the token generated on TaticView> [-token_name "<token name>"]


 -cmd                   - store_token - The command save the informed access TOKEN the TVCli Token Store for future use.
 -user                  - Your TaticView user (access e-mail).
 -token                 - the access TOKEN.
 -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:

 tvcli -cmd store_token  -user myemail@email.com -token 9bdr845gh5r4r1vd5d5 -token_name "TVCli Server 1" 

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