Global

Members

(constant) addContentSuccess

Send the contents from the loadContents request to the reducer

Source:

(constant) addEventsSuccess

The events that are loaded after an successfull addEvent request and sent to the reducer

Source:

(constant) categories

Categories reducer - Main categories for the knowledge platform

Source:

(constant) changeLanguage

Change the language of the web portal

Source:

(constant) changeUserDetailsSuccess

Changing the user details was successfull

Source:

(constant) compareData

Compare the layers that exist in the metadata table with the ones that are on the geoserver to decide if layer is added or removed from the web gis

Source:

(constant) contacts

Contacts reducer (local contacts on the landing pages)

Source:

(constant) content

Reducer for the contents of the knowledge platform

Source:

(constant) cookies

Initialize the use of cookies to get the token for authorization

Source:

(constant) cookies

Initialize the cookies to get the token for authorization

Source:

(constant) cookies

Initialize the cookies to get the token for authorization

Source:

(constant) cookies

Initialize the cookies to get the token for authorization

Source:

(constant) countries

Reducer for the countries that a user can select in the yellow pages section

Source:

(constant) dataRequest

A data request

Source:

(constant) dataRequestError

A data request returned an error

Source:

(constant) dataRequestSuccess

A data request was successfull and the data is dispatched to the reducer

Source:

(constant) events

Events reducer

Source:

(constant) examples

Redcuer for the case studies

Source:

(constant) explanatorynotes

Reducer for the explanatory notes

Source:

(constant) extractValueFromQuery

Extract the value from a location query, the response can be different so we need this helper function

Source:

(constant) featureRequest

This function creates the link that is needed to get the values for a location query or a report. This link is sent to the backend

Source:

(constant) fetching

Reducer for requests to the backend (data fetching, form submitting)

Source:

(constant) filter

Reducer for the filters of the knowledge platform

Source:

(constant) formRequest

A form request

Source:

(constant) formRequestError

A failed form request is send to the reducer

Source:

(constant) formRequestFinished

A finished form request is dispatched to the fetching reducer

Source:

(constant) formRequestSuccess

A form request was successfull

Source:

(constant) geocodeError

An error occured during the geocoding proccess

Source:

(constant) geocodeSuccess

Geocoding was successfull, send data to the reducer

Source:

(constant) getActiveLayers

Get active layers based on the given ones

Source:

(constant) getLayers

Order the layers that were received from the backend to the menu structure

Source:

(constant) getLayersSuccess

Request to get all layers was successfull, data is sent to the reducer

Source:

(constant) glossary

Glossary reducer

Source:

(constant) language

Language reducer

Source:

Reducer for the international links section

Source:

(constant) loadContentSuccess

Send the request response data containing the knowledge repository content to the reducer

Source:

(constant) loadEventsSuccess

The response of the getEvents request thats sent to the reducer

Source:

(constant) loadExamplesSuccess

Send the case studies after the load request to the dispatcher

Source:

(constant) loadGlossarySuccess

The glossary data was loaded successfully and is sent to the reducer

Source:

(constant) loadLinksSuccess

Links were loaded successfully and are sent to the reducer

Source:

(constant) loadLocalContactsSuccess

Send the local contacts from the successfull request to the contacts reducer

Source:

(constant) loadMeasurementsSuccess

Field measurements were loaded successfully

Source:

(constant) loadNotesSuccess

Send the explanatory notes to the reducer

Source:

(constant) loadPagesSuccess

Loaded the pages successfully

Source:

(constant) loadPilotareasSuccess

Pilot areas were loaded successfully

Source:

(constant) loadProfessionalgroupsSuccess

The professional groups were loaded

Source:

(constant) loadSiteContentSuccess

Loading the content of the landing pages was successfull, return data to reducer

Source:

(constant) loadSuperuserDataSuccess

Loading the admin data was successfull

Source:

(constant) loadTagsSuccess

Loading the tags was successfull, return tags to the reducer

Source:

(constant) loadThematicCoveragesSuccess

Loading the thematic coverages was successfull

Source:

(constant) loadUnitsSuccess

Units were loaded successfully

Source:

(constant) loadUserprofilesSuccess

The userprofiles were loaded

Source:

(constant) localcontacts

Contacts reducer (local contacts on the landing pages)

Source:

(constant) measurements

