The program will import data from Transics directly into the database. It will checks what fields are already present in the database before importing.

The program can also generate reports aimed at drivers for a given period of time.

• Go
• R
• SQL Server

The credentials of used services must be filled in the .env file. You can find an example of what information to fill-in in .env.example.

When newly creating a MSSQL database, it is necessary to set a default schema in the database prior to use the program so as following:

ALTER USER [DATABASE_USER_NAME] WITH DEFAULT_SCHEMA=[dbo]
GO

Install the required dependencies (on a Ubuntu/Debian based distribution) by running config/install.sh. You need read/write access to the folder tx2db is installed. More information in config/README.md

After having installed the necessary dependencies:

1. git clone https://github.com/julienrbrt/ut_bitinc_project/
2. cd ut_bitinc_project
3. go build .

An executable tx2db is now available in your folder.

An efficient way to import or generate report periodically data is to use CRON (for instance every 4h for the importer and every wednesday for the analysis). This can of course be done manually using directly the tx2db commands.

An exaustive list of available commands can be found by running tx2db --help. A list of most common example will follow:

Run the import manually tx2db import

Options exist for this command, more information by running tx2db import --help

Generate the report manually tx2db gen-report

Generate a report from specific date tx2db gen-report --startTime 2020-02-22

Generate a report of a specific range (default 7 days) tx2db gen-report --reportRange 30

Options exist for this command, more information by running tx2db gen-report --help

• analysis contains the driver analysis. Graphs are built with R and the different metrics in SQL via Go. The template of the report is written in .html. The reports are then converted to a .png thanks to phantomjs.
• cmd are the commands accessible in tx2db
• config are configuration files: please read config/README.md.
• txtango implements the TX-TANGO API
• utils implements the FTP upload, jokes, mail and PDF generation.

Emails are sent by tx2db at different occasions:

• a mail is sent to SYSTEM_ADMINISTATOR_EMAIL when a new driver is imported or when a report has to be sent to a driver without email. The mail of that driver needs to be manually added into tx2db database under the drivers table.
• a mail is sent to the drivers when a report is generated (unless --skipSendDriverMail is specified). The mail is sent to the address present in the drivers table.
• a mail is sent to INSTRUCTOR_EMAIL with all the generated report in one pdf (ready to be print). That pdf has to uploaded to the FTP server defined in the .env.
• a mail is sent to SYSTEM_ADMINISTATOR_EMAIL if there is a failure during the upload of the weekly report to the FTP server.

More info about Transics TX-TANGO API:

• TX-TANGO API