text
stringlengths 0
16.9k
| page_start
int64 0
825
| page_end
int64 0
825
| source_file
stringclasses 99
values |
|---|---|---|---|
European Data Portal Version 4.3 – User Manual Page 22 of 57
3.1.7 How to search for EDP Site Content
In order to search within the Portal’s site content (i.e. editorial content, articles, events, reports etc.),
enter any keyword in the “Search site content” text box and click on the
button.
The site will display all matching content found (here for keyword “Brussels”):
Note:
The “Search site content” does not perform any search on datasets.
In order to search for datasets from the EDP Home page, the user should refer to section 3.2. | 21 | 21 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 23 of 57
3.1.8 How to Search for Datasets by Data Category
On the Home Page, the user may click on any of the data categories below: icon or on icon text
(here: “Environment”)
The system displays all dat asets found under the selected data category, as shown below (here: for
dataset category “Environment”). | 22 | 22 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 24 of 57
By clicking on the “All data” icon
, t he system starts displaying all datasets across all data
categories from the entire repository.
The user can scroll through the datasets found by using the pagination at the bottom of the page.
| 23 | 23 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 25 of 57
3.1.9 How to Search for Datasets by Keyword
(please refer to section 3.2.1) | 24 | 24 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 26 of 57
3.2 Datasets (Data Platform)
The datasets section is t he main access point fo r browsing, filtering and searching the datasets . It
offers a faceted search, a full text search and a geographical search. The dataset view provides access
and information to the distributions of the dataset.
The home page of this section appears like this:
| 25 | 25 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 27 of 57
3.2.1 Entering the Datasets-View
The user has the following possibilities to enter the datasets view:
• Browsing directly to http://europeandataportal.eu/data
• Opening the “Data” item in the main menu, then clicking on “Datasets” in the submenu
• Clicking on “Search” in the “Search Datasets” area, with or without a search keyword entered
3.2.2 How to filter datasets by using “Faceted Search”
The user can find suitable datasets by perfo rming a “Faceted Search” . This means the user
systematically adds properties, which the desired dataset shoul d fulfill, e.g. a dataset should be part
of a specific catalogue or category. The following properties are available:
• Countries,
• Catalogues,
• Categories,
• Tags,
• Formats,
• Licences.
Those facets are presented on the left side of the main dataset page. The av ailable options for each
facet always reflect the availability of it in the current set of results. The numbers in brackets indicate
how many datasets in total have that property e.g. there are 117,610 datasets with a distribution in
CSV format.
| 26 | 26 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 28 of 57
By clicking on a facet the result set i s filtered by the selected property. Multiple selections are linked
together by a logical “AND or “OR”.
The foll owing example will find datasets which are fr om catalogue “data.gov.uk” AND are in the
categories “Environment” AND have a distribution in the formats (“CSV” or JSON”).
Facets can be selected and deselected. In ad dition a key word can be entered to filter the results
even more.
| 27 | 27 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 29 of 57
3.2.3 How to store personal queries
As a logged-in user it is possible to store queries. This includes the search term and selected facets.
The option is available by clicking on “Save Query” on the datasets view.
The user has to enter a title and description for the query. After submitting the form by click ing on
“Save Query” the current state of the search query will stored.
A list of all stored queries can be found in the user’s dashboard: Data > Dashboard > M y Queries.
Each user can only access their ow n queries. It is possible to search, sort and del ete the queries. By
clicking on the title of the query the respective search is executed. | 28 | 28 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 30 of 57
| 29 | 29 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 31 of 57
3.2.4 How to filter datasets by geographical area
Many datasets are associated with geographical information. It is possible to filter the datasets by
providing a location or area. Only datasets which are within this geographical are a are displayed in
the result set. The core idea is to select the desired geographical area by highlighting it within a
provided map.
There are two approaches to provide this area:
1. The u ser enters a location key word in the “Filter by location” input fiel d on the left si de,
which triggers a search for suitable geo names (e.g. “Paris”). All the results are linked t o
coordinates. By selecting one result the location is automatically highlighted within the map.
The result set is filtered accordingly.
| 30 | 30 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 32 of 57
2. The second possiblity is a manual selection of a geographical area. The users first clicks on
the grey square and the ma p enlarges automatically. Then, the user clicks on the “Pencil”
button and selects an area by drawing a rectangle over the desired locati on with the mouse
(here: Spain). The filtering is applied by clicking on “Apply”.
| 31 | 31 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 33 of 57
3.2.5 How to download dataset distributions
Besides special formats (see chapters 3.3 and 3.4) distributions are not displayed within the platform
but only l inked. When the user enters the detailed vie w of a dataset by selecting it in the sea rch
result, all available distributions are listed. For d ownloading a distribution, the user click s on the
“Download” button and then on the “Go to resource” icon.
| 32 | 32 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 34 of 57
3.2.6 How to view licensing information
Licensing info rmation is available for all data sets associated with common licenc es, w hich are
supported by the Licence Assistant. When available a link to the assistant is provided on left side of a
dataset page.
By clicking on the licence name (here: cc-by), the Licence Assistant tool is opened in a new window,
displaying relevant information for this particular licence.
| 33 | 33 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 35 of 57
By clicking on the “Data->Licensing Assistant” link in the main menu, the Licence Assistant is opened
in a new window, displaying relevant information of all supported licences by the tool.
| 34 | 34 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 36 of 57
3.2.7 How to switch to another user language
The user language can be switched by selecting a language from the dropdown menu on the top. This
changes the interface langu age and the language of metadata fie lds of the datasets, w hich are
provided in multiple languages, mainly title and description.
By default the searching for datasets is performed within all available languages. | 35 | 35 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 37 of 57
3.2.8 How to browse by data catalogues
By browsing to Data > Catalogues in the m ain menu, all source catalogues are listed and/or can be
searched for by entering a keyword contained in the catalogue name or description.
Catalogues can also be filtered by their country of origin. This ca n be done by selecting one or more
countries in the left country facet. The page then lists all catalogues from the selected countries.
http://www.free-country-flags.com/
| 36 | 36 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 38 of 57
3.3 Visualization of Geo-Spatial Data (map.apps)
The visualization of ge o-spatial data within the European Data Portal provides previewing
functionality for spatial open data. The aim is to allow the us er to assess if a dataset meets specific
requirements in terms of spatial and them atic coverage. The functionality that is pro vided in t he
header (links to disclaimers and language switching) is consistent in the entire portal.
3.3.1 How to visualize geo-spatial data from a dataset resource
Accessing the geo-spatial visualization is achieved via the Data Platform interface. A user searches for
specific data, enters the data set view of reaso nable results and displays the available distributions
(see Section 3.2.5). If a dataset distribution is supported by the geo -spatial vi sualization, a globe
button is displayed (se e Figure 3). This is the entry point into the map viewer application. Supported
formats are OGC Web Map Service (WMS) and GeoJSON. If the user visits the geo -spatial
visualization for th e first time, an interactive user tutorial i s provided to guide the use through
specific functions of the user interface, similar to this written user manual.
Figure 3 – Dataset Resource Page with Link to Geo-Spatial Visualisation. | 37 | 37 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 39 of 57
Once within the map viewer application, the user can decide which layers to be displayed. Most Web
Map Service (WMS) instances provide more than one layer. The geo -spatial visualization provides a
dialog for choosing the desired layers for display (see Figure 4).
Figure 4 – Selection of layers.
In order to examine the resource in more detail, the user can click on a ge ographic feature while the
“Feature Info” tool is enabled (see Figure 5). This function is only enab led if the service supports this
kind of detailed query. | 38 | 38 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 40 of 57
Figure 5 – Feature Info tool.
The different displayed layers can be examined using the “Legend” tool. If the external service
provides legend graphics, the user can inter pret the g iven symbology and temporarily disable the
display of layers (see Figure 6).
Figure 6 – Legend tool.
| 39 | 39 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 41 of 57
The two buttons on the bottom right of the map vi ewer (see Figure 7) can be used to display an
informational disclaimer and to start the user interface tutorial.
Figure 7 – Disclaimer and tutorial buttons.
In some cases the user might experience the display of an error message. The geo -spatial
visualization tries to support all flavors of external services but cannot guarantee to work with
broken services. In these situations an error message dialog is presented and the user can decide if a
support ticket shall be opened (see Figure 8).
| 40 | 40 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 42 of 57
Figure 8 – Error message dialog.
| 41 | 41 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 43 of 57
3.4 Graphical Data Visualisation Tool
This section describes the features of the graphical visualisation tool for numeric data. Th e features
are currently available for XLS (Excel) and CSV files, except for the selection of the sheet name which
is applicable only for Excel files.
Most GUI elements fro m the “Graph” tab (records selection, search box, filters and fields buttons)
are also available on the “Grid” tab and work in the same way.
3.4.1 How to visualize graphical data from a dataset resource
As a result of a dataset search, the system displays on th e “D ataset” tab all distributions
(resource/data files) that are part of the selected dataset. Each XLS or CSV distribution of the dataset
can be further explored by clicking on “Open Visualization” under the “Options” button – if available.
| 42 | 42 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 44 of 57
After clicking on the “Open Visualization” button, the user should execute the following steps:
Step 1: Select a Sheet Name
The Portal is parsing the XLS file and lists all available worksheets. Select one of the s heets contained
in the XLS file.
Step 2: The Grid View
The grid appears once the user has clicked on a file name (and a sheet name in case of an Excel file).
| 43 | 43 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 45 of 57
Step 3: The Graph Tab
Click on the graph tab in order to display the corresponding graph.
1. Selection of the sheet name
2. Button to go back to the “Grid” view
3. Selection of a range of data records
4. Search box
5. Filters button to open the filters form
6. Fields button to open the fields box
7. Select box to select the graph type
8. Select box to select the group column (Axis 1)
9. Select box to select the series A (Axis 2)
10. Button to add series | 44 | 44 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 46 of 57
Step 4: Filters
Once the user clicks on the filters button the filters form appears.
After clicking on “Add filter”, the available fields appear and the user can now filter the data with a
specific value or range.
| 45 | 45 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 47 of 57
Step 5: Fields
Click on the “Fields” button in order to display the fields box that contains the list of available fields.
Step 6: Adding another data series
Click on the “Add Series” button to add another data series to the current graph as shown below.
| 46 | 46 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 48 of 57
3.5 Help Desk
3.5.1 How to contact the Portal’s Help Desk
The European Data Portal Help Desk can be contacted:
• By email: [email protected]
• By phone: t he Portal’s Help Desk is staffed by a multi lingual team of experts, who can be
contacted from Monday to Friday from 09:30 to 17:30 (CET).
o EN: (+352) 31 44 01-448
o FR: (+352) 31 44 01-449
• By providing comments and suggestions via the online contact/feedback form available from
the Portal’s home page.
From the header:
From the footer:
After clicking on the “Contact” item, the following form is displayed: | 47 | 47 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 49 of 57
| 48 | 48 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 50 of 57
3.6 Metadata Quality Assurance (MQA)
The Metadata Quality Assurance is a c omponent to monitor the quality of the metadata that is
harvested from other portals or sto red manually with the EDP metadata creation form. Currently
quality measurement is ba sed on metadata schema violation against DCAT-AP 1.1 and availability of
the dis tributions of a dataset. The MQA is running checks on a weekly basis. Each check has a
duration of a couple of days. This is due to the HTTP GET requests against each single di stribution in
the portal, checking their availability.
In addition to the navig ation buttons in the dark blue bar at the top of the page, a drop down menu
allows the downloading of a report file, in which all the data generated by the MQA is contained. The
report is available in various formats. The PDF report includes the charts displayed.
3.6.1 The Global Dashboard View
This is the landing page of the MQA. It gives an overview of the quality situation across all catalogues,
datasets and distributions in the P ortal. If the use r wants to investigate the mentioned issues with
datasets or distributions in detail, he/she can use the catalogue selection menue on top of the page
to navigate to the selected catalogue details page.
An information icon in the upper right corner is indicating that the user can get explanation texts for
all diagrams on the page. The introduction text shows the planned schedule for the next check to be
performed by the MQA. The bottom of the page show s the date when the last check started. I f the
MQA is currently running a check, then a spinning wheel beside the last check date is indicating this.
| 49 | 49 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 51 of 57
3.6.2 The Catalogue details view
This page presents a detailed view of the issues per catalogue. The “Download as report” drop-down
menu provides a list o f all avail able catalogues. As a next step, the user can choose whether to see
the catalogue dashboard, the distribution availability or dataset schema violations. The catal ogue
dashboard is the default view when visiting this page.
| 50 | 50 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 52 of 57
3.6.2.1 Catalogue Dashboard
The catalogue dashboard provides the same informatio n as the overall dashboard , but only for the
selected catalogue.
3.6.2.2 Distributions
This view provides a detailed report of the distributions’ status of the selected cat alogue. The user
can see the URL s of the dis tributions that were checked (access and download URL), the
corresponding HTTP r esponse code s and the date s when this issue occurred the first time.
Additionally, the distributions’ format is checked for its machine readability. The machine readability
check is based on the results of the Open Data Monitor project1.
1 https://github.com/opendatamonitor/odm.restapi/blob/master/odmapi/def_formatLists.py#L44-L87 | 51 | 51 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 53 of 57
3.6.2.3 Violations
The MQA checks for each dataset if it is DCAT -AP compliant. The validation is done on the metada ta
that is stored in the Virtuoso repository. Therefore, a JSON schema was created and is us ed for
validation. The user can see the location where the violation occurs and its reason for each not
compliant dataset of the selected catalogue.
| 52 | 52 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 54 of 57
3.7 SPARQL Manager
The SPARQL M anager provides a grap hical user interface ( GUI) for sending user defined q ueries to
the Virtuoso SPARQL query engine.
The powerful SPARQL Protocol a nd RDF Query Langua ge are primarily aimed at professionals for
querying metadata as Linked Data. A basic knowl edge of the DCAT -AP specification is highly
recommended.
In the future , users of the SPARQL Manager will be able to save their queries for scheduled
execution. Additionally a notification will be send to the user when a result has changed.
Clicking the inf o icon in the upper right corner will display a step -by-step walkthrough of all
components with a short info about their function.
This is possible in both of modes of the SPARQL Manager, the search and the assistant mode, which
will be described in the following sections.
3.7.1 SPARQL Search
In this mode you can load some predefined example queries from the right side into the editable text
area to introduce yourself w ith the very basic SPARQL syntax. Limiting the number of returned
results is possible by se lecting a value fro m the Limit -dropdown or by editing the query directly .
Furthermore the format for the result can be selected. After clicking the Search -Button the result is
displayed in Result data preview area below. The preview may be truncated depending on the size of
the result. The complete result could always be downloaded as a file by clicking the Download-link on
the right side. | 53 | 53 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 55 of 57
3.7.2 SPARQL Assistant
The SPARQ L assistant extends the functionality of the simple SPARQL search described in the
previous section. More complex queries for datasets could be built by clicking s everal options in the
GUI.
1. Category/Theme
Select one or more Categories/Themes defined in the DCAT-AP standard to filter the results.
Datasets will only be listed in the result if they belong to all selected categories/themes.
2. Distribution format
Datasets can contain d istributions in different formats. You can select one or more formats to
exclude datasets from the result which distributions do not contain the desired formats. If your
format selection by the DCAT-AP standard is to strict you may enter a custom format string at the
bottom of the list, which will result in a simple text comparison in the format label field.
3. Search for keyword
Enter a search term which must be found in the dataset. You can li mit this to the title or the
description. By enabling both options the term has to occur in the title and the description.
4. Count number of results
By clicking the “only count number of results” option, only the number of results that mat ches
the SPARQL query is returned.
| 54 | 54 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 56 of 57
3.7.3 SPARQL Saving/Modifying a Query
Once a user is logged-in, he/she has the oppotunity to save custom queries. A corresponding name
and the actual query as well as a result format have to be provided.
The user may as well enter an email address in order to receive a notification email from the system
and a comment which describes the query.
Selecting a schedule string lets the query run automatically if the checkbox “Enabled” is selected.
If the user likes to share and lets other users see the query he/she may select the “Public” checkbox.
The same page will be displayed if the user decides to modify one of his /her queries. A l ist of all
results on the right side lets the user decide which result he/she likes to display. | 55 | 55 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
European Data Portal Version 4.3 – User Manual Page 57 of 57
3.7.4 SPARQL Queries
The third tab displays all queries set to “public”. Upon creating or modifying a query the user may set
the attribute “public”, which will make the query accessible to everyone.
Once the user is logged -in, another list with all pri vate queries includ ing the owned public queries
will be displayed. Besides “Query name” and “Query comment”, the attribute “E nabled” visualizes if
the query is currently running on a recurring time interval.
All attributes may be changed upon se lecting “Details” if the logg ed-in user is the owner of selected
query.
| 56 | 56 | edp_s1_man_portal-version_4.3-user-manual_v1.0.pdf |
NAIIS-User-Manual.Docx Page 1 10/02/2013
NAIIS Web Application
(Release version 1.1.3)
User Manual
(As of 10 February 2014)
| 0 | 0 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 2 10/02/2013
Contents
1 Introduction .................................................................................................................................. 4
2 General information ..................................................................................................................... 4
2.1 System overview ............................................................................................................... 4
2.2 Pending NAIIS features .................................................................................................... 5
2.3 Contact .................................................................................................................................. 5
3 Getting started .............................................................................................................................. 6
3.1 User Access, Roles and Privileges ........................................................................................ 6
3.2 How to access/ log out / create a GHG inventory ................................................................. 6
3.2.1 How to access the NAIIS application ............................................................................ 6
3.2.2 Create, Start, Add new and View GHG inventory year ................................................. 8
3.2.3 Initial screen / menu tab of the NFP, PM and SE ........................................................ 13
3.2.4 How to log out .............................................................................................................. 13
3.3 User management ................................................................................................................ 14
3.3.1 Add User ...................................................................................................................... 14
3.3.2 Disable/Enable User ..................................................................................................... 15
3.3.3 View User ..................................................................................................................... 16
4 Using the system ........................................................................................................................ 17
4.1 Data Entry ........................................................................................................................... 17
4.2 Navigation tree .................................................................................................................... 17
4.3 Grids .................................................................................................................................... 17
4.4 Data input ............................................................................................................................ 18
4.5 Add/delete new nodes – user defined source categories ..................................................... 18
4.5.1 Add new nodes ............................................................................................................. 18
4.5.2 Delete nodes – user defined nodes ............................................................................... 20
4.6 Backup of data files ............................................................................................................. 20
5 Key Category Analysis ............................................................................................................... 21
5.1 Using the default list ........................................................................................................... 22
5.2 Customizing the list ............................................................................................................. 22
5.3 Delete subnodes ................................................................................................................... 23
6 Reporting Tables ........................................................................................................................ 25
7 Data Export/Import .................................................................................................................... 26
7.1 Excel Export – Data Entry .................................................................................................. 26
7.2 Excel/XML Data import ...................................................................................................... 27
7.3 Export reporting tables ........................................................................................................ 28
7.4 XML Export ........................................................................................................................ 29
8 Completeness ............................................................................................................................. 31
9 Consistency ................................................................................................................................ 33
10 Submission management .......................................................................................................... 35 | 1 | 1 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 3 10/02/2013
10.1 Workflow .......................................................................................................................... 35
10.2 Start of inventory/submission (NFP or PM) ..................................................................... 35
10.3 Send for checking (PM) .................................................................................................... 37
10.4 Send for approval/rejection of an Inventory (PM) ............................................................ 38
10.4.1 Send for approval of an Inventory .............................................................................. 38
10.4.2 Rejection of an Inventory ........................................................................................... 38
10.5 Approval or Rejection of an inventory (NFP) ................................................................... 40
10.5.1 Approval of an inventory ........................................................................................... 40
10.5.2 Rejection of an inventory ........................................................................................... 41
10.6 Submit inventory (PM) ...................................................................................................... 42
10.6.1 Submit select tables for preparing the general submission ........................................ 42
Glossary of terms and abbreviations ............................................................................................. 44
Annex 1: Non-Annex I (NAI) Parties .......................................................................................... 45
Annex 2: Fuel categories .............................................................................................................. 47
Annex 3: Global Warming Potentials (GWPs) ............................................................................ 48
Annex 4: Default values ............................................................................................................... 49
| 2 | 2 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 4 10/02/2013
1 Introduction
The Non-Annex I Inventory software (NAIIS) web application is a web-based tool developed for use by Parties not
included in Annex I to the Convention (non-Annex I Parties) to estimate and report their national greenhouse gas
inventories (GHG inventories). As per Article 4, paragraph 1 (a), and Article 12, paragraph 1 (a) of the Convention,
non-Annex I Parties are required to communicate to the Conference of the Parties a national inventory of
anthropogenic emissions by sources and removals by sinks of all greenhouse gases (GHGs) not controlled by the
Montreal Protocol, to the extent their capacities permit, following the guidelines contained in the annex to
decision17/CP.8.
In order to assist non-Annex I Parties in estimating and reporting their GHG inventories as part of their national
communications, the secretariat developed an Excel-based software which incorporated all the elements of a national
GHG inventory prescribed by decision 17/CP.8. The software was based on the IPCC inventory software version
1.1, which used the Tier 1 methodologies for estimating GHG emissions and removals for all source categories
included in the Revised 1996 IPCC Guidelines, and further complemented by the GPGs.1
Since its release in 2005, most non-Annex I Parties have been using that software for the development of their
national GHG inventories. In December 2011, Parties requested the secretariat to upgrade the software and make it
available to non-Annex I Parties by June 2013. Pursuant to that request, the secretariat converted the current Excel-
based version of the software (v.1.3.2)2 into a web-based application (NAIIS) which provides greater flexibility and
security for maintaining data.
2 General information
The NAIIS is a web-based application designed to en able non-Annex I Parties estimate their national GHG
inventories according to the UNFCCC guidelines and using the IPCC methodologies, and to report the results in their
national communications and biennial update reports.
2.1 System overview
The NAIIS web application has the following functionalities:
1. User management (only for the user roles NFP and PM)
2. Submission management
3. Data entry
4. Key category analysis
5. Reporting tables
6. Data Export/Import
7. Completeness
8. Consistency
The NAIIS web application allows input of data through three different channels:
1. Manual input into the entry grids
2. Partial or full import of data from Excel
3. Bulk import of data from XML
The GHG emissions totals, by gas and by sector, are automatically calculated and saved based on the values
entered for activity data (AD), emission factors and other rele vant parameters. In addition, the software facilitates the
reporting of other category specific info rmation, for example, the choice of t he method for activity data and emission
factors.
1 Good Practice Guidance and Uncertainty Management in National Greenhouse Gas Inventories, 2000, and Good Practice Guidance for Land
Use, Land‐Use Change and Forestry, 2003.
2 http://unfccc.int/files/national_reports/non‐
annex_i_natcom/training_material/methodological_documents/application/zip/unfccc_nai_is_132.zip | 3 | 3 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 5 10/02/2013
2.2 Pending NAIIS features
List of pending functionalities in NAIIS:
-----------------------------------------
1. Web services integration for help desk
2. Display of information in 5 remaining UN languages.
2.3 Contact
Requests for access to, inquiries on the use of the soft ware, and comments on the design and functionalities of the
application should be sent to the dedicated e-mail address [email protected].
| 4 | 4 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 6 10/02/2013
3 Getting started
3.1 User Access, Roles and Privileges
The users of the application are the members of the national team(s) of non-Annex I Parties involved in the
preparation of their national GHG inventories, and each user is assigned a role.
The table below explains the different levels of the access rights and corresponding explanation for each role. It is
important to note that the roles are not necessarily identical to a person’s title (e.g. National Focal Point) and that a
person can take on several roles (which may be necessary for some countries).
There are three types of access rights (roles) to the NAIIS application:
Type of access rights for specific roles Process to gain access rights
National Focal Point (NFP): Will be responsible for
identifying the members of the team and is the only
one who has the right to approve the submission of
any GHG inventory.
NFPs will have the option to create, edit, update or
delete all of their country’s GHG data entries, and
grant access rights to the ‘Project Manager’ and
'Sectoral Experts' for their country if they choose.
Parties that have not already requested and received
access rights can obtain them by having their National
Focal Point contact: [email protected]
(Note: Some Parties may have more than one individual
acting as the NFP; however the system can
accommodate only one account per Party).
Project Manager (PM): Will have the right to
enter/edit data in all sectors, as well as to generate
an official submission to the UNFCCC, and grant
access rights to the 'Sectoral Experts' for their
country.
Entities will be provided these rights by their NFP. If a Party
decides to grant access to a PM, their NFP will be able to
create such user account on the NAIIS application.
Sectoral Experts (SE): Will have the right to
enter/edit data in respective sector(s).
Experts will be provided these rights by their NFP and PM. If
a Party decides to grant access to Sectoral Experts, the NFP
will be able to create such user accounts and assign them in
respective sector(s).
Access for the NFP will be provided by the secretariat, upon request; however, the accounts of the other users within
the country shall only be created by the NFP.
3.2 How to access/ log out / create a GHG inventory
3.2.1 How to access the NAIIS application
Open any internet browser (i.e. Internet Explorer, Firefox, etc.) and type in the following URL http://unfccc.int/7627 on
the browser’s address bar. (figure 1 and figure 2)
Figure 1. Using Internet Explorer browser
Figure 2. Using Firefox browser
| 5 | 5 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 7 10/02/2013
Press the ‘Enter key’ and the non-Annex I Greenhouse Gas Inventories web page appears.
To access the NAIIS application, click on the image NAIIS Web Application, the right hand side of the screen. (figure
3, number 1) and the log-in page will be displayed. (figure 4)
Figure 3. UNFCCC non-Annex I Greenhouse Gas Inventories web page
Figure 4. Log-in page of the NAIIS Web Application
To log-in, enter the username and password and click on the “Sign in” button.
| 6 | 6 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 8 10/02/2013
3.2.2 Create, Start, Add new and View GHG inventory year
These functions allow the NFP and PM to create or edit a GHG inventory within the NAIIS software.
3.2.2.1 Create a new GHG inventory or Start a GHG inventory year
3.2.2.1.1 Create a new GHG inventory
Note: This step can ONLY be undertaken by the NFP or PM !
In order to create one or several GHG inventories, the following steps can be done by the NFP or PM:
Log in as NFP or PM
Hover the cursor on “Submission Management” menu and click on the “View Inventories Progress” button. (see
Figure 5). Left click on the “+” sign will create a new GHG inventory. (see Figure 6)
The new GHG Inventory name will be automatically generated by the NAIIS system, as follows:
<Name of the Non-Annex I Party>_<Year in 4 digits>_<version number>_ Inventory
For example: Paraguay_2013_1_Inventory or Bhutan_2014_2_Inventory
Figure 5. Create new GHG inventory screen
Figure 6. New GHG inventory created screen
| 7 | 7 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 9 10/02/2013
3.2.2.1.2 Start a GHG inventory
In order to START a GHG inventory, please follow the steps below:
Log in as PM.
Hover the cursor on the “Submission Management” and click on the “View Inventories Progress” button.
Click/select the appropriate GHG Inventory in Status = “created” (see figure 7a).
Click on “Work on Inventories” under Submission Management (see figure 7b).
Figure 7: Select an Inventory screen
Left click to select the appropriate Inventory (figure 8a)
Press the “Start Inventory” button (figure 8b)
Figure 8: Start an Inventory screen
Once the “Start Inventory” button is pressed, the status of the selected Inventory change to “started”. (see Figure 9)
Figure 9: “Started” status of an Inventory
| 8 | 8 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 10 10/02/2013
3.2.2.2 Add a new GHG inventory year or edit general properties/sectors (only NFP and
PM’s)
Log in as NFP or PM.
Click on “Work on Inventories” under Submission Management (figure 10).
Figure 10: Sub menu “Work on Inventories”
Once “Work on Inventories” has been clicked, the initial screen will be displayed, which shows the following boxes
(figure 11):
a. Existing Inventory (with all options)
b. General properties – include the nam e, submission year, creator, creation date, status, updater and submission
date
c. Sectors
d. Inventory years
Figure 11. Initial screen of “Work on Inventories”
Follow the steps to add/remove an inventory year:
Click on the inventory year (figure 12a)
Select the inventory year unde r General properties (figure 12b)
Select or deselect the appropriate Sectors (figure 12c)
To add or remove an inventory year, select or deselect the relevant year under Inventory Years box (figure 12d)
| 9 | 9 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 11 10/02/2013
Figure 12. Screen of “Work on Inventories”
3.2.2.3 View Inventory Progress
The NFP or PM should log into the system.
Click on “View Inventories Progress” under Submission Management (figure 13)
Figure 13. View Inventories Progress
Click on “View Inventories Progress” button will display the initial screen with the following columns (figure 14a, 14b
and 14c):
Name - automatically given by the system, once created
Working Inventory – active box shows the current working inventory
Submission year – year when the submission process was initiated
Creator – user who created the inventory
Creation date – date when the inventory was created
Status – created, started, check, submitted, approved, awaiting approval, awaiting rejection check
Updater – user name who updated the inventory
Submission date – date of submission
Sectors – Energy, Industrial processes, Solvent and other product use, Agriculture, LUCF, LULUCF, Waste,
Other
Inventory year
| 10 | 10 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 12 10/02/2013
Figure 14a. Example of Initial screen of View Inventories Progress
Figure 14b. Example of Initial screen of View Inventories Progress
Figure 14c. Example of Initial screen of View Inventories Progress
| 11 | 11 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 13 10/02/2013
3.2.3 Initial screen / menu tab of the NFP, PM and SE
Once the NFP, PM or SE logs-in, the initial screen with multiple tabs will be displayed which feature different
functions. Click the name of the tab to enter.
Initial screen / menu tabs for NFP’s and PM’s:
Menu tabs for SE’s
Note: Once a user logs in, the initial screen is the Submission Management screen of the non–Annex I Party
3.2.4 How to log out
To log out, click on the link to “Sign out” located at the upper right corner of the page. (Figure 15)
Figure 15. Sign out screen
When you have successfully logged-out of the system, the screen below (figure 16) will be displayed.
Figure 16. Sign out screen
Note that after 20 minutes of inactivity , the session is automatically ti med out and an error message will be
displayed (figure 17). In such cases, either click on “Sig n out” and log in again, or click on any of the links to be
redirected to the log in page.
Figure 17. Fatal error
| 12 | 12 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 14 10/02/2013
3.3 User management
3.3.1 Add User
Note: This function is ONLY available for NFP’s and PM’s!
Log in as NFP or PM
Hover the cursor on the “Users Management” tab and click on the “Users Administration” button. (see figure 18);
this opens the Users Administration screen (figure 19).
Figure 18. Users Administration
Figure 19. Initial screen of Users Administration
Click the “+” sign (figure 19a) creates a new user (figure 20 new User).
Double click on the cell of the newly created user name and enter a new user name (must be unique and contain at
least 3 characters).
Once done, press the enter key and the new user name will be saved in the respective table of the NAIIS database.
Note: New user name(s) will be generated by the system as default [Non-Annex I Party name] + “newUser”
(e.g. UgandanewUser, PhilippinesnewUser, ArgentinanewUser)
| 13 | 13 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 15 10/02/2013
Fill-in User Information
There are two options to fill in the information of a new user
(a) by entering the data on the same row of the new user (figure 20a) or;
(b) by entering the data in the General Properties, Sector and Role boxes (figure 20b, 20c and 20d).
Figure 20. New user created screen
Fill in the following fields:
First Name
Last Name
Name (optional)
Email address
Password (must have 1 capital letter, 1 numeric and 8 characters long)
User Role
Sectors
Change password (tick the box prompts t he user to change his/her password)
The functionality to change password is not fully implemented in this release. Please do not tick the “Change
password” box under General Properties! (See figure 20 b).
Enable user (Proceed to section 3.3.2 Disable/Enable User)
3.3.2 Disable/Enable User
This function allows the NFP and PM to activate and/or de-activate users of their country.
Log in as NFP or PM
Hover the cursor on the “Users Management” tab and click on the “Users Administration” button. (see figure 21);
this opens the Disable/Enable User screen (figure 22).
Figure 21. Users Administration
3.3.2.1 Enable User
On the Disable/Enable screen, search for the user whose account should be activated and
un-tick the ‘Disabled’ box. (figure 22a).
3.3.2.2 Disable User
On the Disable/Enable screen, search for the user whose account should be de-activated and tick the ‘Disabled’ box
(figure 22a).
| 14 | 14 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 16 10/02/2013
Figure 22. Disable/Enable User screen
3.3.3 View User
This function enables NFP and PM to view all users of their country.
Log in as NFP or PM
Hover the cursor on the “Users Management” tab and click on the “Users Administration” button. (see figure 21);
this opens the Users Administration screen (figure 22).
Figure 21. Users Administration
Click on the row of the respective user to be viewed (fi gure 22a). All information of the selected user will be
displayed on the General Properties, Sector and Role boxes (figure 22b).
Figure 22. Users Administration
| 15 | 15 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 17 10/02/2013
4 Using the system
This section provides a description of the various func tions of the system represented by each tab indicated in
section 3.2.3 above.
4.1 Data Entry
The data entry tab provides the function to input data into the system through the use of grids. To display the grid, a
node has to be selected from the navigation tree. (Figure 23)
4.2 Navigation tree
To expand or collapse the tree, click on the or signs in front of the nodes, respectively. You can also expand
or collapse the entire tree by clicking the plus and minus signs at the bottom of the tree.
Figure 23. Functions of the navigation tree
4.3 Grids
Each node on the navigation tree has a corresponding grid.
A grid includes elements required for reporting information such as activity data, othe r relevant in formation, and
emissions/removals data.
Expand or collapse all
rows of the navigation tree
Collapse the selected node
Expand the selected node | 16 | 16 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 18 10/02/2013
The cells in the grid have different colors. White grid cells denote that the user can enter data, green cells mean that
the data is automatically calculated by the NAIIS application, light blue cells signify that dat a are automatically
copied from a different node (for example in 1.B.1.a.1.i), and yellow cells mean that a default value (for example,
fraction of carbon stored in reference approach) is provided. Where the cell is grey, no input is necessary. (figure 24)
In the energy sector, users are provided a dropdown list to select a unit in reporting t he consumption and production
of fuels. This is marked with .
Figure 24. Functions in a grid
4.4 Data input
Data can be entered into the white grid cells only. It is also possible to copy and paste data from one cell to another
by using the shortcut keys ‘ Ctrl + c ’ to copy and ‘Ctrl + v ’ to paste. Each value entered is automatically saved .
When the data is entered, it is first shown in bold, and then changes to normal font indicating that the value has been
saved. Saving occurs immediately (usually within 1 second), but in case the system becomes slower, the user
should wait until data are shown in regular font before exiting the grid . Otherwise, the data entered will not be
saved.
As mentioned in the previous section, default values are provided for some par ameters (yellow cells in the grid).
These values can be overwritten if the Party has more accurate data.
Note: Data that has been entered will be automatically saved.
4.5 Add/delete new nodes – user defined source categories
4.5.1 Add new nodes
New nodes, for example, can be added to the navigation tree in order to add ei ther a category, a fluorinated gas (F-
gas), a fuel, a livestock type, or a subdivision in the LULUCF sector.
User-defined items can be added for:
Categories indicated as “Other (please specify)”
LULUCF subdivision
User-defined fuels
| 17 | 17 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 19 10/02/2013
To add a new child node , either a pre-defined or a user-defined it em, click on the right mouse button on the parent
node and select “Add new child node ”. For ease of use, the parent nodes, where a child node can be added, are
highlighted in orange (figure 25).
Figure 25. Add new child node
| 18 | 18 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 20 10/02/2013
4.5.2 Delete nodes – user defined nodes
Only user-added nodes can be deleted. To delete a node, right-click on the node and select “Delete child node”
(figure 26). When deleting user-defined nodes, each of the child nodes has to be deleted first before deleting the
parent node that was added. If a user accidentally deletes the parent node before deleting child nodes, an error
message is displayed, and the nodes will disappear from the tree. However, the nodes are not removed from the
database, therefore the user has to click on the “Reload grid” icon ( ) located at the bo ttom of the navigation tree.
After doing so, the child nodes will re-appear on the tree. It should be noted that any data entered in the grid
corresponding to the user-added nodes are also deleted from the database once the nodes are removed.
Figure 26. Delete node
4.6 Backup of data files
To create a backup of your data, you can export the data f iles and save them as Excel files. Please use the Excel
Export function. (Section 7.1)
| 19 | 19 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 21 10/02/2013
5 Key Category Analysis
This functionality allows the user to identify and select one of the categories to be used for performing the Key
Category Analysis (KCA). Upon selection of the category, the system will perform both level assessment and trend
assessment for which the data are available. The correspondi ng results of the assessments are available in the
reporting tables.
The selection of one or several categories is undertaken as follows. When pressing the ‘Key Categories Choice’ on
the top main menu bar, on the left hand side, select the KCA Year to be used, the navigatio n tree displays all sector
nodes with the following columns (figure 27):
Description
Gas
Percent of Total
Default List
Top 95
Important
The user will have the option to use the default list or customize it. (see figure 27)
Figure 27. Key Categories Choice main screen
| 20 | 20 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 22 10/02/2013
5.1 Using the default list
If the NFP, PM or SE decides to use the default list, they can proceed to t he Reporting tables directly. (Section 6
Reporting Tables).
5.2 Customizing the list
To add a key category, click on the specific node (see parent node, figure 28, number 2) or line (figure 28, number.1),
then reload the list.
Figure 28. Key Categories Choice screen
Once the list has been reloaded or refreshed, as per example below, the node 1.A.3.a Civil aviation – Emissions from
Aircraft has been selected (figure 29, number 1), and the par ent node 1.A.3.a Civil Aviation has been unselected.
(figure 29, number 2).
Figure 29. Key Categories Choice screen
| 21 | 21 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 23 10/02/2013
5.3 Delete subnodes
To delete subnodes, double click on the specific subnode or line (figure 30a), a pop-up window warning message
opens. (See figure 31).
Press the “Ok” button to delete the sub node or the “Cancel” button not to delete. (see figure 31 a)
Figure 30. Key Categories screen – delete subnodes
Figure 31. Key Categories – Delete confirmation screen
| 22 | 22 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 24 10/02/2013
| 23 | 23 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 25 10/02/2013
6 Reporting Tables
The Reporting Tables enable the user to view the data ente red in the grids under the Data Entry section of the web
application. Note, however, that the co lumn headings are not always fully di splayed in the tables because column
widths are fixed. The full heading can be seen by scrolling the mouse over the column title.
The navigation tree here is organized by year (figure 32). It functions similarly as the navigation tree for data entry.
Data in reporting tables cannot be modified; modifications to data should be done through the data entry grids.
Figure 32: Reporting tables organized by year
| 24 | 24 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 26 10/02/2013
7 Data Export/Import
This function enables users to export data from the system in either Excel or XML format.
7.1 Excel Export – Data Entry
Click on the “Data Export / Import” tab and the navigation tree will appear on the left-hand side (figure 33).
Figure 33: Data Export / Import initial navigation tree
There are three options available to export files:
1. Export selected single grid – only the data of the current selected grid will be exported. (figure 34, d)
2. Export selected sector / subsector– all data of the current selected grid and the sub sectors will be
exported. (figure 34, e)
3. Export all data entry grids – all data entry grids will be exported. (figure 34, f)
Clicking on one of the Sector’s or sub sectors’ (figure 34, a) or c)) on the left-hand side navigation tree, three Export
buttons will appear on the middle of the screen. (figure 34, b)
Click on one of the “Export” button. The system will then generate an excel export file.
The file that has been exported can be seen under “My Data Export” (figure 35).
Figure 34: Excel export
| 25 | 25 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 27 10/02/2013
Figure 35: My Data Export
The user will be able to open or save the file by clicking on the FileLink “File”. (figure 36)
Figure 36: Export to Excel screen – Download file
7.2 Excel/XML Data import
The data import tab allows the user to import data into the system with the use of an XML or Excel file.
To import data (figure 37, a), click on the “Browse…” button (or “Choose file” for Chrome users), select the file to be
imported, and then click on the “Subm it” button (figure 37). A message will be displayed to confirm successful
completion of import (figure 38). If the type of the file selected for import is incorrect, an error message is displayed
(only *.xml and *.xlsx files are allowed).
Figure 37. Data import
Pressing the “Submit Query” button will start the data import process.
On the left-hand side navigation tree, click on ‘My Data Import’ which opens a list of imported data.
The status of the import process can be seen under “My Data import” (figure 38, b).
Click on the “File” at column FileLink to open or save the file imported (figure 38, c).
| 26 | 26 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 28 10/02/2013
Figure 38. Download file screen
7.3 Export reporting tables
This Export report tables function allows the user to export reporting tables in excel format.
Clicking on the “Export report tables” button triggers the system to generate an excel file (figure 39, c) and the
following message appears on the screen:
‘We have received your request for reporting tables export. Please be patient, this may take a few minutes. You can
check progress of export in ‘My Data Export’. (figure 40, a)
Figure 39. Export reporting tables screen
Figure 40. Export reporting tables screen
On the left-hand side navigation tree, click on ‘My Data Import’ which opens a list of imported data.
The status of the import process can be seen under “My Data import” (figure 41,b).
Click on the “File” at column FileLink (figure 41, c) to open or save the file exported.
| 27 | 27 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 29 10/02/2013
Figure 41. My Data Export screen
7.4 XML Export
This XML export function allows the user to export files in XML format.
Clicking on the “XML Export – Data Entry” button triggers the system to generate an XML file (figure 42) and the
following message appears on the screen:
‘We have received your request for xml file export. Please be patient, this may take a few minutes. You can check
progress of export in ‘My Data Export’. (figure 43, a)
Figure 42. Export/Import navigation bar – XML Export – Data Entry
Figure 43. XML file export – message XML export file request
On the left-hand side navigation tree, click on ‘My Data Export’ (figure 44, a) which opens a list of export data (figure
44, b),
The user should be able to download the file by clicking on the “File” link (figure 44, c).
| 28 | 28 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 30 10/02/2013
Figure 44. Data Entry Grid Export to Excel screen
| 29 | 29 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 31 10/02/2013
8 Completeness
This function allows the user to check whether all the grids of an inventory year have been completed.
When pressing the ‘Completeness’ tab on the top main menu bar, a navigation tree is displayed on the left-hand side,
sorted by inventory years and then by sectors (nodes and sub-nodes).
Clicking on the specific nodes (figur e 45, number 3) on the tree opens on the right-hand side the data entry grid for
that node.
Figure 45 . Completeness screen
When all of the grids in a year or a sector are fully populated, the color of the checkbox under the column ‘Complete’
will be green. If only some of the grids are populated, the checkbox appears orange; if none of the grids are
populated, it is highlighted red. (figure 46)
| 30 | 30 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 32 10/02/2013
Figure 46. Completeness screen – Example
| 31 | 31 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 33 10/02/2013
9 Consistency
Consistency is the function enabling the user to recalculate all the values of a given year, i.e. when the formulas have
changed.
When pressing the ‘Consistency’ tab on the top main menu bar, the left-hand side navigation tree displays the
inventory years in ascending order.
Clicking on the appropriate inventory year (figure 47, number 3) displays the recalculated data on the right hand side,
if any.
Figure 47. Consistency initial screen
Press the corresponding year button to be checked (figure 48, number 1). However, please note that the system is
recalculating all the values for the selected year and a pop-up window with the message “Loading data” appears
in the middle of the screen (figure 49).
Figure 48. Consistency - example
| 32 | 32 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 34 10/02/2013
Figure 49. Consistency screen – message “Loading data”
If no data has changed after the recalculation, the message “No data found” will appear on the screen (figure 50),
otherwise a list of calculated data sorted by order of calculation will be displayed on the right hand side box (figure
51).
Figure 50. Consistency screen – message “No data found”
Figure 51. Consistency screen – list of calculated data
| 33 | 33 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 35 10/02/2013
10 Submission management
10.1 Workflow
Creating and preparing an inventory, generating tables for checking by the NFP and approving and/or rejecting
submission, follows a number of steps known collectively as a workflow. This chapter describes the workflow relating
to the submission of the GHG inventory/(ies), which users should follow to create, prepare, and send GHG
inventories for internal checking, and approval/rejection of the submission by the NFP, within the NAIIS web
application (figure 52).
Figure 52: Non-Annex I Inventory Software workflow
10.2 Start of inventory/submission (NFP or PM)
This procedure allows the NFP or PM to start a new (created) inventory. The existing data for the inventory year
identified will be made available in the new inventory/submission.
These are the steps to start a new inventory:
1. Click on “View Inventories Progress” under sub menu “Submission Management” (figure 53).
Figure 53. View Inventories Progress sub menu
2. The “View Inventories Progre ss” screen appears (figure 54).
3. Select the appropriate inventory by clicking the bo x under column “Working Inventory” (figure 54, a).
*** Note: The selected appropriate inventory should be in status “created” (figure 54, b)
| 34 | 34 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 36 10/02/2013
Figure 54. View Inventories Progress screen
4. Click on “Work on Inventories” under “Submission” (figure 55).
Figure 55. Work on Inventories sub menu
5. Click the appropriate Inventory year on “Work on Inventories” under “Submission” (figure 56, a).
6. Press the “Start Inventory” button to start the inventory (figure 56, b). Once pressed, the status changes to
“started” (figure 57).
*** Once the “Start Inventory” button has been pressed by the NFP or PM, a notification email will be sent to all
SE’s with the information that a new inventory was created. SE’s and PM’s can start entering their data into the
NAIIS software. More details on how to do the data entry please see section 4.1 above.
Figure 56. Work on Inventories screen
Figure 57. Work on Inventories screen – Status = Started
| 35 | 35 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 37 10/02/2013
10.3 Send for checking (PM)
Once the SE’s/or PM’s have prepared the national GHG inventory, by entering data into the sectoral grids and the
PM of the Party has checked the complete GHG inventory for consistency and correctness, the following steps allows
the PM to send the inventory for checking:
1. Log in as PM.
2. Click on “View Inventories Progress” under sub menu “Submission Management”.
3. The “View Inventories Progress” screen appears.
4. Select the appropriate inventory by clicking the Inventory name under column “Name” (figure 58, a).
5. Press the “Send for Checking by NFP” button to send it to the NFP for his review and approval (figure 58, b).
*** Note: A notification email will be sent to the NFP email address, and the status changed to “check”
(figure 59).
Figure 58. Work on Inventories screen – Status = Started
Figure 59. Work on Inventories screen – Status = check
| 36 | 36 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 38 10/02/2013
10.4 Send for approval/rejection of an Inventory (PM)
This section describes on how the PM approves or rejects an inventory after being checked by the PM.
10.4.1 Send for approval of an Inventory
1. Log in as PM.
2. Click on “View Inventories Progress” under sub menu “Submission Management”.
3. The “View Inventories Progress” screen appears.
4. Select the appropriate inventory by clicking the Inventory name under column “Name” (figure 60, a).
5. Press the “Send for Approval” button to send it to NFP for his/her review and approval of the inventory
(figure 60, b).
*** Note: A notification email will be sent to the PM, once the “Send for Approval” has been pressed. And the
status changed to “Awaiting_approval” (figure 61).
Figure 60. Work on Inventories screen – Send for Approval - Status = check
Figure 61. Work on Inventories screen – Status = awaiting_approval
10.4.2 Rejection of an Inventory
1. Log in as PM.
2. Click on “View Inventories Progress” under sub menu “Submission Management”.
3. The “View Inventories Progress” screen appears.
4. Select the appropriate inventory by clicking the Inventory name under column “Name” (figure 62, a).
5. Press the “Reject” button (figure 62, b).
*** Note: A notification email will be sent to the PM, once the “Reject” button has been pressed. And the
status changed to “Awaiting_rejection_check” (figure 63).
| 37 | 37 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 39 10/02/2013
Figure 62. Work on Inventories screen –Reject - Status = check
Figure 63. Work on Inventories screen – Propose Rejection - Status = awaiting_rejection_check
| 38 | 38 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 40 10/02/2013
10.5 Approval or Rejection of an inventory (NFP)
This section describes how the NFP approves or rejects an inventory after being sent for approval by the PM
(See section 10.4).
10.5.1 Approval of an inventory
1. Log in as NFP.
2. Click on “View Inventories Progress” under sub menu “Submission Management”.
3. The “View Inventories Progress” screen appears.
4. Select the appropriate inventory by clicking t he Inventory name under column “Name” (figure 64).
5. Press the “Approve” button (figure 64, b).
Once the “Approve” button was pressed, the status of the selected inventory changes to “approved” (figure
65, b).
*** Note: A notification email will be sent to the PM that the inventory has been approved. Therefore, the PM
may proceed to selecting the tables for preparing the official submission (See section 10.6).
Figure 64. Work on Inventories screen – Approve an inventory - Status = awaiting_approval
Figure 65. Work on Inventories screen – Approve an inventory - Status = approved
| 39 | 39 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 41 10/02/2013
10.5.2 Rejection of an inventory
1. Log in as NFP.
2. Click on “View Inventories Progress” under sub menu “Submission Management”.
3. The “View Inventories Progress” screen appears.
4. Select the appropriate inventory by clicking t he Inventory name under column “Name” (figure 66).
5. Press the “Send for Reject ion” button (figure 66, b).
Once the “Send for Rejection” button was pressed, the status of the selected inventory changes to
“awaiting_rejection” (figure 67, a).
*** Note: A notification email will be sent to the PM that the inventory has been rejected. Therefore, the PM
will be able to reject the submission. Proceed to section 10.4.2.
Figure 66. Work on Inventories screen – Rejection of an inventory - Status = awaiting_approval
Figure 67. Work on Inventories screen – Rejection of an inventory - Status = rejected_approval
| 40 | 40 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 42 10/02/2013
10.6 Submit inventory (PM)
This section describes on how the PM submits the inventory by selecting tables for the general submission after
being approved by the NFP (See section 10.5).
10.6.1 Submit select tables for preparing the general submission
1. Log in as PM.
2. Click on “View Inventories Progress” under sub menu “Submission Management”.
3. The “View Inventories Progress” screen appears.
4. Select the appropriate inventory by clicking the box under column “Working inventory” (figure 68, a).
*** Note: The selected inventory year to be submitted should be in status “approved” (figure 68, b).
5. Click on “Work on Inventories” under Submission Management (figure 68, c).
This opens the Submit Inventory initial screen (figure 69).
6. Click the inventory year to be submitted (figure 69, a).
7. Press the “Generate Official S ubmission” button (figure 69, c).
Figure 68. View Inventories Progress screen – select inventory for the preparation for the general submission
Figure 69. Submit select tables for the preparation for the general submission
| 41 | 41 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 43 10/02/2013
Once the “Generate Official Submission” button has been pressed the “Submit Inventory” initial screen for selecting
the tables appears (figure 70).
8. Select or deselect by clicking the appropriate year(s) under “Inventory Years” box (figure 70, c) or the sector
grids under the “Table” box (figure 70, d) to generate the official submission.
9. Press the “Submit” button (figure 70, e). An offici al submission will be generated in the NAIIS system.
Figure 70. Submit – select tables and grids for the general submission
| 42 | 42 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 44 10/02/2013
Glossary of terms and abbreviations
AD – Activity Data
AWMS – Animal Waste Management System
BOD – Biochemical Oxygen Demand
C – Carbon
C2F6 – Hexafluoroethane
CF4 – Tetrafluoromethane
CH4 – Methane
CO – Carbon Monoxide
CO2 – Carbon dioxide
COD – Chemical Oxygen Demand
dm – dry matter
Gg – Gigagram
ha – hectare
HFC – Hydrofluorocarbon
hl – hectolitre
k – kilo
kg – kilogram
kha – kilo hectare
kt – kilotonne
LTO – Landing/Take Off
LUCF – Land-Use Change and Forestry
LULUCF – Land Use, Land-Use Change and Forestry
m3 – cubic meter
MCF – Methane Correction Factor
Mg – Megagram
Mha – Megahectare
MSW – Municipal Solid Waste
N – Nitrogen
N2O – Nitrous Oxide
NFP – National Focal Point
NH3 – Ammonia
NMVOC – Non-Methane Volatile Organic Compound
NOX – Nitrogen Dioxide
PFC – Perfluorocarbon
RA - Reference Approach
SE – Sectoral Expert
SF6 – Sulphur Hexafluoride
SO2 – Sulphur Dioxide
SWDS – Solid Waste Disposal Site
t – tonne
Tg – Teragram
TJ – Terajoules
XML – Extensible Markup Language
year t – inventory year
| 43 | 43 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 45 10/02/2013
Annex 1: Non‐Annex I (NAI) Parties
1 Afghanistan AFG
2 Albania ALB
3 Algeria DZA
4 Andorra AND
5 Angola AGO
6 Antigua and Barbuda ATG
7 Argentina ARG
8 Armenia ARM
9 Azerbaijan AZE
10 Bahamas BHS
11 Bahrain BHR
12 Bangladesh BGD
13 Barbados BRB
14 Belize BLZ
15 Benin BEN
16 Bhutan BTN
17 Bolivia BOL
18 Bosnia and Herzegovina BIH
19 Botswana BWA
20 Brazil BRA
21 Brunei Darussalam BRN
22 Burkina Faso BFA
23 Burundi BDI
24 Cambodia KHM
25 Cameroon CMR
26 Cape Verde CPV
27 Central African Republic CAF
28 Chad TCD
29 Chile CHL
30 China CHN
31 Colombia COL
32 Comoros COM
33 Congo COG
34 Cook Islands COK
35 Costa Rica CRI
36 Cote d’Ivoire CIV
37 Cuba CUB
38 Democratic People’s
Republic of Korea
PRK
39 Democratic Republic of the
Congo
COD
40 Djibouti DJI
41 Dominica DMA
42 Dominican Republic DOM
43 Ecuador ECU
44 Egypt EGY
45 El Salvador SLV
46 Equatorial Guinea GNQ
47 Eritrea ERI
48 Ethiopia ETH
49 Fiji FJI
50 Gabon GAB
51 Gambia GMB
52 Georgia GEO
53 Ghana GHA
54 Grenada GRD
55 Guatemala GTM
56 Guinea GIN
57 Guinea-Bissau GNB
58 Guyana GUY
59 Haiti HTI
60 Honduras HND
61 India IND
62 Indonesia IDN
63 Iran (Islamic Republic of) IRN
64 Iraq IRQ
65 Israel ISR
66 Jamaica JAM
67 Jordan JOR
68 Kazakhstan KAZ
69 Kenya KEN
70 Kiribati KIR
71 Kuwait KWT
72 Kyrgyzstan KGZ
73 Lao People's Democratic
Republic
LAO
74 Lebanon LBN
75 Lesotho LSO
76 Libya LBY
77 Liberia LBR
78 Madagascar MDG
79 Malawi MWI
80 Malaysia MYS
81 Maldives MDV
82 Mali MLI
83 Marshall Islands MHL | 44 | 44 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 46 10/02/2013
84 Mauritania MRT
85 Mauritius MUS
86 Mexico MEX
87 Micronesia (Federated
States of)
FSM
88 Mongolia MNG
89 Montenegro MNE
90 Morocco MAR
91 Mozambique MOZ
92 Myanmar MMR
93 Namibia NAM
94 Nauru NRU
95 Nepal NPL
96 Nicaragua NIC
97 Niger NER
98 Nigeria NGA
99 Niue NIU
100 Oman OMN
101 Pakistan PAK
102 Palau PLW
103 Panama PAN
104 Papua New Guinea PNG
105 Paraguay PRY
106 Peru PER
107 Philippines PHL
108 Qatar QAT
109 Republic of Korea KOR
110 Republic of Moldova MDA
111 Rwanda RWA
112 Saint Kitts and Nevis KNA
113 Saint Lucia LCA
114 Saint Vincent and the
Grenadines
VCT
115 Samoa WSM
116 San Marino SMR
117 Sao Tome and Principe STP
118 Saudi Arabia SAU
119 Senegal SEN
120 Serbia SRB
121 Seychelles SYC
122 Sierra Leone SLE
123 Singapore SGP
124 Solomon Islands SLB
125 Somalia SOM
126 South Africa ZAF
127 South Sudan SSD
128 Sri Lanka LKA
129 Sudan SDN
130 Suriname SUR
131 Swaziland SWZ
132 Syrian Arab Republic SYR
133 Tajikistan TJK
134 Thailand THA
135 The former Yugoslav
Republic of Macedonia
MKD
136 Timor-Leste TLS
137 Togo TGO
138 Tonga TON
139 Trinidad and Tobago TTO
140 Tunisia TUN
141 Turkmenistan TKM
142 Tuvalu TUV
143 Uganda UGA
144 United Arab Emirates ARE
145 United Republic of Tanzania TZA
146 Uruguay URY
147 Uzbekistan UZB
148 Vanuatu VUT
149 Venezuela VEN
150 Viet Nam VNM
151 Yemen YEM
152 Zambia ZMB
153 Zimbabwe ZWE
| 45 | 45 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 47 10/02/2013
Annex 2: Fuel categories
Liquid Fuels (Crude oil and petroleum products)
Crude oil
Orimulsion
Natural gas liquids
Gasoline
Motor Gasoline
Aviation Gasoline
Jet Gasoline
Jet kerosene
Other kerosene
Shale oil
Gas/Diesel oil
Residual fuel oil
Liquefied petroleum gas
Ethane
Naphtha
Bitumen
Lubricants
Petroleum coke
Refinery Feedstock
Other oil
Refinery gas
Paraffin waxes
White spirit
Heavy fuel - low
Heavy fuel - medium
Heavy fuel - high
Light fuel oil/diesel - low
Light fuel oil/diesel - medium
Light fuel oil/diesel - high
Diesel (road)
Gasoline (road)
Solid Fuels (Coal and coal products)
Anthracite
Coking coal
Other bituminous coal
Sub-bituminous coal
Other sub-bituminous coal
Lignite/brown coal
Oil shale
Peat
Coke
Coke oven coke
Gas coke
Patent fuel
Coke
Coke oven coke
Gas coke
BKB/Patent Fuel
Patent Fuel
Brown coal briquettes
Gas works gas
Coke oven gas
Blast furnace gas
Other gases and mixtures from coal-derived carbon
Coal - low
Coal - medium
Coal - high
Gaseous Fuels
Natural gas
Other Fuels
Municipal solid waste
Industrial waste
Fuel mixtures (fossil and biomass)
Waste gas
Other wastes
Hydrogen
Biomass
Solid
Wood/Wood waste
Agricultural waste
Charcoal
Other solid biomass
Liquid
Bio-alcohol
Sulphur lies (Black liquor)
Sewage sludge
Other liquid biomass
Gas
Landfill gas
Sludge gas (sewage gas)
Other biogas | 46 | 46 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 48 07/08/2013
Annex 3: Global Warming Potentials (GWPs)
Greenhouse gas Chemical formula 1995 IPCC GWP
Carbon dioxide CO 2 1
Methane CH 4 21
Nitrous oxide N 2O 310
HFC-23 CHF 3 11,700
HFC-32 CH 2F2 650
HFC-41 CH 3F 150
HFC-43-10mee C 5H2F10 1,300
HFC-125 C 2HF5 2,800
HFC-134 C 2H2F4 1,000
HFC-134a CH 2FCF3 1,300
HFC-152a C 2H4F2 140
HFC-143 C 2H3F3 300
HFC-143a CF 3CH3 3,800
HFC-227ea C 3HF7 2,900
HFC-236fa C 3H2F6 6,300
HFC-254ca C 3H3F5 560
Perfluoromethane CF 4 6,500
Perfluroethane C 2F6 9,200
Perfluoropropape C 3F8 7,000
Perfluorobutane C 2F10 7,000
Perfluorocyclobutane c-c 4F8 8,700
Perfluoropentane C 5F12 7,500
Perfluorohexane C 6F14 7,400
Sulphur hexafluoride SF 6 23,900
Source: Climate Change 1995, The Science of Climate Change: Summary for Policymakers and Technical
Summary of the Working Group I Report, page 22.
| 47 | 47 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 49 07/08/2013
Annex 4: Default values
1. Fraction of carbon stored for reference approach
Bitumen – 1
Coal oils and tars (from coking coal – 0.75
Ethane – 0.8
Gas/Diesel oil – 0.5
LPG – 0.8
Lubricants – 0.5
Naphtha – 0.8
Natural gas – 0.33
2. Conversion factors
a. CH 4 volume CH4 Gg = 0.67
b. Conversion factors for energy
From To Multiply by
J TJ 10 -12
KJ TJ 10 -9
MJ TJ 10 -6
GJ TJ 10 -3
TJ TJ 1
cal TJ 4.1868 x 10 -12
kcal TJ 4.1868 x 10 -9
Mcal TJ 4.1868 x 10 -6
Gcal TJ 4.1868 x 10 -3
Tcal TJ 4.1868
kWh TJ 3.6 x 10 -6
MWh TJ 3.6 x 10 -3
GWh TJ 3.6
Btu TJ 1.0551 x 10 -9
kBtu TJ 1.0551 x 10 -6
MBtu TJ 1.0551 x 10 -3
GBtu TJ 1.0551
toe TJ 41.868 x 10 -3
ktoe TJ 41.868
Mtoe TJ 4.1868 x 10 4
TJ J 10 12
TJ KJ 10 9
TJ MJ 10 6
TJ GJ 10 3
TJ cal 238.8 x 10 9
TJ kcal 238.8 x 10 6
TJ Mcal 238.8 x 10 3
TJ Gcal 238.8
TJ Tcal 238.8 x 10 -3
TJ kWh 277.8 x 10 3
TJ MWh 277.8
TJ GWh 277.8 x 10 -3
TJ Btu 947.8 x 10 6
TJ kBtu 947.8 x 10 3
TJ MBtu 947.8
TJ GBtu 947.8 x 10 -3
TJ toe 23.88
TJ ktoe 23.88 x x 10 -3
TJ Mtoe 23.88 x 10 -6 | 48 | 48 | maiis-user-manual.pdf |
NAIIS-User-Manual.Docx Page 50 07/08/2013
3. Emission factors
a. Ozone precursors and SO2 from oil refining – Crude oil throughput
NOx = 0.06
CO = 0.09
NMVOC = 0.62
SO2 = 0.93
b. Ozone precursors and SO2 from oil refining – Catalytic cracker throughput
NOx = 0.2
CO = 42.6
NMVOC = 0.6
SO2 = 1.5
c. NMVOC emissions from storage and handling – Crude oil throughput
Secondary seals = 0.2
Primary seals = 0.7
Fixed Roof = 4.9
d. SO 2 from Sulphur Recovery Plants – 139 kg/t
4. CKD correction factor = 1.02
5. Methane Correction Factor (MCF)
Managed — 1.0
Unmanaged – deep (>= 5m) — 0.8
Unmanaged – shallow (< 5m) — 0.4
Methane Correction Factor — 0.6
6. Inventory time period (for Cropland remaining Cropland – Carbon stock change – Mineral soils) =
20 years
| 49 | 49 | maiis-user-manual.pdf |
See discussions, stats, and author profiles for this publication at: https://www.researchgate.net/publication/351037551
A Practical Guide to Building OWL Ontologies Using Protégé 5.5 and Plugins
Preprint · April 2021
CITATIONS
0
READS
36,030
1 author:
Michael Debellis
21 PUBLICATIONS 194 CITATIONS
SEE PROFILE
All content following this page was uploaded by Michael Debellis on 21 April 2021.
The user has requested enhancement of the downloaded file. | 0 | 0 | Protege5NewOWLPizzaTutorialV3.pdf |
1
A Practical Guide to Building OWL Ontologies
Using Protégé 5.5 and Plugins
Edition 3.0
8 April 2021
Michael DeBellis
This is a revised version of the Protégé 4 Tutorial version 1.3 by Matthew Horridge. Previous versions of
the tutorial were developed by Holger Knublauch , Alan Rector , Robert Stevens, Chris Wroe, Simon
Jupp, Georgina Moulton, Nick Drummond, and Sebastian Brandt.
This work was conducted using the Protégé resource, which is supported by grant GM10331601 from the
National Institute of General Medical Sciences of the United States National Institutes of Health.
Chapters 3-5 are based on the original tutorial. I have updated the tutorial to be consistent with Protégé 5.
I have also made some changes to address some of the most common issues I’ve seen new users grapple
with, to remove some of the dated information about older frame-based versions of Protégé, and various
miscellaneous changes. Chapters 6-11 are new. I have added new sections for technologies such as
SWRL, SPARQL and SHACL as well as some details on concepts such as IRIs and namespaces.
Thanks to Matthew Horridge and everyone who worked on the previous tutorials. Special thanks to
Lorenz Buehmann who helped me work out a thorny problem as I developed the revised example, to
André Wolski for help with the SHACL plugin. Special thanks to Dick Ooms and Colin Pilkington for
their excellent detailed feedback on previous versions of the tutorial. Also, thanks to everyone on the
Protégé user support email list.
Note: this document may get updates frequently. It is a good idea to check my blog at:
https://www.michaeldebellis.com/post/new-protege-pizza-tutorial to make sure you have the latest
version.
If you have questions or comments feel free to contact me at [email protected]
| 1 | 1 | Protege5NewOWLPizzaTutorialV3.pdf |
2
Contents
Chapter 1 Introduction .................................................................................................................................. 4
1.1 Licensing ............................................................................................................................................. 4
1.2 Conventions ........................................................................................................................................ 4
Chapter 2 Requirements and the Protégé User Interface .............................................................................. 6
Chapter 3 What are OWL Ontologies? ......................................................................................................... 6
3.1 Components of OWL Ontologies ....................................................................................................... 6
3.1.1 Individuals........................................................................................................................................ 7
3.1.2 Properties ......................................................................................................................................... 8
3.1.3 Classes.............................................................................................................................................. 8
Chapter 4 Building an OWL Ontology ....................................................................................................... 10
4.1 Named Classes .................................................................................................................................. 13
4.2 Using a Reasoner .............................................................................................................................. 15
4.4 Using Create Class Hierarchy ........................................................................................................... 17
4.5 Create a PizzaTopping Hierarchy ..................................................................................................... 19
4.6 OWL Properties ................................................................................................................................ 22
4.7 Inverse Properties .............................................................................................................................. 23
4.8 OWL Object Property Characteristics .............................................................................................. 24
4.8.1 Functional Properties ................................................................................................................. 24
4.8.2 Inverse Functional Properties ..................................................................................................... 25
4.8.3 Transitive Properties .................................................................................................................. 25
4.8.4 Symmetric and Asymmetric Properties ..................................................................................... 25
4.8.5 Reflexive and Irreflexive Properties .......................................................................................... 26
4.8.6 Reasoners Automatically Enforce Property Characteristics ...................................................... 26
4.9 OWL Property Domains and Ranges ................................................................................................ 26
4.10 Describing and Defining Classes .................................................................................................... 29
4.10.1 Property restrictions ................................................................................................................. 29
4.10.2 Existential Restrictions ............................................................................................................ 31
4.10.3 Creating Subclasses of Pizza .................................................................................................... 33
4.10.4 Detecting a Class that can’t Have Members ............................................................................ 37
4.11 Primitive and Defined Classes (Necessary and Sufficient Axioms) ............................................... 38
4.12 Universal Restrictions ..................................................................................................................... 41
4.13 Automated Classification and Open World Reasoning .................................................................. 42 | 2 | 2 | Protege5NewOWLPizzaTutorialV3.pdf |
3
4.14 Defining an Enumerated Class ........................................................................................................ 44
4.15 Adding Spiciness as a Property ....................................................................................................... 45
4.16 Cardinality Restrictions .................................................................................................................. 46
Chapter 5 Datatype Properties .................................................................................................................... 48
5.1 Defining a Data Property .................................................................................................................. 48
5.2 Customizing the Protégé User Interface ........................................................................................... 50
Chapter 6 Adding Order to an Enumerated Class ....................................................................................... 58
Chapter 7 Names: IRI’s, Labels, and Namespaces ..................................................................................... 60
Chapter 8 A Larger Ontology with some Individuals ................................................................................. 62
8.1 Get Familiar with the Larger Ontology ............................................................................................. 63
Chapter 9 Queries: Description Logic and SPARQL ................................................................................. 66
9.1 Description Logic Queries ................................................................................................................ 66
9.2 SPARQL Queries .............................................................................................................................. 67
9.21 Some SPARQL Pizza Queries ........................................................................................................ 67
9.22 SPARQL and IRI Names ................................................................................................................ 70
Chapter 10 SWRL and SQWRL ................................................................................................................. 72
Chapter 11 SHACL ..................................................................................................................................... 76
11.1 OWA and Monotonic Reasoning .................................................................................................... 76
11.2 The Real World is Messy ................................................................................................................ 76
11.3 Basic SHACL Concepts .................................................................................................................. 77
11.4 The Protégé SHACL Plug-In .......................................................................................................... 77
Chapter 12 Web Protégé ............................................................................................................................. 83
Chapter 13 Conclusion: Some Personal Thoughts and Opinions ............................................................... 88
Chapter 14 Bibliography ............................................................................................................................. 89
14.1 W3C Documents ............................................................................................................................. 89
14.2 Web Sites, Tools, And Presentations. ............................................................................................. 89
14.3 Papers .............................................................................................................................................. 89
14.4 Books .............................................................................................................................................. 90
14.5 Vendors ........................................................................................................................................... 90
| 3 | 3 | Protege5NewOWLPizzaTutorialV3.pdf |
4
Chapter 1 Introduction
This introduces Protégé 5 for creating OWL ontologies as well as various plugins. If you have questions
specific to this tutorial, please feel free to email me directly: [email protected] However, if you
have general questions about Protégé, OWL, or plugins you should subscribe to and send an email to the
User Support for Protégé and Web Protégé email list. This list has many people (including me) who
monitor it and can contribute their knowledge to help you understand how to get the most out of this
technology. To subscribe to the list, go to: https://protege.stanford.edu/support.php and click on the first
orange Subscribe button. That will enable you to subscribe to the list and give you the email to send
questions to.
This chapter covers licensing and describes conventions used in the tutorial. Chapter 2 covers the
requirements for the tutorial and describes the Protégé user interface. Chapter 3 gives a brief overview of
the OWL ontology language. Chapter 4 focuses on building an OWL ontology with classes and object
properties. Chapter 4 also describes using a Description Logic Reasoner to check the consistency of the
ontology and automatically compute the ontology class hierarchy.
Chapter 5 describes data properties. Chapter 6 describes design patterns and shows one design pattern:
adding an order to an enumerated class. Chapter 7 describes the various concepts related to the name of
an OWL entity.
Chapter 8 introduces an extended version of the Pizza tutorial developed in chapters 1-7. This ontology
has a small number of instances and property values already created which can be used to illustrate the
tools in the later chapters for writing rules, doing queries, and defining constraints.
Chapter 9 describes two tools for doing queries: Description Logic queries and SPARQL queries. Chapter
10 introduces the Semantic Web Rule Language (SWRL) and walks you through creating SWRL and
SQWRL rules. Chapter 11 introduces the Shapes Constraint Language (SHACL) and discusses the
difference between defining logical axioms in Description Logic and data integrity constraints in
SHACL. Chapter 12 has some concluding thoughts and opinions and Chapter 13 provides a bibliography.
1.1 Licensing
This document is freely available under the Creative Commons Attribution-ShareAlike 4.0 International
Public License. I typically distribute it as a PDF but if you want to make your own version send me an
email and I will send you the Word version. For details on licensing see:
https://creativecommons.org/licenses/by-sa/4.0/legalcode
1.2 Conventions
Class, property, rule, and individual names are written in Consolas font like this. The term used for
any such construct in Protégé and in this document is an Entity. Individuals and classes can also be
referred to as objects.
Names for user interface tabs, views, menu selections, buttons, and text entry are highlighted like this.
Any time you see highlighted text such as File>Preferences or OK or PizzaTopping it refers to something
that you should or optionally could view or enter into the user interface. If you ever aren’t sure what to
do to accomplish some task look for the highlighted text. Often, as with PizzaTopping the text you
enter into a field in the Protégé UI will be the name of a class, property, etc. In those cases, where the | 4 | 4 | Protege5NewOWLPizzaTutorialV3.pdf |
5
name is meant to be entered into a field it will only be highlighted rather than highlighted and printed in
Consolas font.
Menu options are shown with the name of the top-level menu, followed by a > followed by the next level
down to the desired selection. For example, to indicate how to open the Individuals by class tab under the
Tabs section in the Window menu the following text would be used: Window>Tabs> Individuals by
class.
When a word or phrase is emphasized, it is shown in italics like this.
Exercises are presented like this:
Exercise 1: Accomplish this
_____________________________________________________________________________________
1. Do this.
2. Then do this.
3. Then do this.
_____________________________________________________________________________________
Potential pitfalls and warnings are presented like this.
Tips and suggestions related to using Protégé are presented like this.
Explanations as to what things mean are presented like this.
General notes are presented like this.
Vocabulary explanations and alternative names are presented like this.
| 5 | 5 | Protege5NewOWLPizzaTutorialV3.pdf |
6
Chapter 2 Requirements and the Protégé User Interface
In order to follow this tutorial, you must have Protégé 5, which is available from the Protégé website,1
and some of the Protégé Plugins which will be described in more detail below. For now, just make sure
you have the latest version of Protégé. At the time this is being written the latest version is 5.5 although
the tutorial should work for later versions as well.
The Protégé user interface is divided up into a set of major tabs. These tabs can be seen in the
Window>Tabs option. This option shows all the UI tabs that are currently loaded into the Protégé
environment. Any tabs that are currently opened have a check mark next to them. To see a tab that is not
visible just select it from the menu and it will be added to the top with the other major tabs and its menu
item will now be checked. You can add additional major tabs to your environment by loading plugins. For
example, when we load the SHACL4Protégé plugin the SHACLEditor will be added to the menu.
Each major tab consists of various panes or as Protégé calls them views. Each view can be resized or
closed using the icons in the top right corner of every view. The views can also be nested as sub-tabs
within each major tab. When there could potentially be confusion between a tab that is a screen all its own
(is under the Window>Tabs option) and a view that is a sub-tab we will call the screen tab a major tab.
There are many views that are not in the default version of Protégé that can be added via the
Window>Views option. The additional views are divided into various categories such as
Window>Views>Individual views. Section 5.2 will show an example of adding a new view to a major
tab.
Chapter 3 What are OWL Ontologies?
Ontologies are used to capture knowledge about some domain of interest. An ontology describes the
concepts in the domain and also the relationships that hold between those concepts. Different ontology
languages provide different facilities. The most recent development in standard ontology languages is
OWL from the World Wide Web Consortium (W3C). A good primer on the basic concepts of OWL can
be found at: https://www.w3.org/TR/owl2-primer/
OWL makes it possible to describe concepts in an unambiguous manner based on set theory and logic.
Complex concepts can be built up out of simpler concepts. The logical model allows the use of a reasoner
which can check whether all of the statements and definitions in the ontology are mutually consistent and
can also recognize which concepts fit under which definitions. The reasoner can therefore help to
maintain the hierarchy correctly. This is particularly useful when dealing with cases where classes can
have more than one parent. The reasoner can also infer additional information. For example, if two
properties are inverses only one value needs to be asserted by the user and the inverse value will be
automatically inferred by the reasoner.
3.1 Components of OWL Ontologies
An OWL ontology consists of Classes, Properties, and Individuals. OWL ontologies are an
implementation of Description Logic (DL) which is a decidable subset of First Order Logic. A class in
OWL is a set, a property is a binary relation, and an individual is an element of a set. Other concepts from
set theory are also implemented in OWL such as Disjoint sets, the Empty set (owl:Nothing), inverse
1 http://protege.stanford.edu | 6 | 6 | Protege5NewOWLPizzaTutorialV3.pdf |
7
relations, transitive relations, and many more. An understanding of the basic concepts of set theory will
help the user get the most out of OWL but is not required. One of the benefits of Protégé is that it presents
an intuitive GUI that enables domain experts to define models without a background in set theory.
However, developers are encouraged to refresh their knowledge on logic and set theory. A good source is
the first 3 chapters in Elements of the Theory of Computation by Lewis and Papadamitrious. Another
good source is the PDF document Overview of Set Theory available at:
https://www.michaeldebellis.com/post/owl-theoretical-basics
3.1.1 Individuals
Individuals represent objects in the domain of interest. An important difference between OWL and most
programming and knowledge representation languages is that OWL does not use the Unique Name
Assumption (UNA). This means that two different names could actually refer to the same individual. For
example, “Queen Elizabeth”, “The Queen” and “Elizabeth Windsor” might all refer to the same
individual. In OWL, it must be explicitly stated that individuals are the same as each other, or different
from each other. Figure 3.1 shows a representation of some individuals in a domain of people, nations,
and relations — in this tutorial we represent individuals as diamonds.
Figure 3.1: Representation of Individuals
Michael
Jenna
Diane
Tim
USA
India
Italy
Individuals are also known as instances. Individuals can be referred to as instances of classes.
Figure 3.2: Representation of Properties
Michael
Biswanath
livesIn
India
hasFriend | 7 | 7 | Protege5NewOWLPizzaTutorialV3.pdf |
8
3.1.2 Properties
Properties are binary relations between individuals. I.e., properties link two individuals together. For
example, the property hasFriend might link the individual Biswanath to the individual Michael, or
the property hasChild might link the individual Michael to the individual Oriana. Properties can have
inverses. For example, the inverse of hasChild is hasParent. Properties can be limited to having a
single value – i.e., to being functional. They can also be transitive or symmetric. These property
characteristics are explained in detail in Section 4.8. Figure 3.2 shows a representation of some properties.
3.1.3 Classes
OWL classes are sets that contain individuals. They are described using formal (mathematical)
descriptions that rigorously define the requirements for membership of the class. For example, the class
Cat would contain all the individuals that are cats in our domain of interest.2 Classes may be organized
into a superclass-subclass hierarchy, which is also known as a taxonomy. However, taxonomies are often
trees. I.e., each node has only one parent node. Class hierarchies in OWL are not restricted to be trees and
multiple inheritance can be a powerful tool to represent data in an intuitive manner.
Subclasses specialize (aka are subsumed by) their superclasses. For example, consider the classes Animal
and Dog – Dog might be a subclass of Animal (so Animal is the superclass of Dog). This says that All
dogs are animals, All members of the class Dog are members of the class Animal. OWL and Protégé
2 Individuals can belong to more than one class and classes can have more than one superclass. Unlike OOP where
multiple inheritance is typically unavailable or discouraged it is common in OWL.
Properties are similar to properties in Object-Oriented Programming (OOP). However, there are
important differences between properties in OWL and OOP. The most important difference is that OWL
properties are first class entities that exist independent of classes. OOP developers are encouraged to
read: https://www.w3.org/2001/sw/BestPractices/SE/ODSD/
Michael
Oriana
hasChild
Person
Country
USA
Italy
India
livesIn
Buddy
Rover
Dog
hasPet
Figure 3.3: Representation of Classes containing Individuals | 8 | 8 | Protege5NewOWLPizzaTutorialV3.pdf |
9
provide a language that is called Description Logic or DL for short. One of the key features of DL is that
these superclass-subclass relationships (aka subsumption relationships) can be computed automatically by
a reasoner – more on this later. Figure 3.3 shows a representation of some classes containing individuals –
classes are represented as ovals, like sets in Venn diagrams.
In OWL classes can be built up of descriptions that specify the conditions that must be satisfied by an
individual for it to be a member of the class. How to formulate these descriptions will be explained as the
tutorial progresses.
| 9 | 9 | Protege5NewOWLPizzaTutorialV3.pdf |
10
Chapter 4 Building an OWL Ontology
This chapter describes how to create an ontology of Pizzas. We use Pizzas because it is something almost
everyone is familiar with.
Exercise 1: Create a new OWL Ontology
_____________________________________________________________________________________
1. Start Protégé. When Protégé opens for the first time each day it puts up a screen of all the available
plugins. You can also bring this up at any time by using File>Check for plugins. You won’t need any
plugins at this point of the tutorial so just click the Not now button.
2. The Protégé user-interface consists of several tabs such as Active ontology, Entities, etc. When you
start Protégé you should be in the Active Ontology tab. This is for overview information about the entire
ontology. Protégé always opens with a new untitled ontology you can start with. Your ontology should
have an IRI something like: http://www.semanticweb.org/yourname/ontologies/2020/4/untitled-ontology-
27 Edit the name of the ontology (the part after the last “/” in this case untitled-ontology-27) and change it
to something like PizzaTutorial. Note: the Pizza ontology IRIs shown below (e.g., figure 4.3) show the
IRI after I edited the default that Protégé generated for me. Your IRI will look different and will be based
on your name or the name of your organization.
3. Now you want to save your new ontology. Select File>Save. This should bring up a window that says:
Choose a format to use when saving the ‘PizzaTutorial’ ontology. There is a drop down menu of formats
to use. The default RDF/XML Syntax should be selected by clicking the OK button. This should bring up
the standard dialog your operating system uses for saving files. Navigate to the folder you want to use and
then type in the file name, something like Pizza Tutorial and select Save.
____________________________________________________________________________________
The next step is to set some preferences related to the names of new entities. Remember than in Protégé
any class, individual, object property, data property, annotation property, or rule is referred to as an entity.
The term name in OWL can actually refer to two different concepts. It can be the last part of the IRI3 or it
can refer to the annotation property (usually rdfs:label) used to provide a more user friendly name for
the entity. We will discuss this in more detail below in chapter 7. For now, we just want to set the
parameters correctly so that future parts of the tutorial (especially the section on SPARQL queries) will
work appropriately.
3 An IRI is similar to a URL. This will be discussed in detail below in chapter 7.
As with any file you work on it is a good idea to save your work at regular intervals so that if
something goes wrong you don’t lose your work. At certain points in the tutorial where saving
is especially important the tutorial will prompt you to do so but it is a good idea to save your
work often, not just when prompted.
| 10 | 10 | Protege5NewOWLPizzaTutorialV3.pdf |
11
Exercise 2: Set the Preferences for New Entities and Rendering
_____________________________________________________________________________________
1. Go to File>Preferences in Protégé. This will bring up a new window with lots and lots of different tabs.
Click on the New entities tab. This will bring up a tab that looks similar to figure 4.1. The top part of that
tab is a box labeled Entity IRI. It should be set with the parameters as shown in figure 4.1. I.e., Starts
with Active ontology IRI. Followed by #. Ends with User supplied name. If the last parameter is set to
Auto-generated name change it to User supplied name. That is the parameter most likely to be different
but also check the other two as well.
2. Now select the Renderer tab. It should look like figure 4.2. Most importantly, check that Entity
rendering is set to Render by entity IRI short name (ID) rather than Render by annotation property. Don’t
worry if this doesn’t completely make sense at this point. The issues here are a bit complex and subtle so
we defer them until after you have an understanding of the basic concepts of what an OWL ontology is.
We will have a discussion of these details below in chapter 7. For now you just need to make sure that the
preferences are set appropriately to work with the rest of the tutorial.
____________________________________________________________________________________
Figure 4.1: The New entities tab
| 11 | 11 | Protege5NewOWLPizzaTutorialV3.pdf |
12
Figure 4.2 Renderer tab
Figure 4.3: The Active Ontology Tab with a New Comment
| 12 | 12 | Protege5NewOWLPizzaTutorialV3.pdf |
13
Exercise 3: Add a Comment Annotation to Your Ontology
_____________________________________________________________________________________
1. Make sure you are in the Active Ontology tab. In the view just below the Ontology IRI and Ontology
Version IRI fields find the Annotations option and click on the + sign. This will bring up a menu to create
a new annotation on the ontology.
2. The rdfs:comment annotation should be highlighted by default. If it isn’t highlighted click on it. Then
type a new comment into the view to the right. Something like A tutorial ontology for the Pizza domain.
3. Click OK. Your Active Ontology tab should like Figure 4.3.
_____________________________________________________________________________________
Figure 4.4: The Class Hierarchy View Options
4.1 Named Classes
The main building blocks of an OWL ontology are classes. In Protégé 5, editing of classes can be done in
the Entities tab. The Entities tab has a number of sub-tabs. When you select it, the default should be the
Class hierarchy view as shown in Figure 4.5.4 All empty ontologies contains one class called owl:Thing.
OWL classes are sets of individuals. The class owl:Thing is the class that represents the set containing
all individuals. Because of this all classes are subclasses of owl:Thing.
4 Each of the sub-tabs in the Entities tab also exists as its own major tab. In the tutorial we will refer to tabs like the
Class hierarchy tab or Object properties tab and it is up to the user whether to access them from the Entities tab or
to create them as independent tabs.
Add Subclass
Add Sibling Class
Delete Class | 13 | 13 | Protege5NewOWLPizzaTutorialV3.pdf |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.