Wiki source code of Benutzerverwaltung

Last modified by YellowFox_RD on 2026/03/13 14:09

version	line-number	content
1.1	1	(% class="box" %)
2.1	2	(((
8.1	3	Table of Contents
2.1	4	)))
	5
1.1	6	{{toc/}}
	7
8.1	8	Within the page user adminstration you can manage your users and their rights to use the portal functionalities.
2.1	9
8.1	10	= Summary =
2.1	11
8.1	12	== Preconditions ==
2.1	13
8.1	14	You need to have administrative rights for your company within the YellowFox portal to set the rights. To use the multiuser functions or add new user you'll need booked tariff options Business or Profi.
2.1	15
8.1	16	== Hints ==
2.1	17
8.1	18	Changes in user right settings wil become active after next login of changed user.
2.1	19
8.1	20	= Default =
2.1	21
8.1	22	Default Portal Users are allowed to use the Yellowfox portal without any constraints except limitations by their user rights.
	23	A user role can be assigned to a standard user. This controls and adjusts a user's permissions via the user role.
2.1	24
8.1	25	== Overview - User,,[[image:users.png]],, ==
2.1	26
8.1	27	At this table all users of an company are listed. You can figure out, who's administrator or mainuser, as well as the status of an account is active or locked. In this way, you can quickly see, who's able to login and who is not. Additionally you can reach all user specific functions. To get an better overview use the filter, by entering parts of username or loginname. To filter mainuser, administrators or by account status use one of the prefix "main:", "admin:" or "account:" followed by the values "active" or "inactive". Using "account:active" means you see only users with an active account in the table, "main:active" shows you your mainuser.
2.1	28
8.1	29	=== Setupuser ===
2.1	30
8.1	31	User with the icon "[[image:image2023-5-8_14-19-5.png]]" in front of their name
	32	A setup user account is used by YellowFox staff or the YellowFox partner to carry out initial setup, configuration or support in the customer portal. The setup user has full access to portal functions, vehicles and staff.
	33	Setup users are limited in time and are automatically deleted after expiry.
2.1	34
8.1	35	User specific functions
	36	User specific functions are functions related to this specific user.
	37	If a user is assigned to a user role, it is not possible to change a user's settings. These are controlled via the user role. As a result, various functions are not available for these users.
2.1	38
8.1	39	=== User data ===
2.1	40
8.1	41	User data are all common data of an user as:
2.1	42
1.1	43	(((
8.1	44	* last name
	45	* first name
	46	* login name - this one has to be unique in your company
	47	* password
	48	* email address
1.1	49	* Super PIN
8.1	50	* User role – it is possible to assign a user role, remove the assignment, or switch to the creation dialog for a new user role
1.1	51	)))
2.1	52
8.1	53	You can change these data here. Some of them have constraints, as length constraints which are checked, when you save. If you miss one, you'll get an appropriate message.
2.1	54
8.1	55	=== Portal rights ===
2.1	56
8.1	57	You can grant global rights and vehicle rights to users. Global rights are permissions for special actions in the portal, e.g. the right to delete position data. Vehicle rights are permissions to view and edit vehicles.
	58	To learn more about the meanings of rights have a look in the document right details in Yellowfox portal. Pls be aware that the companys main user owns everytime adminstrator rights.
2.1	59
8.1	60	=== Access time profiles ===
2.1	61
8.1	62	The user can be assigned an access time profile. In addition, a supper PIN can be assigned in "user data", which allows a authentication outside the access time
2.1	63
8.1	64	=== Access network profiles ===
2.1	65
8.1	66	The user can be assigned an access network profile. In addition, a supper PIN can be assigned in "user data", which allows a authentication outside the granted network addresses
2.1	67
8.1	68	=== Vehicle rights ===
2.1	69
8.1	70	Each user may have individual vehicle or group rights. On select or deselect a vehicle group, the right of all assigned vehicles will be changed, too. Use the vehicles and groups list to grant or revoke rights for groups and vehicles to a specific user by check or uncheck the boxes. An checked box means the user owns this right. Don't forget to save after you made changes.
	71	Pls be aware, some portal functions belong to the appropriate vehicle rights. More details you can find in the document right details in Yellowfox portal.
