Live Progress Report

Shows a dashboard for an exam proctor which shows live interactions of learners during an assessment in real time.

You would want to use this to allow an exam proctor to preside over an active assessment, and track and control the learner progress.

Important When initializing a live report, the user_id is mandatory in the security object, see Reports API initialization.

Note Unlike all other reports, this is only used while learners are actively completing an assessment. It should not be used to display, analyze, or control historical sessions.

It renders the Activity status information of learners including:

• Activity name,
• Status of the session and whether the session is paused,
• Status of the learner (if the current window or tab is focused or unfocused), and
• The current Item or Question the learner is viewing.

There is also a flag to enable control events, which give proctors (administrators) the ability to send push events to the learners' assessments, allowing proctors to control the assessments with the following actions. (These are also Reports API methods which have more details linked below.)

• pause or unpause
• extend test time
• send learner to a specific Item
• exit and save
• exit and discard

Unless a learner is interacting live with their assessment, this report will show that user as inactive and control events for their assessment will be ignored.

For use cases involving session management, we recommend integrating with Data API's endpoints for status polling and forcing submission.

Note This report is also known as the live-activitystatus-by-user report.

Examples

// Example report configuration
{
    "id": "report-23",
    "type": "live-activitystatus-by-user",
    "activity": {
        "id": "itemassessdemo",
        "name": "Demo Test"
    },
    "display_activity": true,
    "show_user_selectors" : true,
    "show_action_controls" : true,
    "users": [
        {
            "id": "$ANONYMIZED_USER_ID001",
            "name": "Student Name 001",
            "hash": "7224f1cd26c7eaac4f30c16ccf8e143005734089724affe0dd9cbf008b941e2d"
        },
        {
            "id": "$ANONYMIZED_USER_ID002",
            "activity": {
                "id": "myactivitydemo",
                "name": "My Demo Activity"
            },
            "name": "Student Name 002",
            "hash": "fd1888ffc8cf87efb4ab620401130c76fc8dff5ca04f139e23a7437c56f8f310"
        }
    ]
}

Attributes

• type string

  The type of this report. Must be "live-activitystatus-by-user".

• id string

  The HTML element ID where you want this report to appear.

• users array[object]

  An array of user (learner) definitions to include in the report.

  Note If you need more than 100 users, contact Learnosity Support.

  The individual user definitions include the following properties.

  • id string

    The ID of the user (learner).

  • hash string

    The concatenation of the user ID and your consumer_secret with no delimiters. The hash must be generated by applying the SHA256 hashing algorithm to the concatenated value.

  • activity object

    A custom Activity configuration for each user. Each property in this object overrides the report's global Activity configuration for this user.

    • id string

      The Activity ID.

    • name string

      The name of the Activity.

  • name string

    The name of the user (learner) for display purposes.

• activity object

  The global Activity configuration to apply to each user in the report.

  • id string

    The ID of the Activity.

    Note Can be overridden per user.

  • name string

    The name of the Activity for display purposes.

• control_events boolean

  Controls whether the proctor can interact with learner sessions.

  When set to true, the options for show_user_selectors and show_action_controls will be set to true.

  Default: false

• display_activity boolean

  Controls whether the name of the Activity is shown.

  You would want to use this if you have more than one Activity specified per user.

  Default: false

• show_action_controls boolean

  Controls whether to show the action drop-down menu for proctors.

  The action drop-down menu can be used to control the users' session, for example, to pause, unpause, extend time, etcetera.

  Setting this option will override the default set by control_events.

  Default: false

• show_user_selectors boolean

  Controls whether to show user selectors for proctors. By default, this is not shown.

  Selectors can be used to select one or more users shown in the report. Use the getSelectedUsers() method to retrieve the currently selected user(s).

  Setting this option will override the default set by control_events.

  Default: false

• render boolean

  Renders the report on your page at the location set with the specified HTML element ID.

  You would set this property to false if you wanted to receive the raw report data only and use your own custom UI to display it.

  Default: true