File: Standard import of stored data values

Voir la version française

Object of the interface

This interface is designed to enable the automatic or manual import of any type of stored data values. It aims to make the expected data available in a text file with a unique format whatever the data (1/4 h, day, month...). This file will be read and interpreted by the interface in order to update the stored data in the Timesquare® database.

Learn more about setting up this import.

File name

The file can be named in two different ways depending upon the third system which may build one different file for each day or a unique file containing one or more days of historical data.

Unique files

File name is free (Text + extension), but once it has been defined in the import setup it should not be
changed.

Example 1: the Label field in the configuration and the import file are both named incomingflows.txt.

Example 2: the Label field in the configuration and the import file are both named
history_Timesquare.001

Multiple files

The file name must comply with a specific syntax including the date of the data provided. The Label field must define the naming chosen. Thus, LabelJJMMAAAA.EXT, LabelJJMMAA.EXT, LabelAAAAMMJJ.EXT or LabelAAMMJJ.EXT are the supported wordings in which:

• "Label" is made of a string of alphanumerical characters that can be personalized
• "JJ" stands for the day (DD), "MM" stands for the month, "AA" and "AAAA" stands for the year (YY or YYYY), that can be indifferently written with 2 or 4 characters
• "EXT" is an alphanumerical string with 3 characters maximum that can be personalized

Example 1: the Label field in the configuration is named site1_JJMMAA.txt and the three import files are
named site1_040520.txt, site1_050520.txt and site1_060520.txt.

Example 2: the Label field in the configuration is named siteflowAAAAMMJJ.001 and the three import
files are named siteflow20200504.001, siteflow20200505.001 and siteflow20200506.001.

Example 3: the Label field in the configuration is named AAMMJJ.txt and the three import files are
named 040520.txt, 050520.txt et 060520.txt.

Format

Text. UTF-8 encoding.

Separator between two information

The separator between two pieces of information is the semicolon (;).

Description of the file content

Order	Field name	Type	Notes
01	Data identifier	Alphanumerical	Code of the stored data, maximum 12 characters
02	Current Date	Date	DD/MM/YYYY
03	Time slot start	Time	HH:NN (hours, minutes) may be empty in the case of data of day, week or month type.
04	Time slot end	Time	HH:NN (hours, minutes) may be empty in the case of data of day, week or month type.
05	Value	Alphanumerical

Rules

• When the stored data to feed is entered with a day, week or month rhythm, Time slot start time
  and Time slot end time are empty.
• Day input mode: The value is allocated to the current day
• Week input mode: The value is allocated to the week corresponding to the current day
• Month input mode: The value is allocated to the month corresponding to the current day
• If the input mode of the data is equal to the Time slot end time minus the Time slot start time or
  if the input mode is Time interval, then the value is allocated to the period, Time slot start time
  Time slot end time, for the current day date.

Example of content

A133;25/03/2019;09:00;09:15;5
A133;25/03/2019;09:15;09:30;8
A133;25/03/2019;09:30;09:45;13
A133;25/03/2019;09:45;10:00;18
A133;25/03/2019;10:00;10:15;20
458;24/03/2019;10:00;12:00;25
458;24/03/2019;12:00;15:00;35
458;24/03/2019;15:00;20:00;65
458;25/03/2019;10:00;12:15;33
458;25/03/2019;13:00;15:30;42
458;25/03/2019;15:30;20:00;58
525;21/03/2019;;;578,33
525;22/03/2019;;;345,18
525;23/03/2019;;;478,58
525;24/03/2019;;;625,4
525;25/03/2019;;;333,9
MET;21/03/2019;;;Sun
MET;22/03/2019;;;Rain
MET;23/03/2019;;;Rain
MET;24/03/2019;;;Cloudy
MET;25/03/2019;;;Cloudy