Reducer for the field measurements

Source:

(constant) pages

Reducer for the pages (landingpages)

Source:

(constant) pilotareas

Reducer for the pilot areas

Source:

(constant) prepareReport

Send a request to the reducer to empty the report data

Source:

(constant) professionalgroups

Reducer for the occupations that user can choose from for the yellow pages section

Source:

(constant) query

Location query reducer

Source:

(constant) queryRequest

A query request for the given coordinates was started

Source:

(constant) queryRequestSuccess

Location query request was successfull

Source:

(constant) removeUserSuccess

Send the response of the remove user request to the user reducer

Source:

(constant) report

Report reducer

Source:

(constant) reportQuerySuccess

Report query was successfull, send report data to the reducer

Source:

(constant) reverseGeocodeFail

An error occured during the reverse geocoding

Source:

(constant) reverseGeocodeSuccess

Reverse geocoding was successfull

Source:

(constant) signinSuccess

If a signin war successfull, send the signed in user to the reducer via this action

Source:

(constant) signOut

Signout of the knowledge platform

Source:

(constant) signupSuccess

Signup was successfull

Source:

(constant) sitecontent

Reducer for the contents of the landingpages

Source:

(constant) superuser

Reducer for the admin stuff (is always empty except user is admin)

Source:

(constant) tags

Tags reducer

Source:

(constant) tagSearch

Search content of the knowledge repository based on tags

Source:

(constant) topics

Reducer for the thematic coverages of the knowledge repository

Source:

(constant) units

Reducer for the units that are displayed in the virtual boreholes (needed for their legend)

Source:

(constant) updateEventsFilter

Update the filters on the events page

Source:

(constant) updateFilter

Update the filters on the knowledge repository

Source:

(constant) updateMapProps

Update the map props

Source:

(constant) updateUserprofileSuccess

Userprofile was updated

Source:

(constant) updateYellowPagesFilter

Update the filters on the yellow pages

Source:

(constant) user

User reducer

Source:

(constant) userprofiles

Userprofiles reducer

Source:

(constant) virtualBoreholeSuccess

The virtual borehole request was successfull

Source:

(constant) webgis

Reducer for the web gis state

Source:

Methods

addContent(id, title, year, author, publisher_place, territorial_coverage, language, synopsis, link, topics, tags, internal_id, external_link, token)

Send the request to the backend to save content of the knowledge repository

Parameters:
Name Type Description
id

If an entry is edited, the ID of the according entry

title

The title of the entry

year

The publication year

author

The author of the document that is linked / uploaded

publisher_place

The location of the publisher

territorial_coverage

The territorial coverage of the content

language

The language of the content

synopsis

A short summary of the content

link

Link to download the article / publication if possible

topics

The thematic coverages of the entry

tags

The tags of the article

internal_id
external_link

External link to full document

token
Source:

addEvent(id, name, organized_by, contact, contact_email, date1, date2, location, country, website, token)

The request to save an event on the knowledge platform

Parameters:
Name Type Description
id

If an event is edited, the ID of the according event

name

The name of the event

organized_by

Organizer of the event

contact

Contact person for the event

contact_email

Contact person email

date1

Start date

date2

End date

location

Location

country

Country

website

Website of the event

token

JWT token

Source:

addGlossary(id, keyword, keyword_de, keyword_pl, keyword_cz, keyword_sk, keyword_sl, synonyms, synonyms_de, synonyms_pl, synonyms_cz, synonyms_sk, synonyms_sl, link, definition, definition_de, definition_cz, definition_pl, definition_sl, definition_sk, basic, token)

Save a glossary entry

Parameters:
Name Type Description
id

If given, edit the entry with the given ID

keyword

Keyword that should be explained

keyword_de
keyword_pl
keyword_cz
keyword_sk
keyword_sl
synonyms

Synonyms of the keyword

synonyms_de
synonyms_pl
synonyms_cz
synonyms_sk
synonyms_sl
link

Link for more explanation

definition

Definition of the keyword

definition_de
definition_cz
definition_pl
definition_sl
definition_sk
basic

Should be displayed in basic glossary

token

JWT token

Source:

addLayers(area, token, layers)

Request to add layers to the web GIS for a given pilot area

Parameters:
Name Type Description
area

The given pilot area

token

The JWT token

layers

The layers that should be added

Source:

