FEI - Guidelines about XML Format for Automated Results Processing

FEI - Guidelines about XML
Format for Automated Results
Processing

FEI - Guidelines about XML Format for
Automated Results Processing
Contents
I. Introduction ................................................................................................................ 3
II. Connect to FEI Database .............................................................................................. 3
1. Get username and password...................................................................................... 3
a. National Federations ........................................................................................ 3
b. Organisers and IT Providers .............................................................................. 3
2. Environment URL ..................................................................................................... 3
3. How to Login ........................................................................................................... 4
III. Download Event Details ................................................................................................ 5
1. Search Event. .......................................................................................................... 5
2. Choose Event. ......................................................................................................... 5
IV. Import Results ............................................................................................................ 7
1. Import Results by Event ............................................................................................ 7
2. Import results by Competition ................................................................................... 9
3. Error Report ........................................................................................................... 10
a. Validation of XSD File ...................................................................................... 10
b. Fatal Errors .................................................................................................... 11
c. Correct the Warnings ...................................................................................... 12
4. Upload results ......................................................................................................... 12
5. Submit results to the FEI ......................................................................................... 13
a. Submit results for the complete event .............................................................. 13
b. Submit results by competition .......................................................................... 14
6. Delete Imported Results........................................................................................... 15
a. Delete all event results .................................................................................... 15
b. Delete one Competition Results ........................................................................ 15
V. Annex ....................................................................................................................... 16
1. List of possible Errors when importing results ............................................................. 16
09.05.2012 – v 1.0
2

