Difference between revisions of "Parking"

From UmsWiki
Jump to: navigation, search
(Mail Domain)
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The Parking function makes it easy to avoid parking tickets at schools, which 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 compnay, who then knows that the user is allowed to park at the school. Avaiable integration includes Parkzone and Apcoa.
+
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
 +
*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 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==
A part of UMS installation
+
It is necessary to have a running UMS installation.
  
== Technical 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.
  
=== ParkZone setup ===
+
===New Parking Settings===
Template Editor -> Parkzone -> Manage -> Add
+
In the configurator go to:
* 'Description' - The settings name
 
* 'Client Key settings' - Insert the provided client key you have from Parkzone
 
* 'Permission group' - Parkzone parking location ID
 
* 'Delete users' - Will delete the user if they are remove from AD, otherwise they will only be disabled by setting enddate to now
 
* 'Cleanup' - Activate if UMS should synchronise active and deleted users
 
* 'Maximum number of license plates' - Set the limit of licens plates a user may add
 
[[File:Parking permissiongroupsettings.png|none|thumb]]
 
View for manage the client key
 
[[File:Parkzone clientkeysettings.png|none|thumb]]
 
  
=== Apcoa setup ===
+
Modules -> Parking
* 'Description' - The settings name
 
* 'Client key settings' - Insert the provided client key from Apcoa
 
* 'Permission group ID' - Apcoa parking location ID
 
* 'Delete users' - Will delete the user if they are remove from AD, otherwise they will only be disabled by setting enddate to now
 
* 'Cleanup' - Activate if UMS should synchronise active and deleted users
 
* 'Maximum number of licesne plates' - Set the limit of licens plates a user may add
 
* 'Mail Domain' - User suffix
 
[[File:Apcoa permissiongroupsettings.png|none|thumb]]
 
  
View for manage the client key
+
[[File:ParkingSettingsConfigurator.png|thumb|Parking settings in the configurator|none|624x624px]]
[[File:Apcoa clientkeysettings.png|none|thumb]]
 
  
== FAQ ==
+
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.
 +
 
 +
You can add, edit, or remove a system.
 +
[[File:Parking Servers Settings.png|thumb|The list of parking servers.|none|560x560px]]
 +
First, choose your parking system (currently only City Parkering is available, but more will be added in future releases).
 +
 
 +
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 and you can edit, add, or delete them.
 +
[[File:Parking Places.png|thumb|Parking Places|none|556x556px]]
 +
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.
 +
 
 +
=====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.
 +
 
 +
===='''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.[[File:Parking Settings.png|thumb|You can have multiple parking settings.|none|556x556px]]
 +
[[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:
 +
 
 +
#Go to edit your template.
 +
#Find the parking menu and select the parking setting you want for you template.
 +
 
 +
[[File:Parking template.png|thumb|A parking setting is connected to a template.|none|624x624px]]
 +
===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 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.]]
 +
The picture below illustrates the settings when managing the client key.
 +
[[File:Parkzone clientkeysettings.png|none|thumb|567x567px|Manage client key settings for ParkZone.]]
 +
 
 +
====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 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.]]
 +
 
 +
==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.
 +
[[File:Parking Spaces App.png|thumb|First choose your Parking Space.|none|432x432px]]
 +
 
 +
===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.
 +
[[File:Parking registrations.png|thumb|none|463x463px]]
 +
[[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===
 +
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”.
 +
[[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.
 +
 
 +
You can then create a new parking, by clicking on the "create new".
 +
[[File:Empty parking list.png|thumb|You can see your parking permits.|none|591x591px]]
 +
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==

Latest revision as of 07:56, 8 March 2021

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

Parking settings in the configurator

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.

You can add, edit, or remove a system.

The list of parking servers.

First, choose your parking system (currently only City Parkering is available, but more will be added in future releases).

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

2. Parking places

You can have multiple parking places and you can edit, add, or delete them.

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.

Parking place setting edit.jpg

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.

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 have multiple parking settings.
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 your template.
  2. Find the parking menu and select the parking setting you want for you template.
A parking setting is connected to a 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 synchronise if users are active or deleted
  • 'Maximum number of license plates' - Set the limit of license plates a user may add
Permission group settings for ParkZone.

The picture below illustrates the settings when managing the client key.

Manage client key settings for ParkZone.

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 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
Permission group settings for APCOA.

The picture below illustrates the settings when managing the client key.

Manage client key settings for APCOA.

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.

Parking registrations.png
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 whether the school is running APCOA, Parkzone or CityParking.

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

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