FIDES HOW-TO
Version 2.4
Last updated on 23 March 2007 |
This Howto is also available in a ZIP file
1. Generalities
1.1 About this document
1.2 About FIDES
1.3 FIDES History
1.4 Benefits over the previous version
1.5 Requirements
2. Message format specifications
2.1 Introduction
2.2 Original FIDES messages
2.3 FIDES messages
2.4 Explanation of header tags
2.5 Body format and presentation
2.6 Body formatting
3. Connecting to FIDES
3.1 Getting a FIDES login
3.2 Connecting to FIDES
3.3 Accessing FIDES from several computers
4. Using the application
4.1 Generalities
4.2 Different ways to send data to FIDES
II
4.3 Using the Web User's Interface
4.4 Using FTP
4.5 Using X.400/SMTP email
5. Transaction Examples
5.1 Catch Report A
6. Glossary
7. More information
7.1 Additional documentation
7.2 Online tools
8. Address Book
8.1 European Commission
8.2 FIDES Project Manager
8.3 FIDES Helpdesk
8.4 Member States National Administrations
8.5 Useful Links
1.1 About this document
Although information provided herein has been carefully checked, this
document can only become better if you, the users, give us feedback about
this writing. Also feel free to submit any ideas of improvement as
your comments are always most welcomed. To do so, write to the maintainer
of this Howto (fish-fidesinfo@ec.europa.eu).
1.2 About FIDES
FIDES is a computer system built
around the Internet technologies to automate the management of fisheries
data so make it accessible by each of the national administrations in the
Member States, the European Commission, and Fisheries DG, with the possibility
to expand the system to other countries in the future. Member states
can send and retrieve data to and from the FIDES application through
several communication alternatives according to their own preferences.
FIDES is only the middle link between business processes of the member
states and business processes of the Fisheries DG. FIDES is not
the actual database that stores your data but rather the link between you
and the data.
The system is designed around the concept of bridges. You have
a bridge to process requests from FTP, another one for requests from HTTP,
etc.). Consider this as several programs that communicate together. Thus
for example if there is a mail problem, only the bridge that take cares
of the mail should be affected while other FIDES services will continue
to run.
The exchange of information can be done through different data transmission
alternatives (FTP for file transfer, X.400 and SMTP for email, HTTP for
Web). A user identification mechanism is provided by the system so that
users can only transmit and access data for which they are authorized to.
Each report transmitted or requested by the actors is conveyed by the transmission
applications to the FIDES kernel which will process the reports. Each
bridge is an interface that will interact with the communication application:
the email bridge: process requests coming from email;
the web bridge: process requests coming from the web;
the FTP bridge: process requests coming from ftp.
Each exchange of information (called "transaction") is acknowledged, archived
and logged by FIDES automatically. Statistical reports on transaction
can be requested from the system by the different actors but the information
presented will depend on the actor's data access level within the system.
There are two types of possible transactions from FIDES actors:
data exchange: FIDES receives a transaction request and reacts adequately
depending its type;
administrative actions: those operations can vary from changing your own
configuration to the addition of new bridges to FIDES.[1]
1.3 FIDES History
The system originated in a joint operation
between DG III, responsible for the IDA program and DG FISH, responsible
for the Common Fisheries Policy (CFP). FIDES has been so far entirely funded
under the IDA Program and is listed in Council
Decision 468/95 of 6 November 1995 as the recognized sectoral project for
fisheries. More information on this IDA
project can be found online at http://ec.europa.eu/idabc/.
1.4 Benefits over the previous version
The key benefits of using FIDES
instead of the original FIDES are:
open system that supports different standard protocols (X.400, smtp, ftp,
http);
improved speed and accuracy of data: no re-encoding, automated quality
checks;
instant access to up do date information at any time;
user friendly application and interactivity through the web interface;
bridges to standards products (email, FTP...);
recognized flow edit formats;
alternative exchange formats are available;
no specific hardware/software required;
strong security through the use of SSL and
different rights and access rules for each users;
support is provided through Helpdesk;
the application is highly customizable to suit user's needs.
1.5 Requirements
The software requirements on the client
side to use the system are very limited. In fact, almost any computers
with a TCP/IP stack and a connection to the FIDES application (either
by using the Internet or the TESTA II Network) will suffice as the
system uses different open and well known standards:
to use the Web interace: either Netscape Communicator v4.0+, or Microsoft
Internet Explorer v4.0+ can connect to the system. Other web browsers might
works as well, but are not officialy supported. At least, your browser
must supports Secure Socket Layer (SSL), HTML 3.2, and JavaScript;
to use the FTP interface: almost any computer with a TCP/IP stack can connect
to the FTP bridge. There are plenty of FTP clients on the market for every
operating systems (and some of those are even free). In all cases,
any computer with a variation of Unix system, Windows 9x/NT or Windows
3.1 with a TCP/IP stack installed has a built-in ftp client provided along
with the Operating System. To use it, simply type 'ftp' from a
command prompt, then 'open <name_of_ftp_server>', enter your
username/password, and type '?' to get some help about the available commands;
to use the X.400/SMTP interface: virtually any X.400/SMTP email clients
(including Webmail) are able to send data to FIDES. Data sent by email
can be either in the body of the message or included as an attachement.
If you are behind a firewall and are not able to connect to the application,
ask your Local System Administrator to find out if you have access to SSL,
on TCP/IP port 443.
2.1 Introduction
All FIDES transactions are based
on the exchange of flat ASCII files (i.e. containing simple text only)
obeying formatting rules. Compared to previous exchange formats, FIDES
II will allow a greater flexibility in how the data should be formatted
but old formats are still supported. Apart from the different format alternatives,
FIDES also allows for more flexibility in how data are sent and data
are presented to the user.
The processing result, whether resulting from a query or a report upload,
will be given as a FIDES message. Thus, all transactions have an input
format and at least one output format. The output format can depend on
the processing result.
Depending if your file is in original FIDES or in FIDES format, rules
slightly vary when you want to submit your transaction to the system:
-
original FIDES transactions can be sent "as is" using the Web interface
or by specifying additional parameters in the subject (email) or in the
filename (FTP);
-
FIDES messages can be sent "as is" via all three interfaces
(Web, email, FTP) if they already contain a valid header
included inside the<HEAD> and </HEAD> tags. A FIDES message
without header information can be sent via the web interface.
2.2 Original FIDES messages
The FIDES system is built in a way
to accept original FIDES messages without any transformations of the transaction.
However, one parameter that is not found in a original FIDES transaction
is required by FIDES: the REQUEST.NAME parameter that tells the system
what transaction to expect. Rather than editing your old FIDES transaction,
consider the following to provide this required parameter along with your
transaction:
-
if you are using the Web interface, choosing the correct regime/transaction
type that you want to submit is sufficient to provide a valid REQUEST.NAME
along with your transaction. The correct value will be generated
automatically;
-
if you are using the FTP service, you can name your file in a way to provide
this information. Three additional parameters can be defined by giving
a special name to your transaction:
-
t=: defines the transaction type (required), converted into REQUEST.NAME
parameter;
-
f=: gives a transaction reference that can be used at your own leisure
(can be anything you want), converted into REQUEST.REFERENCE parameter;
-
x=: gives the transaction character set, converted into CONTENT_TYPE.CURRENT.CHARACTER_SET.
-
if you are using email, you can provide a subject to your message to provide
this information. Three additional parameters can be defined by giving
a specific subject to your transaction:
-
t=: defines the transaction type (required), converted into REQUEST.NAME
parameter;
-
f=: gives a transaction reference that can be used at your own leisure
(can be anything you want);
-
x=: gives the transaction character set, converted into CONTENT_TYPE.CURRENT.CHARACTER_SET.
You can combine these additional parameters (e.g. t=CR-RPT-A; f=MyReference;").
Do not forget the ";" between any additional parameter that you give, including
the trailing one.
2.3 FIDES messages
Any FIDES message is composed of
two parts:
-
the HEAD section: this section includes meta information about your transaction
to give the context of the transaction to the server. In this section,
the only required tag is the REQUEST.NAME tag;
-
the BODY section: this section is composed of your actual data or request.
This section can be formatted in tag format (<>), Comma Separated format
(;), or Fixed Record Lenght. Data included herein are used only by the
Business Process.
Let us consider an example of a fictional Cath Report A FIDES message:
<FIDES2>
<HEAD>
<REQUEST.NAME>CR-RPT-A
<USER.REFERENCE>my-ref
</HEAD>
<BODY>
<RPM>199912;
<DAT>COD;7X7A34;C;FRA;0.1;
</BODY>
</FIDES2>
Where:
<FIDES2> and </FIDES2> refers to a FIDES message format. These
tags are mandatory in case of a FIDES message;
<HEAD> and </HEAD> refers to the header portion of the FIDES transaction;
<BODY> and </BODY> refers to the data to be transmitted to the Business
Process.
2.4 Explanation of header tags
When you transmit a transaction, you
include several useful tags in the header to reflect your configuration
and your needs. Such tags are:
SYSTEM.PROBE |
This tag can be used if you want to test
your transaction without actually submitting it to the system. No
parameter value is necessary for this field: if this tag is present in
the transaction, the transaction is considered as a test. If you
want to submit such a test from the Web Interface, you should enter something
(whavetever you want) in the SYSTEM.PROBE field |
REQUEST.NAME |
this is the name to identify the transaction
type that your are sending
(e.g.: CR-RPT-A for a Catch Report A) |
REQUEST.NAME.COUNTRY.
ISO_A2 |
this is used to specify the country for
which the data are sent or requested (e.g.: BE) |
REQUEST.NAME.COUNTRY.
ISO_A3 |
this is used to specify the country for
which the data are sent or requested, but expressed in 3 letters ISO code
(e.g.: BEL). You can choose to use either ISO_A2 or ISO_A3 |
REQUEST.DATE |
the date the report was created, in the
format of YYYYMMDD
(e.g. 20000303) |
REQUEST.REFERENCE |
a reference given by you for your own purposes.
This could be whatever comment you want
(e.g. My-Ref) |
REQUEST.AR |
any number of alternate recipient(s) that
should receive the output of your transaction. There is three types
of alternate recipients:
-
FAX, you should then specify a fax number (e.g. fax:+32.2.222.22.22);
-
smtp, you should then specify a mail recipient (e.g. smtp:me@somewhere.com);
-
x400, you should then specify a X400 recipient (e.g. x400:G=...).
|
CONTENT_TYPE.CURRENT.
PRESENTATION |
the current presentation set of the body (see 2.5) |
CONTENT_TYPE.REPLY.
PRESENTATION |
the presentation set that the system should
use in the reply |
CONTENT_TYPE.REPLY.
LINE_SEPARATOR |
the line separator that the system should
use in the reply. Can be either CR, LF, or CRLF. |
CONTENT_TYPE.REPLY.
CHARACTER_SET |
the character set that the system should
use in the reply
(e.g. EuroAscii) |
The following table list all FIDES header tags that can appear in
a transaction or in the results of a transaction. Depending on the transaction you submit,
some of these tags (as well as other transaction dependent fields) appear on the input screen.
;
SYSTEM.* |
information about the transaction used
by the system |
SYSTEM.LOCAL_ID |
FIDES transaction ID |
SYSTEM.THREAD_NO |
FIDES sub-transaction count |
SYSTEM.SOUCE_BRIDGE |
the bridge from which the transaction has been received |
SYSTEM.PROBE |
tags to indicate that the transaction is
only a test |
SYSTEM.RETURN_CODE |
indicate the return code of the business
process |
SYSTEM.STATUS.INTERNAL |
status of the FIDES system |
SYSTEM.STATUS.BP |
depends from the business process |
USER.* |
information about the user |
USER.NAME |
UID of the user |
USER.ORGANIZATION |
organisation of the user |
USER.COUNTRY.ISO_A2 |
2 letters country code of the user |
USER.COUNTRY.ISO_A3 |
3 letters country code of the user |
USER.AVAILABLE_COUNTRIES.* |
countries for which the user can send transaction |
REQUEST.* |
information about the transaction itself |
REQUEST.NAME |
name to identify the transaction |
REQUEST.COUNTRY.A2 |
this is used to specify the country for
which the data are sent or request. If not specified, this will be set
to the same value as USER.COUNTRY.ISO_A2. |
REQUEST.COUNTRY.A3 |
this is used to specify the country for
which the data are sent or request, but expressed in 3 letters ISO code.
If not specified, this will be set to the same value as USER.COUNTRY.ISO_A3. |
REQUEST.DATE |
the date the report was created |
REQUEST.REFERENCE |
a reference given by the user |
REQUEST.AR |
one or several alternate recipient for
the output of the transaction |
REQUEST.TYPE |
transaction type (report, query...) |
CONTENT_TYPE.* |
information about the body |
CONTENT_TYPE.CURRENT.
FORMAT |
body format name |
CONTENT_TYPE.CURRENT.
PRESENTATION |
presentation of the body (e.g. StartTagTerminator-FixedSize |
CONTENT_TYPE.CURRENT.
CHARACTER_SET |
character set of the body |
CONTENT_TYPE.CURRENT.
LINE_SEPARATOR |
line separator of the body |
CONTENT_TYPE.REPLY.
FORMAT |
body format name of the reply |
CONTENT_TYPE.REPLY
PRESENTATION |
presentation of the body of the reply |
CONTENT_TYPE.REPLY
CHARACTER_SET |
character set of the body of the reply |
CONTENT_TYPE.REPLY
LINE_SEPARATOR |
line separator of the body of the reply |
2.5 Body format and presentation
The body contains the data. The data
is structured according to a given format but several presentations exist
for the same format. The format is built of records which in turn is composed
of one or several fields. The presentation then determines how the records
and fields are separated.
It is possible to choose among different presentations which differ
in the choice of delimiters between fields and records by filling in the
CONTENT_TYPE.CURRENT.PRESENTATION tag.
For both the record and the fields a start and end delimiter should
be chosen. The possible combinations for records are:
StartTagEndTag <tagname>record<tagname>
StartTagTerminator <tagname>record[end of line]
Terminator record[end
of line]
The possible combinations for fields separators are:
StartTagEndTag |
<tagname>value</tagname> |
StartTagTerminator |
<tagname>value; |
Terminator |
value; |
FixedSize |
value____ ('_' should be replaced with blank spaces) |
The presentation is then given by one record delimiter combination and
one field delimiter combination, which explain the syntax of the header
tag:
<CONTENT_TYPE.CURRENT.PRESENTATION> RecordSep-FieldSep
The above listed possibilites can be combined to form the following
presentations:
RecordSep-FieldSep = StartTagEndTag-StartTagEndTag
<recordname>
<fieldname1>value1</fieldname1>
<fieldname2>value2</fieldname2>
</recordname>
<recordname>
<fieldname1>value1</fieldname2>
<fieldname2>value2</fieldname2>
</recordname>
RecordSep-FieldSep = StartTagEndTag-Terminator
<recordname>value1;value2;</recordname>
<recordname>value1;value2;</recordname>
RecordSep-FieldSep = StartTagTerminator-Terminator
<recordname>value1;value2;
<recordname>value1;value2;
RecordSep-FieldSep = Terminator-Terminator
value1;value2;
value1;value2;
RecordSep-FieldSep = Terminator-FixedSize
value1____value2____
value1____value2____
Each presentation combination has its advantage. For fully tagged version
StartTagEndTag-StartTag-EndTag), the two main advantages are:
- only the fields for which there is data
need to be present;
- the fully tagged format makes it easier to present
the data in an HTML or XML format.
Presentations with ";"-separated fields
are easy to produce with common desktop tools such as a spreadsheet. The
fixed record length is still used in many applications so it can be a suitable alternative
in some cases. Note that each field must
be entered (with blanks if value is missing) and that it must be correctly
aligned. To be compatible with FIDES I formats, some fields had to
be increased by one to compensate for the additional blanks between the
fields in the previous format. This is why extra attention must be
paid to the alignement.
What is important to note is that the user can choose the presentation
most suitable to its needs and that FIDES can convert between
any of the choosen presentations.
2.6 Body formatting
The body (i.e. the transaction itself) must be formatted according to
the <CONTENT_TYPE.CURRENT.PRESENTATION> you specify in your transaction,
or according to the default value for that transaction.
You can find the formatting standards in the FIDES Message Definition
- Working Document, available on the
CIRCA Web Site. As an alternative,
and to be sure to review the very latest message definition, you can use
the FIDES Application itself. The SC-FORMAT-Q1 transaction, under
the System Call Regime (SC) enables you to retrieve the formatting of any
transaction of the system. Just provide the transaction name in the
QUERY_TRANSACTION field (e.g. CR-RPT-A), and the formatting definition
will appear in the BODY of the following screen. As this information
comes directly from the system, you are sure that it is up-to-date.
Examples are given in section 5.
3.1 Getting a FIDES login
To be able to use
the FIDES services you need to be registered as a FIDES user. In order to register
into FIDES, you will need to contact your FIDES Local Registration Authority
(in short "LRA"), who is an Offical working in your Member State National
Administration being responsible for all the people accessing the FIDES
services on behalf of his Member State National Administration.
You can ask your National Administration for the name of your
FIDES LRA. Alternatively you can also ask the
FIDES Helpdesk.
Your FIDES LRA will then either use the
AdminTool User Management pages
to create or update your FIDES account, or he/she will fill-in a FIDES Registration Form and fax it back to the European
Commission, DG Fisheries (the fax number is shown on the form). Among other information,
this form must contain your surname, given name, business E-Mail address and optionally
your business fax number. Once the DG Fisheries has configured your FIDES account you
will receive by Fax (if possible) or by E-Mail a letter containing all the information
you will need, including your personal login and password to be used in FIDES Web Sites.
The FIDES Registration Form can be obtained from here in either
Microsoft Word 97 format (DOC) or
Rich Text Format (RTF) or
Portable Document Format (PDF).
The same form should also be used for updating a user account (e.g. in case the E-Mail address
changes), modifying user access rights and revoking a user. In that case the user surname
and given name are not mandatory as long as the user login is supplied instead.
Accessing FIDES doesn't require a digital user certificate anymore. In case you have an
old FIDES PKI CUG certificate installed in your browser you can leave it alone, or you can delete it (please
refer to your browser documentation for detailed instructions). It's of no importance.
3.2 Connecting to FIDES
After you have sent your Registration Form,
you will be given a username/password for the FIDES application.
When you connect to a FIDES Web Site (https://webgate.ec.europa.eu/fides/),
you will be asked to authenticate yourself with your personal login and password.
Once this is done you will be authenticated by the application and able to submit
transactions through your Internet browser.
For this to work, you will need a browser supporting strong cryptography (128-bit encryption keys or better).
You can click here to test your browser capabilities.
In order to support encryption, FIDES still uses a Certificate at the server side. One thing you might consider doing
is updating the GlobalSign Root Certificate in you browser so that your browser can check for its authenticity. You'll need to
to this in case your browser always complains about not being able to verify the identity
of the FIDES server each time you start a FIDES session.
Click here to install the latest GlobalSign Root Certificate (if a pop-up box asks you what to do with this
file, select Open, click on Install Certificate and follow the on-screen instructions). This works with most browsers.
3.3 Accessing FIDES from different computers
Connecting to FIDES from another computer is not
an issue anymore as user digital certificates are not required any longer. Just use the
same URL, login and password as you would use on your own computer.
This also means that the whole security mechanism relies solely on your password being
keps secret. Therefore you should never disclose it. Once it's compromised, or in
case of doubts please send a mail to fish-fidesinfo@ec.europa.eu
asking for a new password to be generated (alternatively you can do it yourself using
the AdminTool User Management pages).
4.1 Generalities
Take special
care about the security of your personal username and password. It is
your responsability to keep both the personal user name and password
in a safe place away from malicious usage.
Keep in mind that anyone who has your login and password can use FIDES on your
behalf, even if he can't have physical access to your computer.
Also, when you are done with the application, do not forget to close ALL browser
windows that are open. Why? Because if you let just one browser window
open, your username/password will be kept in memory. This means that anyone
who can get access to your computer will get instant access to the FIDES system using
your personal FIDES profile (i.e. being identified as you), without needing to supply any login or password.
4.2 Different ways to send data
to FIDES
You have three possible ways to send
your data to the FIDES application and you can choose the way that best
suits your needs or your hardware installation:
using the Web interface: this is the most user-friendly way because you
have plenty of information online and a user interface that guides
you through the process of uploading your data or retrieving data from
the server. This is not only user-friendly but it is also the most secure
way to connect to FIDES: by using the Web interface, you talk to the FIDES server through a digitally
encrypted channel, and you're authentified through your
login/password pair wich is sent over the Internet on the encrypted channel.
The encryption is performed using a server side digital Certificate, which also guarantees you are
talking to the genuine FIDES server hosted at the European Commission. To access the interface,
you have to use Netscape
Communicator v4.0 or newer, or Microsoft Internet Explorer v4.0 or
newer. Other browser might work as well but are not officialy supported.
At least your browser must support Secure Socket Layer (SSL), HTML 3.2,
frames, and JavaScript (see 4.3);
using FTP: this way, you can upload your transaction files to your outgoing
directory. Normally, the processing results are available within 15-30
minutes. Any FTP client will work (see 4.4).
using email (SMTP/X400): uploading your data is as simple as sending an
email to fish-fides2@ec.europa.eu.
Your data can be either in the body of the message or included into an
attachement. Any email client will work (see 4.5);
4.3 Using the Web User's
Interface
Once you are connected to the Web Site,
an easy to use interface will show up on your screen. The first page
gives you a listing of the regimes that are available.
Figure 1 - A sample regime listing
Basically there are two types of buttons you can click on:
 |
click on this button to go to the next screen of the
application. Each transactions are grouped by regimes |
 |
click on this button to get more information, when
available |
Click on a regime, then the desired transaction to dispay the form related
to the choosen transaction.
The purpose of this form is to allow you to dynamically alter or add
information to the transaction file that you want to submit. Any information
you enter in this form supersede corresponding information in your transaction.
However, if your transaction is already self-sufficient (in terms of FIDES
II parameters), you can ommit to fill in any fields.
Do not forget to choose your transaction file by clicking on 'Browse',
and selecting the file from your computer. Then you can choose if you want
to View or Download the results. Viewing the results means that you will
view the result in your browser as an HTML page; dowloading the results
means that you will save the results in an HTML page on your hard drive.
If the file is not in FIDES format (i.e. without a header and a body
part), it must at least contain the body part for the given transaction.
Click on Submit to submit your transaction and wait for the results
page to be displayed. This results screen if divided in two part: the HEADER
and the BODY. Check the body to see the output of your transaction. In
case of an error message, correct the problem and try again, or call the
Helpdesk for further assistance.
Note the presence of a 'Quickload' menu item on the left of the upper
banner. The Quickload button is here to provide you with a quick and convenient
way to submit transactions that are already self sufficient FIDES message
(see section 2.
Message format specifications for details).
If you have any comments or remarks concerning the presentation of the
Web interface, feel free to drop a line to fish-fidesinfo@ec.europa.eu.
Your feedback is very important to us as we will adapt the systems to your
needs.
4.4 Using FTP
This way of connection is especially
useful if you want to implement an automated submission process of your
data. However, be warned that this is a non secure way to transmit your
data (anyone who can listen to the wire can intercept your transaction).
Please contact the FIDES Helpdesk if you want to use the FTP connection.
Currently this service is only accessible via dedicated lines or direct
dial-up connection to the FTP service at the Commission.
The settings to connect to the FTP service, as well as a username and password
will be provided to user who request the opening of an FTP account. Requests should
be directed to fish-fidesinfo@ec.europa.eu.
The connection to the server is fairly simple but depends heavilly on
your FTP client application. Let's go for a short explanation with the
basic ftp client delivered with almost any Operating Systems. Note
that FTP commands are the same on all the clients so there are chances
that this explanation will works for you even if you use another FTP client
(graphical FTP clients are often more user-friendly and self-explanatory).
type 'ftp' from a command prompt to launch the ftp client;
at any moment, you can type 'help' or '?' at the ftp
command prompt to get some information about available commands (maybe
you could even try the help command followed with the name of another command
to get some specific help about that specific command, e.g. help ls);
type 'open <ip address or name>' to open the site;
provide your usename;
provide your password;
you are directed to your home directory. If you want to upload a file,
go to the outgoing directory;
type 'put <transaction_file.trn>' to upload the file;
type put '<transaction_file.tmp>' to upload the unlock file;
that's it, your file has been uploaded to the FIDES system.
FIDES system will parse your outgoing directory (named to_eu) and process valid
file that are found there. After a few minutes, an answer from
the system will be put in your incoming directory (named from_eu). Be sure to check this
answer to learn about the success or failure of your transaction.
The extension of the filename gives you an indication about the outcome
of your transaction:
.fin: a processed file which means your transaction was successful;
.err: a processed file which means your transaction resulted in an error.
Note that the filename that you use to name your transaction can
also contain some additional parameters, as defined bellow:
t=: gives the transaction name (e.g. t=CR-RPT-A;.trn for Catch Report A);
x=: gives the transaction character set (e.g. x=EUROASCII;.trn);
f=: gives the transaction reference (e.g. f=my_ref;.trn).
Thus as an example of valid filename you can have t=CR-RPT-A;f=my_reference;x=Cp1252;.trn.
This is especially useful if you want to submit a FIDES I transaction without
modification. Pay attention not to forget the semi colon (';') after each
additional parameter given.
If you got an error message from FIDES in your incoming directory,
correct the problem described in the error file and try again. If
you have no new files in this directory, check in your outgoing directory
to see if your transaction file is still there. If your file is still there,
two possible explanations to the problem can be found:
you are not allowed or configured to use the FTP interface;
the system is not online or is misconfigured.
If you feel the error is related to the system, do not hesitate to contact
the FIDES Helpdesk (fish-fidesinfo@ec.europa.eu).
4.5 Using X.400/SMTP email
You can send your transaction to fish-fides2@ec.europa.eu
for processing. Note that you can supply your transaction to the
system in a variety of ways:
by pasting the content of your transaction into the body of your message;
by sending the transaction as an attachement (this is the recommended method);
by providing some additional parameters in the Subject field.
Only one transaction can be sent per mail.
Additional parameters that you can provide in the Subject fields are:
f= gives the transaction reference. Do not forget to include a semi-colon;
t=: gives the transaction type. Do not forget to include a semi-colon;
x= gives the transaction character set.
Any additional parameters in the Subject field
supersede corresponding parameter in the transaction
Thus as an example of Subject, you can have t=CR-RPT-A;
f=my_reference;x=Cp1252;. Pay attention not to forget the semi colon
(';') after each given additional parameter.
If you get an error message, correct the problem described in the error
file and try again. If you feel the error is related to the system,
do not hesitate to contact the FIDES support (fish-fidesinfo@ec.europa.eu).
Now a word about security. For historical reasons, users generally send their FIDES email
messages in clear text and relied on the email protocol for telling FIDES server who they are.
Be warned that doing so is very insecure. Not only your information travels in clear over the
Internet, but it's also very convenient for a trained hacker to masquerade you and submit
whatever they want to FIDES on your belhalf!
Nowadays S/MIME email security is fully supported by FIDES and
can be enforced on a per-user basis. This means that you can now use any standard S/MIME
compliant email agent software to:
digitally sign your emails and be sure nobody will be able to masquerade you again
digitally encrypt them, making it virtually impossible for a third party to eavesdrop
do both at the same time (which is the recommended option if you can do it)
FIDES will take similar measures when replying back to you, so you
will know for sure whatever you receive through the Internet really is the genuine FIDES
reply message and that nobody else but you can read it.
You will need a Personal RSA Certificate to use S/MIME security.
If you already have one chances are FIDES will trust it and it will work with FIDES right out of the box.
The only necessary step will be to install the FIDES S/MIME Bridge Server Certificate from
the FIDES Links page in your email software
(this usually only needs to be done once).
If you currently have no Personal RSA Certificate however, the IDA Programme at the European Commission
may be able to give one to you. More information can be found
IDA Web site.
In this section, you will find several examples of transactions using different
presentations and options.
5.1 Catch Report A Examples
Consider the following example: a user wants to
submit a Catch Report A transaction for Sweden using tags to start and end records
and terminators to separate fields inside the records.
In that case, the file will look like in the following example (note the <SYSTEM.PROBE> tag which means that
this transaction is a test. You need to remove it for real transactions!):
<FIDES2>
<HEAD>
<CONTENT_TYPE.CURRENT.PRESENTATION>StartTagEndTag-Terminator
<REQUEST.NAME>CR-RPT-A
<REQUEST.COUNTRY.ISO_A3>SWE
<SYSTEM.PROBE>
</HEAD>
<BODY>
<RPM>199901;</RPM>
<DAT> HER;3BCD-C;C ;17.5;0;0;0;17.5;</DAT>
<DAT> HER;5B6ANB;C ;0;0;0;25;25;</DAT>
<DAT> SPR;3BCD-C;P ;1.1;0;0;0;1.1;</DAT>
</BODY>
</FIDES2>
|
(Download this transaction)
|
Now consider exactly the same transaction but with a fixed size presentation:
<FIDES2>
<HEAD>
<CONTENT_TYPE.CURRENT.PRESENTATION>StartTagEndTag-FixedSize
<REQUEST.NAME>CR-RPT-A
<REQUEST.COUNTRY.ISO_A3>SWE
<SYSTEM.PROBE>
</HEAD>
<BODY>
<RPM>_199901
<DAT>_HER_3BCD-C__C17.5_______0__________0__________0__________17.5______
<DAT>_HER_5B6ANB__C0__________0__________0__________25_________25________
<DAT>_SPR_3BCD-C__P1.1________0__________0__________0__________1.1_______
</BODY>
</FIDES2>
|
(Download this transaction)
|
As you can see, the <CONTENT_TYPE.CURRENT.PRESENTATION> tag has changed to reflect the new
body presentation.
As a third example, imagine that you want to submit a file with start tags only
as record separators and terminator as field separators, but you want that the answer to be
provided with start tags AND end tags. Then, the transanction will looks like:
<FIDES2>
<HEAD>
<CONTENT_TYPE.CURRENT.PRESENTATION>StartTagTerminator-Terminator
<CONTENT_TYPE.REPLY.PRESENTATION>StartTagEndTag-Terminator
<REQUEST.NAME>CR-RPT-A
<REQUEST.COUNTRY.ISO_A3>SWE
<SYSTEM.PROBE>
</HEAD>
<BODY>
<RPM>199901;
<DAT> HER;3BCD-C;C ;17.5;0;0;0;17.5;
<DAT> HER;5B6ANB;C ;0;0;0;25;25;
<DAT> SPR;3BCD-C;P ;1.1;0;0;0;1.1;
</BODY>
</FIDES2>
|
(Download this transaction)
|
As you can see, the <CONTENT_TYPE.REPLY.PRESENTATION>StartTagEndTag-Terminator
line has been added to the header.
5.2 Vessel List Declaration Example
Imagine that a user want to transmit a Vessel List
Declaration for Andorra from the FIDES Web Site, but wants at the same time that the results
of the transaction is also sent to an email address. This user also
wants to include a small reference for his own purpose. A valid transaction for this could
be:
<FIDES2>
<HEAD>
<REQUEST.NAME>VL-DECL
<REQUEST.COUNTRY.ISO_A3>AND
<REQUEST.AR>smtp:mymailbox@mycompany.com
<REQUEST.REFERENCE>This is my own reference
<SYSTEM.PROBE>
</HEAD>
<BODY>
ADDANDSGD1 AND24555____VICTOR__________________________________20000512
ADDANDSGD19AND24555____VICTOR__________________________________20000512
ADDANDSGD2 AND24555____VICTOR__________________________________20000512
ADDANDSGD29AND24555____VICTOR__________________________________20000512
ADDANDSGD3 AND24555____VICTOR__________________________________20000512
ADDANDTGD1 AND24555____VICTOR__________________________________20000512
ADDANDTGD19AND24555____VICTOR__________________________________20000512
ADDANDTGD2 AND24555____VICTOR__________________________________20000512
ADDANDTGD29AND24555____VICTOR__________________________________20000512
ADDANDTGD3 AND24555____VICTOR__________________________________20000512
ADDANDTGD41AND24555____VICTOR__________________________________20000512
ADDANDTGD41AND24554____PLAYA DE PYRINEES_______________________20000512
ADDANDTGD42AND24554____PLAYA DE PYRINEES_______________________20000512
ADDANDPSP3 AND24556____MOUNTAIN BOAT___________________________20000512
ADDANDPSP40AND24556____MOUNTAIN BOAT___________________________20000512
ADDANDPSP41AND24556____MOUNTAIN BOAT___________________________20000512
SUPANDPSP3 AND238______VADUZ___________________________________20000512
SUPANDPSP40AND238______VADUZ___________________________________20000512
SUPANDPSP41AND238______VADUZ___________________________________20000512
SUPANDSGD1 AND5110_____PEGAS___________________________________20000512
SUPANDSGD19AND5110_____PEGAS___________________________________20000512
SUPANDSGD2 AND5110_____PEGAS___________________________________20000512
SUPANDSGD29AND5110_____PEGAS___________________________________20000512
SUPANDSGD3 AND5110_____PEGAS___________________________________20000512
SUPANDTGD1 AND5110_____PEGAS___________________________________20000512
SUPANDTGD19AND5110_____PEGAS___________________________________20000512
SUPANDTGD2 AND5110_____PEGAS___________________________________20000512
SUPANDTGD29AND5110_____PEGAS___________________________________20000512
SUPANDTGD3 AND5110_____PEGAS___________________________________20000512
SUPANDTGD41AND5110_____PEGAS___________________________________20000512
SUPANDTGD41AND4208_____BERNARDO ALFAGEME_______________________20000512
SUPANDTGD42AND4208_____BERNARDO ALFAGEME_______________________20000512
</BODY>
</FIDES2>
|
(Download this transaction)
|
Note that if you use the Web interface, you can also provide the <REQUEST.AR>
and <REQUEST.REFERENCE> from the form on the transaction page.
5.3 Cath Report Landing Example
Building a query for the Catch Report Landing is a quick
process. The query critera is located in the header of the
transaction file. So a valid query file can be:
<FIDES2>
<HEAD>
<REQUEST.NAME>CR-LANDING
<REQUEST.REFERENCE>This is my reference
<END_DATE>19981130
</HEAD>
<BODY>
</BODY>
</FIDES2>
|
(Download this transaction)
|
ACL |
Stands for Access Control List. This is the
security assignement policy that is applied to all users. |
BP |
Stands for Business Process. The business process
is a functional unit allowing the treatment of a report. It is not part
of FIDES and is under the responsibility of the concerned DG Fish regime
project management. |
CA |
Stands for Certificate Authority. This is the
organisation that delivers SSL certificates. For FIDES, GlobalSign
is this organisation. |
CUG |
Stands for Closed User Group. |
FIDES |
Stands for Fisheries Information Data Exchange
System. |
FIDES transaction |
This is the suite of FIDES actions performed when
the user report/request data to FIDES. For example, when you request
information, FIDES triggers certain functions like character set conversion,
message parsing, end of line conversion, etc. before and after transmitting
your information to the business process |
frames |
In HTML, you can divide your screen into several parts,
and display different pages in thoses parts. Those parts are called frames. |
FTP |
Stands for File Transfer Protocol. This is
a protocol used to transfer files across a TCP/IP network. |
HTML |
Stands for HyperText Transfer Protocol. This
is the language used to write pages on the Internet. |
HTTP |
Stands for HyperText Transfer Protocol. This
is the protocol used to transfer rich content pages over a TCP/IP network
(pictures, videos, text, sounds). |
IDA |
Stands for Interchange of Data between Administration. |
LDAP |
Stands for Lightweight Directory Access Protocol.
LDAP is a standard directory management system which allow to store information
is one place about almost whatever you want (users, computers...). "A directory
is like a database, but tends to contain more descriptive, attribute based
information. The information in a directory is generally read much more
often than it is written. As a consequence, directories do not usually implement
the complicated transaction or rollback schemes regular databases use for
doing high volume complex updates. Directory updates are typically simple
all-or-nothing changes, if they are allowed at all. Directories are tuned
to give quick response to high volume lookup or search operations. They
may have the ability to replicate information widely in order to increase
availability and reliability, while reducing response time. When directory
information is replicated, temporary inconsistencies between the replicas
may be OK, as long as they get in sync eventually[2]."
If you want more technical information about LDAP, you can go to "An
LDAP Roadmap & FAQ" (http://www.kingsmountain.com/ldapRoadmap.shtml) |
LRA |
Stands for Local Registration Authority. The
role of the LRA is to verify that the user is authorised to access the FIDES services,
i.e. that he belongs to the FIDES community. |
servlet |
Java application that is running on the server side.
That means you do not need a Java virtual machine on the client computer. |
PKI |
Stands for Public Key Infrastructure. |
SMTP |
Stands for Simple Mail Transfer Protocol. This
is the protocol widely used to transfer electronic mail between hosts over
a TCP/IP network, e.g. Internet. |
SSL |
Stands for Secure Socket Layer. SSL is a process
to ensure the security of a connection between two hosts in an open network
environment such as Internet. SSL works with certificates that are given
to the client to be sure the client is really the one he claim to be[3] | .
TAC |
Stands for Total Allowed Catches. |
TCP/IP |
Stands for Transport Control Protocol/Internet
Protocol. This is the standard protocol that transport the packets
of data between hosts. |
X.400 |
protocol used to transfer electronic mail across a
network |
XML |
Stands for eXtended Markup Language. This is
a metalanguage how's purpose is to lets you create your own tags and your
own language. |
7.1 Additional documentation
Check the FIDES CIRCA
Library on the CIRCA Web Site.
7.2 Online tools
On the web, you can check the IDA Homepage (http://forum.europa.eu.int/Public/irc/ida/fides/home).
You will find plenty of information about the FIDES project there, especially
about technical issues and requirements. You can also check the FIDES
promotional and informational Web Site at http://forum.europa.eu.int/Public/irc/ida/fides/info/data/f2web/index.htm;
To learn about the formating of transactions, you
can use the FIDES application itself. By using the SC-FORMAT-Q1
transaction, you can query for the format of every transaction available
in FIDES;
The mailing list is an automatic way to receive the latest information
about FIDES application, as well as tips and tricks and news.
8.1 European Commission
European
Commission Fisheries DG
8.2 FIDES Project Manager
Project Manager: Antoine MATHIEU.
Technical advisor: Matthias PETOFALVI.
8.3 FIDES Helpdesk
Feel free to contact the FIDES Helpdesk for any problems or information:
| phone: | +32 2 295.36.83 (Call Dispatch, 8:30-13:00 & 14:00-17:30 Belgian time) |
| fax: | +32 2 295.19.40 (DG Fisheries) |
| email: | fish-fidesinfo@ec.europa.eu (DG Fisheries) |
8.4 Member States National Administrations
Austria: Bundesministerium für Land- und Forstwirtschaft (http://www.bmlf.gv.at)
Belgium: Dienst voor de Zeevisserij (http://cmlag.fgov.be)
Denmark: Fiskeridirektoratet (http://www.fd.dk)
Finland: Maa- ja Metsätalousministeriö (http://www.mmm.fi)
France: Ministère de l'Agriculture et de la Pêche (http://www.agriculture.gouv.fr)
Germany: Bundesamt für Landwirtschaft und Ernährung (http://www.bml.de)
Great-Britain: Ministry of Agriculture, Forestry and Fisheries (http://www.maff.gov.uk)
Greece: Ministry of Agriculture (http://www.minagric.gr)
Ireland: Department of the Marine and Natural Resources (http://www.irlgov.ie/marine)
Italy: Ministero delle Risorse Agricole, Alimentari e Forestali (http://www.politicheagricole.it/pesca)
Portugal: Direcção Geral das Pescas e Aquicultura (http://www.dg-pescas.pt)
Spain: Ministerio de Agricultura, Pesca y Alimentacion (http://www.from.mag.es)
Sweden: Fiskeriverket (http://jordbruk.regeringen.se/index.htm)
The Netherlands: Ministerie van Landbouw en Visserij (http://www.minlnv.nl)
8.5 Useful Links
Portal to all FIDES Web Sites (including Regime Web Sites)
The FIDES Transaction Upload Web Site
The FIDES Public Information Web Site (hosted on CIRCA)
FIDES Info Site (hosted on CIRCA)
The IDA Web Site
Footnotes
[1] Excerpts from the FIDES Software Requirements
Document, Rudy Demo, March 1999, http://forum.europa.eu.int/ida/Members/.
[2] As taken from the Introduction
to the SLAPD and SLURPD Administrator's Guide, University of Michigan.
SLAPD and SLURPD are free Open Source implementations of an LDAP server
and an LDAP replication server for Unix.
[3] More information about SSL can be found on the Netscape Web Site, at http://developer.netscape.com/tech/security/ssl/.
The SSL Specifications can be found at http://home.netscape.com/eng/ssl3/index.html
v0.1: initial alpha release;
v0.1.1: minor corrections/additions;
v0.1.2: minor corrections/additions;
v0.2: addition of contents about web interface;
v0.3: addition about the CA & installation procedure;
v0.4: new layout, minor corrections;
v0.5: adding several sections and corrections (03/12/1999);
v0.5.1: adding a few more information to FTP section (06-12-1999);
v0.6: modifying and expanding data to reflect the latest changes (14-02-2000);
v0.7: first beta version after comments from Fisheries DG (20-02-2000);
v0.8: second revision after DG Fish comments (30-05-2000);
v0.9: adding some information and corrections (13-06-2000);
v1.0: last revision before approval by DG Fish (26-06-2000);
v1.01: minor corrections (03-08-2000);
v2.0: new registration procedure, new helpdesk, new project manager (26-11-2001).
v2.1: corrected some paragraphs discussing client side Certificates (06-03-2002).
v2.2 to 2.3: some minor cosmetic adaptations (15-05-2002).
v2.4: adapted to the new ec.europa.eu domain name (23-03-2007).
Jean-François Brison from Icon Medialab, Matthias Petofalvi from DG Fisheries.
FIDES Helpdesk:
| phone: | +32 2 295.36.83 (Call Dispatch, 8:30-13:00 & 14:00-17:30 Belgian time) |
| fax: | +32 2 295.19.40 (DG Fisheries) |
| email: | fish-fidesinfo@ec.europa.eu (DG Fisheries) |
|
|