Open main menu

TaticView β

Changes

Automate Update data/en

2,490 bytes added, 13:26, 15 April 2023
Updating to match new version of source page
With TaticView, you can automate the 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 to automate updates on TavicView.
See below the required steps to automate the data updates.
<span style="color: red;">'''Important:'''</span> * To use TVCli works with , the computer where it will be configured must have java from version <i>7.0_808</i>installed. If you use a Java minor version the message "Unsupported major. Howeverminor version 52.0" will be showed, we recommend using <em>see [[Java 8JRE 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: </emi> because C:\Users\<iuser>Java 7\AppData\Local\TVCli\Logs</i> is discontinued by Oracle).
=== 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.
First download * '''Download the installer:* <u>[http://wiki.taticview.com/taticfiles/tvcli-windows-installer.exe Windows[TVCli Download|latest version]]</u>
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 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.
* '''Run the installation''' on the computer where the schedules will be created to run the TVCli.
=== Access TOKEN generation ===
You must have an '''[[Tokens|Access TOKEN]]''' registered on TaticView and TVCli before works through command line. The best way to automate the execution is creating a script, after that, you can schedule it to run an automation importon the system task scheduler. <br/>An Access TOKEN is always related with a TaticView userTo install and execute TVCli on you computer we need Java JRE version 1.8. The Access TOKEN is like a password generated by TaticView which allows access to your account through TVCli0_200 or newer installed. <br/>It On [[Java JRE install and troubleshooting]] we can be revoked by you at any time, allowing help you to decide who and when can access your account on TaticViewin case of doubts.
An === Generating the 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.===
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.
You 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 generate 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 Access TOKEN in two ways: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''Through 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 a new an [[Manage_Access#Tokens|Access TOKEN]]. To help you on this, we wave a [[TVCli Commands|Wizard]]
-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-mailemail).
-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.
Example: '''Example: tvcli -cmd get_token_by_password -user myemail@email.com -password 123466 -token_name "TVCli Server 1" ''' ====Using TaticView's graphical interface==== Here we will show you how to generate a token whit TaticView interface.
'''Through TaticView's 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''';
Command Syntax: '''Syntax: tvcli -cmd store_token -user <your TaticView user name> -token <the token generated tokenon TaticView>'''
-cmd - store_token - stores token The command responsible for storing the TOKENS generated through the interfaceon TaticView. -user - Your TaticView user (access email). -token - The token generated through the interfaceon TaticView.
Example: '''Example: tvcli -cmd store_token -user meuemail@email.com -token 9bdr845gh5r4r1vd5d5'''
=== Updating your data automatically ===
=== Updating You can only automate the update of files that exist on TaticView. It will be necessary to import your data automatically ===file/spreadsheet manually for the first time to generate the required structure.
You can only automate the update of data sources After that have been already created on TaticView, so you are going it will be necessary to need at least one manual import to create the necessary structure.Then you must grant enable the automatic import update to the desired data file.To do For this click on you must access the imported file (On properties of the TaticView interface), select desired ''Datasource'Properties''', and check . Access is available in the checkbox '''Automatic Importation''', which displays context menu of the identifier code of your data file, as you can see Datasource card in the example below[[Main Page Overview|TaticView main page]]:
After that, it will be necessary to enable the automatic update to the desired data file{| class="images-table"| On desktop|-|[[File:Datasources properties en-US. To do so, access the TaticView png|link=]]|-| In mobile devices|-|[[Main Page OverviewFile:Datasources options mobile en-US.png|main pagelink=]], click on data files, select <i>Settings</i>, and enable the <i>Automatic Update</i> option[[File:Datasources properties mobile en-US. After that, it will display the data files code on the screen. See the example below:png|link=]]|}
[[File:datamart-dropdown+en-US.png]]
Then, the ''Automatic importation'' option should be enabled. When you do this, you will see the data file code, as in the example below:
[[File:automatic-importation+en-US.pngPNG]]
Once You can execute the data file is imported, granted for automatic import and you have your identification automatically using the identifier code, you can run the import through the command lineif the data file has permission to be updated automatically.
Command Syntax: '''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 e-mailemail).
-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).
-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 -user myemail@email.com -datamart 246 -file "\\servidor\taticview\imp\myspreadsheet.xls" '''
'''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "cC:\taticview\imp\spreadsheet.xlsx"''' '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "cC:\taticview\imp\file.csv" -wait -notifyshare''' '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "cC:\taticview\imp\spreadsheet.xlsx" -wait''' '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "cC:\taticview\imp\spreadsheet.xlsx" -type clear_and_add''' '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "cC:\taticview\imp\spreadsheet.xlsx" -type append''' '''tvcli -cmd import_file -user myemail@email.com -datamart 246 -file "cC:\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 can create BAT files to schedule a bunch of TVCli version === commands. Doing so the entire process can be automated. As you can schedule using Windows scheduler or other similar tool.
You can run the <i>-version</i> 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.
'''''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
'''Command Syntax: tvcli -version'''
==== Evaluating if command execution was successful ====
=== Commands response 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.
TVCli executable returns specific codes to inform the success or failure of its commands. 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 [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!
)
=== Questions on how generate the automation commands? = 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.
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.  === Script example ===  '''@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\rhhr.xlsx" -datamart 673 -wait
'''if %errorlevel% == 0 (
'''echo "RH HR updated successfully!"
''') else (
'''echo "Problems updating RHHR!"
''')'''
 
=== 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 generate automation commands?</i>, 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 [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/21460...30231"