Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:services:general_services:idm:idm-portal_documentation [2019/08/22 10:24]
bbrauns [Search]
en:services:general_services:idm:idm-portal_documentation [2019/08/22 14:02] (current)
bbrauns [Overview]
Line 1: Line 1:
 ====== IdM-Portal documentation ====== ====== IdM-Portal documentation ======
  
-===== The portal ===== 
-The portal is available at [[https://​idm.gwdg.de]] 
  
-==== Requirements ​==== +==== Overview ​==== 
-You need a current browser ​with JavaScript enabled.+The portal is available at [[https://​idm.gwdg.de]]. ​You can log in via ldap with your username/​e-mail address or via single sign-on. The portal is available in english or german. You can change the language in the top right corner. 
 + 
 +{{:​en:​services:​general_services:​idm:​lang-menu.png?600|}}
  
-==== Overview ==== +The navigation menu is on the left side. The menu is divided into **Workspaces** and **Actions**. Each workspace is a separate environment where different types of objects like users or distribution groups can be found. Available actions such as //search// or //create// always refer to the currently selected workspace.\\ ​
-The portal provides a complete localization and is currently available in german and english. You can change the language in the top right corner. ​The navigation menu is on the left side. The menu is divided into **Workspaces** and **Actions**. Each workspace is a separate environment where different types of objects like users or distribution groups can be found. Available actions such as //search// or //create// always refer to the currently selected workspace.\\ ​+
 {{:​en:​services:​general_services:​idm:​search.png?​600|}} {{:​en:​services:​general_services:​idm:​search.png?​600|}}
  
Line 23: Line 22:
 <WRAP center round tip 60%> <WRAP center round tip 60%>
 The * character can be used as a wildcard, but only with the operator: **equal**. The * character can be used as a wildcard, but only with the operator: **equal**.
-</​WRAP>​ 
-<WRAP center round tip 60%> 
 You can use **"​username equal *"** if you want to find all available objects. You can use **"​username equal *"** if you want to find all available objects.
 </​WRAP>​ </​WRAP>​
  
-=== Autocompletion === 
-The portal has got an autocompletion function. 
-This function is active for operators **contains** and **starts with** only.\\ ​ 
-{{:​en:​services:​general_services:​idm:​autocompletion.png?​direct&​400|}} 
  
 === Search results === === Search results ===
 A list of objects will be shown after submitting the search form.\\ ​ A list of objects will be shown after submitting the search form.\\ ​
-{{:​en:​services:​general_services:​idm:​search-result.png?​direct&​400|}}\\ +{{:​en:​services:​general_services:​idm:​search-result.png?​600|}}\\ 
  
 <WRAP center round info 60%> <WRAP center round info 60%>
Line 41: Line 34:
 </​WRAP>​ </​WRAP>​
  
-This list contains ​some attibutes ​of the found objects. A user can be edited by clicking the **edit ​button** on the right. Below the search condition are links to export ​the results ​to csv file and open a print view.+The search result ​list contains ​a subset ​of the objects ​attributes. The shown attributes can be customized on the [[idm-portal_documentation#​personal settings|personal settings]]. A user can be edited by clicking the **edit** ​button ​on the right. Below the search condition are links copy the result ​to clipboard, ​export to excel/csv and to open a print view.
  
 ==== Edit ==== ==== Edit ====
-=== Overview === +After switching to the edit page new specific actions for the currently selected object appear ​on the left side menuAttributes of a selected object ​are categorized into groups like **general user data** or **Email**. You can show/hide a group by clicking on the + or - Symbol on the right.\\  
-After switching to the edit page new blue navigation box appears ​on the left side. The box contains specific actions available for the current ​selected object.\\  +{{:​en:​services:​general_services:​idm:​edit.png?​600|}} 
-{{:​en:​services:​general_services:​idm:​edit.png?​direct&​400|}}+ 
 +=== History === 
 +By clicking the **history** action attribute and password changes can be reviewed.  
 + 
 +{{:​en:​services:​general_services:​idm:​history.png?​600|}} 
 + 
 +<WRAP center round info 60%> 
 +Please note that this view contains only changes made by administrators via the idm portal. Changes via the idm synchronization mechanisms (drivers) are not displayed. 
 +</​WRAP>​ 
 + 
 +=== Personal settings === 
 +The personal settings menu can be used to change for example the number of elements or the attributes shown after searching. 
 +{{:​en:​services:​general_services:​idm:​personal-settings.png?​600|}} 
 + 
 +==== Special attribute descriptions ====
  
 === Email forwarding === === Email forwarding ===
Line 72: Line 79:
 Send an email to [[support@gwdg.de]] if you want to reactivate a deleted accout. Send an email to [[support@gwdg.de]] if you want to reactivate a deleted accout.
  
-{{:​en:​services:​general_services:​idm:​enable-disable.png?​direct&​400|}}+{{:​en:​services:​general_services:​idm:​enable-disable.png?​direct&​600|}}
  
 === Delete === === Delete ===
 Users can be deleted by activating the **deferred deletion**. An information email is send to the user regarding the deletion of the account. The user will be automatically set to status **delete** after 14 days. Users can be deleted by activating the **deferred deletion**. An information email is send to the user regarding the deletion of the account. The user will be automatically set to status **delete** after 14 days.
  
-{{:​en:​services:​general_services:​idm:​deferred-deletion.png?direct&​400|}}+{{:​en:​services:​general_services:​idm:​sperrung-1.png?600|}}
  
 === Expiration date === === Expiration date ===
 You can set an expiration date for users. The deferred deletion will be activated when the expiration date is reached. You can set an expiration date for users. The deferred deletion will be activated when the expiration date is reached.
  
-{{:​en:​services:​general_services:​idm:​expiration-date.png?direct&​400|}}+{{:​en:​services:​general_services:​idm:​sperrung-2.png?600|}}
  
 === Password === === Password ===
 == Change == == Change ==
-The **change password** link is shown on the edit page of an object. You can choose whether you want to set the password ​as an **initial password**. Initial passwords expire 14 days after password change. The user will be disabled if the password is not changed within this period. ​+Passwords are set as an **initial password** ​according to the following table. Initial passwords expire 14 days after password change. The user will be disabled if the password is not changed within this period. ​
  
 ^ Organization ^ Initial password ^ Expiration ^ Notification ^ ^ Organization ^ Initial password ^ Expiration ^ Notification ^
Line 93: Line 100:
 |MPG| no | never or upon request |  | |MPG| no | never or upon request |  |
  
-{{:​en:​services:​general_services:​idm:​change-password.png?​400|}}+{{:​en:​services:​general_services:​idm:​change-password.png?​600|}}
  
 == Generate and print == == Generate and print ==
-You can also generate a random password by clicking the **Generate** button. You must **save** or **save & print** the password ​after generation+You can also generate a random password by clicking the **Generate** button. You must **save** or **save & print** the password ​afterwards
  
-{{:​en:​services:​general_services:​idm:​generate-and-print-password.png?​400|}}+{{:​en:​services:​general_services:​idm:​generate-and-print-password.png?​600|}}
  
 A PDF document will be generated and opened if you choose **Save and Print**. A PDF document will be generated and opened if you choose **Save and Print**.
Line 105: Line 112:
  
 <WRAP center round info 60%> <WRAP center round info 60%>
-The template for the generated PDF file can be set individually for each institution. If you desire to use a non-standard template, write a mail to support@gwdg.de. The template should be created in the docx format. As placeholders the following values can be used: first name, last name, username, password+The template for the generated PDF file can be set individually for each institution. If you desire to use a non-standard template, write a mail to idm-support@gwdg.de. The template should be created in the docx format. As placeholders the following values can be used: first name, last name, username, password
 </​WRAP>​ </​WRAP>​
  
Line 130: Line 137:
   * Can be shown in Exchange addressbook   * Can be shown in Exchange addressbook
   * [[#​dynamic_exchange_distribution_group | More information]]   * [[#​dynamic_exchange_distribution_group | More information]]
-==== Search ==== 
-See [[en:​services:​general_services:​idm:​idm-portal_documentation#​search|search for users]] 
- 
-==== Edit ==== 
-See [[en:​services:​general_services:​idm:​idm-portal_documentation#​edit|edit users]] 
  
 ==== Create ==== ==== Create ====
-To create a distribution list you have to choose the correct workspace and click the **create ​button**.+To create a distribution list you must first choose the correct workspace and click **create**.
  
-{{:​en:​services:​general_services:​idm:​create-static-exchange.png?​direct&​400|}}+{{:​en:​services:​general_services:​idm:​create-static-exchange.png?​direct&​600|}}
  
 ==== Delete ==== ==== Delete ====
  
-You must first switch to the edit view of a distribution list. There you can click the delete ​link which is located in the blue selection box on the left.+You must first switch to the edit view of a distribution list. There you can click the **delete** action ​on the left.
  
 <WRAP center round important 60%> <WRAP center round important 60%>
 Be aware that the deletion is immediately and a deleted list can not be recovered. Be aware that the deletion is immediately and a deleted list can not be recovered.
 </​WRAP>​ </​WRAP>​
-==== LDAP distribution list ==== 
-=== Edit === 
-== Add / Remove members == 
-Adding and removing members to a LDAP distribution list is similar to [[en:​services:​general_services:​idm:​idm-portal_documentation&#​edit2|static Exchange distribution groups]]. The differece is, that there is no grid with members. The members are shown as a list and each of them got a **remove button** to remove this member. Another difference is that you can add members only by email address and not by username. 
  
 ==== Static Exchange distribution group ==== ==== Static Exchange distribution group ====
-=== Edit === 
-== Visibility in Exchange addressbook == 
-See [[en:​services:​general_services:​idm:​idm-portal_documentation#​visibility_in_exchange_addressbook|Visibility in Exchange addressbook]] 
- 
 == Add / Remove members == == Add / Remove members ==
-A user can be added by clicking the **add button** and insert the username or email address.+A user can be added by clicking the **Add** button ​and insert the username or email address.
  
-{{:​en:​services:​general_services:​idm:​add-member-exchange.png?​direct&​400|}}+{{:​en:​services:​general_services:​idm:​add-member-exchange.png?​direct&​600|}}
  
-You can open the select form by clicking the **select button** if you don't know the username or email address. +\\
-In the select form you can search for objects.+
  
-{{:​en:​services:​general_services:​idm:​add-member-exchange-2.png?​direct&​400|}}+{{:​en:​services:​general_services:​idm:​add-member-exchange-2.png?​direct&​600|}} 
 + 
 +Alternatively you can open a search form by clicking **select** if you don't know the username or email address. 
 + 
 +{{:​en:​services:​general_services:​idm:​select-member-1.png?​600|}} 
 + 
 +\\ 
 + 
 +{{:​en:​services:​general_services:​idm:​select-member.png?​600|}}
  
 Members can be removed by selecting them in the grid and click the **remove button**. Members can be removed by selecting them in the grid and click the **remove button**.
Line 172: Line 173:
 === Send permissions === === Send permissions ===
 You can set send permissions to control who can send to the list. You can set send permissions to control who can send to the list.
-Users who are not allwed ​will recieve an email if they try to send to the list. +Users who are not allowed ​will receive a notification ​email if they try to send to the list. 
-You can choose between ​four settings:+You can choose between ​different ​settings:
   * Unrestricted or as specified (default): Everybody is allowed to send to the list if the send permission list is empty otherwise only the specified users/​groups are allowed to send to the list.   * Unrestricted or as specified (default): Everybody is allowed to send to the list if the send permission list is empty otherwise only the specified users/​groups are allowed to send to the list.
-  * Organization:​ All users of your organization with an Exchange mailbox or email enabled users are allowed to send to the list +  * Organization:​ All users of your organization with an Exchange mailbox or email enabled users are allowed to send to the list. 
-  * Institut: All users of your institution with an Exchange mailbox or email enabled users are allowed to send to the list +  * Institute: All users of your institution with an Exchange mailbox or email enabled users are allowed to send to the list.
 ==== Dynamic Exchange distribution group ==== ==== Dynamic Exchange distribution group ====
 === Overview === === Overview ===
Line 207: Line 207:
 | -not |Not | | -not |Not |
  
-<WRAP center round important 60%> 
-The filter is applied to all objects of your organization (MPG, UNI) by default. You can check the box **Add institute users only** to reduce the set of objects to your institution only. 
-</​WRAP>​ 
  
-== Visibility in Exchange addressbook == 
-See [[en:​services:​general_services:​idm:​idm-portal_documentation#​visibility_in_exchange_addressbook|Visibility in Exchange addressbook]] 
- 
-=== Send permissions === 
-See [[en:​services:​general_services:​idm:​idm-portal_documentation#​send_permissions|Send permissions]]