2.1	72
8.1	73	=== Personal rights ===
2.1	74
8.1	75	You can grant users access to personal data at the module "personal right". There you can set, if an user can see names (and drivers or personal keys), their booking data or master data of your drivers or personal. If a user don't have the permissions to see data, they are marked as anonymised. In this way, he can devide between missing and anonymised data at every point of time. Setting rights for a personnel group will passed to all essigned persons.
	76	In some modules the personal to choose is limited regarding to users rights. Having only the booking rights is not sufficient in most cases, both of the rights names and bookings are needed to get access to the personal in the most modules handles with booking data.
2.1	77
8.1	78	=== User overview ===
2.1	79
8.1	80	To get a total overview over the current set portal, vehicle and personnel rights of your user, click at the appropriate user at the entry user overview. Only granted portal-, vehicle- and personnel rights are listed. To filter for a specific vehicle or person use the search input.
2.1	81
8.1	82	=== Ban / Unban ===
2.1	83
8.1	84	You can ban or unban user accounts. A banned / locked user is not able to log into the Yellowfox portal. It's always possible to unlock an user.
2.1	85
8.1	86	=== Delete ===
2.1	87
8.1	88	You can delete user accounts. A deleted user is not able to log into the Yellowfox portal and cannot be undeleted, the deleted username is available for future users.
2.1	89
8.1	90	== Reload [[image:reload.png]] ==
2.1	91
8.1	92	Click here to reload this table.
2.1	93
8.1	94	== Add new user [[image:newUser.png]] ==
2.1	95
8.1	96	To add a new user to the portal click on the button "new user". An assistent will guide you through all steps to ensure all needed data are entered. In first step you enter personal data of your new user, then the portal rights and finish by his vehicle rights. You're always able to go back one step by clicking "back". Already entered data are kept in all steps.
	97	After you set all data and the new user have been created you can choose to add an additional user by keeping and reuising all the settings from the user you just created or start with blank masks. Otherwise you can go back to the overview.
2.1	98
8.1	99	== Set vehicle rights for selected users [[image:multiUserObjects.png]] ==
2.1	100
8.1	101	You can set the same vehicle rights for more than one user in one step. Choose the user you want to set the rights for. Click on the button and a page is opened where you can choose an existing user as template. The currently set vehicle rights of this user are displayed when you choose him from the dropdown box. If you don't want to use a template and start with a blank mask, choose "don't use a template".
	102	Click on "next" and the mask with the rights is opened. If you choosen an template, the rights are already checked, otherwise everything is blank. Set the rights as you need and click on save.
	103	If you decide to choose another template, you can go back to previous page by click on "back".
2.1	104
8.1	105	== Ban selected users [[image:multiUserBan.png]] ==
2.1	106
8.1	107	You can ban or unban user accounts. A banned / locked user is not able to log into the Yellowfox portal. It's always possible to unlock an user.
	108	To ban more than one user in one step, choose the appropriate users in the overview and click on "ban selected users". To unban a user, you have to choose the option "unban" from the user specific functions.
2.1	109
8.1	110	== Delete selected users [[image:multiUserDel.png]] ==
2.1	111
8.1	112	You can delete user accounts. A deleted user is not able to log into the Yellowfox portal and cannot be undeleted, the deleted username is available for future users.
	113	To delete more than one user in one step, choose the appropriate users in the overview and click on "delete selected users"
2.1	114
8.1	115	== Assign a user role to selected users [[image:image2023-5-16_9-20-55.png]] ==
2.1	116
8.1	117	To assign or unassign a user role to multiple users in one step, select the relevant users in the user overview and click on "Assign a user role to selected users".
	118	You will then receive an overview of the selected users and their current status with regard to a user role assignment. You can now select a role or choose that the users should not belong to any role. By confirming the dialog, the users are then assigned to the role or the respective assignment is canceled.