FEI - Guidelines about XML Format for
Automated Results Processing
I. Introduction
The FEI IT department provides a XML Format for Automated Results Processing.
This XML Format for Automated Results Processing was made to automate results
processing and data exchange between Organising Committees, National Federations, and
the FEI.
You will find the XSD files you will need to implement this XML format in your own
software on our website by following this link http://www.fei.org/xml-format-forautomated-results-processing.
This will enable you to easily generate result files, ready to
be uploaded to the FEI platform.
The XML Format can be imported on the FEI Platform https://data.fei.org/ by the NFs, the
OCs or the IT Providers.
This document will help you get familiar with the import of XML Format for Automated
Results Processing in our system.
II. Connect to FEI Database
1. Get username and password
09.05.2012 – v 1.0
In order to upload XML results files, you will require a personal access to the FEI
Database.
a. National Federations
National federations users already have an account in FEI Database. However, you
will need specific rights (“NF_Results_admin”) to access the XML upload feature.
Please refer to your respective NF to retrieve your personal access information.
b. Organisers and IT Providers
To get a username and password, complete the NDA
(http://www.fei.org/sites/default/files/file/NDA_OCS.pdf) available on the
webpage http://www.fei.org/xml-format-for-automated-results-processing and we
will send you your account details for test and production environment.
2. Environment URL
URL: https://data.fei.org/
This is the FEI platform. Everything you do on this platform will go live.
3

FEI - Guidelines about XML Format for
Automated Results Processing
3. How to Login
09.05.2012 – v 1.0
You can log into https://data.fei.org/ by clicking on Login in the top right corner and
enter your username and password.
4

FEI - Guidelines about XML Format for
Automated Results Processing
III. Download Event Details
To produce XML Files with all required data by the FEI, you will need to retrieve FEI IDs of
shows, events, competitions, schedule competition numbers, schedule rules and venue
names.
1. Search Event.
09.05.2012 – v 1.0
In the Calendar Search Page, Look for your event and then click on Search in the left
corner.
2. Choose Event.
Then choose your event and select it in the list by clicking on it.
5

FEI - Guidelines about XML Format for
Automated Results Processing
Download the Event Details
09.05.2012 – v 1.0
Then Download the Event Details by clicking on Download Event Detail... in the
bottom left corner.
This CSV file will give you the required information to establish your XML file:
CSV
Destination
Element Attribute
ShowID Show FEIID
ShowStartDate Show
Start
Date
ShowEndDate Show End Date
VenueName Venue Name
VenueCountry Venue Country
EventID Event FEIID
EventCode
Discipline Event
(ex. Jumping Event)
Code
NF Event NF
EventStartDate Event
Start
Date
EventEndDate Event End Date
CompetitionID Competition FEIID
ScheduleCompetitionNR Competition Number
Rule Competition Rule
CompetitionName* Competition Name
* If you insert a different Competition Name in your XML File, it will overwrite it in the system.
6

FEI - Guidelines about XML Format for
Automated Results Processing
IV. Import Results
After generating a XML file from your own software, you will be able to upload it directly to
the FEI Database web interface.
1. Import Results by Event
09.05.2012 – v 1.0
In the event details’ page, click on Import Event Results in the bottom left corner.
7

FEI - Guidelines about XML Format for
Automated Results Processing
09.05.2012 – v 1.0
Browse for your XML File in your computer and click “open”.
Click on the Upload button.
8

FEI - Guidelines about XML Format for
Automated Results Processing
2. Import results by Competition
09.05.2012 – v 1.0
You can upload competition results one by one by going on the Competition Detail
Page. To do so just click on the competition name.
Then click on Import Competition Results in the bottom left corner.
Then click on Browse and choose your file the same way as you do to import event
results files.
9

FEI - Guidelines about XML Format for
Automated Results Processing
3. Error Report
09.05.2012 – v 1.0
When you upload your XML file, an error check is performed as described below. Two
types of errors are possible:
� Fatal
� Warning
a. Validation of XSD File
The first check following the results file upload is the validation of the XSD
Schema. Those errors are not listed in the list in annex 1. You will easily identify
them as they are described in the pop-up (line and column number in the XML file
will appear in the error message).
In a standard process, you have already validated your file with the XSD Schema
available on our website (XSD files available on http://www.fei.org/xml-formatfor-automated-results-processing).
10

FEI - Guidelines about XML Format for
Automated Results Processing
09.05.2012 – v 1.0
b. Fatal Errors
When fatal errors occur, you will need to treat every error one by one in order to
upload your file. Refer to the message description to resolve any fatal errors.A list
of all possible errors can be found in Annex 1.
11

FEI - Guidelines about XML Format for
Automated Results Processing
09.05.2012 – v 1.0
c. Correct the Warnings
When you have resolved all fatal errors, you will be able to upload your file
despite any Warning errors. If you wish to tend to the Warning messages, click
on the red cross which will prevent your file from being uploaded. A list of all
possible errors can be found in Annex 1.
4. Upload results
Once you have attended all fatal errors and any warning messages, you may upload
the results by clicking on the green tic on the pop-up. You can still upload files despite
any warning messages.
12

FEI - Guidelines about XML Format for
Automated Results Processing
5. Submit results to the FEI
09.05.2012 – v 1.0
After having imported the results, you will need to submit the results to the FEI.
a. Submit results for the complete event
To directly submit all event competitions results (or the competitions results that
have not been submitted to the FEI yet), click on Submit Results to the FEI on the
Event Detail Page in the bottom right corner.
Note: Submitted results cannot be changed or removed.
13

FEI - Guidelines about XML Format for
Automated Results Processing
09.05.2012 – v 1.0
b. Submit results by competition
To submit results to the FEI one by one, open each competition details’ page by
clicking on the Competition Name.
Then you can submit the results to the FEI, competition by competition by clicking
on Submit the Results to the FEI in the bottom right corner of the page.
14

FEI - Guidelines about XML Format for
Automated Results Processing
6. Delete Imported Results
09.05.2012 – v 1.0
a. Delete all event results
If you want to delete all event competitions results, you can do so by clicking on
Delete Results on the Event Detail Page and then click OK. (Please note that once
submitted you will not be able to delete the results anymore).
b. Delete one Competition Results
If you only want to delete results of one competition, first choose the competition
and open the Competition Detail Page (see 2 on page 9) and then click on Delete
Results and OK.
15

FEI - Guidelines about XML Format for
Automated Results Processing
V. Annex
1. List of possible Errors when importing results
09.05.2012 – v 1.0
When importing results you receive warnings and fatal errors. You will not be able to
upload files until you solve all fatal errors. However, you will be able to upload files
despite Warning Messages. You will find a list of all possible errors below:
Error Type
A competitor is not registered, the related result will be flagged as "not registered" and won't
count in any ranking: CompetitorFEIID='{0}', HorseFEIID='{1}'
An average speed exceeds the maximum allowed of {0}: CompetitorFEIID='{1}', HorseFEIID='{2}',
{3}='{4}'
A horse is not registered, the related result will be flagged as "not registered" and won't count in
any ranking: CompetitorFEIID='{0}', HorseFEIID='{1}'
Warning
Warning
Warning
The competition with CompetitionID='{0}' has been skipped because of it's status result.
Warning
When ranked, the total penalty is required: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
The names of a competitor do not match: CompetitorFEIID='{0}', HorseFEIID='{1}',
Name='{2}' '{3}'
When ranked, the total score is required: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
When ranked, the total average speed is required: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
When ranked, the total time is required: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
The name of a horse does not match: CompetitorFEIID='{0}', HorseFEIID='{1}', Name='{2}' '{3}'
When ranked, the total points is required: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
When ranked, the total time is required: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
When ranked, the total points are required: TeamName='{0}' Fatal
The competitor for country of a competitor does not match: CompetitorFEIID='{0}',
HorseFEIID='{1}', CompetingFor='{2}' '{3}'
The age of a competitor does not comply with the competition rule and the related result is not
marked as disqualified: CompetitorFEIID='{0}', HorseFEIID='{1}'
The date of birth of a competitor is unknown: CompetitorFEIID='{0}' Fatal
Unable to find a competitor: CompetitorFEIID='{0}' Fatal
It is not allowed to import a non disqualified result for a competitor whose status is not active:
CompetitorFEIID='{0}'
Fatal
This person is not a competitor: CompetitorFEIID='{0}' Fatal
A competitor has no league for the season to which belongs the event. Please contact the FEI to
add this competitor to a league before the results can be imported: CompetitorFEIID='{0}'
A competitor was suspended at the beginning of the competition and the related result is not
marked as disqualified: CompetitorFEIID='{0}', HorseFEIID='{1}'
A competitor has more than one of his results flagged to "Count for the WC Standing":
CompetitorFEIID='{0}'
The position status 2 and position status complement 2 can only be set for an Olympic Games
competition: CompetitorFEIID='{0}', HorseFEIID='{1}'
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
16

FEI - Guidelines about XML Format for
Automated Results Processing
The position status 2 and position status complement 2 must be set according to the position
status: CompetitorFEIID='{0}', HorseFEIID='{1}', PosStatus='{2}'
A competitor or a horse is not qualified for the level of the competition: {0} Fatal
No scores for jumping 2 must be set for a competition with a steeplechase with A and C phases:
CompetitorFEIID='{0}', HorseFEIID='{1}'
Neither scores for phases A, B and C nor jumping 2 must be set for a competition without
steeplechase: CompetitorFEIID='{0}', HorseFEIID='{1}'
Neither scores for phases A and C nor jumping 2 must be set for a competition with a
steeplechase: CompetitorFEIID='{0}', HorseFEIID='{1}'
When ranked, the total score is required: TeamName='{0}' Fatal
No artistic attributes must be set for a Standard competition: CompetitorFEIID='{0}', Fatal
HorseFEIID='{1}'
Neither artistic or technical attributes must be set for a Young Horse competition: Fatal
CompetitorFEIID='{0}', HorseFEIID='{1}'
The number of speed scores differs from the number of time scores: CompetitorFEIID='{0}', Fatal
HorseFEIID='{1}'
When ranked, the total time is required: TeamName='{0}' Fatal
The veterinary 1st horse inspection elimination code must be set according to the position
status: CompetitorFEIID='{0}', HorseFEIID='{1}', '{2}'
Incorrect veterinary 1st horse inspection elimination code: CompetitorFEIID='{0}',
HorseFEIID='{1}', {2}='{3}'
Too much veterinary elimination codes found: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
An elimination code must be set if the related result is neither marked as ranked nor as
disqualified: CompetitorFEIID='{0}', HorseFEIID='{1}'
The veterinary final horse inspection elimination code must be set according to the position
status: CompetitorFEIID='{0}', HorseFEIID='{1}', '{2}'
Incorrect veterinary final horse inspection elimination code: CompetitorFEIID='{0}',
HorseFEIID='{1}', {2}='{3}'
The veterinary gate elimination code must be set according to the position status:
CompetitorFEIID='{0}', HorseFEIID='{1}', '{2}'
Incorrect veterinary gate elimination code: CompetitorFEIID='{0}', HorseFEIID='{1}', {2}='{3}'
The scores by gate must be set according to the number of gates and/or the elimination code:
CompetitorFEIID='{0}', HorseFEIID='{1}'
The age of a horse does not comply with the competition rule and the related result is not
marked as disqualified: CompetitorFEIID='{0}', HorseFEIID='{1}'
Unable to find a horse: HorseFEIID='{0}' Fatal
It is not allowed to import a non disqualified result for a horse whose status is not active:
HorseFEIID='{0}'
Fatal
This horse is not a horse but a pony: HorseFEIID='{0}' Fatal
This horse is not a pony but a horse: HorseFEIID='{0}' Fatal
A horse was suspended at the beginning of the competition and the related result is not marked
as disqualified: CompetitorFEIID='{0}', HorseFEIID='{1}'
Unable to find a base data (Indiv): CompetitorFEIID='{0}', HorseFEIID='{1}', {2}='{3}'
Fatal
A competitor belongs to a league incompatible with the competition league: Fatal
09.05.2012 – v 1.0
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
17

FEI - Guidelines about XML Format for
Automated Results Processing
CompetitorFEIID='{0}'
The position must be set according to the position status: CompetitorFEIID='{0}',
HorseFEIID='{1}', PosStatus='{2}'
A position status does not comply with this discipline: CompetitorFEIID='{0}', HorseFEIID='{1}',
PosStatus='{2}'
A position status 2 does not comply with this discipline: CompetitorFEIID='{0}', HorseFEIID='{1}',
PosStatus2='{2}'
The position status complement 2 must be set according to the position status 2:
CompetitorFEIID='{0}', HorseFEIID='{1}'
A position status complement cannot be found or is not allowed for the related position status:
CompetitorFEIID='{0}', HorseFEIID='{1}', PosStatusComplement='{2}'
A position status complement 2 is not allowed for the related position status 2:
CompetitorFEIID='{0}', HorseFEIID='{1}', PosStatusComplement2='{2}'
The position status complement data must be set according to the position status complement:
CompetitorFEIID='{0}', HorseFEIID='{1}'
The position status complement is missing: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
The prize or the prize currency is missing: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
A prize currency does not comply with this discipline: CompetitorFEIID='{0}', HorseFEIID='{1}',
PrizeCurrency='{2}'
Fatal
A prize currency does not match the specified Draft Schedule prize currency: Fatal
CompetitorFEIID='{0}', HorseFEIID='{1}', PrizeCurrency='{2}'
'{3}'
Unable to find a base data (Judge): Firstname='{0}', Familyname='{1}', {2}='{3}'
Fatal
Unable to find a judge: FEIID='{0}' Fatal
The FEI ID of a judge is missing: Firstname='{0}', Familyname='{1}' Fatal
The nationality of a judge does not match: FEIID='{0}', Nationality='{1}' '{2}'
Fatal
This person is not a judge for this discipline: FEIID='{0}' Fatal
A judge has the same position as another: Firstname='{0}', Familyname='{1}' Fatal
A judge has the same position as another: FEIID='{0}' Fatal
The status of a judge does not match: FEIID='{0}', OfficialStatus='{1}' '{2}'
Fatal
An individual result refers to a team that does not exist: TeamNF='{0}' Fatal
The competition requires team results and no teams were found Fatal
The 1st round status cannot be set if the related result is marked as ranked:
CompetitorFEIID='{0}', HorseFEIID='{1}'
The 1st round status must be set if the related result is neither marked as ranked nor as
disqualified: CompetitorFEIID='{0}', HorseFEIID='{1}'
Please provide all rounds and jump-off scores (gaps are not allowed): CompetitorFEIID='{0}',
HorseFEIID='{1}'
The Is Team Only Result attribute cannot be set to true for an individual only competition:
CompetitorFEIID='{0}', HorseFEIID='{1}'
The points of jump-off {0} must be left blank: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
The time of jump-off {0} must be left blank: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
The number of point scores differs from the number of time scores (round or jump-off):
CompetitorFEIID='{0}', HorseFEIID='{1}'
09.05.2012 – v 1.0
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
Fatal
18

FEI - Guidelines about XML Format for
Automated Results Processing
The Is Team Only Result attribute must be set for a team competition: CompetitorFEIID='{0}',
HorseFEIID='{1}'
Fatal
The points of jump-off {0} are mandatory: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
The time of jump-off {0} is mandatory: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
A round or jump-off with status must be preceded by one with score: CompetitorFEIID='{0}',
HorseFEIID='{1}'
Fatal
The points of round {0} are mandatory: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
The time of round {0} is mandatory: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
When ranked, the total points are required: TeamName='{0}' Fatal
When ranked, the total time is required: TeamName='{0}' Fatal
The jump-off {0} has a status, it cannot have score: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
The round {0} has a status, it cannot have score: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
A round or jump-off with status cannot be followed by one with point or time scores:
CompetitorFEIID='{0}', HorseFEIID='{1}'
The round or jump-off status must be set according to the position status: CompetitorFEIID='{0}', Fatal
HorseFEIID='{1}', '{2}'
Incorrect round or jump-off status: CompetitorFEIID='{0}', HorseFEIID='{1}', {2}='{3}'
The points of round {0} must be left blank: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
The time of round {0} must be left blank: CompetitorFEIID='{1}', HorseFEIID='{2}' Fatal
Too much status found: CompetitorFEIID='{0}', HorseFEIID='{1}' Fatal
The number of jump-off scores is greater than the number of jump-off: CompetitorFEIID='{0}',
HorseFEIID='{1}', Max number of jump-off='{2}'
The number of round scores is greater than the number of rounds: CompetitorFEIID='{0}',
HorseFEIID='{1}', Max number of rounds='{2}'
Unable to find a base data (Team): TeamName='{0}', {1}='{2}' Fatal
A team does not refer enough combinations: TeamName='{0}' Fatal
The team name must be different for each team: TeamName='{0}' Fatal
The competition does not allow team results and one or more teams were found Fatal
The position must be set according to the position status: TeamName='{0}' Fatal
The prize or the prize currency is missing: TeamName='{0}' Fatal
A prize currency does not comply with this discipline: TeamName='{0}', PrizeCurrency='{1}' Fatal
A prize currency does not match the specified Draft Schedule prize currency: TeamName='{0}',
PrizeCurrency='{1}' '{2}'
This file is not an event results XML file type.
Fatal
Access denied to EventID='{0}'.
Fatal
Duration allowed to import Results is elapsed to EventID='{0}'.
Fatal
There is no event in the database corresponding to EventID='{0}'.
Fatal
The XML file contains the results of the event identified by EventID='{0}' but this does not match
the current event, which ID is '{1}'.
Fatal
The provided event code ('{0}') does not match the value stored in the database ('{1}') for the
event EventID='{2}'.
Fatal
The provided event NF ('{0}') does not match the value stored in the database ('{1}') for the
event EventID='{2}'.
Fatal
There is no competition in the database corresponding to the event EventID='{0}' and with Fatal
09.05.2012 – v 1.0
Fatal
Fatal
Fatal
Fatal
19

FEI - Guidelines about XML Format for
Automated Results Processing
CompetitionID='{1}'.
The provided Schedule Competition Nr. ({0}) does not match the value stored in the database
({1}) for the competition CompetitionID='{2}'.
The provided Competition Rule ('{0}') does not match the value stored in the database ('{1}') for
the competition CompetitionID='{2}'.
09.05.2012 – v 1.0
Fatal
Fatal
20