changePassword(token, email, password)

Reset the password request to the backend

Parameters:
Name Type Description
token

The "forgot password token"

email

The email of the account for which the password should be changed

password

The new password

Source:

changeUserDetailsSuperuser(id, username, email, confirmed, projectpartner, deactivated, token)

Change specifc user details that only an admin can change

Parameters:
Name Type Description
id

ID of the user

username

Username

email

Email

confirmed

Confirmed

projectpartner

User is a project partner (gives upload rights for knowledge repository)

deactivated

User is deactivated

token

JWT token

Source:

checkIfLoggedIn(token)

Check if the user is logged in based on the token that is saved as a cookie

Parameters:
Name Type Description
token

The JWT token to check the authentification

Source:

confirmAccount(confirmationCode, email)

Send the request to the backend to confirm a user account after registration

Parameters:
Name Type Description
confirmationCode

The confirmation code

email

The email for which the confirmation code was generated

Source:

confirmPasswordReset(token, email)

Confirm that the password was forgotten (via link in email)

Parameters:
Name Type Description
token

The "forgot password token" that was generated when the forgot password request was done

email

The email of the account for which the password was forgotten

Source:

ExamplesList(props)

Component displays a list with all case studies on the web portal

Parameters:
Name Type Description
props
Source:

FieldMeasurementPopup(props)

The popup window for field measurement data

Parameters:
Name Type Description
props *
Source:

forgotPassword(email)

Send the request to the backend if a user forgot his/her password

Parameters:
Name Type Description
email

The email of the account for which the password was forgotten

Source:

generatePDF(headline, html, image, notes, exNotesHeadline)

Request to create a PDF file based on the active report

Parameters:
Name Type Description
headline

Report title

html

The report "html" from which the PDF is generated

image

The map image (base64)

notes

Explanatory notes

exNotesHeadline

Headline for explanatory notes

Source:

geocodeAddress(street, zip, city)

Request to nominatim to geocode a given address and get the coordinates

Parameters:
Name Type Description
street

Street of the address

zip

ZIP code of the address

city

City of the address

Source:

getAllData()

Send a request to the backend to get all needed data for the landingpage / knowledge platform

Source:

getContent()

Get the content (knowledge repository) from the backend

Source:

getEvents()

The request to the backend to load all events

Source:

getExamples()

Get all case studies from the backend

Source:

getGlossary()

Get all the glossary entries

Source:

getLayers(workspace, filter)

Get all the layers from the geoserver for a given pilot area

Parameters:
Name Type Description
workspace

The pilot area

filter
Source:

Load the links that are presented in the "International projects" section

Source:

getMeasurements(area)

Get all the field measurements for the given pilot area

Parameters:
Name Type Description
area

Pilot area

Source:

getPages()

Get all pages that are present on the web portal

Source:

getPilotareas()

Load all pilotareas that are present on the web portal

Source:

getProfessionalgroups()

Load all the professional groups that users can select in the yellow pages

Source:

getSiteContent()

Load the content of the landing pages

Source:

getTags()

Load all tags for the knowledge repository

Source:

getThematicCoverages()

Load the thematic coverages that contents on the knowledge repository can have

Source:

getUnits()

Get the units for the virtual boreholes

Source:

getUserprofiles()

Get the userprofiles for the yellow pages

Source:

InfoOverlay(props)

The overlay that appears on startup of the GIS with an infotext on how to create a report

Parameters:
Name Type Description
props *
Source:

loadSuperuserData(token)

Load the data that is specific to the admin

Parameters:
Name Type Description
token

JWT token

Source:

locationQuery(link, reportParams, layers, coords)

Send a location query request to the backend

Parameters:
Name Type Description
link

Link containing the geoserver params

reportParams

link containing the geoserver params for a full report at this location

layers

All layers for the active pilot area (used for the report query)

coords

Coordinates of the location query

Source:

readExcelFile(area, token, layers)

Request to read the metadata excel sheet (a step to copy data to the web gis)

Parameters:
Name Type Description
area

The active pilot area

token

The JWT token

layers

The layers that are currently online in the given pilot area

Source:

removeContact(id, token)

The request to the backend to remove a contact

Parameters:
Name Type Description
id

The ID of the contact that sould be removed

token

The JWT token

Source:

removeContent(id, token)