2.1	119
8.1	120	== Overview - Vehicles ,,[[image:vehicles.png]],, ==
2.1	121
8.1	122	In the overview "vehicles" you see all vehicles of your company and the users having rights granted to them. For each user 3 symbols mark the granted rights:
1.1	123
8.1	124	\|=right\|=icon active\|=icon inactive
	125	\|See vehicle data\|[[image:icon-eye_a.jpg]]\|[[image:icon-eye_i.jpg]]
	126	\|Request vehicle data\|[[image:icon-msg_a.jpg]]\|[[image:icon-msg_i.jpg]]
	127	\|Change settings data\|[[image:icon-set_a.jpg]]\|[[image:icon-set_i.jpg]]
2.1	128
8.1	129	By clicking an icon you can granted or revoke rights to an user. When trying to revoke a vehicle right, inherited from a group, a dialog will be shown to list all dependency changes of affected vehicle groups. On confirm this dialog the according group right will be deactivated, too. All other vehicles belonging to this group will keep their rights indivually.
	130	Users revoked all rights, will not be listed anymore after next table reload.
2.1	131
8.1	132	== Vehicle specific functions ==
2.1	133
8.1	134	=== Vehicle rights ===
2.1	135
8.1	136	On the page vehicle rights, you get an overview, who got granted rights to this vehicle. Here you can grant or revoke rights to all standard users of your company.
2.1	137
8.1	138	= Time limited portal users =
2.1	139
8.1	140	Time limited portal users get access to the Yellowfox portal in a limited date range. In this way you can enable third persons - as customers - to access data of your vehicles or positions.
	141	Choose the option "Time limited portal users" in navigation on the upper side to manage your limited users.
2.1	142
8.1	143	== Overview - users ==
2.1	144
8.1	145	In the overview all time limited portal users of your company are listed. Additionally you can see directly an account is active or inactive, an user can login or his login is denied. An inactive account can be caused by the time range, as well as by a ban. You can also see here the count of logins, the date and time of latest successful login and the valid time range of this account. The user specific functions are reachable by the dropdown box in the actions column.
	146	To get an better overview you can use the filter by searching for users name, dates or the account status. To filter directly by the status use the prefix "account:" and one of the values "active" or "inactive". For instance the term "account:inactive" lists all the inactive time limited users of your company.
2.1	147
8.1	148	== User specific functions ==
	149
	150	User specific functions are functions related to this specific user.
2.1	151	{{id name="Benutzerverwaltung-LoginMail"/}}
	152
8.1	153	=== Send login data ===
1.1	154
8.1	155	Click on this function to send a mail for the user you want to send the registration data. Please be aware you will not get a feedback, the mail is delivered and read by the recipient.e Rückmeldung über einen erfolgreichen Versand der Mail gibt.
2.1	156
1.1	157	> Hallo Herr Meier,
	158	> hiermit erhalten Sie ihr Login für das YellowFox Ortungsportal.
	159	> Gültig ab: 26.08.2008, 00:00
	160	> Gültig bis: 27.08.2008, 23:59
8.1	161	> Login-Link: <http:~/~/map.yellowfox.de/gprsv2/index.asp?subaction=setlang&language=deu&action=login&tmpuser=XYZ>
1.1	162	> Dieser Link wurde Ihnen gesendet von:
	163	> Firma: YellowFox GmbH
	164	> Person: Mustermann, Max
	165	> Strasse: Zum Tälchen 3
	166	> PLZ, Ort: 01723,Kesselsdorf
	167	> Telefon: 000000
