Open main menu

TaticView β

Changes

Automate Update data/en

5,058 bytes added, 13:26, 15 April 2023
Updating to match new version of source page
<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 TVcli command line program are necessary to automate imports on TavicView[[TVCli]].
If you are having trouble, open a support ticket on https://support.taticview.com/open.php. We are glad See below the required steps to help youautomate the data updates.
=== Installing TVcli ===
<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>).
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.=== Installing TVCli ===
=== ACCESS TOKEN generation ===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.
You must have an * '''ACCESS TOKEN''' 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 Download the [[TVCli. It can be revoked by you at any time, allowing you to decide who and when can access your account on TaticView. Download|latest version]]
You The browser can generate try to block the ACCESS TOKEN installer download. If you can't download please enter in two ways: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.
* '''Through TVcliRun the installation'''# Run on the computer where the command through command line requesting schedules will be created to run the generation of a new ACCESS TOKENTVCli.
'''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 TVCli works through command line. (TVCli) -user - TaticView user -password - TaticView password -token_name (optional) - The name best way to automate the execution is creating a script, after that , you want to give can schedule it to run on the access tokensystem 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. Default name "TaticView CLI"
'''Example: tvcli -cmd get_token_by_password -user myemail@email.com -password 123466 -token_name "TVcli Server 1"'''=== Generating the Access TOKEN ===
'''Through TacticView interface'''# Identify yourself on TaticView and access To automate the data updates through TCVli, it is necessary to own an '''My account''' button '''ACCESS TOKENS''';# On [[File:identificacao-novo-token+en-US.pngManage_Access#Tokens|Access TOKEN]] enter a name to identify the ACCESS TOKEN ''' created on the list TaticView and then click register it on '''Generate new TOKEN'''.# An ACCESS TOKEN will be generated [[File:generated-token+en-USTVCli.png]]# Run TVcli informing the generated ACCESS TOKEN
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 '''Syntax: tvcli -cmd store_token -user <user name> -token <generated 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.
-cmd - store_token - stores token generated through the interface
-user - TaticView user
-token - The token generated through the interface
'''Example: tvcli -cmd store_token -user meuemail@emailHere we will show you how to generate a token whit TaticView interface.com -token 9bdr845gh5r4r1vd5d5'''
There are two ways to generate an Access TOKEN:
=== Importing in an automated 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.
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:datamart-dropdown+en-US.png]]
====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]]
[[File:automatic-importation+en-US.png]]
Once the data file is imported, granted for automatic import and you have Command Syntax: '''tvcli -cmd get_token_by_password -user <your identification code, you can run the import through the command line.TaticView user> -password <your TaticView password> [-token_name "<token name>"]'''
'''Syntax: tvcli -cmd import_file - get_token_by_password - The command responsible for requesting and storing the Access TOKEN on the TVCli settings. -user < - Your TaticView user name> (access email). -datamart <identifier> password -file "<file/spreadsheet>" [Your TaticView access password. -type <type>] [token_name (optional) -wait -[notifyshare]] [-nonotifyerror] 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 - import_file - uploads the data file and places it in the import queue -user get_token_by_password - TaticView user -datamart - identifier of the data file obtained in the Data file properties at the interface. -file - Text data file (CSV) or spreadsheet (XLSX,XLS) to be imported. -type (opcional) - clear_and_add - Deletes all data from TaticView Data File and imports the new data. (default) append - Adds the new data at the end of the TaticView Data File. It is necessary to be careful not to duplicate any datamyemail@email. com -wait (opcional) password 123466 - waits for the end of the import. It is needed to test token_name "TVCli Server 1" '''Output Status''' -noerror (opcional) - does not notify the user if an error occurs during the process -notifyshare (opcinal) - sends data update notification to users who have these data file dashboards shared when the importing process ends without errors.
'''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 -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''====Using TaticView's graphical interface====
Here we will show you how to generate 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 version === TOKEN storing command (<i>store_token</i>), informing the last generated TOKEN;
Shows TVcli version on console and register into log file.
Command Syntax: '''Syntax: tvcli -versioncmd 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 email).
-token - The token generated on TaticView.
=== Command return test ===Example: '''tvcli -cmd store_token -user meuemail@email.com -token 9bdr845gh5r4r1vd5d5'''
The TVCI executable returns different codes to report the success or failure during the execution process.=== Updating your data automatically ===
'''0 - Success''' '''8 - Error'''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.
A notification is sent After that, it will be necessary to enable the user if an error occurs during automatic update to the import processdesired data file.A log with For this you must access the imports details properties of the desired ''Datasource''. Access is generated available in the logs directory, below context menu of the Datasource card in the directory where TVcli was installed.[[Main Page Overview|TaticView main page]]:
{| class="images-table"
| On desktop
|-
|[[File:Datasources properties en-US.png|link=]]
|-
| In mobile devices
|-
|[[File:Datasources options mobile en-US.png|link=]] [[File:Datasources properties mobile en-US.png|link=]]
|}
An example of Windows running script:
Then, the ''Automatic importation'tvcli -cmd import_file -user meuemail@email' option should be enabled.com -datamart 246 -When you do this, you will see the data file "ccode, as in the example below:\taticview\imp\planilha.xlsx" -wait -notifyshare''' '''if errorlevel <> 0''' '''Error notification by email''' '''fi'''
<span style="color[[File: red;">'''Important'''</span>automatic-importation+en-US.PNG]]
 You can execute the data import automatically using the identifier code through command line if the data file has permission to be updated automatically.  Command Syntax: '''tvcli -cmd import_file -user <your TaticView user> -datamart < data file identification code> -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 email). -datamart - The identification code of the data file obtained through the properties option on the TaticView main page. -file - The free version grants 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 automation import from 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 one data sourceworks when used with the <i>-wait</i> command.  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''' === Running TVCli from BAT (Script) file === You need 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.  '''''Attention'''''<br>To execute TVCli 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  ==== 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 configure verify if the feature previous TVCli command was completed successfully. Currently, the available codes are:  '''automatic 0 - Success''' '''8 - Error''' You can perform treatments in your automation script based on these return codes.For this you can [https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/cc754335(v=ws.11) 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 updatewas done successfully.  '''@ECHO OFF''' '' in your subscription 'call C:\TaticView\tvcli -cmd import_file -user my@email.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 my@email.com -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 <i>help to automate generate automation commands?</i>, it will display the imports of more [[TVCli Commands]] screen, where you can obtain preset TVCli commands. All you have to do is inform some required data sources. You can also 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 you.
FuzzyBot
11,677
edits
Retrieved from "http://wiki.taticview.com/index.php/Special:MobileDiff/12834...30231"