1,438
edits
Changes
no edit summary
<!--T:38-->
<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>).
=== Installing TVCli === <!--T:5-->
<!--T:65-->
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.
<!--T:6-->
* '''Download the installer first* <u>[https://wiki.taticview.com/taticfiles/tvcli-windows-installer.exe Windows[TVCli Download|latest version]]</u>
<!--T:51-->
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 choosing the advanced options.
In both situations if you need contact us to help you.
<!--T:7-->
* '''Run the installation ''' on the machine computer 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.
<!--T:59-->
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 === <!--T:8-->
<!--T:9-->
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.
<!--T:40-->
An Access TOKEN is always linked to a TaticViwe 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.
<!--T:60-->
Here we will show you how to generate a token whit TaticView interface.
<!--T:10-->
There are two ways to generate an Access TOKEN:
<!--T:61-->
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==== <!--T:11-->
Run the command through a command line requesting the generation of an [[Manage_Access#Tokens|Access TOKEN]].
<!--T:13-->
-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.
====Using TaticView's graphical interface==== <!--T:15-->
<!--T:63-->
Here we will show you how to generate a token whit TaticView interface.
<!--T:64-->
# 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''';
<!--T:17-->
-cmd - store_token - The command responsible for storing the TOKENS generated on TaticView.
-user - Your TaticView user (access e-mailemail).
-token - The token generated on TaticView.
<!--T:24-->
Command Syntax:
'''tvcli -cmd import_file -user <your TaticView user> -datamart <data file identification code> -file "<file/spreadsheet address>" [-type "<type>"] [-wait [-notifyshare]] [-nonotifyerror]
'''
<!--T:25-->
-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).
'''Call "C:\Program Files\TvCli\tvcli" -cmd import_file -user myemail@email.com -datamart 246 -file "D:\taticview\imp\spreadsheet.xlsx" -wait'''
=== Other Running TVCli commands === ==== TVCli show version ==== <!--T:35--> <!--T:36-->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. <!--T:37-->Command Syntax: '''tvcli -version''' ==== TVCli show log =from BAT (Script) file === <!--T:4752--> ''since TVCli version 1.1'' <!--T:48-->You can run the <i>show_logs</i> command to show the log file. <!--T:49-->Command Syntax: '''tvcli -cmd show_logs''' - Show the current day logs''' '''tvcli -cmd show_logs -all''' - Show all logs in the logs directory''' === Running TVCli from BAT (Script) file ===
<!--T:53-->
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.
<!--T:54-->
'''''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 whas suceful was successful ==== <!--T:27-->
<!--T:28-->
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.
<!--T:55-->
Currently, the available codes are:
<!--T:30-->
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.:
<!--T:4456-->Also, 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.if %errorlevel% == 0 ( echo SALES updated successfully! ) else ( echo Problems updating SALES! )
==== BAT (Script ) example ==== <!--T:31-->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.
<!--T:32-->
'''@ECHO OFF''' '''call C:\TaticView\tvcli -cmd import_file -user jonathanmy@sadigemail.com -file "C:\Users\jonathan\Documents\TaticView\Import Files\sales.xlsx" -datamart 674 -wait
'''if %errorlevel% == 0 (
'''echo SALES updated successfully!
'''echo Problems updating SALES!
''')
'''call C:\TaticView\tvcli -cmd import_file -user jonathanmy@sadigemail.com -file "C:\Users\jonathan\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? === <!--T:42-->
<!--T:44-->
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.
<!--T:43-->
</translate>
