Jump to content

Parking: Difference between revisions

From UmsWiki
 
(14 intermediate revisions by the same user not shown)
Line 7: Line 7:
*Parkzone
*Parkzone
*Apcoa
*Apcoa
*Q-Park
*City Parkering
*City Parkering
**The public IP address of the web server and backend server needs to whitelisted at City parkering.
**The public IP address of the web server and backend server needs to whitelisted at City parkering.
*COPARK


===Module requirements===
===Module requirements===
Line 20: Line 22:


==Configuration settings==
==Configuration settings==
There are two ways of setting up parking: New Parking and Legacy Parking. In the future, Legacy Parking will be moved to the new system. Currently, new Parking settings are used for City Parkering and Legacy Parking settings are used for ParkZone and Apcoa.
===Parking Settings===
 
===New Parking Settings===
In the configurator go to:
In the configurator go to:


Line 31: Line 31:
There are 3 main parts of the parking system that needs to be set up:
There are 3 main parts of the parking system that needs to be set up:


====1. Parking servers====
=== Parking servers ===
It is possible to set up multiple parking server systems.
It is possible to set up multiple parking server systems.


First, choose your parking system:
First, choose your parking system
 
* City Parkering
* Q-Park


The description is used as a name or reference in the configurator and is not visible to users.
The description is used as a name or reference in the configurator and is not visible to users.
Line 43: Line 40:
You should have been provided a company key and a password by your parking provider. Enter them in these parking server settings. [[File:Parking server settings.png|thumb|Parking server settings|none|745x745px]]
You should have been provided a company key and a password by your parking provider. Enter them in these parking server settings. [[File:Parking server settings.png|thumb|Parking server settings|none|745x745px]]


====2. Parking places====
==== '''Parking System specifics''' ====
 
===== '''Apcoa''' =====
You need an API key.
 
Contact Apcoa to receive it.
 
==== City-Parkering ====
You need a Company key and a password.
 
Contact City-Parkering to receive it.
 
===== '''COPARK''' =====
'''Administration URL https://copark-admin.dk/parking-portal'''
 
To get access to the GUI you need to write an email to dev@copark.dk asking for this access.
 
'''You need an API-token. You have to contact COPARK to get one or more for your parking places'''
 
'''One API-token is tied to one parking place.'''
 
==== ParkZone ====
You need an API key.
 
Contact ParkZone to receive it.
 
=== '''Q-Park''' ===
Administration URL https://access.e-park.dk/Account/Login
 
You need a username and a password.
 
Contact Q-Park to receive it.
 
=== Parking places ===
You can have multiple parking places.
You can have multiple parking places.


Line 63: Line 93:
Set the number of registrations a user is allowed to have at this parking place.
Set the number of registrations a user is allowed to have at this parking place.


===== Parking place =====
===== Mail Domain =====
'''Q-Park:'''
 
Enter the name of the parking place not the ID
 
=====Mail Domain=====
 
Is used only when a parking is created for a user that does not have a private email address entered. If there is a private email address, it will be used. Otherwise, the username concatenated with the Mail Domain will be send.  
Is used only when a parking is created for a user that does not have a private email address entered. If there is a private email address, it will be used. Otherwise, the username concatenated with the Mail Domain will be send.  


==== Upload name of users ====
==== Upload name of users ====
'''City Parkering:'''
Enabling this will tell UMS to upload the first name and given name of users.
Enabling this will tell UMS to upload the first name and given name of users.


====3. Parking settings====
==== '''Parking System specifics''' ====
You can set up a parking setting per template, so that one set of users have access to some parking places but not others.


If you only have one parking place, and everyone has access to it, you can just create one parking setting.[[File:Parking setting setup.png|thumb|A parking setting is a collection of allowed and not allowed parking places.|none|383x383px]]
===== '''Apcoa''' =====
'''Login to Apcoa portal go under "Personal parkering" -> "Grupper". Click "Rediger" on the group (parking place) your looking for.'''


You can connect a parking setting to a template:
'''Copy the number in the address line after the last forwards slash "/" into parking place.'''


#Go to edit your template.
==== ParkZone ====
#Find the parking menu and select the parking setting you want for you template.
You need a parking place ID.


