zervo/seb-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

more docu

Browse source
This commit is contained in:
anhefti 2020-03-12 13:38:37 +01:00
parent c6853af5e9
commit 9ed6776a9e
1 changed files with 19 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/institution.rst
View file

@ -5,7 +5,7 @@ The institution section within SEB Server is used to support built-in multi-tena
light-weight stand-alone server but with the possibility to separate operation completely within different institutions. light-weight stand-alone server but with the possibility to separate operation completely within different institutions.
.. note:: .. note::
If a quick use-case based reference suites you better, just forward to the user-case section of this chapter If a quick use-case based reference suites you better, just forward to the "Use Cases" section of this chapter
Only the role of SEB Server administrator and institutional administrator are able to see and use this section. Only the role of SEB Server administrator and institutional administrator are able to see and use this section.
A SEB Server administrator is able to see the whole list of all existing institutions and to create new and maintain every A SEB Server administrator is able to see the whole list of all existing institutions and to create new and maintain every
@ -56,17 +56,34 @@ be completely separated from each other. It should also be possible for an insti
access the application with a web-browser and have the own logo. access the application with a web-browser and have the own logo.
- Login as a SEB Server administrator and select the "Institution" menu-item from the left hand side menu. - Login as a SEB Server administrator and select the "Institution" menu-item from the left hand side menu.
- A list of all existing and available institutions will be shown. - A list of all existing and available institutions will be shown.
- Select "Add Institution" form the right hand side action pane to create a new institution. - Select "Add Institution" form the right hand side action pane to create a new institution.
- The creation form will be shown and the user is able to define a name, url-suffix and or upload a logo for the new institution. - The creation form will be shown and the user is able to define a name, url-suffix and or upload a logo for the new institution.
- After giving all information, the new institution can either be saved and remains inactive until activation or can be saved and - After giving all information, the new institution can either be saved and remains inactive until activation or can be saved and
automatically be activated within the same step. Use the "Save Institution" action on the right side to just save the institution automatically be activated within the same step. Use the "Save Institution" action on the right side to just save the institution
or the "Activate Institution" action the save and activate within the same step. or the "Activate Institution" action the save and activate within the same step.
- In either case the form input will first be verified and if there is missing something or has wrong input, the save action will - In either case the form input will first be verified and if there is missing something or has wrong input, the save action will
be postponed and the edit form will present the missing input within a red box and some inform text right below the input field be postponed and the edit form will present the missing input within a red box and some inform text right below the input field
for correction. for correction.
- If successfully saved, the application will show the form of the newly created institution in read only mode and if already activated - If successfully saved, the application will show the form of the newly created institution in read only mode and if already activated
other user, that are allowed to, can see the institution now. other user, that are allowed to, can see the institution now.
**Change the logo of an existing Institution** **Change the name/logo of an existing or own Institution**
.. note:: This scenario differs a little bit in case of having a SEB Server administrator or institutional administrator role
*As SEB Server administrator*
- Login as a SEB Server administrator and select the "Institution" menu-item from the left hand side menu.
- A list of all existing and available institutions will be shown. Use the filter above to find the institution to change
- Select the institution and use the "Edit Institution" action on the right side action pane to open the institution in edit mode
- Apply the changes and save the institution. If all given information is correct and nothing is missing, the application will
show the changed institution form in read only mode