The request to the backend to remove content from the knowledge repository

Parameters:
Name Type Description
id

The ID of the content that should be deleted

token

The JWT token

Source:

removeContentSuperuser(id, token)

Remove content from the knowledge repository

Parameters:
Name Type Description
id

ID of the content

token

JWT token

Source:

removeEvent(id, token)

Request to the backend to remove an event

Parameters:
Name Type Description
id

ID of the event that should be removed

token

JWT token

Source:

removeEventSuperuser(id, token)

Remove an event from the knowledge platform

Parameters:
Name Type Description
id

ID of the event

token

JWT token

Source:

removeGlossary(id, token)

Remove an entry from the glossary

Parameters:
Name Type Description
id

ID of the entry that should be deleted

token

JWT token

Source:

removePage(id, token)

Remove a page from the web portal

Parameters:
Name Type Description
id

ID of the page that should be removed

token

JWT token

Source:

removeSiteContent(id, token)

Remove content from a landing page

Parameters:
Name Type Description
id

The ID of the content that should be removed

token
Source:

removeUnit(id, token)

Remove a unit

Parameters:
Name Type Description
id

ID of the unit

token

JWT token

Source:

removeUser(token)

Send the request to remove a user from the knowledeg platform to the backend

Parameters:
Name Type Description
token

The JWT token for authentification

Source:

reportQuery(link, layers, coords)

Send a report request for a specific location to the backend

Parameters:
Name Type Description
link

Link for the geoserver containing the needed params

layers

layers of the active pilot area

coords

coordinates of the request

Source:

reverseGeocode(coords)

Reverse geocoding (click on map -> coordiantes -> get the address based on the coordinates)

Parameters:
Name Type Description
coords

The requested coordinates

Source:

saveExample(id, pilotarea_id, title, address_of_project, gps_coordinates, usage_form, heating_capacity, heating_production, cooling_capacity, cooling_production, seasonal_performance, number_of_tubes_wells, depth_of_tubes_wells, geothermal_coverage_rate, supply_temperature_borehole, supply_temperature_heating, supply_temperature_cooling, planning_company, specialties_of_project, drilling_company, heating_installer, thermal_response_test, year_of_installation, web_link, description, introduction, token)

Request to save a case study to the backend

Parameters:
Name Type Description
id

If a case study is edited, the ID of the according entry

pilotarea_id

The ID of the pilot area of the case study

title

Title of the case study

address_of_project

The address

gps_coordinates

GPS coordinates of the location of the case study

usage_form

Usage form

heating_capacity

Heating capacity

heating_production

Heating production

cooling_capacity

Cooling capacity

cooling_production

Cooling production

seasonal_performance

Seasonal performance

number_of_tubes_wells

Number of tubes / wells

depth_of_tubes_wells

Depths of tubes / wells

geothermal_coverage_rate

Geothermal coverage rate

supply_temperature_borehole

Supply temperature borehole

supply_temperature_heating

Supply temperature heating

supply_temperature_cooling

Supply temperature cooling

planning_company

The planning company

specialties_of_project

Specialties of the project

drilling_company

Drilling company

heating_installer

Heating installer

thermal_response_test

TRT test yes/no

year_of_installation

The year of the installation

web_link

Link to the project with more information

description

Description of the project

introduction

Introduction to the project

token

JWT token

Source:

saveLocalContact(id, language, pilotarea, contactinfo, token)

Send the request to the backend to save a local contact

Parameters:
Name Type Description
id

If an existing contact was edited, the ID of this contact

language

The language for which the contact is added

pilotarea

The pilot area this contact is responsible for

contactinfo

The actual contact info (html)

token

The JWT authentication token

Source:

saveNote(id, key, explanatory_note, explanatory_note_de, explanatory_note_cz, explanatory_note_pl, explanatory_note_sk, explanatory_note_sl, layer_description, layer_description_de, layer_description_cz, layer_description_pl, layer_description_sk, layer_description_sl, token)

Request to save a explanatory note to the web portal

Parameters:
Name Type Description
id

If a note is edited, the according ID

key

The key (identifier for the layer)

explanatory_note

The explanatory note itself

explanatory_note_de
explanatory_note_cz
explanatory_note_pl
explanatory_note_sk
explanatory_note_sl
layer_description

A layer description in more detail