[[File:Parking template.png|thumb|A parking setting is connected to a template.|none|624x624px]]
Contact ParkZone to receive it.
===Legacy Parking Settings===


====1. ParkZone setup====
=== '''Q-Park''' ===
All settings for the Parking module is set in the configurator. Go to Template Editor -> Parkzone -> Manage -> Add
You need a parking place ID.


*'Description' - This is the name for your setting, i.e. 'Test Plads'
Contact Q-Park to receive it.
*'Client Key settings' - Insert the provided client key from ParkZone. To edit the settings for the client key, click 'Manage'. See picture below for illustration.
*'Permission group' - Insert the provided parking location ID from ParkZone
*'Delete users' - Check this box if a user should be disabled when removed from AD. If left unchecked, the user will only be disabled if the end date is set to now
*'Cleanup' - Check this box if UMS should synchronise if users are active or deleted
*'Maximum number of license plates' - Set the limit of license plates a user may add


[[File:Parking permissiongroupsettings.png|none|thumb|435x435px|Permission group settings for ParkZone.]]
=== Parking settings ===
The picture below illustrates the settings when managing the client key.
You can set up a parking setting per template, so that one set of users have access to some parking places but not others.
[[File:Parkzone clientkeysettings.png|none|thumb|567x567px|Manage client key settings for ParkZone.]]


====2. APCOA setup====
If you only have one parking place, and everyone has access to it, you can just create one parking setting.[[File:Parking setting setup.png|thumb|A parking setting is a collection of allowed and not allowed parking places.|none|383x383px]]
All settings for the Parking module is set in the configurator. Go to Template Editor -> APCOA -> Manage -> Add


*'Description' - This is the name for your setting, i.e. 'Setup'
You can connect a parking setting to a template:
*'Client key settings' - Insert the provided client key from APCOA. To edit the settings for the client key, click 'Manage'. See picture below for illustration.
*'Permission group ID' - Insert the provided parking location ID from APCOA
*'Delete users' - Check this box if a user should be disabled when removed from AD. If left unchecked, the user will only be disabled if the end date is set to now
*'Cleanup' - Check this box if UMS should synchronise if users are active or deleted
*'Maximum number of license plates' - Set the limit of license plates a user may add
*'Mail Domain' - User suffix
 
[[File:Apcoa permissiongroupsettings.png|none|thumb|435x435px|Permission group settings for APCOA.]]
 
The picture below illustrates the settings when managing the client key.
[[File:Apcoa clientkeysettings.png|none|thumb|332x332px|Manage client key settings for APCOA.]]


#Go to edit template.
#Find the parking menu and select the parking setting you want for you template.
==App==
==App==


Line 136: Line 141:


===General info===
===General info===
The app does not (visually) act differently whether the school is running APCOA, Parkzone or CityParking.
The app does not (visually) act differently depending on which parking system is used (or more parking systems).


==Web interface==
==Web interface==
Line 152: Line 157:
==Parameters==
==Parameters==


====CityParking====
====System====
Only runs City parking (This is a system type)
Only runs a specific system
 
* APCOA
* CityParking
* COPARK
* ParkZone
* QPark


====CreateRegistrations====
====CreateRegistrations====

Latest revision as of 08:07, 15 April 2026

The Parking function makes it easy for users to avoid parking tickets at school. With this module, the school can administer their parking spaces with the parking company. Through the app, students and employees can get a valid, digital parking permit simply by entering their vehicle’s registration number in the app or in UMS Web. When the registration number has been entered, it becomes visible to the parking company. The parking company will then know that the user is allowed to park at the school. Available integration includes Parkzone, APCOA, and City Parkeringssystem.

Prerequisites

Supported administrative systems

  • Parkzone
  • Apcoa
  • Q-Park
  • City Parkering
    • The public IP address of the web server and backend server needs to whitelisted at City parkering.
  • COPARK

Module requirements

Parking

Should third party be contacted

You'll need a client key (and possibly a password) from the parking company before UMS can communicate with their services.

Installation

It is necessary to have a running UMS installation.

Configuration settings

Parking Settings

