<languages/>
<div style="float: right;">__TOC__</div>
<!--== '''Data Import update automation on TaticView''' ==-->
You With TaticView, you can automate the data update of your [[Data_Sources|Data Files]].
Some setup procedures To do so, it is necessary to adjust the settings and to use the use of command line program [[TVCli]] command line program are necessary . See below the required steps to automate the data updates on TavicView. <span style="color: red;">'''Important:'''</span> * To use TVCli, the computer where it will be configured must have java from version <i>8</i> installed. If you use a Java minor version the message "Unsupported major.minor version 52.0" will be showed, see [[Java JRE install and troubleshooting]] for help.* 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: <i>C:\Users\<user>\AppData\Local\TVCli\Logs</i>).
If you are having trouble, open a support ticket on https://support.taticview.com/open.php. We are glad to help you.
=== Installing TVCli ===
For now, we have only a user friendly installer for Windows. If you need install TVCli in other platforms, please contact us at <u>[https://support.taticview.com Support]</u>. We are glad to to help you to install it in you environment.
* '''Download the [[TVCli Download|latest version]]
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 choosing the advanced options.
In both situations if you need contact us to help you.
* '''Run the installation''' on the computer where the schedules will be created to run the TVCli.
TVCli works through command line. The best way to automate the execution is creating a script, after that, you can schedule it to run on the system task scheduler.<br/>
To install and execute TVCli on you computer we need Java JRE version 1.8.0_200 or newer installed.<br/>
On [[Java JRE install and troubleshooting]] we can help you in case of doubts.
=== Generating the Access TOKEN ===
To automate the data updates through TCVli, it is necessary to own an '''[[Manage_Access#Tokens|Access TOKEN]]''' created on TaticView and then register it on TVCli.
An Access TOKEN is always linked to a TaticView user. The TOKEN works like a TaticView generated password that allows access to TVCli. The TOKEN '''[[Manage_Access#Tokens|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.
Here we will show you how to generate a token whit TaticView interface.
There are two ways to generate an Access TOKEN:
The main difference between them, besides the way they are generated, is that [[#Using_TVCli_command_line|command line]] selves, while the created by [[#Using_TaticView's_graphical_interface|TaticView interface]] don't refresh them selves (expire), and need to be recreated.
====Using TVCli command line====
Run the command through a command line requesting the generation of an [[Manage_Access#Tokens|Access TOKEN]].
To help you on this, we wave a [[TVCli Commands|Wizard]]
First download the installerCommand Syntax:* '''tvcli -cmd get_token_by_password -user <uyour TaticView user> -password <your TaticView password>[http://wiki.taticview.com/taticfiles/tvcli-windows-installer.exe Windows]token_name "</utoken name> "]'''
Then run -cmd - get_token_by_password - The command responsible for requesting and storing the installation Access TOKEN on the same workstation where the files that are going 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 automatically imported areset if you do not specify a name.
=== ACCESS TOKEN generation ===Example: '''tvcli -cmd get_token_by_password -user myemail@email.com -password 123466 -token_name "TVCli Server 1" '''
You must have an '''[[Tokens|ACCESS TOKEN]]''====Using TaticView' registered on TaticView and TVCli before you can run an automation import. 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. s graphical interface====
You can Here we will show you how to generate the ACCESS TOKEN in two ways:a token whit TaticView interface.
# On the TaticiView [[Main Page Overview|home screen]], select [[User profile|My Acount]] and click on the [[Tokens|Access TOKENS]] button;
# On [[File:identificacao-novo-token+en-US.png]] inform a name to identify your Access TOKEN on the list and select '''Generate new TOKEN''';
# A new Access TOKEN will be generated [[File:generated-token+en-US.png]]
# Run the TVCli TOKEN storing command (<i>store_token</i>), informing the last generated TOKEN;
'''Through TVcli'''
# Run the command through command line requesting the generation of a new ACCESS TOKEN.
Command Syntax: '''Syntax: tvcli -cmd get_token_by_password store_token -user <your TaticView user name> -password <user password> [-token_name "token <the token namegenerated on TaticView>"]'''
-cmd - get_token_by_password store_token - Requests and stores The command responsible for storing the ACCESS TOKEN through command lineTOKENS generated on TaticView. (TVcli) -user - Your TaticView user(access email). -password - TaticView password -token_name (optional) token - The name that you want to give to the access tokengenerated on TaticView. Default name "TaticView CLI"
Example: '''Example: tvcli -cmd get_token_by_password store_token -user myemailmeuemail@email.com -password 123466 -token_name "TVCli Server 1"token 9bdr845gh5r4r1vd5d5'''
'''Through TacticView interface'''# Identify yourself on TaticView and access the '''My account''' button '''ACCESS TOKENS''';# On [[File:identificacao-novo-token+en-US.png]] enter a name to identify the ACCESS TOKEN on the list and then click on '''Generate new TOKEN'''.# An ACCESS TOKEN will be generated [[File:generated-token+en-US.png]]# Run TVcli informing the generated ACCESS TOKEN=== Updating your data automatically ===
'''Syntax: tvcli -cmd store_token -user <user name> -token <generated token>'''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.
-cmd - store_token - stores token generated through After that, it will be necessary to enable the interface -user - 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 [[Main Page Overview|TaticView user -token - The token generated through the interfacemain page]]:
'''Example{| class="images-table"| On desktop|-|[[File: tvcli Datasources properties en-US.png|link=]]|-| In mobile devices|-cmd store_token |[[File:Datasources options mobile en-user meuemail@emailUS.com png|link=]] [[File:Datasources properties mobile en-token 9bdr845gh5r4r1vd5d5'''US.png|link=]]|}
=== Updating Then, the ''Automatic importation'' option should be enabled. When you do this, you will see the data file code, as in an automated way ===the example below:
You can only automate the import of data files that have been already created on TaticView, so you are going to need at least one manual import to create the necessary structure.
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:
[[File:datamartautomatic-dropdownimportation+en-US.pngPNG]]
You can execute the data import automatically using the identifier code through command line if the data file has permission to be updated automatically.
[[File:automatic-importation+en-US.png]]
Once the Command Syntax: '''tvcli -cmd import_file -user <your TaticView user> -datamart < data file is imported, granted for automatic import and you have your identification code, you can run the import through the command line.> -file "<file/spreadsheet address>" [-type "<type>"] [-wait [-notifyshare]] [-nonotifyerror] '''
'''Syntax: tvcli -cmd - import_file - Command that uploads your files and add them to the update queue. -user < - Your TaticView user name> (access email). -datamart <identifier> -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 <type>] [(opcional) -wait clear_and_add -[notifyshare]] [Deletes every data from the TaticView's Data File and imports new data. This is TVCli's default behavior. append -nonotifyerror] 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.
Example: '''tvcli -cmd import_file - import_file user myemail@email.com -datamart 246 - uploads the data file and places it in the import queue"\\servidor\taticview\imp\myspreadsheet.xls" ''' '''tvcli -cmd import_file -user myemail@email.com - TaticView user datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx"''' '''tvcli -cmd import_file -user myemail@email.com -datamart 246 - identifier of the data file obtained in the Data "C:\taticview\imp\file properties at the interface.csv" -wait -notifyshare''' '''tvcli -cmd import_file -file user myemail@email.com -datamart 246 - Text data file (CSV) or "C:\taticview\imp\spreadsheet (XLSX,XLS) to be imported.xlsx" -wait''' '''tvcli -cmd import_file -type (opcional) user myemail@email.com - clear_and_add datamart 246 - Deletes all data from TaticView Data File and imports the new datafile "C:\taticview\imp\spreadsheet. (default)xlsx" -type clear_and_add''' append '''tvcli -cmd import_file - Adds the new data at the end of the TaticView Data Fileuser myemail@email. It is necessary to be careful not to duplicate any datacom -datamart 246 -file "C:\taticview\imp\spreadsheet.xlsx" -type append''' '''tvcli -wait (opcional) cmd import_file -user myemail@email.com -datamart 246 - waits for the end of the importfile "C:\taticview\imp\spreadsheet. It is needed to test xlsx" -type append -nonotifyerror'''Output Status ''' Call "C:\Program Files\TvCli\tvcli" -nonotifyerror (opcional) cmd import_file - does not notify the user if an error occurs during the process myemail@email.com -notifyshare (opcional) datamart 246 - sends data update notification to users who have these data file dashboards shared when the importing process ends without errors"D:\taticview\imp\spreadsheet. Only works with xlsx" -wait.'''
'''Example:''' '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -=== Running TVCli from BAT (Script) 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'''===
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.
=== TVCli version ===
Shows '''''Attention'''''<br>To execute TVCli version on console and register into log from a BAT file, you have to use the Windows [https://docs. microsoft.com/en-us/windows-server/administration/windows-commands/call CALL] command. Ie.: '''CALL''' C:\TaticView\tvcli -cmd import_file -user jonathan@sadig.com -file "C:\Users\jonathan\Documents\TaticView\Import Files\rh.xlsx" -datamart 673 -wait
'''Syntax: tvcli -version'''
==== Evaluating if command execution was successful ====
=== Command return test ===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.
The TVCI executable returns different Currently, the available codes to report the success or failure during the execution process.are:
'''0 - Success''' '''8 - Error'''
A notification is sent to the user if an error occurs during the import processYou can perform treatments in your automation script based on these return codes.A log with the details of the executions will be generated in the configuration directory of the user For this you can [https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/cc754335(example: C: \ Users \ <user> \ AppData \ Local \ TVcli \ Logsv=ws.11)use ERROLEVEL] Windows environment variable.Ie.:
if %errorlevel% == 0 (
echo SALES updated successfully!
) else (
echo Problems updating SALES!
)
An ==== BAT (Script) example of Windows running ====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 jonathanmy@sadigemail.com -file "C:\Users\jonathan.SADIG\Documents\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 jonathanmy@sadigemail.com -file "C:\Users\jonathan.Sadig\Documents\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 <span style="color: red;"i>'''Important'''help to generate automation commands?</spani>, it will display the [[TVCli Commands]] screen, where you can obtain preset TVCli commands. All you have to do is inform some required data.
The free version grants You can also open a [https://support.taticview.com/open.php/?&lang=en_US support ticket]. In case you automation import from only one data sourceare having problems during the TVCli configuration process. You need It will be a pleasure to configure the feature '''automatic data update''' in your subscription to automate the imports of more data sourceshelp you.