Open main menu

TaticView β

Changes

Automate Update data/en

966 bytes added, 04:15, 8 March 2018
Importing a new version from external source
You can automate the data update of your Data Files.
Some setup procedures and the use of [[TVCli]] command line program are necessary to automate updates on TavicView.
If you are having trouble, open a support ticket on https://support.taticview.com/open.php. We are glad to help you.
 
 
<span style="color: red;">'''Important:'''</span> TVCli works with java from version <i>7.0_80</i>. However, we recommend using <em>Java 8</em> because <i>Java 7</i> is discontinued by Oracle.
 
=== Installing TVCli ===
First download the installer:
* <u>[http://wiki.taticview.com/taticfiles/tvcli-windows-installer.exe Windows]</u>
 
Then run the installation on the same workstation where the files that are going to be automatically imported are.
 
 
<span style="color: red;">'''Important:'''</span> TVCli works with java from version <i>7.0_80</i>. However, we recommend using <em>Java 8</em> because <i>Java 7</i> is discontinued by Oracle.
An Access TOKEN is always related with a TaticView user.
The Access TOKEN is like a password generated by TaticView which allows access to your account through TVCli.
It can be revoked by you at any time, allowing you to decide who and when can access your account on TaticView.  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. 
You can generate the Access TOKEN in two ways:
# Run the command through command line requesting the generation of a new Access TOKEN.
'''Syntax: tvcli -cmd get_token_by_password -user <user name> -password <user password> [-token_name "<token name>"]'''
-cmd - get_token_by_password - Requests and stores the ACCESS TOKEN through command line. (TVCli)
-user - TaticView user
-password - TaticView password
-token_name (optional) - The name that you want to give to the access token. Default name "TaticView CLI"
'''Example: tvcli -cmd get_token_by_password -user myemail@email.com -password 123466 -token_name "TVCli Server 1"'''
# Run TVcli informing the generated Access TOKEN
'''Syntax: tvcli -cmd store_token -user <user name> -token <generated token>'''
-cmd - store_token - stores token generated through the interface
-token - The token generated through the interface
'''Example: tvcli -cmd store_token -user meuemail@email.com -token 9bdr845gh5r4r1vd5d5'''
Then you must grant the automatic import to the desired data file.
To do this click on the imported file (On the TaticView interface), select '''Properties''', and check the checkbox '''Automatic Importation''', which displays the identifier code of your data file, as you can see in the example below:
 
After that, it will be necessary to enable the automatic update to the desired data file. To do so, access the TaticView [[Main Page Overview|main page]], click on data files, select <i>Settings</i>, and enable the <i>Automatic Update</i> option. After that, it will display the data files code on the screen. See the example below:
[[File:datamart-dropdown+en-US.png]]
[[File:automatic-importation+en-US.png]]
 
Once the data file is imported, granted for automatic import and you have your identification code, you can run the import through the command line.
'''Command Syntax: tvcli -cmd import_file -user <your TaticView user name> -datamart <identifierdata file identification code> -file "<file/spreadsheetaddress>" [-type "<type>"] [-wait [-[notifyshare]] [-nonotifyerror] '''
-cmd - import_file - uploads the data file and places it in the import queue
-wait (opcional) - waits for the end of the import. It is needed to test '''Output Status'''
-nonotifyerror (opcional) - does not notify the user if an error occurs during the process
-notifyshare (opcional) - sends data update notification to users who have these data file dashboards shared when the importing process ends without errors. Only works with -wait.
'''Example:'''
'''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 version ===
Shows TVCli version on console and register into log file.  
'''Syntax: tvcli -version'''
A notification is sent to the user if an error occurs during the import process.
A log with the details of the executions will be generated in the configuration directory of the user (example: C:\Users\<user>\AppData\Local\TVcli\Logs).
 
 
=== Questions on how generate the automation commands? ===
 
Open a [https://support.taticview.com/open.php/?&lang=en_US support ticket]. In case you are having problems during the TVCli configuration process. It will be a pleasure to help.
 
Also, on the Data Files properties screen, when clicking the link <i>help to generate automation commands?</i>, it will display the [[TVCli Generate Commands]] screen, where you can obtain preset TVCli commands. All you have to do is inform some required data.
'''echo "Problems updating HR!"
''')'''
 
 
<span style="color: red;">'''Important'''</span>
 
TaticView free subscription allows only one data source to have an automated update. You need to configure the feature '''automatic data update''' in your [[Subscriptions|subscription]] to automate the imports of more data sources.
11,677
edits