8.1	168	> Email: max.mustermann@yellowfox.de
2.1	169
8.1	170	With the login link in this mail your customer can login into the YellowFox portal and gets all the rights you granted to him.
2.1	171
8.1	172	=== User data ===
2.1	173
8.1	174	At this page you can see and change the common data of an users. These data are:
2.1	175
1.1	176	(((
8.1	177	* last name
	178	* first name
	179	* email address - needed for sending the login mail and used as login name
	180	* time range - when your customer is able to login
1.1	181	)))
2.1	182
8.1	183	=== Portal rights ===
2.1	184
8.1	185	It is possible to grant rights for limited users similiar to standard users, except the following rights, you cannot grant:
2.1	186
1.1	187	(((
8.1	188	* is administrator
	189	* alert manager
	190	* delete positiondata
	191	* view invoice information
1.1	192	)))
2.1	193
8.1	194	Which portal function can accessed by which granted right can you see in the document right details in Yellowfox portal.
2.1	195
8.1	196	=== Vehicle rights ===
2.1	197
8.1	198	Each user may have individual vehicle or group rights. On select or deselect a vehicle group, the right of all assigned vehicles will be changed, too. Use the vehicles and groups list to grant or revoke rights for groups and vehicles to a specific user by check or uncheck the boxes. An checked box means the user owns this right. Don't forget to save after you made changes.
	199	The right "change settings" cannot be granted to time limited users.
	200	Please be aware some of the functions in the YellowFox portal need appropriate rights. More details you can find in the document right details in Yellowfox portal.
2.1	201
8.1	202	=== Personal rights ===
2.1	203
8.1	204	You can grant users access to personal data at the module "personal right". There you can set, if an user can see names (and drivers or personal keys), their booking data or master data of your drivers or personal. If a user don't have the permissions to see data, they are marked as anonymised. In this way, he can devide between missing and anonymised data at every point of time. Setting rights for a personnel group will passed to all essigned persons.
	205	In some modules the personal to choose is limited regarding to users rights. Having only the booking rights is not sufficient in most cases, both of the rights names and bookings are needed to get access to the personal in the most modules handles with booking data.
2.1	206
8.1	207	=== User overview ===
2.1	208
8.1	209	To get a total overview over the current set portal, vehicle and personnel rights of your user, click at the appropriate user at the entry user overview. Only granted portal-, vehicle- and personnel rights are listed. To filter for a specific vehicle or person use the search input.
2.1	210
8.1	211	=== Ban / Unban ===
2.1	212
8.1	213	Irrespective of the validation of the time range for a time limited user you can ban or unban this one. Banned users cannot login, even their time range is valid. Banned users can be unbanned by clicking on unban. In all time all portal rights and vehicle rights are untouched.
2.1	214
8.1	215	=== Delete ===
2.1	216
8.1	217	User accounts can be deleted for time limited users. Deleted users cannot be undeleted.
2.1	218
8.1	219	== Reload [[image:reload.png]] ==
2.1	220
8.1	221	Click here to reload the table.
2.1	222
8.1	223	== Add new user [[image:newUser.png]] ==
2.1	224
8.1	225	To add a new user to the portal click on the button "new user". An assistent will guide you through all steps to ensure all needed data are entered. In first step you enter personal data of your new user, then the portal rights and finish by his vehicle rights. You're always able to go back one step by clicking "back". Already entered data are kept in all steps.
	226	After you set all data, the new account is created and the an [[email>>doc:\|\|anchor="Benutzerverwaltung-LoginMail"]] containing the login data is send to the used email address. You can now choose to create an additional user by keeping and reuising all the settings from the user you just created or start with blank masks. Otherwise you can go back to the overview.
2.1	227
8.1	228	= Single-Sign-On =
2.1	229
8.1	230	Single-Sign-On (SSO) is an authentication method which uses a single user name + password relation to access multiple tools. This is a secure and user-friendly alternative as it requires only a single strong password. Due to centralized management it is possible to ban an user from all applications at once, for example if the employee is leaving the company. YellowFox supports login via Microsoft Enta ID.
2.1	231
1.1	232
8.1	233	== Add a SSO account ==
5.1	234
8.1	235	A SSO account can be added while creating a new user by choosing the desired authentication method. It can also be added to existing users by editing the user data.
5.1	236
8.1	237	A user can only have a single authentication method. Registering a SSO account bans the user from using the YellowFox user name and password. This ensures that the user is really banned from the portal on deactivating the SSO account. Nevertheless you can change the registered authentication method for users at all times.
5.1	238
8.1	239	SSO users can also use access profiles. They can not use a Super PIN to log-in outside of access times.
5.1	240
8.1	241	[[image:1773406691623-541.png]]
6.1	242
5.1	243	== Microsoft Entra ID ==
	244
