View source for TVCli Commands Reference

<languages/>
<translate>
== TVCli Commands Reference  == <!--T:27-->
<div style="float: right;">__TOC__</div>


<!--T:28-->
Here you can read about the commands and options available for TVCli.

=== import_file === <!--T:29-->

<!--T:30-->
'''TVCli sending data to a Datasource'''

<!--T:31-->
Use '''import_file''' to send data to a Datasource.
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 

<!--T:32-->
Command Syntax:
  '''tvcli -cmd import_file -user <your TaticView user> -datamart < data file identification code> -file "<file/spreadsheet address>" [-type "<type>"] [-wait [-notifyshare]] [-nonotifyerror]  
 '''

  <!--T:25-->
-cmd                   - import_file   - Command that uploads your files and add them to the update queue.
  -user                  - Your TaticView user (access email).
  -datamart              - The identification code of the data file obtained through the properties option on the TaticView main page.
  -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).
  -type (opcional)       - clear_and_add - Deletes every data from the TaticView's Data File and imports new data. This is TVCli's default behavior.
                           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.
  -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).
  -nonotifyerror (opcional)    - Command used to not notify the user in case of an error occurring during the update process. 
  -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. 

<!--T:26-->
Example:
  '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "\\servidor\taticview\imp\myspreadsheet.xls" '''
  '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx"'''
  '''tvcli -cmd import_file -user myemail@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\spreadsheet.xlsx" -wait'''
  '''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 myemail@email.com -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx" -type append'''
  '''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 myemail@email.com -datamart 246 -file "D:\taticview\imp\spreadsheet.xlsx" -wait'''

=== get_token_by_password === <!--T:33-->

<!--T:34-->
'''TVCli generate and store/save new token on local repository'''

<!--T:35-->
Use '''get_token_by_password''' command to request the generation of a new '''[[Manage_Access#Tokens|access TOKEN]]'''.

<!--T:36-->
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 


<!--T:37-->
Command Syntax:
  '''tvcli -cmd get_token_by_password -user <your TaticView user> -password <your TaticView password> [-token_name "<token name>"]'''

<!--T:38-->
  -cmd                   - get_token_by_password - The command responsible for requesting and storing the Access TOKEN on the TVCli settings.
  -user                  - Your TaticView user (access email).
  -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.         

<!--T:39-->
Example:
  '''tvcli -cmd get_token_by_password -user myemail@email.com -password 123466 -token_name "TVCli sample token" '''

=== store_token === <!--T:49--> 


<!--T:50-->
'''TVCli store/save token on local repository'''

<!--T:51-->
Use '''store_token''' command to store a previously generated '''[[Manage_Access#Tokens|access TOKEN]]''' in TVCli Token Store.

<!--T:52-->
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 


<!--T:53-->
Command Syntax:
  '''tvcli -cmd store_token -user <your TaticView user> -token <the token generated on TaticView>'''


  <!--T:54-->
-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 email).
  -token                 - the '''[[Manage_Access#Tokens|access TOKEN]]'''.


<!--T:55-->
Example:
  '''tvcli -cmd store_token  -user myemail@email.com -token 9bdr845gh5r4r1vd5d5'''

===version=== <!--T:40-->

<!--T:41-->
'''TVCli show version'''

<!--T:42-->
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.


<!--T:43-->
Command Syntax: 
  '''tvcli -version'''

=== show_logs=== <!--T:44-->

<!--T:45-->
'''TVCli show log'''

<!--T:46-->
''since TVCli version 1.1''

<!--T:47-->
Use the '''show_logs''' command to show the log file.

<!--T:48-->
Command Syntax: 
  '''tvcli -cmd show_logs''' - Show the current day logs'''
  '''tvcli -cmd show_logs -all''' - Show all logs in the logs directory'''





</translate>