diff --git a/docs/images/screen_proctoring/proctoring_overview.png b/docs/images/screen_proctoring/proctoring_overview.png new file mode 100644 index 00000000..a40f3416 Binary files /dev/null and b/docs/images/screen_proctoring/proctoring_overview.png differ diff --git a/docs/images/screen_proctoring/proctoring_overview_live.png b/docs/images/screen_proctoring/proctoring_overview_live.png new file mode 100644 index 00000000..0ad86516 Binary files /dev/null and b/docs/images/screen_proctoring/proctoring_overview_live.png differ diff --git a/docs/images/screen_proctoring/search_form.png b/docs/images/screen_proctoring/search_form.png new file mode 100644 index 00000000..f8369b07 Binary files /dev/null and b/docs/images/screen_proctoring/search_form.png differ diff --git a/docs/images/screen_proctoring/search_results_screenshots.png b/docs/images/screen_proctoring/search_results_screenshots.png new file mode 100644 index 00000000..c0ae2c83 Binary files /dev/null and b/docs/images/screen_proctoring/search_results_screenshots.png differ diff --git a/docs/images/screen_proctoring/search_results_sessions.png b/docs/images/screen_proctoring/search_results_sessions.png new file mode 100644 index 00000000..cfb9d00e Binary files /dev/null and b/docs/images/screen_proctoring/search_results_sessions.png differ diff --git a/docs/screen_proctoring.rst b/docs/screen_proctoring.rst index ad31fc26..b2f3c6ae 100644 --- a/docs/screen_proctoring.rst +++ b/docs/screen_proctoring.rst @@ -61,7 +61,7 @@ Gallery View - The SEB-Client additionally sends metadata about the screenshot - Metadata changes according to the content displayed on the screenshot -- Refer to chapter "Metadata" for more details +- Refer to the chapter "Metadata" for more details - The camera icon opens the Proctoring View in a new tab. See chapter "Proctoring View" for more infos. - Close the expanded view either by clicking on the collapse button or somewhere outside of the screenshot @@ -78,7 +78,7 @@ Gallery View Running Exams --------- -To get an overview of all running exams which your user has access to click on the "Running Exams" item in the navigation bar on the left hand side. +To get an overview of all running exams which your user has access to click on the "Running Exams" item in the navigation bar on the left side. - By Default the exams are sorted by "Exam Start-Time" in ascending order - click on any table header to change the sorting according to your needs @@ -90,8 +90,8 @@ To get an overview of all running exams which your user has access to click on t By clicking on the settings icon in the menu bar two options are displayed. -- select "Show past exams" to display all finished exams (red) -- select "Show upcoming exams" to display all exams which are planed for the future +- Select "Show past exams" to display all finished exams (red) +- Select "Show upcoming exams" to display all exams which are planed for the future .. image:: images/screen_proctoring/running_exam_selection.png @@ -105,14 +105,105 @@ Proctoring View The proctoring view shows a recorded or live session in more detail. +To open a proctoring view of a sessions either + +- Click on the camera icon in the gallery view +- Use the search feature +- Directly type in the url in the address bar: https:///recording/ + +A session can either be live or recorded. +- A live session is indicated by the "Live"-Button +- Navigating to the proctoring view during a live session always displays the latest screenshot and updates it accordingly +- Use the slider as any other video player +- This is also possible during a live session +- Click on the "Live"-Button to jump to the latest screenshot + +.. image:: images/screen_proctoring/proctoring_overview_live.png + :align: center + :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/docu/docs/images/screen_proctoring/proctoring_overview_live.png +- The "Details"-Box on the right side displays information about the session and the current screenshot +- "SEB Session Info" is static +- "Screenshot Metadata" dynamically changes for every Screenshot +- Refer to the chapter "Metadata" for more details + + +.. image:: images/screen_proctoring/proctoring_overview.png + :align: center + :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/docu/docs/images/screen_proctoring/proctoring_overview.png + + +- The "Live"-Button disappears when the sessions disconnects from the server +- Set the playback speed with the "settings"-icon according to you preferences +- The current screenshot and the total amount of screenshot is display in the "Total"-Row Search --------- +The search functionality is a powerful feature to search and find sessions and screenshots. +Click on the "Search" item in the navigation bar on the left side. + +**Form** + +The upper part of the page is the search form. +There are 4 different categories of search criteria: + +- exam data +- session / user data +- screenshot metadata +- time data + +Use the form fields and the time / date selection to tailor the search result to your needs. + +.. image:: images/screen_proctoring/search_form.png + :align: center + :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/docu/docs/images/screen_proctoring/search_form.png + + +**Search Results** + +The search results are grouped into days and sorted by date in descending order. +Use the "date"-button on the right side to change the sort oder. + +- Clicking on any date expands the panel and displays all sessions (a session is a student using SEB) with recordings on that day +- Per default the sessions are sorted by "Start-Time" in descending order +- Click on the table header to change the sorting according to your preferences +- A click on the down facing arrow on the right side lists all screenshots of that given student + + +.. image:: images/screen_proctoring/search_results_sessions.png + :align: center + :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/docu/docs/images/screen_proctoring/search_results_sessions.png + +- Per default the screenshot are sorted by "Capture-Time" in ascending order +- The screenshots are grouped into the metadata "Application / Website" +- Grouping means that each successive screenshot that has the same "Application / Website" metadata is placed in the same group +- Click on the camera icon on the right side to open the proctoring view at this exact time + +.. note:: + If the session is still live the proctoring view won't open at the given time but instead jumps to the latest image. + + + Metadata --------- +Metadata in context of the Screen Proctoring component are data which belong to a screenshot. +They describe the content of the captured screen. + +Currently the SEB-Client captures the following 5 metadata (additional values might follow in future releases): + + - Application: The name of the actual application that is used and focused + - e.g. "SafeExamBrowser.Client.exe", "calc.exe" + + - URL: The URL of the browser tab with current focus + - e.g. "http://google.com", "http://moodle.com/exam123" + + - Activity Details: The activity which triggerd the screenshot + - e.g. "A key has been pressed", "Left mouse button has been pressed" + + - Window Title: The window title of the focused window + - e.g. "Google Homepage", "Moodle Exam 123" \ No newline at end of file