In the configurator go to:

Modules -> Parking

Parking settings in the configurator

There are 3 main parts of the parking system that needs to be set up:

Parking servers

It is possible to set up multiple parking server systems.

First, choose your parking system

The description is used as a name or reference in the configurator and is not visible to users.

You should have been provided a company key and a password by your parking provider. Enter them in these parking server settings. 

Parking server settings

Parking System specifics

Apcoa

You need an API key.

Contact Apcoa to receive it.

City-Parkering

You need a Company key and a password.

Contact City-Parkering to receive it.

COPARK

Administration URL https://copark-admin.dk/parking-portal

To get access to the GUI you need to write an email to dev@copark.dk asking for this access.

You need an API-token. You have to contact COPARK to get one or more for your parking places

One API-token is tied to one parking place.

ParkZone

You need an API key.

Contact ParkZone to receive it.

Q-Park

Administration URL https://access.e-park.dk/Account/Login

You need a username and a password.

Contact Q-Park to receive it.

Parking places

You can have multiple parking places.

The parking place description is shown to users that have multiple parking systems to choose from, so make sure that this is a good identifier.

Keep registration alive for X days

Keeps the registration alive in the parking system for x number of days after the user is no longer allowed to park at the parking place.

0 means it will not be kept alive.

Delete users

Users that are removed in UMS will also be deleted from the parking system.

Cleanup

Users that exists in the parking system but not UMS will also be deleted.

Maximum number of license plates

Set the number of registrations a user is allowed to have at this parking place.

Mail Domain

Is used only when a parking is created for a user that does not have a private email address entered. If there is a private email address, it will be used. Otherwise, the username concatenated with the Mail Domain will be send.

Upload name of users

Enabling this will tell UMS to upload the first name and given name of users.

Parking System specifics

Apcoa

Login to Apcoa portal go under "Personal parkering" -> "Grupper". Click "Rediger" on the group (parking place) your looking for.

Copy the number in the address line after the last forwards slash "/" into parking place.

ParkZone

You need a parking place ID.

Contact ParkZone to receive it.

Q-Park

You need a parking place ID.

Contact Q-Park to receive it.

Parking settings

You can set up a parking setting per template, so that one set of users have access to some parking places but not others.

If you only have one parking place, and everyone has access to it, you can just create one parking setting.

A parking setting is a collection of allowed and not allowed parking places.

You can connect a parking setting to a template:

  1. Go to edit template.
  2. Find the parking menu and select the parking setting you want for you template.

App

Parking spaces

This view is a list of all parking spaces the school has available (based on your template).

If you only have 1 present, that parking space will automatically be selected and this step will be skipped.

First choose your Parking Space.

Parking registrations

When you have selected a parking space, you will see a list of your registered license plates along with a timestamp of when this was registered.

Here you can edit and delete existing registrations, as well as create more, up to the allowed number of registrations the school has specified.

You can add a license plate by clicking on the "plus sign" in the top right.

General info

The app does not (visually) act differently depending on which parking system is used (or more parking systems).

Web interface

To register a license plate with a parking system go to “Your info”.

Go to your info

If a parking system has been installed and you have access to it, you should see a parking menu.

You can then create a new parking, by clicking on the "create new".

You can see your parking permits.

Enter your license plate and select which parking location you want to use. If you only have access to one parking place, you do not have to choose one.

Once you click 'ok', the parking should be registered with the parking system and you should be good to go.

Enter your registration number and choose a parking spot.

You can always edit or delete your parking.

A created registration

Parameters

System

Only runs a specific system

  • APCOA
  • CityParking
  • COPARK
  • ParkZone
  • QPark

CreateRegistrations

Create registrations

UpdateRegistrations

Update registrations

DeleteRegistrations

Delete registrations

DeleteActiveRegistrationsNotFoundInDB

Delete all unknown (to UMS) registrations in a parking place. Recreate all missing registrations in the parking system.(Known to UMS but not parking system)

ShowParkingPlaces

Show parking places that exists on the parking servers

ShowRegistrationInParkingPlace

Show all registrations in a specific parking place

This can be either the parking place id or the description for that parking place in UMS

FAQ