Parking: Difference between revisions
Added web interface description. |
|||
(15 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
The Parking function makes it easy to avoid parking tickets at | 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 == | ==Prerequisites== | ||
=== Supported administrative systems === | ===Supported administrative systems=== | ||
* Parkzone | |||
* Apcoa | *Parkzone | ||
* City Parkering | *Apcoa | ||
*City Parkering | |||
**The public IP address of the web server and backend server needs to whitelisted at City parkering. | |||
=== Module requirements === | ===Module requirements=== | ||
Parking | Parking | ||
=== Should third party be contacted === | ===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. | You'll need a client key (and possibly a password) from the parking company before UMS can communicate with their services. | ||
== Installation == | ==Installation== | ||
It is necessary to have a running UMS installation. | It is necessary to have a running UMS installation. | ||
== Configuration settings == | ==Configuration settings== | ||
There are two ways of | 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. | ||
=== New Parking Settings === | ===New Parking Settings=== | ||
In the configurator go to: | In the configurator go to: | ||
Modules -> Parking | Modules -> Parking | ||
[[File:ParkingSettingsConfigurator.png | |||
[[File:ParkingSettingsConfigurator.png|thumb|Parking settings in the configurator|none|624x624px]] | |||
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==== | |||
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: | |||
[[File:Parking server settings.png | |||
* City Parkering | |||
* Q-Park -> Administration URL https://access.e-park.dk/Account/Login | |||
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. [[File:Parking server settings.png|thumb|Parking server settings|none|745x745px]] | |||
====2. 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. | |||
[[File:Parking place setting edit.jpg|none|thumb|783x783px]] | |||
==== 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. | |||
===== Parking place ===== | |||
'''Q-Park:''' | |||
Enter the name of the parking place not the ID. | |||
It can be found by logging into the administration portal | |||
[[File:Parking Q-Park Parking place.jpg|none|frame]] | |||
=====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 ==== | |||
'''City Parkering:''' | |||
Enabling this will tell UMS to upload the first name and given name of users. | |||
====3. 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. | 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. | 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]] | ||
You can connect a parking setting to a template: | You can connect a parking setting to a template: | ||
=== Legacy Parking Settings === | #Go to edit template. | ||
#Find the parking menu and select the parking setting you want for you template. | |||
===Legacy Parking Settings=== | |||
==== 1. ParkZone setup ==== | ====1. ParkZone setup==== | ||
All settings for the Parking module is set in the configurator. Go to Template Editor -> Parkzone -> Manage -> Add | All settings for the Parking module is set in the configurator. Go to Template Editor -> Parkzone -> Manage -> Add | ||
[[File:Parking permissiongroupsettings.png|none|thumb|435x435px|Permission group settings for ParkZone.]] | [[File:Parking permissiongroupsettings.png|none|thumb|435x435px|Permission group settings for ParkZone.]] | ||
===== Description ===== | |||
This is the name for your setting, i.e. 'Test Plads' | |||
===== 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 synchronize if users are active or deleted | |||
===== Maximum number of license plates ===== | |||
Set the limit of license plates a user may add | |||
The picture below illustrates the settings when managing the client key. | The picture below illustrates the settings when managing the client key. | ||
[[File:Parkzone clientkeysettings.png|none|thumb| | [[File:Parkzone clientkeysettings.png|none|thumb|567x567px|Manage client key settings for ParkZone.]] | ||
==== 2. APCOA setup ==== | ====2. APCOA setup==== | ||
All settings for the Parking module is set in the configurator. Go to Template Editor -> APCOA -> Manage -> Add | All settings for the Parking module is set in the configurator. Go to Template Editor -> APCOA -> Manage -> Add | ||
[[File:Apcoa permissiongroupsettings.png|none|thumb|435x435px|Permission group settings for APCOA.]] | [[File:Apcoa permissiongroupsettings.png|none|thumb|435x435px|Permission group settings for APCOA.]] | ||
===== Description ===== | |||
This is the name for your setting, i.e. 'Setup' | |||
===== 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 synchronize 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 | |||
The picture below illustrates the settings when managing the client key. | The picture below illustrates the settings when managing the client key. | ||
[[File:Apcoa clientkeysettings.png|none|thumb|332x332px|Manage client key settings for APCOA.]] | [[File:Apcoa clientkeysettings.png|none|thumb|332x332px|Manage client key settings for APCOA.]] | ||
== App == | ==App== | ||
=== Parking spaces === | ===Parking spaces=== | ||
This view is a list of all parking spaces the school has available (based on your template). | This view is a list of all parking spaces the school has available (based on your template). | ||
If you only have 1 present, | If you only have 1 present, that parking space will automatically be selected and this step will be skipped. | ||
[[File:Parking Spaces App.png | [[File:Parking Spaces App.png|thumb|First choose your Parking Space.|none|432x432px]] | ||
=== Parking registrations === | ===Parking registrations=== | ||
When you have selected a parking space, you will see a list of your registered license plates | 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. | Here you can edit and delete existing registrations, as well as create more, up to the allowed number of registrations the school has specified. | ||
[[File:Parking registrations.png| | [[File:Parking registrations.png|thumb|none|463x463px]] | ||
[[File:You can add a license plate.png | [[File:You can add a license plate.png|thumb|You can add a license plate by clicking on the "plus sign" in the top right.|none|459x459px]] | ||
=== 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 whether the school is running APCOA, Parkzone or CityParking. | ||
== Web interface == | ==Web interface== | ||
To register a license plate with a parking system go to “Your info”. | To register a license plate with a parking system go to “Your info”. | ||
[[File:Your info.png | [[File:Your info.png|thumb|Go to your info|none|370x370px]] | ||
If a parking system has been installed and you have access to it, you should see a parking menu. | 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 then create a new parking, by clicking on the "create new". | ||
[[File: | [[File:Empty parking list.png|thumb|You can see your parking permits.|none|591x591px]] | ||
Enter your | 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.[[File:Enter License.png|thumb|Enter your registration number and choose a parking spot.|none|334x334px]] | |||
You can always edit or delete your parking.[[File:A created registration.png|thumb|A created registration|none|390x390px]] | |||
==Parameters== | |||
====CityParking==== | |||
Only runs City parking (This is a system type) | |||
====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 == | ==FAQ== |
Latest revision as of 08:47, 21 November 2024
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
- City Parkering
- The public IP address of the web server and backend server needs to whitelisted at City parkering.
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
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.
New Parking Settings
In the configurator go to:
Modules -> Parking
There are 3 main parts of the parking system that needs to be set up:
1. Parking servers
It is possible to set up multiple parking server systems.
First, choose your parking system:
- City Parkering
- Q-Park -> Administration URL https://access.e-park.dk/Account/Login
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.
2. 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.
Parking place
Q-Park:
Enter the name of the parking place not the ID.
It can be found by logging into the administration portal
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
City Parkering:
Enabling this will tell UMS to upload the first name and given name of users.
3. 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.
You can connect a parking setting to a template:
- Go to edit template.
- Find the parking menu and select the parking setting you want for you template.
Legacy Parking Settings
1. ParkZone setup
All settings for the Parking module is set in the configurator. Go to Template Editor -> Parkzone -> Manage -> Add
Description
This is the name for your setting, i.e. 'Test Plads'
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 synchronize if users are active or deleted
Maximum number of license plates
Set the limit of license plates a user may add
The picture below illustrates the settings when managing the client key.
2. APCOA setup
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'
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 synchronize 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
The picture below illustrates the settings when managing the client key.
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.
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.
General info
The app does not (visually) act differently whether the school is running APCOA, Parkzone or CityParking.
Web interface
To register a license plate with a parking system 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".
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.
You can always edit or delete your parking.
Parameters
CityParking
Only runs City parking (This is a system type)
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