Automate Update data
- 1 Installing TVCli
- 2 Generating the Access TOKEN
- 3 Updating your data automatically
- 4 Running TVCli from BAT (Script) file
- 5 More questions on how generate the automation commands?
- 6 Other TVCli commands
With TaticView, you can automate the update of your Data Files.
To do so, it is necessary to adjust the settings and to use the command line program TVCli.
See below the required steps to automate the data updates.
- To use TVCli, the computer where it will be configured must have java from version 8 installed. If you use a Java minor version the message "Unsupported major.minor version 52.0" will be showed.
- A notification will be displayed to the user if an error occurred during the data update.
- A log with the execution details will be generated in the user's settings folder (Example: C:\Users\<user>\AppData\Local\TVCli\Logs).
Download the installer first
The browser can try to block the installer download. If you can't download please enter in contact with our support. Windows can too block the installer execution to protect the computer. In this case continue the installation choosen advanced options. In both situations if you need contact us to help you.
Run the installation on the machine where the schedules will be created to run the TVCli. TVCli works through command line. After you have created the executable containing the disered command, you can schedule its running process through your disered task scheduler.
Generating the Access TOKEN
To automate the data updates through TCVli, it is necessary to own an Access TOKEN created on TaticView and then register it on TVCli.
An Access TOKEN is always linked to a TaticViwe user. The TOKEN works like a TaticView generated password that allows access to TVCli. The TOKEN can be revoked at any moment, allowing you to decide who can access your TaticView account and when. It is important to remember that this access only allows the update of data files that are set to be automatically updated.
There are two ways to generate an Access TOKEN:
Using TVCli (command line)
Run the command through a command line requesting the generation of an Access TOKEN.
tvcli -cmd get_token_by_password -user <your TaticView user> -password <your TaticView password> [-token_name "<token name>"]
-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.
tvcli -cmd get_token_by_password -user firstname.lastname@example.org -password 123466 -token_name "TVCli Server 1"
Using TaticView's graphical interface
- On the TaticiView home screen, select My Acount and click on the Access TOKENS button;
- On inform a name to identify your Access TOKEN on the list and select Generate new TOKEN;
- A new Access TOKEN will be generated
- Run the TVCli TOKEN storing command (store_token), informing the last generated TOKEN;
tvcli -cmd store_token -user <your TaticView user> -token <the token generated on TaticView>
-cmd - store_token - The command responsible for storing the TOKENS generated on TaticView. -user - Your TaticView user (access e-mail). -token - The token generated on TaticView.
tvcli -cmd store_token -user email@example.com -token 9bdr845gh5r4r1vd5d5
Updating your data automatically
You can only automate the update of files that exist on TaticView. It will be necessary to import your file/spreadsheet manually for the first time to generate the required structure.
After that, it will be necessary to enable the automatic update to the desired data file. For this you must access the properties of the desired Datasource. Access is available in the context menu of the Datasource card in the TaticView main page:
|In mobile devices|
Then, the Automatic importation option should be enabled. When you do this, you will see the data file code, as in the example below:
You can execute the data import automatically using the identifier code through command line if the data file has permission to be updated automatically.
tvcli -cmd import_file -user <your TaticView user> -datamart -file "<file/spreadsheet address>" [-type "<type>"] [-wait [-notifyshare]] [-nonotifyerror]
-cmd - import_file - Command that uploads your files and add them to the update queue. -user - Your TaticView user (access e-mail). -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 -wait command.
tvcli -cmd import_file -user firstname.lastname@example.org -datamart 246 -file "\\servidor\taticview\imp\myspreadsheet.xls" tvcli -cmd import_file -user email@example.com -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx" tvcli -cmd import_file -user firstname.lastname@example.org -datamart 246 -file "C:\taticview\imp\file.csv" -wait -notifyshare tvcli -cmd import_file -user email@example.com -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx" -wait tvcli -cmd import_file -user firstname.lastname@example.org -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx" -type clear_and_add tvcli -cmd import_file -user email@example.com -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx" -type append tvcli -cmd import_file -user firstname.lastname@example.org -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx" -type append -nonotifyerror Call "C:\Program Files\TvCli\tvcli" -cmd import_file -user email@example.com -datamart 246 -file "D:\taticview\imp\spreadsheet.xlsx" -wait
Running TVCli from BAT (Script) file
You can create BAT files to schedule a bunch of TVCli commands. Doing so the entire process can be automated. As you can schedule using Windows scheduler or other similar tool.
To execute TVCli from a BAT file, you have to use the Windows CALL command. Ie.:
CALL C:\TaticView\tvcli -cmd import_file -user firstname.lastname@example.org -file "C:\Users\jonathan\Documents\TaticView\Import Files\rh.xlsx" -datamart 673 -wait
Evaluating if command execution was successful
At end of a command execution, TVCli returns specific codes to inform the success or failure of the command. This allows the BAT file to verify if the previous TVCli command was completed successfully.
Currently, the available codes are:
0 - Success 8 - Error
You can perform treatments in your automation script based on these return codes. For this you can use ERROLEVEL Windows environment variable. Ie.:
if %errorlevel% == 0 ( echo SALES updated successfully! ) else ( echo Problems updating SALES! )
BAT (Script) example
Bellow we show you a script sample that imports two files to different DataMarts (ids 674 and 673) and test the ERRORLEVEL environment variable to evaluate if the data update was done successfully.
@ECHO OFF call C:\TaticView\tvcli -cmd import_file -user email@example.com -file "C:\TaticView\Import Files\sales.xlsx" -datamart 674 -wait if %errorlevel% == 0 ( echo SALES updated successfully! ) else ( echo Problems updating SALES! ) call C:\TaticView\tvcli -cmd import_file -user firstname.lastname@example.org -file "C:\TaticView\Import Files\hr.xlsx" -datamart 673 -wait if %errorlevel% == 0 ( echo HR updated successfully! ) else ( echo Problems updating HR! )
More questions on how generate the automation commands?
TaticView has a wizard the help you on this, on the Data Files properties screen, when clicking the link help to generate automation commands?, it will display the TVCli Commands screen, where you can obtain preset TVCli commands. All you have to do is inform some required data.
You can also open a support ticket. In case you are having problems during the TVCli configuration process. It will be a pleasure to help you.
Other TVCli commands
TVCli show version
You can run 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.
TVCli show log
since TVCli version 1.1
You can run the show_logs command to show the log file.
tvcli -cmd show_logs - Show the current day logs tvcli -cmd show_logs -all - Show all logs in the logs directory