8.1	245	Microsoft Entra ID is a cloud-based access control solution for companies. Attention: This is something else than private Microsoft accounts!
5.1	246
8.1	247	To use Single-Sign-On via Microsoft Entra ID an User-principal-name (UPN) must be added to the user. The UPN is usually the primary Entra login address. Your Entra ID administrator can check this for you. You do not need to do any settings at Microsoft Entra ID itself. As soon as you added the UPN to an user, the login is possibe.
5.1	248
8.1	249	At first login you will be asked for permission to read data from your Entra ID profile. This is necessary for succesful login. It needs to be confirmed by every user. You can deactivate the need of confirmation of every user at Mcrosoft Entra ID. You need an Entra ID user with administration rights to add permission for all users of your tenant. If you do so, the users must not confirm the data usage anymore.
5.1	250
8.1	251	This so called admin consent can also be added globally for your Entra tenant. The app will appear at your companies apps after a single user successfully logged-in.
5.1	252
8.1	253	= User roles =
2.1	254
8.1	255	User roles offer the opportunity to assign similar rights to multiple users. For example you might group your users by their department or subsidiary. If you want to edit these users rights, you do not have to edit each one but you can just apply the changes once to the role. Roles include rights for vehicles, personnel, as well as time and network access profiles.
	256	You can view an overview of your user roles at the “user roles” tab. Use the upper menu to create a new role. Each role needs a name. Afterwards you can set its rights like you are used to from normal users.
2.1	257
8.1	258	== Assign user roles ==
2.1	259
8.1	260	Roles can be selected during the creation of new users. You can also use the mass assignment functionality in the user overview. Just select the desired users and click on the menu entry “assign user roles” at the top. You might also use the action menu in the user role overview to open an assignment editor of a single user role.
	261	If you assign a user role to an already existing user, this will overwrite his current rights. This users’ rights will not be editable anymore. To edit them, you need to edit the role itself or disconnect the role from the user. If you disconnect the role, the rights which were given by it to the user will remain. However, you are now able to edit the user again. As the user is not linked to role anymore, changes to the user will not affect its old role.
1.1	262
2.1	263	{{id name="Benutzerverwaltung-PDF-Export"/}}
	264
8.1	265	= PDF-Export with user overview =
2.1	266
8.1	267	You can write an export in pdf format, containing all your standard users and their granted rights and vehicles.
2.1	268
8.1	269	= Settings =
2.1	270
8.1	271	== Common settings ==
2.1	272
8.1	273	Here you can set your common personal settings and preferences for the module "user administration". Set the amount of lines for your table. This setting is valid for all tables in this module, but can be overwrittten by the dropdown box in the head of each table. Changes made by this dropdown box are temporary and affecting just this table.
2.1	274
8.1	275	== Access time profiles ==
2.1	276
8.1	277	Here you can manage and create your access time profiles. With these profiles, you can limit the portal access of your employees. For a portal access outside this defined time you can specify a Super PIN, which allows an access, All authentications with this PIN will be logged in der user statistic.
2.1	278
8.1	279	== Access network profiles ==
2.1	280
8.1	281	Here you can manage and create your access network profiles. With these profiles, you can limit the portal access of your employees. For a portal access outside this defined network address aereas you can specify a Super PIN, which allows an access, All authentications with this PIN will be logged in der user statistic.
1.1	282
	283	= Quickbar =
2.1	284
1.1	285	\|=Icon\|=Bezeichnung\|=Inhalt
8.1	286	\|[[image:export.png]]\|PDF-Export\|generates a PDF-Export with an users overview
	287	\|[[image:quicklink_light.png]]\|QuickLink\|creates a [[QuickLink>>doc:/display/ds/QuickLinks]] to this page
	288	\|[[image:help_light.png]]\|Help\|the link to this help page
1.1	289