Object of the interface
The interface allows you to import calculation parameters from third-party software to Timesquare. These are grouped in a calculation parameter sheet per person. The principle is to provide the expected information in a text file that will be read and interpreted by the interface in order to update the Timesquare database.
These parameters allow you to define for each person the possible start and end of day limits (PJ01), the working day (PJ02), the minimum and maximum daily durations for days with or without a break (PJ04).
The parameter sheet created remains valid until modified by importing new parameters.
These elements are imported into Timesquare to create calculation parameter sheets that can be used when calculating schedules.
Learn more about setting up this import.
File name
Undated file (custom label)
The file name is free (label + extension) but once defined in the import settings, it must not change.
Example: Param_A.txt, Param_Timesquare.001, Param.csv.
The file name is free (label + extension) but once defined in the import settings, it must not change. It can contain information relating to one or more absences concerning one or more structures.
Example: Param_A.txt, Param_Timesquare.001, Param.csv.
Dated files (with date pattern)
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, LabelAAMMJJ.EXT or LabelYYYYMMDD.EXT are the supported wordings in which:
- "Label" is made of a string of alphanumerical characters that can be personalized
- "JJ" and "DD" stand for the day, "MM" stands for the month, "AA", "AAAA" and "YYYY" stand for the year, 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 param_JJMMAA.txt and the three import files are
named param_040520.txt, param_050520.txt and param_060520.txt.
Example 2: the Label field in the configuration is named staffAAAAMMJJ.001 and the three import
files are named param20200504.001, param20200505.001 and param20200506.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 items is the semicolon (;).
Description of the file content
| Field | Type | Note | |
|---|---|---|---|
| 01 | Employee identifier | Alphanumerical | Registration number, payroll registration number or Timesquare identifier depending on the configuration |
| 02 | Start of application period | Date | DD/MM/YYYY |
| 03 | End of application period | Date | DD/MM/YYYY |
| 04 | Worked day 01 | Numerical |
|
| 05 | Worked day 02 | Numerical | Idem #04 |
| 06 | Worked day 03 | Numerical | Idem #04 |
| 07 | Worked day 04 | Numerical | Idem #04 |
| 08 | Worked day 05 | Numerical | Idem #04 |
| 09 | Worked day 06 | Numerical | Idem #04 |
| 10 | Worked day 07 | Numerical | Idem #04 |
| 11 | Worked bank holiday | Numerical | Idem #04 |
| 12 | Day start time 01 | Time | HH:NN |
| 13 | Day end time 01 | Time | HH:NN |
| 14 | Day start time 02 | Time | HH:NN |
| 15 | Day end time 02 | Time | HH:NN |
| 16 | Day start time 03 | Time | HH:NN |
| 17 | Day end time 03 | Time | HH:NN |
| 18 | Day start time 04 | Time | HH:NN |
| 19 | Day end time 04 | Time | HH:NN |
| 20 | Day start time 05 | Time | HH:NN |
| 21 | Day end time 05 | Time | HH:NN |
| 22 | Day start time 06 | Time | HH:NN |
| 23 | Day end time 06 | Time | HH:NN |
| 24 | Day start time 07 | Time | HH:NN |
| 25 | Day end time 07 | Time | HH:NN |
| 26 | Day start time bank holiday | Time | HH:NN |
| 27 | Day end time bank holiday | Time | HH:NN |
| 28 | Minimum daily duration day 01 (without a meal break) | Duration | HH:NN |
| 29 | Maximum daily duration day 01 (without a meal break) | Duration | HH:NN |
| 30 | Minimum daily duration day 02 (without a meal break) | Duration | HH:NN |
| 31 | Maximum daily duration day 02 (without a meal break) | Duration | HH:NN |
| 32 | Minimum daily duration day 03 (without a meal break) | Duration | HH:NN |
| 33 | Maximum daily duration day 03 (without a meal break) | Duration | HH:NN |
| 34 | Minimum daily duration day 04 (without a meal break) | Duration | HH:NN |
| 35 | Maximum daily duration day 04 (without a meal break) | Duration | HH:NN |
| 36 | Minimum daily duration day 05 (without a meal break) | Duration | HH:NN |
| 37 | Maximum daily duration day 05 (without a meal break) | Duration | HH:NN |
| 38 | Minimum daily duration day 06 (without a meal break) | Duration | HH:NN |
| 39 | Maximum daily duration day 06 (without a meal break) | Duration | HH:NN |
| 40 | Minimum daily duration day 07 (without a meal break) | Duration | HH:NN |
| 41 | Maximum daily duration day 07 (without a meal break) | Duration | HH:NN |
| 42 | Minimum daily duration day BH (without a meal break) | Duration | HH:NN |
| 43 | Maximum daily duration day BH (without a meal break) | Duration | HH:NN |
| 44 | Minimum daily duration day 01 (with a meal break) | Duration | HH:NN |
| 45 | Maximum daily duration day 01 (with a meal break) | Duration | HH:NN |
| 46 | Minimum daily duration day 02 (with a meal break) | Duration | HH:NN |
| 47 | Maximum daily duration day 02 (with a meal break) | Duration | HH:NN |
| 48 | Minimum daily duration day 03 (with a meal break) | Duration | HH:NN |
| 49 | Maximum daily duration day 03 (with a meal break) | Duration | HH:NN |
| 50 | Minimum daily duration day 04 (with a meal break) | Duration | HH:NN |
| 51 | Maximum daily duration day 04 (with a meal break) | Duration | HH:NN |
| 52 | Minimum daily duration day 05 (with a meal break) | Duration | HH:NN |
| 53 | Maximum daily duration day 05 (with a meal break) | Duration | HH:NN |
| 54 | Minimum daily duration day 06 (with a meal break) | Duration | HH:NN |
| 55 | Maximum daily duration day 06 (with a meal break) | Duration | HH:NN |
| 56 | Minimum daily duration day 07 (with a meal break) | Duration | HH:NN |
| 57 | Maximum daily duration day 07 (with a meal break) | Duration | HH:NN |
| 58 | Minimum daily duration day BH (with a meal break) | Duration | HH:NN |
| 59 | Maximum daily duration day BH (with a meal break) | Duration | HH:NN |
File details
When the import is executed, each line of the file is read and a calculation parameter sheet is created for each line processed if the following condition is met:
The employee number or payroll number or identifier (column #01 of the file) read exists in Timesquare.
When creating the sheet following the import, the following elements are retrieved:
- Title of the sheet: This is the result of the concatenation of the prefix defined in the interface configuration and the name of the person concerned.
- Period of application: The dates present in columns #02 and #03 are used to populate the period of application of the calculation parameter sheet.
- Status: "Active" after creation except for the exception described below.
- Frequency: The values are 1 and daily.
- Duration: Always: 1.
- Event: No filter therefore "All".
- Contract: No filter therefore "All contracts".
- Groups: No filter, so "All groups".
- Description: The field is filled with the string "Created by a standard import".
- Group PJ02 (Working day): The fields are filled with the values of columns #04 to #11.
- Group PJ01 (Start and end time of day): The fields are filled with the values of columns #12 to #27
- Group PJ04 (Minimum and maximum daily duration with or without break): The fields are filled with the values of columns #28 to #59
- Differentiate an imported parameter sheet:
- When creating an import sheet, this sheet will be tagged as "imported" in the database. This will differentiate it from parameter sheets filled in manually and thus subject them to a specific right.
- An imported parameter sheet may not be editable depending on the rights associated with the user. If the user does not have the right "Modify a parameter sheet imported by person" but has the right "Modify a parameter sheet by person", he will not be able to modify the imported sheets.
- An imported parameter sheet is processed by the compilation in the same way as the other calculation parameter sheets.
- An imported parameter sheet can be copied / pasted in the same way as the others.
- Importing a parameter sheet when an imported sheet already exists. A person already has a parameter sheet filled in linked to a first import. In this case, during the second import, the system detects the presence of a parameter sheet tagged as "imported" in the database. Three cases can arise:
- The start and end dates of the existing sheet and the imported sheet are identical. The sheet already present is made "Inactive".
- The application periods of the existing sheet and the imported sheet have a common part. A new sheet is created.
- The application periods of the existing sheet and the imported sheet do not overlap. A new sheet is created.
Note: these management rules only apply to "imported" sheets; sheets created from the HMI or from a schedule adjustment request are not affected.
Example of content
ID;DPA;FPA;JT1;JT2;JT3;JT4;JT5;JT6;JT7;JFT;HDJ01;HFJ01;HDJ02;HFJ02;HDJ03;HFJ03;HDJ04;HFJ0;HDJ0;HFJ04;HDJ05;HFJ05;HDJ06;HFJ06;HDJ07;HFJ07;HDJF;HFJF;DQMin01SC;DQMax01SC;DQMin02SC;DQMax02SC;DQMin03SC;DQMax03SC;DQMin04SC;DQMax04SC;DQMin05SC;DQMax05SC;DQMin06SC;DQMax06SC;DQMin07SC;DQMax07SC;DQMinJFSC;DQMaxJFSC;DQMin01AC;DQMax01AC;DQMin02AC;DQMax02AC;DQMin03AC;DQMax03AC;DQMin04AC;DQMax04AC;DQMin05AC;DQMax05AC;DQMin06AC;DQMax06AC;DQMin07AC;DQMax07AC;DQMinJFAC;DQMaxJFAC
ORB01;08/01/2024;31/08/2024;0;0;1;;;2;1;1;10:00;15:00;;;;;;;;;;;;;;;;;;;;;;;06:00;08:00;;;;;;;;;;;;;;;06:00;08:00;;;;
Comments
0 comments
Please sign in to leave a comment.