docu
This commit is contained in:
parent
26b0ff9fb3
commit
4729cc530a
1 changed files with 49 additions and 12 deletions
|
@ -25,8 +25,10 @@ Currently an institution has a name, an optional url-suffix and an optional logo
|
|||
- The name is mandatory and must be unique within the SEB Server application.
|
||||
- The url-suffix is optional and defines a suffix that can be used within the browser URL to access the SEB Server within
|
||||
this institution. The institution logo and theme will then be shown.
|
||||
- The logo upload where a image can be uploaded to be used as logo for the institution. The logo ideally should have dimension
|
||||
around 300 pixel width and 80 pixel height to fit well into the logo section of the page.
|
||||
- The logo upload where a image can be uploaded to be used as logo for the institution.
|
||||
|
||||
.. note:: The logo ideally should have a dimension around 300 pixel width and 80 pixel height
|
||||
to fit well into the logo section of the page. Currently only .png, .jpg and .jpeg image-files are supported.
|
||||
|
||||
.. image:: images/institution/list.png
|
||||
:align: center
|
||||
|
@ -56,24 +58,22 @@ 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.
|
||||
|
||||
- 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.
|
||||
|
||||
- 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.
|
||||
|
||||
- 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
|
||||
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
|
||||
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.
|
||||
|
||||
- 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.
|
||||
|
||||
.. image:: images/institution/new.png
|
||||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/institution/new.png
|
||||
|
||||
|
||||
**Change the name/logo of an existing or own Institution**
|
||||
|
||||
|
@ -82,8 +82,45 @@ access the application with a web-browser and have the own logo.
|
|||
*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.
|
||||
- To upload a new logo, click on the upload-icon just beside the logo input field. The application will show a file-picker dialog.
|
||||
Use the file-picker dialog to search and select the logo file. Use the "Upload" action-button to upload the selected file. The
|
||||
selected logo should appear as an image within the image upload input field of the institution form.
|
||||
- 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.
|
||||
|
||||
*As an institutional administrator*
|
||||
|
||||
- Login as an institutional administrator and select the "Institution" menu-item from the left hand side menu.
|
||||
- The form of the own institution is shown in read-only mode. Use the "Edit Institution" action from the action pane.
|
||||
- The form of the own institution is now shown in the edit mode and the name or logo of the institution can be modified.
|
||||
- To upload a new logo, click on the upload-icon just beside the logo input field. The application will show a file-picker dialog.
|
||||
Use the file-picker dialog to search and select the logo file. Use the "Upload" action-button to upload the selected file. The
|
||||
selected logo should appear as an image within the image upload input field of the institution form.
|
||||
- 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.
|
||||
|
||||
.. image:: images/institution/view_institutional.png
|
||||
:align: center
|
||||
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/institution/view_institutional.png
|
||||
|
||||
|
||||
**Activate / Deactivate an existing institution**
|
||||
|
||||
An institution is shown to other users and ready for applying user-accounts and other entities only if it is active. An inactive
|
||||
institution can only be seen by a institutional administrator of this institution or by a SEB Server administrator that are able to
|
||||
see all institutions.
|
||||
|
||||
To activate an institution for the first Time one can either use the "Activate Institution" action form the action pane on the right side
|
||||
within the read only mode of the institution form or with the same action on the edit mode while also saving the applied modifications of
|
||||
the form.
|
||||
|
||||
To deactivate an institution one can use the "Deactivate Institution" action form the action pane on the right side.
|
||||
When an institution is been deactivated, also all existing and active entities that belongs to this institution are deactivated too.
|
||||
This affects user-accounts, configurations and LMS Setups. On deactivation action, the application will search the affected entities
|
||||
and will inform the administrator about the number of the affected entities and asks for confirmation.
|
||||
After Confirm the deactivation the insitution and all affected entities will be deactivated. This means also the user-accounts that has
|
||||
not a institutional role or the SEB Server administration role, will not be able to login anymore.
|
||||
|
||||
|
||||
- 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
|
||||
|
|
Loading…
Reference in a new issue