layer_description_de
layer_description_cz
layer_description_pl
layer_description_sk
layer_description_sl
token

JWT token

Source:

savePage(id, title, title_de, title_cs, title_pl, title_sk, title_sl, navigation, url, token)

Save a page to the web portal

Parameters:
Name Type Description
id

If a page is edited, the according ID of the page

title

Title of the page

title_de
title_cs
title_pl
title_sk
title_sl
navigation

Placement of the link to the page on the web portal (Top navi, Footer)

url

URL of the new page

token

JWT token

Source:

saveSiteContent(id, activated, page_id, title, title_de, title_cz, title_pl, title_sk, title_sl, text, text_de, text_cz, text_pl, text_sk, text_sl, position, token)

Save content for a specific landing page

Parameters:
Name Type Description
id

If given, edit the according content

activated

Content is active

page_id

The page where the content should appear

title

The title of the content

title_de
title_cz
title_pl
title_sk
title_sl
text

The text of the content (rich text)

text_de
text_cz
text_pl
text_sk
text_sl
position

The position of the content on the given page

token

JWT token

Source:

saveUnit(id, color, area, identifier, title_en, title_de, title_cz, title_pl, title_sk, title_sl, description_en, description_de, description_cz, description_pl, description_sk, description_sl, token)

Save a unit request

Parameters:
Name Type Description
id

If a unit should be edited, ID of this unit

color

Color of the unit in borehole (hexcode)

area

Pilotarea

identifier

Identifier in the model

title_en

Title of the unit

title_de
title_cz
title_pl
title_sk
title_sl
description_en

Description of the unit

description_de
description_cz
description_pl
description_sk
description_sl
token

JWT token

Source:

sendMessage(contactemail, name, email, topic, message)

Request to send a message via the contact form on the yellow pages

Parameters:
Name Type Description
contactemail

Contact person email

name

Name

email

Email

topic

Topic

message

Message

Source:

signIn(email, password)

Send the signin request to the backend

Parameters:
Name Type Description
email

The email of the user that wants to login

password

The password belonging to the account

Source:

signUp(username, email, password)

Request to signup as a new user on the knowledge platform

Parameters:
Name Type Description
username

Username

email

Email

password

Password

Source:

toggleUserprofile(id, token)

Toggle the active status of a userprofile

Parameters:
Name Type Description
id

ID of the profile

token

JWT token

Source:

UnitList(props)

List of units that exist in the web-portal (context: virtual boreholes)

Parameters:
Name Type Description
props
Source:

UnitTable(props)

Legend for the virtual borehole

Parameters:
Name Type Description
props

The units that are displayed

Source:

updateFieldmeasurements(area, token)

Update the field measurements

Parameters:
Name Type Description
area

Pilotarea

token

JWT token

Source:

Send a request to update the links that are presentsd in the "international projects" section

Parameters:
Name Type Description
token

JWT token

Source:

updatePilotarea(id, contact_details, excel_identifier, uri, ne_corner, sw_corner, description_en, description_de, description_cs, description_pl, description_sk, description_sl, token)

Update the pilot area details

Parameters:
Name Type Description
id

ID of the pilot area

contact_details

Contact details for this area

excel_identifier

Excel identifier (metadata table filename)

uri

URI string for this area

ne_corner

NE bounding box corner

sw_corner

SW bounding box corner

description_en

Description

description_de
description_cs
description_pl
description_sk
description_sl
token

JWT token

Source:

updateUserprofile(name, occupation, street, zip, city, country, phone, email, website, pilotArea, lat, lon, contactForm, activated, profile, token)

Update a userprofile for the yellow pages section

Parameters:
Name Type Description
name

Name

occupation

Occupation

street

Street

zip

ZIP code

city

City

country

Country

phone

Phone number

email

Email

website

Website

pilotArea

Pilotarea

lat

Latitude

lon

Longitude

contactForm

Contact via contactform? (true/false)

activated

Activated? (true/false)

profile

Description

token

JWT token

Source:

uploadAreas(token)

Request to upload the pilot area outline to the web GIS

Parameters:
Name Type Description
token

JWT token

Source:

virtualBorehole(pilotarea, coordinates, srs)

Request to create a virtual borehole

Parameters:
Name Type Description
pilotarea

Active pilot area

coordinates

Coordinates of the virtual borehole

srs

Active SRS

Source: